]> git.stg.codes - stg.git/blob - doc/xslt/docsrc/reference.xml.included
Merge branch 'stg-2.409' into stg-2.409-radius
[stg.git] / doc / xslt / docsrc / reference.xml.included
1 <?xml version="1.0" encoding="ASCII"?><set xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:base="../docsrc/">
2   <!-- * WARNING WARNING WARNING -->
3   <!-- * WARNING WARNING WARNING -->
4   <!-- * -->
5   <!-- * This document has duplicate IDs in it and is intended for -->
6   <!-- * processing using the chunk.xsl stylesheet to generate chunked -->
7   <!-- * output from it (not for generating a single HTML output file) -->
8   <!-- * -->
9   <!-- * WARNING WARNING WARNING -->
10   <!-- * WARNING WARNING WARNING -->
11   <title>DocBook XSL Stylesheets: Reference&#160;Documentation</title>
12   <info><releaseinfo role="meta">$Id: reference.xml 8321 2009-03-12 18:20:36Z mzjn $ </releaseinfo>
13     <authorgroup version="5.0">
14   <author>
15     <personname>
16       <surname>Walsh</surname><firstname>Norman</firstname>
17     </personname>
18   </author>
19   <author>
20     <orgname>The DocBook Project</orgname>
21   </author>
22 </authorgroup>
23     <copyright>
24     <year>1999-2007</year>
25     <holder>Norman Walsh</holder>
26   </copyright><copyright>
27     <year>2003</year>
28     <holder>Ji&#345;&#237; Kosek</holder>
29   </copyright><copyright>
30     <year>2004-2007</year>
31     <holder>Steve Ball</holder>
32   </copyright><copyright>
33     <year>2001-2007</year>
34     <holder>The DocBook Project</holder>
35   </copyright>
36     <legalnotice version="5.0" id="copyright"><title>License</title>
37 <para>Permission is hereby granted, free of charge, to any person
38 obtaining a copy of this software and associated documentation files
39 (the <quote>Software</quote>), to deal in the Software without
40 restriction, including without limitation the rights to use, copy,
41 modify, merge, publish, distribute, sublicense, and/or sell copies of
42 the Software, and to permit persons to whom the Software is furnished
43 to do so, subject to the following conditions:
44 </para>
45 <para>The above copyright notice and this permission notice shall be
46 included in all copies or substantial portions of the Software.</para>
47 <para>Except as contained in this notice, the names of individuals
48 credited with contribution to this software shall not be used in
49 advertising or otherwise to promote the sale, use or other dealings in
50 this Software without prior written authorization from the individuals
51 in question.</para>
52 <para>Any stylesheet derived from this Software that is publically
53 distributed will be identified with a different name and the version
54 strings in any derived Software will be changed so that no possibility
55 of confusion between the derived package and this Software will
56 exist.</para>
57 </legalnotice>
58     <legalnotice version="5.0" id="warranty"><title>Warranty</title>
59 <para>THE SOFTWARE IS PROVIDED <quote>AS IS</quote>,
60 WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
61 LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
62 PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL NORMAN WALSH OR ANY
63 OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
64 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
65 OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
66 THE SOFTWARE.</para>
67 </legalnotice>
68     <abstract id="about">
69       <title>About this document</title>
70       <para>This is generated reference documentation for the DocBook
71         XSL stylesheets. It is available in the following formats:
72         <itemizedlist>
73           <listitem>
74             <para><link xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.html">HTML</link>,
75               <link xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.pdf">PDF</link>,
76               <link xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.txt">plain text</link></para>
77           </listitem>
78         </itemizedlist>
79         This is primarily documentation on the parameters and processing instructions you can use
80         to control the behavior of the stylesheets.
81         <note>
82           <para>This is purely reference documentation&#160;&#8211; not how-to
83             documentation. For a thorough step-by-step how-to guide to
84             publishing content using the DocBook XSL stylesheets, see
85             Bob Stayton&#8217;s <link xlink:href="http://www.sagehill.net/book-description.html">DocBook XSL: The Complete Guide</link>, available online
86             at <link xlink:href="http://www.sagehill.net/docbookxsl/index.html">http://www.sagehill.net/docbookxsl/index.html</link>
87           </para>
88         </note>
89         This document is divided into three sets of references:
90         the first two sets provides user documentation; the third,
91         developer documentation.</para>
92     </abstract>
93   </info>
94   <book id="param"><title>DocBook XSL Stylesheets User&#160;Reference:&#160;Parameters</title>
95     <info>
96       <abstract>
97         <para>This is generated reference documentation for all
98           user-configurable parameters in the DocBook XSL
99           stylesheets.
100           <note>
101             <para>This is purely reference documentation&#160;&#8211; not how-to
102               documentation. For a thorough step-by-step how-to guide to
103               publishing content using the DocBook XSL stylesheets, see
104               Bob Stayton&#8217;s <link xlink:href="http://www.sagehill.net/book-description.html">DocBook XSL: The Complete Guide</link>, available online
105               at <link xlink:href="http://www.sagehill.net/docbookxsl/index.html">http://www.sagehill.net/docbookxsl/index.html</link>
106             </para>
107           </note>
108         </para>
109       </abstract>
110     </info>
111     <part id="html">
112       <?dbhtml dir="html"?>
113       <?dbhtml filename="index.html"?>
114       <title xml:base="../html/param.xml">HTML Parameter Reference</title>
115       <partintro id="htmlintro">
116         
117   <para xml:base="../html/param.xml">This is reference documentation for all user-configurable
118   parameters in the DocBook XSL HTML stylesheets (for generating
119   HTML output).</para>
120
121       </partintro>
122       <reference id="admons" xml:base="../html/param.xml"><title>Admonitions</title>
123 <refentry version="5.0" id="admon.graphics.extension">
124 <refmeta>
125 <refentrytitle>admon.graphics.extension</refentrytitle>
126 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
127 </refmeta>
128 <refnamediv>
129 <refname>admon.graphics.extension</refname>
130 <refpurpose>Filename extension for admonition graphics</refpurpose>
131 </refnamediv>
132
133 <refsynopsisdiv>
134 <programlisting id="admon.graphics.extension.frag">
135 &lt;xsl:param name="admon.graphics.extension"&gt;.png&lt;/xsl:param&gt;
136 </programlisting>
137 </refsynopsisdiv>
138
139 <refsection><info><title>Description</title></info>
140
141 <para>Sets the filename extension to use on admonition graphics.</para>
142
143 </refsection>
144 </refentry>
145
146 <refentry version="5.0" id="admon.graphics.path">
147 <refmeta>
148 <refentrytitle>admon.graphics.path</refentrytitle>
149 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
150 </refmeta>
151 <refnamediv>
152 <refname>admon.graphics.path</refname>
153 <refpurpose>Path to admonition graphics</refpurpose>
154 </refnamediv>
155
156 <refsynopsisdiv>
157 <programlisting id="admon.graphics.path.frag">&lt;xsl:param name="admon.graphics.path"&gt;images/&lt;/xsl:param&gt;</programlisting>
158 </refsynopsisdiv>
159
160 <refsection><info><title>Description</title></info>
161
162 <para>Sets the path to the directory containing the admonition graphics
163 (caution.png, important.png etc). This location is normally relative
164 to the output html directory. See <parameter>base.dir</parameter></para>
165
166 </refsection>
167 </refentry>
168
169 <refentry version="5.0" id="admon.graphics">
170 <refmeta>
171 <refentrytitle>admon.graphics</refentrytitle>
172 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
173 </refmeta>
174 <refnamediv>
175 <refname>admon.graphics</refname>
176 <refpurpose>Use graphics in admonitions?</refpurpose>
177 </refnamediv>
178
179 <refsynopsisdiv>
180 <programlisting id="admon.graphics.frag">
181 &lt;xsl:param name="admon.graphics" select="0"&gt;&lt;/xsl:param&gt;
182 </programlisting>
183 </refsynopsisdiv>
184
185 <refsection><info><title>Description</title></info>
186
187 <para>If true (non-zero), admonitions are presented in an alternate style that uses
188 a graphic.  Default graphics are provided in the distribution.
189 </para>
190
191 </refsection>
192 </refentry>
193
194 <refentry version="5.0" id="admon.textlabel">
195 <refmeta>
196 <refentrytitle>admon.textlabel</refentrytitle>
197 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
198 </refmeta>
199 <refnamediv>
200 <refname>admon.textlabel</refname>
201 <refpurpose>Use text label in admonitions?</refpurpose>
202 </refnamediv>
203
204 <refsynopsisdiv>
205 <programlisting id="admon.textlabel.frag">
206 &lt;xsl:param name="admon.textlabel" select="1"&gt;&lt;/xsl:param&gt;
207 </programlisting>
208 </refsynopsisdiv>
209
210 <refsection><info><title>Description</title></info>
211
212 <para>If true (non-zero), admonitions are presented with a generated
213 text label such as Note or Warning in the appropriate language.
214 If zero, such labels are turned off, but any title child
215 of the admonition element are still output.
216 The default value is 1.
217 </para>
218
219 </refsection>
220 </refentry>
221
222 <refentry version="5.0" id="admon.style">
223 <refmeta>
224 <refentrytitle>admon.style</refentrytitle>
225 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
226 </refmeta>
227 <refnamediv>
228 <refname>admon.style</refname>
229 <refpurpose>Specifies the CSS style attribute that should be added to
230 admonitions.</refpurpose>
231 </refnamediv>
232
233 <refsynopsisdiv>
234 <programlisting id="admon.style.frag">&lt;xsl:param name="admon.style"&gt;
235   &lt;xsl:value-of select="concat('margin-', $direction.align.start,            ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"&gt;&lt;/xsl:value-of&gt;
236 &lt;/xsl:param&gt;</programlisting>
237 </refsynopsisdiv>
238
239 <refsection><info><title>Description</title></info>
240
241 <para>Specifies the value of the CSS <tag class="attribute">style</tag>
242 attribute that should be added to admonitions.
243 </para>
244
245 </refsection>
246 </refentry>
247
248 </reference><reference id="callouts" xml:base="../html/param.xml"><title>Callouts</title>
249 <refentry version="5.0" id="callout.defaultcolumn">
250 <refmeta>
251 <refentrytitle>callout.defaultcolumn</refentrytitle>
252 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
253 </refmeta>
254 <refnamediv>
255 <refname>callout.defaultcolumn</refname>
256 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
257 </refnamediv>
258
259 <refsynopsisdiv>
260 <programlisting id="callout.defaultcolumn.frag">
261 &lt;xsl:param name="callout.defaultcolumn"&gt;60&lt;/xsl:param&gt;
262 </programlisting>
263 </refsynopsisdiv>
264
265 <refsection><info><title>Description</title></info>
266
267 <para>If a callout does not identify a column (for example, if it uses
268 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
269 it will appear in the default column.
270 </para>
271
272 </refsection>
273 </refentry>
274
275 <refentry version="5.0" id="callout.graphics.extension">
276 <refmeta>
277 <refentrytitle>callout.graphics.extension</refentrytitle>
278 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
279 </refmeta>
280 <refnamediv>
281 <refname>callout.graphics.extension</refname>
282 <refpurpose>Filename extension for callout graphics</refpurpose>
283 </refnamediv>
284
285 <refsynopsisdiv>
286 <programlisting id="callout.graphics.extension.frag">
287 &lt;xsl:param name="callout.graphics.extension"&gt;.png&lt;/xsl:param&gt;
288
289 </programlisting>
290 </refsynopsisdiv>
291
292 <refsection><info><title>Description</title></info>
293 <para>Sets the filename extension to use on callout graphics. </para>
294
295 <itemizedlist>
296 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
297 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
298 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
299 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
300 </itemizedlist>
301 </refsection>
302 </refentry>
303
304 <refentry version="5.0" id="callout.graphics.number.limit">
305 <refmeta>
306 <refentrytitle>callout.graphics.number.limit</refentrytitle>
307 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
308 </refmeta>
309 <refnamediv>
310 <refname>callout.graphics.number.limit</refname>
311 <refpurpose>Number of the largest callout graphic</refpurpose>
312 </refnamediv>
313
314 <refsynopsisdiv>
315 <programlisting id="callout.graphics.number.limit.frag">
316 &lt;xsl:param name="callout.graphics.number.limit"&gt;15&lt;/xsl:param&gt;
317
318 </programlisting>
319 </refsynopsisdiv>
320
321 <refsection><info><title>Description</title></info>
322
323 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
324 are used to represent callout numbers instead of plain text. The value
325 of <parameter>callout.graphics.number.limit</parameter> is the largest
326 number for which a graphic exists. If the callout number exceeds this
327 limit, the default presentation "(plain text instead of a graphic)"
328 will  be used.
329 </para>
330
331 </refsection>
332 </refentry>
333
334 <refentry version="5.0" id="callout.graphics.path">
335 <refmeta>
336 <refentrytitle>callout.graphics.path</refentrytitle>
337 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
338 </refmeta>
339 <refnamediv>
340 <refname>callout.graphics.path</refname>
341 <refpurpose>Path to callout graphics</refpurpose>
342 </refnamediv>
343
344 <refsynopsisdiv>
345 <programlisting id="callout.graphics.path.frag">
346 &lt;xsl:param name="callout.graphics.path"&gt;images/callouts/&lt;/xsl:param&gt;
347 </programlisting>
348 </refsynopsisdiv>
349
350 <refsection><info><title>Description</title></info>
351
352 <para>Sets the path to the directory holding the callout graphics. his
353 location is normally relative to the output html directory. see
354 base.dir. Always terminate the directory with / since the graphic file
355 is appended to this string, hence needs the separator.
356 </para>
357
358 </refsection>
359 </refentry>
360
361 <refentry version="5.0" id="callout.graphics">
362 <refmeta>
363 <refentrytitle>callout.graphics</refentrytitle>
364 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
365 </refmeta>
366 <refnamediv>
367 <refname>callout.graphics</refname>
368 <refpurpose>Use graphics for callouts?</refpurpose>
369 </refnamediv>
370
371 <refsynopsisdiv>
372 <programlisting id="callout.graphics.frag">
373 &lt;xsl:param name="callout.graphics" select="1"&gt;&lt;/xsl:param&gt;
374 </programlisting>
375 </refsynopsisdiv>
376
377 <refsection><info><title>Description</title></info>
378
379 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
380 circled numbers instead of "(1)", "(2)", etc.).
381 Default graphics are provided in the distribution.
382 </para>
383
384 </refsection>
385 </refentry>
386
387 <refentry version="5.0" id="callout.list.table">
388 <refmeta>
389 <refentrytitle>callout.list.table</refentrytitle>
390 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
391 </refmeta>
392 <refnamediv>
393 <refname>callout.list.table</refname>
394 <refpurpose>Present callout lists using a table?</refpurpose>
395 </refnamediv>
396
397 <refsynopsisdiv>
398 <programlisting id="callout.list.table.frag">
399 &lt;xsl:param name="callout.list.table" select="1"&gt;&lt;/xsl:param&gt;
400 </programlisting>
401 </refsynopsisdiv>
402
403 <refsection><info><title>Description</title></info>
404
405 <para>The default presentation of <tag>calloutlist</tag>s uses
406 an HTML <tag>DL</tag> element. Some browsers don't align DLs very well
407 if <parameter>callout.graphics</parameter> is used. With this option
408 turned on, <tag>calloutlist</tag>s are presented in an HTML
409 <tag>TABLE</tag>, which usually results in better alignment
410 of the callout number with the callout description.</para>
411
412 </refsection>
413 </refentry>
414
415 <refentry version="5.0" id="callout.unicode.number.limit">
416 <refmeta>
417 <refentrytitle>callout.unicode.number.limit</refentrytitle>
418 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
419 </refmeta>
420 <refnamediv>
421 <refname>callout.unicode.number.limit</refname>
422 <refpurpose>Number of the largest unicode callout character</refpurpose>
423 </refnamediv>
424
425 <refsynopsisdiv>
426 <programlisting id="callout.unicode.number.limit.frag">
427 &lt;xsl:param name="callout.unicode.number.limit"&gt;10&lt;/xsl:param&gt;
428 </programlisting>
429 </refsynopsisdiv>
430
431 <refsection><info><title>Description</title></info>
432
433 <para>If <parameter>callout.unicode</parameter>
434 is non-zero, unicode characters are used to represent
435 callout numbers. The value of
436 <parameter>callout.unicode.number.limit</parameter>
437 is
438 the largest number for which a unicode character exists. If the callout number
439 exceeds this limit, the default presentation "(nnn)" will always
440 be used.
441 </para>
442
443 </refsection>
444 </refentry>
445
446 <refentry version="5.0" id="callout.unicode.start.character">
447 <refmeta>
448 <refentrytitle>callout.unicode.start.character</refentrytitle>
449 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
450 </refmeta>
451 <refnamediv>
452 <refname>callout.unicode.start.character</refname>
453 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
454 </refnamediv>
455
456 <refsynopsisdiv>
457 <programlisting id="callout.unicode.start.character.frag">
458 &lt;xsl:param name="callout.unicode.start.character"&gt;10102&lt;/xsl:param&gt;
459 </programlisting>
460 </refsynopsisdiv>
461
462 <refsection><info><title>Description</title></info>
463
464 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
465 is non-zero, unicode characters are used to represent
466 callout numbers. The value of
467 <parameter>callout.unicode.start.character</parameter>
468 is the decimal unicode value used for callout number one. Currently, 
469 only 10102 is supported in the stylesheets for this parameter. 
470 </para>
471
472 </refsection>
473 </refentry>
474
475 <refentry version="5.0" id="callout.unicode">
476 <refmeta>
477 <refentrytitle>callout.unicode</refentrytitle>
478 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
479 </refmeta>
480 <refnamediv>
481 <refname>callout.unicode</refname>
482 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
483 </refnamediv>
484
485 <refsynopsisdiv>
486 <programlisting id="callout.unicode.frag">&lt;xsl:param name="callout.unicode" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
487 </refsynopsisdiv>
488
489 <refsection><info><title>Description</title></info>
490
491 <para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option.
492 </para>
493
494 </refsection>
495 </refentry>
496
497 <refentry version="5.0" id="callouts.extension">
498 <refmeta>
499 <refentrytitle>callouts.extension</refentrytitle>
500 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
501 </refmeta>
502 <refnamediv>
503 <refname>callouts.extension</refname>
504 <refpurpose>Enable the callout extension</refpurpose>
505 </refnamediv>
506
507 <refsynopsisdiv>
508 <programlisting id="callouts.extension.frag">
509 &lt;xsl:param name="callouts.extension" select="1"&gt;&lt;/xsl:param&gt;
510 </programlisting>
511 </refsynopsisdiv>
512
513 <refsection><info><title>Description</title></info>
514
515 <para>The callouts extension processes <tag>areaset</tag>
516 elements in <tag>programlistingco</tag> and other text-based
517 callout elements.
518 </para>
519
520 </refsection>
521 </refentry>
522
523 </reference><reference id="ebnf" xml:base="../html/param.xml"><title>EBNF</title>
524 <refentry version="5.0" id="ebnf.table.bgcolor">
525 <refmeta>
526 <refentrytitle>ebnf.table.bgcolor</refentrytitle>
527 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
528 </refmeta>
529 <refnamediv>
530 <refname>ebnf.table.bgcolor</refname>
531 <refpurpose>Background color for EBNF tables</refpurpose>
532 </refnamediv>
533
534 <refsynopsisdiv>
535 <programlisting id="ebnf.table.bgcolor.frag">
536 &lt;xsl:param name="ebnf.table.bgcolor"&gt;#F5DCB3&lt;/xsl:param&gt;
537 </programlisting>
538 </refsynopsisdiv>
539
540 <refsection><info><title>Description</title></info>
541
542 <para>Sets the background color for EBNF tables (a pale brown). No
543 <tag>bgcolor</tag> attribute is output if
544 <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para>
545
546
547 </refsection>
548 </refentry>
549
550 <refentry version="5.0" id="ebnf.table.border">
551 <refmeta>
552 <refentrytitle>ebnf.table.border</refentrytitle>
553 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
554 </refmeta>
555 <refnamediv>
556 <refname>ebnf.table.border</refname>
557 <refpurpose>Selects border on EBNF tables</refpurpose>
558 </refnamediv>
559
560 <refsynopsisdiv>
561 <programlisting id="ebnf.table.border.frag">&lt;xsl:param name="ebnf.table.border" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
562 </refsynopsisdiv>
563
564 <refsection><info><title>Description</title></info>
565
566 <para>Selects the border on EBNF tables. If non-zero, the tables have
567 borders, otherwise they don't.</para>
568
569 </refsection>
570 </refentry>
571
572 <refentry version="5.0" id="ebnf.assignment">
573 <refmeta>
574 <refentrytitle>ebnf.assignment</refentrytitle>
575 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
576 </refmeta>
577 <refnamediv>
578 <refname>ebnf.assignment</refname>
579 <refpurpose>The EBNF production assignment operator</refpurpose>
580 </refnamediv>
581
582 <refsynopsisdiv>
583 <programlisting id="ebnf.assignment.frag">
584 &lt;xsl:param name="ebnf.assignment"&gt;
585 &lt;code&gt;::=&lt;/code&gt;
586 &lt;/xsl:param&gt;
587
588 </programlisting>
589 </refsynopsisdiv>
590
591 <refsection><info><title>Description</title></info>
592
593 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
594 text is used to show <quote>assignment</quote> in <tag>production</tag>s
595 in <tag>productionset</tag>s.</para>
596
597 <para>While <quote><literal>::=</literal></quote> is common, so are several
598 other operators.</para>
599
600 </refsection>
601 </refentry>
602
603 <refentry version="5.0" id="ebnf.statement.terminator">
604 <refmeta>
605 <refentrytitle>ebnf.statement.terminator</refentrytitle>
606 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
607 </refmeta>
608 <refnamediv>
609 <refname>ebnf.statement.terminator</refname>
610 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
611 </refnamediv>
612
613 <refsynopsisdiv>
614 <programlisting id="ebnf.statement.terminator.frag">
615 &lt;xsl:param name="ebnf.statement.terminator"&gt;&lt;/xsl:param&gt;
616
617 </programlisting>
618 </refsynopsisdiv>
619
620 <refsection><info><title>Description</title></info>
621
622 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
623 text is used to terminate each <tag>production</tag>
624 in <tag>productionset</tag>.</para>
625
626 <para>Some notations end each statement with a period.</para>
627
628 </refsection>
629 </refentry>
630
631 </reference><reference id="toc_index" xml:base="../html/param.xml"><title>ToC/LoT/Index Generation</title>
632 <refentry version="5.0" id="annotate.toc">
633 <refmeta>
634 <refentrytitle>annotate.toc</refentrytitle>
635 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
636 </refmeta>
637 <refnamediv>
638 <refname>annotate.toc</refname>
639 <refpurpose>Annotate the Table of Contents?</refpurpose>
640 </refnamediv>
641
642 <refsynopsisdiv>
643 <programlisting id="annotate.toc.frag">&lt;xsl:param name="annotate.toc" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
644 </refsynopsisdiv>
645
646 <refsection><info><title>Description</title></info>
647
648 <para>If true, TOCs will be annotated. At present, this just means
649 that the <tag>refpurpose</tag> of <tag>refentry</tag>
650 TOC entries will be displayed.
651 </para>
652
653 </refsection>
654 </refentry>
655
656 <refentry version="5.0" id="autotoc.label.separator">
657 <refmeta>
658 <refentrytitle>autotoc.label.separator</refentrytitle>
659 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
660 </refmeta>
661 <refnamediv>
662 <refname>autotoc.label.separator</refname>
663 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
664 </refnamediv>
665
666 <refsynopsisdiv>
667 <programlisting id="autotoc.label.separator.frag">
668 &lt;xsl:param name="autotoc.label.separator"&gt;. &lt;/xsl:param&gt;
669 </programlisting>
670 </refsynopsisdiv>
671
672 <refsection><info><title>Description</title></info>
673
674 <para>String used to separate labels and titles in a table of contents.</para>
675
676 </refsection>
677 </refentry>
678
679 <refentry version="5.0" id="autotoc.label.in.hyperlink">
680 <refmeta>
681 <refentrytitle>autotoc.label.in.hyperlink</refentrytitle>
682 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
683 </refmeta>
684 <refnamediv>
685 <refname>autotoc.label.in.hyperlink</refname>
686 <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose>
687 </refnamediv>
688
689 <refsynopsisdiv>
690 <programlisting id="autotoc.label.in.hyperlink.frag">&lt;xsl:param name="autotoc.label.in.hyperlink" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
691 </refsynopsisdiv>
692
693 <refsection><info><title>Description</title></info>
694
695 <para>If the value of
696 <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels
697 are included in hyperlinked titles in the TOC. If it is instead zero,
698 labels are still displayed prior to the hyperlinked titles, but
699 are not hyperlinked along with the titles.</para>
700
701 </refsection>
702 </refentry>
703
704 <refentry version="5.0" id="process.source.toc">
705 <refmeta>
706 <refentrytitle>process.source.toc</refentrytitle>
707 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
708 </refmeta>
709 <refnamediv>
710 <refname>process.source.toc</refname>
711 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
712 </refnamediv>
713
714 <refsynopsisdiv>
715 <programlisting id="process.source.toc.frag">&lt;xsl:param name="process.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
716 </refsynopsisdiv>
717
718 <refsection><info><title>Description</title></info>
719
720 <para>Specifies that the contents of a non-empty "hard-coded"
721 <tag>toc</tag> element in a source document are processed to
722 generate a TOC in output.
723 <note>
724   <para>This parameter has no effect on automated generation of
725   TOCs. An automated TOC may still be generated along with the
726   "hard-coded" TOC. To suppress automated TOC generation, adjust the
727   value of the <parameter>generate.toc</parameter> paramameter.</para>
728
729   <para>The <tag>process.source.toc</tag> parameter also has
730   no effect if the <tag>toc</tag> element is empty; handling
731   for empty <tag>toc</tag> is controlled by the
732   <parameter>process.empty.source.toc</parameter> parameter.</para>
733 </note>
734 </para>
735
736 </refsection>
737 </refentry>
738
739 <refentry version="5.0" id="process.empty.source.toc">
740 <refmeta>
741 <refentrytitle>process.empty.source.toc</refentrytitle>
742 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
743 </refmeta>
744 <refnamediv>
745 <refname>process.empty.source.toc</refname>
746 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
747 </refnamediv>
748
749 <refsynopsisdiv>
750 <programlisting id="process.empty.source.toc.frag">&lt;xsl:param name="process.empty.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
751 </refsynopsisdiv>
752
753 <refsection><info><title>Description</title></info>
754
755 <para>Specifies that if an empty <tag>toc</tag> element is found in a
756 source document, an automated TOC is generated at this point in the
757 document.
758 <note>
759   <para>Depending on what the value of the
760   <parameter>generate.toc</parameter> parameter is, setting this
761   parameter to <literal>1</literal> could result in generation of
762   duplicate automated TOCs. So the
763   <parameter>process.empty.source.toc</parameter> is primarily useful
764   as an "override": by placing an empty <tag>toc</tag> in your
765   document and setting this parameter to <literal>1</literal>, you can
766   force a TOC to be generated even if <tag>generate.toc</tag>
767   says not to.</para>
768 </note>
769 </para>
770
771 </refsection>
772 </refentry>
773
774 <refentry version="5.0" id="bridgehead.in.toc">
775 <refmeta>
776 <refentrytitle>bridgehead.in.toc</refentrytitle>
777 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
778 </refmeta>
779 <refnamediv>
780 <refname>bridgehead.in.toc</refname>
781 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
782 </refnamediv>
783
784 <refsynopsisdiv>
785 <programlisting id="bridgehead.in.toc.frag">&lt;xsl:param name="bridgehead.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
786 </refsynopsisdiv>
787
788 <refsection><info><title>Description</title></info>
789
790 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
791 this option is not fully supported and may be removed in a future
792 version of the stylesheets.
793 </para>
794
795 </refsection>
796 </refentry>
797
798 <refentry version="5.0" id="simplesect.in.toc">
799 <refmeta>
800 <refentrytitle>simplesect.in.toc</refentrytitle>
801 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
802 </refmeta>
803 <refnamediv>
804 <refname>simplesect.in.toc</refname>
805 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
806 </refnamediv>
807
808 <refsynopsisdiv>
809 <programlisting id="simplesect.in.toc.frag">&lt;xsl:param name="simplesect.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
810 </refsynopsisdiv>
811
812 <refsection><info><title>Description</title></info>
813
814 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
815 </para>
816
817 </refsection>
818 </refentry>
819
820 <refentry version="5.0" id="manual.toc">
821 <refmeta>
822 <refentrytitle>manual.toc</refentrytitle>
823 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
824 </refmeta>
825 <refnamediv>
826 <refname>manual.toc</refname>
827 <refpurpose>An explicit TOC to be used for the TOC</refpurpose>
828 </refnamediv>
829
830 <refsynopsisdiv>
831 <programlisting id="manual.toc.frag">
832 &lt;xsl:param name="manual.toc"&gt;&lt;/xsl:param&gt;
833 </programlisting>
834 </refsynopsisdiv>
835
836 <refsection><info><title>Description</title></info>
837
838 <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that
839 will be used for building the printed TOC.
840 </para>
841
842 </refsection>
843 </refentry>
844
845 <refentry version="5.0" id="toc.list.type">
846 <refmeta>
847 <refentrytitle>toc.list.type</refentrytitle>
848 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
849 <refmiscinfo class="other" otherclass="value">dl</refmiscinfo>
850 <refmiscinfo class="other" otherclass="value">ul</refmiscinfo>
851 <refmiscinfo class="other" otherclass="value">ol</refmiscinfo>
852 </refmeta>
853 <refnamediv>
854 <refname>toc.list.type</refname>
855 <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose>
856 </refnamediv>
857
858 <refsynopsisdiv>
859 <programlisting id="toc.list.type.frag">&lt;xsl:param name="toc.list.type"&gt;dl&lt;/xsl:param&gt;</programlisting>
860 </refsynopsisdiv>
861
862 <refsection><info><title>Description</title></info>
863
864 <para>When an automatically generated Table of Contents (or List of Titles)
865 is produced, this HTML element will be used to make the list.
866 </para>
867
868 </refsection>
869 </refentry>
870
871 <refentry version="5.0" id="toc.section.depth">
872 <refmeta>
873 <refentrytitle>toc.section.depth</refentrytitle>
874 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
875 </refmeta>
876 <refnamediv>
877 <refname>toc.section.depth</refname>
878 <refpurpose>How deep should recursive <tag>section</tag>s appear
879 in the TOC?</refpurpose>
880 </refnamediv>
881
882 <refsynopsisdiv>
883 <programlisting id="toc.section.depth.frag">&lt;xsl:param name="toc.section.depth"&gt;2&lt;/xsl:param&gt;</programlisting>
884 </refsynopsisdiv>
885
886 <refsection><info><title>Description</title></info>
887
888 <para>Specifies the depth to which recursive sections should appear in the
889 TOC.
890 </para>
891
892 </refsection>
893 </refentry>
894
895 <refentry version="5.0" id="toc.max.depth">
896 <refmeta>
897 <refentrytitle>toc.max.depth</refentrytitle>
898 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
899 </refmeta>
900 <refnamediv>
901 <refname>toc.max.depth</refname>
902 <refpurpose>How many levels should be created for each TOC?</refpurpose>
903 </refnamediv>
904
905 <refsynopsisdiv>
906 <programlisting id="toc.max.depth.frag">&lt;xsl:param name="toc.max.depth"&gt;8&lt;/xsl:param&gt;</programlisting>
907 </refsynopsisdiv>
908
909 <refsection><info><title>Description</title></info>
910
911 <para>Specifies the maximal depth of TOC on all levels.</para>
912
913 </refsection>
914 </refentry>
915
916 <refentry version="5.0" id="generate.toc">
917 <refmeta>
918 <refentrytitle>generate.toc</refentrytitle>
919 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
920 </refmeta>
921 <refnamediv>
922 <refname>generate.toc</refname>
923 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
924 </refnamediv>
925
926 <refsynopsisdiv>
927 <programlisting id="generate.toc.frag">
928 &lt;xsl:param name="generate.toc"&gt;
929 appendix  toc,title
930 article/appendix  nop
931 article   toc,title
932 book      toc,title,figure,table,example,equation
933 chapter   toc,title
934 part      toc,title
935 preface   toc,title
936 qandadiv  toc
937 qandaset  toc
938 reference toc,title
939 sect1     toc
940 sect2     toc
941 sect3     toc
942 sect4     toc
943 sect5     toc
944 section   toc
945 set       toc,title
946 &lt;/xsl:param&gt;
947
948 </programlisting>
949 </refsynopsisdiv>
950
951 <refsection><info><title>Description</title></info>
952
953 <para>This parameter has a structured value. It is a table of space-delimited
954 path/value pairs. Each path identifies some element in the source document
955 using a restricted subset of XPath (only the implicit child axis, no wildcards,
956 no predicates). Paths can be either relative or absolute.</para>
957
958 <para>When processing a particular element, the stylesheets consult this table to
959 determine if a ToC (or LoT(s)) should be generated.</para>
960
961 <para>For example, consider the entry:</para>
962
963 <screen>book toc,figure</screen>
964
965 <para>This indicates that whenever a <tag>book</tag> is formatted, a
966 Table Of Contents and a List of Figures should be generated. Similarly,</para>
967
968 <screen>/chapter toc</screen>
969
970 <para>indicates that whenever a document <emphasis>that has a root
971 of</emphasis> <tag>chapter</tag> is formatted, a Table of
972 Contents should be generated. The entry <literal>chapter</literal> would match
973 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
974 document elements.</para>
975
976 <para>Generally, the longest match wins. So, for example, if you want to distinguish
977 articles in books from articles in parts, you could use these two entries:</para>
978
979 <screen>book/article toc,figure
980 part/article toc</screen>
981
982 <para>Note that an article in a part can never match a <literal>book/article</literal>,
983 so if you want nothing to be generated for articles in parts, you can simply leave
984 that rule out.</para>
985
986 <para>If you want to leave the rule in, to make it explicit that you're turning
987 something off, use the value <quote>nop</quote>. For example, the following
988 entry disables ToCs and LoTs for articles:</para>
989
990 <screen>article nop</screen>
991
992 <para>Do not simply leave the word <quote>article</quote> in the file
993 without a matching value. That'd be just begging the silly little
994 path/value parser to get confused.</para>
995
996 <para>Section ToCs are further controlled by the
997 <parameter>generate.section.toc.level</parameter> parameter.
998 For a given section level to have a ToC, it must have both an entry in 
999 <parameter>generate.toc</parameter> and be within the range enabled by
1000 <parameter>generate.section.toc.level</parameter>.</para>
1001 </refsection>
1002 </refentry>
1003
1004 <refentry version="5.0" id="generate.section.toc.level">
1005 <refmeta>
1006 <refentrytitle>generate.section.toc.level</refentrytitle>
1007 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1008 </refmeta>
1009 <refnamediv>
1010 <refname>generate.section.toc.level</refname>
1011 <refpurpose>Control depth of TOC generation in sections</refpurpose>
1012 </refnamediv>
1013
1014 <refsynopsisdiv>
1015 <programlisting id="generate.section.toc.level.frag">
1016 &lt;xsl:param name="generate.section.toc.level" select="0"&gt;&lt;/xsl:param&gt;
1017 </programlisting>
1018 </refsynopsisdiv>
1019
1020 <refsection><info><title>Description</title></info>
1021
1022 <para>The <parameter>generate.section.toc.level</parameter> parameter
1023 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
1024 that this is related to, but not the same as
1025 <parameter>toc.section.depth</parameter>, which controls the depth to
1026 which TOC entries will be generated in a given TOC.</para>
1027 <para>If, for example, <parameter>generate.section.toc.level</parameter>
1028 is <literal>3</literal>, TOCs will be generated in first, second, and third
1029 level sections, but not in fourth level sections.
1030 </para>
1031
1032 </refsection>
1033 </refentry>
1034
1035 <refentry version="5.0" id="generate.index">
1036 <refmeta>
1037 <refentrytitle>generate.index</refentrytitle>
1038 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1039 </refmeta>
1040 <refnamediv>
1041 <refname>generate.index</refname>
1042 <refpurpose>Do you want an index?</refpurpose>
1043 </refnamediv>
1044
1045 <refsynopsisdiv>
1046 <programlisting id="generate.index.frag">&lt;xsl:param name="generate.index" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
1047 </refsynopsisdiv>
1048
1049 <refsection><info><title>Description</title></info>
1050
1051 <para>Specify if an index should be generated. </para>
1052
1053 </refsection>
1054 </refentry>
1055
1056 <refentry version="5.0" id="index.method">
1057 <refmeta>
1058 <refentrytitle>index.method</refentrytitle>
1059 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1060 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
1061 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
1062 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
1063 </refmeta>
1064 <refnamediv>
1065 <refname>index.method</refname>
1066 <refpurpose>Select method used to group index entries in an index</refpurpose>
1067 </refnamediv>
1068
1069 <refsynopsisdiv>
1070 <programlisting id="index.method.frag">
1071 &lt;xsl:param name="index.method"&gt;basic&lt;/xsl:param&gt;
1072 </programlisting>
1073 </refsynopsisdiv>
1074
1075 <refsection><info><title>Description</title></info>
1076
1077 <para>This parameter lets you select which method to use for sorting and grouping
1078  index entries in an index.
1079 Indexes in Latin-based languages that have accented characters typically
1080 sort together accented words and unaccented words.
1081 Thus <quote>&#193;</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
1082 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
1083 section of the index.
1084 Languages using other alphabets (such as Russian,  which is written in the Cyrillic alphabet)
1085 and languages using ideographic chararacters (such as Japanese)
1086 require grouping specific to the languages and alphabets.
1087 </para>
1088
1089 <para>The default indexing method is limited.
1090 It can group accented characters in Latin-based languages only.
1091 It cannot handle non-Latin alphabets or ideographic languages.
1092 The other indexing methods require extensions of one type or
1093 another, and do not work with
1094 all XSLT processors, which is why they are not used by default.</para>
1095
1096 <para>The three choices for indexing method are:</para>
1097 <variablelist>
1098 <varlistentry>
1099 <term><literal>basic</literal></term>
1100 <listitem>
1101 <para>
1102 (default)  Sort and groups words based only on the Latin alphabet.
1103 Words with accented Latin letters will group and sort with
1104 their respective primary letter, but
1105 words in non-Latin alphabets will be
1106 put in the <quote>Symbols</quote> section of the index.
1107 </para>
1108 </listitem>
1109 </varlistentry>
1110 <varlistentry>
1111 <term><literal>kosek</literal></term>
1112 <listitem>
1113 <para>
1114 This method sorts and groups words based on letter groups configured in
1115 the DocBook locale file for the given language.
1116 See, for example, the French locale file <filename>common/fr.xml</filename>.
1117 This method requires that the XSLT processor
1118 supports the EXSLT extensions (most do).
1119 It also requires support for using 
1120 user-defined functions in xsl:key (xsltproc does not).
1121 </para>
1122 <para>This method is suitable for any language for which you can
1123 list all the individual characters that should appear
1124 in each letter group in an index.
1125 It is probably not practical to use it for ideographic languages
1126 such as Chinese that have hundreds or thousands of characters.
1127 </para>
1128
1129 <para>To use the kosek method, you must:</para>
1130
1131 <orderedlist>
1132 <listitem>
1133 <para>Use a processor that supports its extensions, such as
1134 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
1135 </para>
1136 </listitem>
1137 <listitem>
1138 <para>Set the index.method parameter's value to <quote>kosek</quote>.
1139 </para>
1140 </listitem>
1141 <listitem>
1142 <para>Import the appropriate index extensions stylesheet module
1143 <filename>fo/autoidx-kosek.xsl</filename> or 
1144 <filename>html/autoidx-kosek.xsl</filename> into your
1145 customization.
1146 </para>
1147 </listitem>
1148 </orderedlist>
1149
1150 </listitem>
1151 </varlistentry>
1152 <varlistentry>
1153 <term><literal>kimber</literal></term>
1154 <listitem>
1155 <para>
1156 This method uses extensions to the Saxon processor to implement
1157 sophisticated indexing processes. It uses its own 
1158 configuration file, which can include information for any number of
1159 languages. Each language's configuration can group
1160 words using one of two processes. In the
1161 enumerated process similar to that used in the kosek method,
1162 you indicate the groupings character-by-character.
1163 In the between-key process, you specify the
1164 break-points in the sort order that should start a new group.
1165 The latter configuration is useful for ideographic languages
1166 such as Chinese, Japanese, and Korean.
1167 You can also define your own collation algorithms and how you
1168 want mixed Latin-alphabet words sorted.</para>
1169 <itemizedlist>
1170 <listitem>
1171 <para>For a whitepaper describing the extensions, see:
1172 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>.
1173 </para>
1174 </listitem>
1175 <listitem>
1176 <para>To download the extension library, see
1177 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
1178 </para>
1179 </listitem>
1180 </itemizedlist>
1181
1182 <para>To use the kimber method, you must:</para>
1183
1184 <orderedlist>
1185 <listitem>
1186 <para>Use Saxon (version 6 or 8) as your XSLT processor.
1187 </para>
1188 </listitem>
1189 <listitem>
1190 <para>Install and configure the Innodata Isogen library, using
1191 the documentation that comes with it.
1192 </para>
1193 </listitem>
1194 <listitem>
1195 <para>Set the index.method parameter's value to <quote>kimber</quote>.
1196 </para>
1197 </listitem>
1198 <listitem>
1199 <para>Import the appropriate index extensions stylesheet module
1200 <filename>fo/autoidx-kimber.xsl</filename> or 
1201 <filename>html/autoidx-kimber.xsl</filename> into your
1202 customization.
1203 </para>
1204 </listitem>
1205 </orderedlist>
1206
1207 </listitem>
1208 </varlistentry>
1209 </variablelist>
1210
1211 </refsection>
1212 </refentry>
1213
1214 <refentry version="5.0" id="index.on.type">
1215 <refmeta>
1216 <refentrytitle>index.on.type</refentrytitle>
1217 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1218 </refmeta>
1219 <refnamediv>
1220 <refname>index.on.type</refname>
1221 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
1222 attribute value</refpurpose>
1223 </refnamediv>
1224
1225 <refsynopsisdiv>
1226 <programlisting id="index.on.type.frag">
1227 &lt;xsl:param name="index.on.type" select="0"&gt;&lt;/xsl:param&gt;
1228 </programlisting>
1229 </refsynopsisdiv>
1230
1231 <refsection><info><title>Description</title></info>
1232
1233 <para>
1234 If non-zero, 
1235 then an <tag>index</tag> element that has a
1236 <tag class="attribute">type</tag> attribute
1237 value will contain only those <tag>indexterm</tag>
1238 elements with a matching <tag class="attribute">type</tag> attribute value.
1239 If an <tag>index</tag> has no <tag class="attribute">type</tag>
1240 attribute or it is blank, then the index will contain
1241 all <tag>indexterm</tag>s in the current scope.
1242 </para>
1243
1244 <para>
1245 If <literal>index.on.type</literal> is zero, then the
1246 <tag class="attribute">type</tag> attribute has no effect
1247 on selecting indexterms for an index.
1248 </para>
1249
1250 <para>For those using DocBook version 4.2 or earlier,
1251 the <tag class="attribute">type</tag> attribute is not available
1252 for index terms.  However, you can achieve the same
1253 effect by using the <tag class="attribute">role</tag> attribute
1254 in the same manner on <tag>indexterm</tag>
1255 and <tag>index</tag>, and setting the stylesheet parameter 
1256 <parameter>index.on.role</parameter> to a nonzero value.
1257 </para>
1258
1259 </refsection>
1260 </refentry>
1261
1262 <refentry version="5.0" id="index.on.role">
1263 <refmeta>
1264 <refentrytitle>index.on.role</refentrytitle>
1265 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1266 </refmeta>
1267 <refnamediv>
1268 <refname>index.on.role</refname>
1269 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
1270 </refnamediv>
1271
1272 <refsynopsisdiv>
1273 <programlisting id="index.on.role.frag">
1274 &lt;xsl:param name="index.on.role" select="0"&gt;&lt;/xsl:param&gt;
1275 </programlisting>
1276 </refsynopsisdiv>
1277
1278 <refsection><info><title>Description</title></info>
1279
1280 <para>
1281 If non-zero, 
1282 then an <tag>index</tag> element that has a
1283 <tag class="attribute">role</tag> attribute
1284 value will contain only those <tag>indexterm</tag>
1285 elements with a matching role value.
1286 If an <tag>index</tag> has no <tag class="attribute">role</tag>
1287 attribute or it is blank, then the index will contain
1288 all <tag>indexterm</tag>s in the current scope.
1289 </para>
1290 <para>
1291 If <literal>index.on.role</literal> is zero, then the
1292 <tag class="attribute">role</tag> attribute has no effect
1293 on selecting indexterms for an index.
1294 </para>
1295
1296 <para>If you are using DocBook version 4.3 or later, you should
1297 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
1298 on <tag>indexterm</tag> and <tag>index</tag>,
1299 and set the <parameter>index.on.type</parameter> to a nonzero
1300 value.
1301 </para>
1302
1303 </refsection>
1304 </refentry>
1305
1306 <refentry version="5.0" id="index.links.to.section">
1307 <refmeta>
1308 <refentrytitle>index.links.to.section</refentrytitle>
1309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1310 </refmeta>
1311 <refnamediv>
1312 <refname>index.links.to.section</refname>
1313 <refpurpose>HTML index entries link to container section title</refpurpose>
1314 </refnamediv>
1315
1316 <refsynopsisdiv>
1317 <programlisting id="index.links.to.section.frag">
1318 &lt;xsl:param name="index.links.to.section" select="1"&gt;&lt;/xsl:param&gt;
1319 </programlisting>
1320 </refsynopsisdiv>
1321
1322 <refsection><info><title>Description</title></info>
1323
1324 <para>If zero, then an index entry in an index links
1325 directly to the location of the
1326 generated <tag>anchor</tag> that is output
1327 for the indexterm. If two identical indexterm elements
1328 exist in the same section, then both entries appear
1329 in the index with the same title but link to different
1330 locations.</para>
1331
1332 <para>If non-zero, then an index entry in an index links to the
1333 section title containing the <tag>indexterm</tag>, rather than
1334 directly to the <tag>anchor</tag> output for the indexterm.
1335 Duplicate indexterm entries in the same section are dropped.
1336 </para>
1337
1338 <para>The default value is 1, so index entries link to
1339 section titles by default.</para>
1340
1341 <para>In both cases, the link text in an index entry is the
1342 title of the section containing the indexterm.
1343 That is because HTML does not have numbered pages.
1344 It also provides the reader with context information
1345 for each link.</para>
1346
1347 <para>This parameter lets you choose which style of
1348 index linking you want. </para>
1349
1350 <itemizedlist>
1351 <listitem>
1352 <para>When set to 0, an index entry takes you 
1353 to the precise location of its corresponding indexterm.
1354 However, if you have a lot of duplicate
1355 entries in sections, then you have a lot of duplicate
1356 titles in the index, which makes it more cluttered.
1357 The reader may not recognize why duplicate titles
1358 appear until they follow the links. Also, the links
1359 may land the reader in the middle of a section where the
1360 section title is not visible, which may also be
1361 confusing to the reader.</para>
1362 </listitem>
1363 <listitem>
1364 <para>When set to 1, an index entry link is
1365 less precise, but duplicate titles in the
1366 index entries are eliminated. 
1367 Landing on the section title location may confirm the reader's
1368 expectation that a link that
1369 shows a section title will take them to that section title,
1370 not a location within the section.
1371 </para>
1372 </listitem>
1373 </itemizedlist>
1374
1375 </refsection>
1376 </refentry>
1377
1378 <refentry version="5.0" id="index.prefer.titleabbrev">
1379 <refmeta>
1380 <refentrytitle>index.prefer.titleabbrev</refentrytitle>
1381 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1382 </refmeta>
1383 <refnamediv>
1384 <refname>index.prefer.titleabbrev</refname>
1385 <refpurpose>Should abbreviated titles be used as back references?</refpurpose>
1386 </refnamediv>
1387
1388 <refsynopsisdiv>
1389 <programlisting id="index.prefer.titleabbrev.frag">
1390 &lt;xsl:param name="index.prefer.titleabbrev" select="0"&gt;&lt;/xsl:param&gt;
1391 </programlisting>
1392 </refsynopsisdiv>
1393
1394 <refsection><info><title>Description</title></info>
1395
1396 <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
1397 is used as the link text of a back reference in the index.
1398 </para>
1399
1400 </refsection>
1401 </refentry>
1402
1403 <refentry version="5.0" id="index.term.separator">
1404 <refmeta>
1405 <refentrytitle>index.term.separator</refentrytitle>
1406 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1407 </refmeta>
1408 <refnamediv>
1409 <refname>index.term.separator</refname>
1410 <refpurpose>Override for punctuation separating an index term 
1411 from its list of page references in an index</refpurpose>
1412 </refnamediv>
1413
1414 <refsynopsisdiv>
1415 <programlisting id="index.term.separator.frag">
1416 &lt;xsl:param name="index.term.separator"&gt;&lt;/xsl:param&gt;
1417 </programlisting>
1418 </refsynopsisdiv>
1419
1420 <refsection><info><title>Description</title></info>
1421
1422 <para>This parameter permits you to override
1423 the text to insert between
1424 the end of an index term and its list of page references.
1425 Typically that might be a comma and a space.
1426 </para>
1427
1428 <para>Because this text may be locale dependent,
1429 this parameter's value is normally taken from a gentext
1430 template named 'term-separator' in the
1431 context 'index' in the stylesheet
1432 locale file for the language
1433 of the current document.
1434 This parameter can be used to override the gentext string,
1435 and would typically be used on the command line.
1436 This parameter would apply to all languages.
1437 </para>
1438
1439 <para>So this text string can be customized in two ways.
1440 You can reset the default gentext string using
1441 the <parameter>local.l10n.xml</parameter> parameter, or you can
1442 fill in the content for this normally empty 
1443 override parameter.
1444 The content can be a simple string, or it can be
1445 something more complex such as a call-template.
1446 For fo output, it could be an <tag>fo:leader</tag>
1447 element to provide space of a specific length, or a dot leader.
1448 </para>
1449
1450 </refsection>
1451 </refentry>
1452
1453 <refentry version="5.0" id="index.number.separator">
1454 <refmeta>
1455 <refentrytitle>index.number.separator</refentrytitle>
1456 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1457 </refmeta>
1458 <refnamediv>
1459 <refname>index.number.separator</refname>
1460 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
1461 </refnamediv>
1462
1463 <refsynopsisdiv>
1464 <programlisting id="index.number.separator.frag">
1465 &lt;xsl:param name="index.number.separator"&gt;&lt;/xsl:param&gt;
1466 </programlisting>
1467 </refsynopsisdiv>
1468
1469 <refsection><info><title>Description</title></info>
1470
1471 <para>This parameter permits you to override the text to insert between
1472 page references in a formatted index entry.  Typically 
1473 that would be a comma and a space.
1474 </para>
1475
1476 <para>Because this text may be locale dependent,
1477 this parameter's value is normally taken from a gentext
1478 template named 'number-separator' in the
1479 context 'index' in the stylesheet
1480 locale file for the language
1481 of the current document.
1482 This parameter can be used to override the gentext string,
1483 and would typically be used on the command line.
1484 This parameter would apply to all languages.
1485 </para>
1486
1487 <para>So this text string can be customized in two ways.
1488 You can reset the default gentext string using
1489 the <parameter>local.l10n.xml</parameter> parameter, or you can
1490 override the gentext with the content of this parameter.
1491 The content can be a simple string, or it can be
1492 something more complex such as a call-template.
1493 </para>
1494
1495 <para>In HTML index output, section title references are used instead of
1496 page number references.  This punctuation appears between
1497 such section titles in an HTML index.
1498 </para>
1499
1500 </refsection>
1501 </refentry>
1502
1503 <refentry version="5.0" id="index.range.separator">
1504 <refmeta>
1505 <refentrytitle>index.range.separator</refentrytitle>
1506 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1507 </refmeta>
1508 <refnamediv>
1509 <refname>index.range.separator</refname>
1510 <refpurpose>Override for punctuation separating the two numbers
1511 in a page range in index</refpurpose>
1512 </refnamediv>
1513
1514 <refsynopsisdiv>
1515 <programlisting id="index.range.separator.frag">
1516 &lt;xsl:param name="index.range.separator"&gt;&lt;/xsl:param&gt;
1517 </programlisting>
1518 </refsynopsisdiv>
1519
1520 <refsection><info><title>Description</title></info>
1521
1522 <para>This parameter permits you
1523 to override the text to insert between
1524 the two numbers of a page range in an index.
1525 This parameter is only used by those XSL-FO processors
1526 that support an extension for generating such page ranges
1527 (such as XEP).</para>
1528
1529 <para>Because this text may be locale dependent,
1530 this parameter's value is normally taken from a gentext
1531 template named 'range-separator' in the
1532 context 'index' in the stylesheet
1533 locale file for the language
1534 of the current document.
1535 This parameter can be used to override the gentext string,
1536 and would typically be used on the command line.
1537 This parameter would apply to all languages.
1538 </para>
1539
1540 <para>So this text string can be customized in two ways.
1541 You can reset the default gentext string using
1542 the <parameter>local.l10n.xml</parameter> parameter, or you can
1543 override the gentext with the content of this parameter.
1544 The content can be a simple string, or it can be
1545 something more complex such as a call-template.
1546 </para>
1547
1548 <para>In HTML index output, section title references are used instead of
1549 page number references. So there are no page ranges
1550 and this parameter has no effect.
1551 </para>
1552
1553 </refsection>
1554 </refentry>
1555
1556 </reference><reference id="dbk_ext" xml:base="../html/param.xml"><title>Stylesheet Extensions</title>
1557 <refentry version="5.0" id="linenumbering.everyNth">
1558 <refmeta>
1559 <refentrytitle>linenumbering.everyNth</refentrytitle>
1560 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1561 </refmeta>
1562 <refnamediv>
1563 <refname>linenumbering.everyNth</refname>
1564 <refpurpose>Indicate which lines should be numbered</refpurpose>
1565 </refnamediv>
1566
1567 <refsynopsisdiv>
1568 <programlisting id="linenumbering.everyNth.frag">
1569 &lt;xsl:param name="linenumbering.everyNth"&gt;5&lt;/xsl:param&gt;
1570 </programlisting>
1571 </refsynopsisdiv>
1572
1573 <refsection><info><title>Description</title></info>
1574
1575 <para>If line numbering is enabled, everyNth line will be
1576 numbered. Note that numbering is one based, not zero based.
1577 </para>
1578
1579 </refsection>
1580 </refentry>
1581
1582 <refentry version="5.0" id="linenumbering.extension">
1583 <refmeta>
1584 <refentrytitle>linenumbering.extension</refentrytitle>
1585 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1586 </refmeta>
1587 <refnamediv>
1588 <refname>linenumbering.extension</refname>
1589 <refpurpose>Enable the line numbering extension</refpurpose>
1590 </refnamediv>
1591
1592 <refsynopsisdiv>
1593 <programlisting id="linenumbering.extension.frag">
1594 &lt;xsl:param name="linenumbering.extension" select="1"&gt;&lt;/xsl:param&gt;
1595 </programlisting>
1596 </refsynopsisdiv>
1597
1598 <refsection><info><title>Description</title></info>
1599
1600 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
1601 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
1602 have line numbers.
1603 </para>
1604
1605 </refsection>
1606 </refentry>
1607
1608 <refentry version="5.0" id="linenumbering.separator">
1609 <refmeta>
1610 <refentrytitle>linenumbering.separator</refentrytitle>
1611 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1612 </refmeta>
1613 <refnamediv>
1614 <refname>linenumbering.separator</refname>
1615 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
1616 </refnamediv>
1617
1618 <refsynopsisdiv>
1619 <programlisting id="linenumbering.separator.frag">
1620 &lt;xsl:param name="linenumbering.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;
1621 </programlisting>
1622 </refsynopsisdiv>
1623
1624 <refsection><info><title>Description</title></info>
1625
1626 <para>The separator is inserted between line numbers and lines in the
1627 verbatim environment. The default value is a single white space.
1628  Note the interaction with <parameter>linenumbering.width</parameter>
1629 </para>
1630
1631 </refsection>
1632 </refentry>
1633
1634 <refentry version="5.0" id="linenumbering.width">
1635 <refmeta>
1636 <refentrytitle>linenumbering.width</refentrytitle>
1637 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1638 </refmeta>
1639 <refnamediv>
1640 <refname>linenumbering.width</refname>
1641 <refpurpose>Indicates the width of line numbers</refpurpose>
1642 </refnamediv>
1643
1644 <refsynopsisdiv>
1645 <programlisting id="linenumbering.width.frag">
1646 &lt;xsl:param name="linenumbering.width"&gt;3&lt;/xsl:param&gt;
1647 </programlisting>
1648 </refsynopsisdiv>
1649
1650 <refsection><info><title>Description</title></info>
1651
1652 <para>If line numbering is enabled, line numbers will appear right
1653 justified in a field "width" characters wide.
1654 </para>
1655
1656 </refsection>
1657 </refentry>
1658
1659 <refentry version="5.0" id="tablecolumns.extension">
1660 <refmeta>
1661 <refentrytitle>tablecolumns.extension</refentrytitle>
1662 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1663 </refmeta>
1664 <refnamediv>
1665 <refname>tablecolumns.extension</refname>
1666 <refpurpose>Enable the table columns extension function</refpurpose>
1667 </refnamediv>
1668
1669 <refsynopsisdiv>
1670 <programlisting id="tablecolumns.extension.frag">
1671 &lt;xsl:param name="tablecolumns.extension" select="1"&gt;&lt;/xsl:param&gt;
1672 </programlisting>
1673 </refsynopsisdiv>
1674
1675 <refsection><info><title>Description</title></info>
1676
1677 <para>The table columns extension function adjusts the widths of table
1678 columns in the HTML result to more accurately reflect the specifications
1679 in the CALS table.
1680 </para>
1681
1682 </refsection>
1683 </refentry>
1684
1685 <refentry version="5.0" id="textinsert.extension">
1686   <refmeta>
1687     <refentrytitle>textinsert.extension</refentrytitle>
1688     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1689   </refmeta>
1690   <refnamediv>
1691     <refname>textinsert.extension</refname>
1692     <refpurpose>Enables the textinsert extension element</refpurpose>
1693   </refnamediv>
1694   <refsynopsisdiv>
1695     <programlisting id="textinsert.extension.frag">
1696   &lt;xsl:param name="textinsert.extension" select="1"&gt;&lt;/xsl:param&gt;
1697 </programlisting>
1698   </refsynopsisdiv>
1699   <refsection><info><title>Description</title></info>
1700     <para>The textinsert extension element inserts the contents of
1701       a file into the result tree (as text).</para>
1702     <note>
1703       <para>To use the textinsert extension element, you must use
1704         either Saxon or Xalan as your XSLT processor (it doesn&#8217;t
1705         work with xsltproc), along with either the DocBook Saxon
1706         extensions or DocBook Xalan extensions (for more
1707         information about those extensions, see <link role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
1708         the <parameter>use.extensions</parameter> and
1709         <parameter>textinsert.extension</parameter> parameters to
1710         <literal>1</literal>.</para>
1711       <para>As an alternative to using the textinsert element,
1712         consider using an Xinclude element with the
1713         <literal>parse="text"</literal> attribute and value
1714         specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
1715     </note>
1716   </refsection>
1717   <refsection><info><title>See Also</title></info>
1718     <para>You can also use the <tag class="xmlpi">dbhtml-include&#160;href</tag> processing
1719       instruction to insert external files &#8212; both files containing
1720       plain text and files with markup content (including HTML
1721       content).</para>
1722   </refsection>
1723   <refsection><info><title>More information</title></info>
1724     <para>For how-to documentation on inserting contents of
1725       external code files and other text files into output, see
1726       <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
1727     <para>For guidelines on inserting contents of
1728       HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
1729   </refsection>
1730 </refentry>
1731
1732 <refentry version="5.0" id="textdata.default.encoding">
1733 <refmeta>
1734 <refentrytitle>textdata.default.encoding</refentrytitle>
1735 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1736 </refmeta>
1737 <refnamediv>
1738 <refname>textdata.default.encoding</refname>
1739 <refpurpose>Default encoding of external text files which are included
1740 using textdata element</refpurpose>
1741 </refnamediv>
1742
1743 <refsynopsisdiv>
1744 <programlisting id="textdata.default.encoding.frag">
1745 &lt;xsl:param name="textdata.default.encoding"&gt;&lt;/xsl:param&gt;
1746 </programlisting>
1747 </refsynopsisdiv>
1748
1749 <refsection><info><title>Description</title></info>
1750
1751 <para>Specifies the encoding of any external text files included using
1752 <tag>textdata</tag> element. This value is used only when you do
1753 not specify encoding by the appropriate attribute 
1754 directly on textdata. An empty string is interpreted as the system
1755 default encoding.</para>
1756
1757 </refsection>
1758 </refentry>
1759
1760 <refentry version="5.0" id="graphicsize.extension">
1761 <refmeta>
1762 <refentrytitle>graphicsize.extension</refentrytitle>
1763 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1764 </refmeta>
1765 <refnamediv>
1766 <refname>graphicsize.extension</refname>
1767 <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose>
1768 </refnamediv>
1769
1770 <refsynopsisdiv>
1771 <programlisting id="graphicsize.extension.frag">
1772 &lt;xsl:param name="graphicsize.extension" select="1"&gt;&lt;/xsl:param&gt;
1773 </programlisting>
1774 </refsynopsisdiv>
1775
1776 <refsection><info><title>Description</title></info>
1777
1778 <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero
1779 and if you're using a processor that supports extension functions), the
1780 <function>getWidth</function> and <function>getDepth</function> functions
1781 will be used to extract image sizes from graphics.</para>
1782
1783 </refsection>
1784 </refentry>
1785
1786 <refentry version="5.0" id="graphicsize.use.img.src.path">
1787 <refmeta>
1788 <refentrytitle>graphicsize.use.img.src.path</refentrytitle>
1789 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1790 </refmeta>
1791 <refnamediv>
1792 <refname>graphicsize.use.img.src.path</refname>
1793 <refpurpose>Prepend <parameter>img.src.path</parameter> before
1794 filenames passed to extension functions</refpurpose>
1795 </refnamediv>
1796
1797 <refsynopsisdiv>
1798 <programlisting id="graphicsize.use.img.src.path.frag">
1799 &lt;xsl:param name="graphicsize.use.img.src.path" select="0"&gt;&lt;/xsl:param&gt;
1800 </programlisting>
1801 </refsynopsisdiv>
1802
1803 <refsection><info><title>Description</title></info>
1804
1805 <para>If non-zero <parameter>img.src.path</parameter> parameter will
1806 be appended before filenames passed to extension functions for
1807 measuring image dimensions.</para>
1808
1809 </refsection>
1810 </refentry>
1811
1812 <refentry version="5.0" id="use.extensions">
1813 <refmeta>
1814 <refentrytitle>use.extensions</refentrytitle>
1815 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1816 </refmeta>
1817 <refnamediv>
1818 <refname>use.extensions</refname>
1819 <refpurpose>Enable extensions</refpurpose>
1820 </refnamediv>
1821
1822 <refsynopsisdiv>
1823 <programlisting id="use.extensions.frag">
1824 &lt;xsl:param name="use.extensions" select="0"&gt;&lt;/xsl:param&gt;
1825 </programlisting>
1826 </refsynopsisdiv>
1827
1828 <refsection><info><title>Description</title></info>
1829
1830 <para>If non-zero, extensions may be used. Each extension is
1831 further controlled by its own parameter. But if
1832 <parameter>use.extensions</parameter> is zero, no extensions will
1833 be used.
1834 </para>
1835
1836 </refsection>
1837 </refentry>
1838
1839 </reference><reference id="labels" xml:base="../html/param.xml"><title>Automatic labelling</title>
1840 <refentry version="5.0" id="chapter.autolabel">
1841 <refmeta>
1842 <refentrytitle>chapter.autolabel</refentrytitle>
1843 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
1844 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1845 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1846 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1847 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1848 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1849 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1850 </refmeta>
1851 <refnamediv>
1852 <refname>chapter.autolabel</refname>
1853 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
1854 </refnamediv>
1855
1856 <refsynopsisdiv>
1857 <programlisting id="chapter.autolabel.frag">
1858 &lt;xsl:param name="chapter.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
1859 </refsynopsisdiv>
1860
1861 <refsection><info><title>Description</title></info>
1862
1863 <para>If non-zero, then chapters will be numbered using the parameter
1864 value as the number format if the value matches one of the following:
1865 </para>
1866
1867 <variablelist>
1868   <varlistentry>
1869     <term>1 or arabic</term>
1870     <listitem>
1871       <para>Arabic numeration (1, 2, 3 ...).</para>
1872     </listitem>
1873   </varlistentry>
1874   <varlistentry>
1875     <term>A or upperalpha</term>
1876     <listitem>
1877       <para>Uppercase letter numeration (A, B, C ...).</para>
1878     </listitem>
1879   </varlistentry>
1880   <varlistentry>
1881     <term>a or loweralpha</term>
1882     <listitem>
1883       <para>Lowercase letter numeration (a, b, c ...).</para>
1884     </listitem>
1885   </varlistentry>
1886   <varlistentry>
1887     <term>I or upperroman</term>
1888     <listitem>
1889       <para>Uppercase roman numeration (I, II, III ...).</para>
1890     </listitem>
1891   </varlistentry>
1892   <varlistentry>
1893     <term>i or lowerroman</term>
1894     <listitem>
1895       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1896     </listitem>
1897   </varlistentry>
1898 </variablelist>
1899
1900 <para>Any nonzero value other than the above will generate
1901 the default number format (arabic).
1902 </para>
1903
1904 </refsection>
1905 </refentry>
1906
1907 <refentry version="5.0" id="appendix.autolabel">
1908 <refmeta>
1909 <refentrytitle>appendix.autolabel</refentrytitle>
1910 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
1911 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1912 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1913 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1914 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1915 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1916 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1917 </refmeta>
1918 <refnamediv>
1919 <refname>appendix.autolabel</refname>
1920 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
1921 </refnamediv>
1922
1923 <refsynopsisdiv>
1924 <programlisting id="appendix.autolabel.frag">
1925 &lt;xsl:param name="appendix.autolabel"&gt;A&lt;/xsl:param&gt;
1926 </programlisting>
1927 </refsynopsisdiv>
1928
1929 <refsection><info><title>Description</title></info>
1930
1931 <para>If non-zero, then appendices will be numbered using the
1932 parameter value as the number format if the value matches one of the
1933 following:
1934 </para>
1935
1936 <variablelist>
1937   <varlistentry>
1938     <term>1 or arabic</term>
1939     <listitem>
1940       <para>Arabic numeration (1, 2, 3 ...).</para>
1941     </listitem>
1942   </varlistentry>
1943   <varlistentry>
1944     <term>A or upperalpha</term>
1945     <listitem>
1946       <para>Uppercase letter numeration (A, B, C ...).</para>
1947     </listitem>
1948   </varlistentry>
1949   <varlistentry>
1950     <term>a or loweralpha</term>
1951     <listitem>
1952       <para>Lowercase letter numeration (a, b, c ...).</para>
1953     </listitem>
1954   </varlistentry>
1955   <varlistentry>
1956     <term>I or upperroman</term>
1957     <listitem>
1958       <para>Uppercase roman numeration (I, II, III ...).</para>
1959     </listitem>
1960   </varlistentry>
1961   <varlistentry>
1962     <term>i or lowerroman</term>
1963     <listitem>
1964       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1965     </listitem>
1966   </varlistentry>
1967 </variablelist>
1968
1969 <para>Any nonzero value other than the above will generate
1970 the default number format (upperalpha).
1971 </para>
1972
1973 </refsection>
1974 </refentry>
1975
1976 <refentry version="5.0" id="part.autolabel">
1977 <refmeta>
1978 <refentrytitle>part.autolabel</refentrytitle>
1979 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
1980 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1981 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1982 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1983 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1984 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1985 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1986 </refmeta>
1987 <refnamediv>
1988 <refname>part.autolabel</refname>
1989 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
1990 </refnamediv>
1991
1992 <refsynopsisdiv>
1993 <programlisting id="part.autolabel.frag">
1994 &lt;xsl:param name="part.autolabel"&gt;I&lt;/xsl:param&gt;
1995 </programlisting>
1996 </refsynopsisdiv>
1997
1998 <refsection><info><title>Description</title></info>
1999
2000 <para>If non-zero, then parts will be numbered using the parameter
2001 value as the number format if the value matches one of the following:
2002 </para>
2003
2004 <variablelist>
2005   <varlistentry>
2006     <term>1 or arabic</term>
2007     <listitem>
2008       <para>Arabic numeration (1, 2, 3 ...).</para>
2009     </listitem>
2010   </varlistentry>
2011   <varlistentry>
2012     <term>A or upperalpha</term>
2013     <listitem>
2014       <para>Uppercase letter numeration (A, B, C ...).</para>
2015     </listitem>
2016   </varlistentry>
2017   <varlistentry>
2018     <term>a or loweralpha</term>
2019     <listitem>
2020       <para>Lowercase letter numeration (a, b, c ...).</para>
2021     </listitem>
2022   </varlistentry>
2023   <varlistentry>
2024     <term>I or upperroman</term>
2025     <listitem>
2026       <para>Uppercase roman numeration (I, II, III ...).</para>
2027     </listitem>
2028   </varlistentry>
2029   <varlistentry>
2030     <term>i or lowerroman</term>
2031     <listitem>
2032       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2033     </listitem>
2034   </varlistentry>
2035 </variablelist>
2036
2037 <para>Any nonzero value other than the above will generate
2038 the default number format (upperroman).
2039 </para>
2040
2041
2042 </refsection>
2043 </refentry>
2044
2045 <refentry version="5.0" id="reference.autolabel">
2046 <refmeta>
2047 <refentrytitle>reference.autolabel</refentrytitle>
2048 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
2049 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2050 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2051 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2052 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2053 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2054 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2055 </refmeta>
2056 <refnamediv>
2057 <refname>reference.autolabel</refname>
2058 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
2059 </refnamediv>
2060 <refsynopsisdiv>
2061 <programlisting id="reference.autolabel.frag">
2062   &lt;xsl:param name="reference.autolabel"&gt;I&lt;/xsl:param&gt;
2063 </programlisting>
2064 </refsynopsisdiv>
2065 <refsection><info><title>Description</title></info>
2066 <para>If non-zero, references will be numbered using the parameter
2067   value as the number format if the value matches one of the
2068   following:
2069 </para>
2070 <variablelist>
2071   <varlistentry>
2072     <term>1 or arabic</term>
2073     <listitem>
2074       <para>Arabic numeration (1, 2, 3 ...).</para>
2075     </listitem>
2076   </varlistentry>
2077   <varlistentry>
2078     <term>A or upperalpha</term>
2079     <listitem>
2080       <para>Uppercase letter numeration (A, B, C ...).</para>
2081     </listitem>
2082   </varlistentry>
2083   <varlistentry>
2084     <term>a or loweralpha</term>
2085     <listitem>
2086       <para>Lowercase letter numeration (a, b, c ...).</para>
2087     </listitem>
2088   </varlistentry>
2089   <varlistentry>
2090     <term>I or upperroman</term>
2091     <listitem>
2092       <para>Uppercase roman numeration (I, II, III ...).</para>
2093     </listitem>
2094   </varlistentry>
2095   <varlistentry>
2096     <term>i or lowerroman</term>
2097     <listitem>
2098       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2099     </listitem>
2100   </varlistentry>
2101 </variablelist>
2102 <para>Any non-zero value other than the above will generate
2103 the default number format (upperroman).
2104 </para>
2105 </refsection>
2106 </refentry>
2107
2108 <refentry version="5.0" id="preface.autolabel">
2109 <refmeta>
2110 <refentrytitle>preface.autolabel</refentrytitle>
2111 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
2112 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2113 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2114 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2115 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2116 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2117 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2118 </refmeta>
2119 <refnamediv>
2120 <refname>preface.autolabel</refname>
2121 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
2122 </refnamediv>
2123
2124 <refsynopsisdiv>
2125 <programlisting id="preface.autolabel.frag">&lt;xsl:param name="preface.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2126 </refsynopsisdiv>
2127
2128 <refsection><info><title>Description</title></info>
2129
2130 <para>If non-zero then prefaces will be numbered using the parameter
2131 value as the number format if the value matches one of the following:
2132 </para>
2133
2134 <variablelist>
2135   <varlistentry>
2136     <term>1 or arabic</term>
2137     <listitem>
2138       <para>Arabic numeration (1, 2, 3 ...).</para>
2139     </listitem>
2140   </varlistentry>
2141   <varlistentry>
2142     <term>A or upperalpha</term>
2143     <listitem>
2144       <para>Uppercase letter numeration (A, B, C ...).</para>
2145     </listitem>
2146   </varlistentry>
2147   <varlistentry>
2148     <term>a or loweralpha</term>
2149     <listitem>
2150       <para>Lowercase letter numeration (a, b, c ...).</para>
2151     </listitem>
2152   </varlistentry>
2153   <varlistentry>
2154     <term>I or upperroman</term>
2155     <listitem>
2156       <para>Uppercase roman numeration (I, II, III ...).</para>
2157     </listitem>
2158   </varlistentry>
2159   <varlistentry>
2160     <term>i or lowerroman</term>
2161     <listitem>
2162       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2163     </listitem>
2164   </varlistentry>
2165 </variablelist>
2166
2167 <para>Any nonzero value other than the above will generate
2168 the default number format (arabic).
2169 </para>
2170
2171
2172 </refsection>
2173 </refentry>
2174
2175 <refentry version="5.0" id="qandadiv.autolabel">
2176 <refmeta>
2177 <refentrytitle>qandadiv.autolabel</refentrytitle>
2178 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2179 </refmeta>
2180 <refnamediv>
2181 <refname>qandadiv.autolabel</refname>
2182 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
2183 </refnamediv>
2184
2185 <refsynopsisdiv>
2186 <programlisting id="qandadiv.autolabel.frag">&lt;xsl:param name="qandadiv.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
2187 </refsynopsisdiv>
2188
2189 <refsection><info><title>Description</title></info>
2190
2191 <para>If non-zero, unlabeled qandadivs will be enumerated.
2192 </para>
2193
2194 </refsection>
2195 </refentry>
2196
2197 <refentry version="5.0" id="section.autolabel">
2198 <refmeta>
2199 <refentrytitle>section.autolabel</refentrytitle>
2200 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2201 </refmeta>
2202 <refnamediv>
2203 <refname>section.autolabel</refname>
2204 <refpurpose>Are sections enumerated?</refpurpose>
2205 </refnamediv>
2206
2207 <refsynopsisdiv>
2208 <programlisting id="section.autolabel.frag">&lt;xsl:param name="section.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2209 </refsynopsisdiv>
2210
2211 <refsection><info><title>Description</title></info>
2212
2213 <para>If true (non-zero), unlabeled sections will be enumerated.
2214 </para>
2215
2216 </refsection>
2217 </refentry>
2218
2219 <refentry version="5.0" id="section.autolabel.max.depth">
2220 <refmeta>
2221 <refentrytitle>section.autolabel.max.depth</refentrytitle>
2222 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2223 </refmeta>
2224 <refnamediv>
2225 <refname>section.autolabel.max.depth</refname>
2226 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
2227 </refnamediv>
2228
2229 <refsynopsisdiv>
2230 <programlisting id="section.autolabel.max.depth.frag">
2231 &lt;xsl:param name="section.autolabel.max.depth"&gt;8&lt;/xsl:param&gt;
2232 </programlisting>
2233 </refsynopsisdiv>
2234
2235 <refsection><info><title>Description</title></info>
2236
2237 <para>When section numbering is turned on by the
2238 <parameter>section.autolabel</parameter> parameter, then this
2239 parameter controls the depth of <tag>section</tag> nesting that is
2240 numbered.  Sections nested to a level deeper than this value will not
2241 be numbered.
2242 </para>
2243
2244 </refsection>
2245 </refentry>
2246
2247 <refentry version="5.0" id="section.label.includes.component.label">
2248 <refmeta>
2249 <refentrytitle>section.label.includes.component.label</refentrytitle>
2250 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2251 </refmeta>
2252 <refnamediv>
2253 <refname>section.label.includes.component.label</refname>
2254 <refpurpose>Do section labels include the component label?</refpurpose>
2255 </refnamediv>
2256
2257 <refsynopsisdiv>
2258 <programlisting id="section.label.includes.component.label.frag">&lt;xsl:param name="section.label.includes.component.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2259 </refsynopsisdiv>
2260
2261 <refsection><info><title>Description</title></info>
2262
2263 <para>If non-zero, section labels are prefixed with the label of the
2264 component that contains them.
2265 </para>
2266
2267 </refsection>
2268 </refentry>
2269
2270 <refentry version="5.0" id="label.from.part">
2271 <refmeta>
2272 <refentrytitle>label.from.part</refentrytitle>
2273 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2274 </refmeta>
2275 <refnamediv>
2276 <refname>label.from.part</refname>
2277 <refpurpose>Renumber components in each part?</refpurpose>
2278 </refnamediv>
2279
2280 <refsynopsisdiv>
2281 <programlisting id="label.from.part.frag">
2282 &lt;xsl:param name="label.from.part" select="0"&gt;&lt;/xsl:param&gt;
2283 </programlisting>
2284 </refsynopsisdiv>
2285
2286 <refsection><info><title>Description</title></info>
2287
2288 <para>If <parameter>label.from.part</parameter> is non-zero, then
2289   numbering of components &#8212; <tag>preface</tag>,
2290   <tag>chapter</tag>, <tag>appendix</tag>, and
2291   <tag>reference</tag> (when <tag>reference</tag> occurs at the
2292   component level) &#8212; is re-started within each
2293   <tag>part</tag>.</para>
2294 <para>If <parameter>label.from.part</parameter> is zero (the
2295   default), numbering of components is <emphasis>not</emphasis>
2296   re-started within each <tag>part</tag>; instead, components are
2297   numbered sequentially throughout each <tag>book</tag>,
2298   regardless of whether or not they occur within <tag>part</tag>
2299   instances.</para>
2300
2301 </refsection>
2302 </refentry>
2303
2304 <refentry version="5.0" id="component.label.includes.part.label">
2305 <refmeta>
2306 <refentrytitle>component.label.includes.part.label</refentrytitle>
2307 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2308 </refmeta>
2309 <refnamediv>
2310 <refname>component.label.includes.part.label</refname>
2311 <refpurpose>Do component labels include the part label?</refpurpose>
2312 </refnamediv>
2313
2314 <refsynopsisdiv>
2315 <programlisting id="component.label.includes.part.label.frag">&lt;xsl:param name="component.label.includes.part.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2316 </refsynopsisdiv>
2317
2318 <refsection><info><title>Description</title></info>
2319
2320 <para>If non-zero, number labels for <tag>chapter</tag>,
2321 <tag>appendix</tag>, and other component elements are prefixed with
2322 the label of the part element that contains them.  So you might see
2323 Chapter II.3 instead of Chapter 3.  Also, the labels for formal
2324 elements such as <tag>table</tag> and <tag>figure</tag> will include
2325 the part label.  If there is no part element container, then no prefix
2326 is generated.
2327 </para>
2328 <para>
2329 This feature is most useful when the
2330 <parameter>label.from.part</parameter> parameter is turned on.
2331 In that case, there would be more than one <tag>chapter</tag>
2332 <quote>1</quote>, and the extra part label prefix will identify
2333 each chapter unambiguously.
2334 </para>
2335
2336 </refsection>
2337 </refentry>
2338
2339 </reference><reference id="html" xml:base="../html/param.xml"><title>HTML</title>
2340 <refentry version="5.0" id="html.base">
2341 <refmeta>
2342 <refentrytitle>html.base</refentrytitle>
2343 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2344 </refmeta>
2345 <refnamediv>
2346 <refname>html.base</refname>
2347 <refpurpose>An HTML base URI</refpurpose>
2348 </refnamediv>
2349
2350 <refsynopsisdiv>
2351 <programlisting id="html.base.frag">
2352 &lt;xsl:param name="html.base"&gt;&lt;/xsl:param&gt;</programlisting>
2353 </refsynopsisdiv>
2354
2355 <refsection><info><title>Description</title></info>
2356
2357 <para>If html.base is set, it is used for the <tag>base</tag> element
2358 in the <tag>head</tag> of the html documents.  The parameter specifies
2359 the base URL for all relative URLs in the document.  This is useful
2360 for dynamically served html where the base URI needs to be
2361 shifted.</para>
2362
2363 </refsection>
2364 </refentry>
2365
2366 <refentry version="5.0" id="html.stylesheet.type">
2367 <refmeta>
2368 <refentrytitle>html.stylesheet.type</refentrytitle>
2369 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2370 </refmeta>
2371 <refnamediv>
2372 <refname>html.stylesheet.type</refname>
2373 <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose>
2374 </refnamediv>
2375
2376 <refsynopsisdiv>
2377 <programlisting id="html.stylesheet.type.frag">&lt;xsl:param name="html.stylesheet.type"&gt;text/css&lt;/xsl:param&gt;</programlisting>
2378 </refsynopsisdiv>
2379
2380 <refsection><info><title>Description</title></info>
2381
2382 <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag.
2383 </para>
2384
2385 </refsection>
2386 </refentry>
2387
2388 <refentry version="5.0" id="html.stylesheet">
2389 <refmeta>
2390 <refentrytitle>html.stylesheet</refentrytitle>
2391 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2392 </refmeta>
2393 <refnamediv>
2394 <refname>html.stylesheet</refname>
2395 <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose>
2396 </refnamediv>
2397
2398 <refsynopsisdiv>
2399 <programlisting id="html.stylesheet.frag">
2400 &lt;xsl:param name="html.stylesheet"&gt;&lt;/xsl:param&gt;
2401 </programlisting>
2402 </refsynopsisdiv>
2403
2404 <refsection><info><title>Description</title></info>
2405
2406 <para>The <parameter>html.stylesheet</parameter> parameter is either
2407 empty, indicating that no stylesheet <tag>link</tag> tag should be
2408 generated in the html output, or it is a list of one or more
2409 stylesheet files.</para>
2410
2411 <para>Multiple stylesheets are space-delimited. If you need to
2412 reference a stylesheet URI that includes a space, encode it with
2413 <literal>%20</literal>. A separate html <literal>link</literal> element will
2414 be generated for each stylesheet in the order they are listed in the
2415 parameter.</para>
2416
2417 </refsection>
2418 </refentry>
2419
2420 <refentry version="5.0" id="css.decoration">
2421 <refmeta>
2422 <refentrytitle>css.decoration</refentrytitle>
2423 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2424 </refmeta>
2425 <refnamediv>
2426 <refname>css.decoration</refname>
2427 <refpurpose>Enable CSS decoration of elements</refpurpose>
2428 </refnamediv>
2429
2430 <refsynopsisdiv>
2431 <programlisting id="css.decoration.frag">
2432 &lt;xsl:param name="css.decoration" select="1"&gt;&lt;/xsl:param&gt;
2433 </programlisting>
2434 </refsynopsisdiv>
2435
2436 <refsection><info><title>Description</title></info>
2437
2438 <para>
2439 If non-zero, then html elements produced by the stylesheet may be
2440 decorated with <literal>style</literal> attributes.  For example, the
2441 <literal>li</literal> tags produced for list items may include a
2442 fragment of CSS in the <literal>style</literal> attribute which sets
2443 the CSS property "list-style-type".
2444 </para>
2445
2446 </refsection>
2447 </refentry>
2448
2449 <refentry version="5.0" id="spacing.paras">
2450 <refmeta>
2451 <refentrytitle>spacing.paras</refentrytitle>
2452 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2453 </refmeta>
2454 <refnamediv>
2455 <refname>spacing.paras</refname>
2456 <refpurpose>Insert additional &lt;p&gt; elements for spacing?</refpurpose>
2457 </refnamediv>
2458
2459 <refsynopsisdiv>
2460 <programlisting id="spacing.paras.frag">
2461 &lt;xsl:param name="spacing.paras" select="0"&gt;&lt;/xsl:param&gt;
2462 </programlisting>
2463 </refsynopsisdiv>
2464
2465 <refsection><info><title>Description</title></info>
2466
2467 <para>When non-zero, additional, empty paragraphs are inserted in
2468 several contexts (for example, around informal figures), to create a
2469 more pleasing visual appearance in many browsers.
2470 </para>
2471
2472 </refsection>
2473 </refentry>
2474
2475 <refentry version="5.0" id="emphasis.propagates.style">
2476 <refmeta>
2477 <refentrytitle>emphasis.propagates.style</refentrytitle>
2478 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2479 </refmeta>
2480 <refnamediv>
2481 <refname>emphasis.propagates.style</refname>
2482 <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose>
2483 </refnamediv>
2484 <refsynopsisdiv>
2485 <programlisting id="emphasis.propagates.style.frag">
2486 &lt;xsl:param name="emphasis.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
2487 </programlisting>
2488 </refsynopsisdiv>
2489 <refsection><info><title>Description</title></info>
2490 <para>If non-zero, the <literal>role</literal> attribute of
2491 <tag>emphasis</tag> elements will be passed through to the HTML as a
2492 class attribute on a <literal>span</literal> that surrounds the
2493 emphasis.</para>
2494 </refsection>
2495 </refentry>
2496
2497 <refentry version="5.0" id="para.propagates.style">
2498 <refmeta>
2499 <refentrytitle>para.propagates.style</refentrytitle>
2500 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2501 </refmeta>
2502 <refnamediv>
2503 <refname>para.propagates.style</refname>
2504 <refpurpose>Pass para role attribute through to HTML?</refpurpose>
2505 </refnamediv>
2506
2507 <refsynopsisdiv>
2508 <programlisting id="para.propagates.style.frag">
2509 &lt;xsl:param name="para.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
2510 </programlisting>
2511 </refsynopsisdiv>
2512
2513 <refsection><info><title>Description</title></info>
2514
2515 <para>If true, the role attribute of <tag>para</tag> elements
2516 will be passed through to the HTML as a class attribute on the
2517 <tag>p</tag> generated for the paragraph.</para>
2518
2519 </refsection>
2520 </refentry>
2521
2522 <refentry version="5.0" id="phrase.propagates.style">
2523 <refmeta>
2524 <refentrytitle>phrase.propagates.style</refentrytitle>
2525 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2526 </refmeta>
2527 <refnamediv>
2528 <refname>phrase.propagates.style</refname>
2529 <refpurpose>Pass phrase role attribute through to HTML?</refpurpose>
2530 </refnamediv>
2531
2532 <refsynopsisdiv>
2533 <programlisting id="phrase.propagates.style.frag">
2534 &lt;xsl:param name="phrase.propagates.style" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
2535 </refsynopsisdiv>
2536
2537 <refsection><info><title>Description</title></info>
2538
2539 <para>If non-zero, the role attribute of <tag>phrase</tag> elements
2540 will be passed through to the HTML as a <literal>class</literal>
2541 attribute on a <literal>span</literal> that surrounds the
2542 phrase.</para>
2543
2544 </refsection>
2545 </refentry>
2546
2547 <refentry version="5.0" id="entry.propagates.style">
2548 <refmeta>
2549 <refentrytitle>entry.propagates.style</refentrytitle>
2550 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2551 </refmeta>
2552 <refnamediv>
2553 <refname>entry.propagates.style</refname>
2554 <refpurpose>Pass entry role attribute through to HTML?</refpurpose>
2555 </refnamediv>
2556
2557 <refsynopsisdiv>
2558 <programlisting id="entry.propagates.style.frag">
2559 &lt;xsl:param name="entry.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
2560 </programlisting>
2561 </refsynopsisdiv>
2562
2563 <refsection><info><title>Description</title></info>
2564
2565 <para>If true, the role attribute of <tag>entry</tag> elements
2566 will be passed through to the HTML as a class attribute on the
2567 <tag>td</tag> or <tag>th</tag> generated for the table
2568 cell.</para>
2569
2570 </refsection>
2571 </refentry>
2572
2573 <refentry version="5.0" id="html.longdesc">
2574 <refmeta>
2575 <refentrytitle>html.longdesc</refentrytitle>
2576 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2577 </refmeta>
2578 <refnamediv>
2579 <refname>html.longdesc</refname>
2580 <refpurpose>Should longdesc URIs be created?</refpurpose>
2581 </refnamediv>
2582 <refsynopsisdiv>
2583 <programlisting id="html.longdesc.frag">
2584 &lt;xsl:param name="html.longdesc" select="1"&gt;&lt;/xsl:param&gt;
2585 </programlisting>
2586 </refsynopsisdiv>
2587 <refsection><info><title>Description</title></info>
2588 <para>If non-zero, HTML files will be created for the
2589 <literal>longdesc</literal> attribute. These files
2590 are created from the <tag>textobject</tag>s in
2591 <tag>mediaobject</tag>s and
2592 <tag>inlinemediaobject</tag>.
2593 </para>
2594 </refsection>
2595 </refentry>
2596
2597 <refentry version="5.0" id="html.longdesc.link">
2598 <refmeta>
2599 <refentrytitle>html.longdesc.link</refentrytitle>
2600 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2601 </refmeta>
2602 <refnamediv>
2603 <refname>html.longdesc.link</refname>
2604 <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose>
2605 </refnamediv>
2606
2607 <refsynopsisdiv>
2608 <programlisting id="html.longdesc.link.frag">
2609 &lt;xsl:param name="html.longdesc.link" select="$html.longdesc"&gt;&lt;/xsl:param&gt;
2610 </programlisting>
2611 </refsynopsisdiv>
2612
2613 <refsection><info><title>Description</title></info>
2614
2615 <para>If non-zero, links will be created to the
2616 HTML files created for the
2617 <literal>longdesc</literal> attribute. It makes no
2618 sense to enable this option without also enabling the
2619 <parameter>html.longdesc</parameter> parameter.</para>
2620
2621
2622
2623 </refsection>
2624 </refentry>
2625
2626 <refentry version="5.0" id="make.valid.html">
2627 <refmeta>
2628 <refentrytitle>make.valid.html</refentrytitle>
2629 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2630 </refmeta>
2631 <refnamediv>
2632 <refname>make.valid.html</refname>
2633 <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose>
2634 </refnamediv>
2635
2636 <refsynopsisdiv>
2637 <programlisting id="make.valid.html.frag">
2638 &lt;xsl:param name="make.valid.html" select="0"&gt;&lt;/xsl:param&gt;
2639 </programlisting>
2640 </refsynopsisdiv>
2641
2642 <refsection><info><title>Description</title></info>
2643
2644 <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take
2645 extra effort to ensure that the resulting HTML is valid. This may mean that some
2646 <tag>para</tag> tags are translated into HTML <tag>div</tag>s or
2647 that other substitutions occur.</para>
2648
2649 <para>This parameter is different from <parameter>html.cleanup</parameter>
2650 because it changes the resulting markup; it does not use extension functions
2651 to manipulate result-tree-fragments and is therefore applicable to any
2652 XSLT processor.</para>
2653
2654 </refsection>
2655 </refentry>
2656
2657 <refentry version="5.0" id="html.cleanup">
2658 <refmeta>
2659 <refentrytitle>html.cleanup</refentrytitle>
2660 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2661 </refmeta>
2662 <refnamediv>
2663 <refname>html.cleanup</refname>
2664 <refpurpose>Attempt to clean up the resulting HTML?</refpurpose>
2665 </refnamediv>
2666
2667 <refsynopsisdiv>
2668 <programlisting id="html.cleanup.frag">
2669 &lt;xsl:param name="html.cleanup" select="1"&gt;&lt;/xsl:param&gt;
2670 </programlisting>
2671 </refsynopsisdiv>
2672
2673 <refsection><info><title>Description</title></info>
2674
2675 <para>If non-zero, and if the <link xlink:href="http://www.exslt.org/">EXSLT</link>
2676 extensions are supported by your processor, the resulting HTML will be
2677 <quote>cleaned up</quote>. This improves the chances that the
2678 resulting HTML will be valid. It may also improve the formatting of
2679 some elements.</para>
2680
2681 <para>This parameter is different from <parameter>make.valid.html</parameter>
2682 because it uses extension functions to manipulate result-tree-fragments.</para>
2683
2684 </refsection>
2685 </refentry>
2686
2687 <refentry version="5.0" id="html.append">
2688 <refmeta>
2689 <refentrytitle>html.append</refentrytitle>
2690 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2691 </refmeta>
2692 <refnamediv>
2693 <refname>html.append</refname>
2694 <refpurpose>Specifies content to append to HTML output</refpurpose>
2695 </refnamediv>
2696
2697 <refsynopsisdiv>
2698 <programlisting id="html.append.frag">&lt;xsl:param name="html.append"&gt;&lt;/xsl:param&gt;</programlisting>
2699 </refsynopsisdiv>
2700
2701 <refsection><info><title>Description</title></info>
2702
2703 <para>Specifies content to append to the end of HTML files output by
2704 the <filename>html/docbook.xsl</filename> stylesheet, after the
2705 closing <code>&lt;html&gt;</code> tag. You probably don&#8217;t want to set any
2706 value for this parameter; but if you do, the only value it should ever
2707 be set to is a newline character: <code>&amp;#x0a;</code> or
2708 <code>&amp;#10;</code></para>
2709
2710 </refsection>
2711 </refentry>
2712
2713 <refentry version="5.0" id="draft.mode">
2714 <refmeta>
2715 <refentrytitle>draft.mode</refentrytitle>
2716 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2717 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> 
2718 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
2719 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
2720 </refmeta>
2721 <refnamediv>
2722 <refname>draft.mode</refname>
2723 <refpurpose>Select draft mode</refpurpose>
2724 </refnamediv>
2725
2726 <refsynopsisdiv>
2727 <programlisting id="draft.mode.frag">
2728 &lt;xsl:param name="draft.mode"&gt;no&lt;/xsl:param&gt;
2729 </programlisting>
2730 </refsynopsisdiv>
2731
2732 <refsection><info><title>Description</title></info>
2733
2734 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
2735 <quote><literal>yes</literal></quote>, the entire document will be treated
2736 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
2737 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
2738 individual sections will be treated as draft or final independently, depending
2739 on how their <literal>status</literal> attribute is set.
2740 </para>
2741
2742 </refsection>
2743 </refentry>
2744
2745 <refentry version="5.0" id="draft.watermark.image">
2746 <refmeta>
2747 <refentrytitle>draft.watermark.image</refentrytitle>
2748 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2749 </refmeta>
2750 <refnamediv>
2751 <refname>draft.watermark.image</refname>
2752 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
2753 </refnamediv>
2754
2755 <refsynopsisdiv>
2756 <programlisting id="draft.watermark.image.frag">
2757 &lt;xsl:param name="draft.watermark.image"&gt;images/draft.png&lt;/xsl:param&gt;
2758 </programlisting>
2759 </refsynopsisdiv>
2760
2761 <refsection><info><title>Description</title></info>
2762
2763 <para>The image to be used for draft watermarks.</para>
2764
2765 </refsection>
2766 </refentry>
2767
2768 <refentry version="5.0" id="generate.id.attributes">
2769 <refmeta>
2770 <refentrytitle>generate.id.attributes</refentrytitle>
2771 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2772 </refmeta>
2773 <refnamediv>
2774 <refname>generate.id.attributes</refname>
2775 <refpurpose>Generate ID attributes on container elements?</refpurpose>
2776 </refnamediv>
2777
2778 <refsynopsisdiv>
2779 <programlisting id="generate.id.attributes.frag">
2780 &lt;xsl:param name="generate.id.attributes" select="0"&gt;&lt;/xsl:param&gt;
2781 </programlisting>
2782 </refsynopsisdiv>
2783
2784 <refsection><info><title>Description</title></info>
2785
2786 <para>If non-zero, the HTML stylesheet will generate ID attributes on
2787 containers. For example, the markup:</para>
2788
2789 <screen>&lt;section id="foo"&gt;&lt;title&gt;Some Title&lt;/title&gt;
2790 &lt;para&gt;Some para.&lt;/para&gt;
2791 &lt;/section&gt;</screen>
2792
2793 <para>might produce:</para>
2794
2795 <screen>&lt;div class="section" id="foo"&gt;
2796 &lt;h2&gt;Some Title&lt;/h2&gt;
2797 &lt;p&gt;Some para.&lt;/p&gt;
2798 &lt;/div&gt;</screen>
2799
2800 <para>The alternative is to generate anchors:</para>
2801
2802 <screen>&lt;div class="section"&gt;
2803 &lt;h2&gt;&lt;a name="foo"&gt;&lt;/a&gt;Some Title&lt;/h2&gt;
2804 &lt;p&gt;Some para.&lt;/p&gt;
2805 &lt;/div&gt;</screen>
2806
2807 <para>Because the <tag class="attribute">name</tag> attribute of
2808 the <tag>a</tag> element and the <tag class="attribute">id</tag>
2809 attribute of other tags are both of type <quote>ID</quote>, producing both
2810 generates invalid documents.</para>
2811
2812 <para>As of version 1.50, you can use this switch to control which type of
2813 identifier is generated. For backwards-compatibility, generating
2814 <tag>a</tag> anchors is preferred.</para>
2815
2816 <para>Note: at present, this switch is incompletely implemented.
2817 Disabling ID attributes will suppress them, but enabling ID attributes
2818 will not suppress the anchors.</para>
2819
2820 </refsection>
2821 </refentry>
2822
2823 <refentry version="5.0" id="generate.meta.abstract">
2824 <refmeta>
2825 <refentrytitle>generate.meta.abstract</refentrytitle>
2826 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2827 </refmeta>
2828 <refnamediv>
2829 <refname>generate.meta.abstract</refname>
2830 <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose>
2831 </refnamediv>
2832
2833 <refsynopsisdiv>
2834 <programlisting id="generate.meta.abstract.frag">
2835 &lt;xsl:param name="generate.meta.abstract" select="1"&gt;&lt;/xsl:param&gt;
2836 </programlisting>
2837 </refsynopsisdiv>
2838
2839 <refsection><info><title>Description</title></info>
2840
2841 <para>If non-zero, document abstracts will be reproduced in the HTML
2842 <literal>head</literal>, with <literal>&gt;meta name="description" content="..."</literal></para>
2843
2844
2845 </refsection>
2846 </refentry>
2847
2848 <refentry version="5.0" id="make.clean.html">
2849 <refmeta>
2850 <refentrytitle>make.clean.html</refentrytitle>
2851 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2852 </refmeta>
2853 <refnamediv>
2854 <refname>make.clean.html</refname>
2855 <refpurpose>Make HTML conform to modern coding standards</refpurpose>
2856 </refnamediv>
2857
2858 <refsynopsisdiv>
2859 <programlisting id="make.clean.html.frag">
2860 &lt;xsl:param name="make.clean.html" select="0"&gt;&lt;/xsl:param&gt;
2861 </programlisting>
2862 </refsynopsisdiv>
2863
2864 <refsection><info><title>Description</title></info>
2865
2866 <para>If <parameter>make.clean.html</parameter> is true, the stylesheets take
2867 extra effort to ensure that the resulting HTML is conforms to
2868 modern HTML coding standards.  In addition to eliminating
2869 excessive and noncompliant coding, it moves presentation
2870 HTML coding to a CSS stylesheet.</para>
2871
2872 <para>The resulting HTML is dependent on
2873 CSS for formatting, and so the stylesheet is capable of
2874 generating a supporting CSS file. The <parameter>docbook.css.source</parameter>
2875 and <parameter>custom.css.source</parameter> parameters control
2876 how a CSS file is generated.</para>
2877
2878 <para>If you require your CSS to reside in the HTML 
2879 <tag>head</tag> element, then the <parameter>generate.css.header</parameter>
2880 can be used to do that.</para>
2881
2882 <para>The <parameter>make.clean.html</parameter> parameter is
2883 different from <parameter>html.cleanup</parameter>
2884 because the former changes the resulting markup; it does not use extension functions
2885 like the latter to manipulate result-tree-fragments,
2886 and is therefore applicable to any XSLT processor.</para>
2887
2888 <para>If <parameter>make.clean.html</parameter> is set to zero (the default),
2889 then the stylesheet retains its original 
2890 <quote>old style</quote>
2891 HTML formatting features.</para>
2892 </refsection>
2893 </refentry>
2894
2895 <refentry version="5.0" id="docbook.css.source">
2896   <refmeta>
2897     <refentrytitle>docbook.css.source</refentrytitle>
2898     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2899   </refmeta>
2900   <refnamediv>
2901     <refname>docbook.css.source</refname>
2902     <refpurpose>Name of the default CSS input file</refpurpose>
2903   </refnamediv>
2904
2905   <refsynopsisdiv>
2906     <programlisting id="docbook.css.source.frag">&lt;xsl:param name="docbook.css.source"&gt;docbook.css.xml&lt;/xsl:param&gt;</programlisting>
2907   </refsynopsisdiv>
2908
2909   <refsection><info><title>Description</title></info>
2910
2911 <para>The <parameter>docbook.css.source</parameter> parameter
2912 specifies the name of the file containing the default DocBook
2913 CSS styles.  Those styles are necessary when the
2914 <parameter>make.clean.html</parameter> parameter is nonzero.</para>
2915
2916 <para>The file is a well-formed XML file that
2917 must consist of a single <tag>style</tag> root
2918 element that contains CSS styles as its text content.
2919 The default value of the parameter (and filename)
2920 is <literal>docbook.css.xml</literal>.
2921 The stylesheets ship with the default file. You can substitute
2922 your own and specify its path in this parameter.</para>
2923
2924 <para>If <parameter>docbook.css.source</parameter> is not blank,
2925 and <parameter>make.clean.html</parameter> is nonzero, then
2926 the stylesheet takes the following actions:</para>
2927
2928 <orderedlist>
2929   <listitem>
2930     <para>The stylesheet uses the XSLT <literal>document()</literal>
2931     function to open the file specified by the parameter and
2932     load it into a variable.</para>
2933   </listitem>
2934   <listitem>
2935     <para>The stylesheet forms an output pathname consisting of the
2936     value of the <parameter>base.dir</parameter> parameter (if it is set)
2937     and the value of <parameter>docbook.css.source</parameter>,
2938     with the <literal>.xml</literal> suffix stripped off.
2939     </para>
2940   </listitem>
2941   <listitem>
2942     <para>The stylesheet removes the <tag>style</tag>
2943     wrapper element and writes just the CSS text content to the output file.</para>
2944   </listitem>
2945   <listitem>
2946     <para>The stylesheet adds a <tag>link</tag> element to the
2947     HTML <tag>HEAD</tag> element to reference the external CSS stylesheet.
2948     For example:</para>
2949     <programlisting>&lt;link rel="stylesheet" href="docbook.css" type="text/css"&gt;
2950     </programlisting>
2951     <para>However, if the <parameter>docbook.css.link</parameter>
2952     parameter is set to zero, then no <tag>link</tag> is written
2953     for the default CSS file.  That is useful if a custom
2954     CSS file will import the default CSS stylesheet to ensure
2955     proper cascading of styles.</para>
2956   </listitem>
2957 </orderedlist>
2958
2959 <para>If the <parameter>docbook.css.source</parameter> parameter
2960 is changed from its default <literal>docbook.css.xml</literal> to blank,
2961 then no default CSS is generated. Likewise if the
2962 <parameter>make.clean.html</parameter> parameter is set to zero,
2963 then no default CSS is generated. The 
2964 <parameter>custom.css.source</parameter> parameter can be used
2965 instead to generate a complete custom CSS file.</para>
2966
2967 <para>You can use the <parameter>generate.css.header</parameter>
2968 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
2969 element in a <tag>style</tag> tag instead of an external CSS file.</para>
2970
2971   </refsection>
2972 </refentry>
2973
2974 <refentry version="5.0" id="docbook.css.link">
2975 <refmeta>
2976 <refentrytitle>docbook.css.link</refentrytitle>
2977 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2978 </refmeta>
2979 <refnamediv>
2980 <refname>docbook.css.link</refname>
2981 <refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose>
2982 </refnamediv>
2983
2984 <refsynopsisdiv>
2985 <programlisting id="docbook.css.link.frag">
2986 &lt;xsl:param name="docbook.css.link" select="1"&gt;&lt;/xsl:param&gt;
2987 </programlisting>
2988 </refsynopsisdiv>
2989
2990 <refsection><info><title>Description</title></info>
2991
2992 <para>The stylesheets are capable of generating a default
2993 CSS stylesheet file.  The parameters 
2994 <parameter>make.clean.html</parameter> and
2995 <parameter>docbook.css.source</parameter> control that feature.</para>
2996
2997 <para>Normally if a default CSS file is generated, then 
2998 the stylesheet inserts a <tag>link</tag> tag in the HTML
2999 <tag>HEAD</tag> element to reference it.
3000 However, you can omit that <tag>link</tag> reference if
3001 you set the <parameter>docbook.css.link</parameter> to zero
3002 (1 is the default).</para>
3003
3004 <para>This parameter is useful when you want to import the 
3005 default CSS into a custom CSS file generated using the
3006 <parameter>custom.css.source</parameter> parameter.
3007 </para>
3008
3009 </refsection>
3010 </refentry>
3011
3012 <refentry version="5.0" id="custom.css.source">
3013   <refmeta>
3014     <refentrytitle>custom.css.source</refentrytitle>
3015     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3016   </refmeta>
3017   <refnamediv>
3018     <refname>custom.css.source</refname>
3019     <refpurpose>Name of a custom CSS input file</refpurpose>
3020   </refnamediv>
3021
3022   <refsynopsisdiv>
3023     <programlisting id="custom.css.source.frag">&lt;xsl:param name="custom.css.source"&gt;&lt;/xsl:param&gt;</programlisting>
3024   </refsynopsisdiv>
3025
3026   <refsection><info><title>Description</title></info>
3027
3028 <para>The <parameter>custom.css.source</parameter>
3029 parameter enables you to add CSS styles to DocBook's
3030 HTML output.</para>
3031
3032 <para>The parameter
3033 specifies the name of a file containing custom
3034 CSS styles.  The file must be a well-formed XML file that
3035 consists of a single <tag>style</tag> root
3036 element that contains CSS styles as its text content.
3037 For example:</para>
3038 <programlisting>&lt;?xml version="1.0"?&gt;
3039 &lt;style&gt;
3040 h2 {
3041   font-weight: bold;
3042   color: blue;
3043 }
3044 ...
3045 &lt;/style&gt;
3046 </programlisting>
3047
3048 <para>The filename specified by the parameter
3049 should have a <literal>.xml</literal>
3050 filename suffix, although that is not required.
3051 The default value of this parameter is blank.</para>
3052
3053 <para>If <parameter>custom.css.source</parameter> is not blank, then
3054 the stylesheet takes the following actions.
3055 These actions take place regardless of the value of
3056 the <parameter>make.clean.html</parameter> parameter.</para>
3057
3058 <orderedlist>
3059   <listitem>
3060     <para>The stylesheet uses the XSLT <literal>document()</literal>
3061     function to open the file specified by the parameter and
3062     load it into a variable.</para>
3063   </listitem>
3064   <listitem>
3065     <para>The stylesheet forms an output pathname consisting of the
3066     value of the <parameter>base.dir</parameter> parameter (if it is set)
3067     and the value of <parameter>custom.css.source</parameter>,
3068     with the <literal>.xml</literal> suffix stripped off.
3069     </para>
3070   </listitem>
3071   <listitem>
3072     <para>The stylesheet removes the <tag>style</tag>
3073     wrapper element and writes just the CSS text content to the output file.</para>
3074   </listitem>
3075   <listitem>
3076     <para>The stylesheet adds a <tag>link</tag> element to the
3077     HTML <tag>HEAD</tag> element to reference this external CSS stylesheet.
3078     For example:
3079     <programlisting>&lt;link rel="stylesheet" href="custom.css" type="text/css"&gt;
3080     </programlisting>
3081     </para>
3082   </listitem>
3083 </orderedlist>
3084
3085
3086
3087 <para>If the <parameter>make.clean.html</parameter> parameter is nonzero
3088 (the default is zero),
3089 and if the <parameter>docbook.css.source</parameter> parameter
3090 is not blank (the default is not blank),
3091 then the stylesheet will also generate a default CSS file
3092 and add a <tag>link</tag> tag to reference it.
3093 The <tag>link</tag> to the custom CSS comes after the 
3094 <tag>link</tag> to the default, so it should cascade properly
3095 in most browsers.
3096 If you do not want two <tag>link</tag> tags, and
3097 instead want your custom CSS to import the default generated
3098 CSS file, then do the following:
3099 </para>
3100
3101 <orderedlist>
3102   <listitem>
3103     <para>Add a line like the following to your custom CSS source file:</para>
3104     <programlisting>@import url("docbook.css")
3105     </programlisting>
3106   </listitem>
3107   <listitem>
3108     <para>Set the <parameter>docbook.css.link</parameter> parameter 
3109     to zero. This will omit the <tag>link</tag> tag
3110     that references the default CSS file.</para>
3111   </listitem>
3112 </orderedlist>
3113
3114 <para>If you set <parameter>make.clean.html</parameter> to nonzero but
3115 you do not want the default CSS generated, then also set
3116 the <parameter>docbook.css.source</parameter> parameter to blank.
3117 Then no default CSS will be generated, and so
3118 all CSS styles must come from your custom CSS file.</para>
3119
3120 <para>You can use the <parameter>generate.css.header</parameter>
3121 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
3122 element in a <tag>style</tag> tag instead of an external CSS file.</para>
3123
3124   </refsection>
3125 </refentry>
3126
3127 <refentry version="5.0" id="generate.css.header">
3128 <refmeta>
3129 <refentrytitle>generate.css.header</refentrytitle>
3130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3131 </refmeta>
3132 <refnamediv>
3133 <refname>generate.css.header</refname>
3134 <refpurpose>Insert generated CSS styles in HEAD element</refpurpose>
3135 </refnamediv>
3136
3137 <refsynopsisdiv>
3138 <programlisting id="generate.css.header.frag">
3139 &lt;xsl:param name="generate.css.header" select="0"&gt;&lt;/xsl:param&gt;
3140 </programlisting>
3141 </refsynopsisdiv>
3142
3143 <refsection><info><title>Description</title></info>
3144
3145 <para>The stylesheets are capable of generating both default
3146 and custom CSS stylesheet files.  The parameters 
3147 <parameter>make.clean.html</parameter>,
3148 <parameter>docbook.css.source</parameter>, and
3149 <parameter>custom.css.source</parameter> control that feature.</para>
3150
3151 <para>If you require that CSS styles reside in the HTML 
3152 <tag>HEAD</tag> element instead of external CSS files,
3153 then set the <parameter>generate.css.header</parameter>
3154 parameter to nonzero (it is zero by default).
3155 Then instead of generating the CSS in external files,
3156 they are wrapped in <tag>style</tag> elements in
3157 the <tag>HEAD</tag> element of each HTML output file.
3158 </para>
3159
3160 </refsection>
3161 </refentry>
3162
3163 </reference><reference id="xslt" xml:base="../html/param.xml"><title>XSLT Processing</title>
3164 <refentry version="5.0" id="rootid">
3165 <refmeta>
3166 <refentrytitle>rootid</refentrytitle>
3167 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3168 </refmeta>
3169 <refnamediv>
3170 <refname>rootid</refname>
3171 <refpurpose>Specify the root element to format</refpurpose>
3172 </refnamediv>
3173
3174 <refsynopsisdiv>
3175 <programlisting id="rootid.frag">
3176 &lt;xsl:param name="rootid"&gt;&lt;/xsl:param&gt;</programlisting>
3177 </refsynopsisdiv>
3178
3179 <refsection><info><title>Description</title></info>
3180
3181 <para>If <parameter>rootid</parameter> is not empty, it must be the
3182 value of an ID that occurs in the document being formatted. The entire
3183 document will be loaded and parsed, but formatting will begin at the
3184 element identified, rather than at the root. For example, this allows
3185 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
3186 <para>Because the entire document is available to the processor, automatic
3187 numbering, cross references, and other dependencies are correctly
3188 resolved.</para>
3189
3190 </refsection>
3191 </refentry>
3192
3193 <refentry version="5.0" id="suppress.navigation">
3194 <refmeta>
3195 <refentrytitle>suppress.navigation</refentrytitle>
3196 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3197 </refmeta>
3198 <refnamediv>
3199 <refname>suppress.navigation</refname>
3200 <refpurpose>Disable header and footer navigation</refpurpose>
3201 </refnamediv>
3202
3203 <refsynopsisdiv>
3204 <programlisting id="suppress.navigation.frag">
3205 &lt;xsl:param name="suppress.navigation" select="0"&gt;&lt;/xsl:param&gt;
3206 </programlisting>
3207 </refsynopsisdiv>
3208
3209 <refsection><info><title>Description</title></info>
3210
3211 <para>
3212 If non-zero, header and footer navigation will be suppressed.</para>
3213
3214 </refsection>
3215 </refentry>
3216
3217 <refentry version="5.0" id="suppress.header.navigation">
3218 <refmeta>
3219 <refentrytitle>suppress.header.navigation</refentrytitle>
3220 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3221 </refmeta>
3222 <refnamediv>
3223 <refname>suppress.header.navigation</refname>
3224 <refpurpose>Disable header navigation</refpurpose>
3225 </refnamediv>
3226
3227 <refsynopsisdiv>
3228 <programlisting id="suppress.header.navigation.frag">
3229 &lt;xsl:param name="suppress.header.navigation" select="0"&gt;&lt;/xsl:param&gt;
3230 </programlisting>
3231 </refsynopsisdiv>
3232
3233 <refsection><info><title>Description</title></info>
3234
3235 <para>If non-zero, header navigation will be suppressed.</para>
3236
3237 </refsection>
3238 </refentry>
3239
3240 <refentry version="5.0" id="suppress.footer.navigation">
3241 <refmeta>
3242 <refentrytitle>suppress.footer.navigation</refentrytitle>
3243 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3244 </refmeta>
3245 <refnamediv>
3246 <refname>suppress.footer.navigation</refname>
3247 <refpurpose>Disable footer navigation</refpurpose>
3248 </refnamediv>
3249
3250 <refsynopsisdiv>
3251 <programlisting id="suppress.footer.navigation.frag">&lt;xsl:param name="suppress.footer.navigation"&gt;0&lt;/xsl:param&gt;</programlisting>
3252 </refsynopsisdiv>
3253
3254 <refsection><info><title>Description</title></info>
3255
3256 <para>
3257 If non-zero, footer navigation will be suppressed.</para>
3258
3259 </refsection>
3260 </refentry>
3261
3262 <refentry version="5.0" id="header.rule">
3263 <refmeta>
3264 <refentrytitle>header.rule</refentrytitle>
3265 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3266 </refmeta>
3267 <refnamediv>
3268 <refname>header.rule</refname>
3269 <refpurpose>Rule under headers?</refpurpose>
3270 </refnamediv>
3271
3272 <refsynopsisdiv>
3273 <programlisting id="header.rule.frag">
3274 &lt;xsl:param name="header.rule" select="1"&gt;&lt;/xsl:param&gt;
3275 </programlisting>
3276 </refsynopsisdiv>
3277
3278 <refsection><info><title>Description</title></info>
3279
3280 <para>If non-zero, a rule will be drawn below the page headers.</para>
3281
3282 </refsection>
3283 </refentry>
3284
3285 <refentry version="5.0" id="footer.rule">
3286 <refmeta>
3287 <refentrytitle>footer.rule</refentrytitle>
3288 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3289 </refmeta>
3290 <refnamediv>
3291 <refname>footer.rule</refname>
3292 <refpurpose>Rule over footers?</refpurpose>
3293 </refnamediv>
3294
3295 <refsynopsisdiv>
3296 <programlisting id="footer.rule.frag">
3297 &lt;xsl:param name="footer.rule" select="1"&gt;&lt;/xsl:param&gt;
3298 </programlisting>
3299 </refsynopsisdiv>
3300
3301 <refsection><info><title>Description</title></info>
3302
3303 <para>If non-zero, a rule will be drawn above the page footers.</para>
3304
3305 </refsection>
3306 </refentry>
3307
3308 <refentry version="5.0" id="id.warnings">
3309 <refmeta>
3310 <refentrytitle>id.warnings</refentrytitle>
3311 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3312 </refmeta>
3313 <refnamediv>
3314 <refname>id.warnings</refname>
3315 <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
3316 </refnamediv>
3317 <refsynopsisdiv>
3318 <programlisting id="id.warnings.frag">
3319 &lt;xsl:param name="id.warnings" select="0"&gt;&lt;/xsl:param&gt;
3320 </programlisting>
3321 </refsynopsisdiv>
3322 <refsection><info><title>Description</title></info>
3323 <para>If non-zero, the stylesheet will issue a warning for any element
3324 (other than the root element) which has a <tag>title</tag> but does not have an
3325 ID.</para>
3326 </refsection>
3327 </refentry>
3328
3329 </reference><reference id="meta" xml:base="../html/param.xml"><title>Meta/*Info and Titlepages</title>
3330 <refentry version="5.0" id="inherit.keywords">
3331 <refmeta>
3332 <refentrytitle>inherit.keywords</refentrytitle>
3333 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3334 </refmeta>
3335 <refnamediv>
3336 <refname>inherit.keywords</refname>
3337 <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
3338 </refnamediv>
3339
3340 <refsynopsisdiv>
3341 <programlisting id="inherit.keywords.frag">
3342 &lt;xsl:param name="inherit.keywords" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
3343 </refsynopsisdiv>
3344
3345 <refsection><info><title>Description</title></info>
3346
3347 <para>If <parameter>inherit.keywords</parameter>
3348 is non-zero, the keyword <literal>meta</literal> for each HTML
3349 <literal>head</literal> element will include all of the keywords from
3350 ancestor elements. Otherwise, only the keywords from the current section
3351 will be used.
3352 </para>
3353
3354 </refsection>
3355 </refentry>
3356
3357 <refentry version="5.0" id="make.single.year.ranges">
3358 <refmeta>
3359 <refentrytitle>make.single.year.ranges</refentrytitle>
3360 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3361 </refmeta>
3362 <refnamediv>
3363 <refname>make.single.year.ranges</refname>
3364 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
3365 </refnamediv>
3366
3367 <refsynopsisdiv>
3368 <programlisting id="make.single.year.ranges.frag">
3369 &lt;xsl:param name="make.single.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3370 </refsynopsisdiv>
3371
3372 <refsection><info><title>Description</title></info>
3373
3374 <para>If non-zero, year ranges that span a single year will be printed
3375 in range notation (1998-1999) instead of discrete notation
3376 (1998, 1999).</para>
3377
3378 </refsection>
3379 </refentry>
3380
3381 <refentry version="5.0" id="make.year.ranges">
3382 <refmeta>
3383 <refentrytitle>make.year.ranges</refentrytitle>
3384 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3385 </refmeta>
3386 <refnamediv>
3387 <refname>make.year.ranges</refname>
3388 <refpurpose>Collate copyright years into ranges?</refpurpose>
3389 </refnamediv>
3390
3391 <refsynopsisdiv>
3392 <programlisting id="make.year.ranges.frag">&lt;xsl:param name="make.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3393 </refsynopsisdiv>
3394
3395 <refsection><info><title>Description</title></info>
3396
3397 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
3398 collated into ranges.
3399 This works only if each year number is put into a separate
3400 year element.  The copyright element permits multiple
3401 year elements. If a year element contains a dash or
3402 a comma, then that year element will not be merged into
3403 any range.
3404 </para>
3405
3406 </refsection>
3407 </refentry>
3408
3409 <refentry version="5.0" id="author.othername.in.middle">
3410 <refmeta>
3411 <refentrytitle>author.othername.in.middle</refentrytitle>
3412 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3413 </refmeta>
3414 <refnamediv>
3415 <refname>author.othername.in.middle</refname>
3416 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
3417 middle name?</refpurpose>
3418 </refnamediv>
3419
3420 <refsynopsisdiv>
3421 <programlisting id="author.othername.in.middle.frag">
3422 &lt;xsl:param name="author.othername.in.middle" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
3423 </refsynopsisdiv>
3424
3425 <refsection><info><title>Description</title></info>
3426
3427 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
3428 appears between the <tag>firstname</tag> and
3429 <tag>surname</tag>.  Otherwise, <tag>othername</tag>
3430 is suppressed.
3431 </para>
3432
3433 </refsection>
3434 </refentry>
3435
3436 <refentry version="5.0" id="blurb.on.titlepage.enabled">
3437 <refmeta>
3438 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
3439 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3440 </refmeta>
3441 <refnamediv>
3442 <refname>blurb.on.titlepage.enabled</refname>
3443 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
3444 </refnamediv>
3445
3446 <refsynopsisdiv>
3447 <programlisting id="blurb.on.titlepage.enabled.frag">
3448 &lt;xsl:param name="blurb.on.titlepage.enabled" select="0"&gt;&lt;/xsl:param&gt;
3449 </programlisting>
3450 </refsynopsisdiv>
3451
3452 <refsection><info><title>Description</title></info>
3453
3454 <para>If non-zero, output from <tag>authorblurb</tag> and
3455 <tag>personblurb</tag> elements is displayed on title pages. If zero
3456 (the default), output from those elements is suppressed on title pages
3457 (unless you are using a <literal>titlepage</literal> customization
3458 that causes them to be included).</para>
3459
3460 </refsection>
3461 </refentry>
3462
3463 <refentry version="5.0" id="contrib.inline.enabled">
3464 <refmeta>
3465 <refentrytitle>contrib.inline.enabled</refentrytitle>
3466 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3467 </refmeta>
3468 <refnamediv>
3469 <refname>contrib.inline.enabled</refname>
3470 <refpurpose>Display contrib output inline?</refpurpose>
3471 </refnamediv>
3472
3473 <refsynopsisdiv>
3474 <programlisting id="contrib.inline.enabled.frag">&lt;xsl:param name="contrib.inline.enabled"&gt;1&lt;/xsl:param&gt;</programlisting>
3475 </refsynopsisdiv>
3476
3477 <refsection><info><title>Description</title></info>
3478
3479 <para>If non-zero (the default), output of the <tag>contrib</tag> element is
3480 displayed as inline content rather than as block content.</para>
3481
3482 </refsection>
3483 </refentry>
3484
3485 <refentry version="5.0" id="editedby.enabled">
3486 <refmeta>
3487 <refentrytitle>editedby.enabled</refentrytitle>
3488 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3489 </refmeta>
3490 <refnamediv>
3491 <refname>editedby.enabled</refname>
3492 <refpurpose>Display &#8220;Edited by&#8221; heading above editor name?</refpurpose>
3493 </refnamediv>
3494
3495 <refsynopsisdiv>
3496 <programlisting id="editedby.enabled.frag">&lt;xsl:param name="editedby.enabled"&gt;1&lt;/xsl:param&gt;</programlisting>
3497 </refsynopsisdiv>
3498
3499 <refsection><info><title>Description</title></info>
3500
3501 <para>If non-zero, a localized <emphasis role="bold">Edited
3502 by</emphasis> heading is displayed above editor names in output of the
3503 <tag>editor</tag> element.</para>
3504
3505 </refsection>
3506 </refentry>
3507
3508 <refentry version="5.0" id="abstract.notitle.enabled">
3509 <refmeta>
3510 <refentrytitle>abstract.notitle.enabled</refentrytitle>
3511 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3512 </refmeta>
3513 <refnamediv>
3514 <refname>abstract.notitle.enabled</refname>
3515 <refpurpose>Suppress display of abstract titles?</refpurpose>
3516 </refnamediv>
3517 <refsynopsisdiv>
3518   <programlisting id="abstract.notitle.enabled.frag">&lt;xsl:param name="abstract.notitle.enabled" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3519 </refsynopsisdiv>
3520 <refsection><info><title>Description</title></info>
3521 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
3522 display of the abstract title is suppressed.</para>
3523 </refsection>
3524 </refentry>
3525
3526 <refentry version="5.0" id="othercredit.like.author.enabled">
3527 <refmeta>
3528 <refentrytitle>othercredit.like.author.enabled</refentrytitle>
3529 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3530 </refmeta>
3531 <refnamediv>
3532 <refname>othercredit.like.author.enabled</refname>
3533 <refpurpose>Display othercredit in same style as author?</refpurpose>
3534 </refnamediv>
3535
3536 <refsynopsisdiv>
3537 <programlisting id="othercredit.like.author.enabled.frag">&lt;xsl:param name="othercredit.like.author.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
3538 </refsynopsisdiv>
3539
3540 <refsection><info><title>Description</title></info>
3541
3542 <para>If non-zero, output of the
3543 <tag>othercredit</tag> element on titlepages is displayed in
3544 the same style as <tag>author</tag> and
3545 <tag>editor</tag> output. If zero then
3546 <tag>othercredit</tag> output is displayed using a style
3547 different than that of <tag>author</tag> and
3548 <tag>editor</tag>.</para>
3549
3550 </refsection>
3551 </refentry>
3552
3553 <refentry version="5.0" id="generate.legalnotice.link">
3554 <refmeta>
3555 <refentrytitle>generate.legalnotice.link</refentrytitle>
3556 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3557 </refmeta>
3558 <refnamediv>
3559 <refname>generate.legalnotice.link</refname>
3560 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
3561 </refnamediv>
3562
3563 <refsynopsisdiv>
3564 <programlisting id="generate.legalnotice.link.frag">&lt;xsl:param name="generate.legalnotice.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3565 </refsynopsisdiv>
3566
3567 <refsection><info><title>Description</title></info>
3568
3569 <para>If the value of <parameter>generate.legalnotice.link</parameter>
3570 is non-zero, the stylesheet:
3571
3572 <itemizedlist>
3573   <listitem>
3574     <para>writes the contents of <tag>legalnotice</tag> to a separate
3575     HTML file</para>
3576   </listitem>
3577   <listitem>
3578     <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
3579   </listitem>
3580   <listitem>
3581     <para>adds (in the HTML <literal>head</literal>) either a single
3582     <literal>link</literal> or element or multiple
3583     <literal>link</literal> elements (depending on the value of the
3584     <parameter>html.head.legalnotice.link.multiple</parameter>
3585     parameter), with the value or values derived from the
3586     <parameter>html.head.legalnotice.link.types</parameter>
3587     parameter</para>
3588   </listitem>
3589   </itemizedlist>
3590
3591   Otherwise, if <parameter>generate.legalnotice.link</parameter> is
3592   zero, <tag>legalnotice</tag> contents are rendered on the title
3593   page.</para>
3594
3595 <para>The name of the separate HTML file is computed as follows:
3596
3597 <orderedlist>
3598 <listitem>
3599   <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> 
3600 processing instruction, that filename is used.</para>
3601 </listitem>
3602 <listitem>
3603   <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> 
3604 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename 
3605 is the concatenation of the id value and the value of the <parameter>html.ext</parameter> 
3606 parameter.</para>
3607 </listitem>
3608 <listitem>
3609   <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3610  attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-", 
3611 auto-generated id value, and <parameter>html.ext</parameter> value.
3612   </para>
3613 </listitem>
3614 </orderedlist>
3615
3616 </para>
3617
3618 </refsection>
3619 </refentry>
3620
3621 <refentry version="5.0" id="generate.revhistory.link">
3622 <refmeta>
3623 <refentrytitle>generate.revhistory.link</refentrytitle>
3624 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3625 </refmeta>
3626 <refnamediv>
3627 <refname>generate.revhistory.link</refname>
3628 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
3629 </refnamediv>
3630
3631 <refsynopsisdiv>
3632 <programlisting id="generate.revhistory.link.frag">&lt;xsl:param name="generate.revhistory.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3633 </refsynopsisdiv>
3634
3635 <refsection><info><title>Description</title></info>
3636
3637 <para>If non-zero, the contents of <tag>revhistory</tag> are written
3638 to a separate HTML file and a link to the file is
3639 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
3640 the title page.</para>
3641
3642 <para>The name of the separate HTML file is computed as follows:
3643
3644 <orderedlist>
3645 <listitem>
3646   <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction, 
3647 that filename is used.</para>
3648 </listitem>
3649 <listitem>
3650   <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> 
3651 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of 
3652 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
3653 </listitem>
3654 <listitem>
3655   <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> 
3656 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-", 
3657 auto-generated id value, and <parameter>html.ext</parameter> value.
3658   </para>
3659 </listitem>
3660 </orderedlist>
3661
3662 </para>
3663
3664 </refsection>
3665 </refentry>
3666
3667 <refentry version="5.0" id="html.head.legalnotice.link.types">
3668 <refmeta>
3669 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
3670 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3671 </refmeta>
3672 <refnamediv>
3673 <refname>html.head.legalnotice.link.types</refname>
3674 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
3675 </refnamediv>
3676
3677 <refsynopsisdiv>
3678 <programlisting id="html.head.legalnotice.link.types.frag">
3679 &lt;xsl:param name="html.head.legalnotice.link.types"&gt;copyright&lt;/xsl:param&gt;
3680 </programlisting>
3681 </refsynopsisdiv>
3682
3683 <refsection><info><title>Description</title></info>
3684
3685 <para>The value of
3686 <parameter>html.head.legalnotice.link.types</parameter> is a
3687 space-separated list of link types, as described in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12
3688 of the HTML 4.01 specification</link>. If the value of the
3689 <parameter>generate.legalnotice.link</parameter> parameter is
3690 non-zero, then the stylesheet generates (in the
3691 <literal>head</literal> section of the HTML source) either a single
3692 HTML <literal>link</literal> element or, if the value of the
3693 <parameter>html.head.legalnotice.link.multiple</parameter> is
3694 non-zero, one <literal>link</literal> element for each link type
3695 specified. Each <literal>link</literal> has the following attributes:
3696
3697 <itemizedlist>
3698   <listitem>
3699     <para>a <tag class="attribute">rel</tag> attribute whose
3700     value is derived from the value of
3701     <parameter>html.head.legalnotice.link.types</parameter></para>
3702   </listitem>
3703   <listitem>
3704     <para>an <tag class="attribute">href</tag> attribute whose
3705     value is set to the URL of the file containing the
3706     <tag>legalnotice</tag></para>
3707   </listitem>
3708   <listitem>
3709     <para>a <tag class="attribute">title</tag> attribute whose
3710     value is set to the title of the corresponding
3711     <tag>legalnotice</tag> (or a title programatically
3712     determined by the stylesheet)</para>
3713   </listitem>
3714 </itemizedlist>
3715
3716 For example:
3717
3718 <screen>  &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
3719 </para>
3720
3721 <refsection><info><title>About the default value</title></info>
3722   
3723   <para>In an ideal world, the default value of
3724   <parameter>html.head.legalnotice.link.types</parameter> would
3725   probably be &#8220;<literal>license</literal>&#8221;, since the content of the
3726   DocBook <tag>legalnotice</tag> is typically license
3727   information, not copyright information. However, the default value
3728   is &#8220;<literal>copyright</literal>&#8221; for pragmatic reasons: because
3729   that&#8217;s among the set of &#8220;recognized link types&#8221; listed in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section
3730   6.12 of the HTML 4.01 specification</link>, and because certain
3731   browsers and browser extensions are preconfigured to recognize that
3732   value.</para>
3733 </refsection>
3734
3735 </refsection>
3736 </refentry>
3737
3738 <refentry version="5.0" id="html.head.legalnotice.link.multiple">
3739 <refmeta>
3740 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
3741 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3742 </refmeta>
3743 <refnamediv>
3744 <refname>html.head.legalnotice.link.multiple</refname>
3745 <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
3746 </refnamediv>
3747
3748 <refsynopsisdiv>
3749 <programlisting id="html.head.legalnotice.link.multiple.frag">
3750 &lt;xsl:param name="html.head.legalnotice.link.multiple" select="1"&gt;&lt;/xsl:param&gt;
3751 </programlisting>
3752 </refsynopsisdiv>
3753
3754 <refsection><info><title>Description</title></info>
3755
3756 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
3757 non-zero and the value of
3758 <parameter>html.head.legalnotice.link.types</parameter> contains
3759 multiple link types, then the stylesheet generates (in the
3760 <literal>head</literal> section of the HTML source) one
3761 <literal>link</literal> element for each link type specified. For
3762 example, if the value of
3763 <parameter>html.head.legalnotice.link.types</parameter> is
3764 &#8220;<literal>copyright license</literal>&#8221;:
3765
3766 <screen>  &lt;link rel="copyright" href="ln-id2524073.html" title="Legal Notice"&gt;
3767   &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
3768
3769  Otherwise, the stylesheet generates generates a single
3770  <literal>link</literal> instance; for example:
3771
3772 <screen>  &lt;link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
3773  
3774 </para>
3775 </refsection>
3776 </refentry>
3777
3778 </reference><reference id="refentry" xml:base="../html/param.xml"><title>Reference Pages</title>
3779 <refentry version="5.0" id="funcsynopsis.decoration">
3780 <refmeta>
3781 <refentrytitle>funcsynopsis.decoration</refentrytitle>
3782 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3783 </refmeta>
3784 <refnamediv>
3785 <refname>funcsynopsis.decoration</refname>
3786 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
3787 </refnamediv>
3788
3789 <refsynopsisdiv>
3790 <programlisting id="funcsynopsis.decoration.frag">
3791 &lt;xsl:param name="funcsynopsis.decoration" select="1"&gt;&lt;/xsl:param&gt;
3792 </programlisting>
3793 </refsynopsisdiv>
3794
3795 <refsection><info><title>Description</title></info>
3796
3797 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
3798 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
3799 templates that can be redefined in a customization layer.
3800 </para>
3801
3802 </refsection>
3803 </refentry>
3804
3805 <refentry version="5.0" id="funcsynopsis.style">
3806 <refmeta>
3807 <refentrytitle>funcsynopsis.style</refentrytitle>
3808 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3809 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
3810 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
3811 </refmeta>
3812 <refnamediv>
3813 <refname>funcsynopsis.style</refname>
3814 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
3815 </refnamediv>
3816
3817 <refsynopsisdiv>
3818 <programlisting id="funcsynopsis.style.frag">&lt;xsl:param name="funcsynopsis.style"&gt;kr&lt;/xsl:param&gt;</programlisting>
3819 </refsynopsisdiv>
3820
3821 <refsection><info><title>Description</title></info>
3822
3823 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
3824 ANSI-style function synopses are generated for a
3825 <tag>funcsynopsis</tag>, otherwise K&amp;R-style
3826 function synopses are generated.
3827 </para>
3828
3829 </refsection>
3830 </refentry>
3831
3832 <refentry version="5.0" id="function.parens">
3833 <refmeta>
3834 <refentrytitle>function.parens</refentrytitle>
3835 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3836 </refmeta>
3837 <refnamediv>
3838 <refname>function.parens</refname>
3839 <refpurpose>Generate parens after a function?</refpurpose>
3840 </refnamediv>
3841
3842 <refsynopsisdiv>
3843 <programlisting id="function.parens.frag">
3844 &lt;xsl:param name="function.parens" select="0"&gt;&lt;/xsl:param&gt;
3845 </programlisting>
3846 </refsynopsisdiv>
3847
3848 <refsection><info><title>Description</title></info>
3849
3850 <para>If non-zero, the formatting of a <tag>function</tag> element
3851 will include generated parentheses.
3852 </para>
3853
3854 </refsection>
3855 </refentry>
3856
3857 <refentry version="5.0" id="refentry.generate.name">
3858 <refmeta>
3859 <refentrytitle>refentry.generate.name</refentrytitle>
3860 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3861 </refmeta>
3862 <refnamediv>
3863 <refname>refentry.generate.name</refname>
3864 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
3865 </refnamediv>
3866
3867 <refsynopsisdiv>
3868 <programlisting id="refentry.generate.name.frag">
3869 &lt;xsl:param name="refentry.generate.name" select="1"&gt;&lt;/xsl:param&gt;
3870 </programlisting>
3871 </refsynopsisdiv>
3872
3873 <refsection><info><title>Description</title></info>
3874
3875 <para>If non-zero, a "NAME" section title is output before the list
3876 of <tag>refname</tag>s. This parameter and
3877 <parameter>refentry.generate.title</parameter> are mutually
3878 exclusive. This means that if you change this parameter to zero, you
3879 should set <parameter>refentry.generate.title</parameter> to non-zero unless
3880 you want get quite strange output.
3881 </para>
3882
3883 </refsection>
3884 </refentry>
3885
3886 <refentry version="5.0" id="refentry.generate.title">
3887 <refmeta>
3888 <refentrytitle>refentry.generate.title</refentrytitle>
3889 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3890 </refmeta>
3891 <refnamediv>
3892 <refname>refentry.generate.title</refname>
3893 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
3894 </refnamediv>
3895
3896 <refsynopsisdiv>
3897 <programlisting id="refentry.generate.title.frag">
3898 &lt;xsl:param name="refentry.generate.title" select="0"&gt;&lt;/xsl:param&gt;
3899 </programlisting>
3900 </refsynopsisdiv>
3901
3902 <refsection><info><title>Description</title></info>
3903
3904 <para>If non-zero, the reference page title or first name is
3905 output before the list of <tag>refname</tag>s. This parameter and
3906 <parameter>refentry.generate.name</parameter> are mutually exclusive.
3907 This means that if you change this parameter to non-zero, you
3908 should set <parameter>refentry.generate.name</parameter> to zero unless
3909 you want get quite strange output.</para>
3910
3911
3912 </refsection>
3913 </refentry>
3914
3915 <refentry version="5.0" id="refentry.xref.manvolnum">
3916 <refmeta>
3917 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
3918 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3919 </refmeta>
3920 <refnamediv>
3921 <refname>refentry.xref.manvolnum</refname>
3922 <refpurpose>Output <tag>manvolnum</tag> as part of 
3923 <tag>refentry</tag> cross-reference?</refpurpose>
3924 </refnamediv>
3925
3926 <refsynopsisdiv>
3927 <programlisting id="refentry.xref.manvolnum.frag">
3928 &lt;xsl:param name="refentry.xref.manvolnum" select="1"&gt;&lt;/xsl:param&gt;
3929 </programlisting>
3930 </refsynopsisdiv>
3931
3932 <refsection><info><title>Description</title></info>
3933
3934 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
3935 <tag>refentry</tag>s, either with <tag>xref</tag>
3936 or <tag>citerefentry</tag>.
3937 </para>
3938
3939 </refsection>
3940 </refentry>
3941
3942 <refentry version="5.0" id="citerefentry.link">
3943 <refmeta>
3944 <refentrytitle>citerefentry.link</refentrytitle>
3945 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3946 </refmeta>
3947 <refnamediv>
3948 <refname>citerefentry.link</refname>
3949 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
3950 </refnamediv>
3951
3952 <refsynopsisdiv>
3953 <programlisting id="citerefentry.link.frag">
3954 &lt;xsl:param name="citerefentry.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3955 </refsynopsisdiv>
3956
3957 <refsection><info><title>Description</title></info>
3958
3959 <para>If non-zero, a web link will be generated, presumably
3960 to an online man-&gt;HTML gateway. The text of the link is
3961 generated by the <literal>generate.citerefentry.link</literal> template.
3962 </para>
3963
3964 </refsection>
3965 </refentry>
3966
3967 <refentry version="5.0" id="refentry.separator">
3968 <refmeta>
3969 <refentrytitle>refentry.separator</refentrytitle>
3970 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3971 </refmeta>
3972 <refnamediv>
3973 <refname>refentry.separator</refname>
3974 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
3975 </refnamediv>
3976
3977 <refsynopsisdiv>
3978 <programlisting id="refentry.separator.frag">
3979 &lt;xsl:param name="refentry.separator" select="1"&gt;&lt;/xsl:param&gt;
3980 </programlisting>
3981 </refsynopsisdiv>
3982
3983 <refsection><info><title>Description</title></info>
3984
3985 <para>If true, a separator will be generated between consecutive
3986 reference pages.
3987 </para>
3988
3989 </refsection>
3990 </refentry>
3991
3992 <refentry version="5.0" id="refclass.suppress">
3993 <refmeta>
3994 <refentrytitle>refclass.suppress</refentrytitle>
3995 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3996 </refmeta>
3997 <refnamediv>
3998 <refname>refclass.suppress</refname>
3999 <refpurpose>Suppress display of refclass contents?</refpurpose>
4000 </refnamediv>
4001
4002 <refsynopsisdiv>
4003 <programlisting id="refclass.suppress.frag">
4004 &lt;xsl:param name="refclass.suppress" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
4005 </refsynopsisdiv>
4006
4007 <refsection><info><title>Description</title></info>
4008
4009 <para>If the value of <parameter>refclass.suppress</parameter> is
4010 non-zero, then display of <tag>refclass</tag> contents is
4011 suppressed in output.</para>
4012
4013 </refsection>
4014 </refentry>
4015
4016 </reference><reference id="tables" xml:base="../html/param.xml"><title>Tables</title>
4017 <refentry version="5.0" id="default.table.width">
4018 <refmeta>
4019 <refentrytitle>default.table.width</refentrytitle>
4020 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4021 </refmeta>
4022 <refnamediv>
4023 <refname>default.table.width</refname>
4024 <refpurpose>The default width of tables</refpurpose>
4025 </refnamediv>
4026 <refsynopsisdiv>
4027 <programlisting id="default.table.width.frag">
4028 &lt;xsl:param name="default.table.width"&gt;&lt;/xsl:param&gt;
4029 </programlisting>
4030 </refsynopsisdiv>
4031 <refsection><info><title>Description</title></info>
4032 <para>If non-zero, this value will be used for the
4033 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
4034 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or 
4035 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
4036 </refsection>
4037 </refentry>
4038
4039 <refentry version="5.0" id="nominal.table.width">
4040 <refmeta>
4041 <refentrytitle>nominal.table.width</refentrytitle>
4042 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4043 </refmeta>
4044 <refnamediv>
4045 <refname>nominal.table.width</refname>
4046 <refpurpose>The (absolute) nominal width of tables</refpurpose>
4047 </refnamediv>
4048
4049 <refsynopsisdiv>
4050 <programlisting id="nominal.table.width.frag">
4051 &lt;xsl:param name="nominal.table.width"&gt;6in&lt;/xsl:param&gt;
4052 </programlisting>
4053 </refsynopsisdiv>
4054
4055 <refsection><info><title>Description</title></info>
4056
4057 <para>In order to convert CALS column widths into HTML column widths, it
4058 is sometimes necessary to have an absolute table width to use for conversion
4059 of mixed absolute and relative widths. This value must be an absolute
4060 length (not a percentage).</para>
4061
4062 </refsection>
4063 </refentry>
4064
4065 <refentry version="5.0" id="table.borders.with.css">
4066 <refmeta>
4067 <refentrytitle>table.borders.with.css</refentrytitle>
4068 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4069 </refmeta>
4070 <refnamediv>
4071 <refname>table.borders.with.css</refname>
4072 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
4073 </refnamediv>
4074
4075 <refsynopsisdiv>
4076 <programlisting id="table.borders.with.css.frag">
4077 &lt;xsl:param name="table.borders.with.css" select="0"&gt;&lt;/xsl:param&gt;
4078 </programlisting>
4079 </refsynopsisdiv>
4080
4081 <refsection><info><title>Description</title></info>
4082
4083 <para>If non-zero, CSS will be used to draw table borders.
4084 </para>
4085
4086 </refsection>
4087 </refentry>
4088
4089 <refentry version="5.0" id="table.cell.border.style">
4090 <refmeta>
4091 <refentrytitle>table.cell.border.style</refentrytitle>
4092 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
4093 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4094 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4095 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4096 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4097 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4098 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>                       
4099 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4100 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4101 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>          
4102 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4103 </refmeta>
4104 <refnamediv>
4105 <refname>table.cell.border.style</refname>
4106 <refpurpose>Specifies the border style of table cells</refpurpose>
4107 </refnamediv>
4108
4109 <refsynopsisdiv>
4110 <programlisting id="table.cell.border.style.frag">
4111 &lt;xsl:param name="table.cell.border.style"&gt;solid&lt;/xsl:param&gt;
4112 </programlisting>
4113 </refsynopsisdiv>
4114
4115 <refsection><info><title>Description</title></info>
4116
4117 <para>Specifies the border style of table cells.</para>
4118
4119 <note>
4120   <para>To control properties of cell borders in HTML output, you must also turn on the 
4121   <parameter>table.borders.with.css</parameter> parameter.</para>
4122 </note>
4123
4124 </refsection>
4125 </refentry>
4126
4127 <refentry version="5.0" id="table.cell.border.thickness">
4128 <refmeta>
4129 <refentrytitle>table.cell.border.thickness</refentrytitle>
4130 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4131 </refmeta>
4132 <refnamediv>
4133 <refname>table.cell.border.thickness</refname>
4134 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
4135 </refnamediv>
4136
4137 <refsynopsisdiv>
4138 <programlisting id="table.cell.border.thickness.frag">
4139 &lt;xsl:param name="table.cell.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
4140 </programlisting>
4141 </refsynopsisdiv>
4142
4143 <refsection><info><title>Description</title></info>
4144
4145 <para>If non-zero, specifies the thickness of borders on table
4146 cells. The units are points. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
4147 CSS</link></para>
4148
4149 <note>
4150   <para>To control properties of cell borders in HTML output, you must also turn on the 
4151   <parameter>table.borders.with.css</parameter> parameter.</para>
4152 </note>
4153
4154 </refsection>
4155 </refentry>
4156
4157 <refentry version="5.0" id="table.cell.border.color">
4158 <refmeta>
4159 <refentrytitle>table.cell.border.color</refentrytitle>
4160 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4161 </refmeta>
4162 <refnamediv>
4163 <refname>table.cell.border.color</refname>
4164 <refpurpose>Specifies the border color of table cells</refpurpose>
4165 </refnamediv>
4166
4167 <refsynopsisdiv>
4168 <programlisting id="table.cell.border.color.frag">
4169 &lt;xsl:param name="table.cell.border.color"&gt;&lt;/xsl:param&gt;
4170
4171 </programlisting>
4172 </refsynopsisdiv>
4173
4174 <refsection><info><title>Description</title></info>
4175
4176 <para>Set the color of table cell borders. If non-zero, the value is used
4177 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
4178 <literal>color</literal> is either a keyword or a numerical RGB specification.
4179 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
4180 navy, olive, orange, purple, red, silver, teal, white, and
4181 yellow.</para>
4182
4183 <note>
4184   <para>To control properties of cell borders in HTML output, you must also turn on the 
4185   <parameter>table.borders.with.css</parameter> parameter.</para>
4186 </note>
4187
4188 </refsection>
4189 </refentry>
4190
4191 <refentry version="5.0" id="table.frame.border.style">
4192 <refmeta>
4193 <refentrytitle>table.frame.border.style</refentrytitle>
4194 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
4195 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4196 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4197 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4198 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4199 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4200 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>                       
4201 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4202 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4203 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>          
4204 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4205 </refmeta>
4206 <refnamediv>
4207 <refname>table.frame.border.style</refname>
4208 <refpurpose>Specifies the border style of table frames</refpurpose>
4209 </refnamediv>
4210
4211 <refsynopsisdiv>
4212 <programlisting id="table.frame.border.style.frag">
4213 &lt;xsl:param name="table.frame.border.style"&gt;solid&lt;/xsl:param&gt;
4214 </programlisting>
4215 </refsynopsisdiv>
4216
4217 <refsection><info><title>Description</title></info>
4218
4219 <para>Specifies the border style of table frames.</para>
4220
4221 </refsection>
4222 </refentry>
4223
4224 <refentry version="5.0" id="table.frame.border.thickness">
4225 <refmeta>
4226 <refentrytitle>table.frame.border.thickness</refentrytitle>
4227 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4228 </refmeta>
4229 <refnamediv>
4230 <refname>table.frame.border.thickness</refname>
4231 <refpurpose>Specifies the thickness of the frame border</refpurpose>
4232 </refnamediv>
4233
4234 <refsynopsisdiv>
4235 <programlisting id="table.frame.border.thickness.frag">
4236 &lt;xsl:param name="table.frame.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
4237 </programlisting>
4238 </refsynopsisdiv>
4239
4240 <refsection><info><title>Description</title></info>
4241
4242 <para>Specifies the thickness of the border on the table's frame.</para>
4243
4244 </refsection>
4245 </refentry>
4246
4247 <refentry version="5.0" id="table.frame.border.color">
4248 <refmeta>
4249 <refentrytitle>table.frame.border.color</refentrytitle>
4250 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4251 </refmeta>
4252 <refnamediv>
4253 <refname>table.frame.border.color</refname>
4254 <refpurpose>Specifies the border color of table frames</refpurpose>
4255 </refnamediv>
4256
4257 <refsynopsisdiv>
4258 <programlisting id="table.frame.border.color.frag">
4259 &lt;xsl:param name="table.frame.border.color"&gt;&lt;/xsl:param&gt;
4260
4261 </programlisting>
4262 </refsynopsisdiv>
4263
4264 <refsection><info><title>Description</title></info>
4265
4266 <para>Specifies the border color of table frames.</para>
4267
4268 </refsection>
4269 </refentry>
4270
4271 <refentry version="5.0" id="default.table.frame">
4272 <refmeta>
4273 <refentrytitle>default.table.frame</refentrytitle>
4274 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4275 </refmeta>
4276 <refnamediv>
4277 <refname>default.table.frame</refname>
4278 <refpurpose>The default framing of tables</refpurpose>
4279 </refnamediv>
4280
4281 <refsynopsisdiv>
4282 <programlisting id="default.table.frame.frag">
4283 &lt;xsl:param name="default.table.frame"&gt;all&lt;/xsl:param&gt;
4284 </programlisting>
4285 </refsynopsisdiv>
4286
4287 <refsection><info><title>Description</title></info>
4288
4289 <para>This value will be used when there is no frame attribute on the
4290 table. </para>
4291
4292 </refsection>
4293 </refentry>
4294
4295 <refentry version="5.0" id="html.cellspacing">
4296 <refmeta>
4297 <refentrytitle>html.cellspacing</refentrytitle>
4298 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4299 </refmeta>
4300 <refnamediv>
4301 <refname>html.cellspacing</refname>
4302 <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
4303 </refnamediv>
4304
4305 <refsynopsisdiv>
4306 <programlisting id="html.cellspacing.frag">
4307 &lt;xsl:param name="html.cellspacing"&gt;&lt;/xsl:param&gt;
4308 </programlisting>
4309 </refsynopsisdiv>
4310
4311 <refsection><info><title>Description</title></info>
4312
4313 <para>If non-zero, this value will be used as the default cellspacing
4314 value in HTML tables. nn for pixels or nn% for percentage
4315 length. E.g. 5 or 5%</para>
4316
4317 </refsection>
4318 </refentry>
4319
4320 <refentry version="5.0" id="html.cellpadding">
4321 <refmeta>
4322 <refentrytitle>html.cellpadding</refentrytitle>
4323 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4324 </refmeta>
4325 <refnamediv>
4326 <refname>html.cellpadding</refname>
4327 <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
4328 </refnamediv>
4329
4330 <refsynopsisdiv>
4331 <programlisting id="html.cellpadding.frag">
4332 &lt;xsl:param name="html.cellpadding"&gt;&lt;/xsl:param&gt;
4333 </programlisting>
4334 </refsynopsisdiv>
4335
4336 <refsection><info><title>Description</title></info>
4337
4338 <para>If non-zero, this value will be used as the default cellpadding value
4339 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
4340 5%</para>
4341
4342 </refsection>
4343 </refentry>
4344
4345 </reference><reference id="qa" xml:base="../html/param.xml"><title>QAndASet</title>
4346 <refentry version="5.0" id="qanda.defaultlabel">
4347 <refmeta>
4348 <refentrytitle>qanda.defaultlabel</refentrytitle>
4349 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
4350 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
4351 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo> 
4352 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4353 </refmeta>
4354 <refnamediv>
4355 <refname>qanda.defaultlabel</refname>
4356 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
4357 </refnamediv>
4358
4359 <refsynopsisdiv>
4360 <programlisting id="qanda.defaultlabel.frag">
4361 &lt;xsl:param name="qanda.defaultlabel"&gt;number&lt;/xsl:param&gt;
4362 </programlisting>
4363 </refsynopsisdiv>
4364
4365 <refsection><info><title>Description</title></info>
4366
4367 <para>If no <literal>defaultlabel</literal> attribute is specified on
4368 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
4369 values for the defaultlabel attribute (<literal>none</literal>, 
4370 <literal>number</literal> or
4371 <literal>qanda</literal>), or one of the additional stylesheet-specific values
4372 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
4373 The default value is 'number'.
4374 </para>
4375 <para>The values are rendered as follows:</para>
4376 <variablelist>
4377 <varlistentry><term><literal>qanda</literal></term>
4378 <listitem>
4379 <para><tag>question</tag>s are labeled "Q:" and
4380 <tag>answer</tag>s are labeled "A:". </para>
4381 </listitem>
4382 </varlistentry>
4383
4384 <varlistentry><term><literal>number</literal></term>
4385 <listitem>
4386 <para>The questions are enumerated and the answers
4387 are not labeled. </para>
4388 </listitem>
4389 </varlistentry>
4390
4391 <varlistentry><term><literal>qnumber</literal></term>
4392 <listitem>
4393 <para>The questions are labeled "Q:" followed by a number, and answers are not 
4394 labeled. 
4395 When sections are numbered, adding a label
4396 to the number distinguishes the question numbers
4397 from the section numbers.
4398 This value is not allowed in the
4399 <tag class="attribute">defaultlabel</tag> attribute
4400 of a <tag>qandaset</tag> element.</para>
4401 </listitem>
4402 </varlistentry>
4403
4404 <varlistentry><term><literal>qnumberanda</literal></term>
4405 <listitem>
4406 <para>The questions are labeled "Q:" followed by a number, and
4407 the answers are labeled "A:". 
4408 When sections are numbered, adding a label
4409 to the number distinguishes the question numbers
4410 from the section numbers.
4411 This value is not allowed in the
4412 <tag class="attribute">defaultlabel</tag> attribute
4413 of a <tag>qandaset</tag> element.</para>
4414 </listitem>
4415 </varlistentry>
4416
4417 <varlistentry><term><literal>none</literal></term>
4418 <listitem>
4419 <para>No distinguishing label precedes Questions or Answers. 
4420 </para>
4421 </listitem>
4422 </varlistentry>
4423 </variablelist>
4424
4425 </refsection>
4426 </refentry>
4427
4428 <refentry version="5.0" id="qanda.inherit.numeration">
4429 <refmeta>
4430 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4431 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4432 </refmeta>
4433 <refnamediv>
4434 <refname>qanda.inherit.numeration</refname>
4435 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4436 </refnamediv>
4437
4438 <refsynopsisdiv>
4439 <programlisting id="qanda.inherit.numeration.frag">
4440 &lt;xsl:param name="qanda.inherit.numeration" select="1"&gt;&lt;/xsl:param&gt;
4441 </programlisting>
4442 </refsynopsisdiv>
4443
4444 <refsection><info><title>Description</title></info>
4445
4446 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4447 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4448 the ancestors of the <tag>qandaset</tag>.
4449 </para>
4450
4451 </refsection>
4452 </refentry>
4453
4454 <refentry version="5.0" id="qanda.in.toc">
4455 <refmeta>
4456 <refentrytitle>qanda.in.toc</refentrytitle>
4457 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4458 </refmeta>
4459 <refnamediv>
4460 <refname>qanda.in.toc</refname>
4461 <refpurpose>Should qandaentry questions appear in 
4462 the document table of contents?</refpurpose>
4463 </refnamediv>
4464
4465 <refsynopsisdiv>
4466 <programlisting id="qanda.in.toc.frag">&lt;xsl:param name="qanda.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
4467 </refsynopsisdiv>
4468
4469 <refsection><info><title>Description</title></info>
4470
4471 <para>If true (non-zero), then the generated table of contents
4472 for a document will include <tag>qandaset</tag> titles, 
4473 <tag>qandadiv</tag> titles,
4474 and <tag>question</tag> elements.  The default value (zero) excludes
4475 them from the TOC.
4476 </para>
4477 <para>This parameter does not affect any tables of contents
4478 that may be generated inside a qandaset or qandadiv.
4479 </para>
4480
4481 </refsection>
4482 </refentry>
4483
4484 <refentry version="5.0" id="qanda.nested.in.toc">
4485 <refmeta>
4486 <refentrytitle>qanda.nested.in.toc</refentrytitle>
4487 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4488 </refmeta>
4489 <refnamediv>
4490 <refname>qanda.nested.in.toc</refname>
4491 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
4492 </refnamediv>
4493
4494 <refsynopsisdiv>
4495 <programlisting id="qanda.nested.in.toc.frag">
4496 &lt;xsl:param name="qanda.nested.in.toc" select="0"&gt;&lt;/xsl:param&gt;
4497 </programlisting>
4498 </refsynopsisdiv>
4499
4500 <refsection><info><title>Description</title></info>
4501
4502 <para>If non-zero, instances of <tag>qandaentry</tag>
4503 that are children of <tag>answer</tag> elements are shown in
4504 the TOC.</para>
4505
4506 </refsection>
4507 </refentry>
4508
4509 </reference><reference id="links" xml:base="../html/param.xml"><title>Linking</title>
4510 <refentry version="5.0" id="target.database.document"> 
4511 <refmeta> 
4512 <refentrytitle>target.database.document</refentrytitle> 
4513 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> 
4514 </refmeta> 
4515 <refnamediv> 
4516 <refname>target.database.document</refname> 
4517 <refpurpose>Name of master database file for resolving
4518 olinks</refpurpose> 
4519 </refnamediv> 
4520 <refsynopsisdiv> 
4521 <programlisting id="target.database.document.frag">
4522  &lt;xsl:param name="target.database.document"&gt;olinkdb.xml&lt;/xsl:param&gt;
4523 </programlisting> 
4524 </refsynopsisdiv> 
4525 <refsection><info><title>Description</title></info>
4526  
4527 <para>
4528 To resolve olinks between documents, the stylesheets use a master
4529 database document that identifies the target datafiles for all the
4530 documents within the scope of the olinks. This parameter value is the
4531 URI of the master document to be read during processing to resolve
4532 olinks.  The default value is <filename>olinkdb.xml</filename>.</para>
4533
4534 <para>The data structure of the file is defined in the
4535 <filename>targetdatabase.dtd</filename> DTD.  The database file
4536 provides the high level elements to record the identifiers, locations,
4537 and relationships of documents. The cross reference data for
4538 individual documents is generally pulled into the database using
4539 system entity references or XIncludes. See also
4540 <parameter>targets.filename</parameter>.  </para> </refsection>
4541 </refentry>
4542
4543 <refentry version="5.0" id="targets.filename"> 
4544 <refmeta> 
4545 <refentrytitle>targets.filename</refentrytitle> 
4546 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
4547 </refmeta> 
4548 <refnamediv> 
4549 <refname>targets.filename</refname> 
4550 <refpurpose>Name of cross reference targets data file</refpurpose> 
4551 </refnamediv> 
4552 <refsynopsisdiv> <programlisting id="targets.filename.frag">
4553 &lt;xsl:param name="targets.filename"&gt;target.db&lt;/xsl:param&gt;
4554 </programlisting> 
4555 </refsynopsisdiv> 
4556 <refsection><info><title>Description</title></info>
4557  
4558 <para>
4559 In order to resolve olinks efficiently, the stylesheets can
4560 generate an external data file containing information about
4561 all potential cross reference endpoints in a document.
4562 This parameter lets you change the name of the generated
4563 file from the default name <filename>target.db</filename>.
4564 The name must agree with that used in the target database
4565 used to resolve olinks during processing.
4566 See also <parameter>target.database.document</parameter>.
4567 </para> 
4568 </refsection> 
4569 </refentry>
4570
4571 <refentry version="5.0" id="olink.base.uri"> 
4572 <refmeta> 
4573 <refentrytitle>olink.base.uri</refentrytitle> 
4574 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> 
4575 </refmeta> 
4576 <refnamediv> 
4577 <refname>olink.base.uri</refname> 
4578 <refpurpose>Base URI used in olink hrefs</refpurpose> 
4579 </refnamediv> 
4580 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
4581 &lt;xsl:param name="olink.base.uri"&gt;&lt;/xsl:param&gt;
4582 </programlisting> 
4583 </refsynopsisdiv> 
4584 <refsection><info><title>Description</title></info> 
4585  
4586 <para>When cross reference data is collected for resolving olinks, it
4587 may be necessary to prepend a base URI to each target's href. This
4588 parameter lets you set that base URI when cross reference data is
4589 collected. This feature is needed when you want to link to a document
4590 that is processed without chunking. The output filename for such a
4591 document is not known to the XSL stylesheet; the only target
4592 information consists of fragment identifiers such as
4593 <literal>#idref</literal>. To enable the resolution of olinks between
4594 documents, you should pass the name of the HTML output file as the
4595 value of this parameter. Then the hrefs recorded in the cross
4596 reference data collection look like
4597 <literal>outfile.html#idref</literal>, which can be reached as links
4598 from other documents.</para>
4599 </refsection> 
4600 </refentry>
4601
4602 <refentry version="5.0" id="use.local.olink.style"> 
4603 <refmeta> 
4604 <refentrytitle>use.local.olink.style</refentrytitle> 
4605 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> 
4606 </refmeta> 
4607 <refnamediv> 
4608 <refname>use.local.olink.style</refname> 
4609 <refpurpose>Process olinks using xref style of current
4610 document</refpurpose> 
4611 </refnamediv> 
4612 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
4613 &lt;xsl:param name="use.local.olink.style" select="0"&gt;&lt;/xsl:param&gt; </programlisting> 
4614 </refsynopsisdiv> 
4615 <refsection><info><title>Description</title></info> 
4616  
4617 <para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross
4618 reference string is formed again from the target title, number, and
4619 element name, using the stylesheet processing the targeting document.
4620 Then olinks will match the xref style in the targeting document
4621 rather than in the target document. If  both documents are processed
4622 with the same stylesheet, then the results will be the same.</para> 
4623 </refsection> 
4624 </refentry>
4625
4626 <refentry version="5.0" id="current.docid"> 
4627 <refmeta> 
4628 <refentrytitle>current.docid</refentrytitle> 
4629 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
4630 </refmeta> 
4631 <refnamediv> 
4632 <refname>current.docid</refname> 
4633 <refpurpose>targetdoc identifier for the document being
4634 processed</refpurpose> 
4635 </refnamediv> 
4636 <refsynopsisdiv> <programlisting id="current.docid.frag">
4637 &lt;xsl:param name="current.docid"&gt;&lt;/xsl:param&gt;
4638 </programlisting> 
4639 </refsynopsisdiv> 
4640 <refsection><info><title>Description</title></info> 
4641  
4642 <para>When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> database file. This parameter passes to the stylesheet
4643 the targetdoc identifier of the current document, since that
4644 identifier does not appear in the document itself. </para>
4645 <para>This parameter can also be used for print output. If an olink's  <literal>targetdoc</literal>  id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also <parameter>olink.doctitle</parameter> to enable that feature.</para> 
4646 </refsection> 
4647 </refentry>
4648
4649 <refentry version="5.0" id="olink.doctitle"> 
4650 <refmeta> 
4651 <refentrytitle>olink.doctitle</refentrytitle> 
4652 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
4653 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4654 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4655 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4656 </refmeta> 
4657 <refnamediv> 
4658 <refname>olink.doctitle</refname> 
4659 <refpurpose>show the document title for external olinks?</refpurpose>
4660
4661 </refnamediv> 
4662 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
4663 &lt;xsl:param name="olink.doctitle"&gt;no&lt;/xsl:param&gt; 
4664 </programlisting> 
4665 </refsynopsisdiv> 
4666 <refsection><info><title>Description</title></info> 
4667  
4668 <para>When olinks between documents are resolved, the generated text
4669 may not make it clear that the reference is to another document.
4670 It is possible for the stylesheets to append the other document's
4671 title to external olinks. For this to happen, two parameters must
4672 be set.</para>
4673 <itemizedlist>
4674 <listitem>
4675 <para>This <parameter>olink.doctitle</parameter> parameter
4676 should be set to either <literal>yes</literal> or <literal>maybe</literal>
4677 to enable this feature.
4678 </para>
4679 </listitem>
4680 <listitem>
4681 <para>And you should also set the <parameter>current.docid</parameter>
4682 parameter to the document id for the  document currently
4683 being processed for output.
4684 </para>
4685 </listitem>
4686 </itemizedlist>
4687
4688 <para>
4689 Then if an olink's  <literal>targetdoc</literal> id differs from
4690 the <literal>current.docid</literal> value, the stylesheet knows
4691 that it is a reference to another document and can
4692 append the target document's
4693 title to the generated olink text. </para> 
4694
4695 <para>The text for the target document's title is copied from the
4696 olink database from the <tag>ttl</tag> element
4697 of the top-level <tag>div</tag> for that document.
4698 If that <tag>ttl</tag> element is missing or empty,
4699 no title is output.
4700 </para>
4701
4702 <para>The supported values for <parameter>olink.doctitle</parameter> are:
4703 </para>
4704 <variablelist>
4705 <varlistentry>
4706 <term><literal>yes</literal></term>
4707 <listitem>
4708 <para>
4709 Always insert the title to the target document if it is not
4710 the current document.
4711 </para>
4712 </listitem>
4713 </varlistentry>
4714 <varlistentry>
4715 <term><literal>no</literal></term>
4716 <listitem>
4717 <para>
4718 Never insert the title to the target document, even if requested
4719 in an <tag class="attribute">xrefstyle</tag> attribute.
4720 </para>
4721 </listitem>
4722 </varlistentry>
4723 <varlistentry>
4724 <term><literal>maybe</literal></term>
4725 <listitem>
4726 <para>
4727 Only insert the title to the target document, if requested
4728 in an <tag class="attribute">xrefstyle</tag> attribute.
4729 </para>
4730 </listitem>
4731 </varlistentry>
4732 </variablelist>
4733 <para>An <tag class="attribute">xrefstyle</tag> attribute
4734 may override the global setting for individual olinks.
4735 The following values are supported in an
4736 <tag class="attribute">xrefstyle</tag>
4737 attribute using the <literal>select:</literal> syntax:
4738 </para>
4739
4740 <variablelist>
4741 <varlistentry>
4742 <term><literal>docname</literal></term>
4743 <listitem>
4744 <para>
4745 Insert the target document name for this olink using the
4746 <literal>docname</literal> gentext template, but only
4747 if the value of <parameter>olink.doctitle</parameter>
4748 is not <literal>no</literal>.
4749 </para>
4750 </listitem>
4751 </varlistentry>
4752 <varlistentry>
4753 <term><literal>docnamelong</literal></term>
4754 <listitem>
4755 <para>
4756 Insert the target document name for this olink using the
4757 <literal>docnamelong</literal> gentext template, but only
4758 if the value of <parameter>olink.doctitle</parameter>
4759 is not <literal>no</literal>.
4760 </para>
4761 </listitem>
4762 </varlistentry>
4763 <varlistentry>
4764 <term><literal>nodocname</literal></term>
4765 <listitem>
4766 <para>
4767 Omit the target document name even if
4768 the value of <parameter>olink.doctitle</parameter>
4769 is <literal>yes</literal>.
4770 </para>
4771 </listitem>
4772 </varlistentry>
4773 </variablelist>
4774 <para>Another way of inserting the target document name 
4775 for a single olink is to employ an
4776 <tag class="attribute">xrefstyle</tag>
4777 attribute using the <literal>template:</literal> syntax.
4778 The <literal>%o</literal> placeholder (the letter o, not zero)
4779 in such a template
4780 will be filled in with the target document's title when it is processed.
4781 This will occur regardless of 
4782 the value of <parameter>olink.doctitle</parameter>.
4783 </para>
4784 <para>Note that prior to version 1.66 of the XSL stylesheets,
4785 the allowed values for this parameter were 0 and 1.  Those
4786 values are still supported and mapped to 'no' and 'yes', respectively.
4787 </para>
4788 </refsection> 
4789 </refentry>
4790
4791 <refentry version="5.0" id="olink.debug">
4792 <refmeta>
4793 <refentrytitle>olink.debug</refentrytitle>
4794 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4795 </refmeta>
4796 <refnamediv>
4797 <refname>olink.debug</refname>
4798 <refpurpose>Turn on debugging messages for olinks</refpurpose>
4799 </refnamediv>
4800
4801 <refsynopsisdiv>
4802 <programlisting id="olink.debug.frag">
4803 &lt;xsl:param name="olink.debug" select="0"&gt;&lt;/xsl:param&gt;
4804 </programlisting>
4805 </refsynopsisdiv>
4806
4807 <refsection><info><title>Description</title></info>
4808
4809 <para>If non-zero, then each olink will generate several
4810 messages about how it is being resolved during processing.
4811 This is useful when an olink does not resolve properly
4812 and the standard error messages are not sufficient to
4813 find the problem. 
4814 </para>
4815
4816 <para>You may need to read through the olink XSL templates
4817 to understand the context for some of the debug messages.
4818 </para>
4819
4820 </refsection>
4821 </refentry>
4822
4823 <refentry version="5.0" id="olink.properties">
4824 <refmeta>
4825 <refentrytitle>olink.properties</refentrytitle>
4826 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4827 </refmeta>
4828 <refnamediv>
4829 <refname>olink.properties</refname>
4830 <refpurpose>Properties associated with the cross-reference 
4831 text of an olink.</refpurpose>
4832 </refnamediv>
4833
4834 <refsynopsisdiv>
4835 <programlisting id="olink.properties.frag">
4836 &lt;xsl:attribute-set name="olink.properties"&gt;
4837   &lt;xsl:attribute name="show-destination"&gt;replace&lt;/xsl:attribute&gt;
4838 &lt;/xsl:attribute-set&gt;
4839 </programlisting>
4840 </refsynopsisdiv>
4841
4842 <refsection><info><title>Description</title></info>
4843
4844 <para>This <literal>attribute set</literal> is applied to the
4845 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
4846 optional page number or optional title of the external
4847 document.</para>
4848
4849 </refsection>
4850 </refentry>
4851
4852 <refentry version="5.0" id="olink.lang.fallback.sequence"> 
4853 <refmeta> 
4854 <refentrytitle>olink.lang.fallback.sequence</refentrytitle> 
4855 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
4856 </refmeta> 
4857 <refnamediv> 
4858 <refname>olink.lang.fallback.sequence</refname> 
4859 <refpurpose>look up translated documents if olink not found?</refpurpose>
4860
4861 </refnamediv> 
4862 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
4863 &lt;xsl:param name="olink.lang.fallback.sequence"&gt;&lt;/xsl:param&gt;
4864 </programlisting> 
4865 </refsynopsisdiv> 
4866 <refsection><info><title>Description</title></info> 
4867  
4868
4869 <para>This parameter defines a list of lang values
4870 to search among to resolve olinks.
4871 </para>
4872
4873 <para>Normally an olink tries to resolve to a document in the same
4874 language as the olink itself.  The language of an olink
4875 is determined by its nearest ancestor element with a
4876 <tag class="attribute">lang</tag> attribute, otherwise the
4877 value of the <parameter>l10n.gentext.default.lang</parameter>
4878 parameter.
4879 </para>
4880
4881 <para>An olink database can contain target data for the same
4882 document in multiple languages.  Each set of data has the
4883 same value for the <tag>targetdoc</tag> attribute in
4884 the <tag>document</tag> element in the database, but with a 
4885 different <tag>lang</tag> attribute value.
4886 </para>
4887
4888 <para>When an olink is being resolved, the target is first
4889 sought in the document with the same language as the olink.
4890 If no match is found there, then this parameter is consulted
4891 for additional languages to try.</para>
4892
4893 <para>The <parameter>olink.lang.fallback.sequence</parameter>
4894 must be a whitespace separated list of lang values to
4895 try.  The first one with a match in the olink database is used.
4896 The default value is empty.</para>
4897
4898 <para>For example, a document might be written in German
4899 and contain an olink with
4900 <literal>targetdoc="adminguide"</literal>.
4901 When the document is processed, the processor
4902 first looks for a target dataset in the
4903 olink database starting with:</para>
4904
4905 <literallayout><literal>&lt;document targetdoc="adminguide" lang="de"&gt;</literal>.
4906 </literallayout>
4907
4908 <para>If there is no such element, then the
4909 <parameter>olink.lang.fallback.sequence</parameter> 
4910 parameter is consulted.
4911 If its value is, for example, <quote>fr en</quote>, then the processor next
4912 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
4913 then for <literal>targetdoc="adminguide" lang="en"</literal>.
4914 If there is still no match, it looks for
4915 <literal>targetdoc="adminguide"</literal> with no
4916 lang attribute.
4917 </para>
4918
4919 <para>This parameter is useful when a set of documents is only
4920 partially translated, or is in the process of being translated.  
4921 If a target of an olink has not yet been translated, then this
4922 parameter permits the processor to look for the document in
4923 other languages.  This assumes the reader would rather have
4924 a link to a document in a different language than to have
4925 a broken link.
4926 </para>
4927
4928 </refsection> 
4929 </refentry>
4930
4931 <refentry version="5.0" id="insert.olink.page.number">
4932 <refmeta>
4933 <refentrytitle>insert.olink.page.number</refentrytitle>
4934 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
4935 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4936 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4937 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4938 </refmeta>
4939 <refnamediv>
4940 <refname>insert.olink.page.number</refname>
4941 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
4942 </refnamediv>
4943
4944 <refsynopsisdiv>
4945 <programlisting id="insert.olink.page.number.frag">
4946 &lt;xsl:param name="insert.olink.page.number"&gt;no&lt;/xsl:param&gt;
4947 </programlisting>
4948 </refsynopsisdiv>
4949
4950 <refsection><info><title>Description</title></info>
4951
4952 <para>The value of this parameter determines if
4953 cross references made between documents with
4954 <tag>olink</tag> will 
4955 include page number citations.
4956 In most cases this is only applicable to references in printed output.
4957 </para>
4958 <para>The parameter has three possible values.
4959 </para>
4960 <variablelist>
4961 <varlistentry>
4962 <term>no</term>
4963 <listitem><para>No page number references will be generated for olinks.
4964 </para></listitem>
4965 </varlistentry>
4966 <varlistentry>
4967 <term>yes</term>
4968 <listitem><para>Page number references will be generated
4969 for all <tag>olink</tag> references.
4970 The style of page reference may be changed
4971 if an <tag class="attribute">xrefstyle</tag>
4972 attribute is used.
4973 </para></listitem>
4974 </varlistentry>
4975 <varlistentry>
4976 <term>maybe</term>
4977 <listitem><para>Page number references will not be generated
4978 for an <tag>olink</tag> element unless 
4979 it has an
4980 <tag class="attribute">xrefstyle</tag>
4981 attribute whose value specifies a page reference.
4982 </para></listitem>
4983 </varlistentry>
4984 </variablelist>
4985 <para>Olinks that point to targets within the same document
4986 are treated as <tag>xref</tag>s, and controlled by
4987 the <parameter>insert.xref.page.number</parameter> parameter.
4988 </para>
4989
4990 <para>Page number references for olinks to
4991 external documents can only be inserted if the 
4992 information exists in the olink database. 
4993 This means each olink target element 
4994 (<tag>div</tag> or <tag>obj</tag>)
4995 must have a <tag class="attribute">page</tag> attribute
4996 whose value is its page number in the target document.
4997 The XSL stylesheets are not able to extract that information
4998 during processing because pages have not yet been created in
4999 XSLT transformation.  Only the XSL-FO processor knows what
5000 page each element is placed on.
5001 Therefore some postprocessing must take place to populate
5002 page numbers in the olink database.
5003 </para>
5004
5005
5006
5007 </refsection>
5008 </refentry>
5009
5010 <refentry version="5.0" id="insert.olink.pdf.frag">
5011 <refmeta>
5012 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
5013 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5014 </refmeta>
5015 <refnamediv>
5016 <refname>insert.olink.pdf.frag</refname>
5017 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
5018 </refnamediv>
5019
5020 <refsynopsisdiv>
5021 <programlisting id="insert.olink.pdf.frag.frag">
5022 &lt;xsl:param name="insert.olink.pdf.frag" select="0"&gt;&lt;/xsl:param&gt;
5023 </programlisting>
5024 </refsynopsisdiv>
5025
5026 <refsection><info><title>Description</title></info>
5027
5028 <para>The value of this parameter determines whether
5029 the cross reference URIs to PDF documents made with
5030 <tag>olink</tag> will 
5031 include fragment identifiers.
5032 </para>
5033
5034 <para>When forming a URI to link to a PDF document,
5035 a fragment identifier (typically a '#' followed by an
5036 id value) appended to the PDF filename can be used by
5037 the PDF viewer to open
5038 the PDF file to a location within the document instead of
5039 the first page.
5040 However, not all PDF files have id
5041 values embedded in them, and not all PDF viewers can
5042 handle fragment identifiers. 
5043 </para>
5044
5045 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
5046 to a non-zero value, then any olink targeting a
5047 PDF file will have the fragment identifier appended to the URI.
5048 The URI is formed by concatenating the value of the
5049 <parameter>olink.base.uri</parameter> parameter, the
5050 value of the <tag class="attribute">baseuri</tag>
5051 attribute from the <tag class="element">document</tag>
5052 element in the olink database with the matching
5053 <tag class="attribute">targetdoc</tag> value,
5054 and the value of the <tag class="attribute">href</tag>
5055 attribute for the targeted element in the olink database.
5056 The <tag class="attribute">href</tag> attribute
5057 contains the fragment identifier.
5058 </para>
5059
5060 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
5061 to zero (the default value), then 
5062 the <tag class="attribute">href</tag> attribute
5063 from the olink database
5064 is not appended to PDF olinks, so the fragment identifier is left off.
5065 A PDF olink is any olink for which the
5066 <tag class="attribute">baseuri</tag> attribute
5067 from the matching <tag class="element">document</tag>
5068 element in the olink database ends with '.pdf'.
5069 Any other olinks will still have the fragment identifier added.
5070 </para>
5071 </refsection>
5072 </refentry>
5073
5074 <refentry version="5.0" id="prefer.internal.olink">
5075 <refmeta>
5076 <refentrytitle>prefer.internal.olink</refentrytitle>
5077 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5078 </refmeta>
5079 <refnamediv>
5080 <refname>prefer.internal.olink</refname>
5081 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
5082 </refnamediv>
5083
5084 <refsynopsisdiv>
5085 <programlisting id="prefer.internal.olink.frag">
5086 &lt;xsl:param name="prefer.internal.olink" select="0"&gt;&lt;/xsl:param&gt;
5087 </programlisting>
5088 </refsynopsisdiv>
5089
5090 <refsection><info><title>Description</title></info>
5091
5092 <para>If you are re-using XML content modules in multiple documents,
5093 you may want to redirect some of your olinks.  This parameter
5094 permits you to redirect an olink to the current document.
5095 </para>
5096
5097 <para>For example: you are writing documentation for a  product, 
5098 which includes 3 manuals: a little installation
5099 booklet (booklet.xml), a user 
5100 guide (user.xml), and a reference manual (reference.xml).
5101 All 3 documents begin with the same introduction section (intro.xml) that 
5102 contains a reference to the customization section (custom.xml) which is 
5103 included in both user.xml and reference.xml documents.
5104 </para>
5105
5106 <para>How do you write the link to custom.xml in intro.xml
5107 so that it is interpreted correctly in all 3 documents?</para>
5108 <itemizedlist>
5109 <listitem><para>If you use xref, it will fail in user.xml.</para>
5110 </listitem>
5111 <listitem><para>If you use olink (pointing to reference.xml),
5112 the reference in user.xml  
5113 will point to the customization section of the reference manual, while it is 
5114 actually available in user.xml.</para>
5115 </listitem>
5116 </itemizedlist>
5117
5118 <para>If you set the <parameter>prefer.internal.olink</parameter>
5119 parameter to a non-zero value, then the processor will
5120 first look in the olink database
5121 for the olink's <tag>targetptr</tag> attribute value
5122 in document matching the <parameter>current.docid</parameter>
5123 parameter value.  If it isn't found there, then
5124 it tries the document in the database
5125 with the <tag>targetdoc</tag>
5126 value that matches the olink's <tag>targetdoc</tag>
5127 attribute.
5128 </para>
5129
5130 <para>This feature permits an olink reference to resolve to
5131 the current document if there is an element
5132 with an id matching the olink's <tag>targetptr</tag>
5133 value.  The current document's olink data must be
5134 included in the target database for this to work.</para>
5135
5136 <caution>
5137 <para>There is a potential for incorrect links if
5138 the same <tag>id</tag> attribute value is used for different
5139 content in different documents.
5140 Some of your olinks may be redirected to the current document
5141 when they shouldn't be.  It is not possible to control
5142 individual olink instances.</para>
5143 </caution>
5144
5145 </refsection>
5146 </refentry>
5147
5148 <refentry version="5.0" id="link.mailto.url">
5149 <refmeta>
5150 <refentrytitle>link.mailto.url</refentrytitle>
5151 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5152 </refmeta>
5153 <refnamediv>
5154 <refname>link.mailto.url</refname>
5155 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
5156 </refnamediv>
5157
5158 <refsynopsisdiv>
5159 <programlisting id="link.mailto.url.frag">
5160 &lt;xsl:param name="link.mailto.url"&gt;&lt;/xsl:param&gt;
5161 </programlisting>
5162 </refsynopsisdiv>
5163
5164 <refsection><info><title>Description</title></info>
5165
5166 <para>If not the empty string, this address will be used for the
5167 rel=made <literal>link</literal> element in the html <literal>head</literal>
5168 </para>
5169
5170 </refsection>
5171 </refentry>
5172
5173 <refentry version="5.0" id="ulink.target">
5174 <refmeta>
5175 <refentrytitle>ulink.target</refentrytitle>
5176 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5177 </refmeta>
5178 <refnamediv>
5179 <refname>ulink.target</refname>
5180 <refpurpose>The HTML anchor target for ULinks</refpurpose>
5181 </refnamediv>
5182
5183 <refsynopsisdiv>
5184 <programlisting id="ulink.target.frag">
5185 &lt;xsl:param name="ulink.target"&gt;_top&lt;/xsl:param&gt;
5186 </programlisting>
5187 </refsynopsisdiv>
5188
5189 <refsection><info><title>Description</title></info>
5190
5191 <para>If <parameter>ulink.target</parameter> is non-zero, its value will
5192 be used for the <literal>target</literal> attribute
5193 on anchors generated for <tag>ulink</tag>s.</para>
5194
5195 </refsection>
5196 </refentry>
5197
5198 <refentry version="5.0" id="olink.fragid">
5199 <refmeta>
5200 <refentrytitle>olink.fragid</refentrytitle>
5201 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5202 </refmeta>
5203 <refnamediv>
5204 <refname>olink.fragid</refname>
5205 <refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose>
5206 </refnamediv>
5207 <refsynopsisdiv>
5208 <programlisting id="olink.fragid.frag">
5209 &lt;xsl:param name="olink.fragid"&gt;fragid=&lt;/xsl:param&gt;
5210 </programlisting>
5211 </refsynopsisdiv>
5212 <refsection><info><title>Description</title></info>
5213 <para>The fragment identifier portion of an <tag>olink</tag> target.</para>
5214 </refsection>
5215 </refentry>
5216
5217 <refentry version="5.0" id="olink.outline.ext">
5218 <refmeta>
5219 <refentrytitle>olink.outline.ext</refentrytitle>
5220 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5221 </refmeta>
5222 <refnamediv>
5223 <refname>olink.outline.ext</refname>
5224 <refpurpose>The extension of OLink outline files</refpurpose>
5225 </refnamediv>
5226
5227 <refsynopsisdiv>
5228 <programlisting id="olink.outline.ext.frag">
5229 &lt;xsl:param name="olink.outline.ext"&gt;.olink&lt;/xsl:param&gt;
5230 </programlisting>
5231 </refsynopsisdiv>
5232
5233 <refsection><info><title>Description</title></info>
5234
5235 <para>The extension to be expected for  OLink outline files</para>
5236 <para>Bob has this parameter as dead. Please don't use</para>
5237
5238 </refsection>
5239 </refentry>
5240
5241 <refentry version="5.0" id="olink.pubid">
5242 <refmeta>
5243 <refentrytitle>olink.pubid</refentrytitle>
5244 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5245 </refmeta>
5246 <refnamediv>
5247 <refname>olink.pubid</refname>
5248 <refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose>
5249 </refnamediv>
5250
5251 <refsynopsisdiv>
5252 <programlisting id="olink.pubid.frag">
5253 &lt;xsl:param name="olink.pubid"&gt;pubid&lt;/xsl:param&gt;
5254 </programlisting>
5255 </refsynopsisdiv>
5256
5257 <refsection><info><title>Description</title></info>
5258
5259 <para/>
5260
5261 </refsection>
5262 </refentry>
5263
5264 <refentry version="5.0" id="olink.sysid">
5265 <refmeta>
5266 <refentrytitle>olink.sysid</refentrytitle>
5267 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5268 </refmeta>
5269 <refnamediv>
5270 <refname>olink.sysid</refname>
5271 <refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose>
5272 </refnamediv>
5273
5274 <refsynopsisdiv>
5275 <programlisting id="olink.sysid.frag">
5276 &lt;xsl:param name="olink.sysid"&gt;sysid&lt;/xsl:param&gt;
5277 </programlisting>
5278 </refsynopsisdiv>
5279
5280 <refsection><info><title>Description</title></info>
5281
5282 <para>FIXME</para>
5283
5284 </refsection>
5285 </refentry>
5286
5287 <refentry version="5.0" id="olink.resolver">
5288 <refmeta>
5289 <refentrytitle>olink.resolver</refentrytitle>
5290 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5291 </refmeta>
5292 <refnamediv>
5293 <refname>olink.resolver</refname>
5294 <refpurpose>The root name of the OLink resolver (usually a script)</refpurpose>
5295 </refnamediv>
5296 <refsynopsisdiv>
5297 <programlisting id="olink.resolver.frag">
5298   &lt;xsl:param name="olink.resolver"&gt;/cgi-bin/olink&lt;/xsl:param&gt;
5299 </programlisting>
5300 </refsynopsisdiv>
5301 <refsection><info><title>Description</title></info>
5302 <para>FIXME:</para>
5303 </refsection>
5304 </refentry>
5305
5306 </reference><reference id="xrefs" xml:base="../html/param.xml"><title>Cross References</title>
5307 <refentry version="5.0" id="collect.xref.targets"> 
5308 <refmeta> 
5309 <refentrytitle>collect.xref.targets</refentrytitle> 
5310 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
5311 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5312 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5313 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
5314 </refmeta> 
5315 <refnamediv> 
5316 <refname>collect.xref.targets</refname> 
5317 <refpurpose>Controls whether cross reference data is
5318 collected</refpurpose> 
5319 </refnamediv> 
5320 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
5321 &lt;xsl:param name="collect.xref.targets"&gt;no&lt;/xsl:param&gt;
5322 </programlisting> 
5323 </refsynopsisdiv> 
5324 <refsection><info><title>Description</title></info> 
5325  
5326 <para>
5327 In order to resolve olinks efficiently, the stylesheets can
5328 generate an external data file containing information about
5329 all potential cross reference endpoints in a document.
5330 This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is  <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output.
5331 See also <parameter>targets.filename</parameter>.
5332 </para> 
5333 </refsection> 
5334 </refentry>
5335
5336 <refentry version="5.0" id="insert.xref.page.number">
5337 <refmeta>
5338 <refentrytitle>insert.xref.page.number</refentrytitle>
5339 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
5340 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5341 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5342 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5343 </refmeta>
5344 <refnamediv>
5345 <refname>insert.xref.page.number</refname>
5346 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
5347 </refnamediv>
5348
5349 <refsynopsisdiv>
5350 <programlisting id="insert.xref.page.number.frag">
5351 &lt;xsl:param name="insert.xref.page.number"&gt;no&lt;/xsl:param&gt;
5352 </programlisting>
5353 </refsynopsisdiv>
5354
5355 <refsection><info><title>Description</title></info>
5356
5357 <para>The value of this parameter determines if
5358 cross references (<tag>xref</tag>s) in
5359 printed output will
5360 include page number citations.
5361 It has three possible values.
5362 </para>
5363 <variablelist>
5364 <varlistentry>
5365 <term>no</term>
5366 <listitem><para>No page number references will be generated.
5367 </para></listitem>
5368 </varlistentry>
5369 <varlistentry>
5370 <term>yes</term>
5371 <listitem><para>Page number references will be generated
5372 for all <tag>xref</tag> elements.
5373 The style of page reference may be changed
5374 if an <tag class="attribute">xrefstyle</tag>
5375 attribute is used.
5376 </para></listitem>
5377 </varlistentry>
5378 <varlistentry>
5379 <term>maybe</term>
5380 <listitem><para>Page number references will not be generated
5381 for an <tag>xref</tag> element unless 
5382 it has an
5383 <tag class="attribute">xrefstyle</tag>
5384 attribute whose value specifies a page reference.
5385 </para></listitem>
5386 </varlistentry>
5387 </variablelist>
5388
5389 </refsection>
5390 </refentry>
5391
5392 <refentry version="5.0" id="use.role.as.xrefstyle">
5393 <refmeta>
5394 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
5395 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5396 </refmeta>
5397 <refnamediv>
5398 <refname>use.role.as.xrefstyle</refname>
5399 <refpurpose>Use <tag class="attribute">role</tag> attribute for
5400 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
5401 </refnamediv>
5402
5403 <refsynopsisdiv>
5404 <programlisting id="use.role.as.xrefstyle.frag">
5405 &lt;xsl:param name="use.role.as.xrefstyle" select="1"&gt;&lt;/xsl:param&gt;
5406 </programlisting>
5407 </refsynopsisdiv>
5408
5409 <refsection><info><title>Description</title></info>
5410
5411 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows 
5412 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
5413
5414 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
5415 <tag>xref</tag> will be used to select the cross reference style.
5416 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
5417 If the <tag class="attribute">xrefstyle</tag> attribute is present, 
5418 <tag class="attribute">role</tag> will be ignored, regardless of the setting
5419 of this parameter.</para>
5420
5421 </refsection>
5422
5423 <refsection><info><title>Example</title></info>
5424
5425 <para>The following small stylesheet shows how to configure the
5426 stylesheets to make use of the cross reference style:</para>
5427
5428 <programlisting>&lt;?xml version="1.0"?&gt;
5429 &lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
5430                 version="1.0"&gt;
5431
5432 &lt;xsl:import href="../xsl/html/docbook.xsl"/&gt;
5433
5434 &lt;xsl:output method="html"/&gt;
5435
5436 &lt;xsl:param name="local.l10n.xml" select="document('')"/&gt;
5437 &lt;l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"&gt;
5438   &lt;l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"&gt;
5439    &lt;l:context name="xref"&gt;
5440       &lt;l:template name="chapter" style="title" text="Chapter %n, %t"/&gt;
5441       &lt;l:template name="chapter" text="Chapter %n"/&gt;
5442     &lt;/l:context&gt;
5443   &lt;/l:l10n&gt;
5444 &lt;/l:i18n&gt;
5445
5446 &lt;/xsl:stylesheet&gt;</programlisting>
5447
5448 <para>With this stylesheet, the cross references in the following document:</para>
5449
5450 <programlisting>&lt;?xml version="1.0" encoding="utf-8"?&gt;
5451 &lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5452                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
5453 &lt;book id="book"&gt;&lt;title&gt;Book&lt;/title&gt;
5454
5455 &lt;preface&gt;
5456 &lt;title&gt;Preface&lt;/title&gt;
5457
5458 &lt;para&gt;Normal: &lt;xref linkend="ch1"/&gt;.&lt;/para&gt;
5459 &lt;para&gt;Title: &lt;xref xrefstyle="title" linkend="ch1"/&gt;.&lt;/para&gt;
5460
5461 &lt;/preface&gt;
5462
5463 &lt;chapter id="ch1"&gt;
5464 &lt;title&gt;First Chapter&lt;/title&gt;
5465
5466 &lt;para&gt;Irrelevant.&lt;/para&gt;
5467
5468 &lt;/chapter&gt;
5469 &lt;/book&gt;</programlisting>
5470
5471 <para>will appear as:</para>
5472
5473 <informalexample>
5474 <para>Normal: Chapter 1.</para>
5475 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
5476 </informalexample>
5477 </refsection>
5478
5479 </refentry>
5480
5481 <refentry version="5.0" id="xref.with.number.and.title">
5482 <refmeta>
5483 <refentrytitle>xref.with.number.and.title</refentrytitle>
5484 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5485 </refmeta>
5486 <refnamediv>
5487 <refname>xref.with.number.and.title</refname>
5488 <refpurpose>Use number and title in cross references</refpurpose>
5489 </refnamediv>
5490
5491 <refsynopsisdiv>
5492 <programlisting id="xref.with.number.and.title.frag">
5493 &lt;xsl:param name="xref.with.number.and.title" select="1"&gt;&lt;/xsl:param&gt;
5494 </programlisting>
5495 </refsynopsisdiv>
5496
5497 <refsection><info><title>Description</title></info>
5498
5499 <para>A cross reference may include the number (for example, the number of
5500 an example or figure) and the <tag>title</tag> which is a required child of some
5501 targets. This parameter inserts both the relevant number as well as
5502 the title into the link. </para>
5503
5504 </refsection>
5505 </refentry>
5506
5507 <refentry version="5.0" id="xref.label-page.separator">
5508 <refmeta>
5509 <refentrytitle>xref.label-page.separator</refentrytitle>
5510 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5511 </refmeta>
5512 <refnamediv>
5513 <refname>xref.label-page.separator</refname>
5514 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
5515 </refnamediv>
5516
5517 <refsynopsisdiv>
5518 <programlisting id="xref.label-page.separator.frag">&lt;xsl:param name="xref.label-page.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;</programlisting>
5519 </refsynopsisdiv>
5520
5521 <refsection><info><title>Description</title></info>
5522
5523 <para>
5524 This parameter allows you to control the punctuation of certain
5525 types of generated cross reference text.
5526 When cross reference text is generated for an 
5527 <tag class="element">xref</tag> or 
5528 <tag class="element">olink</tag> element
5529 using an <tag class="attribute">xrefstyle</tag> attribute
5530 that makes use of the <literal>select:</literal> feature,
5531 and the selected components include both label and page
5532 but no title,
5533 then the value of this parameter is inserted between
5534 label and page number in the output.  
5535 If a title is included, then other separators are used.
5536 </para>
5537
5538 </refsection>
5539 </refentry>
5540
5541 <refentry version="5.0" id="xref.label-title.separator">
5542 <refmeta>
5543 <refentrytitle>xref.label-title.separator</refentrytitle>
5544 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5545 </refmeta>
5546 <refnamediv>
5547 <refname>xref.label-title.separator</refname>
5548 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
5549 </refnamediv>
5550
5551 <refsynopsisdiv>
5552 <programlisting id="xref.label-title.separator.frag">&lt;xsl:param name="xref.label-title.separator"&gt;: &lt;/xsl:param&gt;</programlisting>
5553 </refsynopsisdiv>
5554
5555 <refsection><info><title>Description</title></info>
5556
5557 <para>
5558 This parameter allows you to control the punctuation of certain
5559 types of generated cross reference text.
5560 When cross reference text is generated for an 
5561 <tag class="element">xref</tag> or 
5562 <tag class="element">olink</tag> element
5563 using an <tag class="attribute">xrefstyle</tag> attribute
5564 that makes use of the <literal>select:</literal> feature,
5565 and the selected components include both label and title,
5566 then the value of this parameter is inserted between
5567 label and title in the output.  
5568 </para>
5569
5570 </refsection>
5571 </refentry>
5572
5573 <refentry version="5.0" id="xref.title-page.separator">
5574 <refmeta>
5575 <refentrytitle>xref.title-page.separator</refentrytitle>
5576 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5577 </refmeta>
5578 <refnamediv>
5579 <refname>xref.title-page.separator</refname>
5580 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
5581 </refnamediv>
5582
5583 <refsynopsisdiv>
5584 <programlisting id="xref.title-page.separator.frag">&lt;xsl:param name="xref.title-page.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;</programlisting>
5585 </refsynopsisdiv>
5586
5587 <refsection><info><title>Description</title></info>
5588
5589 <para>
5590 This parameter allows you to control the punctuation of certain
5591 types of generated cross reference text.
5592 When cross reference text is generated for an 
5593 <tag class="element">xref</tag> or 
5594 <tag class="element">olink</tag> element
5595 using an <tag class="attribute">xrefstyle</tag> attribute
5596 that makes use of the <literal>select:</literal> feature,
5597 and the selected components include both title and page number,
5598 then the value of this parameter is inserted between
5599 title and page number in the output.  
5600 </para>
5601
5602 </refsection>
5603 </refentry>
5604
5605 </reference><reference id="lists" xml:base="../html/param.xml"><title>Lists</title>
5606 <refentry version="5.0" id="segmentedlist.as.table">
5607 <refmeta>
5608 <refentrytitle>segmentedlist.as.table</refentrytitle>
5609 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5610 </refmeta>
5611 <refnamediv>
5612 <refname>segmentedlist.as.table</refname>
5613 <refpurpose>Format segmented lists as tables?</refpurpose>
5614 </refnamediv>
5615
5616 <refsynopsisdiv>
5617 <programlisting id="segmentedlist.as.table.frag">
5618 &lt;xsl:param name="segmentedlist.as.table" select="0"&gt;&lt;/xsl:param&gt;
5619 </programlisting>
5620 </refsynopsisdiv>
5621
5622 <refsection><info><title>Description</title></info>
5623
5624 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
5625 tables.</para>
5626
5627 </refsection>
5628 </refentry>
5629
5630 <refentry version="5.0" id="variablelist.as.table">
5631 <refmeta>
5632 <refentrytitle>variablelist.as.table</refentrytitle>
5633 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5634 </refmeta>
5635 <refnamediv>
5636 <refname>variablelist.as.table</refname>
5637 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
5638 </refnamediv>
5639
5640 <refsynopsisdiv>
5641 <programlisting id="variablelist.as.table.frag">
5642 &lt;xsl:param name="variablelist.as.table" select="0"&gt;&lt;/xsl:param&gt;
5643 </programlisting>
5644 </refsynopsisdiv>
5645
5646 <refsection><info><title>Description</title></info>
5647
5648 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
5649 tables. A processing instruction exists to specify a particular width for the 
5650 column containing the <tag>term</tag>s:   
5651 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
5652
5653 <para>You can override this setting with a processing instruction as the
5654 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
5655 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
5656 list-presentation="list"</tag>.</para>
5657
5658 <para>This parameter only applies to the HTML transformations. In the
5659 FO case, proper list markup is robust enough to handle the formatting.
5660 But see also <parameter>variablelist.as.blocks</parameter>.</para>
5661
5662 <programlisting>  &lt;variablelist&gt;
5663         &lt;?dbhtml list-presentation="table"?&gt;
5664         &lt;?dbhtml term-width="1.5in"?&gt;
5665         &lt;?dbfo list-presentation="list"?&gt;
5666         &lt;?dbfo term-width="1in"?&gt;
5667         &lt;varlistentry&gt;
5668           &lt;term&gt;list&lt;/term&gt;
5669           &lt;listitem&gt;
5670                 &lt;para&gt;
5671                   Formatted as a table even if variablelist.as.table is set to 0.
5672                 &lt;/para&gt;
5673           &lt;/listitem&gt;
5674         &lt;/varlistentry&gt;
5675   &lt;/variablelist&gt;</programlisting>
5676
5677 </refsection>
5678 </refentry>
5679
5680 <refentry version="5.0" id="variablelist.term.separator">
5681 <refmeta>
5682 <refentrytitle>variablelist.term.separator</refentrytitle>
5683 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5684 </refmeta>
5685 <refnamediv>
5686 <refname>variablelist.term.separator</refname>
5687 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
5688 <tag>varlistentry</tag></refpurpose>
5689 </refnamediv>
5690
5691 <refsynopsisdiv>
5692 <programlisting id="variablelist.term.separator.frag">
5693 &lt;xsl:param name="variablelist.term.separator"&gt;, &lt;/xsl:param&gt;</programlisting>
5694 </refsynopsisdiv>
5695
5696 <refsection><info><title>Description</title></info>
5697
5698 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
5699 elements, the string specified in the value of the
5700 <parameter>variablelist.term.separator</parameter> parameter is placed
5701 after each <tag>term</tag> except the last.</para>
5702
5703 <note>
5704   <para>To generate a line break between multiple <tag>term</tag>s in
5705   a <tag>varlistentry</tag>, set a non-zero value for the
5706   <parameter>variablelist.term.break.after</parameter> parameter. If
5707   you do so, you may also want to set the value of the
5708   <parameter>variablelist.term.separator</parameter> parameter to an
5709   empty string (to suppress rendering of the default comma and space
5710   after each <tag>term</tag>).</para>
5711 </note>
5712
5713 </refsection>
5714 </refentry>
5715
5716 <refentry version="5.0" id="variablelist.term.break.after">
5717 <refmeta>
5718 <refentrytitle>variablelist.term.break.after</refentrytitle>
5719 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5720 </refmeta>
5721 <refnamediv>
5722 <refname>variablelist.term.break.after</refname>
5723 <refpurpose>Generate line break after each <tag>term</tag> within a
5724 multi-term <tag>varlistentry</tag>?</refpurpose>
5725 </refnamediv>
5726
5727 <refsynopsisdiv>
5728 <programlisting id="variablelist.term.break.after.frag">
5729 &lt;xsl:param name="variablelist.term.break.after"&gt;0&lt;/xsl:param&gt;</programlisting>
5730 </refsynopsisdiv>
5731
5732 <refsection><info><title>Description</title></info>
5733
5734 <para>Set a non-zero value for the
5735 <parameter>variablelist.term.break.after</parameter> parameter to
5736 generate a line break between <tag>term</tag>s in a
5737 multi-term <tag>varlistentry</tag>.</para>
5738
5739 <note>
5740 <para>If you set a non-zero value for
5741 <parameter>variablelist.term.break.after</parameter>, you may also
5742 want to set the value of the
5743 <parameter>variablelist.term.separator</parameter> parameter to an
5744 empty string (to suppress rendering of the default comma and space
5745 after each <tag>term</tag>).</para>
5746 </note>
5747
5748 </refsection>
5749 </refentry>
5750
5751 </reference><reference id="biblio" xml:base="../html/param.xml"><title>Bibliography</title>
5752 <refentry version="5.0" id="bibliography.style">
5753 <refmeta>
5754 <refentrytitle>bibliography.style</refentrytitle>
5755 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5756 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
5757 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
5758 </refmeta>
5759 <refnamediv>
5760 <refname>bibliography.style</refname>
5761 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
5762 </refnamediv>
5763
5764 <refsynopsisdiv>
5765 <programlisting id="bibliography.style.frag">
5766 &lt;xsl:param name="bibliography.style"&gt;normal&lt;/xsl:param&gt;
5767 </programlisting>
5768 </refsynopsisdiv>
5769
5770 <refsection><info><title>Description</title></info>
5771
5772 <para>Currently only <literal>normal</literal> and
5773 <literal>iso690</literal> styles are supported.</para>
5774
5775 <para>In order to use ISO690 style to the full extent you might need
5776 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
5777 following WiKi page</link>.</para>
5778
5779 </refsection>
5780 </refentry>
5781
5782 <refentry version="5.0" id="biblioentry.item.separator">
5783 <refmeta>
5784 <refentrytitle>biblioentry.item.separator</refentrytitle>
5785 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5786 </refmeta>
5787 <refnamediv>
5788 <refname>biblioentry.item.separator</refname>
5789 <refpurpose>Text to separate bibliography entries</refpurpose>
5790 </refnamediv>
5791
5792 <refsynopsisdiv>
5793 <programlisting id="biblioentry.item.separator.frag">&lt;xsl:param name="biblioentry.item.separator"&gt;. &lt;/xsl:param&gt;</programlisting>
5794 </refsynopsisdiv>
5795
5796 <refsection><info><title>Description</title></info>
5797
5798 <para>Text to separate bibliography entries
5799 </para>
5800
5801 </refsection>
5802 </refentry>
5803
5804 <refentry version="5.0" id="bibliography.collection">
5805 <refmeta>
5806 <refentrytitle>bibliography.collection</refentrytitle>
5807 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5808 </refmeta>
5809 <refnamediv>
5810 <refname>bibliography.collection</refname>
5811 <refpurpose>Name of the bibliography collection file</refpurpose>
5812 </refnamediv>
5813
5814 <refsynopsisdiv>
5815 <programlisting id="bibliography.collection.frag">
5816 &lt;xsl:param name="bibliography.collection"&gt;http://docbook.sourceforge.net/release/bibliography/bibliography.xml&lt;/xsl:param&gt;
5817
5818 </programlisting>
5819 </refsynopsisdiv>
5820
5821 <refsection><info><title>Description</title></info>
5822
5823 <para>Maintaining bibliography entries across a set of documents is tedious, time
5824 consuming, and error prone. It makes much more sense, usually, to store all of
5825 the bibliography entries in a single place and simply <quote>extract</quote>
5826 the ones you need in each document.</para>
5827
5828 <para>That's the purpose of the
5829 <parameter>bibliography.collection</parameter> parameter. To setup a global
5830 bibliography <quote>database</quote>, follow these steps:</para>
5831
5832 <para>First, create a stand-alone bibliography document that contains all of
5833 the documents that you wish to reference. Make sure that each bibliography
5834 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
5835 has an ID.</para>
5836
5837 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
5838 like this:</para>
5839
5840 <informalexample>
5841 <programlisting>&lt;!DOCTYPE bibliography
5842   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5843   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
5844 &lt;bibliography&gt;&lt;title&gt;References&lt;/title&gt;
5845
5846 &lt;bibliomixed id="xml-rec"&gt;&lt;abbrev&gt;XML 1.0&lt;/abbrev&gt;Tim Bray,
5847 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
5848 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml"&gt;Extensible Markup
5849 Language (XML) 1.0 Second Edition&lt;/ulink&gt;&lt;/citetitle&gt;.
5850 World Wide Web Consortium, 2000.
5851 &lt;/bibliomixed&gt;
5852
5853 &lt;bibliomixed id="xml-names"&gt;&lt;abbrev&gt;Namespaces&lt;/abbrev&gt;Tim Bray,
5854 Dave Hollander,
5855 and Andrew Layman, editors.
5856 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml-names/"&gt;Namespaces in
5857 XML&lt;/ulink&gt;&lt;/citetitle&gt;.
5858 World Wide Web Consortium, 1999.
5859 &lt;/bibliomixed&gt;
5860
5861 &lt;!-- ... --&gt;
5862 &lt;/bibliography&gt;
5863 </programlisting>
5864 </informalexample>
5865
5866 <para>When you create a bibliography in your document, simply
5867 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
5868 entries for each document that you wish to cite. Make sure that these
5869 elements have the same ID as the corresponding <quote>real</quote>
5870 entry in your global bibliography.</para>
5871
5872 <para>For example:</para>
5873
5874 <informalexample>
5875 <programlisting>&lt;bibliography&gt;&lt;title&gt;Bibliography&lt;/title&gt;
5876
5877 &lt;bibliomixed id="xml-rec"/&gt;
5878 &lt;bibliomixed id="xml-names"/&gt;
5879 &lt;bibliomixed id="DKnuth86"&gt;Donald E. Knuth. &lt;citetitle&gt;Computers and
5880 Typesetting: Volume B, TeX: The Program&lt;/citetitle&gt;. Addison-Wesley,
5881 1986.  ISBN 0-201-13437-3.
5882 &lt;/bibliomixed&gt;
5883 &lt;bibliomixed id="relaxng"/&gt;
5884
5885 &lt;/bibliography&gt;</programlisting>
5886 </informalexample>
5887
5888 <para>Note that it's perfectly acceptable to mix entries from your
5889 global bibliography with <quote>normal</quote> entries. You can use
5890 <tag>xref</tag> or other elements to cross-reference your
5891 bibliography entries in exactly the same way you do now.</para>
5892
5893 <para>Finally, when you are ready to format your document, simply set the
5894 <parameter>bibliography.collection</parameter> parameter (in either a
5895 customization layer or directly through your processor's interface) to
5896 point to your global bibliography.</para>
5897
5898 <para>The stylesheets will format the bibliography in your document as if
5899 all of the entries referenced appeared there literally.</para>
5900
5901 </refsection>
5902 </refentry>
5903
5904 <refentry version="5.0" id="bibliography.numbered">
5905 <refmeta>
5906 <refentrytitle>bibliography.numbered</refentrytitle>
5907 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5908 </refmeta>
5909 <refnamediv>
5910 <refname>bibliography.numbered</refname>
5911 <refpurpose>Should bibliography entries be numbered?</refpurpose>
5912 </refnamediv>
5913
5914 <refsynopsisdiv>
5915 <programlisting id="bibliography.numbered.frag">
5916 &lt;xsl:param name="bibliography.numbered" select="0"&gt;&lt;/xsl:param&gt;
5917 </programlisting>
5918 </refsynopsisdiv>
5919
5920 <refsection><info><title>Description</title></info>
5921
5922 <para>If non-zero bibliography entries will be numbered</para>
5923
5924 </refsection>
5925 </refentry>
5926
5927 </reference><reference id="glossary" xml:base="../html/param.xml"><title>Glossary</title>
5928 <refentry version="5.0" id="glossterm.auto.link">
5929 <refmeta>
5930 <refentrytitle>glossterm.auto.link</refentrytitle>
5931 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5932 </refmeta>
5933 <refnamediv>
5934 <refname>glossterm.auto.link</refname>
5935 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
5936 </refnamediv>
5937
5938 <refsynopsisdiv>
5939 <programlisting id="glossterm.auto.link.frag">
5940 &lt;xsl:param name="glossterm.auto.link" select="0"&gt;&lt;/xsl:param&gt;
5941 </programlisting>
5942 </refsynopsisdiv>
5943
5944 <refsection><info><title>Description</title></info>
5945
5946 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding 
5947 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag> 
5948 will be automatically generated. This is useful when your glossterms are consistent 
5949 and you don't want to add links manually.</para>
5950
5951 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
5952 that have a <tag class="attribute">linkend</tag> attribute.</para>
5953
5954 </refsection>
5955 </refentry>
5956
5957 <refentry version="5.0" id="firstterm.only.link">
5958 <refmeta>
5959 <refentrytitle>firstterm.only.link</refentrytitle>
5960 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5961 </refmeta>
5962 <refnamediv>
5963 <refname>firstterm.only.link</refname>
5964 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
5965 </refnamediv>
5966
5967 <refsynopsisdiv>
5968 <programlisting id="firstterm.only.link.frag">
5969 &lt;xsl:param name="firstterm.only.link" select="0"&gt;&lt;/xsl:param&gt;
5970 </programlisting>
5971 </refsynopsisdiv>
5972
5973 <refsection><info><title>Description</title></info>
5974
5975 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
5976 to the glossary. If glossary linking is not enabled, this parameter
5977 has no effect.</para>
5978
5979 </refsection>
5980 </refentry>
5981
5982 <refentry version="5.0" id="glossary.collection">
5983 <refmeta>
5984 <refentrytitle>glossary.collection</refentrytitle>
5985 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5986 </refmeta>
5987 <refnamediv>
5988 <refname>glossary.collection</refname>
5989 <refpurpose>Name of the glossary collection file</refpurpose>
5990 </refnamediv>
5991
5992 <refsynopsisdiv>
5993 <programlisting id="glossary.collection.frag">
5994 &lt;xsl:param name="glossary.collection"&gt;&lt;/xsl:param&gt;
5995 </programlisting>
5996 </refsynopsisdiv>
5997
5998 <refsection><info><title>Description</title></info>
5999
6000 <para>Glossaries maintained independently across a set of documents
6001 are likely to become inconsistent unless considerable effort is
6002 expended to keep them in sync. It makes much more sense, usually, to
6003 store all of the glossary entries in a single place and simply
6004 <quote>extract</quote> the ones you need in each document.</para>
6005
6006 <para>That's the purpose of the
6007 <parameter>glossary.collection</parameter> parameter. To setup a global
6008 glossary <quote>database</quote>, follow these steps:</para>
6009
6010 <refsection><info><title>Setting Up the Glossary Database</title></info>
6011
6012 <para>First, create a stand-alone glossary document that contains all of
6013 the entries that you wish to reference. Make sure that each glossary
6014 entry has an ID.</para>
6015
6016 <para>Here's an example glossary:</para>
6017
6018 <informalexample>
6019 <programlisting>
6020 &lt;?xml version="1.0" encoding="utf-8"?&gt;
6021 &lt;!DOCTYPE glossary
6022   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
6023   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
6024 &lt;glossary&gt;
6025 &lt;glossaryinfo&gt;
6026 &lt;editor&gt;&lt;firstname&gt;Eric&lt;/firstname&gt;&lt;surname&gt;Raymond&lt;/surname&gt;&lt;/editor&gt;
6027 &lt;title&gt;Jargon File 4.2.3 (abridged)&lt;/title&gt;
6028 &lt;releaseinfo&gt;Just some test data&lt;/releaseinfo&gt;
6029 &lt;/glossaryinfo&gt;
6030
6031 &lt;glossdiv&gt;&lt;title&gt;0&lt;/title&gt;
6032
6033 &lt;glossentry&gt;
6034 &lt;glossterm&gt;0&lt;/glossterm&gt;
6035 &lt;glossdef&gt;
6036 &lt;para&gt;Numeric zero, as opposed to the letter `O' (the 15th letter of
6037 the English alphabet). In their unmodified forms they look a lot
6038 alike, and various kluges invented to make them visually distinct have
6039 compounded the confusion. If your zero is center-dotted and letter-O
6040 is not, or if letter-O looks almost rectangular but zero looks more
6041 like an American football stood on end (or the reverse), you're
6042 probably looking at a modern character display (though the dotted zero
6043 seems to have originated as an option on IBM 3270 controllers). If
6044 your zero is slashed but letter-O is not, you're probably looking at
6045 an old-style ASCII graphic set descended from the default typewheel on
6046 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
6047 curse this arrangement). (Interestingly, the slashed zero long
6048 predates computers; Florian Cajori's monumental "A History of
6049 Mathematical Notations" notes that it was used in the twelfth and
6050 thirteenth centuries.) If letter-O has a slash across it and the zero
6051 does not, your display is tuned for a very old convention used at IBM
6052 and a few other early mainframe makers (Scandinavians curse &lt;emphasis&gt;this&lt;/emphasis&gt;
6053 arrangement even more, because it means two of their letters collide).
6054 Some Burroughs/Unisys equipment displays a zero with a &lt;emphasis&gt;reversed&lt;/emphasis&gt;
6055 slash. Old CDC computers rendered letter O as an unbroken oval and 0
6056 as an oval broken at upper right and lower left. And yet another
6057 convention common on early line printers left zero unornamented but
6058 added a tail or hook to the letter-O so that it resembled an inverted
6059 Q or cursive capital letter-O (this was endorsed by a draft ANSI
6060 standard for how to draw ASCII characters, but the final standard
6061 changed the distinguisher to a tick-mark in the upper-left corner).
6062 Are we sufficiently confused yet?&lt;/para&gt;
6063 &lt;/glossdef&gt;
6064 &lt;/glossentry&gt;
6065
6066 &lt;glossentry&gt;
6067 &lt;glossterm&gt;1TBS&lt;/glossterm&gt;
6068 &lt;glossdef&gt;
6069 &lt;para role="accidence"&gt;
6070 &lt;phrase role="pronounce"&gt;&lt;/phrase&gt;
6071 &lt;phrase role="partsofspeach"&gt;n&lt;/phrase&gt;
6072 &lt;/para&gt;
6073 &lt;para&gt;The "One True Brace Style"&lt;/para&gt;
6074 &lt;glossseealso&gt;indent style&lt;/glossseealso&gt;
6075 &lt;/glossdef&gt;
6076 &lt;/glossentry&gt;
6077
6078 &lt;!-- ... --&gt;
6079
6080 &lt;/glossdiv&gt;
6081
6082 &lt;!-- ... --&gt;
6083
6084 &lt;/glossary&gt;</programlisting>
6085 </informalexample>
6086
6087 </refsection>
6088
6089 <refsection><info><title>Marking Up Glossary Terms</title></info>
6090
6091 <para>That takes care of the glossary database, now you have to get the entries
6092 into your document. Unlike bibliography entries, which can be empty, creating
6093 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
6094 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
6095
6096 <para>In your source document, simply use <tag>firstterm</tag> and
6097 <tag>glossterm</tag> to identify the terms you wish to have included
6098 in the glossary. The stylesheets assume that you will either set the
6099 <tag class="attribute">baseform</tag> attribute correctly, or that the
6100 content of the element exactly matches a term in your glossary.</para>
6101
6102 <para>If you're using a <parameter>glossary.collection</parameter>, don't
6103 make explicit links on the terms in your document.</para>
6104
6105 <para>So, in your document, you might write things like this:</para>
6106
6107 <informalexample>
6108 <programlisting>&lt;para&gt;This is dummy text, without any real meaning.
6109 The point is simply to reference glossary terms like &lt;glossterm&gt;0&lt;/glossterm&gt;
6110 and the &lt;firstterm baseform="1TBS"&gt;One True Brace Style (1TBS)&lt;/firstterm&gt;.
6111 The &lt;glossterm&gt;1TBS&lt;/glossterm&gt;, as you can probably imagine, is a nearly
6112 religious issue.&lt;/para&gt;</programlisting>
6113 </informalexample>
6114
6115 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
6116 only the terms marked with <tag>firstterm</tag> will be links.
6117 Otherwise, all the terms will be linked.</para>
6118
6119 </refsection>
6120
6121 <refsection><info><title>Marking Up the Glossary</title></info>
6122
6123 <para>The glossary itself has to be identified for the stylesheets. For lack
6124 of a better choice, the <tag class="attribute">role</tag> is used.
6125 To identify the glossary as the target for automatic processing, set
6126 the role to <quote><literal>auto</literal></quote>. The title of this
6127 glossary (and any other information from the <tag>glossaryinfo</tag>
6128 that's rendered by your stylesheet) will be displayed, but the entries will
6129 come from the database.
6130 </para>
6131
6132 <para>Unfortunately, the glossary can't be empty, so you must put in
6133 at least one <tag>glossentry</tag>. The content of this entry
6134 is irrelevant, it will not be rendered:</para>
6135
6136 <informalexample>
6137 <programlisting>&lt;glossary role="auto"&gt;
6138 &lt;glossentry&gt;
6139 &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
6140 &lt;glossdef&gt;
6141 &lt;para&gt;If you can see this, the document was processed incorrectly. Use
6142 the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
6143 &lt;/glossdef&gt;
6144 &lt;/glossentry&gt;
6145 &lt;/glossary&gt;</programlisting>
6146 </informalexample>
6147
6148 <para>What about glossary divisions? If your glossary database has glossary
6149 divisions <emphasis>and</emphasis> your automatic glossary contains at least
6150 one <tag>glossdiv</tag>, the automic glossary will have divisions.
6151 If the <tag>glossdiv</tag> is missing from either location, no divisions
6152 will be rendered.</para>
6153
6154 <para>Glossary entries (and divisions, if appropriate) in the glossary will
6155 occur in precisely the order they occur in your database.</para>
6156
6157 </refsection>
6158
6159 <refsection><info><title>Formatting the Document</title></info>
6160
6161 <para>Finally, when you are ready to format your document, simply set the
6162 <parameter>glossary.collection</parameter> parameter (in either a
6163 customization layer or directly through your processor's interface) to
6164 point to your global glossary.</para>
6165
6166 <para>The stylesheets will format the glossary in your document as if
6167 all of the entries implicilty referenced appeared there literally.</para>
6168 </refsection>
6169
6170 <refsection><info><title>Limitations</title></info>
6171
6172 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
6173 not supported. For example, this <emphasis>will not</emphasis> work:</para>
6174
6175 <informalexample>
6176 <programlisting>&lt;glossentry&gt;
6177 &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
6178 &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
6179 &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
6180 &lt;/glossdef&gt;
6181 &lt;/glossentry&gt;</programlisting>
6182 </informalexample>
6183
6184 <para>If you put glossary cross-references in your glossary that way,
6185 you'll get the cryptic error: <computeroutput>Warning:
6186 glossary.collection specified, but there are 0 automatic
6187 glossaries</computeroutput>.</para>
6188
6189 <para>Instead, you must do two things:</para>
6190
6191 <orderedlist>
6192 <listitem>
6193 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
6194
6195 <informalexample>
6196 <programlisting>&lt;glossentry&gt;
6197 &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
6198 &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
6199 &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
6200 &lt;/glossdef&gt;
6201 &lt;/glossentry&gt;</programlisting>
6202 </informalexample>
6203 </listitem>
6204
6205 <listitem>
6206 <para>Make sure there is at least one <tag>glossterm</tag> reference to
6207 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
6208 easiest way to do that is probably within a <tag>remark</tag> in your
6209 automatic glossary:</para>
6210
6211 <informalexample>
6212 <programlisting>&lt;glossary role="auto"&gt;
6213 &lt;remark&gt;Make sure there's a reference to &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/remark&gt;
6214 &lt;glossentry&gt;
6215 &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
6216 &lt;glossdef&gt;
6217 &lt;para&gt;If you can see this, the document was processed incorrectly. Use
6218 the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
6219 &lt;/glossdef&gt;
6220 &lt;/glossentry&gt;
6221 &lt;/glossary&gt;</programlisting>
6222 </informalexample>
6223 </listitem>
6224 </orderedlist>
6225 </refsection>
6226
6227 </refsection>
6228 </refentry>
6229
6230 <refentry version="5.0" id="glossary.sort">
6231 <refmeta>
6232 <refentrytitle>glossary.sort</refentrytitle>
6233 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6234 </refmeta>
6235 <refnamediv>
6236 <refname>glossary.sort</refname>
6237 <refpurpose>Sort glossentry elements?</refpurpose>
6238 </refnamediv>
6239
6240 <refsynopsisdiv>
6241 <programlisting id="glossary.sort.frag">
6242 &lt;xsl:param name="glossary.sort" select="0"&gt;&lt;/xsl:param&gt;
6243 </programlisting>
6244 </refsynopsisdiv>
6245
6246 <refsection><info><title>Description</title></info>
6247
6248 <para>If non-zero, then the glossentry elements within a
6249 glossary, glossdiv, or glosslist are sorted on the glossterm, using
6250 the current lang setting.  If zero (the default), then
6251 glossentry elements are not sorted and are presented
6252 in document order.
6253 </para>
6254
6255 </refsection>
6256 </refentry>
6257
6258 <refentry version="5.0" id="glossentry.show.acronym">
6259 <refmeta>
6260 <refentrytitle>glossentry.show.acronym</refentrytitle>
6261 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6262 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> 
6263 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
6264 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
6265 </refmeta>
6266 <refnamediv>
6267 <refname>glossentry.show.acronym</refname>
6268 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
6269 </refnamediv>
6270
6271 <refsynopsisdiv>
6272 <programlisting id="glossentry.show.acronym.frag">
6273 &lt;xsl:param name="glossentry.show.acronym"&gt;no&lt;/xsl:param&gt;
6274 </programlisting>
6275 </refsynopsisdiv>
6276
6277 <refsection><info><title>Description</title></info>
6278
6279 <para>A setting of <quote>yes</quote> means they should be displayed;
6280 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
6281 then they are shown as the primary text for the entry.</para>
6282
6283 <note>
6284 <para>This setting controls both <tag>acronym</tag> and
6285 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
6286 </note>
6287
6288 </refsection>
6289 </refentry>
6290
6291 </reference><reference id="misc" xml:base="../html/param.xml"><title>Miscellaneous</title>
6292 <refentry version="5.0" id="formal.procedures">
6293 <refmeta>
6294 <refentrytitle>formal.procedures</refentrytitle>
6295 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6296 </refmeta>
6297 <refnamediv>
6298 <refname>formal.procedures</refname>
6299 <refpurpose>Selects formal or informal procedures</refpurpose>
6300 </refnamediv>
6301
6302 <refsynopsisdiv>
6303 <programlisting id="formal.procedures.frag">
6304 &lt;xsl:param name="formal.procedures" select="1"&gt;&lt;/xsl:param&gt;
6305 </programlisting>
6306 </refsynopsisdiv>
6307
6308 <refsection><info><title>Description</title></info>
6309
6310 <para>Formal procedures are numbered and always have a title.
6311 </para>
6312
6313 </refsection>
6314 </refentry>
6315
6316 <refentry version="5.0" id="formal.title.placement">
6317 <refmeta>
6318 <refentrytitle>formal.title.placement</refentrytitle>
6319 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
6320 </refmeta>
6321 <refnamediv>
6322 <refname>formal.title.placement</refname>
6323 <refpurpose>Specifies where formal object titles should occur</refpurpose>
6324 </refnamediv>
6325
6326 <refsynopsisdiv>
6327 <programlisting id="formal.title.placement.frag">
6328 &lt;xsl:param name="formal.title.placement"&gt;
6329 figure before
6330 example before
6331 equation before
6332 table before
6333 procedure before
6334 task before
6335 &lt;/xsl:param&gt;
6336 </programlisting>
6337 </refsynopsisdiv>
6338
6339 <refsection><info><title>Description</title></info>
6340
6341 <para>Specifies where formal object titles should occur. For each formal object
6342 type (<tag>figure</tag>,
6343 <tag>example</tag>,
6344 <tag>equation</tag>,
6345 <tag>table</tag>, and <tag>procedure</tag>)
6346 you can specify either the keyword
6347 <quote><literal>before</literal></quote> or
6348 <quote><literal>after</literal></quote>.</para>
6349
6350 </refsection>
6351 </refentry>
6352
6353 <refentry version="5.0" id="runinhead.default.title.end.punct">
6354 <refmeta>
6355 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
6356 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6357 </refmeta>
6358 <refnamediv>
6359 <refname>runinhead.default.title.end.punct</refname>
6360 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
6361 </refnamediv>
6362
6363 <refsynopsisdiv>
6364 <programlisting id="runinhead.default.title.end.punct.frag">&lt;xsl:param name="runinhead.default.title.end.punct"&gt;.&lt;/xsl:param&gt;
6365 </programlisting>
6366 </refsynopsisdiv>
6367
6368 <refsection><info><title>Description</title></info>
6369
6370 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
6371 string as the separator between the title and following text. The period is the default value.</para>
6372
6373 </refsection>
6374 </refentry>
6375
6376 <refentry version="5.0" id="runinhead.title.end.punct">
6377 <refmeta>
6378 <refentrytitle>runinhead.title.end.punct</refentrytitle>
6379 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6380 </refmeta>
6381 <refnamediv>
6382 <refname>runinhead.title.end.punct</refname>
6383 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
6384 </refnamediv>
6385
6386 <refsynopsisdiv>
6387 <programlisting id="runinhead.title.end.punct.frag">
6388 &lt;xsl:param name="runinhead.title.end.punct"&gt;.!?:&lt;/xsl:param&gt;
6389 </programlisting>
6390 </refsynopsisdiv>
6391
6392 <refsection><info><title>Description</title></info>
6393
6394 <para>Specify which characters are to be counted as punctuation. These
6395 characters are checked for a match with the last character of the
6396 title. If no match is found, the
6397 <parameter>runinhead.default.title.end.punct</parameter> contents are
6398 inserted. This is to avoid duplicated punctuation in the output.
6399 </para>
6400
6401 </refsection>
6402 </refentry>
6403
6404 <refentry version="5.0" id="show.comments">
6405 <refmeta>
6406 <refentrytitle>show.comments</refentrytitle>
6407 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6408 </refmeta>
6409 <refnamediv>
6410 <refname>show.comments</refname>
6411 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
6412 </refnamediv>
6413
6414 <refsynopsisdiv>
6415 <programlisting id="show.comments.frag">
6416 &lt;xsl:param name="show.comments" select="1"&gt;&lt;/xsl:param&gt;
6417 </programlisting>
6418 </refsynopsisdiv>
6419
6420 <refsection><info><title>Description</title></info>
6421
6422 <para>If non-zero, comments will be displayed, otherwise they
6423 are suppressed.  Comments here refers to the <tag>remark</tag> element
6424 (which was called <literal>comment</literal> prior to DocBook
6425 4.0), not XML comments (&lt;-- like this --&gt;) which are
6426 unavailable.
6427 </para>
6428
6429 </refsection>
6430 </refentry>
6431
6432 <refentry version="5.0" id="show.revisionflag">
6433 <refmeta>
6434 <refentrytitle>show.revisionflag</refentrytitle>
6435 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6436 </refmeta>
6437 <refnamediv>
6438 <refname>show.revisionflag</refname>
6439 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
6440 </refnamediv>
6441
6442 <refsynopsisdiv>
6443 <programlisting id="show.revisionflag.frag">
6444 &lt;xsl:param name="show.revisionflag" select="0"&gt;&lt;/xsl:param&gt;
6445 </programlisting>
6446 </refsynopsisdiv>
6447
6448 <refsection><info><title>Description</title></info>
6449
6450 <para>
6451 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
6452 may produce additional markup designed to allow a CSS stylesheet to
6453 highlight elements that have specific revisionflag settings.</para>
6454
6455 <para>The markup inserted will be usually be either a &lt;span&gt; or
6456 &lt;div&gt; with an appropriate <literal>class</literal>
6457 attribute. (The value of the class attribute will be the same as the
6458 value of the revisionflag attribute). In some contexts, for example
6459 tables, where extra markup would be structurally illegal, the class
6460 attribute will be added to the appropriate container element.</para>
6461
6462 <para>In general, the stylesheets only test for revisionflag in contexts
6463 where an importing stylesheet would have to redefine whole templates.
6464 Most of the revisionflag processing is expected to be done by another
6465 stylesheet, for example <filename>changebars.xsl</filename>.</para>
6466
6467 </refsection>
6468 </refentry>
6469
6470 <refentry version="5.0" id="shade.verbatim">
6471 <refmeta>
6472 <refentrytitle>shade.verbatim</refentrytitle>
6473 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6474 </refmeta>
6475 <refnamediv>
6476 <refname>shade.verbatim</refname>
6477 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6478 </refnamediv>
6479
6480 <refsynopsisdiv>
6481 <programlisting id="shade.verbatim.frag">&lt;xsl:param name="shade.verbatim" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
6482 </refsynopsisdiv>
6483
6484 <refsection><info><title>Description</title></info>
6485
6486 <para>In the FO stylesheet, if this parameter is non-zero then the
6487 <property>shade.verbatim.style</property> properties will be applied
6488 to verbatim environments.</para>
6489
6490 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6491 CSS instead.</para>
6492
6493 </refsection>
6494 </refentry>
6495
6496 <refentry version="5.0" id="shade.verbatim.style">
6497 <refmeta>
6498 <refentrytitle>shade.verbatim.style</refentrytitle>
6499 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6500 </refmeta>
6501 <refnamediv>
6502 <refname>shade.verbatim.style</refname>
6503 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6504 </refnamediv>
6505
6506 <refsynopsisdiv>
6507 <programlisting id="shade.verbatim.style.frag">
6508 &lt;xsl:attribute-set name="shade.verbatim.style"&gt;
6509   &lt;xsl:attribute name="border"&gt;0&lt;/xsl:attribute&gt;
6510   &lt;xsl:attribute name="bgcolor"&gt;#E0E0E0&lt;/xsl:attribute&gt;
6511 &lt;/xsl:attribute-set&gt;
6512
6513 </programlisting>
6514 </refsynopsisdiv>
6515
6516 <refsection><info><title>Description</title></info>
6517
6518 <para>Properties that specify the style of shaded verbatim listings. The
6519 parameters specified (the border and background color) are added to
6520 the styling of the xsl-fo output. A border might be specified as "thin
6521 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
6522
6523 </refsection>
6524 </refentry>
6525
6526 <refentry version="5.0" id="punct.honorific">
6527 <refmeta>
6528 <refentrytitle>punct.honorific</refentrytitle>
6529 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6530 </refmeta>
6531 <refnamediv>
6532 <refname>punct.honorific</refname>
6533 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
6534 </refnamediv>
6535
6536 <refsynopsisdiv>
6537 <programlisting id="punct.honorific.frag">
6538 &lt;xsl:param name="punct.honorific"&gt;.&lt;/xsl:param&gt;
6539 </programlisting>
6540 </refsynopsisdiv>
6541
6542 <refsection><info><title>Description</title></info>
6543
6544 <para>This parameter specifies the punctuation that should be added after an
6545 honorific in a personal name.</para>
6546
6547 </refsection>
6548 </refentry>
6549
6550 <refentry version="5.0" id="tex.math.in.alt">
6551 <refmeta>
6552 <refentrytitle>tex.math.in.alt</refentrytitle>
6553 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
6554 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
6555 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
6556 </refmeta>
6557 <refnamediv>
6558 <refname>tex.math.in.alt</refname>
6559 <refpurpose>TeX notation used for equations</refpurpose>
6560 </refnamediv>
6561
6562 <refsynopsisdiv>
6563 <programlisting id="tex.math.in.alt.frag">
6564 &lt;xsl:param name="tex.math.in.alt"&gt;&lt;/xsl:param&gt;
6565 </programlisting>
6566 </refsynopsisdiv>
6567
6568 <refsection><info><title>Description</title></info>
6569
6570 <para>If you want type math directly in TeX notation in equations,
6571 this parameter specifies notation used. Currently are supported two
6572 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
6573 value means that you are not using TeX math at all.</para>
6574
6575 <para>Preferred way for including TeX alternative of math is inside of
6576 <tag>textobject</tag> element. Eg.:</para>
6577
6578 <programlisting>&lt;inlineequation&gt;
6579 &lt;inlinemediaobject&gt;
6580 &lt;imageobject&gt;
6581 &lt;imagedata fileref="eq1.gif"/&gt;
6582 &lt;/imageobject&gt;
6583 &lt;textobject&gt;&lt;phrase&gt;E=mc squared&lt;/phrase&gt;&lt;/textobject&gt;
6584 &lt;textobject role="tex"&gt;&lt;phrase&gt;E=mc^2&lt;/phrase&gt;&lt;/textobject&gt;
6585 &lt;/inlinemediaobject&gt;
6586 &lt;/inlineequation&gt;</programlisting>
6587
6588 <para>If you are using <tag>graphic</tag> element, you can
6589 store TeX inside <tag>alt</tag> element:</para>
6590
6591 <programlisting>&lt;inlineequation&gt;
6592 &lt;alt role="tex"&gt;a^2+b^2=c^2&lt;/alt&gt;
6593 &lt;graphic fileref="a2b2c2.gif"/&gt;  
6594 &lt;/inlineequation&gt;</programlisting>
6595
6596 <para>If you want use this feature, you should process your FO with
6597 PassiveTeX, which only supports TeX math notation. When calling
6598 stylsheet, don't forget to specify also
6599 passivetex.extensions=1.</para>
6600
6601 <para>If you want equations in HTML, just process generated file
6602 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
6603 dvi2bitmap program on result DVI file. You will get images for
6604 equations in your document.</para>
6605
6606 <warning>
6607   <para>This feature is useful for print/PDF output only if you
6608     use the obsolete and now unsupported PassiveTeX XSL-FO
6609     engine.</para>
6610 </warning>
6611
6612 </refsection>
6613
6614 <refsection><info><title>Related Parameters</title></info>
6615   <para><parameter>tex.math.delims</parameter>,
6616     <parameter>passivetex.extensions</parameter>,
6617     <parameter>tex.math.file</parameter></para>
6618 </refsection>
6619
6620 </refentry>
6621
6622 <refentry version="5.0" id="tex.math.file">
6623 <refmeta>
6624 <refentrytitle>tex.math.file</refentrytitle>
6625 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6626 </refmeta>
6627 <refnamediv>
6628 <refname>tex.math.file</refname>
6629 <refpurpose>Name of temporary file for generating images from equations</refpurpose>
6630 </refnamediv>
6631
6632 <refsynopsisdiv>
6633 <programlisting id="tex.math.file.frag">
6634 &lt;xsl:param name="tex.math.file"&gt;tex-math-equations.tex&lt;/xsl:param&gt;
6635 </programlisting>
6636 </refsynopsisdiv>
6637
6638 <refsection><info><title>Description</title></info>
6639
6640 <para>Name of auxiliary file for TeX equations. This file can be
6641 processed by dvi2bitmap to get bitmap versions of equations for HTML
6642 output.</para>
6643
6644 </refsection>
6645 <refsection><info><title>Related Parameters</title></info>
6646   <para><parameter>tex.math.in.alt</parameter>,
6647     <parameter>tex.math.delims</parameter>,
6648   </para>
6649 </refsection>
6650 <refsection><info><title>More information</title></info>
6651   <para>For how-to documentation on embedding TeX equations and
6652     generating output from them, see
6653     <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6654 </refsection>
6655 </refentry>
6656
6657 <refentry version="5.0" id="tex.math.delims">
6658 <refmeta>
6659 <refentrytitle>tex.math.delims</refentrytitle>
6660 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6661 </refmeta>
6662 <refnamediv>
6663 <refname>tex.math.delims</refname>
6664 <refpurpose>Should equations output for processing by TeX be
6665 surrounded by math mode delimiters?</refpurpose>
6666 </refnamediv> 
6667
6668 <refsynopsisdiv>
6669 <programlisting id="tex.math.delims.frag">
6670 &lt;xsl:param name="tex.math.delims" select="1"&gt;&lt;/xsl:param&gt;
6671 </programlisting>
6672 </refsynopsisdiv>
6673
6674 <refsection><info><title>Description</title></info>
6675
6676 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
6677 you should set this parameter to 0.</para>
6678
6679 <warning>
6680   <para>This feature is useful for print/PDF output only if you
6681   use the obsolete and now unsupported PassiveTeX XSL-FO
6682   engine.</para>
6683 </warning>
6684
6685 </refsection>
6686 <refsection><info><title>Related Parameters</title></info>
6687   <para><parameter>tex.math.in.alt</parameter>,
6688     <parameter>passivetex.extensions</parameter></para>
6689 </refsection>
6690
6691 <refsection><info><title>See Also</title></info>
6692   <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
6693     instruction to control whether delimiters are output.</para>
6694 </refsection>
6695
6696
6697 </refentry>
6698
6699 <refentry version="5.0" id="pixels.per.inch">
6700 <refmeta>
6701 <refentrytitle>pixels.per.inch</refentrytitle>
6702 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
6703 </refmeta>
6704 <refnamediv>
6705 <refname>pixels.per.inch</refname>
6706 <refpurpose>How many pixels are there per inch?</refpurpose>
6707 </refnamediv>
6708
6709 <refsynopsisdiv>
6710 <programlisting id="pixels.per.inch.frag">
6711 &lt;xsl:param name="pixels.per.inch"&gt;90&lt;/xsl:param&gt;
6712 </programlisting>
6713 </refsynopsisdiv>
6714
6715 <refsection><info><title>Description</title></info>
6716
6717 <para>When lengths are converted to pixels, this value is used to
6718 determine the size of a pixel. The default value is taken from the
6719 <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
6720 Recommendation</link>.
6721 </para>
6722
6723 </refsection>
6724 </refentry>
6725
6726 <refentry version="5.0" id="points.per.em">
6727 <refmeta>
6728 <refentrytitle>points.per.em</refentrytitle>
6729 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
6730 </refmeta>
6731 <refnamediv>
6732 <refname>points.per.em</refname>
6733 <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
6734 </refnamediv>
6735
6736 <refsynopsisdiv>
6737 <programlisting id="points.per.em.frag">
6738 &lt;xsl:param name="points.per.em"&gt;10&lt;/xsl:param&gt;
6739 </programlisting>
6740 </refsynopsisdiv>
6741
6742 <refsection><info><title>Description</title></info>
6743
6744 <para>The fixed value used for calculations based upon the size of a
6745 character. The assumption made is that ten point font is in use. This
6746 assumption may not be valid.</para>
6747
6748 </refsection>
6749 </refentry>
6750
6751 <refentry version="5.0" id="use.svg">
6752 <refmeta>
6753 <refentrytitle>use.svg</refentrytitle>
6754 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6755 </refmeta>
6756 <refnamediv>
6757 <refname>use.svg</refname>
6758 <refpurpose>Allow SVG in the result tree?</refpurpose>
6759 </refnamediv>
6760
6761 <refsynopsisdiv>
6762 <programlisting id="use.svg.frag">
6763 &lt;xsl:param name="use.svg" select="1"&gt;&lt;/xsl:param&gt;
6764 </programlisting>
6765 </refsynopsisdiv>
6766
6767 <refsection><info><title>Description</title></info>
6768
6769 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6770 is passed through to the result tree, so correct rendering of the resulting
6771 diagram depends on the formatter (FO processor or web browser) that is used
6772 to process the output from the stylesheet.</para>
6773
6774 </refsection>
6775 </refentry>
6776
6777 <refentry version="5.0" id="menuchoice.separator">
6778 <refmeta>
6779 <refentrytitle>menuchoice.separator</refentrytitle>
6780 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6781 </refmeta>
6782 <refnamediv>
6783 <refname>menuchoice.separator</refname>
6784 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6785 other than <tag>guimenuitem</tag> and
6786 <tag>guisubmenu</tag></refpurpose>
6787 </refnamediv>
6788
6789 <refsynopsisdiv>
6790 <programlisting id="menuchoice.separator.frag">
6791 &lt;xsl:param name="menuchoice.separator"&gt;+&lt;/xsl:param&gt;
6792 </programlisting>
6793 </refsynopsisdiv>
6794
6795 <refsection><info><title>Description</title></info>
6796
6797 <para>Separator used to connect items of a <tag>menuchoice</tag> other
6798 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
6799 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
6800 </para>
6801
6802 </refsection>
6803 </refentry>
6804
6805 <refentry version="5.0" id="menuchoice.menu.separator">
6806 <refmeta>
6807 <refentrytitle>menuchoice.menu.separator</refentrytitle>
6808 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6809 </refmeta>
6810 <refnamediv>
6811 <refname>menuchoice.menu.separator</refname>
6812 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6813 with <tag>guimenuitem</tag> or
6814 <tag>guisubmenu</tag></refpurpose>
6815 </refnamediv>
6816
6817 <refsynopsisdiv>
6818 <programlisting id="menuchoice.menu.separator.frag">
6819 &lt;xsl:param name="menuchoice.menu.separator"&gt; &#8594; &lt;/xsl:param&gt;
6820 </programlisting>
6821 </refsynopsisdiv>
6822
6823 <refsection><info><title>Description</title></info>
6824
6825 <para>Separator used to connect items of a <tag>menuchoice</tag> with
6826 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
6827 are linked with <parameter>menuchoice.separator</parameter>.
6828 </para>
6829 <para>The default value is &amp;#x2192;, which is the
6830 &amp;rarr; (right arrow) character entity.  
6831 The current FOP (0.20.5) requires setting the font-family
6832 explicitly.
6833 </para>
6834 <para>The default value also includes spaces around the arrow,
6835 which will allow a line to break.  Replace the spaces with
6836 &amp;#xA0; (nonbreaking space) if you don't want those
6837 spaces to break.
6838 </para>
6839
6840 </refsection>
6841 </refentry>
6842
6843 <refentry version="5.0" id="default.float.class">
6844 <refmeta>
6845 <refentrytitle>default.float.class</refentrytitle>
6846 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6847 </refmeta>
6848 <refnamediv>
6849 <refname>default.float.class</refname>
6850 <refpurpose>Specifies the default float class</refpurpose>
6851 </refnamediv>
6852
6853 <refsynopsisdiv>
6854 <programlisting id="default.float.class.frag">
6855 &lt;xsl:param name="default.float.class"&gt;
6856   &lt;xsl:choose&gt;
6857     &lt;xsl:when test="contains($stylesheet.result.type,'html')"&gt;left&lt;/xsl:when&gt;
6858     &lt;xsl:otherwise&gt;before&lt;/xsl:otherwise&gt;
6859   &lt;/xsl:choose&gt;
6860 &lt;/xsl:param&gt;
6861 </programlisting>
6862 </refsynopsisdiv>
6863
6864 <refsection><info><title>Description</title></info>
6865
6866 <para>Selects the direction in which a float should be placed. for
6867 xsl-fo this is before, for html it is left. For Western texts, the
6868 before direction is the top of the page.</para>
6869
6870 </refsection>
6871 </refentry>
6872
6873 <refentry version="5.0" id="footnote.number.format">
6874 <refmeta>
6875 <refentrytitle>footnote.number.format</refentrytitle>
6876 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
6877 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6878 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6879 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6880 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6881 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6882 </refmeta>
6883 <refnamediv>
6884 <refname>footnote.number.format</refname>
6885 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
6886 </refnamediv>
6887
6888 <refsynopsisdiv>
6889 <programlisting id="footnote.number.format.frag">
6890 &lt;xsl:param name="footnote.number.format"&gt;1&lt;/xsl:param&gt;
6891 </programlisting>
6892 </refsynopsisdiv>
6893
6894 <refsection><info><title>Description</title></info>
6895
6896 <para>The <parameter>footnote.number.format</parameter> specifies the format
6897 to use for footnote numeration (1, i, I, a, or A).</para>
6898
6899 </refsection>
6900 </refentry>
6901
6902 <refentry version="5.0" id="table.footnote.number.format">
6903 <refmeta>
6904 <refentrytitle>table.footnote.number.format</refentrytitle>
6905 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
6906 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6907 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6908 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6909 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6910 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6911 </refmeta>
6912 <refnamediv>
6913 <refname>table.footnote.number.format</refname>
6914 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
6915 </refnamediv>
6916
6917 <refsynopsisdiv>
6918 <programlisting id="table.footnote.number.format.frag">
6919 &lt;xsl:param name="table.footnote.number.format"&gt;a&lt;/xsl:param&gt;
6920 </programlisting>
6921 </refsynopsisdiv>
6922
6923 <refsection><info><title>Description</title></info>
6924
6925 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
6926 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
6927
6928 </refsection>
6929 </refentry>
6930
6931 <refentry version="5.0" id="footnote.number.symbols">
6932 <refmeta>
6933 <refentrytitle>footnote.number.symbols</refentrytitle>
6934 <refmiscinfo class="other" otherclass="datatype"/>
6935 </refmeta>
6936 <refnamediv>
6937 <refname>footnote.number.symbols</refname>
6938 <refpurpose>Special characters to use as footnote markers</refpurpose>
6939 </refnamediv>
6940
6941 <refsynopsisdiv>
6942 <programlisting id="footnote.number.symbols.frag">
6943 &lt;xsl:param name="footnote.number.symbols"&gt;&lt;/xsl:param&gt;
6944 </programlisting>
6945 </refsynopsisdiv>
6946
6947 <refsection><info><title>Description</title></info>
6948
6949 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
6950 footnotes will use the characters it contains as footnote symbols. For example,
6951 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
6952 footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
6953 <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
6954 than symbols, the stylesheets will fall back to numbered footnotes using
6955 <parameter>footnote.number.format</parameter>.</para>
6956
6957 <para>The use of symbols for footnotes depends on the ability of your
6958 processor (or browser) to render the symbols you select. Not all systems are
6959 capable of displaying the full range of Unicode characters. If the quoted characters
6960 in the preceding paragraph are not displayed properly, that's a good indicator
6961 that you may have trouble using those symbols for footnotes.</para>
6962
6963 </refsection>
6964 </refentry>
6965
6966 <refentry version="5.0" id="table.footnote.number.symbols">
6967 <refmeta>
6968 <refentrytitle>table.footnote.number.symbols</refentrytitle>
6969 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6970 </refmeta>
6971 <refnamediv>
6972 <refname>table.footnote.number.symbols</refname>
6973 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
6974 </refnamediv>
6975
6976 <refsynopsisdiv>
6977 <programlisting id="table.footnote.number.symbols.frag">
6978 &lt;xsl:param name="table.footnote.number.symbols"&gt;&lt;/xsl:param&gt;
6979 </programlisting>
6980 </refsynopsisdiv>
6981
6982 <refsection><info><title>Description</title></info>
6983
6984 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
6985 table footnotes will use the characters it contains as footnote symbols. For example,
6986 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
6987 footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
6988 <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
6989 than symbols, the stylesheets will fall back to numbered footnotes using
6990 <parameter>table.footnote.number.format</parameter>.</para>
6991
6992 <para>The use of symbols for footnotes depends on the ability of your
6993 processor (or browser) to render the symbols you select. Not all systems are
6994 capable of displaying the full range of Unicode characters. If the quoted characters
6995 in the preceding paragraph are not displayed properly, that's a good indicator
6996 that you may have trouble using those symbols for footnotes.</para>
6997
6998 </refsection>
6999 </refentry>
7000
7001 <refentry version="5.0" id="highlight.source">
7002 <refmeta>
7003 <refentrytitle>highlight.source</refentrytitle>
7004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7005 </refmeta>
7006 <refnamediv>
7007 <refname>highlight.source</refname>
7008 <refpurpose>Should the content of <tag>programlisting</tag>
7009 be syntactically highlighted?</refpurpose>
7010 </refnamediv>
7011
7012 <refsynopsisdiv>
7013 <programlisting id="highlight.source.frag">
7014 &lt;xsl:param name="highlight.source" select="0"&gt;&lt;/xsl:param&gt;
7015 </programlisting>
7016 </refsynopsisdiv>
7017
7018 <refsection><info><title>Description</title></info>
7019
7020 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the 
7021 content of <tag>programlisting</tag> elements. You specify the language for each programlisting 
7022 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter> 
7023 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag> 
7024 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
7025
7026 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be 
7027 downloaded separately (see below).</para>
7028
7029 <itemizedlist>
7030 <para>In order to use this extension, you must</para> 
7031
7032 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
7033 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link> 
7034 at SourceForge.</para>
7035 </listitem>
7036 <listitem>
7037 <para>use a customization layer in which you import one of the following stylesheet modules: 
7038 <itemizedlist>
7039   <listitem>
7040     <para><filename>html/highlight.xsl</filename>
7041     </para>
7042   </listitem>
7043 <listitem>
7044     <para><filename>xhtml/highlight.xsl</filename>
7045     </para>
7046   </listitem>
7047 <listitem>
7048     <para><filename>xhtml-1_1/highlight.xsl</filename>
7049     </para>
7050   </listitem>
7051 <listitem>
7052     <para><filename>fo/highlight.xsl</filename>
7053     </para>
7054 </listitem>
7055 </itemizedlist>
7056 </para>
7057 </listitem>
7058 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
7059 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax 
7060 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file, 
7061 <filename>highlighting/xslthl-config.xml</filename>.</para>
7062 </listitem>
7063 </itemizedlist>
7064
7065 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is 
7066 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
7067
7068 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
7069
7070 <informalexample>
7071 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar 
7072 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet 
7073 -o test.html test.xml myhtml.xsl</command></para>
7074 </informalexample>
7075
7076 </refsection>
7077 </refentry>
7078
7079 <refentry version="5.0" id="highlight.xslthl.config">
7080 <refmeta>
7081 <refentrytitle>highlight.xslthl.config</refentrytitle>
7082 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7083 </refmeta>
7084 <refnamediv>
7085 <refname>highlight.xslthl.config</refname>
7086 <refpurpose>Location of XSLTHL configuration file</refpurpose>
7087 </refnamediv>
7088
7089 <refsynopsisdiv>
7090 <programlisting id="highlight.xslthl.config.frag">
7091 &lt;xsl:param name="highlight.xslthl.config"&gt;&lt;/xsl:param&gt;
7092 </programlisting>
7093 </refsynopsisdiv>
7094
7095 <refsection><info><title>Description</title></info>
7096
7097 <para>This location has precedence over the corresponding Java property.</para>
7098
7099 <para>Please note that usually you have to specify location as URL not
7100 just as a simple path on the local
7101 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
7102
7103
7104
7105 </refsection>
7106 </refentry>
7107
7108 <refentry version="5.0" id="highlight.default.language">
7109 <refmeta>
7110 <refentrytitle>highlight.default.language</refentrytitle>
7111 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7112 </refmeta>
7113 <refnamediv>
7114 <refname>highlight.default.language</refname>
7115 <refpurpose>Default language of programlisting</refpurpose>
7116 </refnamediv>
7117
7118 <refsynopsisdiv>
7119 <programlisting id="highlight.default.language.frag">
7120 &lt;xsl:param name="highlight.default.language"&gt;&lt;/xsl:param&gt;
7121 </programlisting>
7122 </refsynopsisdiv>
7123
7124 <refsection><info><title>Description</title></info>
7125
7126 <para>This language is used when there is no language attribute on programlisting.</para>
7127
7128 </refsection>
7129 </refentry>
7130
7131 <refentry version="5.0" id="email.delimiters.enabled">
7132 <refmeta>
7133 <refentrytitle>email.delimiters.enabled</refentrytitle>
7134 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7135 </refmeta>
7136 <refnamediv>
7137 <refname>email.delimiters.enabled</refname>
7138 <refpurpose>Generate delimiters around email addresses?</refpurpose>
7139 </refnamediv>
7140
7141 <refsynopsisdiv>
7142 <programlisting id="email.delimiters.enabled.frag">
7143 &lt;xsl:param name="email.delimiters.enabled" select="1"&gt;&lt;/xsl:param&gt;
7144 </programlisting>
7145 </refsynopsisdiv>
7146
7147 <refsection><info><title>Description</title></info>
7148
7149 <para>If non-zero, delimiters
7150
7151 <footnote><para>For delimiters, the
7152 stylesheets are currently hard-coded to output angle
7153 brackets.</para></footnote> 
7154
7155 are generated around e-mail addresses
7156 (the output of the <tag>email</tag> element).</para>
7157
7158 </refsection>
7159 </refentry>
7160
7161 <refentry version="5.0" id="exsl.node.set.available">
7162 <refmeta>
7163 <refentrytitle>exsl.node.set.available</refentrytitle>
7164 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7165 </refmeta>
7166 <refnamediv>
7167 <refname>exsl.node.set.available</refname>
7168 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
7169 </refnamediv>
7170
7171 <refsynopsisdiv>
7172 <programlisting id="exsl.node.set.available.frag">&lt;xsl:param name="exsl.node.set.available"&gt; 
7173   &lt;xsl:choose&gt;
7174     &lt;xsl:when exsl:foo="" test="function-available('exsl:node-set') or                        contains(system-property('xsl:vendor'),                          'Apache Software Foundation')"&gt;1&lt;/xsl:when&gt;
7175     &lt;xsl:otherwise&gt;0&lt;/xsl:otherwise&gt;
7176   &lt;/xsl:choose&gt;
7177 &lt;/xsl:param&gt;
7178 </programlisting>
7179 </refsynopsisdiv>
7180
7181 <refsection><info><title>Description</title></info>
7182
7183 <para>If non-zero,
7184 then the exsl:node-set() function is available to be used in
7185 the stylesheet.
7186 If zero, then the function is not available.
7187 This param automatically detects the presence of
7188 the function and does not normally need to be set manually.</para>
7189
7190 <para>This param was created to handle a long-standing
7191 bug in the Xalan processor that fails to detect the
7192 function even though it is available.</para>
7193
7194 </refsection>
7195 </refentry>
7196
7197 </reference><reference id="annos" xml:base="../html/param.xml"><title>Annotations</title>
7198 <refentry version="5.0" id="annotation.support">
7199 <refmeta>
7200 <refentrytitle>annotation.support</refentrytitle>
7201 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7202 </refmeta>
7203 <refnamediv>
7204 <refname>annotation.support</refname>
7205 <refpurpose>Enable annotations?</refpurpose>
7206 </refnamediv>
7207
7208 <refsynopsisdiv>
7209 <programlisting id="annotation.support.frag">
7210 &lt;xsl:param name="annotation.support" select="0"&gt;&lt;/xsl:param&gt;
7211 </programlisting>
7212 </refsynopsisdiv>
7213
7214 <refsection><info><title>Description</title></info>
7215
7216 <para>If non-zero, the stylesheets will attempt to support annotation
7217 elements in HTML by including some JavaScript (see
7218 <parameter>annotation.js</parameter>).</para>
7219
7220 </refsection>
7221 </refentry>
7222
7223 <refentry version="5.0" id="annotation.js">
7224 <refmeta>
7225 <refentrytitle>annotation.js</refentrytitle>
7226 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7227 </refmeta>
7228 <refnamediv>
7229 <refname>annotation.js</refname>
7230 <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
7231 </refnamediv>
7232
7233 <refsynopsisdiv>
7234 <programlisting id="annotation.js.frag">
7235
7236 &lt;xsl:param name="annotation.js"&gt;
7237 &lt;xsl:text&gt;http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js&lt;/xsl:text&gt;&lt;/xsl:param&gt;
7238
7239 </programlisting>
7240 </refsynopsisdiv>
7241
7242 <refsection><info><title>Description</title></info>
7243
7244 <para>If <property>annotation.support</property> is enabled and the
7245 document contains <tag>annotation</tag>s, then the URIs listed
7246 in this parameter will be included. These JavaScript files are required
7247 for popup annotation support.</para>
7248
7249 </refsection>
7250 </refentry>
7251
7252 <refentry version="5.0" id="annotation.css">
7253 <refmeta>
7254 <refentrytitle>annotation.css</refentrytitle>
7255 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7256 </refmeta>
7257 <refnamediv>
7258 <refname>annotation.css</refname>
7259 <refpurpose>CSS rules for annotations</refpurpose>
7260 </refnamediv>
7261
7262 <refsynopsisdiv>
7263 <programlisting id="annotation.css.frag">
7264 &lt;xsl:param name="annotation.css"&gt;
7265 /* ======================================================================
7266    Annotations
7267 */
7268
7269 div.annotation-list  { visibility: hidden;
7270                      }
7271
7272 div.annotation-nocss { position: absolute;
7273                        visibility: hidden;
7274                      }
7275
7276 div.annotation-popup { position: absolute;
7277                        z-index: 4;
7278                        visibility: hidden;
7279                        padding: 0px;
7280                        margin: 2px;
7281                        border-style: solid;
7282                        border-width: 1px;
7283                        width: 200px;
7284                        background-color: white;
7285                      }
7286
7287 div.annotation-title { padding: 1px;
7288                        font-weight: bold;
7289                        border-bottom-style: solid;
7290                        border-bottom-width: 1px;
7291                        color: white;
7292                        background-color: black;
7293                      }
7294
7295 div.annotation-body  { padding: 2px;
7296                      }
7297
7298 div.annotation-body p { margin-top: 0px;
7299                         padding-top: 0px;
7300                       }
7301
7302 div.annotation-close { position: absolute;
7303                        top: 2px;
7304                        right: 2px;
7305                      }
7306 &lt;/xsl:param&gt;
7307 </programlisting>
7308 </refsynopsisdiv>
7309
7310 <refsection><info><title>Description</title></info>
7311
7312 <para>If <parameter>annotation.support</parameter> is enabled and the
7313 document contains <tag>annotation</tag>s, then the CSS in this
7314 parameter will be included in the document.</para>
7315
7316 </refsection>
7317 </refentry>
7318
7319 <refentry version="5.0" id="annotation.graphic.open">
7320 <refmeta>
7321 <refentrytitle>annotation.graphic.open</refentrytitle>
7322 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7323 </refmeta>
7324 <refnamediv>
7325 <refname>annotation.graphic.open</refname>
7326 <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
7327 </refnamediv>
7328
7329 <refsynopsisdiv>
7330 <programlisting id="annotation.graphic.open.frag">
7331 &lt;xsl:param name="annotation.graphic.open"&gt;http://docbook.sourceforge.net/release/images/annot-open.png&lt;/xsl:param&gt;
7332 </programlisting>
7333 </refsynopsisdiv>
7334
7335 <refsection><info><title>Description</title></info>
7336
7337 <para>This image is used inline to identify the location of
7338 annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7339
7340 </refsection>
7341 </refentry>
7342
7343 <refentry version="5.0" id="annotation.graphic.close">
7344 <refmeta>
7345 <refentrytitle>annotation.graphic.close</refentrytitle>
7346 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7347 </refmeta>
7348 <refnamediv>
7349 <refname>annotation.graphic.close</refname>
7350 <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
7351 </refnamediv>
7352
7353 <refsynopsisdiv>
7354 <programlisting id="annotation.graphic.close.frag">
7355 &lt;xsl:param name="annotation.graphic.close"&gt;
7356 http://docbook.sourceforge.net/release/images/annot-close.png&lt;/xsl:param&gt;
7357 </programlisting>
7358 </refsynopsisdiv>
7359
7360 <refsection><info><title>Description</title></info>
7361
7362 <para>This image is used on popup annotations as the &#8220;x&#8221; that the
7363 user can click to dismiss the popup.</para>
7364 <para>This image is used on popup annotations as the &#8220;x&#8221; that the user can
7365 click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7366
7367 </refsection>
7368 </refentry>
7369
7370 </reference><reference id="graphics" xml:base="../html/param.xml"><title>Graphics</title>
7371 <refentry version="5.0" id="img.src.path">
7372 <refmeta>
7373 <refentrytitle>img.src.path</refentrytitle>
7374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7375 </refmeta>
7376 <refnamediv>
7377 <refname>img.src.path</refname>
7378 <refpurpose>Path to HTML/FO image files</refpurpose>
7379 </refnamediv>
7380
7381 <refsynopsisdiv>
7382 <programlisting id="img.src.path.frag">&lt;xsl:param name="img.src.path"&gt;&lt;/xsl:param&gt;</programlisting>
7383 </refsynopsisdiv>
7384
7385 <refsection><info><title>Description</title></info>
7386
7387 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag> 
7388 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting 
7389 compound path is used in the output as the value of the <tag class="attribute">src</tag> 
7390 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7391 </para>
7392
7393 <para>
7394 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7395 files are created, or it could be an absolute URI.
7396 The default value is empty.
7397 Be sure to include a trailing slash if needed.
7398 </para>
7399
7400 <para>This prefix is not applied to any filerefs that start
7401 with "/" or contain "//:".
7402 </para>
7403
7404 </refsection>
7405 </refentry>
7406
7407 <refentry version="5.0" id="keep.relative.image.uris">
7408 <refmeta>
7409 <refentrytitle>keep.relative.image.uris</refentrytitle>
7410 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7411 </refmeta>
7412 <refnamediv>
7413 <refname>keep.relative.image.uris</refname>
7414 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7415 </refnamediv>
7416
7417 <refsynopsisdiv>
7418 <programlisting id="keep.relative.image.uris.frag">
7419 &lt;xsl:param name="keep.relative.image.uris" select="1"&gt;&lt;/xsl:param&gt;
7420
7421 </programlisting>
7422 </refsynopsisdiv>
7423
7424 <refsection><info><title>Description</title></info>
7425
7426 <para>If non-zero, relative URIs (in, for example
7427 <literal>fileref</literal> attributes) will be used in the generated
7428 output. Otherwise, the URIs will be made absolute with respect to the
7429 base URI.</para>
7430
7431 <para>Note that the stylesheets calculate (and use) the absolute form
7432 for some purposes, this only applies to the resulting output.</para>
7433
7434 </refsection>
7435 </refentry>
7436
7437 <refentry version="5.0" id="graphic.default.extension">
7438 <refmeta>
7439 <refentrytitle>graphic.default.extension</refentrytitle>
7440 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7441 </refmeta>
7442 <refnamediv>
7443 <refname>graphic.default.extension</refname>
7444 <refpurpose>Default extension for graphic filenames</refpurpose>
7445 </refnamediv>
7446
7447 <refsynopsisdiv>
7448 <programlisting id="graphic.default.extension.frag">&lt;xsl:param name="graphic.default.extension"&gt;&lt;/xsl:param&gt;</programlisting>
7449 </refsynopsisdiv>
7450
7451 <refsection><info><title>Description</title></info>
7452
7453 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7454 includes a reference to a filename that does not include an extension,
7455 and the <tag class="attribute">format</tag> attribute is
7456 <emphasis>unspecified</emphasis>, the default extension will be used.
7457 </para>
7458
7459 </refsection>
7460 </refentry>
7461
7462 <refentry version="5.0" id="default.image.width">
7463 <refmeta>
7464 <refentrytitle>default.image.width</refentrytitle>
7465 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7466 </refmeta>
7467 <refnamediv>
7468 <refname>default.image.width</refname>
7469 <refpurpose>The default width of images</refpurpose>
7470 </refnamediv>
7471
7472 <refsynopsisdiv>
7473 <programlisting id="default.image.width.frag">
7474 &lt;xsl:param name="default.image.width"&gt;&lt;/xsl:param&gt;
7475 </programlisting>
7476 </refsynopsisdiv>
7477
7478 <refsection><info><title>Description</title></info>
7479
7480 <para>If specified, this value will be used for the
7481 <tag class="attribute">width</tag> attribute on images that do not specify any 
7482 <emphasis xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
7483
7484 </refsection>
7485 </refentry>
7486
7487 <refentry version="5.0" id="nominal.image.width">
7488 <refmeta>
7489 <refentrytitle>nominal.image.width</refentrytitle>
7490 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7491 </refmeta>
7492 <refnamediv>
7493 <refname>nominal.image.width</refname>
7494 <refpurpose>The nominal image width</refpurpose>
7495 </refnamediv>
7496
7497 <refsynopsisdiv>
7498 <programlisting id="nominal.image.width.frag">
7499 &lt;xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"&gt;&lt;/xsl:param&gt;
7500 </programlisting>
7501 </refsynopsisdiv>
7502
7503 <refsection><info><title>Description</title></info>
7504
7505 <para>Graphic widths expressed as a percentage are problematic. In the
7506 following discussion, we speak of width and contentwidth, but
7507 the same issues apply to depth and contentdepth.</para>
7508
7509 <para>A width of 50% means "half of the available space for the image."
7510 That's fine. But note that in HTML, this is a dynamic property and
7511 the image size will vary if the browser window is resized.</para>
7512
7513 <para>A contentwidth of 50% means "half of the actual image width".
7514 But what does that mean if the stylesheets cannot assess the image's
7515 actual size? Treating this as a width of 50% is one possibility, but
7516 it produces behavior (dynamic scaling) that seems entirely out of
7517 character with the meaning.</para>
7518
7519 <para>Instead, the stylesheets define a
7520 <parameter>nominal.image.width</parameter> and convert percentages to
7521 actual values based on that nominal size.</para>
7522
7523 </refsection>
7524 </refentry>
7525
7526 <refentry version="5.0" id="nominal.image.depth">
7527 <refmeta>
7528 <refentrytitle>nominal.image.depth</refentrytitle>
7529 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7530 </refmeta>
7531 <refnamediv>
7532 <refname>nominal.image.depth</refname>
7533 <refpurpose>Nominal image depth</refpurpose>
7534 </refnamediv>
7535
7536 <refsynopsisdiv>
7537 <programlisting id="nominal.image.depth.frag">
7538 &lt;xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"&gt;&lt;/xsl:param&gt;
7539 </programlisting>
7540 </refsynopsisdiv>
7541
7542 <refsection><info><title>Description</title></info>
7543
7544 <para>See <parameter>nominal.image.width</parameter>.</para>
7545
7546 </refsection>
7547 </refentry>
7548
7549 <refentry version="5.0" id="use.embed.for.svg">
7550 <refmeta>
7551 <refentrytitle>use.embed.for.svg</refentrytitle>
7552 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7553 </refmeta>
7554 <refnamediv>
7555 <refname>use.embed.for.svg</refname>
7556 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
7557 </refnamediv>
7558
7559 <refsynopsisdiv>
7560 <programlisting id="use.embed.for.svg.frag">
7561 &lt;xsl:param name="use.embed.for.svg" select="0"&gt;&lt;/xsl:param&gt;
7562 </programlisting>
7563 </refsynopsisdiv>
7564
7565 <refsection><info><title>Description</title></info>
7566
7567 <para>If non-zero, an <tag>embed</tag> element will be created for
7568 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
7569 this parameter merely controls whether or not an additional <tag>embed</tag>
7570 is generated inside the <tag>object</tag>.</para>
7571
7572 <para>On the plus side, this may be more portable among browsers and plug-ins.
7573 On the minus side, it isn't valid HTML.</para>
7574
7575 </refsection>
7576 </refentry>
7577
7578 <refentry version="5.0" id="make.graphic.viewport">
7579 <refmeta>
7580 <refentrytitle>make.graphic.viewport</refentrytitle>
7581 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7582 </refmeta>
7583 <refnamediv>
7584 <refname>make.graphic.viewport</refname>
7585 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
7586 </refnamediv>
7587
7588 <refsynopsisdiv>
7589 <programlisting id="make.graphic.viewport.frag">
7590 &lt;xsl:param name="make.graphic.viewport" select="1"&gt;&lt;/xsl:param&gt;
7591 </programlisting>
7592 </refsynopsisdiv>
7593
7594 <refsection><info><title>Description</title></info>
7595
7596 <para>The HTML <tag>img</tag> element only supports the notion
7597 of content-area scaling; it doesn't support the distinction between a
7598 content-area and a viewport-area, so we have to make some compromises.</para>
7599
7600 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
7601 will be used to frame the image. This creates an effective viewport-area.
7602 </para>
7603
7604 <para>Tables and alignment don't work together, so this parameter is ignored
7605 if alignment is specified on an image.</para>
7606 </refsection>
7607 </refentry>
7608
7609 <refentry version="5.0" id="preferred.mediaobject.role">
7610 <refmeta>
7611 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7612 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7613 </refmeta>
7614 <refnamediv>
7615 <refname>preferred.mediaobject.role</refname>
7616 <refpurpose>Select which mediaobject to use based on
7617 this value of an object's <tag class="attribute">role</tag> attribute.
7618 </refpurpose>
7619 </refnamediv>
7620
7621 <refsynopsisdiv>
7622 <programlisting id="preferred.mediaobject.role.frag">
7623 &lt;xsl:param name="preferred.mediaobject.role"&gt;&lt;/xsl:param&gt;
7624 </programlisting>
7625 </refsynopsisdiv>
7626
7627 <refsection><info><title>Description</title></info>
7628
7629 <para>A mediaobject may contain several objects such as imageobjects.
7630 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7631 non-zero, then the <literal>role</literal> attribute on
7632 <tag>imageobject</tag>s and other objects within a
7633 <tag>mediaobject</tag> container will be used to select which object
7634 will be used.  If one of the objects has a role value that matches the
7635 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7636 has first priority for selection.  If more than one has such a role
7637 value, the first one is used.
7638 </para>
7639 <para>
7640 See the <parameter>use.role.for.mediaobject</parameter> parameter
7641 for the sequence of selection.</para>
7642 </refsection>
7643 </refentry>
7644
7645 <refentry version="5.0" id="use.role.for.mediaobject">
7646 <refmeta>
7647 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7648 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7649 </refmeta>
7650 <refnamediv>
7651 <refname>use.role.for.mediaobject</refname>
7652 <refpurpose>Use <tag class="attribute">role</tag> attribute 
7653 value for selecting which of several objects within a mediaobject to use.
7654 </refpurpose>
7655 </refnamediv>
7656
7657 <refsynopsisdiv>
7658 <programlisting id="use.role.for.mediaobject.frag">
7659 &lt;xsl:param name="use.role.for.mediaobject" select="1"&gt;&lt;/xsl:param&gt;
7660 </programlisting>
7661 </refsynopsisdiv>
7662
7663 <refsection><info><title>Description</title></info>
7664
7665 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7666 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7667 used.
7668 </para>
7669 <para>
7670 The order of selection when then parameter is non-zero is:
7671 </para>
7672 <orderedlist>
7673 <listitem>
7674     <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7675 </listitem>
7676 <listitem>
7677 <para>Else if an object's role attribute has a value of
7678 <literal>html</literal> for HTML processing or
7679 <literal>fo</literal> for FO output, then the first
7680 of such objects is selected.
7681 </para>
7682 </listitem>
7683 <listitem>
7684 <para>Else the first suitable object is selected.</para>
7685 </listitem>
7686 </orderedlist>
7687 <para>
7688 If the value of 
7689 <parameter>use.role.for.mediaobject</parameter>
7690 is zero, then role attributes are not considered
7691 and the first suitable object
7692 with or without a role value is used.
7693 </para>
7694 </refsection>
7695 </refentry>
7696
7697 <refentry version="5.0" id="ignore.image.scaling">
7698 <refmeta>
7699 <refentrytitle>ignore.image.scaling</refentrytitle>
7700 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7701 </refmeta>
7702 <refnamediv>
7703 <refname>ignore.image.scaling</refname>
7704 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7705 </refnamediv>
7706
7707 <refsynopsisdiv>
7708 <programlisting id="ignore.image.scaling.frag">
7709 &lt;xsl:param name="ignore.image.scaling" select="0"&gt;&lt;/xsl:param&gt;
7710 </programlisting>
7711 </refsynopsisdiv>
7712
7713 <refsection><info><title>Description</title></info>
7714
7715 <para>If non-zero, the scaling attributes on graphics and media objects are
7716 ignored.</para>
7717
7718 </refsection>
7719 </refentry>
7720
7721 </reference><reference id="chunking" xml:base="../html/param.xml"><title>Chunking</title>
7722 <refentry version="5.0" id="chunker.output.cdata-section-elements">
7723 <refmeta>
7724 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
7725 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7726 </refmeta>
7727 <refnamediv>
7728 <refname>chunker.output.cdata-section-elements</refname>
7729 <refpurpose>List of elements to escape with CDATA sections</refpurpose>
7730 </refnamediv>
7731 <refsynopsisdiv>
7732 <programlisting id="chunker.output.cdata-section-elements.frag">
7733 &lt;xsl:param name="chunker.output.cdata-section-elements"&gt;&lt;/xsl:param&gt;
7734 </programlisting>
7735 </refsynopsisdiv>
7736 <refsection><info><title>Description</title></info>
7737 <para>This parameter specifies the list of elements that should be escaped
7738 as CDATA sections by the chunking stylesheet.  Not all processors support
7739 specification of this parameter.
7740 </para>
7741 <note>
7742 <para>This parameter is documented here, but the declaration is actually
7743 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7744 </note>
7745 </refsection>
7746 </refentry>
7747
7748 <refentry version="5.0" id="chunker.output.doctype-public">
7749 <refmeta>
7750 <refentrytitle>chunker.output.doctype-public</refentrytitle>
7751 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7752 </refmeta>
7753 <refnamediv>
7754 <refname>chunker.output.doctype-public</refname>
7755 <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
7756 </refnamediv>
7757 <refsynopsisdiv>
7758 <programlisting id="chunker.output.doctype-public.frag">
7759 &lt;xsl:param name="chunker.output.doctype-public"&gt;&lt;/xsl:param&gt;
7760 </programlisting>
7761 </refsynopsisdiv>
7762 <refsection><info><title>Description</title></info>
7763 <para>This parameter specifies the public identifier that should be used by
7764 the chunking stylesheet in the document type declaration of chunked pages.
7765 Not all processors support specification of
7766 this parameter.
7767 </para>
7768 <note>
7769 <para>This parameter is documented here, but the declaration is actually
7770 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7771 </note>
7772 </refsection>
7773 </refentry>
7774
7775 <refentry version="5.0" id="chunker.output.doctype-system">
7776 <refmeta>
7777 <refentrytitle>chunker.output.doctype-system</refentrytitle>
7778 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7779 </refmeta>
7780 <refnamediv>
7781 <refname>chunker.output.doctype-system</refname>
7782 <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
7783 </refnamediv>
7784 <refsynopsisdiv>
7785 <programlisting id="chunker.output.doctype-system.frag">
7786 &lt;xsl:param name="chunker.output.doctype-system"&gt;&lt;/xsl:param&gt;
7787 </programlisting>
7788 </refsynopsisdiv>
7789 <refsection><info><title>Description</title></info>
7790 <para>This parameter specifies the system identifier that should be used by
7791 the chunking stylesheet in the document type declaration of chunked pages.
7792 Not all processors support specification of
7793 this parameter.
7794 </para>
7795 <note>
7796 <para>This parameter is documented here, but the declaration is actually
7797 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7798 </note>
7799 </refsection>
7800 </refentry>
7801
7802 <refentry version="5.0" id="chunker.output.encoding">
7803 <refmeta>
7804 <refentrytitle>chunker.output.encoding</refentrytitle>
7805 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7806 </refmeta>
7807 <refnamediv>
7808 <refname>chunker.output.encoding</refname>
7809 <refpurpose>Encoding used in generated pages</refpurpose>
7810 </refnamediv>
7811 <refsynopsisdiv>
7812 <programlisting id="chunker.output.encoding.frag">
7813 &lt;xsl:param name="chunker.output.encoding"&gt;ISO-8859-1&lt;/xsl:param&gt;
7814 </programlisting>
7815 </refsynopsisdiv>
7816 <refsection><info><title>Description</title></info>
7817 <para>This parameter specifies the encoding to be used in files
7818 generated by the chunking stylesheet. Not all processors support
7819 specification of this parameter.
7820 </para>
7821 <para>This parameter used to be named <literal>default.encoding</literal>.</para>
7822 <note>
7823 <para>This parameter is documented here, but the declaration is actually
7824 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7825 </note>
7826 </refsection>
7827 </refentry>
7828
7829 <refentry version="5.0" id="chunker.output.indent">
7830 <refmeta>
7831 <refentrytitle>chunker.output.indent</refentrytitle>
7832 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7833 </refmeta>
7834 <refnamediv>
7835 <refname>chunker.output.indent</refname>
7836 <refpurpose>Specification of indentation on generated pages</refpurpose>
7837 </refnamediv>
7838 <refsynopsisdiv>
7839 <programlisting id="chunker.output.indent.frag">
7840 &lt;xsl:param name="chunker.output.indent"&gt;no&lt;/xsl:param&gt;
7841 </programlisting>
7842 </refsynopsisdiv>
7843 <refsection><info><title>Description</title></info>
7844 <para>This parameter specifies the value of the indent
7845 specification for generated pages. Not all processors support
7846 specification of this parameter.
7847 </para>
7848 <note>
7849 <para>This parameter is documented here, but the declaration is actually
7850 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7851 </note>
7852 </refsection>
7853 </refentry>
7854
7855 <refentry version="5.0" id="chunker.output.media-type">
7856 <refmeta>
7857 <refentrytitle>chunker.output.media-type</refentrytitle>
7858 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7859 </refmeta>
7860 <refnamediv>
7861 <refname>chunker.output.media-type</refname>
7862 <refpurpose>Media type to use in generated pages</refpurpose>
7863 </refnamediv>
7864 <refsynopsisdiv>
7865 <programlisting id="chunker.output.media-type.frag">
7866 &lt;xsl:param name="chunker.output.media-type"&gt;&lt;/xsl:param&gt;
7867 </programlisting>
7868 </refsynopsisdiv>
7869 <refsection><info><title>Description</title></info>
7870 <para>This parameter specifies the media type that should be used by
7871 the chunking stylesheet. Not all processors support specification of
7872 this parameter.
7873 </para>
7874 <para>This parameter specifies the media type that should be used by the
7875 chunking stylesheet. This should be one from those defined in
7876 <link xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link>  and
7877  <link xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
7878 <note>
7879 <para>This parameter is documented here, but the declaration is actually
7880 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7881 <para>It must be one from html, xml or text</para>
7882 </note>
7883 </refsection>
7884 </refentry>
7885
7886 <refentry version="5.0" id="chunker.output.method">
7887 <refmeta>
7888 <refentrytitle>chunker.output.method</refentrytitle>
7889 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7890 <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
7891 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
7892 </refmeta>
7893 <refnamediv>
7894 <refname>chunker.output.method</refname>
7895 <refpurpose>Method used in generated pages</refpurpose>
7896 </refnamediv>
7897 <refsynopsisdiv>
7898 <programlisting id="chunker.output.method.frag">
7899 &lt;xsl:param name="chunker.output.method"&gt;html&lt;/xsl:param&gt;
7900 </programlisting>
7901 </refsynopsisdiv>
7902 <refsection><info><title>Description</title></info>
7903 <para>This parameter specifies the output method to be used in files
7904 generated by the chunking stylesheet.
7905 </para>
7906 <para>This parameter used to be named <literal>output.method</literal>.</para>
7907 <note>
7908 <para>This parameter is documented here, but the declaration is actually
7909 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7910 </note>
7911 </refsection>
7912 </refentry>
7913
7914 <refentry version="5.0" id="chunker.output.omit-xml-declaration">
7915 <refmeta>
7916 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
7917 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7918 </refmeta>
7919 <refnamediv>
7920 <refname>chunker.output.omit-xml-declaration</refname>
7921 <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
7922 </refnamediv>
7923 <refsynopsisdiv>
7924 <programlisting id="chunker.output.omit-xml-declaration.frag">
7925 &lt;xsl:param name="chunker.output.omit-xml-declaration"&gt;no&lt;/xsl:param&gt;
7926 </programlisting>
7927 </refsynopsisdiv>
7928 <refsection><info><title>Description</title></info>
7929 <para>This parameter specifies the value of the omit-xml-declaration
7930 specification for generated pages. Not all processors support
7931 specification of this parameter.
7932 </para>
7933 <note>
7934 <para>This parameter is documented here, but the declaration is actually
7935 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7936 </note>
7937 </refsection>
7938 </refentry>
7939
7940 <refentry version="5.0" id="chunker.output.standalone">
7941 <refmeta>
7942 <refentrytitle>chunker.output.standalone</refentrytitle>
7943 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7944 </refmeta>
7945 <refnamediv>
7946 <refname>chunker.output.standalone</refname>
7947 <refpurpose>Standalone declaration for generated pages</refpurpose>
7948 </refnamediv>
7949 <refsynopsisdiv>
7950 <programlisting id="chunker.output.standalone.frag">
7951 &lt;xsl:param name="chunker.output.standalone"&gt;no&lt;/xsl:param&gt;
7952 </programlisting>
7953 </refsynopsisdiv>
7954 <refsection><info><title>Description</title></info>
7955 <para>This parameter specifies the value of the standalone
7956   specification for generated pages. It must be either
7957   <literal>yes</literal> or <literal>no</literal>. Not all
7958   processors support specification of this parameter.
7959 </para>
7960 <note>
7961 <para>This parameter is documented here, but the declaration is actually
7962 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7963 </note>
7964 </refsection>
7965 </refentry>
7966
7967 <refentry version="5.0" id="saxon.character.representation">
7968 <refmeta>
7969 <refentrytitle>saxon.character.representation</refentrytitle>
7970 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7971 </refmeta>
7972 <refnamediv>
7973 <refname>saxon.character.representation</refname>
7974 <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
7975 </refnamediv>
7976
7977 <refsynopsisdiv>
7978   <programlisting id="saxon.character.representation.frag">&lt;xsl:param name="saxon.character.representation" select="'entity;decimal'"&gt;&lt;/xsl:param&gt;</programlisting>
7979 </refsynopsisdiv>
7980
7981 <refsection><info><title>Description</title></info>
7982
7983 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later). 
7984 It sets the character representation in files generated by the chunking stylesheets. 
7985 If you want to suppress entity references for characters with direct representations in 
7986 <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>. 
7987 </para>
7988
7989 <para> For more information, see <link role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
7990
7991 <note>
7992 <para>This parameter is documented here, but the declaration is actually
7993 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7994 </note>
7995
7996 </refsection>
7997
7998 </refentry>
7999
8000 <refentry version="5.0" id="html.ext">
8001 <refmeta>
8002 <refentrytitle>html.ext</refentrytitle>
8003 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8004 </refmeta>
8005 <refnamediv>
8006 <refname>html.ext</refname>
8007 <refpurpose>Identifies the extension of generated HTML files</refpurpose>
8008 </refnamediv>
8009
8010 <refsynopsisdiv>
8011 <programlisting id="html.ext.frag">
8012 &lt;xsl:param name="html.ext"&gt;.html&lt;/xsl:param&gt;
8013 </programlisting>
8014 </refsynopsisdiv>
8015
8016 <refsection><info><title>Description</title></info>
8017
8018 <para>The extension identified by <parameter>html.ext</parameter> will
8019 be used as the filename extension for chunks created by this
8020 stylesheet. </para>
8021
8022 </refsection>
8023 </refentry>
8024
8025 <refentry version="5.0" id="use.id.as.filename">
8026 <refmeta>
8027 <refentrytitle>use.id.as.filename</refentrytitle>
8028 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8029 </refmeta>
8030 <refnamediv>
8031 <refname>use.id.as.filename</refname>
8032 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
8033 </refnamediv>
8034
8035 <refsynopsisdiv>
8036 <programlisting id="use.id.as.filename.frag">
8037 &lt;xsl:param name="use.id.as.filename" select="0"&gt;&lt;/xsl:param&gt;
8038 </programlisting>
8039 </refsynopsisdiv>
8040
8041 <refsection><info><title>Description</title></info>
8042
8043 <para>If <parameter>use.id.as.filename</parameter>
8044 is non-zero, the filename of chunk elements that have IDs will be
8045 derived from the ID value.
8046 </para>
8047
8048 </refsection>
8049 </refentry>
8050
8051 <refentry version="5.0" id="html.extra.head.links">
8052 <refmeta>
8053 <refentrytitle>html.extra.head.links</refentrytitle>
8054 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8055 </refmeta>
8056 <refnamediv>
8057 <refname>html.extra.head.links</refname>
8058 <refpurpose>Toggle extra HTML head link information</refpurpose>
8059 </refnamediv>
8060
8061 <refsynopsisdiv>
8062 <programlisting id="html.extra.head.links.frag">
8063 &lt;xsl:param name="html.extra.head.links" select="0"&gt;&lt;/xsl:param&gt;
8064 </programlisting>
8065 </refsynopsisdiv>
8066
8067 <refsection><info><title>Description</title></info>
8068
8069 <para>If non-zero, extra <tag>link</tag> elements will be
8070 generated in the <tag>head</tag> of chunked HTML files. These
8071 extra links point to chapters, appendixes, sections, etc. as supported
8072 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
8073 </para>
8074
8075 </refsection>
8076 </refentry>
8077
8078 <refentry version="5.0" id="root.filename">
8079 <refmeta>
8080 <refentrytitle>root.filename</refentrytitle>
8081 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8082 </refmeta>
8083 <refnamediv>
8084 <refname>root.filename</refname>
8085 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
8086 </refnamediv>
8087
8088 <refsynopsisdiv>
8089 <programlisting id="root.filename.frag">
8090 &lt;xsl:param name="root.filename"&gt;index&lt;/xsl:param&gt;
8091 </programlisting>
8092 </refsynopsisdiv>
8093
8094 <refsection><info><title>Description</title></info>
8095
8096 <para>The <parameter>root.filename</parameter> is the base filename for
8097 the chunk created for the root of each document processed.
8098 </para>
8099
8100 </refsection>
8101 </refentry>
8102
8103 <refentry version="5.0" id="base.dir">
8104 <refmeta>
8105 <refentrytitle>base.dir</refentrytitle>
8106 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8107 </refmeta>
8108 <refnamediv>
8109 <refname>base.dir</refname>
8110 <refpurpose>The base directory of chunks</refpurpose>
8111 </refnamediv>
8112
8113 <refsynopsisdiv>
8114 <programlisting id="base.dir.frag">
8115 &lt;xsl:param name="base.dir"&gt;&lt;/xsl:param&gt;
8116 </programlisting>
8117 </refsynopsisdiv>
8118
8119 <refsection><info><title>Description</title></info>
8120
8121 <para>If specified, the <parameter>base.dir</parameter> identifies
8122 the output directory for chunks. (If not specified, the output directory
8123 is system dependent.)</para>
8124
8125 </refsection>
8126 </refentry>
8127
8128 <refentry version="5.0" id="generate.manifest">
8129   <refmeta>
8130     <refentrytitle>generate.manifest</refentrytitle>
8131     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8132   </refmeta>
8133   <refnamediv>
8134     <refname>generate.manifest</refname>
8135     <refpurpose>Generate a manifest file?</refpurpose>
8136   </refnamediv>
8137
8138   <refsynopsisdiv>
8139     <programlisting id="generate.manifest.frag">&lt;xsl:param name="generate.manifest" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
8140   </refsynopsisdiv>
8141
8142   <refsection><info><title>Description</title></info>
8143
8144     <para>If non-zero, a list of HTML files generated by the
8145       stylesheet transformation is written to the file named by
8146       the <parameter>manifest</parameter> parameter.</para>
8147
8148   </refsection>
8149 </refentry>
8150
8151 <refentry version="5.0" id="manifest">
8152   <refmeta>
8153     <refentrytitle>manifest</refentrytitle>
8154     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8155   </refmeta>
8156   <refnamediv>
8157     <refname>manifest</refname>
8158     <refpurpose>Name of manifest file</refpurpose>
8159   </refnamediv>
8160
8161   <refsynopsisdiv>
8162     <programlisting id="manifest.frag">
8163     &lt;xsl:param name="manifest"&gt;HTML.manifest&lt;/xsl:param&gt;
8164     </programlisting>
8165   </refsynopsisdiv>
8166
8167   <refsection><info><title>Description</title></info>
8168
8169     <para>The name of the file to which a manifest is written (if the
8170       value of the <parameter>generate.manifest</parameter> parameter
8171       is non-zero).</para>
8172
8173   </refsection>
8174 </refentry>
8175
8176 <refentry version="5.0" id="manifest.in.base.dir">
8177 <refmeta>
8178 <refentrytitle>manifest.in.base.dir</refentrytitle>
8179 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8180 </refmeta>
8181 <refnamediv>
8182 <refname>manifest.in.base.dir</refname>
8183 <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
8184 </refnamediv>
8185
8186 <refsynopsisdiv>
8187 <programlisting id="manifest.in.base.dir.frag">
8188 &lt;xsl:param name="manifest.in.base.dir" select="0"&gt;&lt;/xsl:param&gt;
8189 </programlisting>
8190 </refsynopsisdiv>
8191
8192 <refsection><info><title>Description</title></info>
8193
8194 <para>If non-zero, the manifest file as well as project files for HTML Help and
8195 Eclipse Help are written into <parameter>base.dir</parameter> instead
8196 of the current directory.</para>
8197
8198 </refsection>
8199 </refentry>
8200
8201 <refentry version="5.0" id="chunk.toc">
8202 <refmeta>
8203 <refentrytitle>chunk.toc</refentrytitle>
8204 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8205 </refmeta>
8206 <refnamediv>
8207 <refname>chunk.toc</refname>
8208 <refpurpose>An explicit TOC to be used for chunking</refpurpose>
8209 </refnamediv>
8210
8211 <refsynopsisdiv>
8212 <programlisting id="chunk.toc.frag">
8213 &lt;xsl:param name="chunk.toc"&gt;&lt;/xsl:param&gt;
8214 </programlisting>
8215 </refsynopsisdiv>
8216
8217 <refsection><info><title>Description</title></info>
8218
8219 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
8220 will be used for chunking. This parameter is only used by the
8221 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
8222 from it).</para>
8223
8224 </refsection>
8225 </refentry>
8226
8227 <refentry version="5.0" id="chunk.tocs.and.lots">
8228 <refmeta>
8229 <refentrytitle>chunk.tocs.and.lots</refentrytitle>
8230 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8231 </refmeta>
8232 <refnamediv>
8233 <refname>chunk.tocs.and.lots</refname>
8234 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
8235 </refnamediv>
8236
8237 <refsynopsisdiv>
8238 <programlisting id="chunk.tocs.and.lots.frag">
8239 &lt;xsl:param name="chunk.tocs.and.lots" select="0"&gt;&lt;/xsl:param&gt;
8240 </programlisting>
8241 </refsynopsisdiv>
8242
8243 <refsection><info><title>Description</title></info>
8244
8245 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
8246 will be put in a separate chunk. At the moment, this chunk is not in the
8247 normal forward/backward navigation list. Instead, a new link is added to the
8248 navigation footer.</para>
8249
8250 <para>This feature is still somewhat experimental. Feedback welcome.</para>
8251
8252 </refsection>
8253 </refentry>
8254
8255 <refentry version="5.0" id="chunk.separate.lots">
8256 <refmeta>
8257 <refentrytitle>chunk.separate.lots</refentrytitle>
8258 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8259 </refmeta>
8260 <refnamediv>
8261 <refname>chunk.separate.lots</refname>
8262 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
8263 </refnamediv>
8264
8265 <refsynopsisdiv>
8266 <programlisting id="chunk.separate.lots.frag">
8267 &lt;xsl:param name="chunk.separate.lots" select="0"&gt;&lt;/xsl:param&gt;
8268 </programlisting>
8269 </refsynopsisdiv>
8270
8271 <refsection><info><title>Description</title></info>
8272
8273 <para>If non-zero, each of the ToC and LoTs
8274 (List of Examples, List of Figures, etc.)
8275 will be put in its own separate chunk.
8276 The title page includes generated links to each of the separate files.
8277 </para>
8278 <para>
8279 This feature depends on the
8280 <parameter>chunk.tocs.and.lots</parameter>
8281 parameter also being non-zero. 
8282 </para>
8283
8284 </refsection>
8285 </refentry>
8286
8287 <refentry version="5.0" id="chunk.tocs.and.lots.has.title">
8288 <refmeta>
8289 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
8290 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8291 </refmeta>
8292 <refnamediv>
8293 <refname>chunk.tocs.and.lots.has.title</refname>
8294 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
8295 </refnamediv>
8296
8297 <refsynopsisdiv>
8298 <programlisting id="chunk.tocs.and.lots.has.title.frag">
8299 &lt;xsl:param name="chunk.tocs.and.lots.has.title" select="1"&gt;&lt;/xsl:param&gt;
8300 </programlisting>
8301 </refsynopsisdiv>
8302
8303 <refsection><info><title>Description</title></info>
8304
8305 <para>If non-zero title of document is shown before ToC/LoT in
8306 separate chunk.</para>
8307
8308 </refsection>
8309 </refentry>
8310
8311 <refentry version="5.0" id="chunk.section.depth">
8312 <refmeta>
8313 <refentrytitle>chunk.section.depth</refentrytitle>
8314 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8315 </refmeta>
8316 <refnamediv>
8317 <refname>chunk.section.depth</refname>
8318 <refpurpose>Depth to which sections should be chunked</refpurpose>
8319 </refnamediv>
8320
8321 <refsynopsisdiv>
8322 <programlisting id="chunk.section.depth.frag">
8323 &lt;xsl:param name="chunk.section.depth" select="1"&gt;&lt;/xsl:param&gt;
8324 </programlisting>
8325 </refsynopsisdiv>
8326
8327 <refsection><info><title>Description</title></info>
8328
8329 <para>This parameter sets the depth of section chunking.</para>
8330
8331 </refsection>
8332 </refentry>
8333
8334 <refentry version="5.0" id="chunk.first.sections">
8335 <refmeta>
8336 <refentrytitle>chunk.first.sections</refentrytitle>
8337 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8338 </refmeta>
8339 <refnamediv>
8340 <refname>chunk.first.sections</refname>
8341 <refpurpose>Chunk the first top-level section?</refpurpose>
8342 </refnamediv>
8343
8344 <refsynopsisdiv>
8345 <programlisting id="chunk.first.sections.frag">
8346 &lt;xsl:param name="chunk.first.sections" select="0"&gt;&lt;/xsl:param&gt;
8347 </programlisting>
8348 </refsynopsisdiv>
8349
8350 <refsection><info><title>Description</title></info>
8351
8352 <para>If non-zero, a chunk will be created for the first top-level
8353 <tag>sect1</tag> or <tag>section</tag> elements in
8354 each component. Otherwise, that section will be part of the chunk for
8355 its parent.
8356 </para>
8357
8358 </refsection>
8359 </refentry>
8360
8361 <refentry version="5.0" id="chunk.quietly">
8362 <refmeta>
8363 <refentrytitle>chunk.quietly</refentrytitle>
8364 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8365 </refmeta>
8366 <refnamediv>
8367 <refname>chunk.quietly</refname>
8368 <refpurpose>Omit the chunked filename messages.</refpurpose>
8369 </refnamediv>
8370
8371 <refsynopsisdiv>
8372 <programlisting id="chunk.quietly.frag">
8373 &lt;xsl:param name="chunk.quietly" select="0"&gt;&lt;/xsl:param&gt;
8374 </programlisting>
8375 </refsynopsisdiv>
8376
8377 <refsection><info><title>Description</title></info>
8378
8379 <para>If zero (the default), the XSL processor emits a message naming
8380 each separate chunk filename as it is being output.
8381 If nonzero, then the messages are suppressed.
8382 </para>
8383
8384 </refsection>
8385 </refentry>
8386
8387 <refentry version="5.0" id="chunk.append">
8388 <refmeta>
8389 <refentrytitle>chunk.append</refentrytitle>
8390 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8391 </refmeta>
8392 <refnamediv>
8393 <refname>chunk.append</refname>
8394 <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
8395 </refnamediv>
8396
8397 <refsynopsisdiv>
8398 <programlisting id="chunk.append.frag">&lt;xsl:param name="chunk.append"&gt;&lt;/xsl:param&gt;</programlisting>
8399 </refsynopsisdiv>
8400
8401 <refsection><info><title>Description</title></info>
8402
8403 <para>Specifies content to append to the end of HTML files output by
8404 the <filename>html/chunk.xsl</filename> stylesheet, after the closing
8405 <code>&lt;html&gt;</code> tag. You probably don&#8217;t want to set any value
8406 for this parameter; but if you do, the only value it should ever be
8407 set to is a newline character: <code>&amp;#x0a;</code> or
8408 <code>&amp;#10;</code></para>
8409
8410 </refsection>
8411 </refentry>
8412
8413 <refentry version="5.0" id="navig.graphics">
8414 <refmeta>
8415 <refentrytitle>navig.graphics</refentrytitle>
8416 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8417 </refmeta>
8418 <refnamediv>
8419 <refname>navig.graphics</refname>
8420 <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
8421 </refnamediv>
8422
8423 <refsynopsisdiv>
8424 <programlisting id="navig.graphics.frag">
8425 &lt;xsl:param name="navig.graphics" select="0"&gt;&lt;/xsl:param&gt;
8426 </programlisting>
8427 </refsynopsisdiv>
8428
8429 <refsection><info><title>Description</title></info>
8430
8431 <para>If non-zero, the navigational headers and footers in chunked
8432 HTML are presented in an alternate style that uses graphical icons for
8433 Next, Previous, Up, and Home.  Default graphics are provided in the
8434 distribution. If zero, text is used instead of graphics.
8435 </para>
8436
8437 </refsection>
8438 </refentry>
8439
8440 <refentry version="5.0" id="navig.graphics.extension">
8441 <refmeta>
8442 <refentrytitle>navig.graphics.extension</refentrytitle>
8443 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8444 </refmeta>
8445 <refnamediv>
8446 <refname>navig.graphics.extension</refname>
8447 <refpurpose>Extension for navigational graphics</refpurpose>
8448 </refnamediv>
8449
8450 <refsynopsisdiv>
8451 <programlisting id="navig.graphics.extension.frag">
8452 &lt;xsl:param name="navig.graphics.extension"&gt;.gif&lt;/xsl:param&gt;
8453 </programlisting>
8454 </refsynopsisdiv>
8455
8456 <refsection><info><title>Description</title></info>
8457
8458 <para>Sets the filename extension to use on navigational graphics used
8459 in the headers and footers of chunked HTML.</para>
8460
8461 </refsection>
8462 </refentry>
8463
8464 <refentry version="5.0" id="navig.graphics.path">
8465 <refmeta>
8466 <refentrytitle>navig.graphics.path</refentrytitle>
8467 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8468 </refmeta>
8469 <refnamediv>
8470 <refname>navig.graphics.path</refname>
8471 <refpurpose>Path to navigational graphics</refpurpose>
8472 </refnamediv>
8473
8474 <refsynopsisdiv>
8475 <programlisting id="navig.graphics.path.frag">
8476 &lt;xsl:param name="navig.graphics.path"&gt;images/&lt;/xsl:param&gt;
8477 </programlisting>
8478 </refsynopsisdiv>
8479
8480 <refsection><info><title>Description</title></info>
8481
8482 <para>Sets the path, probably relative to the directory where the HTML
8483 files are created, to the navigational graphics used in the
8484 headers and footers of chunked HTML.
8485 </para>
8486
8487 </refsection>
8488 </refentry>
8489
8490 <refentry version="5.0" id="navig.showtitles">
8491 <refmeta>
8492 <refentrytitle>navig.showtitles</refentrytitle>
8493 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8494 </refmeta>
8495 <refnamediv>
8496 <refname>navig.showtitles</refname>
8497 <refpurpose>Display titles in HTML headers and footers?</refpurpose>
8498 </refnamediv>
8499
8500 <refsynopsisdiv>
8501 <programlisting id="navig.showtitles.frag">&lt;xsl:param name="navig.showtitles"&gt;1&lt;/xsl:param&gt;</programlisting>
8502 </refsynopsisdiv>
8503
8504 <refsection><info><title>Description</title></info>
8505
8506 <para>If non-zero,
8507 the headers and footers of chunked HTML
8508 display the titles of the next and previous chunks,
8509 along with the words 'Next' and 'Previous' (or the
8510 equivalent graphical icons if navig.graphics is true).
8511 If false (zero), then only the words 'Next' and 'Previous'
8512 (or the icons) are displayed.
8513 </para>
8514
8515 </refsection>
8516 </refentry>
8517
8518 </reference><reference id="profiling" xml:base="../html/param.xml"><title>Profiling</title>
8519 <partintro id="partintro">
8520 <para>The following parameters can be used for attribute-based
8521 profiling of your document. For more information about profiling, see 
8522 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
8523 </partintro>
8524 <refentry version="5.0" id="profile.arch">
8525 <refmeta>
8526 <refentrytitle>profile.arch</refentrytitle>
8527 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8528 </refmeta>
8529 <refnamediv>
8530 <refname>profile.arch</refname>
8531 <refpurpose>Target profile for <tag class="attribute">arch</tag>
8532 attribute</refpurpose>
8533 </refnamediv>
8534
8535 <refsynopsisdiv>
8536 <programlisting id="profile.arch.frag">
8537 &lt;xsl:param name="profile.arch"&gt;&lt;/xsl:param&gt;
8538 </programlisting>
8539 </refsynopsisdiv>
8540
8541
8542 <refsection><info><title>Description</title></info>
8543
8544 <para>The value of this parameter specifies profiles which should be
8545 included in the output. You can specify multiple profiles by
8546 separating them by semicolon. You can change separator character by
8547 <parameter>profile.separator</parameter>
8548 parameter.</para>
8549
8550 <para>This parameter has effect only when you are using profiling
8551 stylesheets (<filename>profile-docbook.xsl</filename>,
8552 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8553 ones (<filename>docbook.xsl</filename>,
8554 <filename>chunk.xsl</filename>, &#8230;).</para>
8555
8556 </refsection>
8557 </refentry>
8558
8559 <refentry version="5.0" id="profile.audience">
8560 <refmeta>
8561 <refentrytitle>profile.audience</refentrytitle>
8562 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8563 </refmeta>
8564 <refnamediv>
8565 <refname>profile.audience</refname>
8566 <refpurpose>Target profile for <tag class="attribute">audience</tag>
8567 attribute</refpurpose>
8568 </refnamediv>
8569
8570 <refsynopsisdiv>
8571 <programlisting id="profile.audience.frag">
8572 &lt;xsl:param name="profile.audience"&gt;&lt;/xsl:param&gt;
8573 </programlisting>
8574 </refsynopsisdiv>
8575
8576 <refsection><info><title>Description</title></info>
8577
8578 <para>Value of this parameter specifies profiles which should be
8579 included in the output. You can specify multiple profiles by
8580 separating them by semicolon. You can change separator character by
8581 <parameter>profile.separator</parameter>
8582 parameter.</para>
8583
8584 <para>This parameter has effect only when you are using profiling
8585 stylesheets (<filename>profile-docbook.xsl</filename>,
8586 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8587 ones (<filename>docbook.xsl</filename>,
8588 <filename>chunk.xsl</filename>, &#8230;).</para>
8589
8590 </refsection>
8591 </refentry>
8592
8593 <refentry version="5.0" id="profile.condition">
8594 <refmeta>
8595 <refentrytitle>profile.condition</refentrytitle>
8596 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8597 </refmeta>
8598 <refnamediv>
8599 <refname>profile.condition</refname>
8600 <refpurpose>Target profile for <tag class="attribute">condition</tag>
8601 attribute</refpurpose>
8602 </refnamediv>
8603
8604 <refsynopsisdiv>
8605 <programlisting id="profile.condition.frag">
8606 &lt;xsl:param name="profile.condition"&gt;&lt;/xsl:param&gt;
8607 </programlisting>
8608 </refsynopsisdiv>
8609
8610 <refsection><info><title>Description</title></info>
8611
8612 <para>The value of this parameter specifies profiles which should be
8613 included in the output. You can specify multiple profiles by
8614 separating them by semicolon. You can change separator character by
8615 <parameter>profile.separator</parameter>
8616 parameter.</para>
8617
8618 <para>This parameter has effect only when you are using profiling
8619 stylesheets (<filename>profile-docbook.xsl</filename>,
8620 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8621 ones (<filename>docbook.xsl</filename>,
8622 <filename>chunk.xsl</filename>, &#8230;).</para>
8623
8624 </refsection>
8625 </refentry>
8626
8627 <refentry version="5.0" id="profile.conformance">
8628 <refmeta>
8629 <refentrytitle>profile.conformance</refentrytitle>
8630 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8631 </refmeta>
8632 <refnamediv>
8633 <refname>profile.conformance</refname>
8634 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
8635 attribute</refpurpose>
8636 </refnamediv>
8637
8638 <refsynopsisdiv>
8639 <programlisting id="profile.conformance.frag">
8640 &lt;xsl:param name="profile.conformance"&gt;&lt;/xsl:param&gt;
8641 </programlisting>
8642 </refsynopsisdiv>
8643
8644 <refsection><info><title>Description</title></info>
8645
8646 <para>The value of this parameter specifies profiles which should be
8647 included in the output. You can specify multiple profiles by
8648 separating them by semicolon. You can change separator character by
8649 <parameter>profile.separator</parameter>
8650 parameter.</para>
8651
8652 <para>This parameter has effect only when you are using profiling
8653 stylesheets (<filename>profile-docbook.xsl</filename>,
8654 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8655 ones (<filename>docbook.xsl</filename>,
8656 <filename>chunk.xsl</filename>, &#8230;).</para>
8657
8658 </refsection>
8659 </refentry>
8660
8661 <refentry version="5.0" id="profile.lang">
8662 <refmeta>
8663 <refentrytitle>profile.lang</refentrytitle>
8664 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8665 </refmeta>
8666 <refnamediv>
8667 <refname>profile.lang</refname>
8668 <refpurpose>Target profile for <tag class="attribute">lang</tag>
8669 attribute</refpurpose>
8670 </refnamediv>
8671
8672 <refsynopsisdiv>
8673 <programlisting id="profile.lang.frag">
8674 &lt;xsl:param name="profile.lang"&gt;&lt;/xsl:param&gt;
8675 </programlisting>
8676 </refsynopsisdiv>
8677
8678 <refsection><info><title>Description</title></info>
8679
8680 <para>The value of this parameter specifies profiles which should be
8681 included in the output. You can specify multiple profiles by
8682 separating them by semicolon. You can change separator character by
8683 <parameter>profile.separator</parameter>
8684 parameter.</para>
8685
8686 <para>This parameter has effect only when you are using profiling
8687 stylesheets (<filename>profile-docbook.xsl</filename>,
8688 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8689 ones (<filename>docbook.xsl</filename>,
8690 <filename>chunk.xsl</filename>, &#8230;).</para>
8691
8692 </refsection>
8693 </refentry>
8694
8695 <refentry version="5.0" id="profile.os">
8696 <refmeta>
8697 <refentrytitle>profile.os</refentrytitle>
8698 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8699 </refmeta>
8700 <refnamediv>
8701 <refname>profile.os</refname>
8702 <refpurpose>Target profile for <tag class="attribute">os</tag>
8703 attribute</refpurpose>
8704 </refnamediv>
8705
8706 <refsynopsisdiv>
8707 <programlisting id="profile.os.frag">
8708 &lt;xsl:param name="profile.os"&gt;&lt;/xsl:param&gt;
8709 </programlisting>
8710 </refsynopsisdiv>
8711
8712 <refsection><info><title>Description</title></info>
8713
8714 <para>The value of this parameter specifies profiles which should be
8715 included in the output. You can specify multiple profiles by
8716 separating them by semicolon. You can change separator character by
8717 <parameter>profile.separator</parameter>
8718 parameter.</para>
8719
8720 <para>This parameter has effect only when you are using profiling
8721 stylesheets (<filename>profile-docbook.xsl</filename>,
8722 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8723 ones (<filename>docbook.xsl</filename>,
8724 <filename>chunk.xsl</filename>, &#8230;).</para>
8725
8726 </refsection>
8727 </refentry>
8728
8729 <refentry version="5.0" id="profile.revision">
8730 <refmeta>
8731 <refentrytitle>profile.revision</refentrytitle>
8732 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8733 </refmeta>
8734 <refnamediv>
8735 <refname>profile.revision</refname>
8736 <refpurpose>Target profile for <tag class="attribute">revision</tag>
8737 attribute</refpurpose>
8738 </refnamediv>
8739
8740 <refsynopsisdiv>
8741 <programlisting id="profile.revision.frag">
8742 &lt;xsl:param name="profile.revision"&gt;&lt;/xsl:param&gt;
8743 </programlisting>
8744 </refsynopsisdiv>
8745
8746 <refsection><info><title>Description</title></info>
8747
8748 <para>The value of this parameter specifies profiles which should be
8749 included in the output. You can specify multiple profiles by
8750 separating them by semicolon. You can change separator character by
8751 <parameter>profile.separator</parameter>
8752 parameter.</para>
8753
8754 <para>This parameter has effect only when you are using profiling
8755 stylesheets (<filename>profile-docbook.xsl</filename>,
8756 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8757 ones (<filename>docbook.xsl</filename>,
8758 <filename>chunk.xsl</filename>, &#8230;).</para>
8759
8760 </refsection>
8761 </refentry>
8762
8763 <refentry version="5.0" id="profile.revisionflag">
8764 <refmeta>
8765 <refentrytitle>profile.revisionflag</refentrytitle>
8766 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8767 </refmeta>
8768 <refnamediv>
8769 <refname>profile.revisionflag</refname>
8770 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
8771 attribute</refpurpose>
8772 </refnamediv>
8773
8774 <refsynopsisdiv>
8775 <programlisting id="profile.revisionflag.frag">
8776 &lt;xsl:param name="profile.revisionflag"&gt;&lt;/xsl:param&gt;
8777 </programlisting>
8778 </refsynopsisdiv>
8779
8780 <refsection><info><title>Description</title></info>
8781
8782 <para>The value of this parameter specifies profiles which should be
8783 included in the output. You can specify multiple profiles by
8784 separating them by semicolon. You can change separator character by
8785 <parameter>profile.separator</parameter>
8786 parameter.</para>
8787
8788 <para>This parameter has effect only when you are using profiling
8789 stylesheets (<filename>profile-docbook.xsl</filename>,
8790 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8791 ones (<filename>docbook.xsl</filename>,
8792 <filename>chunk.xsl</filename>, &#8230;).</para>
8793
8794 </refsection>
8795 </refentry>
8796
8797 <refentry version="5.0" id="profile.role">
8798 <refmeta>
8799 <refentrytitle>profile.role</refentrytitle>
8800 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8801 </refmeta>
8802 <refnamediv>
8803 <refname>profile.role</refname>
8804 <refpurpose>Target profile for <tag class="attribute">role</tag>
8805 attribute</refpurpose>
8806 </refnamediv>
8807
8808 <refsynopsisdiv>
8809 <programlisting id="profile.role.frag">
8810 &lt;xsl:param name="profile.role"&gt;&lt;/xsl:param&gt;
8811 </programlisting>
8812 </refsynopsisdiv>
8813
8814 <refsection><info><title>Description</title></info>
8815
8816 <para>The value of this parameter specifies profiles which should be
8817 included in the output. You can specify multiple profiles by
8818 separating them by semicolon. You can change separator character by
8819 <parameter>profile.separator</parameter>
8820 parameter.</para>
8821
8822 <para>This parameter has effect only when you are using profiling
8823 stylesheets (<filename>profile-docbook.xsl</filename>,
8824 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8825 ones (<filename>docbook.xsl</filename>,
8826 <filename>chunk.xsl</filename>, &#8230;).</para>
8827
8828 <warning>
8829 <para>Note that <tag class="attribute">role</tag> is often
8830 used for other purposes than profiling. For example it is commonly
8831 used to get emphasize in bold font:</para>
8832
8833 <programlisting>&lt;emphasis role="bold"&gt;very important&lt;/emphasis&gt;</programlisting>
8834
8835 <para>If you are using <tag class="attribute">role</tag> for
8836 these purposes do not forget to add values like <literal>bold</literal> to
8837 value of this parameter. If you forgot you will get document with
8838 small pieces missing which are very hard to track.</para>
8839
8840 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
8841 rather use profiling specific attributes like <tag class="attribute">userlevel</tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag class="attribute">condition</tag>, etc.</para>
8842 </warning>
8843
8844 </refsection>
8845 </refentry>
8846
8847 <refentry version="5.0" id="profile.security">
8848 <refmeta>
8849 <refentrytitle>profile.security</refentrytitle>
8850 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8851 </refmeta>
8852 <refnamediv>
8853 <refname>profile.security</refname>
8854 <refpurpose>Target profile for <tag class="attribute">security</tag>
8855 attribute</refpurpose>
8856 </refnamediv>
8857
8858 <refsynopsisdiv>
8859 <programlisting id="profile.security.frag">
8860 &lt;xsl:param name="profile.security"&gt;&lt;/xsl:param&gt;
8861 </programlisting>
8862 </refsynopsisdiv>
8863
8864 <refsection><info><title>Description</title></info>
8865
8866 <para>The value of this parameter specifies profiles which should be
8867 included in the output. You can specify multiple profiles by
8868 separating them by semicolon. You can change separator character by
8869 <parameter>profile.separator</parameter>
8870 parameter.</para>
8871
8872 <para>This parameter has effect only when you are using profiling
8873 stylesheets (<filename>profile-docbook.xsl</filename>,
8874 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8875 ones (<filename>docbook.xsl</filename>,
8876 <filename>chunk.xsl</filename>, &#8230;).</para>
8877
8878 </refsection>
8879 </refentry>
8880
8881 <refentry version="5.0" id="profile.status">
8882 <refmeta>
8883 <refentrytitle>profile.status</refentrytitle>
8884 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8885 </refmeta>
8886 <refnamediv>
8887 <refname>profile.status</refname>
8888 <refpurpose>Target profile for <tag class="attribute">status</tag>
8889 attribute</refpurpose>
8890 </refnamediv>
8891
8892 <refsynopsisdiv>
8893 <programlisting id="profile.status.frag">
8894 &lt;xsl:param name="profile.status"&gt;&lt;/xsl:param&gt;
8895 </programlisting>
8896 </refsynopsisdiv>
8897
8898 <refsection><info><title>Description</title></info>
8899
8900 <para>The value of this parameter specifies profiles which should be
8901 included in the output. You can specify multiple profiles by
8902 separating them by semicolon. You can change separator character by
8903 <parameter>profile.separator</parameter>
8904 parameter.</para>
8905
8906 <para>This parameter has effect only when you are using profiling
8907 stylesheets (<filename>profile-docbook.xsl</filename>,
8908 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8909 ones (<filename>docbook.xsl</filename>,
8910 <filename>chunk.xsl</filename>, &#8230;).</para>
8911
8912 </refsection>
8913 </refentry>
8914
8915 <refentry version="5.0" id="profile.userlevel">
8916 <refmeta>
8917 <refentrytitle>profile.userlevel</refentrytitle>
8918 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8919 </refmeta>
8920 <refnamediv>
8921 <refname>profile.userlevel</refname>
8922 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
8923 attribute</refpurpose>
8924 </refnamediv>
8925
8926 <refsynopsisdiv>
8927 <programlisting id="profile.userlevel.frag">
8928 &lt;xsl:param name="profile.userlevel"&gt;&lt;/xsl:param&gt;
8929 </programlisting>
8930 </refsynopsisdiv>
8931
8932 <refsection><info><title>Description</title></info>
8933
8934 <para>The value of this parameter specifies profiles which should be
8935 included in the output. You can specify multiple profiles by
8936 separating them by semicolon. You can change separator character by
8937 <parameter>profile.separator</parameter>
8938 parameter.</para>
8939
8940 <para>This parameter has effect only when you are using profiling
8941 stylesheets (<filename>profile-docbook.xsl</filename>,
8942 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8943 ones (<filename>docbook.xsl</filename>,
8944 <filename>chunk.xsl</filename>, &#8230;).</para>
8945
8946 </refsection>
8947 </refentry>
8948
8949 <refentry version="5.0" id="profile.vendor">
8950 <refmeta>
8951 <refentrytitle>profile.vendor</refentrytitle>
8952 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8953 </refmeta>
8954 <refnamediv>
8955 <refname>profile.vendor</refname>
8956 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
8957 attribute</refpurpose>
8958 </refnamediv>
8959
8960 <refsynopsisdiv>
8961 <programlisting id="profile.vendor.frag">
8962 &lt;xsl:param name="profile.vendor"&gt;&lt;/xsl:param&gt;
8963 </programlisting>
8964 </refsynopsisdiv>
8965
8966 <refsection><info><title>Description</title></info>
8967
8968 <para>The value of this parameter specifies profiles which should be
8969 included in the output. You can specify multiple profiles by
8970 separating them by semicolon. You can change separator character by
8971 <parameter>profile.separator</parameter>
8972 parameter.</para>
8973
8974 <para>This parameter has effect only when you are using profiling
8975 stylesheets (<filename>profile-docbook.xsl</filename>,
8976 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8977 ones (<filename>docbook.xsl</filename>,
8978 <filename>chunk.xsl</filename>, &#8230;).</para>
8979
8980 </refsection>
8981 </refentry>
8982
8983 <refentry version="5.0" id="profile.wordsize">
8984 <refmeta>
8985 <refentrytitle>profile.wordsize</refentrytitle>
8986 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8987 </refmeta>
8988 <refnamediv>
8989 <refname>profile.wordsize</refname>
8990 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
8991 attribute</refpurpose>
8992 </refnamediv>
8993
8994 <refsynopsisdiv>
8995 <programlisting id="profile.wordsize.frag">
8996 &lt;xsl:param name="profile.wordsize"&gt;&lt;/xsl:param&gt;
8997 </programlisting>
8998 </refsynopsisdiv>
8999
9000 <refsection><info><title>Description</title></info>
9001
9002 <para>The value of this parameter specifies profiles which should be
9003 included in the output. You can specify multiple profiles by
9004 separating them by semicolon. You can change separator character by
9005 <parameter>profile.separator</parameter>
9006 parameter.</para>
9007
9008 <para>This parameter has effect only when you are using profiling
9009 stylesheets (<filename>profile-docbook.xsl</filename>,
9010 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
9011 ones (<filename>docbook.xsl</filename>,
9012 <filename>chunk.xsl</filename>, &#8230;).</para>
9013
9014 </refsection>
9015 </refentry>
9016
9017 <refentry version="5.0" id="profile.attribute">
9018 <refmeta>
9019 <refentrytitle>profile.attribute</refentrytitle>
9020 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9021 </refmeta>
9022 <refnamediv>
9023 <refname>profile.attribute</refname>
9024 <refpurpose>Name of user-specified profiling attribute</refpurpose>
9025 </refnamediv>
9026
9027 <refsynopsisdiv>
9028 <programlisting id="profile.attribute.frag">
9029 &lt;xsl:param name="profile.attribute"&gt;&lt;/xsl:param&gt;
9030 </programlisting>
9031 </refsynopsisdiv>
9032
9033 <refsection><info><title>Description</title></info>
9034
9035 <para>This parameter is used in conjuction with
9036 <parameter>profile.value</parameter>.</para>
9037
9038 <para>This parameter has effect only when you are using profiling
9039 stylesheets (<filename>profile-docbook.xsl</filename>,
9040 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
9041 ones (<filename>docbook.xsl</filename>,
9042 <filename>chunk.xsl</filename>, &#8230;).</para>
9043
9044 </refsection>
9045 </refentry>
9046
9047 <refentry version="5.0" id="profile.value">
9048 <refmeta>
9049 <refentrytitle>profile.value</refentrytitle>
9050 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9051 </refmeta>
9052 <refnamediv>
9053 <refname>profile.value</refname>
9054 <refpurpose>Target profile for user-specified attribute</refpurpose>
9055 </refnamediv>
9056
9057 <refsynopsisdiv>
9058 <programlisting id="profile.value.frag">
9059 &lt;xsl:param name="profile.value"&gt;&lt;/xsl:param&gt;
9060 </programlisting>
9061 </refsynopsisdiv>
9062
9063 <refsection><info><title>Description</title></info>
9064
9065 <para>When you are using this parameter you must also specify name of
9066 profiling attribute with parameter
9067 <parameter>profile.attribute</parameter>.</para>
9068
9069 <para>The value of this parameter specifies profiles which should be
9070 included in the output. You can specify multiple profiles by
9071 separating them by semicolon. You can change separator character by
9072 <parameter>profile.separator</parameter>
9073 parameter.</para>
9074
9075 <para>This parameter has effect only when you are using profiling
9076 stylesheets (<filename>profile-docbook.xsl</filename>,
9077 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
9078 ones (<filename>docbook.xsl</filename>,
9079 <filename>chunk.xsl</filename>, &#8230;).</para>
9080
9081 </refsection>
9082 </refentry>
9083
9084 <refentry version="5.0" id="profile.separator">
9085 <refmeta>
9086 <refentrytitle>profile.separator</refentrytitle>
9087 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9088 </refmeta>
9089 <refnamediv>
9090 <refname>profile.separator</refname>
9091 <refpurpose>Separator character for compound profile values</refpurpose>
9092 </refnamediv>
9093
9094 <refsynopsisdiv>
9095 <programlisting id="profile.separator.frag">
9096 &lt;xsl:param name="profile.separator"&gt;;&lt;/xsl:param&gt;
9097 </programlisting>
9098 </refsynopsisdiv>
9099
9100 <refsection><info><title>Description</title></info>
9101
9102 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
9103
9104 </refsection>
9105 </refentry>
9106
9107 </reference><reference id="htmlhelp" xml:base="../html/param.xml"><title>HTML Help</title>
9108 <refentry version="5.0" id="htmlhelp.encoding">
9109 <refmeta>
9110 <refentrytitle>htmlhelp.encoding</refentrytitle>
9111 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9112 </refmeta>
9113 <refnamediv>
9114 <refname>htmlhelp.encoding</refname>
9115 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
9116 </refnamediv>
9117
9118 <refsynopsisdiv>
9119 <programlisting id="htmlhelp.encoding.frag">
9120 &lt;xsl:param name="htmlhelp.encoding"&gt;iso-8859-1&lt;/xsl:param&gt;
9121 </programlisting>
9122 </refsynopsisdiv>
9123
9124 <refsection><info><title>Description</title></info>
9125
9126 <para>HTML Help Compiler is not UTF-8 aware, so you should always use an
9127 appropriate single-byte encoding here. Use one from <link xlink:href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">iana</link>, the  registered charset values.</para>
9128
9129 </refsection>
9130 </refentry>
9131
9132 <refentry version="5.0" id="htmlhelp.autolabel">
9133 <refmeta>
9134 <refentrytitle>htmlhelp.autolabel</refentrytitle>
9135 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9136 </refmeta>
9137 <refnamediv>
9138 <refname>htmlhelp.autolabel</refname>
9139 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
9140 </refnamediv>
9141
9142 <refsynopsisdiv>
9143 <programlisting id="htmlhelp.autolabel.frag">
9144 &lt;xsl:param name="htmlhelp.autolabel" select="0"&gt;&lt;/xsl:param&gt;
9145 </programlisting>
9146 </refsynopsisdiv>
9147
9148 <refsection><info><title>Description</title></info>
9149
9150 <para>Set this to non-zero to include chapter and section numbers into ToC
9151 in the left panel.</para>
9152
9153 </refsection>
9154 </refentry>
9155
9156 <refentry version="5.0" id="htmlhelp.chm">
9157 <refmeta>
9158 <refentrytitle>htmlhelp.chm</refentrytitle>
9159 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9160 </refmeta>
9161 <refnamediv>
9162 <refname>htmlhelp.chm</refname>
9163 <refpurpose>Filename of output HTML Help file.</refpurpose>
9164 </refnamediv>
9165
9166 <refsynopsisdiv>
9167 <programlisting id="htmlhelp.chm.frag">
9168 &lt;xsl:param name="htmlhelp.chm"&gt;htmlhelp.chm&lt;/xsl:param&gt;
9169 </programlisting>
9170 </refsynopsisdiv>
9171
9172 <refsection><info><title>Description</title></info>
9173
9174 <para>Set the  name of resulting CHM file</para>
9175
9176 </refsection>
9177 </refentry>
9178
9179 <refentry version="5.0" id="htmlhelp.default.topic">
9180 <refmeta>
9181 <refentrytitle>htmlhelp.default.topic</refentrytitle>
9182 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9183 </refmeta>
9184 <refnamediv>
9185 <refname>htmlhelp.default.topic</refname>
9186 <refpurpose>Name of file with default topic</refpurpose>
9187 </refnamediv>
9188
9189 <refsynopsisdiv>
9190 <programlisting id="htmlhelp.default.topic.frag">
9191 &lt;xsl:param name="htmlhelp.default.topic"&gt;&lt;/xsl:param&gt;
9192 </programlisting>
9193 </refsynopsisdiv>
9194
9195 <refsection><info><title>Description</title></info>
9196
9197 <para>Normally first chunk of document is displayed when you open HTML
9198 Help file. If you want to display another topic, simply set its
9199 filename by this parameter.</para>
9200
9201 <para>This is useful especially if you don't generate ToC in front of
9202 your document and you also hide root element in ToC. E.g.:</para>
9203
9204 <programlisting>&lt;xsl:param name="generate.book.toc" select="0"/&gt;
9205 &lt;xsl:param name="htmlhelp.hhc.show.root" select="0"/&gt;
9206 &lt;xsl:param name="htmlhelp.default.topic"&gt;pr01.html&lt;/xsl:param&gt;
9207 </programlisting>
9208
9209 </refsection>
9210 </refentry>
9211
9212 <refentry version="5.0" id="htmlhelp.display.progress">
9213 <refmeta>
9214 <refentrytitle>htmlhelp.display.progress</refentrytitle>
9215 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9216 </refmeta>
9217 <refnamediv>
9218 <refname>htmlhelp.display.progress</refname>
9219 <refpurpose>Display compile progress?</refpurpose>
9220 </refnamediv>
9221
9222 <refsynopsisdiv>
9223 <programlisting id="htmlhelp.display.progress.frag">
9224 &lt;xsl:param name="htmlhelp.display.progress" select="1"&gt;&lt;/xsl:param&gt;
9225 </programlisting>
9226 </refsynopsisdiv>
9227
9228 <refsection><info><title>Description</title></info>
9229
9230 <para>Set to non-zero to to display compile progress
9231 </para>
9232
9233 </refsection>
9234 </refentry>
9235
9236 <refentry version="5.0" id="htmlhelp.hhp">
9237 <refmeta>
9238 <refentrytitle>htmlhelp.hhp</refentrytitle>
9239 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9240 </refmeta>
9241 <refnamediv>
9242 <refname>htmlhelp.hhp</refname>
9243 <refpurpose>Filename of project file.</refpurpose>
9244 </refnamediv>
9245
9246 <refsynopsisdiv>
9247 <programlisting id="htmlhelp.hhp.frag">
9248 &lt;xsl:param name="htmlhelp.hhp"&gt;htmlhelp.hhp&lt;/xsl:param&gt;
9249 </programlisting>
9250 </refsynopsisdiv>
9251
9252 <refsection><info><title>Description</title></info>
9253
9254 <para>Change this parameter if you want different name of project
9255 file than htmlhelp.hhp.</para>
9256
9257 </refsection>
9258 </refentry>
9259
9260 <refentry version="5.0" id="htmlhelp.hhc">
9261 <refmeta>
9262 <refentrytitle>htmlhelp.hhc</refentrytitle>
9263 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9264 </refmeta>
9265 <refnamediv>
9266 <refname>htmlhelp.hhc</refname>
9267 <refpurpose>Filename of TOC file.</refpurpose>
9268 </refnamediv>
9269
9270 <refsynopsisdiv>
9271 <programlisting id="htmlhelp.hhc.frag">
9272 &lt;xsl:param name="htmlhelp.hhc"&gt;toc.hhc&lt;/xsl:param&gt;
9273 </programlisting>
9274 </refsynopsisdiv>
9275
9276 <refsection><info><title>Description</title></info>
9277
9278 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
9279
9280 </refsection>
9281 </refentry>
9282
9283 <refentry version="5.0" id="htmlhelp.hhk">
9284 <refmeta>
9285 <refentrytitle>htmlhelp.hhk</refentrytitle>
9286 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9287 </refmeta>
9288 <refnamediv>
9289 <refname>htmlhelp.hhk</refname>
9290 <refpurpose>Filename of index file.</refpurpose>
9291 </refnamediv>
9292
9293 <refsynopsisdiv>
9294 <programlisting id="htmlhelp.hhk.frag">
9295 &lt;xsl:param name="htmlhelp.hhk"&gt;index.hhk&lt;/xsl:param&gt;
9296 </programlisting>
9297 </refsynopsisdiv>
9298
9299 <refsection><info><title>Description</title></info>
9300
9301 <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
9302
9303 </refsection>
9304 </refentry>
9305
9306 <refentry version="5.0" id="htmlhelp.hhp.tail">
9307 <refmeta>
9308 <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
9309 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9310 </refmeta>
9311 <refnamediv>
9312 <refname>htmlhelp.hhp.tail</refname>
9313 <refpurpose>Additional content for project file.</refpurpose>
9314 </refnamediv>
9315
9316 <refsynopsisdiv>
9317 <programlisting id="htmlhelp.hhp.tail.frag">
9318 &lt;xsl:param name="htmlhelp.hhp.tail"&gt;&lt;/xsl:param&gt;
9319 </programlisting>
9320 </refsynopsisdiv>
9321
9322 <refsection><info><title>Description</title></info>
9323
9324 <para>If you want to include some additional parameters into project file,
9325 store appropriate part of project file into this parameter.</para>
9326
9327 </refsection>
9328 </refentry>
9329
9330 <refentry version="5.0" id="htmlhelp.hhp.window">
9331 <refmeta>
9332 <refentrytitle>htmlhelp.hhp.window</refentrytitle>
9333 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9334 </refmeta>
9335 <refnamediv>
9336 <refname>htmlhelp.hhp.window</refname>
9337 <refpurpose>Name of default window.</refpurpose>
9338 </refnamediv>
9339
9340 <refsynopsisdiv>
9341 <programlisting id="htmlhelp.hhp.window.frag">
9342 &lt;xsl:param name="htmlhelp.hhp.window"&gt;Main&lt;/xsl:param&gt;
9343 </programlisting>
9344 </refsynopsisdiv>
9345
9346 <refsection><info><title>Description</title></info>
9347
9348 <para>Name of default window. If empty no [WINDOWS] section will be
9349 added to project file.</para>
9350
9351 </refsection>
9352 </refentry>
9353
9354 <refentry version="5.0" id="htmlhelp.hhp.windows">
9355 <refmeta>
9356 <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
9357 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9358 </refmeta>
9359 <refnamediv>
9360 <refname>htmlhelp.hhp.windows</refname>
9361 <refpurpose>Definition of additional windows</refpurpose>
9362 </refnamediv>
9363
9364 <refsynopsisdiv>
9365 <programlisting id="htmlhelp.hhp.windows.frag">
9366 &lt;xsl:param name="htmlhelp.hhp.windows"&gt;&lt;/xsl:param&gt;
9367 </programlisting>
9368 </refsynopsisdiv>
9369
9370 <refsection><info><title>Description</title></info>
9371
9372 <para>Content of this parameter is placed at the end of [WINDOWS]
9373 section of project file. You can use it for defining your own
9374 addtional windows.</para>
9375
9376 </refsection>
9377 </refentry>
9378
9379 <refentry version="5.0" id="htmlhelp.enhanced.decompilation">
9380 <refmeta>
9381 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
9382 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9383 </refmeta>
9384 <refnamediv>
9385 <refname>htmlhelp.enhanced.decompilation</refname>
9386 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
9387 </refnamediv>
9388
9389 <refsynopsisdiv>
9390 <programlisting id="htmlhelp.enhanced.decompilation.frag">
9391 &lt;xsl:param name="htmlhelp.enhanced.decompilation" select="0"&gt;&lt;/xsl:param&gt;
9392 </programlisting>
9393 </refsynopsisdiv>
9394
9395 <refsection><info><title>Description</title></info>
9396
9397 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
9398
9399 </refsection>
9400 </refentry>
9401
9402 <refentry version="5.0" id="htmlhelp.enumerate.images">
9403 <refmeta>
9404 <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
9405 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9406 </refmeta>
9407 <refnamediv>
9408 <refname>htmlhelp.enumerate.images</refname>
9409 <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
9410 </refnamediv>
9411
9412 <refsynopsisdiv>
9413 <programlisting id="htmlhelp.enumerate.images.frag">
9414 &lt;xsl:param name="htmlhelp.enumerate.images" select="0"&gt;&lt;/xsl:param&gt;
9415 </programlisting>
9416 </refsynopsisdiv>
9417
9418 <refsection><info><title>Description</title></info>
9419
9420 <para>Set to non-zero if you insert images into your documents as
9421 external binary entities or if you are using absolute image paths.</para>
9422
9423 </refsection>
9424 </refentry>
9425
9426 <refentry version="5.0" id="htmlhelp.force.map.and.alias">
9427 <refmeta>
9428 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
9429 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9430 </refmeta>
9431 <refnamediv>
9432 <refname>htmlhelp.force.map.and.alias</refname>
9433 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
9434 </refnamediv>
9435 <refsynopsisdiv>
9436 <programlisting id="htmlhelp.force.map.and.alias.frag">
9437 &lt;xsl:param name="htmlhelp.force.map.and.alias" select="0"&gt;&lt;/xsl:param&gt;
9438 </programlisting>
9439 </refsynopsisdiv>
9440 <refsection><info><title>Description</title></info>
9441   <para>Set to non-zero if you have your own
9442     <literal>alias.h</literal> and <literal>context.h</literal>
9443     files and you want to include references to them in the project
9444     file.</para>
9445 </refsection>
9446 </refentry>
9447
9448 <refentry version="5.0" id="htmlhelp.map.file">
9449 <refmeta>
9450 <refentrytitle>htmlhelp.map.file</refentrytitle>
9451 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9452 </refmeta>
9453 <refnamediv>
9454 <refname>htmlhelp.map.file</refname>
9455 <refpurpose>Filename of map file.</refpurpose>
9456 </refnamediv>
9457 <refsynopsisdiv>
9458 <programlisting id="htmlhelp.map.file.frag">
9459 &lt;xsl:param name="htmlhelp.map.file"&gt;context.h&lt;/xsl:param&gt;
9460 </programlisting>
9461 </refsynopsisdiv>
9462 <refsection><info><title>Description</title></info>
9463 <para>Set the name of map file. The default is
9464   <filename>context.h</filename>. (used for context-sensitive
9465   help).</para>
9466 </refsection>
9467 </refentry>
9468
9469 <refentry version="5.0" id="htmlhelp.alias.file">
9470 <refmeta>
9471 <refentrytitle>htmlhelp.alias.file</refentrytitle>
9472 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9473 </refmeta>
9474 <refnamediv>
9475 <refname>htmlhelp.alias.file</refname>
9476 <refpurpose>Filename of alias file.</refpurpose>
9477 </refnamediv>
9478
9479 <refsynopsisdiv>
9480 <programlisting id="htmlhelp.alias.file.frag">
9481 &lt;xsl:param name="htmlhelp.alias.file"&gt;alias.h&lt;/xsl:param&gt;
9482 </programlisting>
9483 </refsynopsisdiv>
9484
9485 <refsection><info><title>Description</title></info>
9486
9487 <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
9488
9489 </refsection>
9490 </refentry>
9491
9492 <refentry version="5.0" id="htmlhelp.hhc.section.depth">
9493 <refmeta>
9494 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
9495 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9496 </refmeta>
9497 <refnamediv>
9498 <refname>htmlhelp.hhc.section.depth</refname>
9499 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
9500 </refnamediv>
9501
9502 <refsynopsisdiv>
9503 <programlisting id="htmlhelp.hhc.section.depth.frag">
9504 &lt;xsl:param name="htmlhelp.hhc.section.depth"&gt;5&lt;/xsl:param&gt;
9505 </programlisting>
9506 </refsynopsisdiv>
9507
9508 <refsection><info><title>Description</title></info>
9509
9510 <para>Set the section depth in the left pane of HTML Help viewer. </para>
9511
9512 </refsection>
9513 </refentry>
9514
9515 <refentry version="5.0" id="htmlhelp.hhc.show.root">
9516 <refmeta>
9517 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
9518 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9519 </refmeta>
9520 <refnamediv>
9521 <refname>htmlhelp.hhc.show.root</refname>
9522 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
9523 </refnamediv>
9524
9525 <refsynopsisdiv>
9526 <programlisting id="htmlhelp.hhc.show.root.frag">
9527 &lt;xsl:param name="htmlhelp.hhc.show.root" select="1"&gt;&lt;/xsl:param&gt;
9528 </programlisting>
9529 </refsynopsisdiv>
9530
9531 <refsection><info><title>Description</title></info>
9532
9533 <para>If set to zero, there will be no entry for the root element in the 
9534 ToC. This is useful when you want to provide the user with an expanded
9535 ToC as a default.</para>
9536
9537 </refsection>
9538 </refentry>
9539
9540 <refentry version="5.0" id="htmlhelp.hhc.folders.instead.books">
9541 <refmeta>
9542 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
9543 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9544 </refmeta>
9545 <refnamediv>
9546 <refname>htmlhelp.hhc.folders.instead.books</refname>
9547 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
9548 </refnamediv>
9549
9550 <refsynopsisdiv>
9551 <programlisting id="htmlhelp.hhc.folders.instead.books.frag">
9552 &lt;xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"&gt;&lt;/xsl:param&gt;
9553 </programlisting>
9554 </refsynopsisdiv>
9555
9556 <refsection><info><title>Description</title></info>
9557
9558 <para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC. 
9559 If you want to use folder-like icons, you must switch off the binary ToC using 
9560 <parameter>htmlhelp.hhc.binary</parameter>.
9561
9562 </para>
9563
9564 </refsection>
9565 </refentry>
9566
9567 <refentry version="5.0" id="htmlhelp.hhc.binary">
9568 <refmeta>
9569 <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
9570 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9571 </refmeta>
9572 <refnamediv>
9573 <refname>htmlhelp.hhc.binary</refname>
9574 <refpurpose>Generate binary ToC?</refpurpose>
9575 </refnamediv>
9576
9577 <refsynopsisdiv>
9578 <programlisting id="htmlhelp.hhc.binary.frag">
9579 &lt;xsl:param name="htmlhelp.hhc.binary" select="1"&gt;&lt;/xsl:param&gt;
9580 </programlisting>
9581 </refsynopsisdiv>
9582
9583 <refsection><info><title>Description</title></info>
9584
9585 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
9586 if you want to add Prev/Next buttons to toolbar (which is default
9587 behaviour). Files with binary TOC can't be merged.</para>
9588
9589 </refsection>
9590 </refentry>
9591
9592 <refentry version="5.0" id="htmlhelp.hhc.width">
9593 <refmeta>
9594 <refentrytitle>htmlhelp.hhc.width</refentrytitle>
9595 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9596 </refmeta>
9597 <refnamediv>
9598 <refname>htmlhelp.hhc.width</refname>
9599 <refpurpose>Width of navigation pane</refpurpose>
9600 </refnamediv>
9601
9602 <refsynopsisdiv>
9603 <programlisting id="htmlhelp.hhc.width.frag">
9604 &lt;xsl:param name="htmlhelp.hhc.width"&gt;&lt;/xsl:param&gt;
9605 </programlisting>
9606 </refsynopsisdiv>
9607
9608 <refsection><info><title>Description</title></info>
9609
9610 <para>This parameter specifies the width of the navigation pane (containing TOC and
9611 other navigation tabs) in pixels.</para>
9612
9613 </refsection>
9614 </refentry>
9615
9616 <refentry version="5.0" id="htmlhelp.title">
9617 <refmeta>
9618 <refentrytitle>htmlhelp.title</refentrytitle>
9619 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9620 </refmeta>
9621 <refnamediv>
9622 <refname>htmlhelp.title</refname>
9623 <refpurpose>Title of HTML Help</refpurpose>
9624 </refnamediv>
9625
9626 <refsynopsisdiv>
9627 <programlisting id="htmlhelp.title.frag">
9628 &lt;xsl:param name="htmlhelp.title"&gt;&lt;/xsl:param&gt;
9629 </programlisting>
9630 </refsynopsisdiv>
9631
9632 <refsection><info><title>Description</title></info>
9633
9634 <para>Content of this parameter will be used as a title for generated
9635 HTML Help. If empty, title will be automatically taken from document.</para>
9636
9637 </refsection>
9638 </refentry>
9639
9640 <refentry version="5.0" id="htmlhelp.show.menu">
9641 <refmeta>
9642 <refentrytitle>htmlhelp.show.menu</refentrytitle>
9643 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9644 </refmeta>
9645 <refnamediv>
9646 <refname>htmlhelp.show.menu</refname>
9647 <refpurpose>Should the menu bar be shown?</refpurpose>
9648 </refnamediv>
9649
9650 <refsynopsisdiv>
9651 <programlisting id="htmlhelp.show.menu.frag">
9652 &lt;xsl:param name="htmlhelp.show.menu" select="0"&gt;&lt;/xsl:param&gt;
9653 </programlisting>
9654 </refsynopsisdiv>
9655
9656 <refsection><info><title>Description</title></info>
9657
9658 <para>Set to non-zero to have an application menu bar in your HTML Help window.
9659 </para>
9660
9661 </refsection>
9662 </refentry>
9663
9664 <refentry version="5.0" id="htmlhelp.show.toolbar.text">
9665 <refmeta>
9666 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
9667 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9668 </refmeta>
9669 <refnamediv>
9670 <refname>htmlhelp.show.toolbar.text</refname>
9671 <refpurpose>Show text under toolbar buttons?</refpurpose>
9672 </refnamediv>
9673
9674 <refsynopsisdiv>
9675 <programlisting id="htmlhelp.show.toolbar.text.frag">
9676 &lt;xsl:param name="htmlhelp.show.toolbar.text" select="1"&gt;&lt;/xsl:param&gt;
9677 </programlisting>
9678 </refsynopsisdiv>
9679
9680 <refsection><info><title>Description</title></info>
9681
9682 <para>Set to non-zero to display texts under toolbar buttons, zero to switch
9683 off displays.</para>
9684
9685 </refsection>
9686 </refentry>
9687
9688 <refentry version="5.0" id="htmlhelp.show.advanced.search">
9689 <refmeta>
9690 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
9691 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9692 </refmeta>
9693 <refnamediv>
9694 <refname>htmlhelp.show.advanced.search</refname>
9695 <refpurpose>Should advanced search features be available?</refpurpose>
9696 </refnamediv>
9697
9698 <refsynopsisdiv>
9699 <programlisting id="htmlhelp.show.advanced.search.frag">
9700 &lt;xsl:param name="htmlhelp.show.advanced.search" select="0"&gt;&lt;/xsl:param&gt;
9701 </programlisting>
9702 </refsynopsisdiv>
9703
9704 <refsection><info><title>Description</title></info>
9705
9706 <para>If you want advanced search features in your help, turn this
9707 parameter to 1.</para>
9708
9709 </refsection>
9710 </refentry>
9711
9712 <refentry version="5.0" id="htmlhelp.show.favorities">
9713 <refmeta>
9714 <refentrytitle>htmlhelp.show.favorities</refentrytitle>
9715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9716 </refmeta>
9717 <refnamediv>
9718 <refname>htmlhelp.show.favorities</refname>
9719 <refpurpose>Should the Favorites tab be shown?</refpurpose>
9720 </refnamediv>
9721
9722 <refsynopsisdiv>
9723 <programlisting id="htmlhelp.show.favorities.frag">
9724 &lt;xsl:param name="htmlhelp.show.favorities" select="0"&gt;&lt;/xsl:param&gt;
9725 </programlisting>
9726 </refsynopsisdiv>
9727
9728 <refsection><info><title>Description</title></info>
9729
9730 <para>Set to non-zero to include a Favorites tab in the navigation pane 
9731 of the help window.</para>
9732
9733 </refsection>
9734 </refentry>
9735
9736 <refentry version="5.0" id="htmlhelp.button.hideshow">
9737 <refmeta>
9738 <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
9739 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9740 </refmeta>
9741 <refnamediv>
9742 <refname>htmlhelp.button.hideshow</refname>
9743 <refpurpose>Should the Hide/Show button be shown?</refpurpose>
9744 </refnamediv>
9745
9746 <refsynopsisdiv>
9747 <programlisting id="htmlhelp.button.hideshow.frag">
9748 &lt;xsl:param name="htmlhelp.button.hideshow" select="1"&gt;&lt;/xsl:param&gt;
9749 </programlisting>
9750 </refsynopsisdiv>
9751
9752 <refsection><info><title>Description</title></info>
9753
9754 <para>Set to non-zero to include the  Hide/Show button shown on toolbar</para>
9755
9756 </refsection>
9757 </refentry>
9758
9759 <refentry version="5.0" id="htmlhelp.button.back">
9760 <refmeta>
9761 <refentrytitle>htmlhelp.button.back</refentrytitle>
9762 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9763 </refmeta>
9764 <refnamediv>
9765 <refname>htmlhelp.button.back</refname>
9766 <refpurpose>Should the Back button be shown?</refpurpose>
9767 </refnamediv>
9768
9769 <refsynopsisdiv>
9770 <programlisting id="htmlhelp.button.back.frag">
9771 &lt;xsl:param name="htmlhelp.button.back" select="1"&gt;&lt;/xsl:param&gt;
9772 </programlisting>
9773 </refsynopsisdiv>
9774
9775 <refsection><info><title>Description</title></info>
9776
9777 <para>Set to non-zero to include the  Hide/Show button shown on toolbar</para>
9778
9779 </refsection>
9780 </refentry>
9781
9782 <refentry version="5.0" id="htmlhelp.button.forward">
9783 <refmeta>
9784 <refentrytitle>htmlhelp.button.forward</refentrytitle>
9785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9786 </refmeta>
9787 <refnamediv>
9788 <refname>htmlhelp.button.forward</refname>
9789 <refpurpose>Should the Forward button be shown?</refpurpose>
9790 </refnamediv>
9791
9792 <refsynopsisdiv>
9793 <programlisting id="htmlhelp.button.forward.frag">
9794 &lt;xsl:param name="htmlhelp.button.forward" select="0"&gt;&lt;/xsl:param&gt;
9795 </programlisting>
9796 </refsynopsisdiv>
9797
9798 <refsection><info><title>Description</title></info>
9799
9800 <para>Set to non-zero to include the  Forward button  on the toolbar.</para>
9801
9802 </refsection>
9803 </refentry>
9804
9805 <refentry version="5.0" id="htmlhelp.button.stop">
9806 <refmeta>
9807 <refentrytitle>htmlhelp.button.stop</refentrytitle>
9808 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9809 </refmeta>
9810 <refnamediv>
9811 <refname>htmlhelp.button.stop</refname>
9812 <refpurpose>Should the Stop button be shown?</refpurpose>
9813 </refnamediv>
9814
9815 <refsynopsisdiv>
9816 <programlisting id="htmlhelp.button.stop.frag">
9817 &lt;xsl:param name="htmlhelp.button.stop" select="0"&gt;&lt;/xsl:param&gt;
9818 </programlisting>
9819 </refsynopsisdiv>
9820
9821 <refsection><info><title>Description</title></info>
9822
9823 <para>If you want Stop button shown on toolbar, turn this
9824 parameter to 1.</para>
9825
9826 </refsection>
9827 </refentry>
9828
9829 <refentry version="5.0" id="htmlhelp.button.refresh">
9830 <refmeta>
9831 <refentrytitle>htmlhelp.button.refresh</refentrytitle>
9832 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9833 </refmeta>
9834 <refnamediv>
9835 <refname>htmlhelp.button.refresh</refname>
9836 <refpurpose>Should the Refresh button be shown?</refpurpose>
9837 </refnamediv>
9838
9839 <refsynopsisdiv>
9840 <programlisting id="htmlhelp.button.refresh.frag">
9841 &lt;xsl:param name="htmlhelp.button.refresh" select="0"&gt;&lt;/xsl:param&gt;
9842 </programlisting>
9843 </refsynopsisdiv>
9844
9845 <refsection><info><title>Description</title></info>
9846
9847 <para>Set to non-zero to include the Stop button  on the toolbar.</para>
9848
9849 </refsection>
9850 </refentry>
9851
9852 <refentry version="5.0" id="htmlhelp.button.home">
9853 <refmeta>
9854 <refentrytitle>htmlhelp.button.home</refentrytitle>
9855 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9856 </refmeta>
9857 <refnamediv>
9858 <refname>htmlhelp.button.home</refname>
9859 <refpurpose>Should the Home button be shown?</refpurpose>
9860 </refnamediv>
9861
9862 <refsynopsisdiv>
9863 <programlisting id="htmlhelp.button.home.frag">
9864 &lt;xsl:param name="htmlhelp.button.home" select="0"&gt;&lt;/xsl:param&gt;
9865 </programlisting>
9866 </refsynopsisdiv>
9867
9868 <refsection><info><title>Description</title></info>
9869
9870 <para>Set to non-zero to include the Home button  on the toolbar.</para>
9871
9872 </refsection>
9873 </refentry>
9874
9875 <refentry version="5.0" id="htmlhelp.button.home.url">
9876 <refmeta>
9877 <refentrytitle>htmlhelp.button.home.url</refentrytitle>
9878 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9879 </refmeta>
9880 <refnamediv>
9881 <refname>htmlhelp.button.home.url</refname>
9882 <refpurpose>URL address of page accessible by Home button</refpurpose>
9883 </refnamediv>
9884
9885 <refsynopsisdiv>
9886 <programlisting id="htmlhelp.button.home.url.frag">
9887 &lt;xsl:param name="htmlhelp.button.home.url"&gt;&lt;/xsl:param&gt;
9888 </programlisting>
9889 </refsynopsisdiv>
9890
9891 <refsection><info><title>Description</title></info>
9892
9893 <para>URL address of page accessible by Home button.</para>
9894
9895 </refsection>
9896 </refentry>
9897
9898 <refentry version="5.0" id="htmlhelp.button.options">
9899 <refmeta>
9900 <refentrytitle>htmlhelp.button.options</refentrytitle>
9901 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9902 </refmeta>
9903 <refnamediv>
9904 <refname>htmlhelp.button.options</refname>
9905 <refpurpose>Should the Options button be shown?</refpurpose>
9906 </refnamediv>
9907
9908 <refsynopsisdiv>
9909 <programlisting id="htmlhelp.button.options.frag">
9910 &lt;xsl:param name="htmlhelp.button.options" select="1"&gt;&lt;/xsl:param&gt;
9911 </programlisting>
9912 </refsynopsisdiv>
9913
9914 <refsection><info><title>Description</title></info>
9915
9916 <para>If you want Options button shown on toolbar, turn this
9917 parameter to 1.</para>
9918
9919 </refsection>
9920 </refentry>
9921
9922 <refentry version="5.0" id="htmlhelp.button.print">
9923 <refmeta>
9924 <refentrytitle>htmlhelp.button.print</refentrytitle>
9925 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9926 </refmeta>
9927 <refnamediv>
9928 <refname>htmlhelp.button.print</refname>
9929 <refpurpose>Should the Print button be shown?</refpurpose>
9930 </refnamediv>
9931
9932 <refsynopsisdiv>
9933 <programlisting id="htmlhelp.button.print.frag">
9934 &lt;xsl:param name="htmlhelp.button.print" select="1"&gt;&lt;/xsl:param&gt;
9935 </programlisting>
9936 </refsynopsisdiv>
9937
9938 <refsection><info><title>Description</title></info>
9939
9940 <para>Set to non-zero to include the Print button  on the toolbar.
9941 </para>
9942
9943 </refsection>
9944 </refentry>
9945
9946 <refentry version="5.0" id="htmlhelp.button.locate">
9947 <refmeta>
9948 <refentrytitle>htmlhelp.button.locate</refentrytitle>
9949 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9950 </refmeta>
9951 <refnamediv>
9952 <refname>htmlhelp.button.locate</refname>
9953 <refpurpose>Should the Locate button be shown?</refpurpose>
9954 </refnamediv>
9955
9956 <refsynopsisdiv>
9957 <programlisting id="htmlhelp.button.locate.frag">
9958 &lt;xsl:param name="htmlhelp.button.locate" select="0"&gt;&lt;/xsl:param&gt;
9959 </programlisting>
9960 </refsynopsisdiv>
9961
9962 <refsection><info><title>Description</title></info>
9963
9964 <para>If you want Locate button shown on toolbar, turn this
9965 parameter to 1.</para>
9966
9967 </refsection>
9968 </refentry>
9969
9970 <refentry version="5.0" id="htmlhelp.button.jump1">
9971 <refmeta>
9972 <refentrytitle>htmlhelp.button.jump1</refentrytitle>
9973 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9974 </refmeta>
9975 <refnamediv>
9976 <refname>htmlhelp.button.jump1</refname>
9977 <refpurpose>Should the Jump1 button be shown?</refpurpose>
9978 </refnamediv>
9979 <refsynopsisdiv>
9980 <programlisting id="htmlhelp.button.jump1.frag">
9981 &lt;xsl:param name="htmlhelp.button.jump1" select="0"&gt;&lt;/xsl:param&gt;
9982 </programlisting>
9983 </refsynopsisdiv>
9984 <refsection><info><title>Description</title></info>
9985   <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
9986 </refsection>
9987 </refentry>
9988
9989 <refentry version="5.0" id="htmlhelp.button.jump1.url">
9990 <refmeta>
9991 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
9992 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9993 </refmeta>
9994 <refnamediv>
9995 <refname>htmlhelp.button.jump1.url</refname>
9996 <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
9997 </refnamediv>
9998
9999 <refsynopsisdiv>
10000 <programlisting id="htmlhelp.button.jump1.url.frag">
10001 &lt;xsl:param name="htmlhelp.button.jump1.url"&gt;&lt;/xsl:param&gt;
10002 </programlisting>
10003 </refsynopsisdiv>
10004
10005 <refsection><info><title>Description</title></info>
10006
10007 <para>URL address of page accessible by Jump1 button.</para>
10008
10009 </refsection>
10010 </refentry>
10011
10012 <refentry version="5.0" id="htmlhelp.button.jump1.title">
10013 <refmeta>
10014 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
10015 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10016 </refmeta>
10017 <refnamediv>
10018 <refname>htmlhelp.button.jump1.title</refname>
10019 <refpurpose>Title of Jump1 button</refpurpose>
10020 </refnamediv>
10021
10022 <refsynopsisdiv>
10023 <programlisting id="htmlhelp.button.jump1.title.frag">
10024 &lt;xsl:param name="htmlhelp.button.jump1.title"&gt;User1&lt;/xsl:param&gt;
10025 </programlisting>
10026 </refsynopsisdiv>
10027
10028 <refsection><info><title>Description</title></info>
10029
10030 <para>Title of Jump1 button.</para>
10031
10032 </refsection>
10033 </refentry>
10034
10035 <refentry version="5.0" id="htmlhelp.button.jump2">
10036 <refmeta>
10037 <refentrytitle>htmlhelp.button.jump2</refentrytitle>
10038 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10039 </refmeta>
10040 <refnamediv>
10041 <refname>htmlhelp.button.jump2</refname>
10042 <refpurpose>Should the Jump2 button be shown?</refpurpose>
10043 </refnamediv>
10044
10045 <refsynopsisdiv>
10046 <programlisting id="htmlhelp.button.jump2.frag">
10047 &lt;xsl:param name="htmlhelp.button.jump2" select="0"&gt;&lt;/xsl:param&gt;
10048 </programlisting>
10049 </refsynopsisdiv>
10050
10051 <refsection><info><title>Description</title></info>
10052
10053 <para>Set to non-zero to include the Jump2 button  on the toolbar.</para>
10054
10055 </refsection>
10056 </refentry>
10057
10058 <refentry version="5.0" id="htmlhelp.button.jump2.url">
10059 <refmeta>
10060 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
10061 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10062 </refmeta>
10063 <refnamediv>
10064 <refname>htmlhelp.button.jump2.url</refname>
10065 <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
10066 </refnamediv>
10067
10068 <refsynopsisdiv>
10069 <programlisting id="htmlhelp.button.jump2.url.frag">
10070 &lt;xsl:param name="htmlhelp.button.jump2.url"&gt;&lt;/xsl:param&gt;
10071 </programlisting>
10072 </refsynopsisdiv>
10073
10074 <refsection><info><title>Description</title></info>
10075
10076 <para>URL address of page accessible by Jump2 button.</para>
10077
10078 </refsection>
10079 </refentry>
10080
10081 <refentry version="5.0" id="htmlhelp.button.jump2.title">
10082 <refmeta>
10083 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
10084 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10085 </refmeta>
10086 <refnamediv>
10087 <refname>htmlhelp.button.jump2.title</refname>
10088 <refpurpose>Title of Jump2 button</refpurpose>
10089 </refnamediv>
10090
10091 <refsynopsisdiv>
10092 <programlisting id="htmlhelp.button.jump2.title.frag">
10093 &lt;xsl:param name="htmlhelp.button.jump2.title"&gt;User2&lt;/xsl:param&gt;
10094 </programlisting>
10095 </refsynopsisdiv>
10096
10097 <refsection><info><title>Description</title></info>
10098
10099 <para>Title of Jump2 button.</para>
10100
10101 </refsection>
10102 </refentry>
10103
10104 <refentry version="5.0" id="htmlhelp.button.next">
10105 <refmeta>
10106 <refentrytitle>htmlhelp.button.next</refentrytitle>
10107 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10108 </refmeta>
10109 <refnamediv>
10110 <refname>htmlhelp.button.next</refname>
10111 <refpurpose>Should the Next button be shown?</refpurpose>
10112 </refnamediv>
10113
10114 <refsynopsisdiv>
10115 <programlisting id="htmlhelp.button.next.frag">
10116 &lt;xsl:param name="htmlhelp.button.next" select="1"&gt;&lt;/xsl:param&gt;
10117 </programlisting>
10118 </refsynopsisdiv>
10119
10120 <refsection><info><title>Description</title></info>
10121
10122 <para>Set to non-zero to include the Next button  on the toolbar.</para>
10123
10124 </refsection>
10125 </refentry>
10126
10127 <refentry version="5.0" id="htmlhelp.button.prev">
10128 <refmeta>
10129 <refentrytitle>htmlhelp.button.prev</refentrytitle>
10130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10131 </refmeta>
10132 <refnamediv>
10133 <refname>htmlhelp.button.prev</refname>
10134 <refpurpose>Should the Prev button be shown?</refpurpose>
10135 </refnamediv>
10136
10137 <refsynopsisdiv>
10138 <programlisting id="htmlhelp.button.prev.frag">
10139 &lt;xsl:param name="htmlhelp.button.prev" select="1"&gt;&lt;/xsl:param&gt;
10140 </programlisting>
10141 </refsynopsisdiv>
10142
10143 <refsection><info><title>Description</title></info>
10144
10145 <para>Set to non-zero to include the Prev button  on the toolbar.
10146 </para>
10147
10148 </refsection>
10149 </refentry>
10150
10151 <refentry version="5.0" id="htmlhelp.button.zoom">
10152 <refmeta>
10153 <refentrytitle>htmlhelp.button.zoom</refentrytitle>
10154 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10155 </refmeta>
10156 <refnamediv>
10157 <refname>htmlhelp.button.zoom</refname>
10158 <refpurpose>Should the Zoom button be shown?</refpurpose>
10159 </refnamediv>
10160
10161 <refsynopsisdiv>
10162 <programlisting id="htmlhelp.button.zoom.frag">
10163 &lt;xsl:param name="htmlhelp.button.zoom" select="0"&gt;&lt;/xsl:param&gt;
10164 </programlisting>
10165 </refsynopsisdiv>
10166
10167 <refsection><info><title>Description</title></info>
10168
10169 <para>Set to non-zero to include the Zoom button  on the toolbar.
10170 </para>
10171
10172 </refsection>
10173 </refentry>
10174
10175 <refentry version="5.0" id="htmlhelp.remember.window.position">
10176 <refmeta>
10177 <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
10178 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10179 </refmeta>
10180 <refnamediv>
10181 <refname>htmlhelp.remember.window.position</refname>
10182 <refpurpose>Remember help window position?</refpurpose>
10183 </refnamediv>
10184
10185 <refsynopsisdiv>
10186 <programlisting id="htmlhelp.remember.window.position.frag">
10187 &lt;xsl:param name="htmlhelp.remember.window.position" select="0"&gt;&lt;/xsl:param&gt;
10188 </programlisting>
10189 </refsynopsisdiv>
10190
10191 <refsection><info><title>Description</title></info>
10192
10193 <para>Set to non-zero to remember help window position between starts.</para>
10194
10195 </refsection>
10196 </refentry>
10197
10198 <refentry version="5.0" id="htmlhelp.window.geometry">
10199 <refmeta>
10200 <refentrytitle>htmlhelp.window.geometry</refentrytitle>
10201 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10202 </refmeta>
10203 <refnamediv>
10204 <refname>htmlhelp.window.geometry</refname>
10205 <refpurpose>Set initial geometry of help window</refpurpose>
10206 </refnamediv>
10207
10208 <refsynopsisdiv>
10209 <programlisting id="htmlhelp.window.geometry.frag">
10210 &lt;xsl:param name="htmlhelp.window.geometry"&gt;&lt;/xsl:param&gt;
10211 </programlisting>
10212 </refsynopsisdiv>
10213
10214 <refsection><info><title>Description</title></info>
10215
10216 <para>This parameter specifies initial position of help
10217 window. E.g.</para>
10218
10219 <programlisting>&lt;xsl:param name="htmlhelp.window.geometry"&gt;[160,64,992,704]&lt;/xsl:param&gt;</programlisting>
10220
10221 </refsection>
10222 </refentry>
10223
10224 <refentry version="5.0" id="htmlhelp.use.hhk">
10225 <refmeta>
10226 <refentrytitle>htmlhelp.use.hhk</refentrytitle>
10227 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10228 </refmeta>
10229 <refnamediv>
10230 <refname>htmlhelp.use.hhk</refname>
10231 <refpurpose>Should the index be built using the HHK file?</refpurpose>
10232 </refnamediv>
10233
10234 <refsynopsisdiv>
10235 <programlisting id="htmlhelp.use.hhk.frag">
10236 &lt;xsl:param name="htmlhelp.use.hhk" select="0"&gt;&lt;/xsl:param&gt;
10237 </programlisting>
10238 </refsynopsisdiv>
10239
10240 <refsection><info><title>Description</title></info>
10241
10242 <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
10243 elements in the HTML files). For more information, see <link role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
10244 </refsection>
10245 </refentry>
10246
10247 <refentry version="5.0" id="htmlhelp.only">
10248 <refmeta>
10249 <refentrytitle>htmlhelp.only</refentrytitle>
10250 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10251 </refmeta>
10252 <refnamediv>
10253 <refname>htmlhelp.only</refname>
10254 <refpurpose>Should only project files be generated?</refpurpose>
10255 </refnamediv>
10256
10257 <refsynopsisdiv>
10258 <programlisting id="htmlhelp.only.frag">
10259 &lt;xsl:param name="htmlhelp.only" select="0"&gt;&lt;/xsl:param&gt;
10260 </programlisting>
10261 </refsynopsisdiv>
10262
10263 <refsection><info><title>Description</title></info>
10264
10265
10266 <para>Set to non-zero if you want to play with various HTML Help parameters
10267 and you don't need to regenerate all HTML files. This setting will not
10268 process whole document, only project files (hhp, hhc, hhk,...) will be
10269 generated.</para>
10270
10271
10272 </refsection>
10273 </refentry>
10274
10275 </reference><reference id="eclipse_help" xml:base="../html/param.xml"><title>Eclipse Help Platform</title>
10276 <refentry version="5.0" id="eclipse.autolabel">
10277 <refmeta>
10278 <refentrytitle>eclipse.autolabel</refentrytitle>
10279 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10280 </refmeta>
10281 <refnamediv>
10282 <refname>eclipse.autolabel</refname>
10283 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
10284 </refnamediv>
10285
10286 <refsynopsisdiv>
10287 <programlisting id="eclipse.autolabel.frag">
10288 &lt;xsl:param name="eclipse.autolabel" select="0"&gt;&lt;/xsl:param&gt;
10289 </programlisting>
10290 </refsynopsisdiv>
10291
10292 <refsection><info><title>Description</title></info>
10293
10294 <para>If you want to include chapter and section numbers into ToC in
10295 the left panel, set this parameter to 1.</para>
10296
10297 </refsection>
10298 </refentry>
10299
10300 <refentry version="5.0" id="eclipse.plugin.name">
10301 <refmeta>
10302 <refentrytitle>eclipse.plugin.name</refentrytitle>
10303 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10304 </refmeta>
10305 <refnamediv>
10306 <refname>eclipse.plugin.name</refname>
10307 <refpurpose>Eclipse Help plugin name</refpurpose>
10308 </refnamediv>
10309
10310 <refsynopsisdiv>
10311 <programlisting id="eclipse.plugin.name.frag">
10312 &lt;xsl:param name="eclipse.plugin.name"&gt;DocBook Online Help Sample&lt;/xsl:param&gt;
10313 </programlisting>
10314 </refsynopsisdiv>
10315
10316 <refsection><info><title>Description</title></info>
10317
10318 <para>Eclipse Help plugin name.</para>
10319
10320 </refsection>
10321 </refentry>
10322
10323 <refentry version="5.0" id="eclipse.plugin.id">
10324 <refmeta>
10325 <refentrytitle>eclipse.plugin.id</refentrytitle>
10326 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10327 </refmeta>
10328 <refnamediv>
10329 <refname>eclipse.plugin.id</refname>
10330 <refpurpose>Eclipse Help plugin id</refpurpose>
10331 </refnamediv>
10332
10333 <refsynopsisdiv>
10334 <programlisting id="eclipse.plugin.id.frag">
10335 &lt;xsl:param name="eclipse.plugin.id"&gt;com.example.help&lt;/xsl:param&gt;
10336 </programlisting>
10337 </refsynopsisdiv>
10338
10339 <refsection><info><title>Description</title></info>
10340
10341 <para>Eclipse Help plugin id. You should change this id to something
10342 unique for each help.</para>
10343
10344 </refsection>
10345 </refentry>
10346
10347 <refentry version="5.0" id="eclipse.plugin.provider">
10348 <refmeta>
10349 <refentrytitle>eclipse.plugin.provider</refentrytitle>
10350 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10351 </refmeta>
10352 <refnamediv>
10353 <refname>eclipse.plugin.provider</refname>
10354 <refpurpose>Eclipse Help plugin provider name</refpurpose>
10355 </refnamediv>
10356
10357 <refsynopsisdiv>
10358 <programlisting id="eclipse.plugin.provider.frag">
10359 &lt;xsl:param name="eclipse.plugin.provider"&gt;Example provider&lt;/xsl:param&gt;
10360 </programlisting>
10361 </refsynopsisdiv>
10362
10363 <refsection><info><title>Description</title></info>
10364
10365 <para>Eclipse Help plugin provider name.</para>
10366
10367 </refsection>
10368 </refentry>
10369
10370 </reference><reference id="javahelp" xml:base="../html/param.xml"><title>JavaHelp</title>
10371 <refentry version="5.0" id="javahelp.encoding">
10372 <refmeta>
10373 <refentrytitle>javahelp.encoding</refentrytitle>
10374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10375 </refmeta>
10376 <refnamediv>
10377 <refname>javahelp.encoding</refname>
10378 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
10379 </refnamediv>
10380
10381 <refsynopsisdiv>
10382 <programlisting id="javahelp.encoding.frag">
10383 &lt;xsl:param name="javahelp.encoding"&gt;iso-8859-1&lt;/xsl:param&gt;
10384 </programlisting>
10385 </refsynopsisdiv>
10386
10387 <refsection><info><title>Description</title></info>
10388   
10389 <para>JavaHelp crashes on some characters when written as character
10390 references. In that case you can use this parameter to select an appropriate encoding.</para>
10391   
10392 </refsection>
10393 </refentry>
10394
10395
10396
10397
10398 </reference><reference id="l10n" xml:base="../html/param.xml"><title>Localization</title>
10399 <refentry version="5.0" id="l10n.gentext.language">
10400 <refmeta>
10401 <refentrytitle>l10n.gentext.language</refentrytitle>
10402 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10403 </refmeta>
10404 <refnamediv>
10405 <refname>l10n.gentext.language</refname>
10406 <refpurpose>Sets the gentext language</refpurpose>
10407 </refnamediv>
10408
10409 <refsynopsisdiv>
10410 <programlisting id="l10n.gentext.language.frag">
10411 &lt;xsl:param name="l10n.gentext.language"&gt;&lt;/xsl:param&gt;
10412 </programlisting>
10413 </refsynopsisdiv>
10414
10415 <refsection><info><title>Description</title></info>
10416
10417 <para>If this parameter is set to any value other than the empty string, its
10418 value will be used as the value for the language when generating text. Setting
10419 <parameter>l10n.gentext.language</parameter> overrides any settings within the
10420 document being formatted.</para>
10421
10422 <para>It's much more likely that you might want to set the
10423 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
10424
10425 </refsection>
10426 </refentry>
10427
10428 <refentry version="5.0" id="l10n.gentext.default.language">
10429   <refmeta>
10430     <refentrytitle>l10n.gentext.default.language</refentrytitle>
10431     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10432   </refmeta>
10433   <refnamediv>
10434     <refname>l10n.gentext.default.language</refname>
10435     <refpurpose>Sets the default language for generated text</refpurpose>
10436   </refnamediv>
10437
10438   <refsynopsisdiv>
10439 <programlisting id="l10n.gentext.default.language.frag">
10440 &lt;xsl:param name="l10n.gentext.default.language"&gt;en&lt;/xsl:param&gt;
10441 </programlisting>
10442 </refsynopsisdiv>
10443
10444 <refsection><info><title>Description</title></info>
10445
10446 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
10447 parameter is used as the language for generated text if no setting is provided
10448 in the source document.</para>
10449
10450 </refsection>
10451 </refentry>
10452
10453 <refentry version="5.0" id="l10n.gentext.use.xref.language">
10454 <refmeta>
10455 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
10456 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10457 </refmeta>
10458 <refnamediv>
10459 <refname>l10n.gentext.use.xref.language</refname>
10460 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
10461 </refnamediv>
10462
10463 <refsynopsisdiv>
10464 <programlisting id="l10n.gentext.use.xref.language.frag">
10465 &lt;xsl:param name="l10n.gentext.use.xref.language" select="0"&gt;&lt;/xsl:param&gt;
10466 </programlisting>
10467 </refsynopsisdiv>
10468
10469 <refsection><info><title>Description</title></info>
10470
10471 <para>If non-zero, the language of the target will be used when
10472 generating cross reference text. Usually, the <quote>current</quote>
10473 language is used when generating text (that is, the language of the
10474 element that contains the cross-reference element). But setting this parameter
10475 allows the language of the element <emphasis>pointed to</emphasis> to control
10476 the generated text.</para>
10477
10478 <para>Consider the following example:</para>
10479
10480 <informalexample>
10481 <programlisting>&lt;para lang="en"&gt;See also &lt;xref linkend="chap3"/&gt;.&lt;/para&gt;
10482 </programlisting>
10483 </informalexample>
10484
10485 <para>Suppose that Chapter 3 happens to be written in German.
10486 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
10487 resulting text will be something like this:</para>
10488
10489 <blockquote>
10490 <para>See also Kapital 3.</para>
10491 </blockquote>
10492
10493 <para>Where the more traditional rendering would be:</para>
10494
10495 <blockquote>
10496 <para>See also Chapter 3.</para>
10497 </blockquote>
10498
10499 </refsection>
10500 </refentry>
10501
10502 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
10503 <refmeta>
10504 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
10505 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10506 </refmeta>
10507 <refnamediv>
10508 <refname>l10n.lang.value.rfc.compliant</refname>
10509 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
10510 </refnamediv>
10511
10512 <refsynopsisdiv>
10513 <programlisting id="l10n.lang.value.rfc.compliant.frag">
10514 &lt;xsl:param name="l10n.lang.value.rfc.compliant" select="1"&gt;&lt;/xsl:param&gt;
10515 </programlisting>
10516 </refsynopsisdiv>
10517
10518 <refsection><info><title>Description</title></info>
10519
10520 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
10521 compliant<footnote><para>Section 8.1.1, <link xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that:
10522
10523 <blockquote><para>[RFC1766] defines and explains the language codes
10524 that must be used in HTML documents.</para>
10525 <para>Briefly, language codes consist of a primary code and a possibly
10526 empty series of subcodes:
10527
10528 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
10529 </para>
10530 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
10531 of Languages</link>, the EBNF for "language tag" is given as:
10532
10533 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
10534 Primary-tag = 1*8ALPHA
10535 Subtag = 1*8ALPHA</literallayout>
10536 </para>
10537 </blockquote>
10538 </para></footnote>.
10539
10540 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
10541 replacing them with hyphen characters in output HTML files. For
10542 example, <literal>zh_CN</literal> in a source document becomes
10543 <literal>zh-CN</literal> in the HTML output form that source.
10544
10545 <note>
10546 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
10547 explicitly states that all "language tags" (as it calls them) "are
10548 to be treated as case insensitive".</para>
10549 </note>
10550 </para>
10551
10552 </refsection>
10553 </refentry>
10554
10555 <refentry version="5.0" id="writing.mode">
10556 <refmeta>
10557 <refentrytitle>writing.mode</refentrytitle>
10558 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10559 </refmeta>
10560 <refnamediv>
10561 <refname>writing.mode</refname>
10562 <refpurpose>Direction of text flow based on locale</refpurpose>
10563 </refnamediv>
10564
10565 <refsynopsisdiv>
10566 <programlisting id="writing.mode.frag">
10567 &lt;xsl:param name="writing.mode"&gt;
10568   &lt;xsl:call-template name="gentext"&gt;
10569     &lt;xsl:with-param name="key"&gt;writing-mode&lt;/xsl:with-param&gt;
10570     &lt;xsl:with-param name="lang"&gt;
10571       &lt;xsl:call-template name="l10n.language"&gt;
10572         &lt;xsl:with-param name="target" select="/*[1]"&gt;&lt;/xsl:with-param&gt;
10573       &lt;/xsl:call-template&gt;
10574     &lt;/xsl:with-param&gt;
10575   &lt;/xsl:call-template&gt;
10576 &lt;/xsl:param&gt;
10577 </programlisting>
10578 </refsynopsisdiv>
10579
10580 <refsection><info><title>Description</title></info>
10581
10582 <para>Sets direction of text flow and text alignment based on locale.
10583 The value is normally taken from the gentext file for the 
10584 lang attribute of the document's root element, using the 
10585 key name 'writing-mode' to look it up in the gentext file.
10586 But the param can also be
10587 set on the command line to override that gentext value.
10588 </para>
10589 <para>Accepted values are:
10590 <variablelist>
10591   <varlistentry>
10592     <term>lr-tb</term>
10593     <listitem>
10594       <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
10595     </listitem>
10596   </varlistentry>
10597   <varlistentry>
10598     <term>rl-tb</term>
10599     <listitem>
10600       <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
10601     </listitem>
10602   </varlistentry>
10603   <varlistentry>
10604     <term>tb-rl</term>
10605     <listitem>
10606       <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
10607       Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
10608     </listitem>
10609   </varlistentry>
10610   <varlistentry>
10611     <term>lr</term>
10612     <listitem>
10613       <para>Shorthand for lr-tb.</para>
10614     </listitem>
10615   </varlistentry>
10616   <varlistentry>
10617     <term>rl</term>
10618     <listitem>
10619       <para>Shorthand for rl-tb.</para>
10620     </listitem>
10621   </varlistentry>
10622   <varlistentry>
10623     <term>tb</term>
10624     <listitem>
10625       <para>Shorthand for tb-rl.</para>
10626     </listitem>
10627   </varlistentry>
10628 </variablelist>
10629 </para>
10630
10631 </refsection>
10632 </refentry>
10633
10634 </reference>
10635     </part>
10636     <part id="fo">
10637       <?dbhtml dir="fo"?>
10638       <?dbhtml filename="index.html"?>
10639       <title xml:base="../fo/param.xml">FO Parameter Reference</title>
10640       <partintro id="fointro">
10641         
10642   <para xml:base="../fo/param.xml">This is reference documentation for all user-configurable
10643   parameters in the DocBook XSL FO stylesheets (for generating
10644   XSL-FO output destined for final print/PDF output).</para>
10645
10646       </partintro>
10647       <reference id="admons" xml:base="../fo/param.xml"><title>Admonitions</title>
10648 <refentry version="5.0" id="admon.graphics">
10649 <refmeta>
10650 <refentrytitle>admon.graphics</refentrytitle>
10651 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10652 </refmeta>
10653 <refnamediv>
10654 <refname>admon.graphics</refname>
10655 <refpurpose>Use graphics in admonitions?</refpurpose>
10656 </refnamediv>
10657
10658 <refsynopsisdiv>
10659 <programlisting id="admon.graphics.frag">
10660 &lt;xsl:param name="admon.graphics" select="0"&gt;&lt;/xsl:param&gt;
10661 </programlisting>
10662 </refsynopsisdiv>
10663
10664 <refsection><info><title>Description</title></info>
10665
10666 <para>If true (non-zero), admonitions are presented in an alternate style that uses
10667 a graphic.  Default graphics are provided in the distribution.
10668 </para>
10669
10670 </refsection>
10671 </refentry>
10672
10673 <refentry version="5.0" id="admon.graphics.extension">
10674 <refmeta>
10675 <refentrytitle>admon.graphics.extension</refentrytitle>
10676 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10677 </refmeta>
10678 <refnamediv>
10679 <refname>admon.graphics.extension</refname>
10680 <refpurpose>Filename extension for admonition graphics</refpurpose>
10681 </refnamediv>
10682
10683 <refsynopsisdiv>
10684 <programlisting id="admon.graphics.extension.frag">
10685 &lt;xsl:param name="admon.graphics.extension"&gt;.png&lt;/xsl:param&gt;
10686 </programlisting>
10687 </refsynopsisdiv>
10688
10689 <refsection><info><title>Description</title></info>
10690
10691 <para>Sets the filename extension to use on admonition graphics.</para>
10692
10693 </refsection>
10694 </refentry>
10695
10696 <refentry version="5.0" id="admon.graphics.path">
10697 <refmeta>
10698 <refentrytitle>admon.graphics.path</refentrytitle>
10699 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10700 </refmeta>
10701 <refnamediv>
10702 <refname>admon.graphics.path</refname>
10703 <refpurpose>Path to admonition graphics</refpurpose>
10704 </refnamediv>
10705
10706 <refsynopsisdiv>
10707 <programlisting id="admon.graphics.path.frag">&lt;xsl:param name="admon.graphics.path"&gt;images/&lt;/xsl:param&gt;</programlisting>
10708 </refsynopsisdiv>
10709
10710 <refsection><info><title>Description</title></info>
10711
10712 <para>Sets the path to the directory containing the admonition graphics
10713 (caution.png, important.png etc). This location is normally relative
10714 to the output html directory. See <parameter>base.dir</parameter></para>
10715
10716 </refsection>
10717 </refentry>
10718
10719 <refentry version="5.0" id="admon.textlabel">
10720 <refmeta>
10721 <refentrytitle>admon.textlabel</refentrytitle>
10722 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10723 </refmeta>
10724 <refnamediv>
10725 <refname>admon.textlabel</refname>
10726 <refpurpose>Use text label in admonitions?</refpurpose>
10727 </refnamediv>
10728
10729 <refsynopsisdiv>
10730 <programlisting id="admon.textlabel.frag">
10731 &lt;xsl:param name="admon.textlabel" select="1"&gt;&lt;/xsl:param&gt;
10732 </programlisting>
10733 </refsynopsisdiv>
10734
10735 <refsection><info><title>Description</title></info>
10736
10737 <para>If true (non-zero), admonitions are presented with a generated
10738 text label such as Note or Warning in the appropriate language.
10739 If zero, such labels are turned off, but any title child
10740 of the admonition element are still output.
10741 The default value is 1.
10742 </para>
10743
10744 </refsection>
10745 </refentry>
10746
10747 <refentry version="5.0" id="admonition.title.properties">
10748
10749 <refmeta>
10750   <refentrytitle>admonition.title.properties</refentrytitle>
10751   <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10752 </refmeta>
10753 <refnamediv>
10754 <refname>admonition.title.properties</refname>
10755 <refpurpose>To set the style for admonitions titles.</refpurpose>
10756 </refnamediv>
10757
10758 <refsynopsisdiv>
10759 <programlisting id="admonition.title.properties.frag">
10760 &lt;xsl:attribute-set name="admonition.title.properties"&gt;
10761   &lt;xsl:attribute name="font-size"&gt;14pt&lt;/xsl:attribute&gt;
10762   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
10763   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
10764   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
10765 &lt;/xsl:attribute-set&gt;
10766 </programlisting>
10767 </refsynopsisdiv>
10768 <refsection><info><title>Description</title></info>
10769 <para>How do you want admonitions titles styled? </para>
10770 <para>Set the font-size, weight etc to the style required.</para>
10771
10772 </refsection>
10773 </refentry>
10774
10775 <refentry version="5.0" id="admonition.properties">
10776 <refmeta>
10777   <refentrytitle>admonition.properties</refentrytitle>
10778   <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10779 </refmeta>  
10780 <refnamediv>
10781 <refname>admonition.properties</refname>
10782 <refpurpose>To set the style for admonitions.</refpurpose>
10783 </refnamediv>
10784
10785 <refsynopsisdiv>
10786 <programlisting id="admonition.properties.frag">&lt;xsl:attribute-set name="admonition.properties"&gt;&lt;/xsl:attribute-set&gt;
10787 </programlisting>
10788 </refsynopsisdiv>
10789 <refsection><info><title>Description</title></info>
10790 <para>How do you want admonitions styled? </para>
10791 <para>Set the font-size, weight, etc. to the style required</para>
10792
10793 </refsection>
10794 </refentry>
10795
10796 <refentry version="5.0" id="graphical.admonition.properties">
10797 <refmeta>
10798 <refentrytitle>graphical.admonition.properties</refentrytitle>
10799 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10800 </refmeta>
10801 <refnamediv>
10802 <refname>graphical.admonition.properties</refname>
10803 <refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose>
10804 </refnamediv>
10805
10806 <refsynopsisdiv>
10807 <programlisting id="graphical.admonition.properties.frag">&lt;xsl:attribute-set name="graphical.admonition.properties"&gt;
10808   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
10809   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
10810   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
10811   &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
10812   &lt;xsl:attribute name="space-after.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
10813   &lt;xsl:attribute name="space-after.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
10814 &lt;/xsl:attribute-set&gt;
10815 </programlisting>
10816 </refsynopsisdiv>
10817 <refsection><info><title>Description</title></info>
10818 <para>These properties are added to the outer block containing the
10819 entire graphical admonition, including its title.
10820 It is used when the parameter
10821 <parameter>admon.graphics</parameter> is set to nonzero.
10822 Use this attribute-set to set the space above and below,
10823 and any indent for the whole admonition.</para>
10824
10825 <para>In addition to these properties, a graphical admonition
10826 also applies the <parameter>admonition.title.properties</parameter>
10827 attribute-set to the title, and applies the
10828 <parameter>admonition.properties</parameter> attribute-set
10829 to the rest of the content.</para>
10830
10831 </refsection>
10832 </refentry>
10833
10834 <refentry version="5.0" id="nongraphical.admonition.properties">
10835 <refmeta>
10836 <refentrytitle>nongraphical.admonition.properties</refentrytitle>
10837 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10838 </refmeta>
10839 <refnamediv>
10840 <refname>nongraphical.admonition.properties</refname>
10841 <refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose>
10842 </refnamediv>
10843
10844 <refsynopsisdiv>
10845 <programlisting id="nongraphical.admonition.properties.frag">&lt;xsl:attribute-set name="nongraphical.admonition.properties"&gt;
10846   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
10847   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
10848   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
10849   &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;0.25in&lt;/xsl:attribute&gt;
10850   &lt;xsl:attribute name="margin-{$direction.align.end}"&gt;0.25in&lt;/xsl:attribute&gt;
10851 &lt;/xsl:attribute-set&gt;
10852 </programlisting>
10853 </refsynopsisdiv>
10854 <refsection><info><title>Description</title></info>
10855 <para>These properties are added to the outer block containing the
10856 entire nongraphical admonition, including its title.
10857 It is used when the parameter
10858 <parameter>admon.graphics</parameter> is set to zero.
10859 Use this attribute-set to set the space above and below,
10860 and any indent for the whole admonition.</para>
10861
10862 <para>In addition to these properties, a nongraphical admonition
10863 also applies the <parameter>admonition.title.properties</parameter>
10864 attribute-set to the title, and the
10865 <parameter>admonition.properties</parameter> attribute-set
10866 to the rest of the content.</para>
10867
10868 </refsection>
10869 </refentry>
10870
10871 </reference><reference id="callouts" xml:base="../fo/param.xml"><title>Callouts</title>
10872 <refentry version="5.0" id="callout.defaultcolumn">
10873 <refmeta>
10874 <refentrytitle>callout.defaultcolumn</refentrytitle>
10875 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10876 </refmeta>
10877 <refnamediv>
10878 <refname>callout.defaultcolumn</refname>
10879 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
10880 </refnamediv>
10881
10882 <refsynopsisdiv>
10883 <programlisting id="callout.defaultcolumn.frag">
10884 &lt;xsl:param name="callout.defaultcolumn"&gt;60&lt;/xsl:param&gt;
10885 </programlisting>
10886 </refsynopsisdiv>
10887
10888 <refsection><info><title>Description</title></info>
10889
10890 <para>If a callout does not identify a column (for example, if it uses
10891 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
10892 it will appear in the default column.
10893 </para>
10894
10895 </refsection>
10896 </refentry>
10897
10898 <refentry version="5.0" id="callout.graphics">
10899 <refmeta>
10900 <refentrytitle>callout.graphics</refentrytitle>
10901 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10902 </refmeta>
10903 <refnamediv>
10904 <refname>callout.graphics</refname>
10905 <refpurpose>Use graphics for callouts?</refpurpose>
10906 </refnamediv>
10907
10908 <refsynopsisdiv>
10909 <programlisting id="callout.graphics.frag">
10910 &lt;xsl:param name="callout.graphics" select="1"&gt;&lt;/xsl:param&gt;
10911 </programlisting>
10912 </refsynopsisdiv>
10913
10914 <refsection><info><title>Description</title></info>
10915
10916 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
10917 circled numbers instead of "(1)", "(2)", etc.).
10918 Default graphics are provided in the distribution.
10919 </para>
10920
10921 </refsection>
10922 </refentry>
10923
10924 <refentry version="5.0" id="callout.graphics.extension">
10925 <refmeta>
10926 <refentrytitle>callout.graphics.extension</refentrytitle>
10927 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10928 </refmeta>
10929 <refnamediv>
10930 <refname>callout.graphics.extension</refname>
10931 <refpurpose>Filename extension for callout graphics</refpurpose>
10932 </refnamediv>
10933
10934 <refsynopsisdiv>
10935 <programlisting id="callout.graphics.extension.frag">
10936
10937 &lt;xsl:param name="callout.graphics.extension"&gt;.svg&lt;/xsl:param&gt;
10938 </programlisting>
10939 </refsynopsisdiv>
10940
10941 <refsection><info><title>Description</title></info>
10942 <para>Sets the filename extension to use on callout graphics. </para>
10943
10944 <itemizedlist>
10945 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
10946 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
10947 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
10948 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
10949 </itemizedlist>
10950 </refsection>
10951 </refentry>
10952
10953 <refentry version="5.0" id="callout.graphics.number.limit">
10954 <refmeta>
10955 <refentrytitle>callout.graphics.number.limit</refentrytitle>
10956 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10957 </refmeta>
10958 <refnamediv>
10959 <refname>callout.graphics.number.limit</refname>
10960 <refpurpose>Number of the largest callout graphic</refpurpose>
10961 </refnamediv>
10962
10963 <refsynopsisdiv>
10964 <programlisting id="callout.graphics.number.limit.frag">
10965
10966 &lt;xsl:param name="callout.graphics.number.limit"&gt;30&lt;/xsl:param&gt;
10967 </programlisting>
10968 </refsynopsisdiv>
10969
10970 <refsection><info><title>Description</title></info>
10971
10972 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
10973 are used to represent callout numbers instead of plain text. The value
10974 of <parameter>callout.graphics.number.limit</parameter> is the largest
10975 number for which a graphic exists. If the callout number exceeds this
10976 limit, the default presentation "(plain text instead of a graphic)"
10977 will  be used.
10978 </para>
10979
10980 </refsection>
10981 </refentry>
10982
10983 <refentry version="5.0" id="callout.graphics.path">
10984 <refmeta>
10985 <refentrytitle>callout.graphics.path</refentrytitle>
10986 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10987 </refmeta>
10988 <refnamediv>
10989 <refname>callout.graphics.path</refname>
10990 <refpurpose>Path to callout graphics</refpurpose>
10991 </refnamediv>
10992
10993 <refsynopsisdiv>
10994 <programlisting id="callout.graphics.path.frag">
10995 &lt;xsl:param name="callout.graphics.path"&gt;images/callouts/&lt;/xsl:param&gt;
10996 </programlisting>
10997 </refsynopsisdiv>
10998
10999 <refsection><info><title>Description</title></info>
11000
11001 <para>Sets the path to the directory holding the callout graphics. his
11002 location is normally relative to the output html directory. see
11003 base.dir. Always terminate the directory with / since the graphic file
11004 is appended to this string, hence needs the separator.
11005 </para>
11006
11007 </refsection>
11008 </refentry>
11009
11010 <refentry version="5.0" id="callout.icon.size">
11011 <refmeta>
11012 <refentrytitle>callout.icon.size</refentrytitle>
11013 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
11014 </refmeta>
11015 <refnamediv>
11016 <refname>callout.icon.size</refname>
11017 <refpurpose>Specifies the size of callout marker icons</refpurpose>
11018 </refnamediv>
11019
11020 <refsynopsisdiv>
11021 <programlisting id="callout.icon.size.frag">
11022 &lt;xsl:param name="callout.icon.size"&gt;7pt&lt;/xsl:param&gt;
11023 </programlisting>
11024 </refsynopsisdiv>
11025
11026 <refsection><info><title>Description</title></info>
11027
11028 <para>Specifies the size of the callout marker icons.
11029 The default size is 7 points.</para>
11030
11031 </refsection>
11032 </refentry>
11033
11034 <refentry version="5.0" id="callout.unicode">
11035 <refmeta>
11036 <refentrytitle>callout.unicode</refentrytitle>
11037 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11038 </refmeta>
11039 <refnamediv>
11040 <refname>callout.unicode</refname>
11041 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
11042 </refnamediv>
11043
11044 <refsynopsisdiv>
11045 <programlisting id="callout.unicode.frag">&lt;xsl:param name="callout.unicode" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
11046 </refsynopsisdiv>
11047
11048 <refsection><info><title>Description</title></info>
11049
11050 <para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option.
11051 </para>
11052
11053 </refsection>
11054 </refentry>
11055
11056 <refentry version="5.0" id="callout.unicode.font">
11057 <refmeta>
11058 <refentrytitle>callout.unicode.font</refentrytitle>
11059 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11060 </refmeta>
11061 <refnamediv>
11062 <refname>callout.unicode.font</refname>
11063 <refpurpose>Specify a font for Unicode glyphs</refpurpose>
11064 </refnamediv>
11065
11066 <refsynopsisdiv>
11067 <programlisting id="callout.unicode.font.frag">
11068 &lt;xsl:param name="callout.unicode.font"&gt;ZapfDingbats&lt;/xsl:param&gt;
11069 </programlisting>
11070 </refsynopsisdiv>
11071
11072 <refsection><info><title>Description</title></info>
11073
11074 <para>The name of the font to specify around Unicode callout glyphs.
11075 If set to the empty string, no font change will occur.
11076 </para>
11077
11078 </refsection>
11079 </refentry>
11080
11081 <refentry version="5.0" id="callout.unicode.number.limit">
11082 <refmeta>
11083 <refentrytitle>callout.unicode.number.limit</refentrytitle>
11084 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11085 </refmeta>
11086 <refnamediv>
11087 <refname>callout.unicode.number.limit</refname>
11088 <refpurpose>Number of the largest unicode callout character</refpurpose>
11089 </refnamediv>
11090
11091 <refsynopsisdiv>
11092 <programlisting id="callout.unicode.number.limit.frag">
11093 &lt;xsl:param name="callout.unicode.number.limit"&gt;10&lt;/xsl:param&gt;
11094 </programlisting>
11095 </refsynopsisdiv>
11096
11097 <refsection><info><title>Description</title></info>
11098
11099 <para>If <parameter>callout.unicode</parameter>
11100 is non-zero, unicode characters are used to represent
11101 callout numbers. The value of
11102 <parameter>callout.unicode.number.limit</parameter>
11103 is
11104 the largest number for which a unicode character exists. If the callout number
11105 exceeds this limit, the default presentation "(nnn)" will always
11106 be used.
11107 </para>
11108
11109 </refsection>
11110 </refentry>
11111
11112 <refentry version="5.0" id="callout.unicode.start.character">
11113 <refmeta>
11114 <refentrytitle>callout.unicode.start.character</refentrytitle>
11115 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11116 </refmeta>
11117 <refnamediv>
11118 <refname>callout.unicode.start.character</refname>
11119 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
11120 </refnamediv>
11121
11122 <refsynopsisdiv>
11123 <programlisting id="callout.unicode.start.character.frag">
11124 &lt;xsl:param name="callout.unicode.start.character"&gt;10102&lt;/xsl:param&gt;
11125 </programlisting>
11126 </refsynopsisdiv>
11127
11128 <refsection><info><title>Description</title></info>
11129
11130 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
11131 is non-zero, unicode characters are used to represent
11132 callout numbers. The value of
11133 <parameter>callout.unicode.start.character</parameter>
11134 is the decimal unicode value used for callout number one. Currently, 
11135 only 10102 is supported in the stylesheets for this parameter. 
11136 </para>
11137
11138 </refsection>
11139 </refentry>
11140
11141 <refentry version="5.0" id="callouts.extension">
11142 <refmeta>
11143 <refentrytitle>callouts.extension</refentrytitle>
11144 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11145 </refmeta>
11146 <refnamediv>
11147 <refname>callouts.extension</refname>
11148 <refpurpose>Enable the callout extension</refpurpose>
11149 </refnamediv>
11150
11151 <refsynopsisdiv>
11152 <programlisting id="callouts.extension.frag">
11153 &lt;xsl:param name="callouts.extension" select="1"&gt;&lt;/xsl:param&gt;
11154 </programlisting>
11155 </refsynopsisdiv>
11156
11157 <refsection><info><title>Description</title></info>
11158
11159 <para>The callouts extension processes <tag>areaset</tag>
11160 elements in <tag>programlistingco</tag> and other text-based
11161 callout elements.
11162 </para>
11163
11164 </refsection>
11165 </refentry>
11166
11167 </reference><reference id="toc_index" xml:base="../fo/param.xml"><title>ToC/LoT/Index Generation</title>
11168 <refentry version="5.0" id="autotoc.label.separator">
11169 <refmeta>
11170 <refentrytitle>autotoc.label.separator</refentrytitle>
11171 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11172 </refmeta>
11173 <refnamediv>
11174 <refname>autotoc.label.separator</refname>
11175 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
11176 </refnamediv>
11177
11178 <refsynopsisdiv>
11179 <programlisting id="autotoc.label.separator.frag">
11180 &lt;xsl:param name="autotoc.label.separator"&gt;. &lt;/xsl:param&gt;
11181 </programlisting>
11182 </refsynopsisdiv>
11183
11184 <refsection><info><title>Description</title></info>
11185
11186 <para>String used to separate labels and titles in a table of contents.</para>
11187
11188 </refsection>
11189 </refentry>
11190
11191 <refentry version="5.0" id="process.empty.source.toc">
11192 <refmeta>
11193 <refentrytitle>process.empty.source.toc</refentrytitle>
11194 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11195 </refmeta>
11196 <refnamediv>
11197 <refname>process.empty.source.toc</refname>
11198 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
11199 </refnamediv>
11200
11201 <refsynopsisdiv>
11202 <programlisting id="process.empty.source.toc.frag">&lt;xsl:param name="process.empty.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
11203 </refsynopsisdiv>
11204
11205 <refsection><info><title>Description</title></info>
11206
11207 <para>Specifies that if an empty <tag>toc</tag> element is found in a
11208 source document, an automated TOC is generated at this point in the
11209 document.
11210 <note>
11211   <para>Depending on what the value of the
11212   <parameter>generate.toc</parameter> parameter is, setting this
11213   parameter to <literal>1</literal> could result in generation of
11214   duplicate automated TOCs. So the
11215   <parameter>process.empty.source.toc</parameter> is primarily useful
11216   as an "override": by placing an empty <tag>toc</tag> in your
11217   document and setting this parameter to <literal>1</literal>, you can
11218   force a TOC to be generated even if <tag>generate.toc</tag>
11219   says not to.</para>
11220 </note>
11221 </para>
11222
11223 </refsection>
11224 </refentry>
11225
11226 <refentry version="5.0" id="process.source.toc">
11227 <refmeta>
11228 <refentrytitle>process.source.toc</refentrytitle>
11229 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11230 </refmeta>
11231 <refnamediv>
11232 <refname>process.source.toc</refname>
11233 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
11234 </refnamediv>
11235
11236 <refsynopsisdiv>
11237 <programlisting id="process.source.toc.frag">&lt;xsl:param name="process.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
11238 </refsynopsisdiv>
11239
11240 <refsection><info><title>Description</title></info>
11241
11242 <para>Specifies that the contents of a non-empty "hard-coded"
11243 <tag>toc</tag> element in a source document are processed to
11244 generate a TOC in output.
11245 <note>
11246   <para>This parameter has no effect on automated generation of
11247   TOCs. An automated TOC may still be generated along with the
11248   "hard-coded" TOC. To suppress automated TOC generation, adjust the
11249   value of the <parameter>generate.toc</parameter> paramameter.</para>
11250
11251   <para>The <tag>process.source.toc</tag> parameter also has
11252   no effect if the <tag>toc</tag> element is empty; handling
11253   for empty <tag>toc</tag> is controlled by the
11254   <parameter>process.empty.source.toc</parameter> parameter.</para>
11255 </note>
11256 </para>
11257
11258 </refsection>
11259 </refentry>
11260
11261 <refentry version="5.0" id="generate.toc">
11262 <refmeta>
11263 <refentrytitle>generate.toc</refentrytitle>
11264 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
11265 </refmeta>
11266 <refnamediv>
11267 <refname>generate.toc</refname>
11268 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
11269 </refnamediv>
11270
11271 <refsynopsisdiv>
11272 <programlisting id="generate.toc.frag">
11273
11274 &lt;xsl:param name="generate.toc"&gt;
11275 /appendix toc,title
11276 article/appendix  nop
11277 /article  toc,title
11278 book      toc,title,figure,table,example,equation
11279 /chapter  toc,title
11280 part      toc,title
11281 /preface  toc,title
11282 reference toc,title
11283 /sect1    toc
11284 /sect2    toc
11285 /sect3    toc
11286 /sect4    toc
11287 /sect5    toc
11288 /section  toc
11289 set       toc,title
11290 &lt;/xsl:param&gt;
11291 </programlisting>
11292 </refsynopsisdiv>
11293
11294 <refsection><info><title>Description</title></info>
11295
11296 <para>This parameter has a structured value. It is a table of space-delimited
11297 path/value pairs. Each path identifies some element in the source document
11298 using a restricted subset of XPath (only the implicit child axis, no wildcards,
11299 no predicates). Paths can be either relative or absolute.</para>
11300
11301 <para>When processing a particular element, the stylesheets consult this table to
11302 determine if a ToC (or LoT(s)) should be generated.</para>
11303
11304 <para>For example, consider the entry:</para>
11305
11306 <screen>book toc,figure</screen>
11307
11308 <para>This indicates that whenever a <tag>book</tag> is formatted, a
11309 Table Of Contents and a List of Figures should be generated. Similarly,</para>
11310
11311 <screen>/chapter toc</screen>
11312
11313 <para>indicates that whenever a document <emphasis>that has a root
11314 of</emphasis> <tag>chapter</tag> is formatted, a Table of
11315 Contents should be generated. The entry <literal>chapter</literal> would match
11316 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
11317 document elements.</para>
11318
11319 <para>Generally, the longest match wins. So, for example, if you want to distinguish
11320 articles in books from articles in parts, you could use these two entries:</para>
11321
11322 <screen>book/article toc,figure
11323 part/article toc</screen>
11324
11325 <para>Note that an article in a part can never match a <literal>book/article</literal>,
11326 so if you want nothing to be generated for articles in parts, you can simply leave
11327 that rule out.</para>
11328
11329 <para>If you want to leave the rule in, to make it explicit that you're turning
11330 something off, use the value <quote>nop</quote>. For example, the following
11331 entry disables ToCs and LoTs for articles:</para>
11332
11333 <screen>article nop</screen>
11334
11335 <para>Do not simply leave the word <quote>article</quote> in the file
11336 without a matching value. That'd be just begging the silly little
11337 path/value parser to get confused.</para>
11338
11339 <para>Section ToCs are further controlled by the
11340 <parameter>generate.section.toc.level</parameter> parameter.
11341 For a given section level to have a ToC, it must have both an entry in 
11342 <parameter>generate.toc</parameter> and be within the range enabled by
11343 <parameter>generate.section.toc.level</parameter>.</para>
11344 </refsection>
11345 </refentry>
11346
11347 <refentry version="5.0" id="generate.index">
11348 <refmeta>
11349 <refentrytitle>generate.index</refentrytitle>
11350 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11351 </refmeta>
11352 <refnamediv>
11353 <refname>generate.index</refname>
11354 <refpurpose>Do you want an index?</refpurpose>
11355 </refnamediv>
11356
11357 <refsynopsisdiv>
11358 <programlisting id="generate.index.frag">&lt;xsl:param name="generate.index" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
11359 </refsynopsisdiv>
11360
11361 <refsection><info><title>Description</title></info>
11362
11363 <para>Specify if an index should be generated. </para>
11364
11365 </refsection>
11366 </refentry>
11367
11368 <refentry version="5.0" id="make.index.markup">
11369 <refmeta>
11370 <refentrytitle>make.index.markup</refentrytitle>
11371 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11372 </refmeta>
11373 <refnamediv>
11374 <refname>make.index.markup</refname>
11375 <refpurpose>Generate XML index markup in the index?</refpurpose>
11376 </refnamediv>
11377
11378 <refsynopsisdiv>
11379 <programlisting id="make.index.markup.frag">
11380 &lt;xsl:param name="make.index.markup" select="0"&gt;&lt;/xsl:param&gt;
11381 </programlisting>
11382 </refsynopsisdiv>
11383
11384 <refsection><info><title>Description</title></info>
11385
11386 <para>This parameter enables a very neat trick for getting properly
11387 merged, collated back-of-the-book indexes. G. Ken Holman suggested
11388 this trick at Extreme Markup Languages 2002 and I'm indebted to him
11389 for it.</para>
11390
11391 <para>Jeni Tennison's excellent code in
11392 <filename>autoidx.xsl</filename> does a great job of merging and
11393 sorting <tag>indexterm</tag>s in the document and building a
11394 back-of-the-book index. However, there's one thing that it cannot
11395 reasonably be expected to do: merge page numbers into ranges. (I would
11396 not have thought that it could collate and suppress duplicate page
11397 numbers, but in fact it appears to manage that task somehow.)</para>
11398
11399 <para>Ken's trick is to produce a document in which the index at the
11400 back of the book is <quote>displayed</quote> in XML. Because the index
11401 is generated by the FO processor, all of the page numbers have been resolved.
11402 It's a bit hard to explain, but what it boils down to is that instead of having
11403 an index at the back of the book that looks like this:</para>
11404
11405 <blockquote>
11406 <formalpara><info><title>A</title></info>
11407 <para>ap1, 1, 2, 3</para>
11408 </formalpara>
11409 </blockquote>
11410
11411 <para>you get one that looks like this:</para>
11412
11413 <blockquote>
11414 <programlisting>&lt;indexdiv&gt;A&lt;/indexdiv&gt;
11415 &lt;indexentry&gt;
11416 &lt;primaryie&gt;ap1&lt;/primaryie&gt;,
11417 &lt;phrase role="pageno"&gt;1&lt;/phrase&gt;,
11418 &lt;phrase role="pageno"&gt;2&lt;/phrase&gt;,
11419 &lt;phrase role="pageno"&gt;3&lt;/phrase&gt;
11420 &lt;/indexentry&gt;</programlisting>
11421 </blockquote>
11422
11423 <para>After building a PDF file with this sort of odd-looking index, you can
11424 extract the text from the PDF file and the result is a proper index expressed in
11425 XML.</para>
11426
11427 <para>Now you have data that's amenable to processing and a simple Perl script
11428 (such as <filename>fo/pdf2index</filename>) can
11429 merge page ranges and generate a proper index.</para>
11430
11431 <para>Finally, reformat your original document using this literal index instead of
11432 an automatically generated one and <quote>bingo</quote>!</para>
11433
11434 </refsection>
11435 </refentry>
11436
11437 <refentry version="5.0" id="index.method">
11438 <refmeta>
11439 <refentrytitle>index.method</refentrytitle>
11440 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
11441 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
11442 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
11443 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
11444 </refmeta>
11445 <refnamediv>
11446 <refname>index.method</refname>
11447 <refpurpose>Select method used to group index entries in an index</refpurpose>
11448 </refnamediv>
11449
11450 <refsynopsisdiv>
11451 <programlisting id="index.method.frag">
11452 &lt;xsl:param name="index.method"&gt;basic&lt;/xsl:param&gt;
11453 </programlisting>
11454 </refsynopsisdiv>
11455
11456 <refsection><info><title>Description</title></info>
11457
11458 <para>This parameter lets you select which method to use for sorting and grouping
11459  index entries in an index.
11460 Indexes in Latin-based languages that have accented characters typically
11461 sort together accented words and unaccented words.
11462 Thus <quote>&#193;</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
11463 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
11464 section of the index.
11465 Languages using other alphabets (such as Russian,  which is written in the Cyrillic alphabet)
11466 and languages using ideographic chararacters (such as Japanese)
11467 require grouping specific to the languages and alphabets.
11468 </para>
11469
11470 <para>The default indexing method is limited.
11471 It can group accented characters in Latin-based languages only.
11472 It cannot handle non-Latin alphabets or ideographic languages.
11473 The other indexing methods require extensions of one type or
11474 another, and do not work with
11475 all XSLT processors, which is why they are not used by default.</para>
11476
11477 <para>The three choices for indexing method are:</para>
11478 <variablelist>
11479 <varlistentry>
11480 <term><literal>basic</literal></term>
11481 <listitem>
11482 <para>
11483 (default)  Sort and groups words based only on the Latin alphabet.
11484 Words with accented Latin letters will group and sort with
11485 their respective primary letter, but
11486 words in non-Latin alphabets will be
11487 put in the <quote>Symbols</quote> section of the index.
11488 </para>
11489 </listitem>
11490 </varlistentry>
11491 <varlistentry>
11492 <term><literal>kosek</literal></term>
11493 <listitem>
11494 <para>
11495 This method sorts and groups words based on letter groups configured in
11496 the DocBook locale file for the given language.
11497 See, for example, the French locale file <filename>common/fr.xml</filename>.
11498 This method requires that the XSLT processor
11499 supports the EXSLT extensions (most do).
11500 It also requires support for using 
11501 user-defined functions in xsl:key (xsltproc does not).
11502 </para>
11503 <para>This method is suitable for any language for which you can
11504 list all the individual characters that should appear
11505 in each letter group in an index.
11506 It is probably not practical to use it for ideographic languages
11507 such as Chinese that have hundreds or thousands of characters.
11508 </para>
11509
11510 <para>To use the kosek method, you must:</para>
11511
11512 <orderedlist>
11513 <listitem>
11514 <para>Use a processor that supports its extensions, such as
11515 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
11516 </para>
11517 </listitem>
11518 <listitem>
11519 <para>Set the index.method parameter's value to <quote>kosek</quote>.
11520 </para>
11521 </listitem>
11522 <listitem>
11523 <para>Import the appropriate index extensions stylesheet module
11524 <filename>fo/autoidx-kosek.xsl</filename> or 
11525 <filename>html/autoidx-kosek.xsl</filename> into your
11526 customization.
11527 </para>
11528 </listitem>
11529 </orderedlist>
11530
11531 </listitem>
11532 </varlistentry>
11533 <varlistentry>
11534 <term><literal>kimber</literal></term>
11535 <listitem>
11536 <para>
11537 This method uses extensions to the Saxon processor to implement
11538 sophisticated indexing processes. It uses its own 
11539 configuration file, which can include information for any number of
11540 languages. Each language's configuration can group
11541 words using one of two processes. In the
11542 enumerated process similar to that used in the kosek method,
11543 you indicate the groupings character-by-character.
11544 In the between-key process, you specify the
11545 break-points in the sort order that should start a new group.
11546 The latter configuration is useful for ideographic languages
11547 such as Chinese, Japanese, and Korean.
11548 You can also define your own collation algorithms and how you
11549 want mixed Latin-alphabet words sorted.</para>
11550 <itemizedlist>
11551 <listitem>
11552 <para>For a whitepaper describing the extensions, see:
11553 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>.
11554 </para>
11555 </listitem>
11556 <listitem>
11557 <para>To download the extension library, see
11558 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
11559 </para>
11560 </listitem>
11561 </itemizedlist>
11562
11563 <para>To use the kimber method, you must:</para>
11564
11565 <orderedlist>
11566 <listitem>
11567 <para>Use Saxon (version 6 or 8) as your XSLT processor.
11568 </para>
11569 </listitem>
11570 <listitem>
11571 <para>Install and configure the Innodata Isogen library, using
11572 the documentation that comes with it.
11573 </para>
11574 </listitem>
11575 <listitem>
11576 <para>Set the index.method parameter's value to <quote>kimber</quote>.
11577 </para>
11578 </listitem>
11579 <listitem>
11580 <para>Import the appropriate index extensions stylesheet module
11581 <filename>fo/autoidx-kimber.xsl</filename> or 
11582 <filename>html/autoidx-kimber.xsl</filename> into your
11583 customization.
11584 </para>
11585 </listitem>
11586 </orderedlist>
11587
11588 </listitem>
11589 </varlistentry>
11590 </variablelist>
11591
11592 </refsection>
11593 </refentry>
11594
11595 <refentry version="5.0" id="index.on.type">
11596 <refmeta>
11597 <refentrytitle>index.on.type</refentrytitle>
11598 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11599 </refmeta>
11600 <refnamediv>
11601 <refname>index.on.type</refname>
11602 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
11603 attribute value</refpurpose>
11604 </refnamediv>
11605
11606 <refsynopsisdiv>
11607 <programlisting id="index.on.type.frag">
11608 &lt;xsl:param name="index.on.type" select="0"&gt;&lt;/xsl:param&gt;
11609 </programlisting>
11610 </refsynopsisdiv>
11611
11612 <refsection><info><title>Description</title></info>
11613
11614 <para>
11615 If non-zero, 
11616 then an <tag>index</tag> element that has a
11617 <tag class="attribute">type</tag> attribute
11618 value will contain only those <tag>indexterm</tag>
11619 elements with a matching <tag class="attribute">type</tag> attribute value.
11620 If an <tag>index</tag> has no <tag class="attribute">type</tag>
11621 attribute or it is blank, then the index will contain
11622 all <tag>indexterm</tag>s in the current scope.
11623 </para>
11624
11625 <para>
11626 If <literal>index.on.type</literal> is zero, then the
11627 <tag class="attribute">type</tag> attribute has no effect
11628 on selecting indexterms for an index.
11629 </para>
11630
11631 <para>For those using DocBook version 4.2 or earlier,
11632 the <tag class="attribute">type</tag> attribute is not available
11633 for index terms.  However, you can achieve the same
11634 effect by using the <tag class="attribute">role</tag> attribute
11635 in the same manner on <tag>indexterm</tag>
11636 and <tag>index</tag>, and setting the stylesheet parameter 
11637 <parameter>index.on.role</parameter> to a nonzero value.
11638 </para>
11639
11640 </refsection>
11641 </refentry>
11642
11643 <refentry version="5.0" id="index.on.role">
11644 <refmeta>
11645 <refentrytitle>index.on.role</refentrytitle>
11646 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11647 </refmeta>
11648 <refnamediv>
11649 <refname>index.on.role</refname>
11650 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
11651 </refnamediv>
11652
11653 <refsynopsisdiv>
11654 <programlisting id="index.on.role.frag">
11655 &lt;xsl:param name="index.on.role" select="0"&gt;&lt;/xsl:param&gt;
11656 </programlisting>
11657 </refsynopsisdiv>
11658
11659 <refsection><info><title>Description</title></info>
11660
11661 <para>
11662 If non-zero, 
11663 then an <tag>index</tag> element that has a
11664 <tag class="attribute">role</tag> attribute
11665 value will contain only those <tag>indexterm</tag>
11666 elements with a matching role value.
11667 If an <tag>index</tag> has no <tag class="attribute">role</tag>
11668 attribute or it is blank, then the index will contain
11669 all <tag>indexterm</tag>s in the current scope.
11670 </para>
11671 <para>
11672 If <literal>index.on.role</literal> is zero, then the
11673 <tag class="attribute">role</tag> attribute has no effect
11674 on selecting indexterms for an index.
11675 </para>
11676
11677 <para>If you are using DocBook version 4.3 or later, you should
11678 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
11679 on <tag>indexterm</tag> and <tag>index</tag>,
11680 and set the <parameter>index.on.type</parameter> to a nonzero
11681 value.
11682 </para>
11683
11684 </refsection>
11685 </refentry>
11686
11687 <refentry version="5.0" id="index.preferred.page.properties">
11688 <refmeta>
11689 <refentrytitle>index.preferred.page.properties</refentrytitle>
11690 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11691 </refmeta>
11692 <refnamediv>
11693 <refname>index.preferred.page.properties</refname>
11694 <refpurpose>Properties used to emphasize page number references for
11695 significant index terms</refpurpose>
11696 </refnamediv>
11697
11698 <refsynopsisdiv>
11699 <programlisting id="index.preferred.page.properties.frag">
11700 &lt;xsl:attribute-set name="index.preferred.page.properties"&gt;
11701   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
11702 &lt;/xsl:attribute-set&gt;
11703 </programlisting>
11704 </refsynopsisdiv>
11705
11706 <refsection><info><title>Description</title></info>
11707
11708 <para>Properties used to emphasize page number references for
11709 significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with
11710 XEP.</para>
11711
11712 </refsection>
11713 </refentry>
11714
11715 <refentry version="5.0" id="index.entry.properties">
11716 <refmeta>
11717 <refentrytitle>index.entry.properties</refentrytitle>
11718 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11719 </refmeta>
11720 <refnamediv>
11721 <refname>index.entry.properties</refname>
11722 <refpurpose>Properties applied to the formatted entries
11723 in an index</refpurpose>
11724 </refnamediv>
11725
11726 <refsynopsisdiv>
11727 <programlisting id="index.entry.properties.frag">
11728 &lt;xsl:attribute-set name="index.entry.properties"&gt;
11729   &lt;xsl:attribute name="start-indent"&gt;0pt&lt;/xsl:attribute&gt;
11730 &lt;/xsl:attribute-set&gt;
11731 </programlisting>
11732 </refsynopsisdiv>
11733
11734 <refsection><info><title>Description</title></info>
11735
11736 <para>This attribute set is applied to the block containing
11737 the entries in a letter division in an index.  It can be used to set the
11738 font-size, font-family, and other inheritable properties that will be
11739 applied to all index entries.</para>
11740
11741 </refsection>
11742 </refentry>
11743
11744 <refentry version="5.0" id="index.div.title.properties">
11745 <refmeta>
11746 <refentrytitle>index.div.title.properties</refentrytitle>
11747 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11748 </refmeta>
11749 <refnamediv>
11750 <refname>index.div.title.properties</refname>
11751 <refpurpose>Properties associated with the letter headings in an
11752 index</refpurpose>
11753 </refnamediv>
11754
11755 <refsynopsisdiv>
11756 <programlisting id="index.div.title.properties.frag">
11757 &lt;xsl:attribute-set name="index.div.title.properties"&gt;
11758   &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;0pt&lt;/xsl:attribute&gt;
11759   &lt;xsl:attribute name="font-size"&gt;14.4pt&lt;/xsl:attribute&gt;
11760   &lt;xsl:attribute name="font-family"&gt;&lt;xsl:value-of select="$title.fontset"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
11761   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
11762   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
11763   &lt;xsl:attribute name="space-before.optimum"&gt;&lt;xsl:value-of select="concat($body.font.master,'pt')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
11764   &lt;xsl:attribute name="space-before.minimum"&gt;&lt;xsl:value-of select="concat($body.font.master,'pt * 0.8')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
11765   &lt;xsl:attribute name="space-before.maximum"&gt;&lt;xsl:value-of select="concat($body.font.master,'pt * 1.2')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
11766   &lt;xsl:attribute name="start-indent"&gt;0pt&lt;/xsl:attribute&gt;
11767 &lt;/xsl:attribute-set&gt;
11768 </programlisting>
11769 </refsynopsisdiv>
11770
11771 <refsection><info><title>Description</title></info>
11772
11773 <para>This attribute set is used on the letter headings that separate
11774 the divisions in an index.</para>
11775
11776 </refsection>
11777 </refentry>
11778
11779 <refentry version="5.0" id="index.number.separator">
11780 <refmeta>
11781 <refentrytitle>index.number.separator</refentrytitle>
11782 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11783 </refmeta>
11784 <refnamediv>
11785 <refname>index.number.separator</refname>
11786 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
11787 </refnamediv>
11788
11789 <refsynopsisdiv>
11790 <programlisting id="index.number.separator.frag">
11791 &lt;xsl:param name="index.number.separator"&gt;&lt;/xsl:param&gt;
11792 </programlisting>
11793 </refsynopsisdiv>
11794
11795 <refsection><info><title>Description</title></info>
11796
11797 <para>This parameter permits you to override the text to insert between
11798 page references in a formatted index entry.  Typically 
11799 that would be a comma and a space.
11800 </para>
11801
11802 <para>Because this text may be locale dependent,
11803 this parameter's value is normally taken from a gentext
11804 template named 'number-separator' in the
11805 context 'index' in the stylesheet
11806 locale file for the language
11807 of the current document.
11808 This parameter can be used to override the gentext string,
11809 and would typically be used on the command line.
11810 This parameter would apply to all languages.
11811 </para>
11812
11813 <para>So this text string can be customized in two ways.
11814 You can reset the default gentext string using
11815 the <parameter>local.l10n.xml</parameter> parameter, or you can
11816 override the gentext with the content of this parameter.
11817 The content can be a simple string, or it can be
11818 something more complex such as a call-template.
11819 </para>
11820
11821 <para>In HTML index output, section title references are used instead of
11822 page number references.  This punctuation appears between
11823 such section titles in an HTML index.
11824 </para>
11825
11826 </refsection>
11827 </refentry>
11828
11829 <refentry version="5.0" id="index.range.separator">
11830 <refmeta>
11831 <refentrytitle>index.range.separator</refentrytitle>
11832 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11833 </refmeta>
11834 <refnamediv>
11835 <refname>index.range.separator</refname>
11836 <refpurpose>Override for punctuation separating the two numbers
11837 in a page range in index</refpurpose>
11838 </refnamediv>
11839
11840 <refsynopsisdiv>
11841 <programlisting id="index.range.separator.frag">
11842 &lt;xsl:param name="index.range.separator"&gt;&lt;/xsl:param&gt;
11843 </programlisting>
11844 </refsynopsisdiv>
11845
11846 <refsection><info><title>Description</title></info>
11847
11848 <para>This parameter permits you
11849 to override the text to insert between
11850 the two numbers of a page range in an index.
11851 This parameter is only used by those XSL-FO processors
11852 that support an extension for generating such page ranges
11853 (such as XEP).</para>
11854
11855 <para>Because this text may be locale dependent,
11856 this parameter's value is normally taken from a gentext
11857 template named 'range-separator' in the
11858 context 'index' in the stylesheet
11859 locale file for the language
11860 of the current document.
11861 This parameter can be used to override the gentext string,
11862 and would typically be used on the command line.
11863 This parameter would apply to all languages.
11864 </para>
11865
11866 <para>So this text string can be customized in two ways.
11867 You can reset the default gentext string using
11868 the <parameter>local.l10n.xml</parameter> parameter, or you can
11869 override the gentext with the content of this parameter.
11870 The content can be a simple string, or it can be
11871 something more complex such as a call-template.
11872 </para>
11873
11874 <para>In HTML index output, section title references are used instead of
11875 page number references. So there are no page ranges
11876 and this parameter has no effect.
11877 </para>
11878
11879 </refsection>
11880 </refentry>
11881
11882 <refentry version="5.0" id="index.term.separator">
11883 <refmeta>
11884 <refentrytitle>index.term.separator</refentrytitle>
11885 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11886 </refmeta>
11887 <refnamediv>
11888 <refname>index.term.separator</refname>
11889 <refpurpose>Override for punctuation separating an index term 
11890 from its list of page references in an index</refpurpose>
11891 </refnamediv>
11892
11893 <refsynopsisdiv>
11894 <programlisting id="index.term.separator.frag">
11895 &lt;xsl:param name="index.term.separator"&gt;&lt;/xsl:param&gt;
11896 </programlisting>
11897 </refsynopsisdiv>
11898
11899 <refsection><info><title>Description</title></info>
11900
11901 <para>This parameter permits you to override
11902 the text to insert between
11903 the end of an index term and its list of page references.
11904 Typically that might be a comma and a space.
11905 </para>
11906
11907 <para>Because this text may be locale dependent,
11908 this parameter's value is normally taken from a gentext
11909 template named 'term-separator' in the
11910 context 'index' in the stylesheet
11911 locale file for the language
11912 of the current document.
11913 This parameter can be used to override the gentext string,
11914 and would typically be used on the command line.
11915 This parameter would apply to all languages.
11916 </para>
11917
11918 <para>So this text string can be customized in two ways.
11919 You can reset the default gentext string using
11920 the <parameter>local.l10n.xml</parameter> parameter, or you can
11921 fill in the content for this normally empty 
11922 override parameter.
11923 The content can be a simple string, or it can be
11924 something more complex such as a call-template.
11925 For fo output, it could be an <tag>fo:leader</tag>
11926 element to provide space of a specific length, or a dot leader.
11927 </para>
11928
11929 </refsection>
11930 </refentry>
11931
11932 <refentry version="5.0" id="xep.index.item.properties">
11933 <refmeta>
11934 <refentrytitle>xep.index.item.properties</refentrytitle>
11935 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11936 </refmeta>
11937 <refnamediv>
11938 <refname>xep.index.item.properties</refname>
11939 <refpurpose>Properties associated with XEP index-items</refpurpose>
11940 </refnamediv>
11941
11942 <refsynopsisdiv>
11943 <programlisting id="xep.index.item.properties.frag">
11944 &lt;xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties"&gt;
11945   &lt;xsl:attribute name="merge-subsequent-page-numbers"&gt;true&lt;/xsl:attribute&gt;
11946   &lt;xsl:attribute name="link-back"&gt;true&lt;/xsl:attribute&gt;
11947 &lt;/xsl:attribute-set&gt;
11948 </programlisting>
11949 </refsynopsisdiv>
11950
11951 <refsection><info><title>Description</title></info>
11952
11953 <para>Properties associated with XEP index-items, which generate
11954 page numbers in an index processed by XEP. For more info see
11955 the XEP documentation section "Indexes" in
11956 <uri xlink:href="http://www.renderx.com/reference.html#Indexes">http://www.renderx.com/reference.html#Indexes</uri>.</para>
11957
11958 <para>This attribute-set also adds by default any properties from the
11959 <tag class="attribute">index.page.number.properties</tag>
11960 attribute-set.</para>
11961 </refsection>
11962 </refentry>
11963
11964 <refentry version="5.0" id="toc.section.depth">
11965 <refmeta>
11966 <refentrytitle>toc.section.depth</refentrytitle>
11967 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11968 </refmeta>
11969 <refnamediv>
11970 <refname>toc.section.depth</refname>
11971 <refpurpose>How deep should recursive <tag>section</tag>s appear
11972 in the TOC?</refpurpose>
11973 </refnamediv>
11974
11975 <refsynopsisdiv>
11976 <programlisting id="toc.section.depth.frag">&lt;xsl:param name="toc.section.depth"&gt;2&lt;/xsl:param&gt;</programlisting>
11977 </refsynopsisdiv>
11978
11979 <refsection><info><title>Description</title></info>
11980
11981 <para>Specifies the depth to which recursive sections should appear in the
11982 TOC.
11983 </para>
11984
11985 </refsection>
11986 </refentry>
11987
11988 <refentry version="5.0" id="toc.max.depth">
11989 <refmeta>
11990 <refentrytitle>toc.max.depth</refentrytitle>
11991 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11992 </refmeta>
11993 <refnamediv>
11994 <refname>toc.max.depth</refname>
11995 <refpurpose>How many levels should be created for each TOC?</refpurpose>
11996 </refnamediv>
11997
11998 <refsynopsisdiv>
11999 <programlisting id="toc.max.depth.frag">&lt;xsl:param name="toc.max.depth"&gt;8&lt;/xsl:param&gt;</programlisting>
12000 </refsynopsisdiv>
12001
12002 <refsection><info><title>Description</title></info>
12003
12004 <para>Specifies the maximal depth of TOC on all levels.</para>
12005
12006 </refsection>
12007 </refentry>
12008
12009 <refentry version="5.0" id="toc.indent.width">
12010 <refmeta>
12011 <refentrytitle>toc.indent.width</refentrytitle>
12012 <refmiscinfo class="other" otherclass="datatype">float</refmiscinfo>
12013 </refmeta>
12014 <refnamediv>
12015 <refname>toc.indent.width</refname>
12016 <refpurpose>Amount of indentation for TOC entries</refpurpose>
12017 </refnamediv>
12018
12019 <refsynopsisdiv>
12020 <programlisting id="toc.indent.width.frag">
12021 &lt;xsl:param name="toc.indent.width"&gt;24&lt;/xsl:param&gt;
12022 &lt;!-- inconsistant point specification? --&gt;
12023 </programlisting>
12024 </refsynopsisdiv>
12025
12026 <refsection><info><title>Description</title></info>
12027
12028 <para>Specifies, in points, the distance by which each level of the
12029 TOC is indented from its parent.</para>
12030
12031 <para>This value is expressed in points, without
12032 a unit (in other words, it is a bare number). Using a bare number allows the stylesheet
12033 to perform calculations that would otherwise have to be performed by the FO processor
12034 because not all processors support expressions.</para>
12035
12036 </refsection>
12037 </refentry>
12038
12039 <refentry version="5.0" id="toc.line.properties">
12040 <refmeta>
12041 <refentrytitle>toc.line.properties</refentrytitle>
12042 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12043 </refmeta>
12044 <refnamediv>
12045 <refname>toc.line.properties</refname>
12046 <refpurpose>Properties for lines in ToCs and LoTs</refpurpose>
12047 </refnamediv>
12048
12049 <refsynopsisdiv>
12050 <programlisting id="toc.line.properties.frag">
12051 &lt;xsl:attribute-set name="toc.line.properties"&gt;
12052   &lt;xsl:attribute name="text-align-last"&gt;justify&lt;/xsl:attribute&gt;
12053   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
12054   &lt;xsl:attribute name="end-indent"&gt;&lt;xsl:value-of select="concat($toc.indent.width, 'pt')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
12055   &lt;xsl:attribute name="last-line-end-indent"&gt;&lt;xsl:value-of select="concat('-', $toc.indent.width, 'pt')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
12056 &lt;/xsl:attribute-set&gt;
12057 </programlisting>
12058 </refsynopsisdiv>
12059
12060 <refsection><info><title>Description</title></info>
12061
12062 <para>Properties which are applied to every line in ToC (or LoT). You can
12063 modify them in order to change appearance of all, or some lines. For
12064 example, in order to make lines for chapters bold, specify the
12065 following in your customization layer:</para>
12066
12067 <programlisting>&lt;xsl:attribute-set name="toc.line.properties"&gt;
12068   &lt;xsl:attribute name="font-weight"&gt;
12069    &lt;xsl:choose&gt;
12070     &lt;xsl:when test="self::chapter"&gt;bold&lt;/xsl:when&gt;
12071     &lt;xsl:otherwise&gt;normal&lt;/xsl:otherwise&gt;
12072    &lt;/xsl:choose&gt;
12073   &lt;/xsl:attribute&gt;
12074 &lt;/xsl:attribute-set&gt;</programlisting>
12075
12076 </refsection>
12077 </refentry>
12078
12079 <refentry version="5.0" id="toc.margin.properties">
12080 <refmeta>
12081 <refentrytitle>toc.margin.properties</refentrytitle>
12082 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12083 </refmeta>
12084 <refnamediv>
12085 <refname>toc.margin.properties</refname>
12086 <refpurpose>Margin properties used on Tables of Contents</refpurpose>
12087 </refnamediv>
12088
12089 <refsynopsisdiv>
12090 <programlisting id="toc.margin.properties.frag">
12091 &lt;xsl:attribute-set name="toc.margin.properties"&gt;
12092   &lt;xsl:attribute name="space-before.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
12093   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
12094   &lt;xsl:attribute name="space-before.maximum"&gt;2em&lt;/xsl:attribute&gt;
12095   &lt;xsl:attribute name="space-after.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
12096   &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
12097   &lt;xsl:attribute name="space-after.maximum"&gt;2em&lt;/xsl:attribute&gt;
12098 &lt;/xsl:attribute-set&gt;
12099 </programlisting>
12100 </refsynopsisdiv>
12101
12102 <refsection><info><title>Description</title></info>
12103 <para>This attribute set is used on Tables of Contents. These attributes are set
12104 on the wrapper that surrounds the ToC block, not on each individual lines.</para>
12105 </refsection>
12106 </refentry>
12107
12108 <refentry version="5.0" id="bridgehead.in.toc">
12109 <refmeta>
12110 <refentrytitle>bridgehead.in.toc</refentrytitle>
12111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12112 </refmeta>
12113 <refnamediv>
12114 <refname>bridgehead.in.toc</refname>
12115 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
12116 </refnamediv>
12117
12118 <refsynopsisdiv>
12119 <programlisting id="bridgehead.in.toc.frag">&lt;xsl:param name="bridgehead.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12120 </refsynopsisdiv>
12121
12122 <refsection><info><title>Description</title></info>
12123
12124 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
12125 this option is not fully supported and may be removed in a future
12126 version of the stylesheets.
12127 </para>
12128
12129 </refsection>
12130 </refentry>
12131
12132 <refentry version="5.0" id="simplesect.in.toc">
12133 <refmeta>
12134 <refentrytitle>simplesect.in.toc</refentrytitle>
12135 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12136 </refmeta>
12137 <refnamediv>
12138 <refname>simplesect.in.toc</refname>
12139 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
12140 </refnamediv>
12141
12142 <refsynopsisdiv>
12143 <programlisting id="simplesect.in.toc.frag">&lt;xsl:param name="simplesect.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12144 </refsynopsisdiv>
12145
12146 <refsection><info><title>Description</title></info>
12147
12148 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
12149 </para>
12150
12151 </refsection>
12152 </refentry>
12153
12154 <refentry version="5.0" id="generate.section.toc.level">
12155 <refmeta>
12156 <refentrytitle>generate.section.toc.level</refentrytitle>
12157 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12158 </refmeta>
12159 <refnamediv>
12160 <refname>generate.section.toc.level</refname>
12161 <refpurpose>Control depth of TOC generation in sections</refpurpose>
12162 </refnamediv>
12163
12164 <refsynopsisdiv>
12165 <programlisting id="generate.section.toc.level.frag">
12166 &lt;xsl:param name="generate.section.toc.level" select="0"&gt;&lt;/xsl:param&gt;
12167 </programlisting>
12168 </refsynopsisdiv>
12169
12170 <refsection><info><title>Description</title></info>
12171
12172 <para>The <parameter>generate.section.toc.level</parameter> parameter
12173 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
12174 that this is related to, but not the same as
12175 <parameter>toc.section.depth</parameter>, which controls the depth to
12176 which TOC entries will be generated in a given TOC.</para>
12177 <para>If, for example, <parameter>generate.section.toc.level</parameter>
12178 is <literal>3</literal>, TOCs will be generated in first, second, and third
12179 level sections, but not in fourth level sections.
12180 </para>
12181
12182 </refsection>
12183 </refentry>
12184
12185
12186
12187
12188 </reference><reference id="fo_ext" xml:base="../fo/param.xml"><title>Processor Extensions</title>
12189 <refentry version="5.0" id="arbortext.extensions">
12190 <refmeta>
12191 <refentrytitle>arbortext.extensions</refentrytitle>
12192 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12193 </refmeta>
12194 <refnamediv>
12195 <refname>arbortext.extensions</refname>
12196 <refpurpose>Enable Arbortext extensions?</refpurpose>
12197 </refnamediv>
12198
12199 <refsynopsisdiv>
12200 <programlisting id="arbortext.extensions.frag">&lt;xsl:param name="arbortext.extensions" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12201 </refsynopsisdiv>
12202
12203 <refsection><info><title>Description</title></info>
12204
12205 <para>If non-zero,
12206 <link xlink:href="http://www.arbortext.com/">Arbortext</link>
12207 extensions will be used.
12208 </para>
12209 <para>This parameter can also affect which graphics file formats
12210 are supported</para>
12211
12212 </refsection>
12213 </refentry>
12214
12215 <refentry version="5.0" id="axf.extensions">
12216 <refmeta>
12217 <refentrytitle>axf.extensions</refentrytitle>
12218 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12219 </refmeta>
12220 <refnamediv>
12221 <refname>axf.extensions</refname>
12222 <refpurpose>Enable XSL Formatter extensions?</refpurpose>
12223 </refnamediv>
12224
12225 <refsynopsisdiv>
12226 <programlisting id="axf.extensions.frag">
12227 &lt;xsl:param name="axf.extensions" select="0"&gt;&lt;/xsl:param&gt;
12228 </programlisting>
12229 </refsynopsisdiv>
12230
12231 <refsection><info><title>Description</title></info>
12232
12233 <para>If non-zero,
12234 <link xlink:href="http://www.antennahouse.com/">XSL Formatter</link>
12235 extensions will be used. XSL Formatter extensions consists of PDF bookmarks,
12236 document information and better index processing.</para>
12237
12238 <para>This parameter can also affect which graphics file formats
12239 are supported</para>
12240
12241 </refsection>
12242 </refentry>
12243
12244 <refentry version="5.0" id="fop.extensions">
12245 <refmeta>
12246 <refentrytitle>fop.extensions</refentrytitle>
12247 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12248 </refmeta>
12249 <refnamediv>
12250 <refname>fop.extensions</refname>
12251 <refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose>
12252 </refnamediv>
12253
12254 <refsynopsisdiv>
12255 <programlisting id="fop.extensions.frag">&lt;xsl:param name="fop.extensions" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12256 </refsynopsisdiv>
12257
12258 <refsection><info><title>Description</title></info>
12259
12260 <para>If non-zero, extensions intended for
12261 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
12262 version 0.20.5 and earlier will be used.
12263 At present, this consists of PDF bookmarks.
12264 </para>
12265
12266 <para>This parameter can also affect which graphics file formats
12267 are supported.</para>
12268
12269 <para>If you are using a version of FOP beyond
12270 version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter
12271 instead.
12272 </para>
12273 </refsection>
12274 </refentry>
12275
12276 <refentry version="5.0" id="fop1.extensions">
12277 <refmeta>
12278 <refentrytitle>fop1.extensions</refentrytitle>
12279 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12280 </refmeta>
12281 <refnamediv>
12282 <refname>fop1.extensions</refname>
12283 <refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose>
12284 </refnamediv>
12285
12286 <refsynopsisdiv>
12287 <programlisting id="fop1.extensions.frag">&lt;xsl:param name="fop1.extensions" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12288 </refsynopsisdiv>
12289
12290 <refsection><info><title>Description</title></info>
12291
12292 <para>If non-zero, extensions for 
12293 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
12294 version 0.90 and later will be used.
12295 </para>
12296
12297 <para>This parameter can also affect which graphics file formats
12298 are supported.</para>
12299
12300 <para>The original <parameter>fop.extensions</parameter> parameter
12301 should still be used for FOP version 0.20.5 and earlier.
12302 </para>
12303 </refsection>
12304 </refentry>
12305
12306 <refentry version="5.0" id="passivetex.extensions">
12307 <refmeta>
12308 <refentrytitle>passivetex.extensions</refentrytitle>
12309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12310 </refmeta>
12311 <refnamediv>
12312 <refname>passivetex.extensions</refname>
12313 <refpurpose>Enable PassiveTeX extensions?</refpurpose>
12314 </refnamediv>
12315
12316 <refsynopsisdiv>
12317 <programlisting id="passivetex.extensions.frag">&lt;xsl:param name="passivetex.extensions" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12318 </refsynopsisdiv>
12319
12320 <refsection><info><title>Description</title></info>
12321
12322 <para>If non-zero,
12323 <link xlink:href="http://www.tei-c.org.uk/Software/passivetex/">PassiveTeX</link>
12324 extensions will be used. At present, this consists of PDF bookmarks
12325 and sorted index terms.
12326 </para>
12327
12328 <para>This parameter can also affect which graphics file formats
12329 are supported</para>
12330
12331 <note>
12332   <para>PassiveTeX is incomplete and development has ceased. In most cases, 
12333 another XSL-FO engine is probably a better choice.</para>
12334 </note>
12335
12336 </refsection>
12337 </refentry>
12338
12339 <refentry version="5.0" id="tex.math.in.alt">
12340 <refmeta>
12341 <refentrytitle>tex.math.in.alt</refentrytitle>
12342 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
12343 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
12344 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
12345 </refmeta>
12346 <refnamediv>
12347 <refname>tex.math.in.alt</refname>
12348 <refpurpose>TeX notation used for equations</refpurpose>
12349 </refnamediv>
12350
12351 <refsynopsisdiv>
12352 <programlisting id="tex.math.in.alt.frag">
12353 &lt;xsl:param name="tex.math.in.alt"&gt;&lt;/xsl:param&gt;
12354 </programlisting>
12355 </refsynopsisdiv>
12356
12357 <refsection><info><title>Description</title></info>
12358
12359 <para>If you want type math directly in TeX notation in equations,
12360 this parameter specifies notation used. Currently are supported two
12361 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
12362 value means that you are not using TeX math at all.</para>
12363
12364 <para>Preferred way for including TeX alternative of math is inside of
12365 <tag>textobject</tag> element. Eg.:</para>
12366
12367 <programlisting>&lt;inlineequation&gt;
12368 &lt;inlinemediaobject&gt;
12369 &lt;imageobject&gt;
12370 &lt;imagedata fileref="eq1.gif"/&gt;
12371 &lt;/imageobject&gt;
12372 &lt;textobject&gt;&lt;phrase&gt;E=mc squared&lt;/phrase&gt;&lt;/textobject&gt;
12373 &lt;textobject role="tex"&gt;&lt;phrase&gt;E=mc^2&lt;/phrase&gt;&lt;/textobject&gt;
12374 &lt;/inlinemediaobject&gt;
12375 &lt;/inlineequation&gt;</programlisting>
12376
12377 <para>If you are using <tag>graphic</tag> element, you can
12378 store TeX inside <tag>alt</tag> element:</para>
12379
12380 <programlisting>&lt;inlineequation&gt;
12381 &lt;alt role="tex"&gt;a^2+b^2=c^2&lt;/alt&gt;
12382 &lt;graphic fileref="a2b2c2.gif"/&gt;  
12383 &lt;/inlineequation&gt;</programlisting>
12384
12385 <para>If you want use this feature, you should process your FO with
12386 PassiveTeX, which only supports TeX math notation. When calling
12387 stylsheet, don't forget to specify also
12388 passivetex.extensions=1.</para>
12389
12390 <para>If you want equations in HTML, just process generated file
12391 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
12392 dvi2bitmap program on result DVI file. You will get images for
12393 equations in your document.</para>
12394
12395 <warning>
12396   <para>This feature is useful for print/PDF output only if you
12397     use the obsolete and now unsupported PassiveTeX XSL-FO
12398     engine.</para>
12399 </warning>
12400
12401 </refsection>
12402
12403 <refsection><info><title>Related Parameters</title></info>
12404   <para><parameter>tex.math.delims</parameter>,
12405     <parameter>passivetex.extensions</parameter>,
12406     <parameter>tex.math.file</parameter></para>
12407 </refsection>
12408
12409 </refentry>
12410
12411 <refentry version="5.0" id="tex.math.delims">
12412 <refmeta>
12413 <refentrytitle>tex.math.delims</refentrytitle>
12414 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12415 </refmeta>
12416 <refnamediv>
12417 <refname>tex.math.delims</refname>
12418 <refpurpose>Should equations output for processing by TeX be
12419 surrounded by math mode delimiters?</refpurpose>
12420 </refnamediv> 
12421
12422 <refsynopsisdiv>
12423 <programlisting id="tex.math.delims.frag">
12424 &lt;xsl:param name="tex.math.delims" select="1"&gt;&lt;/xsl:param&gt;
12425 </programlisting>
12426 </refsynopsisdiv>
12427
12428 <refsection><info><title>Description</title></info>
12429
12430 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
12431 you should set this parameter to 0.</para>
12432
12433 <warning>
12434   <para>This feature is useful for print/PDF output only if you
12435   use the obsolete and now unsupported PassiveTeX XSL-FO
12436   engine.</para>
12437 </warning>
12438
12439 </refsection>
12440 <refsection><info><title>Related Parameters</title></info>
12441   <para><parameter>tex.math.in.alt</parameter>,
12442     <parameter>passivetex.extensions</parameter></para>
12443 </refsection>
12444
12445 <refsection><info><title>See Also</title></info>
12446   <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
12447     instruction to control whether delimiters are output.</para>
12448 </refsection>
12449
12450
12451 </refentry>
12452
12453 <refentry version="5.0" id="xep.extensions">
12454 <refmeta>
12455 <refentrytitle>xep.extensions</refentrytitle>
12456 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12457 </refmeta>
12458 <refnamediv>
12459 <refname>xep.extensions</refname>
12460 <refpurpose>Enable XEP extensions?</refpurpose>
12461 </refnamediv>
12462
12463 <refsynopsisdiv>
12464 <programlisting id="xep.extensions.frag">&lt;xsl:param name="xep.extensions" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12465 </refsynopsisdiv>
12466
12467 <refsection><info><title>Description</title></info>
12468
12469 <para>If non-zero,
12470 <link xlink:href="http://www.renderx.com/">XEP</link>
12471 extensions will be used. XEP extensions consists of PDF bookmarks,
12472 document information and better index processing.
12473 </para>
12474
12475 <para>This parameter can also affect which graphics file formats
12476 are supported</para>
12477 </refsection>
12478 </refentry>
12479
12480 </reference><reference id="dbk_ext" xml:base="../fo/param.xml"><title>Stylesheet Extensions</title>
12481 <refentry version="5.0" id="linenumbering.everyNth">
12482 <refmeta>
12483 <refentrytitle>linenumbering.everyNth</refentrytitle>
12484 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12485 </refmeta>
12486 <refnamediv>
12487 <refname>linenumbering.everyNth</refname>
12488 <refpurpose>Indicate which lines should be numbered</refpurpose>
12489 </refnamediv>
12490
12491 <refsynopsisdiv>
12492 <programlisting id="linenumbering.everyNth.frag">
12493 &lt;xsl:param name="linenumbering.everyNth"&gt;5&lt;/xsl:param&gt;
12494 </programlisting>
12495 </refsynopsisdiv>
12496
12497 <refsection><info><title>Description</title></info>
12498
12499 <para>If line numbering is enabled, everyNth line will be
12500 numbered. Note that numbering is one based, not zero based.
12501 </para>
12502
12503 </refsection>
12504 </refentry>
12505
12506 <refentry version="5.0" id="linenumbering.extension">
12507 <refmeta>
12508 <refentrytitle>linenumbering.extension</refentrytitle>
12509 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12510 </refmeta>
12511 <refnamediv>
12512 <refname>linenumbering.extension</refname>
12513 <refpurpose>Enable the line numbering extension</refpurpose>
12514 </refnamediv>
12515
12516 <refsynopsisdiv>
12517 <programlisting id="linenumbering.extension.frag">
12518 &lt;xsl:param name="linenumbering.extension" select="1"&gt;&lt;/xsl:param&gt;
12519 </programlisting>
12520 </refsynopsisdiv>
12521
12522 <refsection><info><title>Description</title></info>
12523
12524 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
12525 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
12526 have line numbers.
12527 </para>
12528
12529 </refsection>
12530 </refentry>
12531
12532 <refentry version="5.0" id="linenumbering.separator">
12533 <refmeta>
12534 <refentrytitle>linenumbering.separator</refentrytitle>
12535 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12536 </refmeta>
12537 <refnamediv>
12538 <refname>linenumbering.separator</refname>
12539 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
12540 </refnamediv>
12541
12542 <refsynopsisdiv>
12543 <programlisting id="linenumbering.separator.frag">
12544 &lt;xsl:param name="linenumbering.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;
12545 </programlisting>
12546 </refsynopsisdiv>
12547
12548 <refsection><info><title>Description</title></info>
12549
12550 <para>The separator is inserted between line numbers and lines in the
12551 verbatim environment. The default value is a single white space.
12552  Note the interaction with <parameter>linenumbering.width</parameter>
12553 </para>
12554
12555 </refsection>
12556 </refentry>
12557
12558 <refentry version="5.0" id="linenumbering.width">
12559 <refmeta>
12560 <refentrytitle>linenumbering.width</refentrytitle>
12561 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12562 </refmeta>
12563 <refnamediv>
12564 <refname>linenumbering.width</refname>
12565 <refpurpose>Indicates the width of line numbers</refpurpose>
12566 </refnamediv>
12567
12568 <refsynopsisdiv>
12569 <programlisting id="linenumbering.width.frag">
12570 &lt;xsl:param name="linenumbering.width"&gt;3&lt;/xsl:param&gt;
12571 </programlisting>
12572 </refsynopsisdiv>
12573
12574 <refsection><info><title>Description</title></info>
12575
12576 <para>If line numbering is enabled, line numbers will appear right
12577 justified in a field "width" characters wide.
12578 </para>
12579
12580 </refsection>
12581 </refentry>
12582
12583 <refentry version="5.0" id="tablecolumns.extension">
12584 <refmeta>
12585 <refentrytitle>tablecolumns.extension</refentrytitle>
12586 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12587 </refmeta>
12588 <refnamediv>
12589 <refname>tablecolumns.extension</refname>
12590 <refpurpose>Enable the table columns extension function</refpurpose>
12591 </refnamediv>
12592
12593 <refsynopsisdiv>
12594 <programlisting id="tablecolumns.extension.frag">
12595 &lt;xsl:param name="tablecolumns.extension" select="1"&gt;&lt;/xsl:param&gt;
12596 </programlisting>
12597 </refsynopsisdiv>
12598
12599 <refsection><info><title>Description</title></info>
12600
12601 <para>The table columns extension function adjusts the widths of table
12602 columns in the HTML result to more accurately reflect the specifications
12603 in the CALS table.
12604 </para>
12605
12606 </refsection>
12607 </refentry>
12608
12609 <refentry version="5.0" id="textinsert.extension">
12610   <refmeta>
12611     <refentrytitle>textinsert.extension</refentrytitle>
12612     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12613   </refmeta>
12614   <refnamediv>
12615     <refname>textinsert.extension</refname>
12616     <refpurpose>Enables the textinsert extension element</refpurpose>
12617   </refnamediv>
12618   <refsynopsisdiv>
12619     <programlisting id="textinsert.extension.frag">
12620   &lt;xsl:param name="textinsert.extension" select="1"&gt;&lt;/xsl:param&gt;
12621 </programlisting>
12622   </refsynopsisdiv>
12623   <refsection><info><title>Description</title></info>
12624     <para>The textinsert extension element inserts the contents of
12625       a file into the result tree (as text).</para>
12626     <note>
12627       <para>To use the textinsert extension element, you must use
12628         either Saxon or Xalan as your XSLT processor (it doesn&#8217;t
12629         work with xsltproc), along with either the DocBook Saxon
12630         extensions or DocBook Xalan extensions (for more
12631         information about those extensions, see <link role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
12632         the <parameter>use.extensions</parameter> and
12633         <parameter>textinsert.extension</parameter> parameters to
12634         <literal>1</literal>.</para>
12635       <para>As an alternative to using the textinsert element,
12636         consider using an Xinclude element with the
12637         <literal>parse="text"</literal> attribute and value
12638         specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
12639     </note>
12640   </refsection>
12641   <refsection><info><title>See Also</title></info>
12642     <para>You can also use the <tag class="xmlpi">dbhtml-include&#160;href</tag> processing
12643       instruction to insert external files &#8212; both files containing
12644       plain text and files with markup content (including HTML
12645       content).</para>
12646   </refsection>
12647   <refsection><info><title>More information</title></info>
12648     <para>For how-to documentation on inserting contents of
12649       external code files and other text files into output, see
12650       <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
12651     <para>For guidelines on inserting contents of
12652       HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
12653   </refsection>
12654 </refentry>
12655
12656 <refentry version="5.0" id="textdata.default.encoding">
12657 <refmeta>
12658 <refentrytitle>textdata.default.encoding</refentrytitle>
12659 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12660 </refmeta>
12661 <refnamediv>
12662 <refname>textdata.default.encoding</refname>
12663 <refpurpose>Default encoding of external text files which are included
12664 using textdata element</refpurpose>
12665 </refnamediv>
12666
12667 <refsynopsisdiv>
12668 <programlisting id="textdata.default.encoding.frag">
12669 &lt;xsl:param name="textdata.default.encoding"&gt;&lt;/xsl:param&gt;
12670 </programlisting>
12671 </refsynopsisdiv>
12672
12673 <refsection><info><title>Description</title></info>
12674
12675 <para>Specifies the encoding of any external text files included using
12676 <tag>textdata</tag> element. This value is used only when you do
12677 not specify encoding by the appropriate attribute 
12678 directly on textdata. An empty string is interpreted as the system
12679 default encoding.</para>
12680
12681 </refsection>
12682 </refentry>
12683
12684 <refentry version="5.0" id="use.extensions">
12685 <refmeta>
12686 <refentrytitle>use.extensions</refentrytitle>
12687 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12688 </refmeta>
12689 <refnamediv>
12690 <refname>use.extensions</refname>
12691 <refpurpose>Enable extensions</refpurpose>
12692 </refnamediv>
12693
12694 <refsynopsisdiv>
12695 <programlisting id="use.extensions.frag">
12696 &lt;xsl:param name="use.extensions" select="0"&gt;&lt;/xsl:param&gt;
12697 </programlisting>
12698 </refsynopsisdiv>
12699
12700 <refsection><info><title>Description</title></info>
12701
12702 <para>If non-zero, extensions may be used. Each extension is
12703 further controlled by its own parameter. But if
12704 <parameter>use.extensions</parameter> is zero, no extensions will
12705 be used.
12706 </para>
12707
12708 </refsection>
12709 </refentry>
12710
12711 </reference><reference id="labels" xml:base="../fo/param.xml"><title>Automatic labelling</title>
12712 <refentry version="5.0" id="appendix.autolabel">
12713 <refmeta>
12714 <refentrytitle>appendix.autolabel</refentrytitle>
12715 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
12716 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12717 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12718 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12719 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12720 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12721 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12722 </refmeta>
12723 <refnamediv>
12724 <refname>appendix.autolabel</refname>
12725 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
12726 </refnamediv>
12727
12728 <refsynopsisdiv>
12729 <programlisting id="appendix.autolabel.frag">
12730 &lt;xsl:param name="appendix.autolabel"&gt;A&lt;/xsl:param&gt;
12731 </programlisting>
12732 </refsynopsisdiv>
12733
12734 <refsection><info><title>Description</title></info>
12735
12736 <para>If non-zero, then appendices will be numbered using the
12737 parameter value as the number format if the value matches one of the
12738 following:
12739 </para>
12740
12741 <variablelist>
12742   <varlistentry>
12743     <term>1 or arabic</term>
12744     <listitem>
12745       <para>Arabic numeration (1, 2, 3 ...).</para>
12746     </listitem>
12747   </varlistentry>
12748   <varlistentry>
12749     <term>A or upperalpha</term>
12750     <listitem>
12751       <para>Uppercase letter numeration (A, B, C ...).</para>
12752     </listitem>
12753   </varlistentry>
12754   <varlistentry>
12755     <term>a or loweralpha</term>
12756     <listitem>
12757       <para>Lowercase letter numeration (a, b, c ...).</para>
12758     </listitem>
12759   </varlistentry>
12760   <varlistentry>
12761     <term>I or upperroman</term>
12762     <listitem>
12763       <para>Uppercase roman numeration (I, II, III ...).</para>
12764     </listitem>
12765   </varlistentry>
12766   <varlistentry>
12767     <term>i or lowerroman</term>
12768     <listitem>
12769       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12770     </listitem>
12771   </varlistentry>
12772 </variablelist>
12773
12774 <para>Any nonzero value other than the above will generate
12775 the default number format (upperalpha).
12776 </para>
12777
12778 </refsection>
12779 </refentry>
12780
12781 <refentry version="5.0" id="chapter.autolabel">
12782 <refmeta>
12783 <refentrytitle>chapter.autolabel</refentrytitle>
12784 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
12785 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12786 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12787 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12788 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12789 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12790 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12791 </refmeta>
12792 <refnamediv>
12793 <refname>chapter.autolabel</refname>
12794 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
12795 </refnamediv>
12796
12797 <refsynopsisdiv>
12798 <programlisting id="chapter.autolabel.frag">
12799 &lt;xsl:param name="chapter.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
12800 </refsynopsisdiv>
12801
12802 <refsection><info><title>Description</title></info>
12803
12804 <para>If non-zero, then chapters will be numbered using the parameter
12805 value as the number format if the value matches one of the following:
12806 </para>
12807
12808 <variablelist>
12809   <varlistentry>
12810     <term>1 or arabic</term>
12811     <listitem>
12812       <para>Arabic numeration (1, 2, 3 ...).</para>
12813     </listitem>
12814   </varlistentry>
12815   <varlistentry>
12816     <term>A or upperalpha</term>
12817     <listitem>
12818       <para>Uppercase letter numeration (A, B, C ...).</para>
12819     </listitem>
12820   </varlistentry>
12821   <varlistentry>
12822     <term>a or loweralpha</term>
12823     <listitem>
12824       <para>Lowercase letter numeration (a, b, c ...).</para>
12825     </listitem>
12826   </varlistentry>
12827   <varlistentry>
12828     <term>I or upperroman</term>
12829     <listitem>
12830       <para>Uppercase roman numeration (I, II, III ...).</para>
12831     </listitem>
12832   </varlistentry>
12833   <varlistentry>
12834     <term>i or lowerroman</term>
12835     <listitem>
12836       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12837     </listitem>
12838   </varlistentry>
12839 </variablelist>
12840
12841 <para>Any nonzero value other than the above will generate
12842 the default number format (arabic).
12843 </para>
12844
12845 </refsection>
12846 </refentry>
12847
12848 <refentry version="5.0" id="part.autolabel">
12849 <refmeta>
12850 <refentrytitle>part.autolabel</refentrytitle>
12851 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
12852 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12853 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12854 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12855 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12856 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12857 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12858 </refmeta>
12859 <refnamediv>
12860 <refname>part.autolabel</refname>
12861 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
12862 </refnamediv>
12863
12864 <refsynopsisdiv>
12865 <programlisting id="part.autolabel.frag">
12866 &lt;xsl:param name="part.autolabel"&gt;I&lt;/xsl:param&gt;
12867 </programlisting>
12868 </refsynopsisdiv>
12869
12870 <refsection><info><title>Description</title></info>
12871
12872 <para>If non-zero, then parts will be numbered using the parameter
12873 value as the number format if the value matches one of the following:
12874 </para>
12875
12876 <variablelist>
12877   <varlistentry>
12878     <term>1 or arabic</term>
12879     <listitem>
12880       <para>Arabic numeration (1, 2, 3 ...).</para>
12881     </listitem>
12882   </varlistentry>
12883   <varlistentry>
12884     <term>A or upperalpha</term>
12885     <listitem>
12886       <para>Uppercase letter numeration (A, B, C ...).</para>
12887     </listitem>
12888   </varlistentry>
12889   <varlistentry>
12890     <term>a or loweralpha</term>
12891     <listitem>
12892       <para>Lowercase letter numeration (a, b, c ...).</para>
12893     </listitem>
12894   </varlistentry>
12895   <varlistentry>
12896     <term>I or upperroman</term>
12897     <listitem>
12898       <para>Uppercase roman numeration (I, II, III ...).</para>
12899     </listitem>
12900   </varlistentry>
12901   <varlistentry>
12902     <term>i or lowerroman</term>
12903     <listitem>
12904       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12905     </listitem>
12906   </varlistentry>
12907 </variablelist>
12908
12909 <para>Any nonzero value other than the above will generate
12910 the default number format (upperroman).
12911 </para>
12912
12913
12914 </refsection>
12915 </refentry>
12916
12917 <refentry version="5.0" id="reference.autolabel">
12918 <refmeta>
12919 <refentrytitle>reference.autolabel</refentrytitle>
12920 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
12921 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12922 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12923 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12924 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12925 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12926 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12927 </refmeta>
12928 <refnamediv>
12929 <refname>reference.autolabel</refname>
12930 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
12931 </refnamediv>
12932 <refsynopsisdiv>
12933 <programlisting id="reference.autolabel.frag">
12934   &lt;xsl:param name="reference.autolabel"&gt;I&lt;/xsl:param&gt;
12935 </programlisting>
12936 </refsynopsisdiv>
12937 <refsection><info><title>Description</title></info>
12938 <para>If non-zero, references will be numbered using the parameter
12939   value as the number format if the value matches one of the
12940   following:
12941 </para>
12942 <variablelist>
12943   <varlistentry>
12944     <term>1 or arabic</term>
12945     <listitem>
12946       <para>Arabic numeration (1, 2, 3 ...).</para>
12947     </listitem>
12948   </varlistentry>
12949   <varlistentry>
12950     <term>A or upperalpha</term>
12951     <listitem>
12952       <para>Uppercase letter numeration (A, B, C ...).</para>
12953     </listitem>
12954   </varlistentry>
12955   <varlistentry>
12956     <term>a or loweralpha</term>
12957     <listitem>
12958       <para>Lowercase letter numeration (a, b, c ...).</para>
12959     </listitem>
12960   </varlistentry>
12961   <varlistentry>
12962     <term>I or upperroman</term>
12963     <listitem>
12964       <para>Uppercase roman numeration (I, II, III ...).</para>
12965     </listitem>
12966   </varlistentry>
12967   <varlistentry>
12968     <term>i or lowerroman</term>
12969     <listitem>
12970       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12971     </listitem>
12972   </varlistentry>
12973 </variablelist>
12974 <para>Any non-zero value other than the above will generate
12975 the default number format (upperroman).
12976 </para>
12977 </refsection>
12978 </refentry>
12979
12980 <refentry version="5.0" id="preface.autolabel">
12981 <refmeta>
12982 <refentrytitle>preface.autolabel</refentrytitle>
12983 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
12984 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12985 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12986 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12987 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12988 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12989 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12990 </refmeta>
12991 <refnamediv>
12992 <refname>preface.autolabel</refname>
12993 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
12994 </refnamediv>
12995
12996 <refsynopsisdiv>
12997 <programlisting id="preface.autolabel.frag">&lt;xsl:param name="preface.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
12998 </refsynopsisdiv>
12999
13000 <refsection><info><title>Description</title></info>
13001
13002 <para>If non-zero then prefaces will be numbered using the parameter
13003 value as the number format if the value matches one of the following:
13004 </para>
13005
13006 <variablelist>
13007   <varlistentry>
13008     <term>1 or arabic</term>
13009     <listitem>
13010       <para>Arabic numeration (1, 2, 3 ...).</para>
13011     </listitem>
13012   </varlistentry>
13013   <varlistentry>
13014     <term>A or upperalpha</term>
13015     <listitem>
13016       <para>Uppercase letter numeration (A, B, C ...).</para>
13017     </listitem>
13018   </varlistentry>
13019   <varlistentry>
13020     <term>a or loweralpha</term>
13021     <listitem>
13022       <para>Lowercase letter numeration (a, b, c ...).</para>
13023     </listitem>
13024   </varlistentry>
13025   <varlistentry>
13026     <term>I or upperroman</term>
13027     <listitem>
13028       <para>Uppercase roman numeration (I, II, III ...).</para>
13029     </listitem>
13030   </varlistentry>
13031   <varlistentry>
13032     <term>i or lowerroman</term>
13033     <listitem>
13034       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13035     </listitem>
13036   </varlistentry>
13037 </variablelist>
13038
13039 <para>Any nonzero value other than the above will generate
13040 the default number format (arabic).
13041 </para>
13042
13043
13044 </refsection>
13045 </refentry>
13046
13047 <refentry version="5.0" id="section.autolabel">
13048 <refmeta>
13049 <refentrytitle>section.autolabel</refentrytitle>
13050 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13051 </refmeta>
13052 <refnamediv>
13053 <refname>section.autolabel</refname>
13054 <refpurpose>Are sections enumerated?</refpurpose>
13055 </refnamediv>
13056
13057 <refsynopsisdiv>
13058 <programlisting id="section.autolabel.frag">&lt;xsl:param name="section.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
13059 </refsynopsisdiv>
13060
13061 <refsection><info><title>Description</title></info>
13062
13063 <para>If true (non-zero), unlabeled sections will be enumerated.
13064 </para>
13065
13066 </refsection>
13067 </refentry>
13068
13069 <refentry version="5.0" id="section.autolabel.max.depth">
13070 <refmeta>
13071 <refentrytitle>section.autolabel.max.depth</refentrytitle>
13072 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
13073 </refmeta>
13074 <refnamediv>
13075 <refname>section.autolabel.max.depth</refname>
13076 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
13077 </refnamediv>
13078
13079 <refsynopsisdiv>
13080 <programlisting id="section.autolabel.max.depth.frag">
13081 &lt;xsl:param name="section.autolabel.max.depth"&gt;8&lt;/xsl:param&gt;
13082 </programlisting>
13083 </refsynopsisdiv>
13084
13085 <refsection><info><title>Description</title></info>
13086
13087 <para>When section numbering is turned on by the
13088 <parameter>section.autolabel</parameter> parameter, then this
13089 parameter controls the depth of <tag>section</tag> nesting that is
13090 numbered.  Sections nested to a level deeper than this value will not
13091 be numbered.
13092 </para>
13093
13094 </refsection>
13095 </refentry>
13096
13097 <refentry version="5.0" id="section.label.includes.component.label">
13098 <refmeta>
13099 <refentrytitle>section.label.includes.component.label</refentrytitle>
13100 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13101 </refmeta>
13102 <refnamediv>
13103 <refname>section.label.includes.component.label</refname>
13104 <refpurpose>Do section labels include the component label?</refpurpose>
13105 </refnamediv>
13106
13107 <refsynopsisdiv>
13108 <programlisting id="section.label.includes.component.label.frag">&lt;xsl:param name="section.label.includes.component.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
13109 </refsynopsisdiv>
13110
13111 <refsection><info><title>Description</title></info>
13112
13113 <para>If non-zero, section labels are prefixed with the label of the
13114 component that contains them.
13115 </para>
13116
13117 </refsection>
13118 </refentry>
13119
13120 <refentry version="5.0" id="label.from.part">
13121 <refmeta>
13122 <refentrytitle>label.from.part</refentrytitle>
13123 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13124 </refmeta>
13125 <refnamediv>
13126 <refname>label.from.part</refname>
13127 <refpurpose>Renumber components in each part?</refpurpose>
13128 </refnamediv>
13129
13130 <refsynopsisdiv>
13131 <programlisting id="label.from.part.frag">
13132 &lt;xsl:param name="label.from.part" select="0"&gt;&lt;/xsl:param&gt;
13133 </programlisting>
13134 </refsynopsisdiv>
13135
13136 <refsection><info><title>Description</title></info>
13137
13138 <para>If <parameter>label.from.part</parameter> is non-zero, then
13139   numbering of components &#8212; <tag>preface</tag>,
13140   <tag>chapter</tag>, <tag>appendix</tag>, and
13141   <tag>reference</tag> (when <tag>reference</tag> occurs at the
13142   component level) &#8212; is re-started within each
13143   <tag>part</tag>.</para>
13144 <para>If <parameter>label.from.part</parameter> is zero (the
13145   default), numbering of components is <emphasis>not</emphasis>
13146   re-started within each <tag>part</tag>; instead, components are
13147   numbered sequentially throughout each <tag>book</tag>,
13148   regardless of whether or not they occur within <tag>part</tag>
13149   instances.</para>
13150
13151 </refsection>
13152 </refentry>
13153
13154 <refentry version="5.0" id="component.label.includes.part.label">
13155 <refmeta>
13156 <refentrytitle>component.label.includes.part.label</refentrytitle>
13157 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13158 </refmeta>
13159 <refnamediv>
13160 <refname>component.label.includes.part.label</refname>
13161 <refpurpose>Do component labels include the part label?</refpurpose>
13162 </refnamediv>
13163
13164 <refsynopsisdiv>
13165 <programlisting id="component.label.includes.part.label.frag">&lt;xsl:param name="component.label.includes.part.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
13166 </refsynopsisdiv>
13167
13168 <refsection><info><title>Description</title></info>
13169
13170 <para>If non-zero, number labels for <tag>chapter</tag>,
13171 <tag>appendix</tag>, and other component elements are prefixed with
13172 the label of the part element that contains them.  So you might see
13173 Chapter II.3 instead of Chapter 3.  Also, the labels for formal
13174 elements such as <tag>table</tag> and <tag>figure</tag> will include
13175 the part label.  If there is no part element container, then no prefix
13176 is generated.
13177 </para>
13178 <para>
13179 This feature is most useful when the
13180 <parameter>label.from.part</parameter> parameter is turned on.
13181 In that case, there would be more than one <tag>chapter</tag>
13182 <quote>1</quote>, and the extra part label prefix will identify
13183 each chapter unambiguously.
13184 </para>
13185
13186 </refsection>
13187 </refentry>
13188
13189 </reference><reference id="xslt" xml:base="../fo/param.xml"><title>XSLT Processing</title>
13190 <refentry version="5.0" id="rootid">
13191 <refmeta>
13192 <refentrytitle>rootid</refentrytitle>
13193 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13194 </refmeta>
13195 <refnamediv>
13196 <refname>rootid</refname>
13197 <refpurpose>Specify the root element to format</refpurpose>
13198 </refnamediv>
13199
13200 <refsynopsisdiv>
13201 <programlisting id="rootid.frag">
13202 &lt;xsl:param name="rootid"&gt;&lt;/xsl:param&gt;</programlisting>
13203 </refsynopsisdiv>
13204
13205 <refsection><info><title>Description</title></info>
13206
13207 <para>If <parameter>rootid</parameter> is not empty, it must be the
13208 value of an ID that occurs in the document being formatted. The entire
13209 document will be loaded and parsed, but formatting will begin at the
13210 element identified, rather than at the root. For example, this allows
13211 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
13212 <para>Because the entire document is available to the processor, automatic
13213 numbering, cross references, and other dependencies are correctly
13214 resolved.</para>
13215
13216 </refsection>
13217 </refentry>
13218
13219 </reference><reference id="meta" xml:base="../fo/param.xml"><title>Meta/*Info</title>
13220 <refentry version="5.0" id="make.single.year.ranges">
13221 <refmeta>
13222 <refentrytitle>make.single.year.ranges</refentrytitle>
13223 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13224 </refmeta>
13225 <refnamediv>
13226 <refname>make.single.year.ranges</refname>
13227 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
13228 </refnamediv>
13229
13230 <refsynopsisdiv>
13231 <programlisting id="make.single.year.ranges.frag">
13232 &lt;xsl:param name="make.single.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
13233 </refsynopsisdiv>
13234
13235 <refsection><info><title>Description</title></info>
13236
13237 <para>If non-zero, year ranges that span a single year will be printed
13238 in range notation (1998-1999) instead of discrete notation
13239 (1998, 1999).</para>
13240
13241 </refsection>
13242 </refentry>
13243
13244 <refentry version="5.0" id="make.year.ranges">
13245 <refmeta>
13246 <refentrytitle>make.year.ranges</refentrytitle>
13247 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13248 </refmeta>
13249 <refnamediv>
13250 <refname>make.year.ranges</refname>
13251 <refpurpose>Collate copyright years into ranges?</refpurpose>
13252 </refnamediv>
13253
13254 <refsynopsisdiv>
13255 <programlisting id="make.year.ranges.frag">&lt;xsl:param name="make.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
13256 </refsynopsisdiv>
13257
13258 <refsection><info><title>Description</title></info>
13259
13260 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
13261 collated into ranges.
13262 This works only if each year number is put into a separate
13263 year element.  The copyright element permits multiple
13264 year elements. If a year element contains a dash or
13265 a comma, then that year element will not be merged into
13266 any range.
13267 </para>
13268
13269 </refsection>
13270 </refentry>
13271
13272 <refentry version="5.0" id="author.othername.in.middle">
13273 <refmeta>
13274 <refentrytitle>author.othername.in.middle</refentrytitle>
13275 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13276 </refmeta>
13277 <refnamediv>
13278 <refname>author.othername.in.middle</refname>
13279 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
13280 middle name?</refpurpose>
13281 </refnamediv>
13282
13283 <refsynopsisdiv>
13284 <programlisting id="author.othername.in.middle.frag">
13285 &lt;xsl:param name="author.othername.in.middle" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
13286 </refsynopsisdiv>
13287
13288 <refsection><info><title>Description</title></info>
13289
13290 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
13291 appears between the <tag>firstname</tag> and
13292 <tag>surname</tag>.  Otherwise, <tag>othername</tag>
13293 is suppressed.
13294 </para>
13295
13296 </refsection>
13297 </refentry>
13298
13299 </reference><reference id="refentry" xml:base="../fo/param.xml"><title>Reference Pages</title>
13300 <refentry version="5.0" id="funcsynopsis.decoration">
13301 <refmeta>
13302 <refentrytitle>funcsynopsis.decoration</refentrytitle>
13303 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13304 </refmeta>
13305 <refnamediv>
13306 <refname>funcsynopsis.decoration</refname>
13307 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
13308 </refnamediv>
13309
13310 <refsynopsisdiv>
13311 <programlisting id="funcsynopsis.decoration.frag">
13312 &lt;xsl:param name="funcsynopsis.decoration" select="1"&gt;&lt;/xsl:param&gt;
13313 </programlisting>
13314 </refsynopsisdiv>
13315
13316 <refsection><info><title>Description</title></info>
13317
13318 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
13319 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
13320 templates that can be redefined in a customization layer.
13321 </para>
13322
13323 </refsection>
13324 </refentry>
13325
13326 <refentry version="5.0" id="funcsynopsis.style">
13327 <refmeta>
13328 <refentrytitle>funcsynopsis.style</refentrytitle>
13329 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13330 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
13331 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
13332 </refmeta>
13333 <refnamediv>
13334 <refname>funcsynopsis.style</refname>
13335 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
13336 </refnamediv>
13337
13338 <refsynopsisdiv>
13339 <programlisting id="funcsynopsis.style.frag">&lt;xsl:param name="funcsynopsis.style"&gt;kr&lt;/xsl:param&gt;</programlisting>
13340 </refsynopsisdiv>
13341
13342 <refsection><info><title>Description</title></info>
13343
13344 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
13345 ANSI-style function synopses are generated for a
13346 <tag>funcsynopsis</tag>, otherwise K&amp;R-style
13347 function synopses are generated.
13348 </para>
13349
13350 </refsection>
13351 </refentry>
13352
13353 <refentry version="5.0" id="function.parens">
13354 <refmeta>
13355 <refentrytitle>function.parens</refentrytitle>
13356 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13357 </refmeta>
13358 <refnamediv>
13359 <refname>function.parens</refname>
13360 <refpurpose>Generate parens after a function?</refpurpose>
13361 </refnamediv>
13362
13363 <refsynopsisdiv>
13364 <programlisting id="function.parens.frag">
13365 &lt;xsl:param name="function.parens" select="0"&gt;&lt;/xsl:param&gt;
13366 </programlisting>
13367 </refsynopsisdiv>
13368
13369 <refsection><info><title>Description</title></info>
13370
13371 <para>If non-zero, the formatting of a <tag>function</tag> element
13372 will include generated parentheses.
13373 </para>
13374
13375 </refsection>
13376 </refentry>
13377
13378 <refentry version="5.0" id="refentry.generate.name">
13379 <refmeta>
13380 <refentrytitle>refentry.generate.name</refentrytitle>
13381 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13382 </refmeta>
13383 <refnamediv>
13384 <refname>refentry.generate.name</refname>
13385 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
13386 </refnamediv>
13387
13388 <refsynopsisdiv>
13389 <programlisting id="refentry.generate.name.frag">
13390 &lt;xsl:param name="refentry.generate.name" select="1"&gt;&lt;/xsl:param&gt;
13391 </programlisting>
13392 </refsynopsisdiv>
13393
13394 <refsection><info><title>Description</title></info>
13395
13396 <para>If non-zero, a "NAME" section title is output before the list
13397 of <tag>refname</tag>s. This parameter and
13398 <parameter>refentry.generate.title</parameter> are mutually
13399 exclusive. This means that if you change this parameter to zero, you
13400 should set <parameter>refentry.generate.title</parameter> to non-zero unless
13401 you want get quite strange output.
13402 </para>
13403
13404 </refsection>
13405 </refentry>
13406
13407 <refentry version="5.0" id="refentry.generate.title">
13408 <refmeta>
13409 <refentrytitle>refentry.generate.title</refentrytitle>
13410 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13411 </refmeta>
13412 <refnamediv>
13413 <refname>refentry.generate.title</refname>
13414 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
13415 </refnamediv>
13416
13417 <refsynopsisdiv>
13418 <programlisting id="refentry.generate.title.frag">
13419 &lt;xsl:param name="refentry.generate.title" select="0"&gt;&lt;/xsl:param&gt;
13420 </programlisting>
13421 </refsynopsisdiv>
13422
13423 <refsection><info><title>Description</title></info>
13424
13425 <para>If non-zero, the reference page title or first name is
13426 output before the list of <tag>refname</tag>s. This parameter and
13427 <parameter>refentry.generate.name</parameter> are mutually exclusive.
13428 This means that if you change this parameter to non-zero, you
13429 should set <parameter>refentry.generate.name</parameter> to zero unless
13430 you want get quite strange output.</para>
13431
13432
13433 </refsection>
13434 </refentry>
13435
13436 <refentry version="5.0" id="refentry.pagebreak">
13437 <refmeta>
13438 <refentrytitle>refentry.pagebreak</refentrytitle>
13439 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13440 </refmeta>
13441 <refnamediv>
13442 <refname>refentry.pagebreak</refname>
13443 <refpurpose>Start each refentry on a new page</refpurpose>
13444 </refnamediv>
13445
13446 <refsynopsisdiv>
13447 <programlisting id="refentry.pagebreak.frag">&lt;xsl:param name="refentry.pagebreak" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
13448 </refsynopsisdiv>
13449
13450 <refsection><info><title>Description</title></info>
13451
13452 <para>If non-zero (the default), each <tag>refentry</tag>
13453 element will start on a new page.  If zero, a page
13454 break will not be generated between <tag>refentry</tag> elements.
13455 The exception is when the <tag>refentry</tag> elements are children of
13456 a <tag>part</tag> element, in which case the page breaks are always
13457 retained.  That is because a <tag>part</tag> element does not generate
13458 a page-sequence for its children, so each <tag>refentry</tag> must
13459 start its own page-sequence.
13460 </para>
13461
13462 </refsection>
13463 </refentry>
13464
13465 <refentry version="5.0" id="refentry.title.properties">
13466 <refmeta>
13467 <refentrytitle>refentry.title.properties</refentrytitle>
13468 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13469 </refmeta>
13470 <refnamediv>
13471 <refname>refentry.title.properties</refname>
13472 <refpurpose>Title properties for a refentry title</refpurpose>
13473 </refnamediv>
13474
13475 <refsynopsisdiv>
13476 <programlisting id="refentry.title.properties.frag">
13477 &lt;xsl:attribute-set name="refentry.title.properties"&gt;
13478   &lt;xsl:attribute name="font-family"&gt;
13479     &lt;xsl:value-of select="$title.font.family"&gt;&lt;/xsl:value-of&gt;
13480   &lt;/xsl:attribute&gt;
13481   &lt;xsl:attribute name="font-size"&gt;18pt&lt;/xsl:attribute&gt;
13482   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
13483   &lt;xsl:attribute name="space-after"&gt;1em&lt;/xsl:attribute&gt;
13484   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
13485   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
13486   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
13487   &lt;xsl:attribute name="space-before.optimum"&gt;1.0em&lt;/xsl:attribute&gt;
13488   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
13489   &lt;xsl:attribute name="space-after.optimum"&gt;0.5em&lt;/xsl:attribute&gt;
13490   &lt;xsl:attribute name="space-after.minimum"&gt;0.4em&lt;/xsl:attribute&gt;
13491   &lt;xsl:attribute name="space-after.maximum"&gt;0.6em&lt;/xsl:attribute&gt;
13492   &lt;xsl:attribute name="start-indent"&gt;&lt;xsl:value-of select="$title.margin.left"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
13493 &lt;/xsl:attribute-set&gt;
13494 </programlisting>
13495 </refsynopsisdiv>
13496
13497 <refsection><info><title>Description</title></info>
13498
13499 <para>Formatting properties applied to the title generated for the
13500 <tag>refnamediv</tag> part of output for
13501 <tag>refentry</tag> when the value of the
13502 <parameter>refentry.generate.title</parameter> parameter is
13503 non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter>
13504 attribute-set, computed from the location of the
13505 <tag>refentry</tag> in the section hierarchy.</para>
13506
13507 <note>
13508   <para>This parameter has no effect on the the title generated for
13509   the <tag>refnamediv</tag> part of output for
13510   <tag>refentry</tag> when the value of the
13511   <parameter>refentry.generate.name</parameter> parameter is
13512   non-zero. By default, that title is formatted with the same
13513   properties as the titles for all other first-level children of
13514   <tag>refentry</tag>.</para>
13515 </note>
13516
13517 </refsection>
13518 </refentry>
13519
13520 <refentry version="5.0" id="refentry.xref.manvolnum">
13521 <refmeta>
13522 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
13523 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13524 </refmeta>
13525 <refnamediv>
13526 <refname>refentry.xref.manvolnum</refname>
13527 <refpurpose>Output <tag>manvolnum</tag> as part of 
13528 <tag>refentry</tag> cross-reference?</refpurpose>
13529 </refnamediv>
13530
13531 <refsynopsisdiv>
13532 <programlisting id="refentry.xref.manvolnum.frag">
13533 &lt;xsl:param name="refentry.xref.manvolnum" select="1"&gt;&lt;/xsl:param&gt;
13534 </programlisting>
13535 </refsynopsisdiv>
13536
13537 <refsection><info><title>Description</title></info>
13538
13539 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
13540 <tag>refentry</tag>s, either with <tag>xref</tag>
13541 or <tag>citerefentry</tag>.
13542 </para>
13543
13544 </refsection>
13545 </refentry>
13546
13547 <refentry version="5.0" id="refclass.suppress">
13548 <refmeta>
13549 <refentrytitle>refclass.suppress</refentrytitle>
13550 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13551 </refmeta>
13552 <refnamediv>
13553 <refname>refclass.suppress</refname>
13554 <refpurpose>Suppress display of refclass contents?</refpurpose>
13555 </refnamediv>
13556
13557 <refsynopsisdiv>
13558 <programlisting id="refclass.suppress.frag">
13559 &lt;xsl:param name="refclass.suppress" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
13560 </refsynopsisdiv>
13561
13562 <refsection><info><title>Description</title></info>
13563
13564 <para>If the value of <parameter>refclass.suppress</parameter> is
13565 non-zero, then display of <tag>refclass</tag> contents is
13566 suppressed in output.</para>
13567
13568 </refsection>
13569 </refentry>
13570
13571 </reference><reference id="tables" xml:base="../fo/param.xml"><title>Tables</title>
13572 <refentry version="5.0" id="default.table.width">
13573 <refmeta>
13574 <refentrytitle>default.table.width</refentrytitle>
13575 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13576 </refmeta>
13577 <refnamediv>
13578 <refname>default.table.width</refname>
13579 <refpurpose>The default width of tables</refpurpose>
13580 </refnamediv>
13581 <refsynopsisdiv>
13582 <programlisting id="default.table.width.frag">
13583 &lt;xsl:param name="default.table.width"&gt;&lt;/xsl:param&gt;
13584 </programlisting>
13585 </refsynopsisdiv>
13586 <refsection><info><title>Description</title></info>
13587 <para>If non-zero, this value will be used for the
13588 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
13589 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or 
13590 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
13591 </refsection>
13592 </refentry>
13593
13594 <refentry version="5.0" id="nominal.table.width">
13595 <refmeta>
13596 <refentrytitle>nominal.table.width</refentrytitle>
13597 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13598 </refmeta>
13599 <refnamediv>
13600 <refname>nominal.table.width</refname>
13601 <refpurpose>The (absolute) nominal width of tables</refpurpose>
13602 </refnamediv>
13603
13604 <refsynopsisdiv>
13605 <programlisting id="nominal.table.width.frag">
13606 &lt;xsl:param name="nominal.table.width"&gt;6in&lt;/xsl:param&gt;
13607 </programlisting>
13608 </refsynopsisdiv>
13609
13610 <refsection><info><title>Description</title></info>
13611
13612 <para>In order to convert CALS column widths into HTML column widths, it
13613 is sometimes necessary to have an absolute table width to use for conversion
13614 of mixed absolute and relative widths. This value must be an absolute
13615 length (not a percentage).</para>
13616
13617 </refsection>
13618 </refentry>
13619
13620 <refentry version="5.0" id="default.table.frame">
13621 <refmeta>
13622 <refentrytitle>default.table.frame</refentrytitle>
13623 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13624 </refmeta>
13625 <refnamediv>
13626 <refname>default.table.frame</refname>
13627 <refpurpose>The default framing of tables</refpurpose>
13628 </refnamediv>
13629
13630 <refsynopsisdiv>
13631 <programlisting id="default.table.frame.frag">
13632 &lt;xsl:param name="default.table.frame"&gt;all&lt;/xsl:param&gt;
13633 </programlisting>
13634 </refsynopsisdiv>
13635
13636 <refsection><info><title>Description</title></info>
13637
13638 <para>This value will be used when there is no frame attribute on the
13639 table. </para>
13640
13641 </refsection>
13642 </refentry>
13643
13644 <refentry version="5.0" id="default.table.rules">
13645 <refmeta>
13646 <refentrytitle>default.table.rules</refentrytitle>
13647 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13648 </refmeta>
13649 <refnamediv>
13650 <refname>default.table.rules</refname>
13651 <refpurpose>The default column and row rules for tables using HTML markup</refpurpose>
13652 </refnamediv>
13653
13654 <refsynopsisdiv>
13655 <programlisting id="default.table.rules.frag">
13656 &lt;xsl:param name="default.table.rules"&gt;none&lt;/xsl:param&gt;
13657 </programlisting>
13658 </refsynopsisdiv>
13659
13660 <refsection><info><title>Description</title></info>
13661
13662 <para>Tables using HTML markup elements can use an attribute
13663 named <tag class="attribute">rules</tag> on the <tag>table</tag> or
13664 <tag>informaltable</tag> element
13665 to specify whether column and row border rules should be 
13666 displayed. This parameter lets you specify a global default
13667 style for all HTML tables that don't otherwise have
13668 that attribute.</para>
13669 <para>These are the supported values:</para>
13670
13671 <variablelist>
13672 <varlistentry><term>all</term>
13673 <listitem>
13674 <para>Rules will appear between all rows and columns.</para>
13675 </listitem>
13676 </varlistentry>
13677
13678 <varlistentry><term>rows</term>
13679 <listitem>
13680 <para>Rules will appear between rows only.</para>
13681 </listitem>
13682 </varlistentry>
13683
13684 <varlistentry><term>cols</term>
13685 <listitem>
13686 <para>Rules will appear between columns only.</para>
13687 </listitem>
13688 </varlistentry>
13689
13690 <varlistentry><term>groups</term>
13691 <listitem>
13692 <para>Rules will appear between row groups (thead, tfoot, tbody).
13693 No support for rules between column groups yet.
13694 </para>
13695 </listitem>
13696 </varlistentry>
13697
13698 <varlistentry><term>none</term>
13699 <listitem>
13700 <para>No rules.  This is the default value.
13701 </para>
13702 </listitem>
13703 </varlistentry>
13704
13705 </variablelist>
13706
13707 <para>The border after the last row and the border after
13708 the last column are not affected by
13709 this setting. Those borders are controlled by
13710 the <tag class="attribute">frame</tag> attribute on the table element.
13711 </para>
13712
13713 </refsection>
13714 </refentry>
13715
13716 <refentry version="5.0" id="table.cell.padding">
13717 <refmeta>
13718 <refentrytitle>table.cell.padding</refentrytitle>
13719 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13720 </refmeta>
13721 <refnamediv>
13722 <refname>table.cell.padding</refname>
13723 <refpurpose>Specifies the padding of table cells</refpurpose>
13724 </refnamediv>
13725
13726 <refsynopsisdiv>
13727 <programlisting id="table.cell.padding.frag">
13728 &lt;xsl:attribute-set name="table.cell.padding"&gt;
13729   &lt;xsl:attribute name="padding-start"&gt;2pt&lt;/xsl:attribute&gt;
13730   &lt;xsl:attribute name="padding-end"&gt;2pt&lt;/xsl:attribute&gt;
13731   &lt;xsl:attribute name="padding-top"&gt;2pt&lt;/xsl:attribute&gt;
13732   &lt;xsl:attribute name="padding-bottom"&gt;2pt&lt;/xsl:attribute&gt;
13733 &lt;/xsl:attribute-set&gt;
13734 </programlisting>
13735 </refsynopsisdiv>
13736
13737 <refsection><info><title>Description</title></info>
13738
13739 <para>Specifies the padding of table cells.</para>
13740
13741 </refsection>
13742 </refentry>
13743
13744 <refentry version="5.0" id="table.frame.border.thickness">
13745 <refmeta>
13746 <refentrytitle>table.frame.border.thickness</refentrytitle>
13747 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13748 </refmeta>
13749 <refnamediv>
13750 <refname>table.frame.border.thickness</refname>
13751 <refpurpose>Specifies the thickness of the frame border</refpurpose>
13752 </refnamediv>
13753
13754 <refsynopsisdiv>
13755 <programlisting id="table.frame.border.thickness.frag">
13756 &lt;xsl:param name="table.frame.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
13757 </programlisting>
13758 </refsynopsisdiv>
13759
13760 <refsection><info><title>Description</title></info>
13761
13762 <para>Specifies the thickness of the border on the table's frame.</para>
13763
13764 </refsection>
13765 </refentry>
13766
13767 <refentry version="5.0" id="table.frame.border.style">
13768 <refmeta>
13769 <refentrytitle>table.frame.border.style</refentrytitle>
13770 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
13771 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13772 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13773 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
13774 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
13775 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
13776 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>                       
13777 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
13778 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
13779 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>          
13780 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13781 </refmeta>
13782 <refnamediv>
13783 <refname>table.frame.border.style</refname>
13784 <refpurpose>Specifies the border style of table frames</refpurpose>
13785 </refnamediv>
13786
13787 <refsynopsisdiv>
13788 <programlisting id="table.frame.border.style.frag">
13789 &lt;xsl:param name="table.frame.border.style"&gt;solid&lt;/xsl:param&gt;
13790 </programlisting>
13791 </refsynopsisdiv>
13792
13793 <refsection><info><title>Description</title></info>
13794
13795 <para>Specifies the border style of table frames.</para>
13796
13797 </refsection>
13798 </refentry>
13799
13800 <refentry version="5.0" id="table.frame.border.color">
13801 <refmeta>
13802 <refentrytitle>table.frame.border.color</refentrytitle>
13803 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
13804 </refmeta>
13805 <refnamediv>
13806 <refname>table.frame.border.color</refname>
13807 <refpurpose>Specifies the border color of table frames</refpurpose>
13808 </refnamediv>
13809
13810 <refsynopsisdiv>
13811 <programlisting id="table.frame.border.color.frag">
13812
13813 &lt;xsl:param name="table.frame.border.color"&gt;black&lt;/xsl:param&gt;
13814 </programlisting>
13815 </refsynopsisdiv>
13816
13817 <refsection><info><title>Description</title></info>
13818
13819 <para>Specifies the border color of table frames.</para>
13820
13821 </refsection>
13822 </refentry>
13823
13824 <refentry version="5.0" id="table.cell.border.thickness">
13825 <refmeta>
13826 <refentrytitle>table.cell.border.thickness</refentrytitle>
13827 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13828 </refmeta>
13829 <refnamediv>
13830 <refname>table.cell.border.thickness</refname>
13831 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
13832 </refnamediv>
13833
13834 <refsynopsisdiv>
13835 <programlisting id="table.cell.border.thickness.frag">
13836 &lt;xsl:param name="table.cell.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
13837 </programlisting>
13838 </refsynopsisdiv>
13839
13840 <refsection><info><title>Description</title></info>
13841
13842 <para>If non-zero, specifies the thickness of borders on table
13843 cells. The units are points. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
13844 CSS</link></para>
13845
13846 <note>
13847   <para>To control properties of cell borders in HTML output, you must also turn on the 
13848   <parameter>table.borders.with.css</parameter> parameter.</para>
13849 </note>
13850
13851 </refsection>
13852 </refentry>
13853
13854 <refentry version="5.0" id="table.cell.border.style">
13855 <refmeta>
13856 <refentrytitle>table.cell.border.style</refentrytitle>
13857 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
13858 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13859 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13860 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
13861 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
13862 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
13863 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>                       
13864 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
13865 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
13866 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>          
13867 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13868 </refmeta>
13869 <refnamediv>
13870 <refname>table.cell.border.style</refname>
13871 <refpurpose>Specifies the border style of table cells</refpurpose>
13872 </refnamediv>
13873
13874 <refsynopsisdiv>
13875 <programlisting id="table.cell.border.style.frag">
13876 &lt;xsl:param name="table.cell.border.style"&gt;solid&lt;/xsl:param&gt;
13877 </programlisting>
13878 </refsynopsisdiv>
13879
13880 <refsection><info><title>Description</title></info>
13881
13882 <para>Specifies the border style of table cells.</para>
13883
13884 <note>
13885   <para>To control properties of cell borders in HTML output, you must also turn on the 
13886   <parameter>table.borders.with.css</parameter> parameter.</para>
13887 </note>
13888
13889 </refsection>
13890 </refentry>
13891
13892 <refentry version="5.0" id="table.cell.border.color">
13893 <refmeta>
13894 <refentrytitle>table.cell.border.color</refentrytitle>
13895 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
13896 </refmeta>
13897 <refnamediv>
13898 <refname>table.cell.border.color</refname>
13899 <refpurpose>Specifies the border color of table cells</refpurpose>
13900 </refnamediv>
13901
13902 <refsynopsisdiv>
13903 <programlisting id="table.cell.border.color.frag">
13904
13905 &lt;xsl:param name="table.cell.border.color"&gt;black&lt;/xsl:param&gt;
13906 </programlisting>
13907 </refsynopsisdiv>
13908
13909 <refsection><info><title>Description</title></info>
13910
13911 <para>Set the color of table cell borders. If non-zero, the value is used
13912 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
13913 <literal>color</literal> is either a keyword or a numerical RGB specification.
13914 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
13915 navy, olive, orange, purple, red, silver, teal, white, and
13916 yellow.</para>
13917
13918 <note>
13919   <para>To control properties of cell borders in HTML output, you must also turn on the 
13920   <parameter>table.borders.with.css</parameter> parameter.</para>
13921 </note>
13922
13923 </refsection>
13924 </refentry>
13925
13926 <refentry version="5.0" id="table.table.properties">
13927 <refmeta>
13928 <refentrytitle>table.table.properties</refentrytitle>
13929 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13930 </refmeta>
13931 <refnamediv>
13932 <refname>table.table.properties</refname>
13933 <refpurpose>Properties associated with a table</refpurpose>
13934 </refnamediv>
13935
13936 <refsynopsisdiv>
13937 <programlisting id="table.table.properties.frag">
13938 &lt;xsl:attribute-set name="table.table.properties"&gt;
13939   &lt;xsl:attribute name="border-before-width.conditionality"&gt;retain&lt;/xsl:attribute&gt;
13940   &lt;xsl:attribute name="border-collapse"&gt;collapse&lt;/xsl:attribute&gt;
13941 &lt;/xsl:attribute-set&gt;
13942 </programlisting>
13943 </refsynopsisdiv>
13944
13945 <refsection><info><title>Description</title></info>
13946
13947 <para>The styling for tables. This parameter should really
13948 have been called <literal>table.properties</literal>, but that parameter
13949 name was inadvertently established for the block-level properties
13950 of the table as a whole.
13951 </para>
13952
13953 <para>See also <parameter>table.properties</parameter>.</para>
13954
13955 </refsection>
13956 </refentry>
13957
13958 </reference><reference id="links" xml:base="../fo/param.xml"><title>Linking</title>
13959 <refentry version="5.0" id="current.docid"> 
13960 <refmeta> 
13961 <refentrytitle>current.docid</refentrytitle> 
13962 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
13963 </refmeta> 
13964 <refnamediv> 
13965 <refname>current.docid</refname> 
13966 <refpurpose>targetdoc identifier for the document being
13967 processed</refpurpose> 
13968 </refnamediv> 
13969 <refsynopsisdiv> <programlisting id="current.docid.frag">
13970 &lt;xsl:param name="current.docid"&gt;&lt;/xsl:param&gt;
13971 </programlisting> 
13972 </refsynopsisdiv> 
13973 <refsection><info><title>Description</title></info> 
13974  
13975 <para>When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> database file. This parameter passes to the stylesheet
13976 the targetdoc identifier of the current document, since that
13977 identifier does not appear in the document itself. </para>
13978 <para>This parameter can also be used for print output. If an olink's  <literal>targetdoc</literal>  id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also <parameter>olink.doctitle</parameter> to enable that feature.</para> 
13979 </refsection> 
13980 </refentry>
13981
13982 <refentry version="5.0" id="collect.xref.targets"> 
13983 <refmeta> 
13984 <refentrytitle>collect.xref.targets</refentrytitle> 
13985 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
13986 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
13987 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
13988 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
13989 </refmeta> 
13990 <refnamediv> 
13991 <refname>collect.xref.targets</refname> 
13992 <refpurpose>Controls whether cross reference data is
13993 collected</refpurpose> 
13994 </refnamediv> 
13995 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
13996 &lt;xsl:param name="collect.xref.targets"&gt;no&lt;/xsl:param&gt;
13997 </programlisting> 
13998 </refsynopsisdiv> 
13999 <refsection><info><title>Description</title></info> 
14000  
14001 <para>
14002 In order to resolve olinks efficiently, the stylesheets can
14003 generate an external data file containing information about
14004 all potential cross reference endpoints in a document.
14005 This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is  <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output.
14006 See also <parameter>targets.filename</parameter>.
14007 </para> 
14008 </refsection> 
14009 </refentry>
14010
14011 <refentry version="5.0" id="insert.olink.page.number">
14012 <refmeta>
14013 <refentrytitle>insert.olink.page.number</refentrytitle>
14014 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
14015 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14016 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14017 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14018 </refmeta>
14019 <refnamediv>
14020 <refname>insert.olink.page.number</refname>
14021 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
14022 </refnamediv>
14023
14024 <refsynopsisdiv>
14025 <programlisting id="insert.olink.page.number.frag">
14026 &lt;xsl:param name="insert.olink.page.number"&gt;no&lt;/xsl:param&gt;
14027 </programlisting>
14028 </refsynopsisdiv>
14029
14030 <refsection><info><title>Description</title></info>
14031
14032 <para>The value of this parameter determines if
14033 cross references made between documents with
14034 <tag>olink</tag> will 
14035 include page number citations.
14036 In most cases this is only applicable to references in printed output.
14037 </para>
14038 <para>The parameter has three possible values.
14039 </para>
14040 <variablelist>
14041 <varlistentry>
14042 <term>no</term>
14043 <listitem><para>No page number references will be generated for olinks.
14044 </para></listitem>
14045 </varlistentry>
14046 <varlistentry>
14047 <term>yes</term>
14048 <listitem><para>Page number references will be generated
14049 for all <tag>olink</tag> references.
14050 The style of page reference may be changed
14051 if an <tag class="attribute">xrefstyle</tag>
14052 attribute is used.
14053 </para></listitem>
14054 </varlistentry>
14055 <varlistentry>
14056 <term>maybe</term>
14057 <listitem><para>Page number references will not be generated
14058 for an <tag>olink</tag> element unless 
14059 it has an
14060 <tag class="attribute">xrefstyle</tag>
14061 attribute whose value specifies a page reference.
14062 </para></listitem>
14063 </varlistentry>
14064 </variablelist>
14065 <para>Olinks that point to targets within the same document
14066 are treated as <tag>xref</tag>s, and controlled by
14067 the <parameter>insert.xref.page.number</parameter> parameter.
14068 </para>
14069
14070 <para>Page number references for olinks to
14071 external documents can only be inserted if the 
14072 information exists in the olink database. 
14073 This means each olink target element 
14074 (<tag>div</tag> or <tag>obj</tag>)
14075 must have a <tag class="attribute">page</tag> attribute
14076 whose value is its page number in the target document.
14077 The XSL stylesheets are not able to extract that information
14078 during processing because pages have not yet been created in
14079 XSLT transformation.  Only the XSL-FO processor knows what
14080 page each element is placed on.
14081 Therefore some postprocessing must take place to populate
14082 page numbers in the olink database.
14083 </para>
14084
14085
14086
14087 </refsection>
14088 </refentry>
14089
14090 <refentry version="5.0" id="insert.olink.pdf.frag">
14091 <refmeta>
14092 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
14093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14094 </refmeta>
14095 <refnamediv>
14096 <refname>insert.olink.pdf.frag</refname>
14097 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
14098 </refnamediv>
14099
14100 <refsynopsisdiv>
14101 <programlisting id="insert.olink.pdf.frag.frag">
14102 &lt;xsl:param name="insert.olink.pdf.frag" select="0"&gt;&lt;/xsl:param&gt;
14103 </programlisting>
14104 </refsynopsisdiv>
14105
14106 <refsection><info><title>Description</title></info>
14107
14108 <para>The value of this parameter determines whether
14109 the cross reference URIs to PDF documents made with
14110 <tag>olink</tag> will 
14111 include fragment identifiers.
14112 </para>
14113
14114 <para>When forming a URI to link to a PDF document,
14115 a fragment identifier (typically a '#' followed by an
14116 id value) appended to the PDF filename can be used by
14117 the PDF viewer to open
14118 the PDF file to a location within the document instead of
14119 the first page.
14120 However, not all PDF files have id
14121 values embedded in them, and not all PDF viewers can
14122 handle fragment identifiers. 
14123 </para>
14124
14125 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
14126 to a non-zero value, then any olink targeting a
14127 PDF file will have the fragment identifier appended to the URI.
14128 The URI is formed by concatenating the value of the
14129 <parameter>olink.base.uri</parameter> parameter, the
14130 value of the <tag class="attribute">baseuri</tag>
14131 attribute from the <tag class="element">document</tag>
14132 element in the olink database with the matching
14133 <tag class="attribute">targetdoc</tag> value,
14134 and the value of the <tag class="attribute">href</tag>
14135 attribute for the targeted element in the olink database.
14136 The <tag class="attribute">href</tag> attribute
14137 contains the fragment identifier.
14138 </para>
14139
14140 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
14141 to zero (the default value), then 
14142 the <tag class="attribute">href</tag> attribute
14143 from the olink database
14144 is not appended to PDF olinks, so the fragment identifier is left off.
14145 A PDF olink is any olink for which the
14146 <tag class="attribute">baseuri</tag> attribute
14147 from the matching <tag class="element">document</tag>
14148 element in the olink database ends with '.pdf'.
14149 Any other olinks will still have the fragment identifier added.
14150 </para>
14151 </refsection>
14152 </refentry>
14153
14154 <refentry version="5.0" id="olink.base.uri"> 
14155 <refmeta> 
14156 <refentrytitle>olink.base.uri</refentrytitle> 
14157 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> 
14158 </refmeta> 
14159 <refnamediv> 
14160 <refname>olink.base.uri</refname> 
14161 <refpurpose>Base URI used in olink hrefs</refpurpose> 
14162 </refnamediv> 
14163 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
14164 &lt;xsl:param name="olink.base.uri"&gt;&lt;/xsl:param&gt;
14165 </programlisting> 
14166 </refsynopsisdiv> 
14167 <refsection><info><title>Description</title></info> 
14168  
14169 <para>When cross reference data is collected for resolving olinks, it
14170 may be necessary to prepend a base URI to each target's href. This
14171 parameter lets you set that base URI when cross reference data is
14172 collected. This feature is needed when you want to link to a document
14173 that is processed without chunking. The output filename for such a
14174 document is not known to the XSL stylesheet; the only target
14175 information consists of fragment identifiers such as
14176 <literal>#idref</literal>. To enable the resolution of olinks between
14177 documents, you should pass the name of the HTML output file as the
14178 value of this parameter. Then the hrefs recorded in the cross
14179 reference data collection look like
14180 <literal>outfile.html#idref</literal>, which can be reached as links
14181 from other documents.</para>
14182 </refsection> 
14183 </refentry>
14184
14185 <refentry version="5.0" id="olink.debug">
14186 <refmeta>
14187 <refentrytitle>olink.debug</refentrytitle>
14188 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14189 </refmeta>
14190 <refnamediv>
14191 <refname>olink.debug</refname>
14192 <refpurpose>Turn on debugging messages for olinks</refpurpose>
14193 </refnamediv>
14194
14195 <refsynopsisdiv>
14196 <programlisting id="olink.debug.frag">
14197 &lt;xsl:param name="olink.debug" select="0"&gt;&lt;/xsl:param&gt;
14198 </programlisting>
14199 </refsynopsisdiv>
14200
14201 <refsection><info><title>Description</title></info>
14202
14203 <para>If non-zero, then each olink will generate several
14204 messages about how it is being resolved during processing.
14205 This is useful when an olink does not resolve properly
14206 and the standard error messages are not sufficient to
14207 find the problem. 
14208 </para>
14209
14210 <para>You may need to read through the olink XSL templates
14211 to understand the context for some of the debug messages.
14212 </para>
14213
14214 </refsection>
14215 </refentry>
14216
14217 <refentry version="5.0" id="olink.doctitle"> 
14218 <refmeta> 
14219 <refentrytitle>olink.doctitle</refentrytitle> 
14220 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
14221 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14222 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14223 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14224 </refmeta> 
14225 <refnamediv> 
14226 <refname>olink.doctitle</refname> 
14227 <refpurpose>show the document title for external olinks?</refpurpose>
14228
14229 </refnamediv> 
14230 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
14231 &lt;xsl:param name="olink.doctitle"&gt;no&lt;/xsl:param&gt; 
14232 </programlisting> 
14233 </refsynopsisdiv> 
14234 <refsection><info><title>Description</title></info> 
14235  
14236 <para>When olinks between documents are resolved, the generated text
14237 may not make it clear that the reference is to another document.
14238 It is possible for the stylesheets to append the other document's
14239 title to external olinks. For this to happen, two parameters must
14240 be set.</para>
14241 <itemizedlist>
14242 <listitem>
14243 <para>This <parameter>olink.doctitle</parameter> parameter
14244 should be set to either <literal>yes</literal> or <literal>maybe</literal>
14245 to enable this feature.
14246 </para>
14247 </listitem>
14248 <listitem>
14249 <para>And you should also set the <parameter>current.docid</parameter>
14250 parameter to the document id for the  document currently
14251 being processed for output.
14252 </para>
14253 </listitem>
14254 </itemizedlist>
14255
14256 <para>
14257 Then if an olink's  <literal>targetdoc</literal> id differs from
14258 the <literal>current.docid</literal> value, the stylesheet knows
14259 that it is a reference to another document and can
14260 append the target document's
14261 title to the generated olink text. </para> 
14262
14263 <para>The text for the target document's title is copied from the
14264 olink database from the <tag>ttl</tag> element
14265 of the top-level <tag>div</tag> for that document.
14266 If that <tag>ttl</tag> element is missing or empty,
14267 no title is output.
14268 </para>
14269
14270 <para>The supported values for <parameter>olink.doctitle</parameter> are:
14271 </para>
14272 <variablelist>
14273 <varlistentry>
14274 <term><literal>yes</literal></term>
14275 <listitem>
14276 <para>
14277 Always insert the title to the target document if it is not
14278 the current document.
14279 </para>
14280 </listitem>
14281 </varlistentry>
14282 <varlistentry>
14283 <term><literal>no</literal></term>
14284 <listitem>
14285 <para>
14286 Never insert the title to the target document, even if requested
14287 in an <tag class="attribute">xrefstyle</tag> attribute.
14288 </para>
14289 </listitem>
14290 </varlistentry>
14291 <varlistentry>
14292 <term><literal>maybe</literal></term>
14293 <listitem>
14294 <para>
14295 Only insert the title to the target document, if requested
14296 in an <tag class="attribute">xrefstyle</tag> attribute.
14297 </para>
14298 </listitem>
14299 </varlistentry>
14300 </variablelist>
14301 <para>An <tag class="attribute">xrefstyle</tag> attribute
14302 may override the global setting for individual olinks.
14303 The following values are supported in an
14304 <tag class="attribute">xrefstyle</tag>
14305 attribute using the <literal>select:</literal> syntax:
14306 </para>
14307
14308 <variablelist>
14309 <varlistentry>
14310 <term><literal>docname</literal></term>
14311 <listitem>
14312 <para>
14313 Insert the target document name for this olink using the
14314 <literal>docname</literal> gentext template, but only
14315 if the value of <parameter>olink.doctitle</parameter>
14316 is not <literal>no</literal>.
14317 </para>
14318 </listitem>
14319 </varlistentry>
14320 <varlistentry>
14321 <term><literal>docnamelong</literal></term>
14322 <listitem>
14323 <para>
14324 Insert the target document name for this olink using the
14325 <literal>docnamelong</literal> gentext template, but only
14326 if the value of <parameter>olink.doctitle</parameter>
14327 is not <literal>no</literal>.
14328 </para>
14329 </listitem>
14330 </varlistentry>
14331 <varlistentry>
14332 <term><literal>nodocname</literal></term>
14333 <listitem>
14334 <para>
14335 Omit the target document name even if
14336 the value of <parameter>olink.doctitle</parameter>
14337 is <literal>yes</literal>.
14338 </para>
14339 </listitem>
14340 </varlistentry>
14341 </variablelist>
14342 <para>Another way of inserting the target document name 
14343 for a single olink is to employ an
14344 <tag class="attribute">xrefstyle</tag>
14345 attribute using the <literal>template:</literal> syntax.
14346 The <literal>%o</literal> placeholder (the letter o, not zero)
14347 in such a template
14348 will be filled in with the target document's title when it is processed.
14349 This will occur regardless of 
14350 the value of <parameter>olink.doctitle</parameter>.
14351 </para>
14352 <para>Note that prior to version 1.66 of the XSL stylesheets,
14353 the allowed values for this parameter were 0 and 1.  Those
14354 values are still supported and mapped to 'no' and 'yes', respectively.
14355 </para>
14356 </refsection> 
14357 </refentry>
14358
14359 <refentry version="5.0" id="olink.lang.fallback.sequence"> 
14360 <refmeta> 
14361 <refentrytitle>olink.lang.fallback.sequence</refentrytitle> 
14362 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
14363 </refmeta> 
14364 <refnamediv> 
14365 <refname>olink.lang.fallback.sequence</refname> 
14366 <refpurpose>look up translated documents if olink not found?</refpurpose>
14367
14368 </refnamediv> 
14369 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
14370 &lt;xsl:param name="olink.lang.fallback.sequence"&gt;&lt;/xsl:param&gt;
14371 </programlisting> 
14372 </refsynopsisdiv> 
14373 <refsection><info><title>Description</title></info> 
14374  
14375
14376 <para>This parameter defines a list of lang values
14377 to search among to resolve olinks.
14378 </para>
14379
14380 <para>Normally an olink tries to resolve to a document in the same
14381 language as the olink itself.  The language of an olink
14382 is determined by its nearest ancestor element with a
14383 <tag class="attribute">lang</tag> attribute, otherwise the
14384 value of the <parameter>l10n.gentext.default.lang</parameter>
14385 parameter.
14386 </para>
14387
14388 <para>An olink database can contain target data for the same
14389 document in multiple languages.  Each set of data has the
14390 same value for the <tag>targetdoc</tag> attribute in
14391 the <tag>document</tag> element in the database, but with a 
14392 different <tag>lang</tag> attribute value.
14393 </para>
14394
14395 <para>When an olink is being resolved, the target is first
14396 sought in the document with the same language as the olink.
14397 If no match is found there, then this parameter is consulted
14398 for additional languages to try.</para>
14399
14400 <para>The <parameter>olink.lang.fallback.sequence</parameter>
14401 must be a whitespace separated list of lang values to
14402 try.  The first one with a match in the olink database is used.
14403 The default value is empty.</para>
14404
14405 <para>For example, a document might be written in German
14406 and contain an olink with
14407 <literal>targetdoc="adminguide"</literal>.
14408 When the document is processed, the processor
14409 first looks for a target dataset in the
14410 olink database starting with:</para>
14411
14412 <literallayout><literal>&lt;document targetdoc="adminguide" lang="de"&gt;</literal>.
14413 </literallayout>
14414
14415 <para>If there is no such element, then the
14416 <parameter>olink.lang.fallback.sequence</parameter> 
14417 parameter is consulted.
14418 If its value is, for example, <quote>fr en</quote>, then the processor next
14419 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
14420 then for <literal>targetdoc="adminguide" lang="en"</literal>.
14421 If there is still no match, it looks for
14422 <literal>targetdoc="adminguide"</literal> with no
14423 lang attribute.
14424 </para>
14425
14426 <para>This parameter is useful when a set of documents is only
14427 partially translated, or is in the process of being translated.  
14428 If a target of an olink has not yet been translated, then this
14429 parameter permits the processor to look for the document in
14430 other languages.  This assumes the reader would rather have
14431 a link to a document in a different language than to have
14432 a broken link.
14433 </para>
14434
14435 </refsection> 
14436 </refentry>
14437
14438 <refentry version="5.0" id="olink.properties">
14439 <refmeta>
14440 <refentrytitle>olink.properties</refentrytitle>
14441 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14442 </refmeta>
14443 <refnamediv>
14444 <refname>olink.properties</refname>
14445 <refpurpose>Properties associated with the cross-reference 
14446 text of an olink.</refpurpose>
14447 </refnamediv>
14448
14449 <refsynopsisdiv>
14450 <programlisting id="olink.properties.frag">
14451 &lt;xsl:attribute-set name="olink.properties"&gt;
14452   &lt;xsl:attribute name="show-destination"&gt;replace&lt;/xsl:attribute&gt;
14453 &lt;/xsl:attribute-set&gt;
14454 </programlisting>
14455 </refsynopsisdiv>
14456
14457 <refsection><info><title>Description</title></info>
14458
14459 <para>This <literal>attribute set</literal> is applied to the
14460 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
14461 optional page number or optional title of the external
14462 document.</para>
14463
14464 </refsection>
14465 </refentry>
14466
14467 <refentry version="5.0" id="prefer.internal.olink">
14468 <refmeta>
14469 <refentrytitle>prefer.internal.olink</refentrytitle>
14470 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14471 </refmeta>
14472 <refnamediv>
14473 <refname>prefer.internal.olink</refname>
14474 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
14475 </refnamediv>
14476
14477 <refsynopsisdiv>
14478 <programlisting id="prefer.internal.olink.frag">
14479 &lt;xsl:param name="prefer.internal.olink" select="0"&gt;&lt;/xsl:param&gt;
14480 </programlisting>
14481 </refsynopsisdiv>
14482
14483 <refsection><info><title>Description</title></info>
14484
14485 <para>If you are re-using XML content modules in multiple documents,
14486 you may want to redirect some of your olinks.  This parameter
14487 permits you to redirect an olink to the current document.
14488 </para>
14489
14490 <para>For example: you are writing documentation for a  product, 
14491 which includes 3 manuals: a little installation
14492 booklet (booklet.xml), a user 
14493 guide (user.xml), and a reference manual (reference.xml).
14494 All 3 documents begin with the same introduction section (intro.xml) that 
14495 contains a reference to the customization section (custom.xml) which is 
14496 included in both user.xml and reference.xml documents.
14497 </para>
14498
14499 <para>How do you write the link to custom.xml in intro.xml
14500 so that it is interpreted correctly in all 3 documents?</para>
14501 <itemizedlist>
14502 <listitem><para>If you use xref, it will fail in user.xml.</para>
14503 </listitem>
14504 <listitem><para>If you use olink (pointing to reference.xml),
14505 the reference in user.xml  
14506 will point to the customization section of the reference manual, while it is 
14507 actually available in user.xml.</para>
14508 </listitem>
14509 </itemizedlist>
14510
14511 <para>If you set the <parameter>prefer.internal.olink</parameter>
14512 parameter to a non-zero value, then the processor will
14513 first look in the olink database
14514 for the olink's <tag>targetptr</tag> attribute value
14515 in document matching the <parameter>current.docid</parameter>
14516 parameter value.  If it isn't found there, then
14517 it tries the document in the database
14518 with the <tag>targetdoc</tag>
14519 value that matches the olink's <tag>targetdoc</tag>
14520 attribute.
14521 </para>
14522
14523 <para>This feature permits an olink reference to resolve to
14524 the current document if there is an element
14525 with an id matching the olink's <tag>targetptr</tag>
14526 value.  The current document's olink data must be
14527 included in the target database for this to work.</para>
14528
14529 <caution>
14530 <para>There is a potential for incorrect links if
14531 the same <tag>id</tag> attribute value is used for different
14532 content in different documents.
14533 Some of your olinks may be redirected to the current document
14534 when they shouldn't be.  It is not possible to control
14535 individual olink instances.</para>
14536 </caution>
14537
14538 </refsection>
14539 </refentry>
14540
14541 <refentry version="5.0" id="target.database.document"> 
14542 <refmeta> 
14543 <refentrytitle>target.database.document</refentrytitle> 
14544 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> 
14545 </refmeta> 
14546 <refnamediv> 
14547 <refname>target.database.document</refname> 
14548 <refpurpose>Name of master database file for resolving
14549 olinks</refpurpose> 
14550 </refnamediv> 
14551 <refsynopsisdiv> 
14552 <programlisting id="target.database.document.frag">
14553  &lt;xsl:param name="target.database.document"&gt;olinkdb.xml&lt;/xsl:param&gt;
14554 </programlisting> 
14555 </refsynopsisdiv> 
14556 <refsection><info><title>Description</title></info>
14557  
14558 <para>
14559 To resolve olinks between documents, the stylesheets use a master
14560 database document that identifies the target datafiles for all the
14561 documents within the scope of the olinks. This parameter value is the
14562 URI of the master document to be read during processing to resolve
14563 olinks.  The default value is <filename>olinkdb.xml</filename>.</para>
14564
14565 <para>The data structure of the file is defined in the
14566 <filename>targetdatabase.dtd</filename> DTD.  The database file
14567 provides the high level elements to record the identifiers, locations,
14568 and relationships of documents. The cross reference data for
14569 individual documents is generally pulled into the database using
14570 system entity references or XIncludes. See also
14571 <parameter>targets.filename</parameter>.  </para> </refsection>
14572 </refentry>
14573
14574 <refentry version="5.0" id="targets.filename"> 
14575 <refmeta> 
14576 <refentrytitle>targets.filename</refentrytitle> 
14577 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
14578 </refmeta> 
14579 <refnamediv> 
14580 <refname>targets.filename</refname> 
14581 <refpurpose>Name of cross reference targets data file</refpurpose> 
14582 </refnamediv> 
14583 <refsynopsisdiv> <programlisting id="targets.filename.frag">
14584 &lt;xsl:param name="targets.filename"&gt;target.db&lt;/xsl:param&gt;
14585 </programlisting> 
14586 </refsynopsisdiv> 
14587 <refsection><info><title>Description</title></info>
14588  
14589 <para>
14590 In order to resolve olinks efficiently, the stylesheets can
14591 generate an external data file containing information about
14592 all potential cross reference endpoints in a document.
14593 This parameter lets you change the name of the generated
14594 file from the default name <filename>target.db</filename>.
14595 The name must agree with that used in the target database
14596 used to resolve olinks during processing.
14597 See also <parameter>target.database.document</parameter>.
14598 </para> 
14599 </refsection> 
14600 </refentry>
14601
14602 <refentry version="5.0" id="use.local.olink.style"> 
14603 <refmeta> 
14604 <refentrytitle>use.local.olink.style</refentrytitle> 
14605 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> 
14606 </refmeta> 
14607 <refnamediv> 
14608 <refname>use.local.olink.style</refname> 
14609 <refpurpose>Process olinks using xref style of current
14610 document</refpurpose> 
14611 </refnamediv> 
14612 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
14613 &lt;xsl:param name="use.local.olink.style" select="0"&gt;&lt;/xsl:param&gt; </programlisting> 
14614 </refsynopsisdiv> 
14615 <refsection><info><title>Description</title></info> 
14616  
14617 <para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross
14618 reference string is formed again from the target title, number, and
14619 element name, using the stylesheet processing the targeting document.
14620 Then olinks will match the xref style in the targeting document
14621 rather than in the target document. If  both documents are processed
14622 with the same stylesheet, then the results will be the same.</para> 
14623 </refsection> 
14624 </refentry>
14625
14626 </reference><reference id="xrefs" xml:base="../fo/param.xml"><title>Cross References</title>
14627 <refentry version="5.0" id="insert.xref.page.number">
14628 <refmeta>
14629 <refentrytitle>insert.xref.page.number</refentrytitle>
14630 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
14631 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14632 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14633 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14634 </refmeta>
14635 <refnamediv>
14636 <refname>insert.xref.page.number</refname>
14637 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
14638 </refnamediv>
14639
14640 <refsynopsisdiv>
14641 <programlisting id="insert.xref.page.number.frag">
14642 &lt;xsl:param name="insert.xref.page.number"&gt;no&lt;/xsl:param&gt;
14643 </programlisting>
14644 </refsynopsisdiv>
14645
14646 <refsection><info><title>Description</title></info>
14647
14648 <para>The value of this parameter determines if
14649 cross references (<tag>xref</tag>s) in
14650 printed output will
14651 include page number citations.
14652 It has three possible values.
14653 </para>
14654 <variablelist>
14655 <varlistentry>
14656 <term>no</term>
14657 <listitem><para>No page number references will be generated.
14658 </para></listitem>
14659 </varlistentry>
14660 <varlistentry>
14661 <term>yes</term>
14662 <listitem><para>Page number references will be generated
14663 for all <tag>xref</tag> elements.
14664 The style of page reference may be changed
14665 if an <tag class="attribute">xrefstyle</tag>
14666 attribute is used.
14667 </para></listitem>
14668 </varlistentry>
14669 <varlistentry>
14670 <term>maybe</term>
14671 <listitem><para>Page number references will not be generated
14672 for an <tag>xref</tag> element unless 
14673 it has an
14674 <tag class="attribute">xrefstyle</tag>
14675 attribute whose value specifies a page reference.
14676 </para></listitem>
14677 </varlistentry>
14678 </variablelist>
14679
14680 </refsection>
14681 </refentry>
14682
14683 <refentry version="5.0" id="xref.properties">
14684 <refmeta>
14685 <refentrytitle>xref.properties</refentrytitle>
14686 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14687 </refmeta>
14688 <refnamediv>
14689 <refname>xref.properties</refname>
14690 <refpurpose>Properties associated with cross-reference text</refpurpose>
14691 </refnamediv>
14692
14693 <refsynopsisdiv>
14694 <programlisting id="xref.properties.frag">
14695 &lt;xsl:attribute-set name="xref.properties"&gt;
14696 &lt;/xsl:attribute-set&gt;
14697 </programlisting>
14698 </refsynopsisdiv>
14699
14700 <refsection><info><title>Description</title></info>
14701
14702 <para>This attribute set is used to set properties
14703 on cross reference text.</para>
14704
14705 </refsection>
14706 </refentry>
14707
14708 <refentry version="5.0" id="xref.label-title.separator">
14709 <refmeta>
14710 <refentrytitle>xref.label-title.separator</refentrytitle>
14711 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14712 </refmeta>
14713 <refnamediv>
14714 <refname>xref.label-title.separator</refname>
14715 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
14716 </refnamediv>
14717
14718 <refsynopsisdiv>
14719 <programlisting id="xref.label-title.separator.frag">&lt;xsl:param name="xref.label-title.separator"&gt;: &lt;/xsl:param&gt;</programlisting>
14720 </refsynopsisdiv>
14721
14722 <refsection><info><title>Description</title></info>
14723
14724 <para>
14725 This parameter allows you to control the punctuation of certain
14726 types of generated cross reference text.
14727 When cross reference text is generated for an 
14728 <tag class="element">xref</tag> or 
14729 <tag class="element">olink</tag> element
14730 using an <tag class="attribute">xrefstyle</tag> attribute
14731 that makes use of the <literal>select:</literal> feature,
14732 and the selected components include both label and title,
14733 then the value of this parameter is inserted between
14734 label and title in the output.  
14735 </para>
14736
14737 </refsection>
14738 </refentry>
14739
14740 <refentry version="5.0" id="xref.label-page.separator">
14741 <refmeta>
14742 <refentrytitle>xref.label-page.separator</refentrytitle>
14743 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14744 </refmeta>
14745 <refnamediv>
14746 <refname>xref.label-page.separator</refname>
14747 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
14748 </refnamediv>
14749
14750 <refsynopsisdiv>
14751 <programlisting id="xref.label-page.separator.frag">&lt;xsl:param name="xref.label-page.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;</programlisting>
14752 </refsynopsisdiv>
14753
14754 <refsection><info><title>Description</title></info>
14755
14756 <para>
14757 This parameter allows you to control the punctuation of certain
14758 types of generated cross reference text.
14759 When cross reference text is generated for an 
14760 <tag class="element">xref</tag> or 
14761 <tag class="element">olink</tag> element
14762 using an <tag class="attribute">xrefstyle</tag> attribute
14763 that makes use of the <literal>select:</literal> feature,
14764 and the selected components include both label and page
14765 but no title,
14766 then the value of this parameter is inserted between
14767 label and page number in the output.  
14768 If a title is included, then other separators are used.
14769 </para>
14770
14771 </refsection>
14772 </refentry>
14773
14774 <refentry version="5.0" id="xref.title-page.separator">
14775 <refmeta>
14776 <refentrytitle>xref.title-page.separator</refentrytitle>
14777 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14778 </refmeta>
14779 <refnamediv>
14780 <refname>xref.title-page.separator</refname>
14781 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
14782 </refnamediv>
14783
14784 <refsynopsisdiv>
14785 <programlisting id="xref.title-page.separator.frag">&lt;xsl:param name="xref.title-page.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;</programlisting>
14786 </refsynopsisdiv>
14787
14788 <refsection><info><title>Description</title></info>
14789
14790 <para>
14791 This parameter allows you to control the punctuation of certain
14792 types of generated cross reference text.
14793 When cross reference text is generated for an 
14794 <tag class="element">xref</tag> or 
14795 <tag class="element">olink</tag> element
14796 using an <tag class="attribute">xrefstyle</tag> attribute
14797 that makes use of the <literal>select:</literal> feature,
14798 and the selected components include both title and page number,
14799 then the value of this parameter is inserted between
14800 title and page number in the output.  
14801 </para>
14802
14803 </refsection>
14804 </refentry>
14805
14806 <refentry version="5.0" id="insert.link.page.number">
14807 <refmeta>
14808 <refentrytitle>insert.link.page.number</refentrytitle>
14809 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
14810 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14811 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14812 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14813 </refmeta>
14814 <refnamediv>
14815 <refname>insert.link.page.number</refname>
14816 <refpurpose>Turns page numbers in link elements on and off</refpurpose>
14817 </refnamediv>
14818
14819 <refsynopsisdiv>
14820 <programlisting id="insert.link.page.number.frag">
14821 &lt;xsl:param name="insert.link.page.number"&gt;no&lt;/xsl:param&gt;
14822 </programlisting>
14823 </refsynopsisdiv>
14824
14825 <refsection><info><title>Description</title></info>
14826
14827 <para>The value of this parameter determines if
14828 cross references using the <tag>link</tag> element in
14829 printed output will
14830 include standard page number citations.
14831 It has three possible values.
14832 </para>
14833 <variablelist>
14834 <varlistentry>
14835 <term>no</term>
14836 <listitem><para>No page number references will be generated.
14837 </para></listitem>
14838 </varlistentry>
14839 <varlistentry>
14840 <term>yes</term>
14841 <listitem><para>Page number references will be generated
14842 for all <tag>link</tag> elements.
14843 The style of page reference may be changed
14844 if an <tag class="attribute">xrefstyle</tag>
14845 attribute is used.
14846 </para></listitem>
14847 </varlistentry>
14848 <varlistentry>
14849 <term>maybe</term>
14850 <listitem><para>Page number references will not be generated
14851 for a <tag>link</tag> element unless 
14852 it has an
14853 <tag class="attribute">xrefstyle</tag>
14854 attribute whose value specifies a page reference.
14855 </para></listitem>
14856 </varlistentry>
14857 </variablelist>
14858
14859 <para>Although the <tag>xrefstyle</tag> attribute
14860 can be used to turn the page reference on or off, it cannot be
14861 used to control the formatting of the page number as it
14862 can in <tag>xref</tag>.
14863 In <tag>link</tag> it will always format with
14864 the style established by the
14865 gentext template with <literal>name="page.citation"</literal>
14866 in the <literal>l:context name="xref"</literal>.
14867 </para>
14868 </refsection>
14869 </refentry>
14870
14871 </reference><reference id="lists" xml:base="../fo/param.xml"><title>Lists</title>
14872 <refentry version="5.0" id="compact.list.item.spacing">
14873 <refmeta>
14874 <refentrytitle>compact.list.item.spacing</refentrytitle>
14875 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14876 </refmeta>  
14877 <refnamediv>
14878 <refname>compact.list.item.spacing</refname>
14879 <refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose>
14880 </refnamediv>
14881
14882 <refsynopsisdiv>
14883 <programlisting id="compact.list.item.spacing.frag">&lt;xsl:attribute-set name="compact.list.item.spacing"&gt;
14884   &lt;xsl:attribute name="space-before.optimum"&gt;0em&lt;/xsl:attribute&gt;
14885   &lt;xsl:attribute name="space-before.minimum"&gt;0em&lt;/xsl:attribute&gt;
14886   &lt;xsl:attribute name="space-before.maximum"&gt;0.2em&lt;/xsl:attribute&gt;
14887 &lt;/xsl:attribute-set&gt;</programlisting>
14888 </refsynopsisdiv>
14889 <refsection><info><title>Description</title></info>
14890 <para>Specify what spacing you want between each list item when
14891 <tag class="attribute">spacing</tag> is
14892 <quote><literal>compact</literal></quote>.</para>
14893 </refsection>
14894 </refentry>
14895
14896 <refentry version="5.0" id="itemizedlist.properties">
14897 <refmeta>
14898 <refentrytitle>itemizedlist.properties</refentrytitle>
14899 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14900 </refmeta>
14901 <refnamediv>
14902 <refname>itemizedlist.properties</refname>
14903 <refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose>
14904 </refnamediv>
14905
14906 <refsynopsisdiv>
14907 <programlisting id="itemizedlist.properties.frag">&lt;xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties"&gt;
14908 &lt;/xsl:attribute-set&gt;</programlisting>
14909 </refsynopsisdiv>
14910 <refsection><info><title>Description</title></info>
14911 <para>Properties that apply to each fo:list-block generated by itemizedlist.</para>
14912 </refsection>
14913 </refentry>
14914
14915 <refentry version="5.0" id="itemizedlist.label.properties">
14916 <refmeta>
14917 <refentrytitle>itemizedlist.label.properties</refentrytitle>
14918 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14919 </refmeta>
14920 <refnamediv>
14921 <refname>itemizedlist.label.properties</refname>
14922 <refpurpose>Properties that apply to each label inside itemized list.</refpurpose>
14923 </refnamediv>
14924
14925 <refsynopsisdiv>
14926 <programlisting id="itemizedlist.label.properties.frag">&lt;xsl:attribute-set name="itemizedlist.label.properties"&gt;
14927 &lt;/xsl:attribute-set&gt;</programlisting>
14928 </refsynopsisdiv>
14929 <refsection><info><title>Description</title></info>
14930 <para>Properties that apply to each label inside itemized list. E.g.:</para>
14931 <programlisting>&lt;xsl:attribute-set name="itemizedlist.label.properties"&gt;
14932   &lt;xsl:attribute name="text-align"&gt;right&lt;/xsl:attribute&gt;
14933 &lt;/xsl:attribute-set&gt;</programlisting>
14934 </refsection>
14935 </refentry>
14936
14937 <refentry version="5.0" id="itemizedlist.label.width">
14938 <refmeta>
14939 <refentrytitle>itemizedlist.label.width</refentrytitle>
14940 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14941 </refmeta>
14942 <refnamediv>
14943   <refname>itemizedlist.label.width</refname>
14944 <refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose>
14945 </refnamediv>
14946
14947 <refsynopsisdiv>
14948   <programlisting id="itemizedlist.label.width.frag">
14949     &lt;xsl:param name="itemizedlist.label.width"&gt;1.0em&lt;/xsl:param&gt;
14950   </programlisting>
14951 </refsynopsisdiv>
14952
14953 <refsection><info><title>Description</title></info>
14954 <para>Specifies the default width of the label (usually a bullet or other
14955 symbol) in an itemized list. You can override the default value on any
14956 particular list with the &#8220;dbfo&#8221; processing instruction using the
14957 &#8220;label-width&#8221; pseudoattribute.</para>
14958 </refsection>
14959 </refentry>
14960
14961 <refentry version="5.0" id="list.block.properties">
14962 <refmeta>
14963 <refentrytitle>list.block.properties</refentrytitle>
14964 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14965 </refmeta>
14966 <refnamediv>
14967 <refname>list.block.properties</refname>
14968 <refpurpose>Properties that apply to each list-block generated by list.</refpurpose>
14969 </refnamediv>
14970
14971 <refsynopsisdiv>
14972 <programlisting id="list.block.properties.frag">&lt;xsl:attribute-set name="list.block.properties"&gt;
14973   &lt;xsl:attribute name="provisional-label-separation"&gt;0.2em&lt;/xsl:attribute&gt;
14974   &lt;xsl:attribute name="provisional-distance-between-starts"&gt;1.5em&lt;/xsl:attribute&gt;
14975 &lt;/xsl:attribute-set&gt;</programlisting>
14976 </refsynopsisdiv>
14977 <refsection><info><title>Description</title></info>
14978 <para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para>
14979 </refsection>
14980 </refentry>
14981
14982 <refentry version="5.0" id="list.block.spacing">
14983 <refmeta>
14984 <refentrytitle>list.block.spacing</refentrytitle>
14985 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14986 </refmeta>
14987 <refnamediv>
14988 <refname>list.block.spacing</refname>
14989 <refpurpose>What spacing do you want before and after lists?</refpurpose>
14990 </refnamediv>
14991
14992 <refsynopsisdiv>
14993 <programlisting id="list.block.spacing.frag">&lt;xsl:attribute-set name="list.block.spacing"&gt;
14994   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
14995   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
14996   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
14997   &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
14998   &lt;xsl:attribute name="space-after.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
14999   &lt;xsl:attribute name="space-after.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
15000 &lt;/xsl:attribute-set&gt;</programlisting>
15001 </refsynopsisdiv>
15002 <refsection><info><title>Description</title></info>
15003 <para>Specify the spacing required before and after a list. It is necessary to specify the space after a list block because lists can come inside of paras.  </para>
15004 </refsection>
15005 </refentry>
15006
15007 <refentry version="5.0" id="list.item.spacing">
15008 <refmeta>
15009 <refentrytitle>list.item.spacing</refentrytitle>
15010 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15011 </refmeta>
15012 <refnamediv>
15013 <refname>list.item.spacing</refname>
15014 <refpurpose>What space do you want between list items?</refpurpose>
15015 </refnamediv>
15016
15017 <refsynopsisdiv>
15018 <programlisting id="list.item.spacing.frag">&lt;xsl:attribute-set name="list.item.spacing"&gt;
15019   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
15020   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
15021   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
15022 &lt;/xsl:attribute-set&gt;</programlisting>
15023 </refsynopsisdiv>
15024 <refsection><info><title>Description</title></info>
15025 <para>Specify what spacing you want between each list item.</para>
15026 </refsection>
15027 </refentry>
15028
15029 <refentry version="5.0" id="orderedlist.properties">
15030 <refmeta>
15031 <refentrytitle>orderedlist.properties</refentrytitle>
15032 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15033 </refmeta>
15034 <refnamediv>
15035 <refname>orderedlist.properties</refname>
15036 <refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose>
15037 </refnamediv>
15038
15039 <refsynopsisdiv>
15040 <programlisting id="orderedlist.properties.frag">&lt;xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties"&gt;
15041   &lt;xsl:attribute name="provisional-distance-between-starts"&gt;2em&lt;/xsl:attribute&gt;
15042 &lt;/xsl:attribute-set&gt;</programlisting>
15043 </refsynopsisdiv>
15044 <refsection><info><title>Description</title></info>
15045 <para>Properties that apply to each fo:list-block generated by orderedlist.</para>
15046 </refsection>
15047 </refentry>
15048
15049 <refentry version="5.0" id="orderedlist.label.properties">
15050 <refmeta>
15051 <refentrytitle>orderedlist.label.properties</refentrytitle>
15052 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15053 </refmeta>
15054 <refnamediv>
15055 <refname>orderedlist.label.properties</refname>
15056 <refpurpose>Properties that apply to each label inside ordered list.</refpurpose>
15057 </refnamediv>
15058
15059 <refsynopsisdiv>
15060 <programlisting id="orderedlist.label.properties.frag">&lt;xsl:attribute-set name="orderedlist.label.properties"&gt;
15061 &lt;/xsl:attribute-set&gt;</programlisting>
15062 </refsynopsisdiv>
15063 <refsection><info><title>Description</title></info>
15064 <para>Properties that apply to each label inside ordered list. E.g.:</para>
15065 <programlisting>&lt;xsl:attribute-set name="orderedlist.label.properties"&gt;
15066   &lt;xsl:attribute name="text-align"&gt;right&lt;/xsl:attribute&gt;
15067 &lt;/xsl:attribute-set&gt;</programlisting>
15068 </refsection>
15069 </refentry>
15070
15071 <refentry version="5.0" id="orderedlist.label.width">
15072 <refmeta>
15073 <refentrytitle>orderedlist.label.width</refentrytitle>
15074 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
15075 </refmeta>
15076 <refnamediv>
15077 <refname>orderedlist.label.width</refname>
15078 <refpurpose>The default width of the label (number) in an ordered list.</refpurpose>
15079 </refnamediv>
15080
15081 <refsynopsisdiv>
15082 <programlisting id="orderedlist.label.width.frag">
15083 &lt;xsl:param name="orderedlist.label.width"&gt;1.2em&lt;/xsl:param&gt;
15084 </programlisting>
15085 </refsynopsisdiv>
15086
15087 <refsection><info><title>Description</title></info>
15088 <para>Specifies the default width of the label (usually a number or
15089 sequence of numbers) in an ordered list. You can override the default
15090 value on any particular list with the &#8220;dbfo&#8221; processing instruction
15091 using the &#8220;label-width&#8221; pseudoattribute.</para>
15092 </refsection>
15093 </refentry>
15094
15095 <refentry version="5.0" id="variablelist.max.termlength">
15096 <refmeta>
15097 <refentrytitle>variablelist.max.termlength</refentrytitle>
15098 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
15099 </refmeta>
15100 <refnamediv>
15101 <refname>variablelist.max.termlength</refname>
15102 <refpurpose>Specifies the longest term in variablelists</refpurpose>
15103 </refnamediv>
15104
15105 <refsynopsisdiv>
15106 <programlisting id="variablelist.max.termlength.frag">
15107 &lt;xsl:param name="variablelist.max.termlength"&gt;24&lt;/xsl:param&gt;
15108 </programlisting>
15109 </refsynopsisdiv>
15110
15111 <refsection><info><title>Description</title></info>
15112
15113 <para>In variablelists, the <tag>listitem</tag>
15114 is indented to leave room for the 
15115 <tag>term</tag> elements. That indent may be computed
15116 if it is not specified with a <tag class="attribute">termlength</tag>
15117 attribute on the <tag>variablelist</tag> element.
15118 </para>
15119 <para>
15120 The computation counts characters in the 
15121 <tag>term</tag> elements in the list
15122 to find the longest term.  However, some terms are very long
15123 and would produce extreme indents.  This parameter lets you
15124 set a maximum character count.  Any terms longer than the maximum
15125 would line wrap.  The default value is 24.
15126 </para>
15127 <para>
15128 The character counts are converted to physical widths
15129 by multiplying by 0.50em. There will be some variability
15130 in how many actual characters fit in the space
15131 since some characters are wider than others.
15132 </para>
15133
15134 </refsection>
15135 </refentry>
15136
15137 <refentry version="5.0" id="variablelist.term.separator">
15138 <refmeta>
15139 <refentrytitle>variablelist.term.separator</refentrytitle>
15140 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15141 </refmeta>
15142 <refnamediv>
15143 <refname>variablelist.term.separator</refname>
15144 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
15145 <tag>varlistentry</tag></refpurpose>
15146 </refnamediv>
15147
15148 <refsynopsisdiv>
15149 <programlisting id="variablelist.term.separator.frag">
15150 &lt;xsl:param name="variablelist.term.separator"&gt;, &lt;/xsl:param&gt;</programlisting>
15151 </refsynopsisdiv>
15152
15153 <refsection><info><title>Description</title></info>
15154
15155 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
15156 elements, the string specified in the value of the
15157 <parameter>variablelist.term.separator</parameter> parameter is placed
15158 after each <tag>term</tag> except the last.</para>
15159
15160 <note>
15161   <para>To generate a line break between multiple <tag>term</tag>s in
15162   a <tag>varlistentry</tag>, set a non-zero value for the
15163   <parameter>variablelist.term.break.after</parameter> parameter. If
15164   you do so, you may also want to set the value of the
15165   <parameter>variablelist.term.separator</parameter> parameter to an
15166   empty string (to suppress rendering of the default comma and space
15167   after each <tag>term</tag>).</para>
15168 </note>
15169
15170 </refsection>
15171 </refentry>
15172
15173 <refentry version="5.0" id="variablelist.term.properties">
15174 <refmeta>
15175 <refentrytitle>variablelist.term.properties</refentrytitle>
15176 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15177 </refmeta>
15178 <refnamediv>
15179 <refname>variablelist.term.properties</refname>
15180 <refpurpose>To add properties to the term elements in a variablelist.</refpurpose>
15181 </refnamediv>
15182
15183 <refsynopsisdiv>
15184 <programlisting id="variablelist.term.properties.frag">
15185 &lt;xsl:attribute-set name="variablelist.term.properties"&gt;
15186 &lt;/xsl:attribute-set&gt;
15187 </programlisting>
15188 </refsynopsisdiv>
15189 <refsection><info><title>Description</title></info>
15190 <para>These properties are added to the block containing a
15191 term in a variablelist.
15192 Use this attribute-set to set
15193 font properties or alignment, for example.</para>
15194
15195 </refsection>
15196 </refentry>
15197
15198 <refentry version="5.0" id="variablelist.term.break.after">
15199 <refmeta>
15200 <refentrytitle>variablelist.term.break.after</refentrytitle>
15201 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15202 </refmeta>
15203 <refnamediv>
15204 <refname>variablelist.term.break.after</refname>
15205 <refpurpose>Generate line break after each <tag>term</tag> within a
15206 multi-term <tag>varlistentry</tag>?</refpurpose>
15207 </refnamediv>
15208
15209 <refsynopsisdiv>
15210 <programlisting id="variablelist.term.break.after.frag">
15211 &lt;xsl:param name="variablelist.term.break.after"&gt;0&lt;/xsl:param&gt;</programlisting>
15212 </refsynopsisdiv>
15213
15214 <refsection><info><title>Description</title></info>
15215
15216 <para>Set a non-zero value for the
15217 <parameter>variablelist.term.break.after</parameter> parameter to
15218 generate a line break between <tag>term</tag>s in a
15219 multi-term <tag>varlistentry</tag>.</para>
15220
15221 <note>
15222 <para>If you set a non-zero value for
15223 <parameter>variablelist.term.break.after</parameter>, you may also
15224 want to set the value of the
15225 <parameter>variablelist.term.separator</parameter> parameter to an
15226 empty string (to suppress rendering of the default comma and space
15227 after each <tag>term</tag>).</para>
15228 </note>
15229
15230 </refsection>
15231 </refentry>
15232
15233 </reference><reference id="qa" xml:base="../fo/param.xml"><title>QAndASet</title>
15234 <refentry version="5.0" id="qandadiv.autolabel">
15235 <refmeta>
15236 <refentrytitle>qandadiv.autolabel</refentrytitle>
15237 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15238 </refmeta>
15239 <refnamediv>
15240 <refname>qandadiv.autolabel</refname>
15241 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
15242 </refnamediv>
15243
15244 <refsynopsisdiv>
15245 <programlisting id="qandadiv.autolabel.frag">&lt;xsl:param name="qandadiv.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
15246 </refsynopsisdiv>
15247
15248 <refsection><info><title>Description</title></info>
15249
15250 <para>If non-zero, unlabeled qandadivs will be enumerated.
15251 </para>
15252
15253 </refsection>
15254 </refentry>
15255
15256 <refentry version="5.0" id="qanda.inherit.numeration">
15257 <refmeta>
15258 <refentrytitle>qanda.inherit.numeration</refentrytitle>
15259 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15260 </refmeta>
15261 <refnamediv>
15262 <refname>qanda.inherit.numeration</refname>
15263 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
15264 </refnamediv>
15265
15266 <refsynopsisdiv>
15267 <programlisting id="qanda.inherit.numeration.frag">
15268 &lt;xsl:param name="qanda.inherit.numeration" select="1"&gt;&lt;/xsl:param&gt;
15269 </programlisting>
15270 </refsynopsisdiv>
15271
15272 <refsection><info><title>Description</title></info>
15273
15274 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
15275 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
15276 the ancestors of the <tag>qandaset</tag>.
15277 </para>
15278
15279 </refsection>
15280 </refentry>
15281
15282 <refentry version="5.0" id="qanda.defaultlabel">
15283 <refmeta>
15284 <refentrytitle>qanda.defaultlabel</refentrytitle>
15285 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
15286 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
15287 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo> 
15288 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
15289 </refmeta>
15290 <refnamediv>
15291 <refname>qanda.defaultlabel</refname>
15292 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
15293 </refnamediv>
15294
15295 <refsynopsisdiv>
15296 <programlisting id="qanda.defaultlabel.frag">
15297 &lt;xsl:param name="qanda.defaultlabel"&gt;number&lt;/xsl:param&gt;
15298 </programlisting>
15299 </refsynopsisdiv>
15300
15301 <refsection><info><title>Description</title></info>
15302
15303 <para>If no <literal>defaultlabel</literal> attribute is specified on
15304 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
15305 values for the defaultlabel attribute (<literal>none</literal>, 
15306 <literal>number</literal> or
15307 <literal>qanda</literal>), or one of the additional stylesheet-specific values
15308 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
15309 The default value is 'number'.
15310 </para>
15311 <para>The values are rendered as follows:</para>
15312 <variablelist>
15313 <varlistentry><term><literal>qanda</literal></term>
15314 <listitem>
15315 <para><tag>question</tag>s are labeled "Q:" and
15316 <tag>answer</tag>s are labeled "A:". </para>
15317 </listitem>
15318 </varlistentry>
15319
15320 <varlistentry><term><literal>number</literal></term>
15321 <listitem>
15322 <para>The questions are enumerated and the answers
15323 are not labeled. </para>
15324 </listitem>
15325 </varlistentry>
15326
15327 <varlistentry><term><literal>qnumber</literal></term>
15328 <listitem>
15329 <para>The questions are labeled "Q:" followed by a number, and answers are not 
15330 labeled. 
15331 When sections are numbered, adding a label
15332 to the number distinguishes the question numbers
15333 from the section numbers.
15334 This value is not allowed in the
15335 <tag class="attribute">defaultlabel</tag> attribute
15336 of a <tag>qandaset</tag> element.</para>
15337 </listitem>
15338 </varlistentry>
15339
15340 <varlistentry><term><literal>qnumberanda</literal></term>
15341 <listitem>
15342 <para>The questions are labeled "Q:" followed by a number, and
15343 the answers are labeled "A:". 
15344 When sections are numbered, adding a label
15345 to the number distinguishes the question numbers
15346 from the section numbers.
15347 This value is not allowed in the
15348 <tag class="attribute">defaultlabel</tag> attribute
15349 of a <tag>qandaset</tag> element.</para>
15350 </listitem>
15351 </varlistentry>
15352
15353 <varlistentry><term><literal>none</literal></term>
15354 <listitem>
15355 <para>No distinguishing label precedes Questions or Answers. 
15356 </para>
15357 </listitem>
15358 </varlistentry>
15359 </variablelist>
15360
15361 </refsection>
15362 </refentry>
15363
15364 <refentry version="5.0" id="qanda.in.toc">
15365 <refmeta>
15366 <refentrytitle>qanda.in.toc</refentrytitle>
15367 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15368 </refmeta>
15369 <refnamediv>
15370 <refname>qanda.in.toc</refname>
15371 <refpurpose>Should qandaentry questions appear in 
15372 the document table of contents?</refpurpose>
15373 </refnamediv>
15374
15375 <refsynopsisdiv>
15376 <programlisting id="qanda.in.toc.frag">&lt;xsl:param name="qanda.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
15377 </refsynopsisdiv>
15378
15379 <refsection><info><title>Description</title></info>
15380
15381 <para>If true (non-zero), then the generated table of contents
15382 for a document will include <tag>qandaset</tag> titles, 
15383 <tag>qandadiv</tag> titles,
15384 and <tag>question</tag> elements.  The default value (zero) excludes
15385 them from the TOC.
15386 </para>
15387 <para>This parameter does not affect any tables of contents
15388 that may be generated inside a qandaset or qandadiv.
15389 </para>
15390
15391 </refsection>
15392 </refentry>
15393
15394 <refentry version="5.0" id="qanda.nested.in.toc">
15395 <refmeta>
15396 <refentrytitle>qanda.nested.in.toc</refentrytitle>
15397 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15398 </refmeta>
15399 <refnamediv>
15400 <refname>qanda.nested.in.toc</refname>
15401 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
15402 </refnamediv>
15403
15404 <refsynopsisdiv>
15405 <programlisting id="qanda.nested.in.toc.frag">
15406 &lt;xsl:param name="qanda.nested.in.toc" select="0"&gt;&lt;/xsl:param&gt;
15407 </programlisting>
15408 </refsynopsisdiv>
15409
15410 <refsection><info><title>Description</title></info>
15411
15412 <para>If non-zero, instances of <tag>qandaentry</tag>
15413 that are children of <tag>answer</tag> elements are shown in
15414 the TOC.</para>
15415
15416 </refsection>
15417 </refentry>
15418
15419 </reference><reference id="biblio" xml:base="../fo/param.xml"><title>Bibliography</title>
15420 <refentry version="5.0" id="bibliography.style">
15421 <refmeta>
15422 <refentrytitle>bibliography.style</refentrytitle>
15423 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15424 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
15425 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
15426 </refmeta>
15427 <refnamediv>
15428 <refname>bibliography.style</refname>
15429 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
15430 </refnamediv>
15431
15432 <refsynopsisdiv>
15433 <programlisting id="bibliography.style.frag">
15434 &lt;xsl:param name="bibliography.style"&gt;normal&lt;/xsl:param&gt;
15435 </programlisting>
15436 </refsynopsisdiv>
15437
15438 <refsection><info><title>Description</title></info>
15439
15440 <para>Currently only <literal>normal</literal> and
15441 <literal>iso690</literal> styles are supported.</para>
15442
15443 <para>In order to use ISO690 style to the full extent you might need
15444 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
15445 following WiKi page</link>.</para>
15446
15447 </refsection>
15448 </refentry>
15449
15450 <refentry version="5.0" id="biblioentry.item.separator">
15451 <refmeta>
15452 <refentrytitle>biblioentry.item.separator</refentrytitle>
15453 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15454 </refmeta>
15455 <refnamediv>
15456 <refname>biblioentry.item.separator</refname>
15457 <refpurpose>Text to separate bibliography entries</refpurpose>
15458 </refnamediv>
15459
15460 <refsynopsisdiv>
15461 <programlisting id="biblioentry.item.separator.frag">&lt;xsl:param name="biblioentry.item.separator"&gt;. &lt;/xsl:param&gt;</programlisting>
15462 </refsynopsisdiv>
15463
15464 <refsection><info><title>Description</title></info>
15465
15466 <para>Text to separate bibliography entries
15467 </para>
15468
15469 </refsection>
15470 </refentry>
15471
15472 <refentry version="5.0" id="bibliography.collection">
15473 <refmeta>
15474 <refentrytitle>bibliography.collection</refentrytitle>
15475 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15476 </refmeta>
15477 <refnamediv>
15478 <refname>bibliography.collection</refname>
15479 <refpurpose>Name of the bibliography collection file</refpurpose>
15480 </refnamediv>
15481
15482 <refsynopsisdiv>
15483 <programlisting id="bibliography.collection.frag">
15484 &lt;xsl:param name="bibliography.collection"&gt;http://docbook.sourceforge.net/release/bibliography/bibliography.xml&lt;/xsl:param&gt;
15485
15486 </programlisting>
15487 </refsynopsisdiv>
15488
15489 <refsection><info><title>Description</title></info>
15490
15491 <para>Maintaining bibliography entries across a set of documents is tedious, time
15492 consuming, and error prone. It makes much more sense, usually, to store all of
15493 the bibliography entries in a single place and simply <quote>extract</quote>
15494 the ones you need in each document.</para>
15495
15496 <para>That's the purpose of the
15497 <parameter>bibliography.collection</parameter> parameter. To setup a global
15498 bibliography <quote>database</quote>, follow these steps:</para>
15499
15500 <para>First, create a stand-alone bibliography document that contains all of
15501 the documents that you wish to reference. Make sure that each bibliography
15502 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
15503 has an ID.</para>
15504
15505 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
15506 like this:</para>
15507
15508 <informalexample>
15509 <programlisting>&lt;!DOCTYPE bibliography
15510   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
15511   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
15512 &lt;bibliography&gt;&lt;title&gt;References&lt;/title&gt;
15513
15514 &lt;bibliomixed id="xml-rec"&gt;&lt;abbrev&gt;XML 1.0&lt;/abbrev&gt;Tim Bray,
15515 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
15516 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml"&gt;Extensible Markup
15517 Language (XML) 1.0 Second Edition&lt;/ulink&gt;&lt;/citetitle&gt;.
15518 World Wide Web Consortium, 2000.
15519 &lt;/bibliomixed&gt;
15520
15521 &lt;bibliomixed id="xml-names"&gt;&lt;abbrev&gt;Namespaces&lt;/abbrev&gt;Tim Bray,
15522 Dave Hollander,
15523 and Andrew Layman, editors.
15524 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml-names/"&gt;Namespaces in
15525 XML&lt;/ulink&gt;&lt;/citetitle&gt;.
15526 World Wide Web Consortium, 1999.
15527 &lt;/bibliomixed&gt;
15528
15529 &lt;!-- ... --&gt;
15530 &lt;/bibliography&gt;
15531 </programlisting>
15532 </informalexample>
15533
15534 <para>When you create a bibliography in your document, simply
15535 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
15536 entries for each document that you wish to cite. Make sure that these
15537 elements have the same ID as the corresponding <quote>real</quote>
15538 entry in your global bibliography.</para>
15539
15540 <para>For example:</para>
15541
15542 <informalexample>
15543 <programlisting>&lt;bibliography&gt;&lt;title&gt;Bibliography&lt;/title&gt;
15544
15545 &lt;bibliomixed id="xml-rec"/&gt;
15546 &lt;bibliomixed id="xml-names"/&gt;
15547 &lt;bibliomixed id="DKnuth86"&gt;Donald E. Knuth. &lt;citetitle&gt;Computers and
15548 Typesetting: Volume B, TeX: The Program&lt;/citetitle&gt;. Addison-Wesley,
15549 1986.  ISBN 0-201-13437-3.
15550 &lt;/bibliomixed&gt;
15551 &lt;bibliomixed id="relaxng"/&gt;
15552
15553 &lt;/bibliography&gt;</programlisting>
15554 </informalexample>
15555
15556 <para>Note that it's perfectly acceptable to mix entries from your
15557 global bibliography with <quote>normal</quote> entries. You can use
15558 <tag>xref</tag> or other elements to cross-reference your
15559 bibliography entries in exactly the same way you do now.</para>
15560
15561 <para>Finally, when you are ready to format your document, simply set the
15562 <parameter>bibliography.collection</parameter> parameter (in either a
15563 customization layer or directly through your processor's interface) to
15564 point to your global bibliography.</para>
15565
15566 <para>The stylesheets will format the bibliography in your document as if
15567 all of the entries referenced appeared there literally.</para>
15568
15569 </refsection>
15570 </refentry>
15571
15572 <refentry version="5.0" id="bibliography.numbered">
15573 <refmeta>
15574 <refentrytitle>bibliography.numbered</refentrytitle>
15575 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15576 </refmeta>
15577 <refnamediv>
15578 <refname>bibliography.numbered</refname>
15579 <refpurpose>Should bibliography entries be numbered?</refpurpose>
15580 </refnamediv>
15581
15582 <refsynopsisdiv>
15583 <programlisting id="bibliography.numbered.frag">
15584 &lt;xsl:param name="bibliography.numbered" select="0"&gt;&lt;/xsl:param&gt;
15585 </programlisting>
15586 </refsynopsisdiv>
15587
15588 <refsection><info><title>Description</title></info>
15589
15590 <para>If non-zero bibliography entries will be numbered</para>
15591
15592 </refsection>
15593 </refentry>
15594
15595 <refentry version="5.0" id="biblioentry.properties">
15596 <refmeta>
15597   <refentrytitle>biblioentry.properties</refentrytitle>
15598   <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15599 </refmeta>
15600 <refnamediv>
15601 <refname>biblioentry.properties</refname>
15602 <refpurpose>To set the style for biblioentry.</refpurpose>
15603 </refnamediv>
15604
15605 <refsynopsisdiv>
15606 <programlisting id="biblioentry.properties.frag">&lt;xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing"&gt;
15607   &lt;xsl:attribute name="start-indent"&gt;0.5in&lt;/xsl:attribute&gt;
15608   &lt;xsl:attribute name="text-indent"&gt;-0.5in&lt;/xsl:attribute&gt;
15609 &lt;/xsl:attribute-set&gt;
15610 </programlisting>
15611 </refsynopsisdiv>
15612 <refsection><info><title>Description</title></info>
15613 <para>How do you want biblioentry styled? </para>
15614 <para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para>
15615
15616 </refsection>
15617 </refentry>
15618
15619 </reference><reference id="glossary" xml:base="../fo/param.xml"><title>Glossary</title>
15620 <refentry version="5.0" id="glossterm.auto.link">
15621 <refmeta>
15622 <refentrytitle>glossterm.auto.link</refentrytitle>
15623 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15624 </refmeta>
15625 <refnamediv>
15626 <refname>glossterm.auto.link</refname>
15627 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
15628 </refnamediv>
15629
15630 <refsynopsisdiv>
15631 <programlisting id="glossterm.auto.link.frag">
15632 &lt;xsl:param name="glossterm.auto.link" select="0"&gt;&lt;/xsl:param&gt;
15633 </programlisting>
15634 </refsynopsisdiv>
15635
15636 <refsection><info><title>Description</title></info>
15637
15638 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding 
15639 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag> 
15640 will be automatically generated. This is useful when your glossterms are consistent 
15641 and you don't want to add links manually.</para>
15642
15643 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
15644 that have a <tag class="attribute">linkend</tag> attribute.</para>
15645
15646 </refsection>
15647 </refentry>
15648
15649 <refentry version="5.0" id="firstterm.only.link">
15650 <refmeta>
15651 <refentrytitle>firstterm.only.link</refentrytitle>
15652 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15653 </refmeta>
15654 <refnamediv>
15655 <refname>firstterm.only.link</refname>
15656 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
15657 </refnamediv>
15658
15659 <refsynopsisdiv>
15660 <programlisting id="firstterm.only.link.frag">
15661 &lt;xsl:param name="firstterm.only.link" select="0"&gt;&lt;/xsl:param&gt;
15662 </programlisting>
15663 </refsynopsisdiv>
15664
15665 <refsection><info><title>Description</title></info>
15666
15667 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
15668 to the glossary. If glossary linking is not enabled, this parameter
15669 has no effect.</para>
15670
15671 </refsection>
15672 </refentry>
15673
15674 <refentry version="5.0" id="glossary.collection">
15675 <refmeta>
15676 <refentrytitle>glossary.collection</refentrytitle>
15677 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15678 </refmeta>
15679 <refnamediv>
15680 <refname>glossary.collection</refname>
15681 <refpurpose>Name of the glossary collection file</refpurpose>
15682 </refnamediv>
15683
15684 <refsynopsisdiv>
15685 <programlisting id="glossary.collection.frag">
15686 &lt;xsl:param name="glossary.collection"&gt;&lt;/xsl:param&gt;
15687 </programlisting>
15688 </refsynopsisdiv>
15689
15690 <refsection><info><title>Description</title></info>
15691
15692 <para>Glossaries maintained independently across a set of documents
15693 are likely to become inconsistent unless considerable effort is
15694 expended to keep them in sync. It makes much more sense, usually, to
15695 store all of the glossary entries in a single place and simply
15696 <quote>extract</quote> the ones you need in each document.</para>
15697
15698 <para>That's the purpose of the
15699 <parameter>glossary.collection</parameter> parameter. To setup a global
15700 glossary <quote>database</quote>, follow these steps:</para>
15701
15702 <refsection><info><title>Setting Up the Glossary Database</title></info>
15703
15704 <para>First, create a stand-alone glossary document that contains all of
15705 the entries that you wish to reference. Make sure that each glossary
15706 entry has an ID.</para>
15707
15708 <para>Here's an example glossary:</para>
15709
15710 <informalexample>
15711 <programlisting>
15712 &lt;?xml version="1.0" encoding="utf-8"?&gt;
15713 &lt;!DOCTYPE glossary
15714   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
15715   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
15716 &lt;glossary&gt;
15717 &lt;glossaryinfo&gt;
15718 &lt;editor&gt;&lt;firstname&gt;Eric&lt;/firstname&gt;&lt;surname&gt;Raymond&lt;/surname&gt;&lt;/editor&gt;
15719 &lt;title&gt;Jargon File 4.2.3 (abridged)&lt;/title&gt;
15720 &lt;releaseinfo&gt;Just some test data&lt;/releaseinfo&gt;
15721 &lt;/glossaryinfo&gt;
15722
15723 &lt;glossdiv&gt;&lt;title&gt;0&lt;/title&gt;
15724
15725 &lt;glossentry&gt;
15726 &lt;glossterm&gt;0&lt;/glossterm&gt;
15727 &lt;glossdef&gt;
15728 &lt;para&gt;Numeric zero, as opposed to the letter `O' (the 15th letter of
15729 the English alphabet). In their unmodified forms they look a lot
15730 alike, and various kluges invented to make them visually distinct have
15731 compounded the confusion. If your zero is center-dotted and letter-O
15732 is not, or if letter-O looks almost rectangular but zero looks more
15733 like an American football stood on end (or the reverse), you're
15734 probably looking at a modern character display (though the dotted zero
15735 seems to have originated as an option on IBM 3270 controllers). If
15736 your zero is slashed but letter-O is not, you're probably looking at
15737 an old-style ASCII graphic set descended from the default typewheel on
15738 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
15739 curse this arrangement). (Interestingly, the slashed zero long
15740 predates computers; Florian Cajori's monumental "A History of
15741 Mathematical Notations" notes that it was used in the twelfth and
15742 thirteenth centuries.) If letter-O has a slash across it and the zero
15743 does not, your display is tuned for a very old convention used at IBM
15744 and a few other early mainframe makers (Scandinavians curse &lt;emphasis&gt;this&lt;/emphasis&gt;
15745 arrangement even more, because it means two of their letters collide).
15746 Some Burroughs/Unisys equipment displays a zero with a &lt;emphasis&gt;reversed&lt;/emphasis&gt;
15747 slash. Old CDC computers rendered letter O as an unbroken oval and 0
15748 as an oval broken at upper right and lower left. And yet another
15749 convention common on early line printers left zero unornamented but
15750 added a tail or hook to the letter-O so that it resembled an inverted
15751 Q or cursive capital letter-O (this was endorsed by a draft ANSI
15752 standard for how to draw ASCII characters, but the final standard
15753 changed the distinguisher to a tick-mark in the upper-left corner).
15754 Are we sufficiently confused yet?&lt;/para&gt;
15755 &lt;/glossdef&gt;
15756 &lt;/glossentry&gt;
15757
15758 &lt;glossentry&gt;
15759 &lt;glossterm&gt;1TBS&lt;/glossterm&gt;
15760 &lt;glossdef&gt;
15761 &lt;para role="accidence"&gt;
15762 &lt;phrase role="pronounce"&gt;&lt;/phrase&gt;
15763 &lt;phrase role="partsofspeach"&gt;n&lt;/phrase&gt;
15764 &lt;/para&gt;
15765 &lt;para&gt;The "One True Brace Style"&lt;/para&gt;
15766 &lt;glossseealso&gt;indent style&lt;/glossseealso&gt;
15767 &lt;/glossdef&gt;
15768 &lt;/glossentry&gt;
15769
15770 &lt;!-- ... --&gt;
15771
15772 &lt;/glossdiv&gt;
15773
15774 &lt;!-- ... --&gt;
15775
15776 &lt;/glossary&gt;</programlisting>
15777 </informalexample>
15778
15779 </refsection>
15780
15781 <refsection><info><title>Marking Up Glossary Terms</title></info>
15782
15783 <para>That takes care of the glossary database, now you have to get the entries
15784 into your document. Unlike bibliography entries, which can be empty, creating
15785 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
15786 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
15787
15788 <para>In your source document, simply use <tag>firstterm</tag> and
15789 <tag>glossterm</tag> to identify the terms you wish to have included
15790 in the glossary. The stylesheets assume that you will either set the
15791 <tag class="attribute">baseform</tag> attribute correctly, or that the
15792 content of the element exactly matches a term in your glossary.</para>
15793
15794 <para>If you're using a <parameter>glossary.collection</parameter>, don't
15795 make explicit links on the terms in your document.</para>
15796
15797 <para>So, in your document, you might write things like this:</para>
15798
15799 <informalexample>
15800 <programlisting>&lt;para&gt;This is dummy text, without any real meaning.
15801 The point is simply to reference glossary terms like &lt;glossterm&gt;0&lt;/glossterm&gt;
15802 and the &lt;firstterm baseform="1TBS"&gt;One True Brace Style (1TBS)&lt;/firstterm&gt;.
15803 The &lt;glossterm&gt;1TBS&lt;/glossterm&gt;, as you can probably imagine, is a nearly
15804 religious issue.&lt;/para&gt;</programlisting>
15805 </informalexample>
15806
15807 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
15808 only the terms marked with <tag>firstterm</tag> will be links.
15809 Otherwise, all the terms will be linked.</para>
15810
15811 </refsection>
15812
15813 <refsection><info><title>Marking Up the Glossary</title></info>
15814
15815 <para>The glossary itself has to be identified for the stylesheets. For lack
15816 of a better choice, the <tag class="attribute">role</tag> is used.
15817 To identify the glossary as the target for automatic processing, set
15818 the role to <quote><literal>auto</literal></quote>. The title of this
15819 glossary (and any other information from the <tag>glossaryinfo</tag>
15820 that's rendered by your stylesheet) will be displayed, but the entries will
15821 come from the database.
15822 </para>
15823
15824 <para>Unfortunately, the glossary can't be empty, so you must put in
15825 at least one <tag>glossentry</tag>. The content of this entry
15826 is irrelevant, it will not be rendered:</para>
15827
15828 <informalexample>
15829 <programlisting>&lt;glossary role="auto"&gt;
15830 &lt;glossentry&gt;
15831 &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
15832 &lt;glossdef&gt;
15833 &lt;para&gt;If you can see this, the document was processed incorrectly. Use
15834 the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
15835 &lt;/glossdef&gt;
15836 &lt;/glossentry&gt;
15837 &lt;/glossary&gt;</programlisting>
15838 </informalexample>
15839
15840 <para>What about glossary divisions? If your glossary database has glossary
15841 divisions <emphasis>and</emphasis> your automatic glossary contains at least
15842 one <tag>glossdiv</tag>, the automic glossary will have divisions.
15843 If the <tag>glossdiv</tag> is missing from either location, no divisions
15844 will be rendered.</para>
15845
15846 <para>Glossary entries (and divisions, if appropriate) in the glossary will
15847 occur in precisely the order they occur in your database.</para>
15848
15849 </refsection>
15850
15851 <refsection><info><title>Formatting the Document</title></info>
15852
15853 <para>Finally, when you are ready to format your document, simply set the
15854 <parameter>glossary.collection</parameter> parameter (in either a
15855 customization layer or directly through your processor's interface) to
15856 point to your global glossary.</para>
15857
15858 <para>The stylesheets will format the glossary in your document as if
15859 all of the entries implicilty referenced appeared there literally.</para>
15860 </refsection>
15861
15862 <refsection><info><title>Limitations</title></info>
15863
15864 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
15865 not supported. For example, this <emphasis>will not</emphasis> work:</para>
15866
15867 <informalexample>
15868 <programlisting>&lt;glossentry&gt;
15869 &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
15870 &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
15871 &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
15872 &lt;/glossdef&gt;
15873 &lt;/glossentry&gt;</programlisting>
15874 </informalexample>
15875
15876 <para>If you put glossary cross-references in your glossary that way,
15877 you'll get the cryptic error: <computeroutput>Warning:
15878 glossary.collection specified, but there are 0 automatic
15879 glossaries</computeroutput>.</para>
15880
15881 <para>Instead, you must do two things:</para>
15882
15883 <orderedlist>
15884 <listitem>
15885 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
15886
15887 <informalexample>
15888 <programlisting>&lt;glossentry&gt;
15889 &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
15890 &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
15891 &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
15892 &lt;/glossdef&gt;
15893 &lt;/glossentry&gt;</programlisting>
15894 </informalexample>
15895 </listitem>
15896
15897 <listitem>
15898 <para>Make sure there is at least one <tag>glossterm</tag> reference to
15899 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
15900 easiest way to do that is probably within a <tag>remark</tag> in your
15901 automatic glossary:</para>
15902
15903 <informalexample>
15904 <programlisting>&lt;glossary role="auto"&gt;
15905 &lt;remark&gt;Make sure there's a reference to &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/remark&gt;
15906 &lt;glossentry&gt;
15907 &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
15908 &lt;glossdef&gt;
15909 &lt;para&gt;If you can see this, the document was processed incorrectly. Use
15910 the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
15911 &lt;/glossdef&gt;
15912 &lt;/glossentry&gt;
15913 &lt;/glossary&gt;</programlisting>
15914 </informalexample>
15915 </listitem>
15916 </orderedlist>
15917 </refsection>
15918
15919 </refsection>
15920 </refentry>
15921
15922 <refentry version="5.0" id="glossary.as.blocks">
15923 <refmeta>
15924 <refentrytitle>glossary.as.blocks</refentrytitle>
15925 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15926 </refmeta>
15927 <refnamediv>
15928 <refname>glossary.as.blocks</refname>
15929 <refpurpose>Present glossarys using blocks instead of lists?</refpurpose>
15930 </refnamediv>
15931
15932 <refsynopsisdiv>
15933 <programlisting id="glossary.as.blocks.frag">
15934 &lt;xsl:param name="glossary.as.blocks" select="0"&gt;&lt;/xsl:param&gt;
15935 </programlisting>
15936 </refsynopsisdiv>
15937
15938 <refsection><info><title>Description</title></info>
15939
15940 <para>If non-zero, <tag>glossary</tag>s will be formatted as
15941 blocks.</para>
15942
15943 <para>If you have long <tag>glossterm</tag>s, proper list
15944 markup in the FO case may produce unattractive lists. By setting this
15945 parameter, you can force the stylesheets to produce block markup
15946 instead of proper lists.</para>
15947
15948 <para>You can override this setting with a processing instruction as the
15949 child of <tag>glossary</tag>: <tag class="xmlpi">dbfo
15950 glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
15951 glossary-presentation="list"</tag></para>
15952
15953 </refsection>
15954 </refentry>
15955
15956 <refentry version="5.0" id="glosslist.as.blocks">
15957 <refmeta>
15958 <refentrytitle>glosslist.as.blocks</refentrytitle>
15959 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15960 </refmeta>
15961 <refnamediv>
15962 <refname>glosslist.as.blocks</refname>
15963 <refpurpose>Use blocks for glosslists?</refpurpose>
15964 </refnamediv>
15965
15966 <refsynopsisdiv>
15967 <programlisting id="glosslist.as.blocks.frag">
15968 &lt;xsl:param name="glosslist.as.blocks" select="0"&gt;&lt;/xsl:param&gt;
15969 </programlisting>
15970 </refsynopsisdiv>
15971
15972 <refsection><info><title>Description</title></info>
15973
15974 <para>See <parameter>glossary.as.blocks</parameter>.</para>
15975
15976 </refsection>
15977 </refentry>
15978
15979 <refentry version="5.0" id="glossentry.list.item.properties">
15980 <refmeta>
15981 <refentrytitle>glossentry.list.item.properties</refentrytitle>
15982 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15983 </refmeta>
15984 <refnamediv>
15985 <refname>glossentry.list.item.properties</refname>
15986 <refpurpose>To add properties to each glossentry in a list.</refpurpose>
15987 </refnamediv>
15988
15989 <refsynopsisdiv>
15990 <programlisting id="glossentry.list.item.properties.frag">&lt;xsl:attribute-set name="glossentry.list.item.properties"&gt;
15991   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
15992   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
15993   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
15994 &lt;/xsl:attribute-set&gt;
15995 </programlisting>
15996 </refsynopsisdiv>
15997 <refsection><info><title>Description</title></info>
15998 <para>These properties are added to the fo:list-item containing a
15999 glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16000 is zero.
16001 Use this attribute-set to set
16002 spacing between entries, for example.</para>
16003
16004 </refsection>
16005 </refentry>
16006
16007 <refentry version="5.0" id="glossterm.block.properties">
16008 <refmeta>
16009 <refentrytitle>glossterm.block.properties</refentrytitle>
16010 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16011 </refmeta>
16012 <refnamediv>
16013 <refname>glossterm.block.properties</refname>
16014 <refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose>
16015 </refnamediv>
16016
16017 <refsynopsisdiv>
16018 <programlisting id="glossterm.block.properties.frag">&lt;xsl:attribute-set name="glossterm.block.properties"&gt;
16019   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
16020   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
16021   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
16022   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
16023   &lt;xsl:attribute name="keep-together.within-column"&gt;always&lt;/xsl:attribute&gt;
16024 &lt;/xsl:attribute-set&gt;
16025 </programlisting>
16026 </refsynopsisdiv>
16027 <refsection><info><title>Description</title></info>
16028 <para>These properties are added to the block containing a
16029 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16030 is non-zero.
16031 Use this attribute-set to set the space above and below,
16032 font properties,
16033 and any indent for the glossary term.</para>
16034
16035 </refsection>
16036 </refentry>
16037
16038 <refentry version="5.0" id="glossdef.block.properties">
16039 <refmeta>
16040 <refentrytitle>glossdef.block.properties</refentrytitle>
16041 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16042 </refmeta>
16043 <refnamediv>
16044 <refname>glossdef.block.properties</refname>
16045 <refpurpose>To add properties to the block of a glossary definition.</refpurpose>
16046 </refnamediv>
16047
16048 <refsynopsisdiv>
16049 <programlisting id="glossdef.block.properties.frag">&lt;xsl:attribute-set name="glossdef.block.properties"&gt;
16050   &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;.25in&lt;/xsl:attribute&gt;
16051 &lt;/xsl:attribute-set&gt;
16052 </programlisting>
16053 </refsynopsisdiv>
16054 <refsection><info><title>Description</title></info>
16055 <para>These properties are added to the block containing a
16056 glossary definition in a glossary when
16057 the <parameter>glossary.as.blocks</parameter> parameter
16058 is non-zero.
16059 Use this attribute-set to set the space above and below,
16060 any font properties,
16061 and any indent for the glossary definition.</para>
16062
16063 </refsection>
16064 </refentry>
16065
16066 <refentry version="5.0" id="glossterm.list.properties">
16067 <refmeta>
16068 <refentrytitle>glossterm.list.properties</refentrytitle>
16069 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16070 </refmeta>
16071 <refnamediv>
16072 <refname>glossterm.list.properties</refname>
16073 <refpurpose>To add properties to the glossterm in a list.</refpurpose>
16074 </refnamediv>
16075
16076 <refsynopsisdiv>
16077 <programlisting id="glossterm.list.properties.frag">
16078 &lt;xsl:attribute-set name="glossterm.list.properties"&gt;
16079 &lt;/xsl:attribute-set&gt;
16080 </programlisting>
16081 </refsynopsisdiv>
16082 <refsection><info><title>Description</title></info>
16083 <para>These properties are added to the block containing a
16084 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16085 is zero.
16086 Use this attribute-set to set
16087 font properties, for example.</para>
16088
16089 </refsection>
16090 </refentry>
16091
16092 <refentry version="5.0" id="glossdef.list.properties">
16093 <refmeta>
16094 <refentrytitle>glossdef.list.properties</refentrytitle>
16095 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16096 </refmeta>
16097 <refnamediv>
16098 <refname>glossdef.list.properties</refname>
16099 <refpurpose>To add properties to the glossary definition in a list.</refpurpose>
16100 </refnamediv>
16101
16102 <refsynopsisdiv>
16103 <programlisting id="glossdef.list.properties.frag">
16104 &lt;xsl:attribute-set name="glossdef.list.properties"&gt;
16105 &lt;/xsl:attribute-set&gt;
16106 </programlisting>
16107 </refsynopsisdiv>
16108 <refsection><info><title>Description</title></info>
16109 <para>These properties are added to the block containing a
16110 glossary definition in a glossary when
16111 the <parameter>glossary.as.blocks</parameter> parameter
16112 is zero.
16113 Use this attribute-set to set font properties, for example.</para>
16114
16115 </refsection>
16116 </refentry>
16117
16118 <refentry version="5.0" id="glossterm.width">
16119 <refmeta>
16120 <refentrytitle>glossterm.width</refentrytitle>
16121 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
16122 </refmeta>
16123 <refnamediv>
16124 <refname>glossterm.width</refname>
16125 <refpurpose>Width of glossterm in list presentation mode</refpurpose>
16126 </refnamediv>
16127
16128 <refsynopsisdiv>
16129 <programlisting id="glossterm.width.frag">
16130 &lt;xsl:param name="glossterm.width"&gt;2in&lt;/xsl:param&gt;
16131 </programlisting>
16132 </refsynopsisdiv>
16133
16134 <refsection><info><title>Description</title></info>
16135
16136 <para>This parameter specifies the width reserved for glossary terms when
16137 a list presentation is used.</para>
16138
16139 </refsection>
16140 </refentry>
16141
16142 <refentry version="5.0" id="glossterm.separation">
16143 <refmeta>
16144 <refentrytitle>glossterm.separation</refentrytitle>
16145 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
16146 </refmeta>
16147 <refnamediv>
16148 <refname>glossterm.separation</refname>
16149 <refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose>
16150 </refnamediv>
16151
16152 <refsynopsisdiv>
16153 <programlisting id="glossterm.separation.frag">
16154 &lt;xsl:param name="glossterm.separation"&gt;0.25in&lt;/xsl:param&gt;
16155 </programlisting>
16156 </refsynopsisdiv>
16157
16158 <refsection><info><title>Description</title></info>
16159
16160 <para>Specifies the miminum horizontal
16161 separation between glossary terms and descriptions when
16162 they are presented side-by-side using lists
16163 when the <parameter>glossary.as.blocks</parameter>
16164 is zero.</para>
16165
16166 </refsection>
16167 </refentry>
16168
16169 <refentry version="5.0" id="glossentry.show.acronym">
16170 <refmeta>
16171 <refentrytitle>glossentry.show.acronym</refentrytitle>
16172 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16173 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> 
16174 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
16175 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
16176 </refmeta>
16177 <refnamediv>
16178 <refname>glossentry.show.acronym</refname>
16179 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
16180 </refnamediv>
16181
16182 <refsynopsisdiv>
16183 <programlisting id="glossentry.show.acronym.frag">
16184 &lt;xsl:param name="glossentry.show.acronym"&gt;no&lt;/xsl:param&gt;
16185 </programlisting>
16186 </refsynopsisdiv>
16187
16188 <refsection><info><title>Description</title></info>
16189
16190 <para>A setting of <quote>yes</quote> means they should be displayed;
16191 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
16192 then they are shown as the primary text for the entry.</para>
16193
16194 <note>
16195 <para>This setting controls both <tag>acronym</tag> and
16196 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
16197 </note>
16198
16199 </refsection>
16200 </refentry>
16201
16202 <refentry version="5.0" id="glossary.sort">
16203 <refmeta>
16204 <refentrytitle>glossary.sort</refentrytitle>
16205 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16206 </refmeta>
16207 <refnamediv>
16208 <refname>glossary.sort</refname>
16209 <refpurpose>Sort glossentry elements?</refpurpose>
16210 </refnamediv>
16211
16212 <refsynopsisdiv>
16213 <programlisting id="glossary.sort.frag">
16214 &lt;xsl:param name="glossary.sort" select="0"&gt;&lt;/xsl:param&gt;
16215 </programlisting>
16216 </refsynopsisdiv>
16217
16218 <refsection><info><title>Description</title></info>
16219
16220 <para>If non-zero, then the glossentry elements within a
16221 glossary, glossdiv, or glosslist are sorted on the glossterm, using
16222 the current lang setting.  If zero (the default), then
16223 glossentry elements are not sorted and are presented
16224 in document order.
16225 </para>
16226
16227 </refsection>
16228 </refentry>
16229
16230 </reference><reference id="misc" xml:base="../fo/param.xml"><title>Miscellaneous</title>
16231 <refentry version="5.0" id="formal.procedures">
16232 <refmeta>
16233 <refentrytitle>formal.procedures</refentrytitle>
16234 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16235 </refmeta>
16236 <refnamediv>
16237 <refname>formal.procedures</refname>
16238 <refpurpose>Selects formal or informal procedures</refpurpose>
16239 </refnamediv>
16240
16241 <refsynopsisdiv>
16242 <programlisting id="formal.procedures.frag">
16243 &lt;xsl:param name="formal.procedures" select="1"&gt;&lt;/xsl:param&gt;
16244 </programlisting>
16245 </refsynopsisdiv>
16246
16247 <refsection><info><title>Description</title></info>
16248
16249 <para>Formal procedures are numbered and always have a title.
16250 </para>
16251
16252 </refsection>
16253 </refentry>
16254
16255 <refentry version="5.0" id="formal.title.placement">
16256 <refmeta>
16257 <refentrytitle>formal.title.placement</refentrytitle>
16258 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
16259 </refmeta>
16260 <refnamediv>
16261 <refname>formal.title.placement</refname>
16262 <refpurpose>Specifies where formal object titles should occur</refpurpose>
16263 </refnamediv>
16264
16265 <refsynopsisdiv>
16266 <programlisting id="formal.title.placement.frag">
16267 &lt;xsl:param name="formal.title.placement"&gt;
16268 figure before
16269 example before
16270 equation before
16271 table before
16272 procedure before
16273 task before
16274 &lt;/xsl:param&gt;
16275 </programlisting>
16276 </refsynopsisdiv>
16277
16278 <refsection><info><title>Description</title></info>
16279
16280 <para>Specifies where formal object titles should occur. For each formal object
16281 type (<tag>figure</tag>,
16282 <tag>example</tag>,
16283 <tag>equation</tag>,
16284 <tag>table</tag>, and <tag>procedure</tag>)
16285 you can specify either the keyword
16286 <quote><literal>before</literal></quote> or
16287 <quote><literal>after</literal></quote>.</para>
16288
16289 </refsection>
16290 </refentry>
16291
16292 <refentry version="5.0" id="runinhead.default.title.end.punct">
16293 <refmeta>
16294 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
16295 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16296 </refmeta>
16297 <refnamediv>
16298 <refname>runinhead.default.title.end.punct</refname>
16299 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
16300 </refnamediv>
16301
16302 <refsynopsisdiv>
16303 <programlisting id="runinhead.default.title.end.punct.frag">&lt;xsl:param name="runinhead.default.title.end.punct"&gt;.&lt;/xsl:param&gt;
16304 </programlisting>
16305 </refsynopsisdiv>
16306
16307 <refsection><info><title>Description</title></info>
16308
16309 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
16310 string as the separator between the title and following text. The period is the default value.</para>
16311
16312 </refsection>
16313 </refentry>
16314
16315 <refentry version="5.0" id="runinhead.title.end.punct">
16316 <refmeta>
16317 <refentrytitle>runinhead.title.end.punct</refentrytitle>
16318 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16319 </refmeta>
16320 <refnamediv>
16321 <refname>runinhead.title.end.punct</refname>
16322 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
16323 </refnamediv>
16324
16325 <refsynopsisdiv>
16326 <programlisting id="runinhead.title.end.punct.frag">
16327 &lt;xsl:param name="runinhead.title.end.punct"&gt;.!?:&lt;/xsl:param&gt;
16328 </programlisting>
16329 </refsynopsisdiv>
16330
16331 <refsection><info><title>Description</title></info>
16332
16333 <para>Specify which characters are to be counted as punctuation. These
16334 characters are checked for a match with the last character of the
16335 title. If no match is found, the
16336 <parameter>runinhead.default.title.end.punct</parameter> contents are
16337 inserted. This is to avoid duplicated punctuation in the output.
16338 </para>
16339
16340 </refsection>
16341 </refentry>
16342
16343 <refentry version="5.0" id="show.comments">
16344 <refmeta>
16345 <refentrytitle>show.comments</refentrytitle>
16346 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16347 </refmeta>
16348 <refnamediv>
16349 <refname>show.comments</refname>
16350 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
16351 </refnamediv>
16352
16353 <refsynopsisdiv>
16354 <programlisting id="show.comments.frag">
16355 &lt;xsl:param name="show.comments" select="1"&gt;&lt;/xsl:param&gt;
16356 </programlisting>
16357 </refsynopsisdiv>
16358
16359 <refsection><info><title>Description</title></info>
16360
16361 <para>If non-zero, comments will be displayed, otherwise they
16362 are suppressed.  Comments here refers to the <tag>remark</tag> element
16363 (which was called <literal>comment</literal> prior to DocBook
16364 4.0), not XML comments (&lt;-- like this --&gt;) which are
16365 unavailable.
16366 </para>
16367
16368 </refsection>
16369 </refentry>
16370
16371 <refentry version="5.0" id="punct.honorific">
16372 <refmeta>
16373 <refentrytitle>punct.honorific</refentrytitle>
16374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16375 </refmeta>
16376 <refnamediv>
16377 <refname>punct.honorific</refname>
16378 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
16379 </refnamediv>
16380
16381 <refsynopsisdiv>
16382 <programlisting id="punct.honorific.frag">
16383 &lt;xsl:param name="punct.honorific"&gt;.&lt;/xsl:param&gt;
16384 </programlisting>
16385 </refsynopsisdiv>
16386
16387 <refsection><info><title>Description</title></info>
16388
16389 <para>This parameter specifies the punctuation that should be added after an
16390 honorific in a personal name.</para>
16391
16392 </refsection>
16393 </refentry>
16394
16395 <refentry version="5.0" id="segmentedlist.as.table">
16396 <refmeta>
16397 <refentrytitle>segmentedlist.as.table</refentrytitle>
16398 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16399 </refmeta>
16400 <refnamediv>
16401 <refname>segmentedlist.as.table</refname>
16402 <refpurpose>Format segmented lists as tables?</refpurpose>
16403 </refnamediv>
16404
16405 <refsynopsisdiv>
16406 <programlisting id="segmentedlist.as.table.frag">
16407 &lt;xsl:param name="segmentedlist.as.table" select="0"&gt;&lt;/xsl:param&gt;
16408 </programlisting>
16409 </refsynopsisdiv>
16410
16411 <refsection><info><title>Description</title></info>
16412
16413 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
16414 tables.</para>
16415
16416 </refsection>
16417 </refentry>
16418
16419 <refentry version="5.0" id="variablelist.as.blocks">
16420 <refmeta>
16421 <refentrytitle>variablelist.as.blocks</refentrytitle>
16422 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16423 </refmeta>
16424 <refnamediv>
16425 <refname>variablelist.as.blocks</refname>
16426 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
16427 </refnamediv>
16428
16429 <refsynopsisdiv>
16430 <programlisting id="variablelist.as.blocks.frag">
16431 &lt;xsl:param name="variablelist.as.blocks" select="0"&gt;&lt;/xsl:param&gt;
16432 </programlisting>
16433 </refsynopsisdiv>
16434
16435 <refsection><info><title>Description</title></info>
16436
16437 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
16438 blocks.</para>
16439
16440 <para>If you have long terms, proper list markup in the FO case may produce
16441 unattractive lists. By setting this parameter, you can force the stylesheets
16442 to produce block markup instead of proper lists.</para>
16443
16444 <para>You can override this setting with a processing instruction as the
16445 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
16446 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
16447 list-presentation="list"</tag>.</para>
16448
16449 <para>When using <literal>list-presentation="list"</literal>,
16450 you can also control the amount of space used for the <tag>term</tag>s with 
16451 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
16452 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
16453 or allow the stylesheets to attempt to calculate the amount of space to leave based on the 
16454 number of letters in the longest term.  
16455 </para>
16456
16457 <programlisting>  &lt;variablelist&gt;
16458         &lt;?dbfo list-presentation="list"?&gt;
16459         &lt;?dbfo term-width="1.5in"?&gt;
16460         &lt;?dbhtml list-presentation="table"?&gt;
16461         &lt;?dbhtml term-width="1.5in"?&gt;
16462         &lt;varlistentry&gt;
16463           &lt;term&gt;list&lt;/term&gt;
16464           &lt;listitem&gt;
16465                 &lt;para&gt;
16466                   Formatted as a list even if variablelist.as.blocks is set to 1.
16467                 &lt;/para&gt;
16468           &lt;/listitem&gt;
16469         &lt;/varlistentry&gt;
16470   &lt;/variablelist&gt;</programlisting>
16471
16472
16473 </refsection>
16474
16475 </refentry>
16476
16477 <refentry version="5.0" id="blockquote.properties">
16478 <refmeta>
16479   <refentrytitle>blockquote.properties</refentrytitle>
16480   <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16481 </refmeta>  
16482 <refnamediv>
16483 <refname>blockquote.properties</refname>
16484 <refpurpose>To set the style for block quotations.</refpurpose>
16485 </refnamediv>
16486
16487 <refsynopsisdiv>
16488 <programlisting id="blockquote.properties.frag">
16489 &lt;xsl:attribute-set name="blockquote.properties"&gt;
16490 &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;0.5in&lt;/xsl:attribute&gt;
16491 &lt;xsl:attribute name="margin-{$direction.align.end}"&gt;0.5in&lt;/xsl:attribute&gt;
16492 &lt;xsl:attribute name="space-after.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
16493 &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
16494 &lt;xsl:attribute name="space-after.maximum"&gt;2em&lt;/xsl:attribute&gt;
16495 &lt;/xsl:attribute-set&gt;
16496 </programlisting>
16497 </refsynopsisdiv>
16498
16499 <refsection><info><title>Description</title></info>
16500
16501 <para>The <parameter>blockquote.properties</parameter> attribute set specifies
16502 the formating properties of block quotations.</para>
16503
16504 </refsection>
16505 </refentry>
16506
16507 <refentry version="5.0" id="ulink.show">
16508 <refmeta>
16509 <refentrytitle>ulink.show</refentrytitle>
16510 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16511 </refmeta>
16512 <refnamediv>
16513 <refname>ulink.show</refname>
16514 <refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose>
16515 </refnamediv>
16516
16517 <refsynopsisdiv>
16518 <programlisting id="ulink.show.frag">
16519 &lt;xsl:param name="ulink.show" select="1"&gt;&lt;/xsl:param&gt;
16520 </programlisting>
16521 </refsynopsisdiv>
16522
16523 <refsection><info><title>Description</title></info>
16524
16525 <para>If non-zero, the URL of each <tag>ulink</tag> will
16526 appear after the text of the link. If the text of the link and the URL
16527 are identical, the URL is suppressed. </para>
16528
16529 <para>See also <parameter>ulink.footnotes</parameter>.</para>
16530
16531 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing 
16532 DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline 
16533 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes 
16534 that point to external resources.</para>
16535 </note>
16536
16537 </refsection>
16538 </refentry>
16539
16540 <refentry version="5.0" id="ulink.footnotes">
16541 <refmeta>
16542 <refentrytitle>ulink.footnotes</refentrytitle>
16543 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16544 </refmeta>
16545 <refnamediv>
16546 <refname>ulink.footnotes</refname>
16547 <refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose>
16548 </refnamediv>
16549
16550 <refsynopsisdiv>
16551 <programlisting id="ulink.footnotes.frag">
16552 &lt;xsl:param name="ulink.footnotes" select="0"&gt;&lt;/xsl:param&gt;
16553 </programlisting>
16554 </refsynopsisdiv>
16555
16556 <refsection><info><title>Description</title></info>
16557
16558 <para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero,
16559 the URL of each <tag>ulink</tag> will appear as a footnote.</para>
16560
16561 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing 
16562 DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline 
16563 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes 
16564 that point to external resources.</para>
16565 </note>
16566
16567 </refsection>
16568 </refentry>
16569
16570 <refentry version="5.0" id="ulink.hyphenate">
16571 <refmeta>
16572 <refentrytitle>ulink.hyphenate</refentrytitle>
16573 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16574 </refmeta>
16575 <refnamediv>
16576 <refname>ulink.hyphenate</refname>
16577 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
16578 </refnamediv>
16579
16580 <refsynopsisdiv>
16581 <programlisting id="ulink.hyphenate.frag">
16582 &lt;xsl:param name="ulink.hyphenate"&gt;&lt;/xsl:param&gt;
16583 </programlisting>
16584 </refsynopsisdiv>
16585
16586 <refsection><info><title>Description</title></info>
16587
16588 <para>If not empty, the specified character (or more generally, content) is
16589 added to URLs after every character included in the string
16590 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
16591 is <quote>/</quote>). If the character in this parameter is a
16592 Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO
16593 processors will be able to reasonably hyphenate long URLs.</para>
16594
16595 <para>As of 28 Jan 2002, discretionary hyphens are more widely and correctly
16596 supported than zero-width spaces for this purpose.</para>
16597
16598 </refsection>
16599 </refentry>
16600
16601 <refentry version="5.0" id="ulink.hyphenate.chars">
16602 <refmeta>
16603 <refentrytitle>ulink.hyphenate.chars</refentrytitle>
16604 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16605 </refmeta>
16606 <refnamediv>
16607 <refname>ulink.hyphenate.chars</refname>
16608 <refpurpose>List of characters to allow ulink URLs to be automatically hyphenated on</refpurpose>
16609 </refnamediv>
16610
16611 <refsynopsisdiv>
16612 <programlisting id="ulink.hyphenate.chars.frag">
16613 &lt;xsl:param name="ulink.hyphenate.chars"&gt;/&lt;/xsl:param&gt;
16614 </programlisting>
16615 </refsynopsisdiv>
16616
16617 <refsection><info><title>Description</title></info>
16618
16619 <para>If the <parameter>ulink.hyphenate</parameter> is not empty, then 
16620 hyphenation of ulinks is turned on, and any
16621 character contained in this parameter is treated as an allowable
16622 hyphenation point.</para>
16623
16624 <para>The default value is <quote>/</quote>, but the parameter
16625 could be customized
16626 to contain other URL characters, as for example:</para>
16627 <programlisting>
16628 &lt;xsl:param name="ulink.hyphenate.chars"&gt;:/@&amp;?.#&lt;/xsl:param&gt;
16629 </programlisting>
16630
16631 </refsection>
16632 </refentry>
16633
16634 <refentry version="5.0" id="shade.verbatim">
16635 <refmeta>
16636 <refentrytitle>shade.verbatim</refentrytitle>
16637 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16638 </refmeta>
16639 <refnamediv>
16640 <refname>shade.verbatim</refname>
16641 <refpurpose>Should verbatim environments be shaded?</refpurpose>
16642 </refnamediv>
16643
16644 <refsynopsisdiv>
16645 <programlisting id="shade.verbatim.frag">&lt;xsl:param name="shade.verbatim" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
16646 </refsynopsisdiv>
16647
16648 <refsection><info><title>Description</title></info>
16649
16650 <para>In the FO stylesheet, if this parameter is non-zero then the
16651 <property>shade.verbatim.style</property> properties will be applied
16652 to verbatim environments.</para>
16653
16654 <para>In the HTML stylesheet, this parameter is now deprecated. Use
16655 CSS instead.</para>
16656
16657 </refsection>
16658 </refentry>
16659
16660 <refentry version="5.0" id="shade.verbatim.style">
16661 <refmeta>
16662 <refentrytitle>shade.verbatim.style</refentrytitle>
16663 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16664 </refmeta>
16665 <refnamediv>
16666 <refname>shade.verbatim.style</refname>
16667 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
16668 </refnamediv>
16669
16670 <refsynopsisdiv>
16671 <programlisting id="shade.verbatim.style.frag">
16672
16673 &lt;xsl:attribute-set name="shade.verbatim.style"&gt;
16674   &lt;xsl:attribute name="background-color"&gt;#E0E0E0&lt;/xsl:attribute&gt;
16675 &lt;/xsl:attribute-set&gt;
16676 </programlisting>
16677 </refsynopsisdiv>
16678
16679 <refsection><info><title>Description</title></info>
16680
16681 <para>Properties that specify the style of shaded verbatim listings. The
16682 parameters specified (the border and background color) are added to
16683 the styling of the xsl-fo output. A border might be specified as "thin
16684 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
16685
16686 </refsection>
16687 </refentry>
16688
16689 <refentry version="5.0" id="hyphenate.verbatim">
16690 <refmeta>
16691 <refentrytitle>hyphenate.verbatim</refentrytitle>
16692 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16693 </refmeta>
16694 <refnamediv>
16695 <refname>hyphenate.verbatim</refname>
16696 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>
16697 </refnamediv>
16698
16699 <refsynopsisdiv>
16700 <programlisting id="hyphenate.verbatim.frag">&lt;xsl:param name="hyphenate.verbatim" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
16701 </refsynopsisdiv>
16702
16703 <refsection><info><title>Description</title></info>
16704
16705 <para>If the lines of program listing are too long to fit into one
16706 line it is quite common to split them at space and indicite by hook
16707 arrow that code continues on the next line. You can turn on this
16708 behaviour for <tag>programlisting</tag>,
16709 <tag>screen</tag> and <tag>synopsis</tag> elements by
16710 using this parameter.</para>
16711
16712 <para>Note that you must also enable line wrapping for verbatim environments and
16713 select appropriate hyphenation character (e.g. hook arrow). This can
16714 be done using <parameter>monospace.verbatim.properties</parameter>
16715 attribute set:</para>
16716
16717 <programlisting>&lt;xsl:attribute-set name="monospace.verbatim.properties" 
16718                    use-attribute-sets="verbatim.properties monospace.properties"&gt;
16719   &lt;xsl:attribute name="wrap-option"&gt;wrap&lt;/xsl:attribute&gt;
16720   &lt;xsl:attribute name="hyphenation-character"&gt;&amp;#x25BA;&lt;/xsl:attribute&gt;
16721 &lt;/xsl:attribute-set&gt;</programlisting>
16722
16723 <para>For a list of arrows available in Unicode see <uri xlink:href="http://www.unicode.org/charts/PDF/U2190.pdf">http://www.unicode.org/charts/PDF/U2190.pdf</uri> and <uri xlink:href="http://www.unicode.org/charts/PDF/U2900.pdf">http://www.unicode.org/charts/PDF/U2900.pdf</uri> and make sure that
16724 selected character is available in the font you are using for verbatim
16725 environments.</para>
16726
16727 </refsection>
16728 </refentry>
16729
16730 <refentry version="5.0" id="hyphenate.verbatim.characters">
16731 <refmeta>
16732 <refentrytitle>hyphenate.verbatim.characters</refentrytitle>
16733 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16734 </refmeta>
16735 <refnamediv>
16736 <refname>hyphenate.verbatim.characters</refname>
16737 <refpurpose>List of characters after which a line break can occur in listings</refpurpose>
16738 </refnamediv>
16739
16740 <refsynopsisdiv>
16741 <programlisting id="hyphenate.verbatim.characters.frag">
16742 &lt;xsl:param name="hyphenate.verbatim.characters"&gt;&lt;/xsl:param&gt;
16743 </programlisting>
16744 </refsynopsisdiv>
16745
16746 <refsection><info><title>Description</title></info>
16747
16748 <para>If you enable <parameter>hyphenate.verbatim</parameter> line
16749 breaks are allowed only on space characters. If this is not enough for
16750 your document, you can specify list of additional characters after
16751 which line break is allowed in this parameter.</para>
16752
16753 </refsection>
16754 </refentry>
16755
16756 <refentry version="5.0" id="use.svg">
16757 <refmeta>
16758 <refentrytitle>use.svg</refentrytitle>
16759 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16760 </refmeta>
16761 <refnamediv>
16762 <refname>use.svg</refname>
16763 <refpurpose>Allow SVG in the result tree?</refpurpose>
16764 </refnamediv>
16765
16766 <refsynopsisdiv>
16767 <programlisting id="use.svg.frag">
16768 &lt;xsl:param name="use.svg" select="1"&gt;&lt;/xsl:param&gt;
16769 </programlisting>
16770 </refsynopsisdiv>
16771
16772 <refsection><info><title>Description</title></info>
16773
16774 <para>If non-zero, SVG will be considered an acceptable image format. SVG
16775 is passed through to the result tree, so correct rendering of the resulting
16776 diagram depends on the formatter (FO processor or web browser) that is used
16777 to process the output from the stylesheet.</para>
16778
16779 </refsection>
16780 </refentry>
16781
16782 <refentry version="5.0" id="use.role.as.xrefstyle">
16783 <refmeta>
16784 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
16785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16786 </refmeta>
16787 <refnamediv>
16788 <refname>use.role.as.xrefstyle</refname>
16789 <refpurpose>Use <tag class="attribute">role</tag> attribute for
16790 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
16791 </refnamediv>
16792
16793 <refsynopsisdiv>
16794 <programlisting id="use.role.as.xrefstyle.frag">
16795 &lt;xsl:param name="use.role.as.xrefstyle" select="1"&gt;&lt;/xsl:param&gt;
16796 </programlisting>
16797 </refsynopsisdiv>
16798
16799 <refsection><info><title>Description</title></info>
16800
16801 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows 
16802 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
16803
16804 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
16805 <tag>xref</tag> will be used to select the cross reference style.
16806 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
16807 If the <tag class="attribute">xrefstyle</tag> attribute is present, 
16808 <tag class="attribute">role</tag> will be ignored, regardless of the setting
16809 of this parameter.</para>
16810
16811 </refsection>
16812
16813 <refsection><info><title>Example</title></info>
16814
16815 <para>The following small stylesheet shows how to configure the
16816 stylesheets to make use of the cross reference style:</para>
16817
16818 <programlisting>&lt;?xml version="1.0"?&gt;
16819 &lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
16820                 version="1.0"&gt;
16821
16822 &lt;xsl:import href="../xsl/html/docbook.xsl"/&gt;
16823
16824 &lt;xsl:output method="html"/&gt;
16825
16826 &lt;xsl:param name="local.l10n.xml" select="document('')"/&gt;
16827 &lt;l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"&gt;
16828   &lt;l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"&gt;
16829    &lt;l:context name="xref"&gt;
16830       &lt;l:template name="chapter" style="title" text="Chapter %n, %t"/&gt;
16831       &lt;l:template name="chapter" text="Chapter %n"/&gt;
16832     &lt;/l:context&gt;
16833   &lt;/l:l10n&gt;
16834 &lt;/l:i18n&gt;
16835
16836 &lt;/xsl:stylesheet&gt;</programlisting>
16837
16838 <para>With this stylesheet, the cross references in the following document:</para>
16839
16840 <programlisting>&lt;?xml version="1.0" encoding="utf-8"?&gt;
16841 &lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
16842                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
16843 &lt;book id="book"&gt;&lt;title&gt;Book&lt;/title&gt;
16844
16845 &lt;preface&gt;
16846 &lt;title&gt;Preface&lt;/title&gt;
16847
16848 &lt;para&gt;Normal: &lt;xref linkend="ch1"/&gt;.&lt;/para&gt;
16849 &lt;para&gt;Title: &lt;xref xrefstyle="title" linkend="ch1"/&gt;.&lt;/para&gt;
16850
16851 &lt;/preface&gt;
16852
16853 &lt;chapter id="ch1"&gt;
16854 &lt;title&gt;First Chapter&lt;/title&gt;
16855
16856 &lt;para&gt;Irrelevant.&lt;/para&gt;
16857
16858 &lt;/chapter&gt;
16859 &lt;/book&gt;</programlisting>
16860
16861 <para>will appear as:</para>
16862
16863 <informalexample>
16864 <para>Normal: Chapter 1.</para>
16865 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
16866 </informalexample>
16867 </refsection>
16868
16869 </refentry>
16870
16871 <refentry version="5.0" id="menuchoice.separator">
16872 <refmeta>
16873 <refentrytitle>menuchoice.separator</refentrytitle>
16874 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16875 </refmeta>
16876 <refnamediv>
16877 <refname>menuchoice.separator</refname>
16878 <refpurpose>Separator between items of a <tag>menuchoice</tag>
16879 other than <tag>guimenuitem</tag> and
16880 <tag>guisubmenu</tag></refpurpose>
16881 </refnamediv>
16882
16883 <refsynopsisdiv>
16884 <programlisting id="menuchoice.separator.frag">
16885 &lt;xsl:param name="menuchoice.separator"&gt;+&lt;/xsl:param&gt;
16886 </programlisting>
16887 </refsynopsisdiv>
16888
16889 <refsection><info><title>Description</title></info>
16890
16891 <para>Separator used to connect items of a <tag>menuchoice</tag> other
16892 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
16893 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
16894 </para>
16895
16896 </refsection>
16897 </refentry>
16898
16899 <refentry version="5.0" id="menuchoice.menu.separator">
16900 <refmeta>
16901 <refentrytitle>menuchoice.menu.separator</refentrytitle>
16902 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16903 </refmeta>
16904 <refnamediv>
16905 <refname>menuchoice.menu.separator</refname>
16906 <refpurpose>Separator between items of a <tag>menuchoice</tag>
16907 with <tag>guimenuitem</tag> or
16908 <tag>guisubmenu</tag></refpurpose>
16909 </refnamediv>
16910
16911 <refsynopsisdiv>
16912 <programlisting id="menuchoice.menu.separator.frag">
16913 &lt;xsl:param name="menuchoice.menu.separator"&gt; &#8594; &lt;/xsl:param&gt;
16914 </programlisting>
16915 </refsynopsisdiv>
16916
16917 <refsection><info><title>Description</title></info>
16918
16919 <para>Separator used to connect items of a <tag>menuchoice</tag> with
16920 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
16921 are linked with <parameter>menuchoice.separator</parameter>.
16922 </para>
16923 <para>The default value is &amp;#x2192;, which is the
16924 &amp;rarr; (right arrow) character entity.  
16925 The current FOP (0.20.5) requires setting the font-family
16926 explicitly.
16927 </para>
16928 <para>The default value also includes spaces around the arrow,
16929 which will allow a line to break.  Replace the spaces with
16930 &amp;#xA0; (nonbreaking space) if you don't want those
16931 spaces to break.
16932 </para>
16933
16934 </refsection>
16935 </refentry>
16936
16937 <refentry version="5.0" id="default.float.class">
16938 <refmeta>
16939 <refentrytitle>default.float.class</refentrytitle>
16940 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16941 </refmeta>
16942 <refnamediv>
16943 <refname>default.float.class</refname>
16944 <refpurpose>Specifies the default float class</refpurpose>
16945 </refnamediv>
16946
16947 <refsynopsisdiv>
16948 <programlisting id="default.float.class.frag">
16949 &lt;xsl:param name="default.float.class"&gt;
16950   &lt;xsl:choose&gt;
16951     &lt;xsl:when test="contains($stylesheet.result.type,'html')"&gt;left&lt;/xsl:when&gt;
16952     &lt;xsl:otherwise&gt;before&lt;/xsl:otherwise&gt;
16953   &lt;/xsl:choose&gt;
16954 &lt;/xsl:param&gt;
16955 </programlisting>
16956 </refsynopsisdiv>
16957
16958 <refsection><info><title>Description</title></info>
16959
16960 <para>Selects the direction in which a float should be placed. for
16961 xsl-fo this is before, for html it is left. For Western texts, the
16962 before direction is the top of the page.</para>
16963
16964 </refsection>
16965 </refentry>
16966
16967 <refentry version="5.0" id="footnote.number.format">
16968 <refmeta>
16969 <refentrytitle>footnote.number.format</refentrytitle>
16970 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
16971 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
16972 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
16973 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
16974 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
16975 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
16976 </refmeta>
16977 <refnamediv>
16978 <refname>footnote.number.format</refname>
16979 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
16980 </refnamediv>
16981
16982 <refsynopsisdiv>
16983 <programlisting id="footnote.number.format.frag">
16984 &lt;xsl:param name="footnote.number.format"&gt;1&lt;/xsl:param&gt;
16985 </programlisting>
16986 </refsynopsisdiv>
16987
16988 <refsection><info><title>Description</title></info>
16989
16990 <para>The <parameter>footnote.number.format</parameter> specifies the format
16991 to use for footnote numeration (1, i, I, a, or A).</para>
16992
16993 </refsection>
16994 </refentry>
16995
16996 <refentry version="5.0" id="table.footnote.number.format">
16997 <refmeta>
16998 <refentrytitle>table.footnote.number.format</refentrytitle>
16999 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
17000 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
17001 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
17002 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
17003 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
17004 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
17005 </refmeta>
17006 <refnamediv>
17007 <refname>table.footnote.number.format</refname>
17008 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
17009 </refnamediv>
17010
17011 <refsynopsisdiv>
17012 <programlisting id="table.footnote.number.format.frag">
17013 &lt;xsl:param name="table.footnote.number.format"&gt;a&lt;/xsl:param&gt;
17014 </programlisting>
17015 </refsynopsisdiv>
17016
17017 <refsection><info><title>Description</title></info>
17018
17019 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
17020 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
17021
17022 </refsection>
17023 </refentry>
17024
17025 <refentry version="5.0" id="footnote.number.symbols">
17026 <refmeta>
17027 <refentrytitle>footnote.number.symbols</refentrytitle>
17028 <refmiscinfo class="other" otherclass="datatype"/>
17029 </refmeta>
17030 <refnamediv>
17031 <refname>footnote.number.symbols</refname>
17032 <refpurpose>Special characters to use as footnote markers</refpurpose>
17033 </refnamediv>
17034
17035 <refsynopsisdiv>
17036 <programlisting id="footnote.number.symbols.frag">
17037 &lt;xsl:param name="footnote.number.symbols"&gt;&lt;/xsl:param&gt;
17038 </programlisting>
17039 </refsynopsisdiv>
17040
17041 <refsection><info><title>Description</title></info>
17042
17043 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
17044 footnotes will use the characters it contains as footnote symbols. For example,
17045 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
17046 footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
17047 <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
17048 than symbols, the stylesheets will fall back to numbered footnotes using
17049 <parameter>footnote.number.format</parameter>.</para>
17050
17051 <para>The use of symbols for footnotes depends on the ability of your
17052 processor (or browser) to render the symbols you select. Not all systems are
17053 capable of displaying the full range of Unicode characters. If the quoted characters
17054 in the preceding paragraph are not displayed properly, that's a good indicator
17055 that you may have trouble using those symbols for footnotes.</para>
17056
17057 </refsection>
17058 </refentry>
17059
17060 <refentry version="5.0" id="table.footnote.number.symbols">
17061 <refmeta>
17062 <refentrytitle>table.footnote.number.symbols</refentrytitle>
17063 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17064 </refmeta>
17065 <refnamediv>
17066 <refname>table.footnote.number.symbols</refname>
17067 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
17068 </refnamediv>
17069
17070 <refsynopsisdiv>
17071 <programlisting id="table.footnote.number.symbols.frag">
17072 &lt;xsl:param name="table.footnote.number.symbols"&gt;&lt;/xsl:param&gt;
17073 </programlisting>
17074 </refsynopsisdiv>
17075
17076 <refsection><info><title>Description</title></info>
17077
17078 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
17079 table footnotes will use the characters it contains as footnote symbols. For example,
17080 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
17081 footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
17082 <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
17083 than symbols, the stylesheets will fall back to numbered footnotes using
17084 <parameter>table.footnote.number.format</parameter>.</para>
17085
17086 <para>The use of symbols for footnotes depends on the ability of your
17087 processor (or browser) to render the symbols you select. Not all systems are
17088 capable of displaying the full range of Unicode characters. If the quoted characters
17089 in the preceding paragraph are not displayed properly, that's a good indicator
17090 that you may have trouble using those symbols for footnotes.</para>
17091
17092 </refsection>
17093 </refentry>
17094
17095 <refentry version="5.0" id="footnote.properties">
17096 <refmeta>
17097 <refentrytitle>footnote.properties</refentrytitle>
17098 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17099 </refmeta>  
17100 <refnamediv>
17101 <refname>footnote.properties</refname>
17102 <refpurpose>Properties applied to each footnote body
17103 </refpurpose>
17104 </refnamediv>
17105
17106 <refsynopsisdiv>
17107 <programlisting id="footnote.properties.frag">
17108 &lt;xsl:attribute-set name="footnote.properties"&gt;
17109   &lt;xsl:attribute name="font-family"&gt;&lt;xsl:value-of select="$body.fontset"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17110   &lt;xsl:attribute name="font-size"&gt;&lt;xsl:value-of select="$footnote.font.size"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17111   &lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
17112   &lt;xsl:attribute name="font-style"&gt;normal&lt;/xsl:attribute&gt;
17113   &lt;xsl:attribute name="text-align"&gt;&lt;xsl:value-of select="$alignment"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17114   &lt;xsl:attribute name="start-indent"&gt;0pt&lt;/xsl:attribute&gt;
17115   &lt;xsl:attribute name="text-indent"&gt;0pt&lt;/xsl:attribute&gt;
17116   &lt;xsl:attribute name="hyphenate"&gt;&lt;xsl:value-of select="$hyphenate"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17117   &lt;xsl:attribute name="wrap-option"&gt;wrap&lt;/xsl:attribute&gt;
17118   &lt;xsl:attribute name="linefeed-treatment"&gt;treat-as-space&lt;/xsl:attribute&gt;
17119 &lt;/xsl:attribute-set&gt;
17120 </programlisting>
17121 </refsynopsisdiv>
17122
17123 <refsection><info><title>Description</title></info>
17124
17125 <para>This attribute set is applied to the footnote-block 
17126 for each footnote.
17127 It can be used to set the
17128 font-size, font-family, and other inheritable properties that will be
17129 applied to all footnotes.</para>
17130
17131 </refsection>
17132 </refentry>
17133
17134 <refentry version="5.0" id="table.footnote.properties">
17135 <refmeta>
17136 <refentrytitle>table.footnote.properties</refentrytitle>
17137 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17138 </refmeta>
17139 <refnamediv>
17140 <refname>table.footnote.properties</refname>
17141 <refpurpose>Properties applied to each table footnote body
17142 </refpurpose>
17143 </refnamediv>
17144
17145 <refsynopsisdiv>
17146 <programlisting id="table.footnote.properties.frag">
17147 &lt;xsl:attribute-set name="table.footnote.properties"&gt;
17148   &lt;xsl:attribute name="font-family"&gt;&lt;xsl:value-of select="$body.fontset"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17149   &lt;xsl:attribute name="font-size"&gt;&lt;xsl:value-of select="$footnote.font.size"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17150   &lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
17151   &lt;xsl:attribute name="font-style"&gt;normal&lt;/xsl:attribute&gt;
17152   &lt;xsl:attribute name="space-before"&gt;2pt&lt;/xsl:attribute&gt;
17153   &lt;xsl:attribute name="text-align"&gt;&lt;xsl:value-of select="$alignment"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17154 &lt;/xsl:attribute-set&gt;
17155 </programlisting>
17156 </refsynopsisdiv>
17157
17158 <refsection><info><title>Description</title></info>
17159
17160 <para>This attribute set is applied to the footnote-block 
17161 for each table footnote.
17162 It can be used to set the
17163 font-size, font-family, and other inheritable properties that will be
17164 applied to all table footnotes.</para>
17165
17166 </refsection>
17167 </refentry>
17168
17169 <refentry version="5.0" id="footnote.mark.properties">
17170 <refmeta>
17171 <refentrytitle>footnote.mark.properties</refentrytitle>
17172 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17173 </refmeta>  
17174 <refnamediv>
17175 <refname>footnote.mark.properties</refname>
17176 <refpurpose>Properties applied to each footnote mark
17177 </refpurpose>
17178 </refnamediv>
17179
17180 <refsynopsisdiv>
17181 <programlisting id="footnote.mark.properties.frag">
17182 &lt;xsl:attribute-set name="footnote.mark.properties"&gt;
17183   &lt;xsl:attribute name="font-family"&gt;&lt;xsl:value-of select="$body.fontset"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
17184   &lt;xsl:attribute name="font-size"&gt;75%&lt;/xsl:attribute&gt;
17185   &lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
17186   &lt;xsl:attribute name="font-style"&gt;normal&lt;/xsl:attribute&gt;
17187 &lt;/xsl:attribute-set&gt;
17188 </programlisting>
17189 </refsynopsisdiv>
17190
17191 <refsection><info><title>Description</title></info>
17192
17193 <para>This attribute set is applied to the footnote mark used
17194 for each footnote.
17195 It should contain only inline properties.
17196 </para>
17197
17198 <para>The property to make the mark a superscript is contained in the
17199 footnote template itself, because the current version of FOP reports
17200 an error if baseline-shift is used.
17201 </para>
17202
17203 </refsection>
17204 </refentry>
17205
17206 <refentry version="5.0" id="footnote.sep.leader.properties">
17207 <refmeta>
17208 <refentrytitle>footnote.sep.leader.properties</refentrytitle>
17209 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17210 </refmeta>
17211 <refnamediv>
17212 <refname>footnote.sep.leader.properties</refname>
17213 <refpurpose>Properties associated with footnote separators</refpurpose>
17214 </refnamediv>
17215
17216 <refsynopsisdiv>
17217 <programlisting id="footnote.sep.leader.properties.frag">
17218 &lt;xsl:attribute-set name="footnote.sep.leader.properties"&gt;
17219   &lt;xsl:attribute name="color"&gt;black&lt;/xsl:attribute&gt;
17220   &lt;xsl:attribute name="leader-pattern"&gt;rule&lt;/xsl:attribute&gt;
17221   &lt;xsl:attribute name="leader-length"&gt;1in&lt;/xsl:attribute&gt;
17222 &lt;/xsl:attribute-set&gt;
17223 </programlisting>
17224 </refsynopsisdiv>
17225
17226 <refsection><info><title>Description</title></info>
17227
17228 <para>The styling for the rule line that separates the
17229 footnotes from the body text.
17230 These are properties applied to the fo:leader used as
17231 the separator.
17232 </para>
17233 <para>If you want to do more than just set properties on
17234 the leader element, then you can customize the template
17235 named <literal>footnote.separator</literal> in 
17236 <filename>fo/pagesetup.xsl</filename>.</para>
17237
17238 </refsection>
17239 </refentry>
17240
17241 <refentry version="5.0" id="xref.with.number.and.title">
17242 <refmeta>
17243 <refentrytitle>xref.with.number.and.title</refentrytitle>
17244 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17245 </refmeta>
17246 <refnamediv>
17247 <refname>xref.with.number.and.title</refname>
17248 <refpurpose>Use number and title in cross references</refpurpose>
17249 </refnamediv>
17250
17251 <refsynopsisdiv>
17252 <programlisting id="xref.with.number.and.title.frag">
17253 &lt;xsl:param name="xref.with.number.and.title" select="1"&gt;&lt;/xsl:param&gt;
17254 </programlisting>
17255 </refsynopsisdiv>
17256
17257 <refsection><info><title>Description</title></info>
17258
17259 <para>A cross reference may include the number (for example, the number of
17260 an example or figure) and the <tag>title</tag> which is a required child of some
17261 targets. This parameter inserts both the relevant number as well as
17262 the title into the link. </para>
17263
17264 </refsection>
17265 </refentry>
17266
17267 <refentry version="5.0" id="superscript.properties">
17268 <refmeta>
17269 <refentrytitle>superscript.properties</refentrytitle>
17270 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17271 </refmeta>
17272 <refnamediv>
17273 <refname>superscript.properties</refname>
17274 <refpurpose>Properties associated with superscripts</refpurpose>
17275 </refnamediv>
17276
17277 <refsynopsisdiv>
17278 <programlisting id="superscript.properties.frag">
17279 &lt;xsl:attribute-set name="superscript.properties"&gt;
17280   &lt;xsl:attribute name="font-size"&gt;75%&lt;/xsl:attribute&gt;
17281 &lt;/xsl:attribute-set&gt;
17282 </programlisting>
17283 </refsynopsisdiv>
17284
17285 <refsection><info><title>Description</title></info>
17286
17287 <para>Specifies styling properties for superscripts.</para>
17288
17289 </refsection>
17290 </refentry>
17291
17292 <refentry version="5.0" id="subscript.properties">
17293 <refmeta>
17294 <refentrytitle>subscript.properties</refentrytitle>
17295 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17296 </refmeta>
17297 <refnamediv>
17298 <refname>subscript.properties</refname>
17299 <refpurpose>Properties associated with subscripts</refpurpose>
17300 </refnamediv>
17301
17302 <refsynopsisdiv>
17303 <programlisting id="subscript.properties.frag">
17304 &lt;xsl:attribute-set name="subscript.properties"&gt;
17305   &lt;xsl:attribute name="font-size"&gt;75%&lt;/xsl:attribute&gt;
17306 &lt;/xsl:attribute-set&gt;
17307 </programlisting>
17308 </refsynopsisdiv>
17309
17310 <refsection><info><title>Description</title></info>
17311
17312 <para>Specifies styling properties for subscripts.</para>
17313
17314 </refsection>
17315 </refentry>
17316
17317 <refentry version="5.0" id="pgwide.properties">
17318 <refmeta>
17319 <refentrytitle>pgwide.properties</refentrytitle>
17320 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17321 </refmeta>
17322 <refnamediv>
17323 <refname>pgwide.properties</refname>
17324 <refpurpose>Properties to make a figure or table page wide.
17325 </refpurpose>
17326 </refnamediv>
17327
17328 <refsynopsisdiv>
17329 <programlisting id="pgwide.properties.frag">
17330 &lt;xsl:attribute-set name="pgwide.properties"&gt;
17331   &lt;xsl:attribute name="start-indent"&gt;0pt&lt;/xsl:attribute&gt;
17332 &lt;/xsl:attribute-set&gt;
17333 </programlisting>
17334 </refsynopsisdiv>
17335
17336 <refsection><info><title>Description</title></info>
17337
17338 <para>This attribute set is used to set the properties
17339 that make a figure or table "page wide" in fo output.
17340 It comes into effect when an attribute <literal>pgwide="1"</literal>
17341 is used.
17342 </para>
17343
17344 <para>
17345 By default, it sets <parameter>start-indent</parameter>
17346 to <literal>0pt</literal>.
17347 In a stylesheet that sets the parameter
17348 <parameter>body.start.indent</parameter>
17349 to a non-zero value in order to indent body text,
17350 this attribute set can be used to outdent pgwide
17351 figures to the start margin.
17352 </para>
17353
17354 <para>If a document uses a multi-column page layout,
17355 then this attribute set could try setting <parameter>span</parameter>
17356 to a value of <literal>all</literal>.  However, this may
17357 not work with some processors because a span property must be on an
17358 fo:block that is a direct child of fo:flow.  It may work in
17359 some processors anyway.
17360 </para>
17361
17362 </refsection>
17363 </refentry>
17364
17365 <refentry version="5.0" id="highlight.source">
17366 <refmeta>
17367 <refentrytitle>highlight.source</refentrytitle>
17368 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17369 </refmeta>
17370 <refnamediv>
17371 <refname>highlight.source</refname>
17372 <refpurpose>Should the content of <tag>programlisting</tag>
17373 be syntactically highlighted?</refpurpose>
17374 </refnamediv>
17375
17376 <refsynopsisdiv>
17377 <programlisting id="highlight.source.frag">
17378 &lt;xsl:param name="highlight.source" select="0"&gt;&lt;/xsl:param&gt;
17379 </programlisting>
17380 </refsynopsisdiv>
17381
17382 <refsection><info><title>Description</title></info>
17383
17384 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the 
17385 content of <tag>programlisting</tag> elements. You specify the language for each programlisting 
17386 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter> 
17387 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag> 
17388 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
17389
17390 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be 
17391 downloaded separately (see below).</para>
17392
17393 <itemizedlist>
17394 <para>In order to use this extension, you must</para> 
17395
17396 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
17397 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link> 
17398 at SourceForge.</para>
17399 </listitem>
17400 <listitem>
17401 <para>use a customization layer in which you import one of the following stylesheet modules: 
17402 <itemizedlist>
17403   <listitem>
17404     <para><filename>html/highlight.xsl</filename>
17405     </para>
17406   </listitem>
17407 <listitem>
17408     <para><filename>xhtml/highlight.xsl</filename>
17409     </para>
17410   </listitem>
17411 <listitem>
17412     <para><filename>xhtml-1_1/highlight.xsl</filename>
17413     </para>
17414   </listitem>
17415 <listitem>
17416     <para><filename>fo/highlight.xsl</filename>
17417     </para>
17418 </listitem>
17419 </itemizedlist>
17420 </para>
17421 </listitem>
17422 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
17423 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax 
17424 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file, 
17425 <filename>highlighting/xslthl-config.xml</filename>.</para>
17426 </listitem>
17427 </itemizedlist>
17428
17429 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is 
17430 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
17431
17432 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
17433
17434 <informalexample>
17435 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar 
17436 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet 
17437 -o test.html test.xml myhtml.xsl</command></para>
17438 </informalexample>
17439
17440 </refsection>
17441 </refentry>
17442
17443 <refentry version="5.0" id="highlight.xslthl.config">
17444 <refmeta>
17445 <refentrytitle>highlight.xslthl.config</refentrytitle>
17446 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
17447 </refmeta>
17448 <refnamediv>
17449 <refname>highlight.xslthl.config</refname>
17450 <refpurpose>Location of XSLTHL configuration file</refpurpose>
17451 </refnamediv>
17452
17453 <refsynopsisdiv>
17454 <programlisting id="highlight.xslthl.config.frag">
17455 &lt;xsl:param name="highlight.xslthl.config"&gt;&lt;/xsl:param&gt;
17456 </programlisting>
17457 </refsynopsisdiv>
17458
17459 <refsection><info><title>Description</title></info>
17460
17461 <para>This location has precedence over the corresponding Java property.</para>
17462
17463 <para>Please note that usually you have to specify location as URL not
17464 just as a simple path on the local
17465 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
17466
17467
17468
17469 </refsection>
17470 </refentry>
17471
17472 <refentry version="5.0" id="highlight.default.language">
17473 <refmeta>
17474 <refentrytitle>highlight.default.language</refentrytitle>
17475 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17476 </refmeta>
17477 <refnamediv>
17478 <refname>highlight.default.language</refname>
17479 <refpurpose>Default language of programlisting</refpurpose>
17480 </refnamediv>
17481
17482 <refsynopsisdiv>
17483 <programlisting id="highlight.default.language.frag">
17484 &lt;xsl:param name="highlight.default.language"&gt;&lt;/xsl:param&gt;
17485 </programlisting>
17486 </refsynopsisdiv>
17487
17488 <refsection><info><title>Description</title></info>
17489
17490 <para>This language is used when there is no language attribute on programlisting.</para>
17491
17492 </refsection>
17493 </refentry>
17494
17495 <refentry version="5.0" id="email.delimiters.enabled">
17496 <refmeta>
17497 <refentrytitle>email.delimiters.enabled</refentrytitle>
17498 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17499 </refmeta>
17500 <refnamediv>
17501 <refname>email.delimiters.enabled</refname>
17502 <refpurpose>Generate delimiters around email addresses?</refpurpose>
17503 </refnamediv>
17504
17505 <refsynopsisdiv>
17506 <programlisting id="email.delimiters.enabled.frag">
17507 &lt;xsl:param name="email.delimiters.enabled" select="1"&gt;&lt;/xsl:param&gt;
17508 </programlisting>
17509 </refsynopsisdiv>
17510
17511 <refsection><info><title>Description</title></info>
17512
17513 <para>If non-zero, delimiters
17514
17515 <footnote><para>For delimiters, the
17516 stylesheets are currently hard-coded to output angle
17517 brackets.</para></footnote> 
17518
17519 are generated around e-mail addresses
17520 (the output of the <tag>email</tag> element).</para>
17521
17522 </refsection>
17523 </refentry>
17524
17525 <refentry version="5.0" id="email.mailto.enabled">
17526 <refmeta>
17527 <refentrytitle>email.mailto.enabled</refentrytitle>
17528 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17529 </refmeta>
17530 <refnamediv>
17531 <refname>email.mailto.enabled</refname>
17532 <refpurpose>Generate mailto: links for email addresses?</refpurpose>
17533 </refnamediv>
17534
17535 <refsynopsisdiv>
17536 <programlisting id="email.mailto.enabled.frag">
17537 &lt;xsl:param name="email.mailto.enabled" select="0"&gt;&lt;/xsl:param&gt;
17538 </programlisting>
17539 </refsynopsisdiv>
17540
17541 <refsection><info><title>Description</title></info>
17542
17543 <para>If non-zero the generated output for the <tag>email</tag> element
17544 will be a clickable mailto: link that brings up the default mail client
17545 on the system.</para>
17546
17547 </refsection>
17548 </refentry>
17549
17550 <refentry version="5.0" id="section.container.element">
17551 <refmeta>
17552 <refentrytitle>section.container.element</refentrytitle>
17553 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17554 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
17555 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
17556 </refmeta>
17557 <refnamediv>
17558 <refname>section.container.element</refname>
17559 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
17560 </refnamediv>
17561
17562 <refsynopsisdiv>
17563 <programlisting id="section.container.element.frag">
17564 &lt;xsl:param name="section.container.element"&gt;block&lt;/xsl:param&gt;
17565 </programlisting>
17566 </refsynopsisdiv>
17567
17568 <refsection><info><title>Description</title></info>
17569
17570 <para>Selects the element name for outer container of
17571 each section. The choices are <literal>block</literal> (default)
17572 or <literal>wrapper</literal>.
17573 The <literal>fo:</literal> namespace prefix is added
17574 by the stylesheet to form the full element name.
17575 </para>
17576
17577 <para>This element receives the section <literal>id</literal>
17578 attribute and the appropriate section level attribute-set.
17579 </para>
17580
17581 <para>Changing this parameter to <literal>wrapper</literal>
17582 is only necessary when producing multi-column output
17583 that contains page-wide spans.  Using <literal>fo:wrapper</literal>
17584 avoids the nesting of <literal>fo:block</literal>
17585 elements that prevents spans from working (the standard says
17586 a span must be on a block that is a direct child of 
17587 <literal>fo:flow</literal>).
17588 </para>
17589
17590 <para>If set to <literal>wrapper</literal>, the
17591 section attribute-sets only support properties
17592 that are inheritable.  That's because there is no
17593 block to apply them to.  Properties such as
17594 font-family are inheritable, but properties such as
17595 border are not.
17596 </para>
17597
17598 <para>Only some XSL-FO processors need to use this parameter.
17599 The Antenna House processor, for example, will handle 
17600 spans in nested blocks without changing the element name.
17601 The RenderX XEP product and FOP follow the XSL-FO standard 
17602 and need to use <literal>wrapper</literal>.
17603 </para>
17604
17605 </refsection>
17606 </refentry>
17607
17608 <refentry version="5.0" id="monospace.verbatim.font.width">
17609 <refmeta>
17610 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
17611 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17612 </refmeta>
17613 <refnamediv>
17614 <refname>monospace.verbatim.font.width</refname>
17615 <refpurpose>Width of a single monospace font character</refpurpose>
17616 </refnamediv>
17617
17618 <refsynopsisdiv>
17619 <programlisting id="monospace.verbatim.font.width.frag">
17620 &lt;xsl:param name="monospace.verbatim.font.width"&gt;0.60em&lt;/xsl:param&gt;
17621 </programlisting>
17622 </refsynopsisdiv>
17623
17624 <refsection><info><title>Description</title></info>
17625
17626 <para>Specifies with em units the width of a single character
17627 of the monospace font. The default value is <literal>0.6em</literal>.</para>
17628
17629 <para>This parameter is only used when a <tag>screen</tag>
17630 or <tag>programlisting</tag> element has a 
17631 <tag class="attribute">width</tag> attribute, which is
17632 expressed as a plain integer to indicate the maximum character count
17633 of each line.
17634 To convert this character count to an actual maximum width
17635 measurement, the width of the font characters must be provided.
17636 Different monospace fonts have different character width,
17637 so this parameter should be adjusted to fit the 
17638 monospace font being used.
17639 </para>
17640
17641 </refsection>
17642 </refentry>
17643
17644 <refentry version="5.0" id="exsl.node.set.available">
17645 <refmeta>
17646 <refentrytitle>exsl.node.set.available</refentrytitle>
17647 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17648 </refmeta>
17649 <refnamediv>
17650 <refname>exsl.node.set.available</refname>
17651 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
17652 </refnamediv>
17653
17654 <refsynopsisdiv>
17655 <programlisting id="exsl.node.set.available.frag">&lt;xsl:param name="exsl.node.set.available"&gt; 
17656   &lt;xsl:choose&gt;
17657     &lt;xsl:when exsl:foo="" test="function-available('exsl:node-set') or                        contains(system-property('xsl:vendor'),                          'Apache Software Foundation')"&gt;1&lt;/xsl:when&gt;
17658     &lt;xsl:otherwise&gt;0&lt;/xsl:otherwise&gt;
17659   &lt;/xsl:choose&gt;
17660 &lt;/xsl:param&gt;
17661 </programlisting>
17662 </refsynopsisdiv>
17663
17664 <refsection><info><title>Description</title></info>
17665
17666 <para>If non-zero,
17667 then the exsl:node-set() function is available to be used in
17668 the stylesheet.
17669 If zero, then the function is not available.
17670 This param automatically detects the presence of
17671 the function and does not normally need to be set manually.</para>
17672
17673 <para>This param was created to handle a long-standing
17674 bug in the Xalan processor that fails to detect the
17675 function even though it is available.</para>
17676
17677 </refsection>
17678 </refentry>
17679
17680 <refentry version="5.0" id="bookmarks.collapse">
17681 <refmeta>
17682 <refentrytitle>bookmarks.collapse</refentrytitle>
17683 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> 
17684 </refmeta>
17685 <refnamediv>
17686 <refname>bookmarks.collapse</refname>
17687 <refpurpose>Specifies the initial state of bookmarks</refpurpose>
17688 </refnamediv>
17689
17690 <refsynopsisdiv>
17691 <programlisting id="bookmarks.collapse.frag">
17692 &lt;xsl:param name="bookmarks.collapse" select="1"&gt;&lt;/xsl:param&gt;
17693 </programlisting>
17694 </refsynopsisdiv>
17695
17696 <refsection><info><title>Description</title></info>
17697
17698 <para>If non-zero, the bookmark tree is collapsed so that only the 
17699 top-level bookmarks are displayed initially. Otherwise, the whole tree 
17700 of bookmarks is displayed.</para>
17701
17702 <para>This parameter currently works with FOP 0.93 or later.</para>
17703
17704 </refsection>
17705 </refentry>
17706
17707 </reference><reference id="graphics" xml:base="../fo/param.xml"><title>Graphics</title>
17708 <refentry version="5.0" id="graphic.default.extension">
17709 <refmeta>
17710 <refentrytitle>graphic.default.extension</refentrytitle>
17711 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17712 </refmeta>
17713 <refnamediv>
17714 <refname>graphic.default.extension</refname>
17715 <refpurpose>Default extension for graphic filenames</refpurpose>
17716 </refnamediv>
17717
17718 <refsynopsisdiv>
17719 <programlisting id="graphic.default.extension.frag">&lt;xsl:param name="graphic.default.extension"&gt;&lt;/xsl:param&gt;</programlisting>
17720 </refsynopsisdiv>
17721
17722 <refsection><info><title>Description</title></info>
17723
17724 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
17725 includes a reference to a filename that does not include an extension,
17726 and the <tag class="attribute">format</tag> attribute is
17727 <emphasis>unspecified</emphasis>, the default extension will be used.
17728 </para>
17729
17730 </refsection>
17731 </refentry>
17732
17733 <refentry version="5.0" id="default.image.width">
17734 <refmeta>
17735 <refentrytitle>default.image.width</refentrytitle>
17736 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17737 </refmeta>
17738 <refnamediv>
17739 <refname>default.image.width</refname>
17740 <refpurpose>The default width of images</refpurpose>
17741 </refnamediv>
17742
17743 <refsynopsisdiv>
17744 <programlisting id="default.image.width.frag">
17745 &lt;xsl:param name="default.image.width"&gt;&lt;/xsl:param&gt;
17746 </programlisting>
17747 </refsynopsisdiv>
17748
17749 <refsection><info><title>Description</title></info>
17750
17751 <para>If specified, this value will be used for the
17752 <tag class="attribute">width</tag> attribute on images that do not specify any 
17753 <emphasis xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
17754
17755 </refsection>
17756 </refentry>
17757
17758 <refentry version="5.0" id="preferred.mediaobject.role">
17759 <refmeta>
17760 <refentrytitle>preferred.mediaobject.role</refentrytitle>
17761 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17762 </refmeta>
17763 <refnamediv>
17764 <refname>preferred.mediaobject.role</refname>
17765 <refpurpose>Select which mediaobject to use based on
17766 this value of an object's <tag class="attribute">role</tag> attribute.
17767 </refpurpose>
17768 </refnamediv>
17769
17770 <refsynopsisdiv>
17771 <programlisting id="preferred.mediaobject.role.frag">
17772 &lt;xsl:param name="preferred.mediaobject.role"&gt;&lt;/xsl:param&gt;
17773 </programlisting>
17774 </refsynopsisdiv>
17775
17776 <refsection><info><title>Description</title></info>
17777
17778 <para>A mediaobject may contain several objects such as imageobjects.
17779 If the parameter <parameter>use.role.for.mediaobject</parameter> is
17780 non-zero, then the <literal>role</literal> attribute on
17781 <tag>imageobject</tag>s and other objects within a
17782 <tag>mediaobject</tag> container will be used to select which object
17783 will be used.  If one of the objects has a role value that matches the
17784 <parameter>preferred.mediaobject.role</parameter> parameter, then it
17785 has first priority for selection.  If more than one has such a role
17786 value, the first one is used.
17787 </para>
17788 <para>
17789 See the <parameter>use.role.for.mediaobject</parameter> parameter
17790 for the sequence of selection.</para>
17791 </refsection>
17792 </refentry>
17793
17794 <refentry version="5.0" id="use.role.for.mediaobject">
17795 <refmeta>
17796 <refentrytitle>use.role.for.mediaobject</refentrytitle>
17797 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17798 </refmeta>
17799 <refnamediv>
17800 <refname>use.role.for.mediaobject</refname>
17801 <refpurpose>Use <tag class="attribute">role</tag> attribute 
17802 value for selecting which of several objects within a mediaobject to use.
17803 </refpurpose>
17804 </refnamediv>
17805
17806 <refsynopsisdiv>
17807 <programlisting id="use.role.for.mediaobject.frag">
17808 &lt;xsl:param name="use.role.for.mediaobject" select="1"&gt;&lt;/xsl:param&gt;
17809 </programlisting>
17810 </refsynopsisdiv>
17811
17812 <refsection><info><title>Description</title></info>
17813
17814 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
17815 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
17816 used.
17817 </para>
17818 <para>
17819 The order of selection when then parameter is non-zero is:
17820 </para>
17821 <orderedlist>
17822 <listitem>
17823     <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
17824 </listitem>
17825 <listitem>
17826 <para>Else if an object's role attribute has a value of
17827 <literal>html</literal> for HTML processing or
17828 <literal>fo</literal> for FO output, then the first
17829 of such objects is selected.
17830 </para>
17831 </listitem>
17832 <listitem>
17833 <para>Else the first suitable object is selected.</para>
17834 </listitem>
17835 </orderedlist>
17836 <para>
17837 If the value of 
17838 <parameter>use.role.for.mediaobject</parameter>
17839 is zero, then role attributes are not considered
17840 and the first suitable object
17841 with or without a role value is used.
17842 </para>
17843 </refsection>
17844 </refentry>
17845
17846 <refentry version="5.0" id="ignore.image.scaling">
17847 <refmeta>
17848 <refentrytitle>ignore.image.scaling</refentrytitle>
17849 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17850 </refmeta>
17851 <refnamediv>
17852 <refname>ignore.image.scaling</refname>
17853 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
17854 </refnamediv>
17855
17856 <refsynopsisdiv>
17857 <programlisting id="ignore.image.scaling.frag">
17858 &lt;xsl:param name="ignore.image.scaling" select="0"&gt;&lt;/xsl:param&gt;
17859 </programlisting>
17860 </refsynopsisdiv>
17861
17862 <refsection><info><title>Description</title></info>
17863
17864 <para>If non-zero, the scaling attributes on graphics and media objects are
17865 ignored.</para>
17866
17867 </refsection>
17868 </refentry>
17869
17870 <refentry version="5.0" id="img.src.path">
17871 <refmeta>
17872 <refentrytitle>img.src.path</refentrytitle>
17873 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17874 </refmeta>
17875 <refnamediv>
17876 <refname>img.src.path</refname>
17877 <refpurpose>Path to HTML/FO image files</refpurpose>
17878 </refnamediv>
17879
17880 <refsynopsisdiv>
17881 <programlisting id="img.src.path.frag">&lt;xsl:param name="img.src.path"&gt;&lt;/xsl:param&gt;</programlisting>
17882 </refsynopsisdiv>
17883
17884 <refsection><info><title>Description</title></info>
17885
17886 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag> 
17887 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting 
17888 compound path is used in the output as the value of the <tag class="attribute">src</tag> 
17889 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
17890 </para>
17891
17892 <para>
17893 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
17894 files are created, or it could be an absolute URI.
17895 The default value is empty.
17896 Be sure to include a trailing slash if needed.
17897 </para>
17898
17899 <para>This prefix is not applied to any filerefs that start
17900 with "/" or contain "//:".
17901 </para>
17902
17903 </refsection>
17904 </refentry>
17905
17906 <refentry version="5.0" id="keep.relative.image.uris">
17907 <refmeta>
17908 <refentrytitle>keep.relative.image.uris</refentrytitle>
17909 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17910 </refmeta>
17911 <refnamediv>
17912 <refname>keep.relative.image.uris</refname>
17913 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
17914 </refnamediv>
17915
17916 <refsynopsisdiv>
17917 <programlisting id="keep.relative.image.uris.frag">
17918
17919 &lt;xsl:param name="keep.relative.image.uris" select="0"&gt;&lt;/xsl:param&gt;
17920 </programlisting>
17921 </refsynopsisdiv>
17922
17923 <refsection><info><title>Description</title></info>
17924
17925 <para>If non-zero, relative URIs (in, for example
17926 <literal>fileref</literal> attributes) will be used in the generated
17927 output. Otherwise, the URIs will be made absolute with respect to the
17928 base URI.</para>
17929
17930 <para>Note that the stylesheets calculate (and use) the absolute form
17931 for some purposes, this only applies to the resulting output.</para>
17932
17933 </refsection>
17934 </refentry>
17935
17936 </reference><reference id="general" xml:base="../fo/param.xml"><title>Pagination and General Styles</title>
17937 <partintro id="margins_partintro">
17938 <section id="margins_intro"><title>Understanding XSL FO Margins</title>
17939
17940 <para>To make sense of the parameters in this section, it's useful to
17941 consider <xref linkend="fig.pagemodel"/>.</para>
17942
17943 <figure id="fig.pagemodel">
17944   <title>Page Model</title>
17945   <mediaobject id="fo-pageregions-image">
17946     <imageobject role="html">
17947       <imagedata fileref="page.png"/>
17948     </imageobject>
17949     <imageobject role="fo">
17950       <imagedata fileref="fo/page.png"/>
17951     </imageobject>
17952     <textobject><phrase>Figure showing page margins</phrase></textobject>
17953     <textobject>
17954       <para>This figure shows the physical page with the various FO page regions
17955       identified.</para>
17956     </textobject>
17957   </mediaobject>
17958 </figure>
17959
17960 <para>First, let's consider the regions on the page.</para>
17961
17962 <para>The white region is the physical page. Its dimensions are determined by
17963 the <parameter>page.height</parameter> and <parameter>page.width</parameter>
17964 parameters.</para>
17965
17966 <para>The yellow region is the region-body. The size and placement of
17967 the region body is constrained by the dimensions labelled in the
17968 figure.</para>
17969
17970 <para>The pink region at the top of the page is the region-before. The
17971 darker area inside the region-before is the header text. In XSL, the default
17972 display alignment for a region is <literal>before</literal>, but the
17973 DocBook stylesheets still explicitly make it <literal>before</literal>. That's
17974 why the darker area is at the top.</para>
17975
17976 <para>The pink region at the bottom of the page is the region-after.
17977 The darker area is the footer text. In XSL, the default display
17978 alignment for a region is <literal>before</literal>,
17979 but the DocBook stylesheets explicitly make it
17980 <literal>after</literal>. That's why the darker area is at the bottom.</para>
17981
17982 <para>The dimensions in the figure are:</para>
17983
17984 <orderedlist numeration="upperalpha">
17985 <listitem><para>The page-master margin-top.
17986 </para></listitem>
17987 <listitem><para>The region-before extent.
17988 </para></listitem>
17989 <listitem><para>The region-body margin-top.
17990 </para></listitem>
17991 <listitem><para>The region-after extent.
17992 </para></listitem>
17993 <listitem><para>The page-master margin-bottom.
17994 </para></listitem>
17995 <listitem><para>The region-body margin-bottom.
17996 </para></listitem>
17997 <listitem><para>The sum of the page-master margin-left and the
17998 region-body margin-left. In DocBook, the region-body margin-left is
17999 zero by default, so this is simply the page-master margin-left.
18000 </para></listitem>
18001 <listitem><para>The sum of the page-master margin-right and the
18002 region-body margin-right. In DocBook, the region-body margin-right is
18003 zero by default, so this is simply the page-master margin-right.
18004 </para></listitem>
18005 </orderedlist>
18006
18007 </section>
18008 </partintro>
18009
18010 <refentry version="5.0" id="page.height">
18011 <refmeta>
18012 <refentrytitle>page.height</refentrytitle>
18013 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18014 </refmeta>
18015 <refnamediv>
18016 <refname>page.height</refname>
18017 <refpurpose>The height of the physical page</refpurpose>
18018 </refnamediv>
18019
18020 <refsynopsisdiv>
18021 <programlisting id="page.height.frag">&lt;xsl:param name="page.height"&gt;
18022   &lt;xsl:choose&gt;
18023     &lt;xsl:when test="$page.orientation = 'portrait'"&gt;
18024       &lt;xsl:value-of select="$page.height.portrait"&gt;&lt;/xsl:value-of&gt;
18025     &lt;/xsl:when&gt;
18026     &lt;xsl:otherwise&gt;
18027       &lt;xsl:value-of select="$page.width.portrait"&gt;&lt;/xsl:value-of&gt;
18028     &lt;/xsl:otherwise&gt;
18029   &lt;/xsl:choose&gt;
18030 &lt;/xsl:param&gt;</programlisting>
18031 </refsynopsisdiv>
18032
18033 <refsection><info><title>Description</title></info>
18034
18035 <para>The page height is generally calculated from the
18036 <parameter>paper.type</parameter> and
18037 <parameter>page.orientation</parameter> parameters.
18038 </para>
18039
18040 </refsection>
18041 </refentry>
18042
18043 <refentry version="5.0" id="page.height.portrait">
18044 <refmeta>
18045 <refentrytitle>page.height.portrait</refentrytitle>
18046 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18047 </refmeta>
18048 <refnamediv>
18049 <refname>page.height.portrait</refname>
18050 <refpurpose>Specify the physical size of the long edge of the page</refpurpose>
18051 </refnamediv>
18052
18053 <refsynopsisdiv>
18054 <programlisting id="page.height.portrait.frag">&lt;xsl:param name="page.height.portrait"&gt;
18055   &lt;xsl:choose&gt;
18056     &lt;xsl:when test="$paper.type = 'A4landscape'"&gt;210mm&lt;/xsl:when&gt;
18057     &lt;xsl:when test="$paper.type = 'USletter'"&gt;11in&lt;/xsl:when&gt;
18058     &lt;xsl:when test="$paper.type = 'USlandscape'"&gt;8.5in&lt;/xsl:when&gt;
18059     &lt;xsl:when test="$paper.type = '4A0'"&gt;2378mm&lt;/xsl:when&gt;
18060     &lt;xsl:when test="$paper.type = '2A0'"&gt;1682mm&lt;/xsl:when&gt;
18061     &lt;xsl:when test="$paper.type = 'A0'"&gt;1189mm&lt;/xsl:when&gt;
18062     &lt;xsl:when test="$paper.type = 'A1'"&gt;841mm&lt;/xsl:when&gt;
18063     &lt;xsl:when test="$paper.type = 'A2'"&gt;594mm&lt;/xsl:when&gt;
18064     &lt;xsl:when test="$paper.type = 'A3'"&gt;420mm&lt;/xsl:when&gt;
18065     &lt;xsl:when test="$paper.type = 'A4'"&gt;297mm&lt;/xsl:when&gt;
18066     &lt;xsl:when test="$paper.type = 'A5'"&gt;210mm&lt;/xsl:when&gt;
18067     &lt;xsl:when test="$paper.type = 'A6'"&gt;148mm&lt;/xsl:when&gt;
18068     &lt;xsl:when test="$paper.type = 'A7'"&gt;105mm&lt;/xsl:when&gt;
18069     &lt;xsl:when test="$paper.type = 'A8'"&gt;74mm&lt;/xsl:when&gt;
18070     &lt;xsl:when test="$paper.type = 'A9'"&gt;52mm&lt;/xsl:when&gt;
18071     &lt;xsl:when test="$paper.type = 'A10'"&gt;37mm&lt;/xsl:when&gt;
18072     &lt;xsl:when test="$paper.type = 'B0'"&gt;1414mm&lt;/xsl:when&gt;
18073     &lt;xsl:when test="$paper.type = 'B1'"&gt;1000mm&lt;/xsl:when&gt;
18074     &lt;xsl:when test="$paper.type = 'B2'"&gt;707mm&lt;/xsl:when&gt;
18075     &lt;xsl:when test="$paper.type = 'B3'"&gt;500mm&lt;/xsl:when&gt;
18076     &lt;xsl:when test="$paper.type = 'B4'"&gt;353mm&lt;/xsl:when&gt;
18077     &lt;xsl:when test="$paper.type = 'B5'"&gt;250mm&lt;/xsl:when&gt;
18078     &lt;xsl:when test="$paper.type = 'B6'"&gt;176mm&lt;/xsl:when&gt;
18079     &lt;xsl:when test="$paper.type = 'B7'"&gt;125mm&lt;/xsl:when&gt;
18080     &lt;xsl:when test="$paper.type = 'B8'"&gt;88mm&lt;/xsl:when&gt;
18081     &lt;xsl:when test="$paper.type = 'B9'"&gt;62mm&lt;/xsl:when&gt;
18082     &lt;xsl:when test="$paper.type = 'B10'"&gt;44mm&lt;/xsl:when&gt;
18083     &lt;xsl:when test="$paper.type = 'C0'"&gt;1297mm&lt;/xsl:when&gt;
18084     &lt;xsl:when test="$paper.type = 'C1'"&gt;917mm&lt;/xsl:when&gt;
18085     &lt;xsl:when test="$paper.type = 'C2'"&gt;648mm&lt;/xsl:when&gt;
18086     &lt;xsl:when test="$paper.type = 'C3'"&gt;458mm&lt;/xsl:when&gt;
18087     &lt;xsl:when test="$paper.type = 'C4'"&gt;324mm&lt;/xsl:when&gt;
18088     &lt;xsl:when test="$paper.type = 'C5'"&gt;229mm&lt;/xsl:when&gt;
18089     &lt;xsl:when test="$paper.type = 'C6'"&gt;162mm&lt;/xsl:when&gt;
18090     &lt;xsl:when test="$paper.type = 'C7'"&gt;114mm&lt;/xsl:when&gt;
18091     &lt;xsl:when test="$paper.type = 'C8'"&gt;81mm&lt;/xsl:when&gt;
18092     &lt;xsl:when test="$paper.type = 'C9'"&gt;57mm&lt;/xsl:when&gt;
18093     &lt;xsl:when test="$paper.type = 'C10'"&gt;40mm&lt;/xsl:when&gt;
18094     &lt;xsl:otherwise&gt;11in&lt;/xsl:otherwise&gt;
18095   &lt;/xsl:choose&gt;
18096 &lt;/xsl:param&gt;</programlisting>
18097 </refsynopsisdiv>
18098
18099 <refsection><info><title>Description</title></info>
18100
18101 <para>The portrait page height is the length of the long
18102 edge of the physical page.
18103 </para>
18104
18105 </refsection>
18106 </refentry>
18107
18108 <refentry version="5.0" id="page.margin.bottom">
18109 <refmeta>
18110 <refentrytitle>page.margin.bottom</refentrytitle>
18111 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18112 </refmeta>
18113 <refnamediv>
18114 <refname>page.margin.bottom</refname>
18115 <refpurpose>The bottom margin of the page</refpurpose>
18116 </refnamediv>
18117
18118 <refsynopsisdiv>
18119 <programlisting id="page.margin.bottom.frag">
18120 &lt;xsl:param name="page.margin.bottom"&gt;0.5in&lt;/xsl:param&gt;
18121 </programlisting>
18122 </refsynopsisdiv>
18123
18124 <refsection><info><title>Description</title></info>
18125
18126 <para>The bottom page margin is the distance from the bottom of the region-after
18127 to the physical bottom of the page.
18128 </para>
18129
18130 </refsection>
18131 </refentry>
18132
18133 <refentry version="5.0" id="page.margin.inner">
18134 <refmeta>
18135 <refentrytitle>page.margin.inner</refentrytitle>
18136 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18137 </refmeta>
18138 <refnamediv>
18139 <refname>page.margin.inner</refname>
18140 <refpurpose>The inner page margin</refpurpose>
18141 </refnamediv>
18142
18143 <refsynopsisdiv>
18144 <programlisting id="page.margin.inner.frag">&lt;xsl:param name="page.margin.inner"&gt;
18145   &lt;xsl:choose&gt;
18146     &lt;xsl:when test="$double.sided != 0"&gt;1.25in&lt;/xsl:when&gt;
18147     &lt;xsl:otherwise&gt;1in&lt;/xsl:otherwise&gt;
18148   &lt;/xsl:choose&gt;
18149 &lt;/xsl:param&gt;</programlisting>
18150 </refsynopsisdiv>
18151
18152 <refsection><info><title>Description</title></info>
18153
18154 <para>The inner page margin is the distance from bound edge of the
18155 page to the first column of text. </para>
18156
18157 <para>The inner page margin is the distance from bound edge of the
18158 page to the outer edge of the first column of text.</para>
18159
18160 <para>In left-to-right text direction,
18161 this is the left margin of recto (front side) pages.
18162 For single-sided output, it is the left margin
18163 of all pages.</para>
18164
18165 <para>In right-to-left text direction,
18166 this is the right margin of recto pages.
18167 For single-sided output, this is the
18168 right margin of all pages.</para>
18169
18170 <note>
18171 <para>Current versions (at least as of version 4.13)
18172 of the XEP XSL-FO processor do not
18173 correctly handle these margin settings for documents
18174 with right-to-left text direction.
18175 The workaround in that situation is to reverse
18176 the values for <parameter>page.margin.inner</parameter>
18177 and <parameter>page.margin.outer</parameter>, until
18178 this bug is fixed by RenderX.  It does not affect documents
18179 with left-to-right text direction.</para>
18180 </note>
18181
18182 </refsection>
18183 </refentry>
18184
18185 <refentry version="5.0" id="page.margin.outer">
18186 <refmeta>
18187 <refentrytitle>page.margin.outer</refentrytitle>
18188 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18189 </refmeta>
18190 <refnamediv>
18191 <refname>page.margin.outer</refname>
18192 <refpurpose>The outer page margin</refpurpose>
18193 </refnamediv>
18194
18195 <refsynopsisdiv>
18196 <programlisting id="page.margin.outer.frag">&lt;xsl:param name="page.margin.outer"&gt;
18197   &lt;xsl:choose&gt;
18198     &lt;xsl:when test="$double.sided != 0"&gt;0.75in&lt;/xsl:when&gt;
18199     &lt;xsl:otherwise&gt;1in&lt;/xsl:otherwise&gt;
18200   &lt;/xsl:choose&gt;
18201 &lt;/xsl:param&gt;</programlisting>
18202 </refsynopsisdiv>
18203
18204 <refsection><info><title>Description</title></info>
18205
18206 <para>The outer page margin is the distance from non-bound edge of the
18207 page to the outer edge of the last column of text.</para>
18208
18209 <para>In left-to-right text direction,
18210 this is the right margin of recto (front side) pages.
18211 For single-sided output, it is the right margin
18212 of all pages.</para>
18213
18214 <para>In right-to-left text direction,
18215 this is the left margin of recto pages.
18216 For single-sided output, this is the
18217 left margin of all pages.</para>
18218
18219 <note>
18220 <para>Current versions (at least as of version 4.13)
18221 of the XEP XSL-FO processor do not
18222 correctly handle these margin settings for documents
18223 with right-to-left text direction.
18224 The workaround in that situation is to reverse
18225 the values for <parameter>page.margin.inner</parameter>
18226 and <parameter>page.margin.outer</parameter>, until
18227 this bug is fixed by RenderX.  It does not affect documents
18228 with left-to-right text direction.</para>
18229 </note>
18230
18231 </refsection>
18232 </refentry>
18233
18234 <refentry version="5.0" id="page.margin.top">
18235 <refmeta>
18236 <refentrytitle>page.margin.top</refentrytitle>
18237 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18238 </refmeta>
18239 <refnamediv>
18240 <refname>page.margin.top</refname>
18241 <refpurpose>The top margin of the page</refpurpose>
18242 </refnamediv>
18243
18244 <refsynopsisdiv>
18245 <programlisting id="page.margin.top.frag">
18246 &lt;xsl:param name="page.margin.top"&gt;0.5in&lt;/xsl:param&gt;
18247 </programlisting>
18248 </refsynopsisdiv>
18249
18250 <refsection><info><title>Description</title></info>
18251
18252 <para>The top page margin is the distance from the physical top of the
18253 page to the top of the region-before.</para>
18254
18255 </refsection>
18256 </refentry>
18257
18258 <refentry version="5.0" id="page.orientation">
18259 <refmeta>
18260 <refentrytitle>page.orientation</refentrytitle>
18261 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18262 <refmiscinfo class="other" otherclass="value">portrait</refmiscinfo>
18263 <refmiscinfo class="other" otherclass="value">landscape</refmiscinfo>
18264 </refmeta>
18265 <refnamediv>
18266 <refname>page.orientation</refname>
18267 <refpurpose>Select the page orientation</refpurpose>
18268 </refnamediv>
18269
18270 <refsynopsisdiv>
18271 <programlisting id="page.orientation.frag">
18272 &lt;xsl:param name="page.orientation"&gt;portrait&lt;/xsl:param&gt;
18273 </programlisting>
18274 </refsynopsisdiv>
18275
18276 <refsection><info><title>Description</title></info>
18277
18278 <para> Select one from portrait or landscape.
18279 In portrait orientation, the short edge is horizontal; in
18280 landscape orientation, it is vertical.
18281 </para>
18282
18283 </refsection>
18284 </refentry>
18285
18286 <refentry version="5.0" id="page.width">
18287 <refmeta>
18288 <refentrytitle>page.width</refentrytitle>
18289 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18290 </refmeta>
18291 <refnamediv>
18292 <refname>page.width</refname>
18293 <refpurpose>The width of the physical page</refpurpose>
18294 </refnamediv>
18295
18296 <refsynopsisdiv>
18297 <programlisting id="page.width.frag">&lt;xsl:param name="page.width"&gt;
18298   &lt;xsl:choose&gt;
18299     &lt;xsl:when test="$page.orientation = 'portrait'"&gt;
18300       &lt;xsl:value-of select="$page.width.portrait"&gt;&lt;/xsl:value-of&gt;
18301     &lt;/xsl:when&gt;
18302     &lt;xsl:otherwise&gt;
18303       &lt;xsl:value-of select="$page.height.portrait"&gt;&lt;/xsl:value-of&gt;
18304     &lt;/xsl:otherwise&gt;
18305   &lt;/xsl:choose&gt;
18306 &lt;/xsl:param&gt;</programlisting>
18307 </refsynopsisdiv>
18308
18309 <refsection><info><title>Description</title></info>
18310
18311 <para>The page width is generally calculated from the
18312 <parameter>paper.type</parameter> and 
18313 <parameter>page.orientation</parameter> parameters.</para>
18314
18315 </refsection>
18316 </refentry>
18317
18318 <refentry version="5.0" id="page.width.portrait">
18319 <refmeta>
18320 <refentrytitle>page.width.portrait</refentrytitle>
18321 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18322 </refmeta>
18323 <refnamediv>
18324 <refname>page.width.portrait</refname>
18325 <refpurpose>Specify the physical size of the short edge of the page</refpurpose>
18326 </refnamediv>
18327
18328 <refsynopsisdiv>
18329 <programlisting id="page.width.portrait.frag">&lt;xsl:param name="page.width.portrait"&gt;
18330   &lt;xsl:choose&gt;
18331     &lt;xsl:when test="$paper.type = 'USletter'"&gt;8.5in&lt;/xsl:when&gt;
18332     &lt;xsl:when test="$paper.type = '4A0'"&gt;1682mm&lt;/xsl:when&gt;
18333     &lt;xsl:when test="$paper.type = '2A0'"&gt;1189mm&lt;/xsl:when&gt;
18334     &lt;xsl:when test="$paper.type = 'A0'"&gt;841mm&lt;/xsl:when&gt;
18335     &lt;xsl:when test="$paper.type = 'A1'"&gt;594mm&lt;/xsl:when&gt;
18336     &lt;xsl:when test="$paper.type = 'A2'"&gt;420mm&lt;/xsl:when&gt;
18337     &lt;xsl:when test="$paper.type = 'A3'"&gt;297mm&lt;/xsl:when&gt;
18338     &lt;xsl:when test="$paper.type = 'A4'"&gt;210mm&lt;/xsl:when&gt;
18339     &lt;xsl:when test="$paper.type = 'A5'"&gt;148mm&lt;/xsl:when&gt;
18340     &lt;xsl:when test="$paper.type = 'A6'"&gt;105mm&lt;/xsl:when&gt;
18341     &lt;xsl:when test="$paper.type = 'A7'"&gt;74mm&lt;/xsl:when&gt;
18342     &lt;xsl:when test="$paper.type = 'A8'"&gt;52mm&lt;/xsl:when&gt;
18343     &lt;xsl:when test="$paper.type = 'A9'"&gt;37mm&lt;/xsl:when&gt;
18344     &lt;xsl:when test="$paper.type = 'A10'"&gt;26mm&lt;/xsl:when&gt;
18345     &lt;xsl:when test="$paper.type = 'B0'"&gt;1000mm&lt;/xsl:when&gt;
18346     &lt;xsl:when test="$paper.type = 'B1'"&gt;707mm&lt;/xsl:when&gt;
18347     &lt;xsl:when test="$paper.type = 'B2'"&gt;500mm&lt;/xsl:when&gt;
18348     &lt;xsl:when test="$paper.type = 'B3'"&gt;353mm&lt;/xsl:when&gt;
18349     &lt;xsl:when test="$paper.type = 'B4'"&gt;250mm&lt;/xsl:when&gt;
18350     &lt;xsl:when test="$paper.type = 'B5'"&gt;176mm&lt;/xsl:when&gt;
18351     &lt;xsl:when test="$paper.type = 'B6'"&gt;125mm&lt;/xsl:when&gt;
18352     &lt;xsl:when test="$paper.type = 'B7'"&gt;88mm&lt;/xsl:when&gt;
18353     &lt;xsl:when test="$paper.type = 'B8'"&gt;62mm&lt;/xsl:when&gt;
18354     &lt;xsl:when test="$paper.type = 'B9'"&gt;44mm&lt;/xsl:when&gt;
18355     &lt;xsl:when test="$paper.type = 'B10'"&gt;31mm&lt;/xsl:when&gt;
18356     &lt;xsl:when test="$paper.type = 'C0'"&gt;917mm&lt;/xsl:when&gt;
18357     &lt;xsl:when test="$paper.type = 'C1'"&gt;648mm&lt;/xsl:when&gt;
18358     &lt;xsl:when test="$paper.type = 'C2'"&gt;458mm&lt;/xsl:when&gt;
18359     &lt;xsl:when test="$paper.type = 'C3'"&gt;324mm&lt;/xsl:when&gt;
18360     &lt;xsl:when test="$paper.type = 'C4'"&gt;229mm&lt;/xsl:when&gt;
18361     &lt;xsl:when test="$paper.type = 'C5'"&gt;162mm&lt;/xsl:when&gt;
18362     &lt;xsl:when test="$paper.type = 'C6'"&gt;114mm&lt;/xsl:when&gt;
18363     &lt;xsl:when test="$paper.type = 'C7'"&gt;81mm&lt;/xsl:when&gt;
18364     &lt;xsl:when test="$paper.type = 'C8'"&gt;57mm&lt;/xsl:when&gt;
18365     &lt;xsl:when test="$paper.type = 'C9'"&gt;40mm&lt;/xsl:when&gt;
18366     &lt;xsl:when test="$paper.type = 'C10'"&gt;28mm&lt;/xsl:when&gt;
18367     &lt;xsl:otherwise&gt;8.5in&lt;/xsl:otherwise&gt;
18368   &lt;/xsl:choose&gt;
18369 &lt;/xsl:param&gt;</programlisting>
18370 </refsynopsisdiv>
18371
18372 <refsection><info><title>Description</title></info>
18373
18374 <para>The portrait page width is the length of the short
18375 edge of the physical page.
18376 </para>
18377
18378 </refsection>
18379 </refentry>
18380
18381 <refentry version="5.0" id="paper.type">
18382 <refmeta>
18383 <refentrytitle>paper.type</refentrytitle>
18384 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18385 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18386 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18387 <refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo>
18388 <refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo>
18389 <refmiscinfo class="other" otherclass="value">USlegal<alt>8.5inx14in</alt></refmiscinfo>
18390 <refmiscinfo class="other" otherclass="value">USlegallandscape<alt>14inx8.5in</alt></refmiscinfo>
18391 <refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo>
18392 <refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo>
18393 <refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo>
18394 <refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo>
18395 <refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo>
18396 <refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo>
18397 <refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo>
18398 <refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo>
18399 <refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo>
18400 <refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo>
18401 <refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo>
18402 <refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo>
18403 <refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo>
18404 <refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo>
18405 <refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo>
18406 <refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo>
18407 <refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo>
18408 <refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo>
18409 <refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo>
18410 <refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo>
18411 <refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo>
18412 <refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo>
18413 <refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo>
18414 <refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo>
18415 <refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo>
18416 <refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo>
18417 <refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo>
18418 <refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo>
18419 <refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo>
18420 <refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo>
18421 <refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo>
18422 <refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo>
18423 <refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo>
18424 <refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo>
18425 <refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo>
18426 </refmeta>
18427 <refnamediv>
18428 <refname>paper.type</refname>
18429 <refpurpose>Select the paper type</refpurpose>
18430 </refnamediv>
18431
18432 <refsynopsisdiv>
18433 <programlisting id="paper.type.frag">
18434 &lt;xsl:param name="paper.type"&gt;USletter&lt;/xsl:param&gt;
18435 </programlisting>
18436 </refsynopsisdiv>
18437
18438 <refsection><info><title>Description</title></info>
18439
18440 <para>The paper type is a convenient way to specify the paper size.
18441 The list of known paper sizes includes USletter and most of the A,
18442 B, and C sizes. See <parameter>page.width.portrait</parameter>, for example.
18443
18444
18445 </para>
18446
18447 </refsection>
18448 </refentry>
18449
18450 <refentry version="5.0" id="double.sided">
18451 <refmeta>
18452 <refentrytitle>double.sided</refentrytitle>
18453 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18454 </refmeta>
18455 <refnamediv>
18456 <refname>double.sided</refname>
18457 <refpurpose>Is the document to be printed double sided?</refpurpose>
18458 </refnamediv>
18459
18460 <refsynopsisdiv>
18461 <programlisting id="double.sided.frag">
18462 &lt;xsl:param name="double.sided" select="0"&gt;&lt;/xsl:param&gt;
18463 </programlisting>
18464 </refsynopsisdiv>
18465
18466 <refsection><info><title>Description</title></info>
18467
18468 <para>Double-sided documents are printed with a slightly wider margin
18469 on the binding edge of the page.
18470 </para>
18471 <para>FIXME: The current set of parameters does not take writing direction
18472 into account.</para>
18473
18474 </refsection>
18475 </refentry>
18476
18477 <refentry version="5.0" id="body.margin.bottom">
18478 <refmeta>
18479 <refentrytitle>body.margin.bottom</refentrytitle>
18480 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18481 </refmeta>
18482 <refnamediv>
18483 <refname>body.margin.bottom</refname>
18484 <refpurpose>The bottom margin of the body text</refpurpose>
18485 </refnamediv>
18486
18487 <refsynopsisdiv>
18488 <programlisting id="body.margin.bottom.frag">
18489 &lt;xsl:param name="body.margin.bottom"&gt;0.5in&lt;/xsl:param&gt;
18490 </programlisting>
18491 </refsynopsisdiv>
18492
18493 <refsection><info><title>Description</title></info>
18494
18495 <para>The body bottom margin is the distance from the last line of text
18496 in the page body to the bottom of the region-after.
18497 </para>
18498
18499 </refsection>
18500 </refentry>
18501
18502 <refentry version="5.0" id="body.margin.top">
18503 <refmeta>
18504 <refentrytitle>body.margin.top</refentrytitle>
18505 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18506 </refmeta>
18507 <refnamediv>
18508 <refname>body.margin.top</refname>
18509 <refpurpose>To specify the size of the top margin of a page</refpurpose>
18510 </refnamediv>
18511
18512 <refsynopsisdiv>
18513 <programlisting id="body.margin.top.frag">
18514 &lt;xsl:param name="body.margin.top"&gt;0.5in&lt;/xsl:param&gt;
18515 </programlisting>
18516 </refsynopsisdiv>
18517
18518 <refsection><info><title>Description</title></info>
18519
18520 <para>The body top margin is the distance from the top of the
18521 region-before to the first line of text in the page body.</para>
18522
18523 </refsection>
18524 </refentry>
18525
18526 <refentry version="5.0" id="body.start.indent">
18527 <refmeta>
18528 <refentrytitle>body.start.indent</refentrytitle>
18529 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18530 </refmeta>
18531 <refnamediv>
18532 <refname>body.start.indent</refname>
18533 <refpurpose>The start-indent for the body text</refpurpose>
18534 </refnamediv>
18535
18536 <refsynopsisdiv>
18537 <programlisting id="body.start.indent.frag">
18538 &lt;xsl:param name="body.start.indent"&gt;
18539   &lt;xsl:choose&gt;
18540     &lt;xsl:when test="$fop.extensions != 0"&gt;0pt&lt;/xsl:when&gt;
18541     &lt;xsl:when test="$passivetex.extensions != 0"&gt;0pt&lt;/xsl:when&gt;
18542     &lt;xsl:otherwise&gt;4pc&lt;/xsl:otherwise&gt;
18543   &lt;/xsl:choose&gt;
18544 &lt;/xsl:param&gt;
18545 </programlisting>
18546 </refsynopsisdiv>
18547
18548 <refsection><info><title>Description</title></info>
18549
18550 <para>This parameter provides
18551 the means of indenting the body text relative to
18552 section titles.
18553 For left-to-right text direction, it indents the left side.
18554 For right-to-left text direction, it indents the right side.
18555 It is used in place of the 
18556 <parameter>title.margin.left</parameter> for
18557 all XSL-FO processors except FOP 0.25.
18558 It enables support for side floats to appear
18559 in the indented margin area.
18560 </para>
18561 <para>This start-indent property is added to the fo:flow
18562 for certain page sequences.  Which page-sequences it is 
18563 applied to is determined by the template named
18564 <literal>set.flow.properties</literal>.
18565 By default, that template adds it to the flow
18566 for page-sequences using the <quote>body</quote>
18567 master-reference, as well as appendixes and prefaces.
18568 </para>
18569 <para>If this parameter is used, section titles should have
18570 a start-indent value of 0pt if they are to be
18571 outdented relative to the body text.
18572 </para>
18573
18574 <para>If you are using FOP, then set this parameter to a zero
18575 width value and set the <parameter>title.margin.left</parameter>
18576 parameter to the negative value of the desired indent.
18577 </para>
18578
18579 <para>See also <parameter>body.end.indent</parameter> and
18580 <parameter>title.margin.left</parameter>.
18581 </para>
18582
18583 </refsection>
18584 </refentry>
18585
18586 <refentry version="5.0" id="body.end.indent">
18587 <refmeta>
18588 <refentrytitle>body.end.indent</refentrytitle>
18589 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18590 </refmeta>
18591 <refnamediv>
18592 <refname>body.end.indent</refname>
18593 <refpurpose>The end-indent for the body text</refpurpose>
18594 </refnamediv>
18595
18596 <refsynopsisdiv>
18597 <programlisting id="body.end.indent.frag">
18598 &lt;xsl:param name="body.end.indent"&gt;0pt&lt;/xsl:param&gt;
18599 </programlisting>
18600 </refsynopsisdiv>
18601
18602 <refsection><info><title>Description</title></info>
18603
18604 <para>This end-indent property is added to the fo:flow
18605 for certain page sequences.  Which page-sequences it is 
18606 applied to is determined by the template named
18607 <literal>set.flow.properties</literal>.
18608 By default, that template adds it to the flow
18609 for page-sequences using the <quote>body</quote>
18610 master-reference, as well as appendixes and prefaces.
18611 </para>
18612
18613 <para>See also <parameter>body.start.indent</parameter>.
18614 </para>
18615
18616 </refsection>
18617 </refentry>
18618
18619 <refentry version="5.0" id="alignment">
18620 <refmeta>
18621 <refentrytitle>alignment</refentrytitle>
18622   <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18623   <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18624   <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
18625   <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
18626   <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
18627   <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
18628   <refmiscinfo class="other" otherclass="value">center</refmiscinfo>
18629   <refmiscinfo class="other" otherclass="value">justify</refmiscinfo>
18630 </refmeta>
18631 <refnamediv>
18632 <refname>alignment</refname>
18633 <refpurpose>Specify the default text alignment</refpurpose>
18634 </refnamediv>
18635
18636 <refsynopsisdiv>
18637 <programlisting id="alignment.frag">&lt;xsl:param name="alignment"&gt;justify&lt;/xsl:param&gt;</programlisting>
18638 </refsynopsisdiv>
18639
18640 <refsection><info><title>Description</title></info>
18641
18642 <para>The default text alignment is used for most body text.
18643 Allowed values are 
18644 <literal>left</literal>,
18645 <literal>right</literal>,
18646 <literal>start</literal>,
18647 <literal>end</literal>,
18648 <literal>center</literal>,
18649 <literal>justify</literal>.
18650 The default value is <literal>justify</literal>.
18651 </para>
18652
18653 </refsection>
18654 </refentry>
18655
18656 <refentry version="5.0" id="hyphenate">
18657 <refmeta>
18658 <refentrytitle>hyphenate</refentrytitle>
18659 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18660 <refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>
18661 <refmiscinfo class="other" otherclass="value">true</refmiscinfo>
18662 <refmiscinfo class="other" otherclass="value">false</refmiscinfo>
18663 </refmeta>
18664 <refnamediv>
18665 <refname>hyphenate</refname>
18666 <refpurpose>Specify hyphenation behavior</refpurpose>
18667 </refnamediv>
18668
18669 <refsynopsisdiv>
18670 <programlisting id="hyphenate.frag">&lt;xsl:param name="hyphenate"&gt;true&lt;/xsl:param&gt;</programlisting>
18671 </refsynopsisdiv>
18672
18673 <refsection><info><title>Description</title></info>
18674
18675 <para>If true, words may be hyphenated. Otherwise, they may not.
18676 </para>
18677
18678 </refsection>
18679 </refentry>
18680
18681 <refentry version="5.0" id="line-height">
18682 <refmeta>
18683 <refentrytitle>line-height</refentrytitle>
18684 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18685 </refmeta>
18686 <refnamediv>
18687 <refname>line-height</refname>
18688 <refpurpose>Specify the line-height property</refpurpose>
18689 </refnamediv>
18690
18691 <refsynopsisdiv>
18692 <programlisting id="line-height.frag">
18693 &lt;xsl:param name="line-height"&gt;normal&lt;/xsl:param&gt;
18694 </programlisting>
18695 </refsynopsisdiv>
18696
18697 <refsection><info><title>Description</title></info>
18698
18699 <para>Sets the line-height property.</para>
18700
18701 </refsection>
18702 </refentry>
18703
18704 <refentry version="5.0" id="column.count.back">
18705 <refmeta>
18706 <refentrytitle>column.count.back</refentrytitle>
18707 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18708 </refmeta>
18709 <refnamediv>
18710 <refname>column.count.back</refname>
18711 <refpurpose>Number of columns on back matter pages</refpurpose>
18712 </refnamediv>
18713
18714 <refsynopsisdiv>
18715 <programlisting id="column.count.back.frag">
18716 &lt;xsl:param name="column.count.back" select="1"&gt;&lt;/xsl:param&gt;
18717 </programlisting>
18718 </refsynopsisdiv>
18719
18720 <refsection><info><title>Description</title></info>
18721
18722 <para>Number of columns on back matter (appendix, glossary, etc.) pages.</para>
18723
18724 </refsection>
18725 </refentry>
18726
18727 <refentry version="5.0" id="column.count.body">
18728 <refmeta>
18729 <refentrytitle>column.count.body</refentrytitle>
18730 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18731 </refmeta>
18732 <refnamediv>
18733 <refname>column.count.body</refname>
18734 <refpurpose>Number of columns on body pages</refpurpose>
18735 </refnamediv>
18736
18737 <refsynopsisdiv>
18738 <programlisting id="column.count.body.frag">
18739 &lt;xsl:param name="column.count.body" select="1"&gt;&lt;/xsl:param&gt;
18740 </programlisting>
18741 </refsynopsisdiv>
18742
18743 <refsection><info><title>Description</title></info>
18744
18745 <para>Number of columns on body pages.</para>
18746
18747 </refsection>
18748 </refentry>
18749
18750 <refentry version="5.0" id="column.count.front">
18751 <refmeta>
18752 <refentrytitle>column.count.front</refentrytitle>
18753 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18754 </refmeta>
18755 <refnamediv>
18756 <refname>column.count.front</refname>
18757 <refpurpose>Number of columns on front matter pages</refpurpose>
18758 </refnamediv>
18759
18760 <refsynopsisdiv>
18761 <programlisting id="column.count.front.frag">
18762 &lt;xsl:param name="column.count.front" select="1"&gt;&lt;/xsl:param&gt;
18763 </programlisting>
18764 </refsynopsisdiv>
18765
18766 <refsection><info><title>Description</title></info>
18767
18768 <para>Number of columns on front matter (dedication, preface, etc.) pages.</para>
18769
18770 </refsection>
18771 </refentry>
18772
18773 <refentry version="5.0" id="column.count.index">
18774 <refmeta>
18775 <refentrytitle>column.count.index</refentrytitle>
18776 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18777 </refmeta>
18778 <refnamediv>
18779 <refname>column.count.index</refname>
18780 <refpurpose>Number of columns on index pages</refpurpose>
18781 </refnamediv>
18782
18783 <refsynopsisdiv>
18784 <programlisting id="column.count.index.frag">
18785 &lt;xsl:param name="column.count.index"&gt;2&lt;/xsl:param&gt;
18786 </programlisting>
18787 </refsynopsisdiv>
18788
18789 <refsection><info><title>Description</title></info>
18790
18791 <para>Number of columns on index pages.</para>
18792
18793 </refsection>
18794 </refentry>
18795
18796 <refentry version="5.0" id="column.count.lot">
18797 <refmeta>
18798 <refentrytitle>column.count.lot</refentrytitle>
18799 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18800 </refmeta>
18801 <refnamediv>
18802 <refname>column.count.lot</refname>
18803 <refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose>
18804 </refnamediv>
18805
18806 <refsynopsisdiv>
18807 <programlisting id="column.count.lot.frag">
18808 &lt;xsl:param name="column.count.lot" select="1"&gt;&lt;/xsl:param&gt;
18809 </programlisting>
18810 </refsynopsisdiv>
18811
18812 <refsection><info><title>Description</title></info>
18813
18814 <para>Number of columns on a page sequence containing the Table of Contents,
18815 List of Figures, etc.</para>
18816
18817 </refsection>
18818 </refentry>
18819
18820 <refentry version="5.0" id="column.count.titlepage">
18821 <refmeta>
18822 <refentrytitle>column.count.titlepage</refentrytitle>
18823 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18824 </refmeta>
18825 <refnamediv>
18826 <refname>column.count.titlepage</refname>
18827 <refpurpose>Number of columns on a title page</refpurpose>
18828 </refnamediv>
18829
18830 <refsynopsisdiv>
18831 <programlisting id="column.count.titlepage.frag">
18832 &lt;xsl:param name="column.count.titlepage" select="1"&gt;&lt;/xsl:param&gt;
18833 </programlisting>
18834 </refsynopsisdiv>
18835
18836 <refsection><info><title>Description</title></info>
18837
18838 <para>Number of columns on a title page</para>
18839
18840 </refsection>
18841 </refentry>
18842
18843 <refentry version="5.0" id="column.gap.back">
18844 <refmeta>
18845 <refentrytitle>column.gap.back</refentrytitle>
18846 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18847 </refmeta>
18848 <refnamediv>
18849 <refname>column.gap.back</refname>
18850 <refpurpose>Gap between columns in back matter</refpurpose>
18851 </refnamediv>
18852
18853 <refsynopsisdiv>
18854 <programlisting id="column.gap.back.frag">
18855 &lt;xsl:param name="column.gap.back"&gt;12pt&lt;/xsl:param&gt;
18856 </programlisting>
18857 </refsynopsisdiv>
18858
18859 <refsection><info><title>Description</title></info>
18860
18861 <para>Specifies the gap between columns in back matter (if
18862 <parameter>column.count.back</parameter> is greater than one).</para>
18863
18864 </refsection>
18865 </refentry>
18866
18867 <refentry version="5.0" id="column.gap.body">
18868 <refmeta>
18869 <refentrytitle>column.gap.body</refentrytitle>
18870 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18871 </refmeta>
18872 <refnamediv>
18873 <refname>column.gap.body</refname>
18874 <refpurpose>Gap between columns in the body</refpurpose>
18875 </refnamediv>
18876
18877 <refsynopsisdiv>
18878 <programlisting id="column.gap.body.frag">
18879 &lt;xsl:param name="column.gap.body"&gt;12pt&lt;/xsl:param&gt;
18880 </programlisting>
18881 </refsynopsisdiv>
18882
18883 <refsection><info><title>Description</title></info>
18884
18885 <para>Specifies the gap between columns in body matter (if
18886 <parameter>column.count.body</parameter> is greater than one).</para>
18887
18888 </refsection>
18889 </refentry>
18890
18891 <refentry version="5.0" id="column.gap.front">
18892 <refmeta>
18893 <refentrytitle>column.gap.front</refentrytitle>
18894 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18895 </refmeta>
18896 <refnamediv>
18897 <refname>column.gap.front</refname>
18898 <refpurpose>Gap between columns in the front matter</refpurpose>
18899 </refnamediv>
18900
18901 <refsynopsisdiv>
18902 <programlisting id="column.gap.front.frag">
18903 &lt;xsl:param name="column.gap.front"&gt;12pt&lt;/xsl:param&gt;
18904 </programlisting>
18905 </refsynopsisdiv>
18906
18907 <refsection><info><title>Description</title></info>
18908
18909 <para>Specifies the gap between columns in front matter (if
18910 <parameter>column.count.front</parameter> is greater than one).</para>
18911
18912 </refsection>
18913 </refentry>
18914
18915 <refentry version="5.0" id="column.gap.index">
18916 <refmeta>
18917 <refentrytitle>column.gap.index</refentrytitle>
18918 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18919 </refmeta>
18920 <refnamediv>
18921 <refname>column.gap.index</refname>
18922 <refpurpose>Gap between columns in the index</refpurpose>
18923 </refnamediv>
18924
18925 <refsynopsisdiv>
18926 <programlisting id="column.gap.index.frag">
18927 &lt;xsl:param name="column.gap.index"&gt;12pt&lt;/xsl:param&gt;
18928 </programlisting>
18929 </refsynopsisdiv>
18930
18931 <refsection><info><title>Description</title></info>
18932
18933 <para>Specifies the gap between columns in indexes (if
18934 <parameter>column.count.index</parameter> is greater than one).</para>
18935
18936 </refsection>
18937 </refentry>
18938
18939 <refentry version="5.0" id="column.gap.lot">
18940 <refmeta>
18941 <refentrytitle>column.gap.lot</refentrytitle>
18942 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18943 </refmeta>
18944 <refnamediv>
18945 <refname>column.gap.lot</refname>
18946 <refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose>
18947 </refnamediv>
18948
18949 <refsynopsisdiv>
18950 <programlisting id="column.gap.lot.frag">
18951 &lt;xsl:param name="column.gap.lot"&gt;12pt&lt;/xsl:param&gt;
18952 </programlisting>
18953 </refsynopsisdiv>
18954
18955 <refsection><info><title>Description</title></info>
18956
18957 <para>Specifies the gap between columns on 'List-of-Titles' pages (if
18958 <parameter>column.count.lot</parameter> is greater than one).</para>
18959
18960 </refsection>
18961 </refentry>
18962
18963 <refentry version="5.0" id="column.gap.titlepage">
18964 <refmeta>
18965 <refentrytitle>column.gap.titlepage</refentrytitle>
18966 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18967 </refmeta>
18968 <refnamediv>
18969 <refname>column.gap.titlepage</refname>
18970 <refpurpose>Gap between columns on title pages</refpurpose>
18971 </refnamediv>
18972
18973 <refsynopsisdiv>
18974 <programlisting id="column.gap.titlepage.frag">
18975 &lt;xsl:param name="column.gap.titlepage"&gt;12pt&lt;/xsl:param&gt;
18976 </programlisting>
18977 </refsynopsisdiv>
18978
18979 <refsection><info><title>Description</title></info>
18980
18981 <para>Specifies the gap between columns on title pages (if
18982 <parameter>column.count.titlepage</parameter> is greater than one).</para>
18983
18984
18985 </refsection>
18986 </refentry>
18987
18988 <refentry version="5.0" id="region.after.extent">
18989 <refmeta>
18990 <refentrytitle>region.after.extent</refentrytitle>
18991 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18992 </refmeta>
18993 <refnamediv>
18994 <refname>region.after.extent</refname>
18995 <refpurpose>Specifies the height of the footer.</refpurpose>
18996 </refnamediv>
18997
18998 <refsynopsisdiv>
18999 <programlisting id="region.after.extent.frag">
19000 &lt;xsl:param name="region.after.extent"&gt;0.4in&lt;/xsl:param&gt;
19001 </programlisting>
19002 </refsynopsisdiv>
19003
19004 <refsection><info><title>Description</title></info>
19005
19006 <para>The region after extent is the height of the area where footers
19007 are printed.
19008 </para>
19009
19010 </refsection>
19011 </refentry>
19012
19013 <refentry version="5.0" id="region.before.extent">
19014 <refmeta>
19015 <refentrytitle>region.before.extent</refentrytitle>
19016 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19017 </refmeta>
19018 <refnamediv>
19019 <refname>region.before.extent</refname>
19020 <refpurpose>Specifies the height of the header</refpurpose>
19021 </refnamediv>
19022
19023 <refsynopsisdiv>
19024 <programlisting id="region.before.extent.frag">
19025 &lt;xsl:param name="region.before.extent"&gt;0.4in&lt;/xsl:param&gt;
19026 </programlisting>
19027 </refsynopsisdiv>
19028
19029 <refsection><info><title>Description</title></info>
19030
19031 <para>The region before extent is the height of the area where headers
19032 are printed.
19033 </para>
19034
19035 </refsection>
19036 </refentry>
19037
19038 <refentry version="5.0" id="default.units">
19039 <refmeta>
19040 <refentrytitle>default.units</refentrytitle>
19041 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19042 <refmiscinfo class="other" otherclass="value">cm</refmiscinfo>
19043 <refmiscinfo class="other" otherclass="value">mm</refmiscinfo>
19044 <refmiscinfo class="other" otherclass="value">in</refmiscinfo>
19045 <refmiscinfo class="other" otherclass="value">pt</refmiscinfo>
19046 <refmiscinfo class="other" otherclass="value">pc</refmiscinfo>
19047 <refmiscinfo class="other" otherclass="value">px</refmiscinfo>
19048 <refmiscinfo class="other" otherclass="value">em</refmiscinfo>
19049 </refmeta>
19050 <refnamediv>
19051 <refname>default.units</refname>
19052 <refpurpose>Default units for an unqualified dimension</refpurpose>
19053 </refnamediv>
19054
19055 <refsynopsisdiv>
19056 <programlisting id="default.units.frag">
19057 &lt;xsl:param name="default.units"&gt;pt&lt;/xsl:param&gt;
19058 </programlisting>
19059 </refsynopsisdiv>
19060
19061 <refsection><info><title>Description</title></info>
19062
19063 <para>If an unqualified dimension is encountered (for example, in a
19064 graphic width), the <parameter>default.units</parameter> will be used for the
19065 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
19066 </para>
19067
19068 </refsection>
19069 </refentry>
19070
19071 <refentry version="5.0" id="normal.para.spacing">
19072 <refmeta>
19073 <refentrytitle>normal.para.spacing</refentrytitle>
19074 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19075 </refmeta>
19076 <refnamediv>
19077 <refname>normal.para.spacing</refname>
19078 <refpurpose>What space do you want between normal paragraphs</refpurpose>
19079 </refnamediv>
19080
19081 <refsynopsisdiv>
19082 <programlisting id="normal.para.spacing.frag">&lt;xsl:attribute-set name="normal.para.spacing"&gt;
19083   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
19084   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
19085   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
19086 &lt;/xsl:attribute-set&gt;</programlisting>
19087 </refsynopsisdiv>
19088 <refsection><info><title>Description</title></info>
19089 <para>Specify the spacing required between normal paragraphs</para>
19090 </refsection>
19091 </refentry>
19092
19093 <refentry version="5.0" id="body.font.master">
19094 <refmeta>
19095 <refentrytitle>body.font.master</refentrytitle>
19096   <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
19097 </refmeta>
19098 <refnamediv>
19099 <refname>body.font.master</refname>
19100 <refpurpose>Specifies the default point size for body text</refpurpose>
19101 </refnamediv>
19102
19103 <refsynopsisdiv>
19104 <programlisting id="body.font.master.frag">
19105 &lt;xsl:param name="body.font.master"&gt;10&lt;/xsl:param&gt;
19106 </programlisting>
19107 </refsynopsisdiv>
19108
19109 <refsection><info><title>Description</title></info>
19110
19111 <para>The body font size is specified in two parameters
19112 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
19113 so that math can be performed on the font size by XSLT.
19114 </para>
19115
19116 </refsection>
19117 </refentry>
19118
19119 <refentry version="5.0" id="body.font.size">
19120 <refmeta>
19121 <refentrytitle>body.font.size</refentrytitle>
19122 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19123 </refmeta>
19124 <refnamediv>
19125 <refname>body.font.size</refname>
19126 <refpurpose>Specifies the default font size for body text</refpurpose>
19127 </refnamediv>
19128
19129 <refsynopsisdiv>
19130 <programlisting id="body.font.size.frag">
19131 &lt;xsl:param name="body.font.size"&gt;
19132  &lt;xsl:value-of select="$body.font.master"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
19133 &lt;/xsl:param&gt;</programlisting>
19134 </refsynopsisdiv>
19135
19136 <refsection><info><title>Description</title></info>
19137
19138 <para>The body font size is specified in two parameters
19139 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
19140 so that math can be performed on the font size by XSLT.
19141 </para>
19142
19143 </refsection>
19144 </refentry>
19145
19146 <refentry version="5.0" id="footnote.font.size">
19147 <refmeta>
19148 <refentrytitle>footnote.font.size</refentrytitle>
19149 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19150 </refmeta>
19151 <refnamediv>
19152 <refname>footnote.font.size</refname>
19153 <refpurpose>The font size for footnotes</refpurpose>
19154 </refnamediv>
19155
19156 <refsynopsisdiv>
19157 <programlisting id="footnote.font.size.frag">&lt;xsl:param name="footnote.font.size"&gt;
19158  &lt;xsl:value-of select="$body.font.master * 0.8"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
19159 &lt;/xsl:param&gt;</programlisting>
19160 </refsynopsisdiv>
19161
19162 <refsection><info><title>Description</title></info>
19163
19164 <para>The footnote font size is used for...footnotes!
19165 </para>
19166
19167 </refsection>
19168 </refentry>
19169
19170 <refentry version="5.0" id="title.margin.left">
19171 <refmeta>
19172 <refentrytitle>title.margin.left</refentrytitle>
19173 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19174 </refmeta>
19175 <refnamediv>
19176 <refname>title.margin.left</refname>
19177 <refpurpose>Adjust the left margin for titles</refpurpose>
19178 </refnamediv>
19179
19180 <refsynopsisdiv>
19181 <programlisting id="title.margin.left.frag">
19182 &lt;xsl:param name="title.margin.left"&gt;
19183   &lt;xsl:choose&gt;
19184     &lt;xsl:when test="$fop.extensions != 0"&gt;-4pc&lt;/xsl:when&gt;
19185     &lt;xsl:when test="$passivetex.extensions != 0"&gt;0pt&lt;/xsl:when&gt;
19186     &lt;xsl:otherwise&gt;0pt&lt;/xsl:otherwise&gt;
19187   &lt;/xsl:choose&gt;
19188 &lt;/xsl:param&gt;
19189 </programlisting>
19190 </refsynopsisdiv>
19191
19192 <refsection><info><title>Description</title></info>
19193
19194 <para>This parameter provides
19195 the means of adjusting the left margin for titles
19196 when the XSL-FO processor being used is
19197 an old version of FOP (0.25 and earlier).
19198 It is only useful when the <parameter>fop.extensions</parameter>
19199 is nonzero.</para>
19200
19201 <para>The left margin of the body region
19202 is calculated to include this space,
19203 and titles are outdented to the left outside
19204 the body region by this amount,
19205 effectively leaving titles at the intended left margin
19206 and the body text indented.
19207 Currently this method is only used for old FOP because
19208 it cannot properly use the <parameter>body.start.indent</parameter>
19209 parameter.
19210 </para>
19211 <para>
19212 The default value when the <parameter>fop.extensions</parameter>
19213 parameter is nonzero is -4pc, which means the
19214 body text is indented 4 picas relative to
19215 the titles.
19216 The default value when the <parameter>fop.extensions</parameter>
19217 parameter equals zero is 0pt, and
19218 the body indent should instead be specified
19219 using the <parameter>body.start.indent</parameter>
19220 parameter.
19221 </para>
19222 <para>
19223 If you set the value to zero, be sure to still include
19224 a unit indicator such as <literal>0pt</literal>, or
19225 the FO processor will report errors.
19226 </para>
19227
19228 </refsection>
19229 </refentry>
19230
19231 <refentry version="5.0" id="draft.mode">
19232 <refmeta>
19233 <refentrytitle>draft.mode</refentrytitle>
19234 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19235 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> 
19236 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
19237 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
19238 </refmeta>
19239 <refnamediv>
19240 <refname>draft.mode</refname>
19241 <refpurpose>Select draft mode</refpurpose>
19242 </refnamediv>
19243
19244 <refsynopsisdiv>
19245 <programlisting id="draft.mode.frag">
19246 &lt;xsl:param name="draft.mode"&gt;no&lt;/xsl:param&gt;
19247 </programlisting>
19248 </refsynopsisdiv>
19249
19250 <refsection><info><title>Description</title></info>
19251
19252 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
19253 <quote><literal>yes</literal></quote>, the entire document will be treated
19254 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
19255 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
19256 individual sections will be treated as draft or final independently, depending
19257 on how their <literal>status</literal> attribute is set.
19258 </para>
19259
19260 </refsection>
19261 </refentry>
19262
19263 <refentry version="5.0" id="draft.watermark.image">
19264 <refmeta>
19265 <refentrytitle>draft.watermark.image</refentrytitle>
19266 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
19267 </refmeta>
19268 <refnamediv>
19269 <refname>draft.watermark.image</refname>
19270 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
19271 </refnamediv>
19272
19273 <refsynopsisdiv>
19274 <programlisting id="draft.watermark.image.frag">
19275 &lt;xsl:param name="draft.watermark.image"&gt;images/draft.png&lt;/xsl:param&gt;
19276 </programlisting>
19277 </refsynopsisdiv>
19278
19279 <refsection><info><title>Description</title></info>
19280
19281 <para>The image to be used for draft watermarks.</para>
19282
19283 </refsection>
19284 </refentry>
19285
19286 <refentry version="5.0" id="headers.on.blank.pages">
19287 <refmeta>
19288 <refentrytitle>headers.on.blank.pages</refentrytitle>
19289 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19290 </refmeta>
19291 <refnamediv>
19292 <refname>headers.on.blank.pages</refname>
19293 <refpurpose>Put headers on blank pages?</refpurpose>
19294 </refnamediv>
19295
19296 <refsynopsisdiv>
19297 <programlisting id="headers.on.blank.pages.frag">
19298 &lt;xsl:param name="headers.on.blank.pages" select="1"&gt;&lt;/xsl:param&gt;
19299 </programlisting>
19300 </refsynopsisdiv>
19301
19302 <refsection><info><title>Description</title></info>
19303
19304 <para>If non-zero, headers will be placed on blank pages.</para>
19305
19306 </refsection>
19307 </refentry>
19308
19309 <refentry version="5.0" id="footers.on.blank.pages">
19310 <refmeta>
19311 <refentrytitle>footers.on.blank.pages</refentrytitle>
19312 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19313 </refmeta>
19314 <refnamediv>
19315 <refname>footers.on.blank.pages</refname>
19316 <refpurpose>Put footers on blank pages?</refpurpose>
19317 </refnamediv>
19318
19319 <refsynopsisdiv>
19320 <programlisting id="footers.on.blank.pages.frag">
19321 &lt;xsl:param name="footers.on.blank.pages" select="1"&gt;&lt;/xsl:param&gt;
19322 </programlisting>
19323 </refsynopsisdiv>
19324
19325 <refsection><info><title>Description</title></info>
19326
19327 <para>If non-zero, footers will be placed on blank pages.</para>
19328
19329 </refsection>
19330 </refentry>
19331
19332 <refentry version="5.0" id="header.rule">
19333 <refmeta>
19334 <refentrytitle>header.rule</refentrytitle>
19335 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19336 </refmeta>
19337 <refnamediv>
19338 <refname>header.rule</refname>
19339 <refpurpose>Rule under headers?</refpurpose>
19340 </refnamediv>
19341
19342 <refsynopsisdiv>
19343 <programlisting id="header.rule.frag">
19344 &lt;xsl:param name="header.rule" select="1"&gt;&lt;/xsl:param&gt;
19345 </programlisting>
19346 </refsynopsisdiv>
19347
19348 <refsection><info><title>Description</title></info>
19349
19350 <para>If non-zero, a rule will be drawn below the page headers.</para>
19351
19352 </refsection>
19353 </refentry>
19354
19355 <refentry version="5.0" id="footer.rule">
19356 <refmeta>
19357 <refentrytitle>footer.rule</refentrytitle>
19358 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19359 </refmeta>
19360 <refnamediv>
19361 <refname>footer.rule</refname>
19362 <refpurpose>Rule over footers?</refpurpose>
19363 </refnamediv>
19364
19365 <refsynopsisdiv>
19366 <programlisting id="footer.rule.frag">
19367 &lt;xsl:param name="footer.rule" select="1"&gt;&lt;/xsl:param&gt;
19368 </programlisting>
19369 </refsynopsisdiv>
19370
19371 <refsection><info><title>Description</title></info>
19372
19373 <para>If non-zero, a rule will be drawn above the page footers.</para>
19374
19375 </refsection>
19376 </refentry>
19377
19378 <refentry version="5.0" id="header.column.widths">
19379 <refmeta>
19380 <refentrytitle>header.column.widths</refentrytitle>
19381 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19382 </refmeta>
19383 <refnamediv>
19384 <refname>header.column.widths</refname>
19385 <refpurpose>Specify relative widths of header areas</refpurpose>
19386 </refnamediv>
19387
19388 <refsynopsisdiv><programlisting id="header.column.widths.frag">
19389 &lt;xsl:param name="header.column.widths"&gt;1 1 1&lt;/xsl:param&gt;
19390 </programlisting></refsynopsisdiv>
19391
19392 <refsection><info><title>Description</title></info>
19393
19394 <para>Page headers in print output use a three column table
19395 to position text at the left, center, and right side of
19396 the header on the page.
19397 This parameter lets you specify the relative sizes of the
19398 three columns.  The default value is
19399 "1 1 1".</para>
19400
19401 <para>The parameter value must be three numbers, separated
19402 by white space. The first number represents the relative
19403 width of the inside header for
19404 double-sided output.  The second number is the relative
19405 width of the center header.  The third number is the
19406 relative width of the outside header for
19407 double-sided output.
19408 </para>
19409 <para>For single-sided output, the first number is the
19410 relative width of left header for left-to-right
19411 text direction, or the right header for right-to-left
19412 text direction.  
19413 The third number is the
19414 relative width of right header for left-to-right
19415 text direction, or the left header for right-to-left
19416 text direction.</para>
19417
19418 <para>The numbers are used to specify the column widths
19419 for the table that makes up the header area.
19420 In the FO output, this looks like:
19421 </para>
19422
19423 <programlisting>
19424 &lt;fo:table-column column-number="1" 
19425     column-width="proportional-column-width(1)"/&gt;
19426 </programlisting>
19427
19428 <para>
19429 The <literal>proportional-column-width()</literal>
19430 function computes a column width by dividing its
19431 argument by the total of the arguments for all the columns, and
19432 then multiplying the result by the width of the whole table
19433 (assuming all the column specs use the function).
19434 Its argument can be any positive integer or floating point number.
19435 Zero is an acceptable value, although some FO processors
19436 may warn about it, in which case using a very small number might
19437 be more satisfactory.
19438 </para>
19439
19440 <para>For example, the value "1 2 1" means the center
19441 header should have twice the width of the other areas.
19442 A value of "0 0 1" means the entire header area
19443 is reserved for the right (or outside) header text.
19444 Note that to keep the center area centered on
19445 the page, the left and right values must be
19446 the same. A specification like "1 2 3" means the
19447 center area is no longer centered on the page
19448 since the right area is three times the width of the left area.
19449 </para>
19450
19451 </refsection>
19452 </refentry>
19453
19454 <refentry version="5.0" id="footer.column.widths">
19455 <refmeta>
19456 <refentrytitle>footer.column.widths</refentrytitle>
19457 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19458 </refmeta>
19459 <refnamediv>
19460 <refname>footer.column.widths</refname>
19461 <refpurpose>Specify relative widths of footer areas</refpurpose>
19462 </refnamediv>
19463
19464 <refsynopsisdiv><programlisting id="footer.column.widths.frag">
19465 &lt;xsl:param name="footer.column.widths"&gt;1 1 1&lt;/xsl:param&gt;
19466 </programlisting></refsynopsisdiv>
19467
19468 <refsection><info><title>Description</title></info>
19469
19470 <para>Page footers in print output use a three column table
19471 to position text at the left, center, and right side of
19472 the footer on the page.
19473 This parameter lets you specify the relative sizes of the
19474 three columns.  The default value is
19475 "1 1 1".</para>
19476
19477 <para>The parameter value must be three numbers, separated
19478 by white space. The first number represents the relative
19479 width of the inside footer for
19480 double-sided output.  The second number is the relative
19481 width of the center footer.  The third number is the
19482 relative width of the outside footer for
19483 double-sided output.
19484 </para>
19485 <para>For single-sided output, the first number is the
19486 relative width of left footer for left-to-right
19487 text direction, or the right footer for right-to-left
19488 text direction.  
19489 The third number is the
19490 relative width of right footer for left-to-right
19491 text direction, or the left footer for right-to-left
19492 text direction.</para>
19493
19494 <para>The numbers are used to specify the column widths
19495 for the table that makes up the footer area.
19496 In the FO output, this looks like:
19497 </para>
19498
19499 <programlisting>
19500 &lt;fo:table-column column-number="1" 
19501     column-width="proportional-column-width(1)"/&gt;
19502 </programlisting>
19503
19504 <para>
19505 The <literal>proportional-column-width()</literal>
19506 function computes a column width by dividing its
19507 argument by the total of the arguments for all the columns, and
19508 then multiplying the result by the width of the whole table
19509 (assuming all the column specs use the function).
19510 Its argument can be any positive integer or floating point number.
19511 Zero is an acceptable value, although some FO processors
19512 may warn about it, in which case using a very small number might
19513 be more satisfactory.
19514 </para>
19515
19516 <para>For example, the value "1 2 1" means the center
19517 footer should have twice the width of the other areas.
19518 A value of "0 0 1" means the entire footer area
19519 is reserved for the right (or outside) footer text.
19520 Note that to keep the center area centered on
19521 the page, the left and right values must be
19522 the same. A specification like "1 2 3" means the
19523 center area is no longer centered on the page
19524 since the right area is three times the width of the left area.
19525 </para>
19526
19527 </refsection>
19528 </refentry>
19529
19530 <refentry version="5.0" id="header.table.properties">
19531 <refmeta>
19532 <refentrytitle>header.table.properties</refentrytitle>
19533 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19534 </refmeta>
19535 <refnamediv>
19536 <refname>header.table.properties</refname>
19537 <refpurpose>Apply properties to the header layout table</refpurpose>
19538 </refnamediv>
19539
19540 <refsynopsisdiv>
19541 <programlisting id="header.table.properties.frag">
19542 &lt;xsl:attribute-set name="header.table.properties"&gt;
19543   &lt;xsl:attribute name="table-layout"&gt;fixed&lt;/xsl:attribute&gt;
19544   &lt;xsl:attribute name="width"&gt;100%&lt;/xsl:attribute&gt;
19545 &lt;/xsl:attribute-set&gt;
19546 </programlisting>
19547 </refsynopsisdiv>
19548
19549 <refsection><info><title>Description</title></info>
19550
19551 <para>Properties applied to the table that lays out the page header.</para>
19552
19553 </refsection>
19554 </refentry>
19555
19556 <refentry version="5.0" id="header.table.height">
19557 <refmeta>
19558 <refentrytitle>header.table.height</refentrytitle>
19559 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19560 </refmeta>
19561 <refnamediv>
19562 <refname>header.table.height</refname>
19563 <refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose>
19564 </refnamediv>
19565
19566 <refsynopsisdiv><programlisting id="header.table.height.frag">
19567 &lt;xsl:param name="header.table.height"&gt;14pt&lt;/xsl:param&gt;
19568 </programlisting></refsynopsisdiv>
19569
19570 <refsection><info><title>Description</title></info>
19571
19572 <para>Page headers in print output use a three column table
19573 to position text at the left, center, and right side of
19574 the header on the page.
19575 This parameter lets you specify the minimum height 
19576 of the single row in the table.  
19577 Since this specifies only the minimum height,
19578 the table should automatically grow to fit taller content.
19579 The default value is "14pt".</para>
19580
19581 </refsection>
19582 </refentry>
19583
19584 <refentry version="5.0" id="footer.table.properties">
19585 <refmeta>
19586 <refentrytitle>footer.table.properties</refentrytitle>
19587 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19588 </refmeta>
19589 <refnamediv>
19590 <refname>footer.table.properties</refname>
19591 <refpurpose>Apply properties to the footer layout table</refpurpose>
19592 </refnamediv>
19593
19594 <refsynopsisdiv>
19595 <programlisting id="footer.table.properties.frag">
19596 &lt;xsl:attribute-set name="footer.table.properties"&gt;
19597   &lt;xsl:attribute name="table-layout"&gt;fixed&lt;/xsl:attribute&gt;
19598   &lt;xsl:attribute name="width"&gt;100%&lt;/xsl:attribute&gt;
19599 &lt;/xsl:attribute-set&gt;
19600 </programlisting>
19601 </refsynopsisdiv>
19602
19603 <refsection><info><title>Description</title></info>
19604
19605 <para>Properties applied to the table that lays out the page footer.</para>
19606
19607 </refsection>
19608 </refentry>
19609
19610 <refentry version="5.0" id="footer.table.height">
19611 <refmeta>
19612 <refentrytitle>footer.table.height</refentrytitle>
19613 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19614 </refmeta>
19615 <refnamediv>
19616 <refname>footer.table.height</refname>
19617 <refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose>
19618 </refnamediv>
19619
19620 <refsynopsisdiv><programlisting id="footer.table.height.frag">
19621 &lt;xsl:param name="footer.table.height"&gt;14pt&lt;/xsl:param&gt;
19622 </programlisting></refsynopsisdiv>
19623
19624 <refsection><info><title>Description</title></info>
19625
19626 <para>Page footers in print output use a three column table
19627 to position text at the left, center, and right side of
19628 the footer on the page.
19629 This parameter lets you specify the minimum height 
19630 of the single row in the table.  
19631 Since this specifies only the minimum height,
19632 the table should automatically grow to fit taller content.
19633 The default value is "14pt".</para>
19634
19635 </refsection>
19636 </refentry>
19637
19638 <refentry version="5.0" id="header.content.properties">
19639 <refmeta>
19640 <refentrytitle>header.content.properties</refentrytitle>
19641 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19642 </refmeta>
19643 <refnamediv>
19644 <refname>header.content.properties</refname>
19645 <refpurpose>Properties of page header content</refpurpose>
19646 </refnamediv>
19647
19648 <refsynopsisdiv>
19649 <programlisting id="header.content.properties.frag">
19650 &lt;xsl:attribute-set name="header.content.properties"&gt;
19651   &lt;xsl:attribute name="font-family"&gt;
19652     &lt;xsl:value-of select="$body.fontset"&gt;&lt;/xsl:value-of&gt;
19653   &lt;/xsl:attribute&gt;
19654   &lt;xsl:attribute name="margin-left"&gt;
19655     &lt;xsl:value-of select="$title.margin.left"&gt;&lt;/xsl:value-of&gt;
19656   &lt;/xsl:attribute&gt;
19657 &lt;/xsl:attribute-set&gt;
19658 </programlisting>
19659 </refsynopsisdiv>
19660
19661 <refsection><info><title>Description</title></info>
19662
19663 <para>Properties of page header content.</para>
19664
19665 </refsection>
19666 </refentry>
19667
19668 <refentry version="5.0" id="footer.content.properties">
19669 <refmeta>
19670 <refentrytitle>footer.content.properties</refentrytitle>
19671 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19672 </refmeta>
19673 <refnamediv>
19674 <refname>footer.content.properties</refname>
19675 <refpurpose>Properties of page footer content</refpurpose>
19676 </refnamediv>
19677
19678 <refsynopsisdiv>
19679 <programlisting id="footer.content.properties.frag">
19680 &lt;xsl:attribute-set name="footer.content.properties"&gt;
19681   &lt;xsl:attribute name="font-family"&gt;
19682     &lt;xsl:value-of select="$body.fontset"&gt;&lt;/xsl:value-of&gt;
19683   &lt;/xsl:attribute&gt;
19684   &lt;xsl:attribute name="margin-left"&gt;
19685     &lt;xsl:value-of select="$title.margin.left"&gt;&lt;/xsl:value-of&gt;
19686   &lt;/xsl:attribute&gt;
19687 &lt;/xsl:attribute-set&gt;
19688 </programlisting>
19689 </refsynopsisdiv>
19690
19691 <refsection><info><title>Description</title></info>
19692
19693 <para>Properties of page footer content.</para>
19694
19695 </refsection>
19696 </refentry>
19697
19698 <refentry version="5.0" id="marker.section.level">
19699 <refmeta>
19700 <refentrytitle>marker.section.level</refentrytitle>
19701 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
19702 </refmeta>
19703 <refnamediv>
19704 <refname>marker.section.level</refname>
19705 <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
19706 </refnamediv>
19707
19708 <refsynopsisdiv>
19709 <programlisting id="marker.section.level.frag">
19710 &lt;xsl:param name="marker.section.level"&gt;2&lt;/xsl:param&gt;
19711 </programlisting>
19712 </refsynopsisdiv>
19713
19714 <refsection><info><title>Description</title></info>
19715
19716 <para>The <parameter>marker.section.level</parameter> parameter
19717 controls the depth of section levels that may be displayed
19718 in running headers and footers.  For example, if the value
19719 is 2 (the default), then titles from <tag>sect1</tag> and 
19720 <tag>sect2</tag> or equivalent <tag>section</tag>
19721 elements are candidates for use in running headers and
19722 footers.
19723 </para>
19724 <para>Each candidate title is marked in the FO output with a
19725 <tag>&lt;fo:marker marker-class-name="section.head.marker"&gt;</tag>
19726 element.
19727 </para>
19728 <para>In order for such titles to appear in headers
19729 or footers, the <literal>header.content</literal>
19730 or <literal>footer.content</literal> template
19731 must be customized to retrieve the marker using
19732 an output element such as:
19733 </para>
19734 <programlisting>
19735 &lt;fo:retrieve-marker retrieve-class-name="section.head.marker"
19736                        retrieve-position="first-including-carryover"
19737                        retrieve-boundary="page-sequence"/&gt;
19738 </programlisting>
19739
19740
19741 </refsection>
19742 </refentry>
19743
19744 </reference><reference id="fonts" xml:base="../fo/param.xml"><title>Font Families</title>
19745 <refentry version="5.0" id="body.font.family">
19746 <refmeta>
19747 <refentrytitle>body.font.family</refentrytitle>
19748 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19749 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19750 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19751 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19752 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19753 </refmeta>
19754 <refnamediv>
19755 <refname>body.font.family</refname>
19756 <refpurpose>The default font family for body text</refpurpose>
19757 </refnamediv>
19758
19759 <refsynopsisdiv>
19760 <programlisting id="body.font.family.frag">
19761 &lt;xsl:param name="body.font.family"&gt;serif&lt;/xsl:param&gt;
19762 </programlisting>
19763 </refsynopsisdiv>
19764
19765 <refsection><info><title>Description</title></info>
19766
19767 <para>The body font family is the default font used for text in the page body.
19768 </para>
19769
19770 </refsection>
19771 </refentry>
19772
19773 <refentry version="5.0" id="dingbat.font.family">
19774 <refmeta>
19775 <refentrytitle>dingbat.font.family</refentrytitle>
19776 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19777 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19778 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19779 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19780 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19781 </refmeta>
19782 <refnamediv>
19783 <refname>dingbat.font.family</refname>
19784 <refpurpose>The font family for copyright, quotes, and other symbols</refpurpose>
19785 </refnamediv>
19786
19787 <refsynopsisdiv>
19788 <programlisting id="dingbat.font.family.frag">
19789 &lt;xsl:param name="dingbat.font.family"&gt;serif&lt;/xsl:param&gt;
19790 </programlisting>
19791 </refsynopsisdiv>
19792
19793 <refsection><info><title>Description</title></info>
19794
19795 <para>The dingbat font family is used for dingbats. If it is defined
19796 as the empty string, no font change is effected around dingbats.
19797 </para>
19798
19799 </refsection>
19800 </refentry>
19801
19802 <refentry version="5.0" id="monospace.font.family">
19803 <refmeta>
19804 <refentrytitle>monospace.font.family</refentrytitle>
19805 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19806 </refmeta>
19807 <refnamediv>
19808 <refname>monospace.font.family</refname>
19809 <refpurpose>The default font family for monospace environments</refpurpose>
19810 </refnamediv>
19811
19812 <refsynopsisdiv>
19813 <programlisting id="monospace.font.family.frag">
19814 &lt;xsl:param name="monospace.font.family"&gt;monospace&lt;/xsl:param&gt;
19815 </programlisting>
19816 </refsynopsisdiv>
19817
19818 <refsection><info><title>Description</title></info>
19819
19820 <para>The monospace font family is used for verbatim environments
19821 (program listings, screens, etc.).
19822 </para>
19823
19824 </refsection>
19825 </refentry>
19826
19827 <refentry version="5.0" id="sans.font.family">
19828 <refmeta>
19829 <refentrytitle>sans.font.family</refentrytitle>
19830 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19831 </refmeta>
19832 <refnamediv>
19833 <refname>sans.font.family</refname>
19834 <refpurpose>The default sans-serif font family</refpurpose>
19835 </refnamediv>
19836
19837 <refsynopsisdiv>
19838 <programlisting id="sans.font.family.frag">
19839 &lt;xsl:param name="sans.font.family"&gt;sans-serif&lt;/xsl:param&gt;
19840 </programlisting>
19841 </refsynopsisdiv>
19842
19843 <refsection><info><title>Description</title></info>
19844
19845 <para>The default sans-serif font family. At the present, this isn't
19846 actually used by the stylesheets.
19847 </para>
19848
19849 </refsection>
19850 </refentry>
19851
19852 <refentry version="5.0" id="title.font.family">
19853 <refmeta>
19854 <refentrytitle>title.font.family</refentrytitle>
19855 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19856 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19857 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19858 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19859 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19860 </refmeta>
19861 <refnamediv>
19862 <refname>title.font.family</refname>
19863 <refpurpose>The default font family for titles</refpurpose>
19864 </refnamediv>
19865
19866 <refsynopsisdiv>
19867 <programlisting id="title.font.family.frag">
19868 &lt;xsl:param name="title.font.family"&gt;sans-serif&lt;/xsl:param&gt;
19869 </programlisting>
19870 </refsynopsisdiv>
19871
19872 <refsection><info><title>Description</title></info>
19873
19874 <para>The title font family is used for titles (chapter, section, figure,
19875 etc.)
19876 </para>
19877
19878 </refsection>
19879 </refentry>
19880
19881 <refentry version="5.0" id="symbol.font.family">
19882 <refmeta>
19883 <refentrytitle>symbol.font.family</refentrytitle>
19884 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19885 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19886 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19887 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19888 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19889 </refmeta>
19890 <refnamediv>
19891 <refname>symbol.font.family</refname>
19892 <refpurpose>The font families to be searched for symbols outside
19893     of the body font</refpurpose>
19894 </refnamediv>
19895
19896 <refsynopsisdiv>
19897 <programlisting id="symbol.font.family.frag">
19898 &lt;xsl:param name="symbol.font.family"&gt;Symbol,ZapfDingbats&lt;/xsl:param&gt;
19899 </programlisting>
19900 </refsynopsisdiv>
19901
19902 <refsection><info><title>Description</title></info>
19903
19904 <para>A typical body or title font does not contain all
19905 the character glyphs that DocBook supports.  This parameter
19906 specifies additional fonts that should be searched for
19907 special characters not in the normal font.
19908 These symbol font names are automatically appended
19909 to the body or title font family name when fonts
19910 are specified in a 
19911 <tag class="attribute">font-family</tag>
19912 property in the FO output.
19913 </para>
19914 <para>The symbol font names should be entered as a
19915 comma-separated list.  The default value is
19916 <literal>Symbol,ZapfDingbats</literal>.
19917 </para>
19918
19919 </refsection>
19920 </refentry>
19921
19922 </reference><reference id="propsets" xml:base="../fo/param.xml"><title>Property Sets</title>
19923 <refentry version="5.0" id="formal.object.properties">
19924 <refmeta>
19925 <refentrytitle>formal.object.properties</refentrytitle>
19926 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19927 </refmeta>
19928 <refnamediv>
19929 <refname>formal.object.properties</refname>
19930 <refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
19931 </refnamediv>
19932
19933 <refsynopsisdiv>
19934 <programlisting id="formal.object.properties.frag">
19935 &lt;xsl:attribute-set name="formal.object.properties"&gt;
19936   &lt;xsl:attribute name="space-before.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
19937   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
19938   &lt;xsl:attribute name="space-before.maximum"&gt;2em&lt;/xsl:attribute&gt;
19939   &lt;xsl:attribute name="space-after.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
19940   &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
19941   &lt;xsl:attribute name="space-after.maximum"&gt;2em&lt;/xsl:attribute&gt;
19942   &lt;xsl:attribute name="keep-together.within-column"&gt;always&lt;/xsl:attribute&gt;
19943 &lt;/xsl:attribute-set&gt;
19944 </programlisting>
19945 </refsynopsisdiv>
19946
19947 <refsection><info><title>Description</title></info>
19948
19949 <para>The styling for formal objects in docbook. Specify the spacing
19950 before and after the object.</para>
19951
19952 </refsection>
19953 </refentry>
19954
19955 <refentry version="5.0" id="formal.title.properties">
19956 <refmeta>
19957 <refentrytitle>formal.title.properties</refentrytitle>
19958 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19959 </refmeta>
19960 <refnamediv>
19961 <refname>formal.title.properties</refname>
19962 <refpurpose>Style the title element of formal object such as a figure.</refpurpose>
19963 </refnamediv>
19964
19965 <refsynopsisdiv>
19966 <programlisting id="formal.title.properties.frag">
19967 &lt;xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing"&gt;
19968   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
19969   &lt;xsl:attribute name="font-size"&gt;
19970     &lt;xsl:value-of select="$body.font.master * 1.2"&gt;&lt;/xsl:value-of&gt;
19971     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
19972   &lt;/xsl:attribute&gt;
19973   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
19974   &lt;xsl:attribute name="space-after.minimum"&gt;0.4em&lt;/xsl:attribute&gt;
19975   &lt;xsl:attribute name="space-after.optimum"&gt;0.6em&lt;/xsl:attribute&gt;
19976   &lt;xsl:attribute name="space-after.maximum"&gt;0.8em&lt;/xsl:attribute&gt;
19977 &lt;/xsl:attribute-set&gt;
19978 </programlisting>
19979 </refsynopsisdiv>
19980 <refsection><info><title>Description</title></info>
19981 <para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
19982 </refsection>
19983 </refentry>
19984
19985 <refentry version="5.0" id="informal.object.properties">
19986 <refmeta>
19987 <refentrytitle>informal.object.properties</refentrytitle>
19988 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19989 </refmeta>
19990 <refnamediv>
19991 <refname>informal.object.properties</refname>
19992 <refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose>
19993 </refnamediv>
19994
19995 <refsynopsisdiv>
19996 <programlisting id="informal.object.properties.frag">&lt;xsl:attribute-set name="informal.object.properties"&gt;
19997   &lt;xsl:attribute name="space-before.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
19998   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
19999   &lt;xsl:attribute name="space-before.maximum"&gt;2em&lt;/xsl:attribute&gt;
20000   &lt;xsl:attribute name="space-after.minimum"&gt;0.5em&lt;/xsl:attribute&gt;
20001   &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
20002   &lt;xsl:attribute name="space-after.maximum"&gt;2em&lt;/xsl:attribute&gt;
20003 &lt;/xsl:attribute-set&gt;</programlisting>
20004 </refsynopsisdiv>
20005 <refsection><info><title>Description</title></info>
20006 <para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para>
20007 </refsection>
20008 </refentry>
20009
20010 <refentry version="5.0" id="monospace.properties">
20011 <refmeta>
20012 <refentrytitle>monospace.properties</refentrytitle>
20013 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20014 </refmeta>
20015 <refnamediv>
20016 <refname>monospace.properties</refname>
20017 <refpurpose>Properties of monospaced content</refpurpose>
20018 </refnamediv>
20019
20020 <refsynopsisdiv>
20021 <programlisting id="monospace.properties.frag">
20022 &lt;xsl:attribute-set name="monospace.properties"&gt;
20023   &lt;xsl:attribute name="font-family"&gt;
20024     &lt;xsl:value-of select="$monospace.font.family"&gt;&lt;/xsl:value-of&gt;
20025   &lt;/xsl:attribute&gt;
20026 &lt;/xsl:attribute-set&gt;
20027 </programlisting>
20028 </refsynopsisdiv>
20029
20030 <refsection><info><title>Description</title></info>
20031
20032 <para>Specifies the font name for monospaced output. This property set
20033 used to set the font-size as well, but that doesn't work very well
20034 when different fonts are used (as they are in titles and paragraphs,
20035 for example).</para>
20036
20037 <para>If you want to set the font-size in a customization layer, it's
20038 probably going to be more appropriate to set font-size-adjust, if your
20039 formatter supports it.</para>
20040
20041 </refsection>
20042 </refentry>
20043
20044 <refentry version="5.0" id="verbatim.properties">
20045 <refmeta>
20046 <refentrytitle>verbatim.properties</refentrytitle>
20047 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20048 </refmeta>
20049 <refnamediv>
20050 <refname>verbatim.properties</refname>
20051 <refpurpose>Properties associated with verbatim text</refpurpose>
20052 </refnamediv>
20053
20054 <refsynopsisdiv>
20055 <programlisting id="verbatim.properties.frag">
20056 &lt;xsl:attribute-set name="verbatim.properties"&gt;
20057   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
20058   &lt;xsl:attribute name="space-before.optimum"&gt;1em&lt;/xsl:attribute&gt;
20059   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
20060   &lt;xsl:attribute name="space-after.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
20061   &lt;xsl:attribute name="space-after.optimum"&gt;1em&lt;/xsl:attribute&gt;
20062   &lt;xsl:attribute name="space-after.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
20063   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
20064   &lt;xsl:attribute name="wrap-option"&gt;no-wrap&lt;/xsl:attribute&gt;
20065   &lt;xsl:attribute name="white-space-collapse"&gt;false&lt;/xsl:attribute&gt;
20066   &lt;xsl:attribute name="white-space-treatment"&gt;preserve&lt;/xsl:attribute&gt;
20067   &lt;xsl:attribute name="linefeed-treatment"&gt;preserve&lt;/xsl:attribute&gt;
20068   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
20069 &lt;/xsl:attribute-set&gt;</programlisting>
20070 </refsynopsisdiv>
20071
20072 <refsection><info><title>Description</title></info>
20073 <para>This attribute set is used on all verbatim environments.</para>
20074 </refsection>
20075
20076 </refentry>
20077
20078 <refentry version="5.0" id="monospace.verbatim.properties">
20079 <refmeta>
20080 <refentrytitle>monospace.verbatim.properties</refentrytitle>
20081 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20082 </refmeta>
20083 <refnamediv>
20084 <refname>monospace.verbatim.properties</refname>
20085 <refpurpose>What font and size do you want for monospaced content?</refpurpose>
20086 </refnamediv>
20087
20088 <refsynopsisdiv>
20089 <programlisting id="monospace.verbatim.properties.frag">
20090 &lt;xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties"&gt;
20091   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
20092   &lt;xsl:attribute name="wrap-option"&gt;no-wrap&lt;/xsl:attribute&gt;
20093 &lt;/xsl:attribute-set&gt;
20094 </programlisting>
20095 </refsynopsisdiv>
20096 <refsection><info><title>Description</title></info>
20097 <para>Specify the font name and size you want for monospaced output</para>
20098 </refsection>
20099 </refentry>
20100
20101 <refentry version="5.0" id="sidebar.properties">
20102 <refmeta>
20103 <refentrytitle>sidebar.properties</refentrytitle>
20104 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20105 </refmeta>
20106 <refnamediv>
20107 <refname>sidebar.properties</refname>
20108 <refpurpose>Attribute set for sidebar properties</refpurpose>
20109 </refnamediv>
20110
20111 <refsynopsisdiv>
20112 <programlisting id="sidebar.properties.frag">
20113 &lt;xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties"&gt;
20114   &lt;xsl:attribute name="border-style"&gt;solid&lt;/xsl:attribute&gt;
20115   &lt;xsl:attribute name="border-width"&gt;1pt&lt;/xsl:attribute&gt;
20116   &lt;xsl:attribute name="border-color"&gt;black&lt;/xsl:attribute&gt;
20117   &lt;xsl:attribute name="background-color"&gt;#DDDDDD&lt;/xsl:attribute&gt;
20118   &lt;xsl:attribute name="padding-start"&gt;12pt&lt;/xsl:attribute&gt;
20119   &lt;xsl:attribute name="padding-end"&gt;12pt&lt;/xsl:attribute&gt;
20120   &lt;xsl:attribute name="padding-top"&gt;6pt&lt;/xsl:attribute&gt;
20121   &lt;xsl:attribute name="padding-bottom"&gt;6pt&lt;/xsl:attribute&gt;
20122   &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;0pt&lt;/xsl:attribute&gt;
20123   &lt;xsl:attribute name="margin-{$direction.align.end}"&gt;0pt&lt;/xsl:attribute&gt;
20124 &lt;!--
20125   &lt;xsl:attribute name="margin-top"&gt;6pt&lt;/xsl:attribute&gt;
20126   &lt;xsl:attribute name="margin-bottom"&gt;6pt&lt;/xsl:attribute&gt;
20127 --&gt;
20128 &lt;/xsl:attribute-set&gt;
20129 </programlisting>
20130 </refsynopsisdiv>
20131
20132 <refsection><info><title>Description</title></info>
20133
20134 <para>The styling for sidebars.</para>
20135
20136 </refsection>
20137 </refentry>
20138
20139 <refentry version="5.0" id="sidebar.title.properties">
20140 <refmeta>
20141 <refentrytitle>sidebar.title.properties</refentrytitle>
20142 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20143 </refmeta>
20144 <refnamediv>
20145 <refname>sidebar.title.properties</refname>
20146 <refpurpose>Attribute set for sidebar titles</refpurpose>
20147 </refnamediv>
20148
20149 <refsynopsisdiv>
20150 <programlisting id="sidebar.title.properties.frag">
20151 &lt;xsl:attribute-set name="sidebar.title.properties"&gt;
20152   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
20153   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
20154   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
20155   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
20156 &lt;/xsl:attribute-set&gt;
20157 </programlisting>
20158 </refsynopsisdiv>
20159
20160 <refsection><info><title>Description</title></info>
20161
20162 <para>The styling for sidebars titles.</para>
20163
20164 </refsection>
20165 </refentry>
20166
20167 <refentry version="5.0" id="sidebar.float.type">
20168 <refmeta>
20169 <refentrytitle>sidebar.float.type</refentrytitle>
20170 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20171 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
20172 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
20173 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
20174 <refmiscinfo class="other" otherclass="value">start</refmiscinfo> 
20175 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
20176 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>     
20177 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
20178 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo> 
20179 </refmeta>
20180 <refnamediv>
20181 <refname>sidebar.float.type</refname>
20182 <refpurpose>Select type of float for sidebar elements</refpurpose>
20183 </refnamediv>
20184
20185 <refsynopsisdiv>
20186 <programlisting id="sidebar.float.type.frag">
20187 &lt;xsl:param name="sidebar.float.type"&gt;none&lt;/xsl:param&gt;
20188 </programlisting>
20189 </refsynopsisdiv>
20190
20191 <refsection><info><title>Description</title></info>
20192
20193 <para>Selects the type of float for sidebar elements.
20194 </para>
20195 <itemizedlist>
20196 <listitem>
20197 <para>If <parameter>sidebar.float.type</parameter> is
20198 <quote><literal>none</literal></quote>, then 
20199 no float is used.
20200 </para>
20201 </listitem>
20202 <listitem>
20203 <para>If <parameter>sidebar.float.type</parameter> is
20204 <quote><literal>before</literal></quote>, then 
20205 the float appears at the top of the page.  On some processors,
20206 that may be the next page rather than the current page.
20207 </para>
20208 </listitem>
20209
20210 <listitem>
20211 <para>If <parameter>sidebar.float.type</parameter> is
20212 <quote><literal>left</literal></quote>,
20213 then a left side float is used.
20214 </para>
20215 </listitem>
20216
20217 <listitem>
20218 <para>If <parameter>sidebar.float.type</parameter> is
20219 <quote><literal>start</literal></quote>,
20220 then when the text direction is left-to-right a left side float is used.
20221 When the text direction is right-to-left, a right side float is used.
20222 </para>
20223 </listitem>
20224
20225 <listitem>
20226 <para>If <parameter>sidebar.float.type</parameter> is
20227 <quote><literal>right</literal></quote>,
20228 then a right side float is used.
20229 </para>
20230 </listitem>
20231
20232 <listitem>
20233 <para>If <parameter>sidebar.float.type</parameter> is
20234 <quote><literal>end</literal></quote>,
20235 then when the text direction is left-to-right a right side float is used.
20236 When the text direction is right-to-left, a left side float is used.
20237 </para>
20238 </listitem>
20239
20240 <listitem>
20241 <para>If your XSL-FO processor supports floats positioned on the
20242 <quote><literal>inside</literal></quote> or
20243 <quote><literal>outside</literal></quote>
20244 of double-sided pages, then you have those two 
20245 options for side floats as well.
20246 </para>
20247 </listitem>
20248 </itemizedlist>
20249
20250 </refsection>
20251 </refentry>
20252
20253 <refentry version="5.0" id="sidebar.float.width">
20254 <refmeta>
20255 <refentrytitle>sidebar.float.width</refentrytitle>
20256 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20257 </refmeta>
20258 <refnamediv>
20259 <refname>sidebar.float.width</refname>
20260 <refpurpose>Set the default width for sidebars</refpurpose>
20261 </refnamediv>
20262
20263 <refsynopsisdiv>
20264 <programlisting id="sidebar.float.width.frag">
20265 &lt;xsl:param name="sidebar.float.width"&gt;1in&lt;/xsl:param&gt;
20266 </programlisting>
20267 </refsynopsisdiv>
20268
20269 <refsection><info><title>Description</title></info>
20270
20271 <para>Sets the default width for sidebars when used as a side float.
20272 The width determines the degree to which the sidebar block intrudes into
20273 the text area.
20274 </para>
20275 <para>If <parameter>sidebar.float.type</parameter> is
20276 <quote><literal>before</literal></quote> or 
20277 <quote><literal>none</literal></quote>, then 
20278 this parameter is ignored.
20279 </para>
20280
20281 </refsection>
20282 </refentry>
20283
20284 <refentry version="5.0" id="margin.note.properties">
20285 <refmeta>
20286 <refentrytitle>margin.note.properties</refentrytitle>
20287 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20288 </refmeta>
20289 <refnamediv>
20290 <refname>margin.note.properties</refname>
20291 <refpurpose>Attribute set for margin.note properties</refpurpose>
20292 </refnamediv>
20293
20294 <refsynopsisdiv>
20295 <programlisting id="margin.note.properties.frag">
20296 &lt;xsl:attribute-set name="margin.note.properties"&gt;
20297   &lt;xsl:attribute name="font-size"&gt;90%&lt;/xsl:attribute&gt;
20298   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
20299 &lt;/xsl:attribute-set&gt;
20300 </programlisting>
20301 </refsynopsisdiv>
20302
20303 <refsection><info><title>Description</title></info>
20304
20305 <para>The styling for margin notes.
20306 By default, margin notes are not implemented for any
20307 element. A stylesheet customization is needed to make
20308 use of this attribute-set.</para>
20309
20310 <para>You can use a template named <quote>floater</quote>
20311 to create the customization.
20312 That template can create side floats by specifying the
20313 content and characteristics as template parameters.
20314 </para>
20315
20316 <para>For example:</para>
20317 <programlisting>&lt;xsl:template match="para[@role='marginnote']"&gt;
20318   &lt;xsl:call-template name="floater"&gt;
20319     &lt;xsl:with-param name="position"&gt;
20320       &lt;xsl:value-of select="$margin.note.float.type"/&gt;
20321     &lt;/xsl:with-param&gt;
20322     &lt;xsl:with-param name="width"&gt;
20323       &lt;xsl:value-of select="$margin.note.width"/&gt;
20324     &lt;/xsl:with-param&gt;
20325     &lt;xsl:with-param name="content"&gt;
20326       &lt;xsl:apply-imports/&gt;
20327     &lt;/xsl:with-param&gt;
20328   &lt;/xsl:call-template&gt;
20329 &lt;/xsl:template&gt;</programlisting>
20330
20331 </refsection>
20332 </refentry>
20333
20334 <refentry version="5.0" id="margin.note.title.properties">
20335 <refmeta>
20336 <refentrytitle>margin.note.title.properties</refentrytitle>
20337 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20338 </refmeta>
20339 <refnamediv>
20340 <refname>margin.note.title.properties</refname>
20341 <refpurpose>Attribute set for margin note titles</refpurpose>
20342 </refnamediv>
20343
20344 <refsynopsisdiv>
20345 <programlisting id="margin.note.title.properties.frag">
20346 &lt;xsl:attribute-set name="margin.note.title.properties"&gt;
20347   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
20348   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
20349   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
20350   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
20351 &lt;/xsl:attribute-set&gt;
20352 </programlisting>
20353 </refsynopsisdiv>
20354
20355 <refsection><info><title>Description</title></info>
20356
20357 <para>The styling for margin note titles.</para>
20358
20359 </refsection>
20360 </refentry>
20361
20362 <refentry version="5.0" id="margin.note.float.type">
20363 <refmeta>
20364 <refentrytitle>margin.note.float.type</refentrytitle>
20365 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20366 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
20367 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
20368 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
20369 <refmiscinfo class="other" otherclass="value">start</refmiscinfo> 
20370 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
20371 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>     
20372 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
20373 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo> 
20374 </refmeta>
20375 <refnamediv>
20376 <refname>margin.note.float.type</refname>
20377 <refpurpose>Select type of float for margin note customizations</refpurpose>
20378 </refnamediv>
20379
20380 <refsynopsisdiv>
20381 <programlisting id="margin.note.float.type.frag">
20382 &lt;xsl:param name="margin.note.float.type"&gt;none&lt;/xsl:param&gt;
20383 </programlisting>
20384 </refsynopsisdiv>
20385
20386 <refsection><info><title>Description</title></info>
20387
20388 <para>Selects the type of float for margin notes.
20389 DocBook does not define a margin note element, so this
20390 feature must be implemented as a customization of the stylesheet.
20391 See <parameter>margin.note.properties</parameter> for
20392 an example.
20393 </para>
20394 <itemizedlist>
20395 <listitem>
20396 <para>If <parameter>margin.note.float.type</parameter> is
20397 <quote><literal>none</literal></quote>, then 
20398 no float is used.
20399 </para>
20400 </listitem>
20401 <listitem>
20402 <para>If <parameter>margin.note.float.type</parameter> is
20403 <quote><literal>before</literal></quote>, then 
20404 the float appears at the top of the page.  On some processors,
20405 that may be the next page rather than the current page.
20406 </para>
20407 </listitem>
20408 <listitem>
20409 <para>If <parameter>margin.note.float.type</parameter> is
20410 <quote><literal>left</literal></quote> or
20411 <quote><literal>start</literal></quote>, then 
20412 a left side float is used.
20413 </para>
20414 </listitem>
20415 <listitem>
20416 <para>If <parameter>margin.note.float.type</parameter> is
20417 <quote><literal>right</literal></quote> or
20418 <quote><literal>end</literal></quote>, then 
20419 a right side float is used.
20420 </para>
20421 </listitem>
20422 <listitem>
20423 <para>If your XSL-FO processor supports floats positioned on the
20424 <quote><literal>inside</literal></quote> or
20425 <quote><literal>outside</literal></quote>
20426 of double-sided pages, then you have those two 
20427 options for side floats as well.
20428 </para>
20429 </listitem>
20430 </itemizedlist>
20431
20432 </refsection>
20433 </refentry>
20434
20435 <refentry version="5.0" id="margin.note.width">
20436 <refmeta>
20437 <refentrytitle>margin.note.width</refentrytitle>
20438 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20439 </refmeta>
20440 <refnamediv>
20441 <refname>margin.note.width</refname>
20442 <refpurpose>Set the default width for margin notes</refpurpose>
20443 </refnamediv>
20444
20445 <refsynopsisdiv>
20446 <programlisting id="margin.note.width.frag">
20447 &lt;xsl:param name="margin.note.width"&gt;1in&lt;/xsl:param&gt;
20448 </programlisting>
20449 </refsynopsisdiv>
20450
20451 <refsection><info><title>Description</title></info>
20452
20453 <para>Sets the default width for margin notes when used as a side
20454 float.  The width determines the degree to which the margin note block
20455 intrudes into the text area.
20456 </para>
20457 <para>If <parameter>margin.note.float.type</parameter> is
20458 <quote><literal>before</literal></quote> or 
20459 <quote><literal>none</literal></quote>, then 
20460 this parameter is ignored.
20461 </para>
20462
20463 </refsection>
20464 </refentry>
20465
20466 <refentry version="5.0" id="component.title.properties">
20467 <refmeta>
20468 <refentrytitle>component.title.properties</refentrytitle>
20469 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20470 </refmeta>
20471 <refnamediv>
20472 <refname>component.title.properties</refname>
20473 <refpurpose>Properties for component titles</refpurpose>
20474 </refnamediv>
20475
20476 <refsynopsisdiv>
20477 <programlisting id="component.title.properties.frag">
20478 &lt;xsl:attribute-set name="component.title.properties"&gt;
20479   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
20480   &lt;xsl:attribute name="space-before.optimum"&gt;&lt;xsl:value-of select="concat($body.font.master, 'pt')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
20481   &lt;xsl:attribute name="space-before.minimum"&gt;&lt;xsl:value-of select="concat($body.font.master, 'pt * 0.8')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
20482   &lt;xsl:attribute name="space-before.maximum"&gt;&lt;xsl:value-of select="concat($body.font.master, 'pt * 1.2')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
20483   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
20484   &lt;xsl:attribute name="text-align"&gt;
20485     &lt;xsl:choose&gt;
20486       &lt;xsl:when test="((parent::article | parent::articleinfo | parent::info/parent::article) and not(ancestor::book) and not(self::bibliography))         or (parent::slides | parent::slidesinfo)"&gt;center&lt;/xsl:when&gt;
20487       &lt;xsl:otherwise&gt;start&lt;/xsl:otherwise&gt;
20488     &lt;/xsl:choose&gt;
20489   &lt;/xsl:attribute&gt;
20490   &lt;xsl:attribute name="start-indent"&gt;&lt;xsl:value-of select="$title.margin.left"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
20491 &lt;/xsl:attribute-set&gt;
20492 </programlisting>
20493 </refsynopsisdiv>
20494
20495 <refsection><info><title>Description</title></info>
20496
20497 <para>The properties common to all component titles.</para>
20498
20499 </refsection>
20500 </refentry>
20501
20502 <refentry version="5.0" id="component.titlepage.properties">
20503 <refmeta>
20504 <refentrytitle>component.titlepage.properties</refentrytitle>
20505 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20506 </refmeta>
20507 <refnamediv>
20508 <refname>component.titlepage.properties</refname>
20509 <refpurpose>Properties for component titlepages</refpurpose>
20510 </refnamediv>
20511
20512 <refsynopsisdiv>
20513 <programlisting id="component.titlepage.properties.frag">
20514 &lt;xsl:attribute-set name="component.titlepage.properties"&gt;
20515 &lt;/xsl:attribute-set&gt;
20516 </programlisting>
20517 </refsynopsisdiv>
20518
20519 <refsection><info><title>Description</title></info>
20520
20521 <para>The properties that are applied to the outer block containing
20522 all the component title page information. 
20523 Its main use is to set a <literal>span="all"</literal>
20524 property on the block that is a direct child of the flow.</para>
20525
20526 <para>This attribute-set also applies to index titlepages. It is empty by default.</para>
20527
20528 </refsection>
20529 </refentry>
20530
20531 <refentry version="5.0" id="section.title.properties">
20532 <refmeta>
20533 <refentrytitle>section.title.properties</refentrytitle>
20534 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20535 </refmeta>
20536 <refnamediv>
20537 <refname>section.title.properties</refname>
20538 <refpurpose>Properties for section titles</refpurpose>
20539 </refnamediv>
20540
20541 <refsynopsisdiv>
20542 <programlisting id="section.title.properties.frag">
20543 &lt;xsl:attribute-set name="section.title.properties"&gt;
20544   &lt;xsl:attribute name="font-family"&gt;
20545     &lt;xsl:value-of select="$title.font.family"&gt;&lt;/xsl:value-of&gt;
20546   &lt;/xsl:attribute&gt;
20547   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
20548   &lt;!-- font size is calculated dynamically by section.heading template --&gt;
20549   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
20550   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
20551   &lt;xsl:attribute name="space-before.optimum"&gt;1.0em&lt;/xsl:attribute&gt;
20552   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
20553   &lt;xsl:attribute name="text-align"&gt;start&lt;/xsl:attribute&gt;
20554   &lt;xsl:attribute name="start-indent"&gt;&lt;xsl:value-of select="$title.margin.left"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
20555 &lt;/xsl:attribute-set&gt;
20556 </programlisting>
20557 </refsynopsisdiv>
20558
20559 <refsection><info><title>Description</title></info>
20560
20561 <para>The properties common to all section titles.</para>
20562
20563 </refsection>
20564 </refentry>
20565
20566 <refentry version="5.0" id="section.title.level1.properties">
20567 <refmeta>
20568 <refentrytitle>section.title.level1.properties</refentrytitle>
20569 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20570 </refmeta>
20571 <refnamediv>
20572 <refname>section.title.level1.properties</refname>
20573 <refpurpose>Properties for level-1 section titles</refpurpose>
20574 </refnamediv>
20575
20576 <refsynopsisdiv>
20577 <programlisting id="section.title.level1.properties.frag">
20578 &lt;xsl:attribute-set name="section.title.level1.properties"&gt;
20579   &lt;xsl:attribute name="font-size"&gt;
20580     &lt;xsl:value-of select="$body.font.master * 2.0736"&gt;&lt;/xsl:value-of&gt;
20581     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
20582   &lt;/xsl:attribute&gt;
20583 &lt;/xsl:attribute-set&gt;
20584 </programlisting>
20585 </refsynopsisdiv>
20586
20587 <refsection><info><title>Description</title></info>
20588
20589 <para>The properties of level-1 section titles.</para>
20590
20591 </refsection>
20592 </refentry>
20593
20594
20595 <refentry version="5.0" id="section.title.level2.properties">
20596 <refmeta>
20597 <refentrytitle>section.title.level2.properties</refentrytitle>
20598 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20599 </refmeta>
20600 <refnamediv>
20601 <refname>section.title.level2.properties</refname>
20602 <refpurpose>Properties for level-2 section titles</refpurpose>
20603 </refnamediv>
20604
20605 <refsynopsisdiv>
20606 <programlisting id="section.title.level2.properties.frag">
20607 &lt;xsl:attribute-set name="section.title.level2.properties"&gt;
20608   &lt;xsl:attribute name="font-size"&gt;
20609     &lt;xsl:value-of select="$body.font.master * 1.728"&gt;&lt;/xsl:value-of&gt;
20610     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
20611   &lt;/xsl:attribute&gt;
20612 &lt;/xsl:attribute-set&gt;
20613 </programlisting>
20614 </refsynopsisdiv>
20615
20616 <refsection><info><title>Description</title></info>
20617
20618 <para>The properties of level-2 section titles.</para>
20619
20620 </refsection>
20621 </refentry>
20622
20623 <refentry version="5.0" id="section.title.level3.properties">
20624 <refmeta>
20625 <refentrytitle>section.title.level3.properties</refentrytitle>
20626 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20627 </refmeta>
20628 <refnamediv>
20629 <refname>section.title.level3.properties</refname>
20630 <refpurpose>Properties for level-3 section titles</refpurpose>
20631 </refnamediv>
20632
20633 <refsynopsisdiv>
20634 <programlisting id="section.title.level3.properties.frag">
20635 &lt;xsl:attribute-set name="section.title.level3.properties"&gt;
20636   &lt;xsl:attribute name="font-size"&gt;
20637     &lt;xsl:value-of select="$body.font.master * 1.44"&gt;&lt;/xsl:value-of&gt;
20638     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
20639   &lt;/xsl:attribute&gt;
20640 &lt;/xsl:attribute-set&gt;
20641 </programlisting>
20642 </refsynopsisdiv>
20643
20644 <refsection><info><title>Description</title></info>
20645
20646 <para>The properties of level-3 section titles.</para>
20647
20648 </refsection>
20649 </refentry>
20650
20651 <refentry version="5.0" id="section.title.level4.properties">
20652 <refmeta>
20653 <refentrytitle>section.title.level4.properties</refentrytitle>
20654 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20655 </refmeta>
20656 <refnamediv>
20657 <refname>section.title.level4.properties</refname>
20658 <refpurpose>Properties for level-4 section titles</refpurpose>
20659 </refnamediv>
20660
20661 <refsynopsisdiv>
20662 <programlisting id="section.title.level4.properties.frag">
20663 &lt;xsl:attribute-set name="section.title.level4.properties"&gt;
20664   &lt;xsl:attribute name="font-size"&gt;
20665     &lt;xsl:value-of select="$body.font.master * 1.2"&gt;&lt;/xsl:value-of&gt;
20666     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
20667   &lt;/xsl:attribute&gt;
20668 &lt;/xsl:attribute-set&gt;
20669 </programlisting>
20670 </refsynopsisdiv>
20671
20672 <refsection><info><title>Description</title></info>
20673
20674 <para>The properties of level-4 section titles.</para>
20675
20676 </refsection>
20677 </refentry>
20678
20679 <refentry version="5.0" id="section.title.level5.properties">
20680 <refmeta>
20681 <refentrytitle>section.title.level5.properties</refentrytitle>
20682 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20683 </refmeta>
20684 <refnamediv>
20685 <refname>section.title.level5.properties</refname>
20686 <refpurpose>Properties for level-5 section titles</refpurpose>
20687 </refnamediv>
20688
20689 <refsynopsisdiv>
20690 <programlisting id="section.title.level5.properties.frag">
20691 &lt;xsl:attribute-set name="section.title.level5.properties"&gt;
20692   &lt;xsl:attribute name="font-size"&gt;
20693     &lt;xsl:value-of select="$body.font.master"&gt;&lt;/xsl:value-of&gt;
20694     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
20695   &lt;/xsl:attribute&gt;
20696 &lt;/xsl:attribute-set&gt;
20697 </programlisting>
20698 </refsynopsisdiv>
20699
20700 <refsection><info><title>Description</title></info>
20701
20702 <para>The properties of level-5 section titles.</para>
20703
20704 </refsection>
20705 </refentry>
20706
20707 <refentry version="5.0" id="section.title.level6.properties">
20708 <refmeta>
20709 <refentrytitle>section.title.level6.properties</refentrytitle>
20710 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20711 </refmeta>
20712 <refnamediv>
20713 <refname>section.title.level6.properties</refname>
20714 <refpurpose>Properties for level-6 section titles</refpurpose>
20715 </refnamediv>
20716
20717 <refsynopsisdiv>
20718 <programlisting id="section.title.level6.properties.frag">
20719 &lt;xsl:attribute-set name="section.title.level6.properties"&gt;
20720   &lt;xsl:attribute name="font-size"&gt;
20721     &lt;xsl:value-of select="$body.font.master"&gt;&lt;/xsl:value-of&gt;
20722     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
20723   &lt;/xsl:attribute&gt;
20724 &lt;/xsl:attribute-set&gt;
20725 </programlisting>
20726 </refsynopsisdiv>
20727
20728 <refsection><info><title>Description</title></info>
20729
20730 <para>The properties of level-6 section titles. This property set is actually
20731 used for all titles below level 5.</para>
20732
20733 </refsection>
20734 </refentry>
20735
20736 <refentry version="5.0" id="section.properties">
20737 <refmeta>
20738 <refentrytitle>section.properties</refentrytitle>
20739 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20740 </refmeta>
20741 <refnamediv>
20742 <refname>section.properties</refname>
20743 <refpurpose>Properties for all section levels</refpurpose>
20744 </refnamediv>
20745
20746 <refsynopsisdiv>
20747 <programlisting id="section.properties.frag">
20748 &lt;xsl:attribute-set name="section.properties"&gt;
20749 &lt;/xsl:attribute-set&gt;
20750 </programlisting>
20751 </refsynopsisdiv>
20752
20753 <refsection><info><title>Description</title></info>
20754
20755 <para>The properties that apply to the containing
20756 block of all section levels, and therefore apply to
20757 the whole section.  
20758 This attribute set is inherited by the
20759 more specific attribute sets such as
20760 <tag>section.level1.properties</tag>.
20761 The default is empty.
20762 </para>
20763
20764 </refsection>
20765 </refentry>
20766
20767 <refentry version="5.0" id="section.level1.properties">
20768 <refmeta>
20769 <refentrytitle>section.level1.properties</refentrytitle>
20770 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20771 </refmeta>
20772 <refnamediv>
20773 <refname>section.level1.properties</refname>
20774 <refpurpose>Properties for level-1 sections</refpurpose>
20775 </refnamediv>
20776
20777 <refsynopsisdiv>
20778 <programlisting id="section.level1.properties.frag">
20779 &lt;xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties"&gt;
20780 &lt;/xsl:attribute-set&gt;
20781 </programlisting>
20782 </refsynopsisdiv>
20783
20784 <refsection><info><title>Description</title></info>
20785
20786 <para>The properties that apply to the containing
20787 block of a level-1 section, and therefore apply to
20788 the whole section.  This includes <tag>sect1</tag>
20789 elements and <tag>section</tag> elements at level 1.
20790 </para>
20791
20792 <para>For example, you could start each level-1 section on
20793 a new page by using:</para>
20794 <programlisting>&lt;xsl:attribute-set name="section.level1.properties"&gt;
20795   &lt;xsl:attribute name="break-before"&gt;page&lt;/xsl:attribute&gt;
20796 &lt;/xsl:attribute-set&gt;
20797 </programlisting>
20798
20799 <para>This attribute set inherits attributes from the
20800 general <tag>section.properties</tag> attribute set.
20801 </para>
20802
20803 </refsection>
20804 </refentry>
20805
20806 <refentry version="5.0" id="section.level2.properties">
20807 <refmeta>
20808 <refentrytitle>section.level2.properties</refentrytitle>
20809 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20810 </refmeta>
20811 <refnamediv>
20812 <refname>section.level2.properties</refname>
20813 <refpurpose>Properties for level-2 sections</refpurpose>
20814 </refnamediv>
20815
20816 <refsynopsisdiv>
20817 <programlisting id="section.level2.properties.frag">
20818 &lt;xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties"&gt;
20819 &lt;/xsl:attribute-set&gt;
20820 </programlisting>
20821 </refsynopsisdiv>
20822
20823 <refsection><info><title>Description</title></info>
20824
20825 <para>The properties that apply to the containing
20826 block of a level-2 section, and therefore apply to
20827 the whole section.  This includes <tag>sect2</tag>
20828 elements and <tag>section</tag> elements at level 2.
20829 </para>
20830
20831 <para>For example, you could start each level-2 section on
20832 a new page by using:</para>
20833 <programlisting>&lt;xsl:attribute-set name="section.level2.properties"&gt;
20834   &lt;xsl:attribute name="break-before"&gt;page&lt;/xsl:attribute&gt;
20835 &lt;/xsl:attribute-set&gt;
20836 </programlisting>
20837
20838 <para>This attribute set inherits attributes from the
20839 general <tag>section.properties</tag> attribute set.
20840 </para>
20841
20842 </refsection>
20843 </refentry>
20844
20845 <refentry version="5.0" id="section.level3.properties">
20846 <refmeta>
20847 <refentrytitle>section.level3.properties</refentrytitle>
20848 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20849 </refmeta>
20850 <refnamediv>
20851 <refname>section.level3.properties</refname>
20852 <refpurpose>Properties for level-3 sections</refpurpose>
20853 </refnamediv>
20854
20855 <refsynopsisdiv>
20856 <programlisting id="section.level3.properties.frag">
20857 &lt;xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties"&gt;
20858 &lt;/xsl:attribute-set&gt;
20859 </programlisting>
20860 </refsynopsisdiv>
20861
20862 <refsection><info><title>Description</title></info>
20863
20864 <para>The properties that apply to the containing
20865 block of a level-3 section, and therefore apply to
20866 the whole section.  This includes <tag>sect3</tag>
20867 elements and <tag>section</tag> elements at level 3.
20868 </para>
20869
20870 <para>For example, you could start each level-3 section on
20871 a new page by using:</para>
20872 <programlisting>&lt;xsl:attribute-set name="section.level3.properties"&gt;
20873   &lt;xsl:attribute name="break-before"&gt;page&lt;/xsl:attribute&gt;
20874 &lt;/xsl:attribute-set&gt;
20875 </programlisting>
20876
20877 <para>This attribute set inherits attributes from the
20878 general <tag>section.properties</tag> attribute set.
20879 </para>
20880
20881 </refsection>
20882 </refentry>
20883
20884 <refentry version="5.0" id="section.level4.properties">
20885 <refmeta>
20886 <refentrytitle>section.level4.properties</refentrytitle>
20887 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20888 </refmeta>
20889 <refnamediv>
20890 <refname>section.level4.properties</refname>
20891 <refpurpose>Properties for level-4 sections</refpurpose>
20892 </refnamediv>
20893
20894 <refsynopsisdiv>
20895 <programlisting id="section.level4.properties.frag">
20896 &lt;xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties"&gt;
20897 &lt;/xsl:attribute-set&gt;
20898 </programlisting>
20899 </refsynopsisdiv>
20900
20901 <refsection><info><title>Description</title></info>
20902
20903 <para>The properties that apply to the containing
20904 block of a level-4 section, and therefore apply to
20905 the whole section.  This includes <tag>sect4</tag>
20906 elements and <tag>section</tag> elements at level 4.
20907 </para>
20908
20909 <para>For example, you could start each level-4 section on
20910 a new page by using:</para>
20911 <programlisting>&lt;xsl:attribute-set name="section.level4.properties"&gt;
20912   &lt;xsl:attribute name="break-before"&gt;page&lt;/xsl:attribute&gt;
20913 &lt;/xsl:attribute-set&gt;
20914 </programlisting>
20915
20916 <para>This attribute set inherits attributes from the
20917 general <tag>section.properties</tag> attribute set.
20918 </para>
20919
20920 </refsection>
20921 </refentry>
20922
20923 <refentry version="5.0" id="section.level5.properties">
20924 <refmeta>
20925 <refentrytitle>section.level5.properties</refentrytitle>
20926 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20927 </refmeta>
20928 <refnamediv>
20929 <refname>section.level5.properties</refname>
20930 <refpurpose>Properties for level-5 sections</refpurpose>
20931 </refnamediv>
20932
20933 <refsynopsisdiv>
20934 <programlisting id="section.level5.properties.frag">
20935 &lt;xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties"&gt;
20936 &lt;/xsl:attribute-set&gt;
20937 </programlisting>
20938 </refsynopsisdiv>
20939
20940 <refsection><info><title>Description</title></info>
20941
20942 <para>The properties that apply to the containing
20943 block of a level-5 section, and therefore apply to
20944 the whole section.  This includes <tag>sect5</tag>
20945 elements and <tag>section</tag> elements at level 5.
20946 </para>
20947
20948 <para>For example, you could start each level-5 section on
20949 a new page by using:</para>
20950 <programlisting>&lt;xsl:attribute-set name="section.level5.properties"&gt;
20951   &lt;xsl:attribute name="break-before"&gt;page&lt;/xsl:attribute&gt;
20952 &lt;/xsl:attribute-set&gt;
20953 </programlisting>
20954
20955 <para>This attribute set inherits attributes from the
20956 general <tag>section.properties</tag> attribute set.
20957 </para>
20958
20959 </refsection>
20960 </refentry>
20961
20962 <refentry version="5.0" id="section.level6.properties">
20963 <refmeta>
20964 <refentrytitle>section.level6.properties</refentrytitle>
20965 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20966 </refmeta>
20967 <refnamediv>
20968 <refname>section.level6.properties</refname>
20969 <refpurpose>Properties for level-6 sections</refpurpose>
20970 </refnamediv>
20971
20972 <refsynopsisdiv>
20973 <programlisting id="section.level6.properties.frag">
20974 &lt;xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties"&gt;
20975 &lt;/xsl:attribute-set&gt;
20976 </programlisting>
20977 </refsynopsisdiv>
20978
20979 <refsection><info><title>Description</title></info>
20980
20981 <para>The properties that apply to the containing
20982 block of a level 6 or lower section, and therefore apply to
20983 the whole section.  This includes 
20984 <tag>section</tag> elements at level 6 and lower.
20985 </para>
20986
20987 <para>For example, you could start each level-6 section on
20988 a new page by using:</para>
20989 <programlisting>&lt;xsl:attribute-set name="section.level6.properties"&gt;
20990   &lt;xsl:attribute name="break-before"&gt;page&lt;/xsl:attribute&gt;
20991 &lt;/xsl:attribute-set&gt;
20992 </programlisting>
20993
20994 <para>This attribute set inherits attributes from the
20995 general <tag>section.properties</tag> attribute set.
20996 </para>
20997
20998 </refsection>
20999 </refentry>
21000
21001 <refentry version="5.0" id="figure.properties">
21002 <refmeta>
21003 <refentrytitle>figure.properties</refentrytitle>
21004 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21005 </refmeta>  
21006 <refnamediv>
21007 <refname>figure.properties</refname>
21008 <refpurpose>Properties associated with a figure</refpurpose>
21009 </refnamediv>
21010
21011 <refsynopsisdiv>
21012 <programlisting id="figure.properties.frag">
21013 &lt;xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21014 </programlisting>
21015 </refsynopsisdiv>
21016
21017 <refsection><info><title>Description</title></info>
21018
21019 <para>The styling for figures.</para>
21020
21021 </refsection>
21022 </refentry>
21023
21024 <refentry version="5.0" id="example.properties">
21025 <refmeta>
21026 <refentrytitle>example.properties</refentrytitle>
21027 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21028 </refmeta>
21029 <refnamediv>
21030 <refname>example.properties</refname>
21031 <refpurpose>Properties associated with a example</refpurpose>
21032 </refnamediv>
21033
21034 <refsynopsisdiv>
21035 <programlisting id="example.properties.frag">
21036 &lt;xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21037 </programlisting>
21038 </refsynopsisdiv>
21039
21040 <refsection><info><title>Description</title></info>
21041
21042 <para>The styling for examples.</para>
21043
21044 </refsection>
21045 </refentry>
21046
21047 <refentry version="5.0" id="equation.properties">
21048 <refmeta>
21049 <refentrytitle>equation.properties</refentrytitle>
21050 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21051 </refmeta>
21052 <refnamediv>
21053 <refname>equation.properties</refname>
21054 <refpurpose>Properties associated with a equation</refpurpose>
21055 </refnamediv>
21056
21057 <refsynopsisdiv>
21058 <programlisting id="equation.properties.frag">
21059 &lt;xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21060 </programlisting>
21061 </refsynopsisdiv>
21062
21063 <refsection><info><title>Description</title></info>
21064
21065 <para>The styling for equations.</para>
21066
21067 </refsection>
21068 </refentry>
21069
21070 <refentry version="5.0" id="equation.number.properties">
21071 <refmeta>
21072 <refentrytitle>equation.number.properties</refentrytitle>
21073 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21074 </refmeta>
21075 <refnamediv>
21076 <refname>equation.number.properties</refname>
21077 <refpurpose>Properties that apply to the <tag>fo:table-cell</tag> containing the number
21078 of an <tag>equation</tag> that does not have a title.</refpurpose>
21079 </refnamediv>
21080
21081 <refsynopsisdiv>
21082 <programlisting id="equation.number.properties.frag">&lt;xsl:attribute-set name="equation.number.properties"&gt;
21083   &lt;xsl:attribute name="text-align"&gt;end&lt;/xsl:attribute&gt;
21084   &lt;xsl:attribute name="display-align"&gt;center&lt;/xsl:attribute&gt;
21085 &lt;/xsl:attribute-set&gt;</programlisting>
21086 </refsynopsisdiv>
21087 <refsection><info><title>Description</title></info>
21088 <para>Properties that apply to the fo:table-cell containing the number
21089 of an equation when it has no title. The number in an equation with a
21090 title is formatted along with the title, and this attribute-set does not apply.</para>
21091 </refsection>
21092 </refentry>
21093
21094 <refentry version="5.0" id="table.properties">
21095 <refmeta>
21096 <refentrytitle>table.properties</refentrytitle>
21097 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21098 </refmeta>
21099 <refnamediv>
21100 <refname>table.properties</refname>
21101 <refpurpose>Properties associated with the block surrounding a table</refpurpose>
21102 </refnamediv>
21103
21104 <refsynopsisdiv>
21105 <programlisting id="table.properties.frag">
21106 &lt;xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties"&gt;
21107   &lt;xsl:attribute name="keep-together.within-column"&gt;auto&lt;/xsl:attribute&gt;
21108 &lt;/xsl:attribute-set&gt;
21109 </programlisting>
21110 </refsynopsisdiv>
21111
21112 <refsection><info><title>Description</title></info>
21113
21114 <para>Block styling properties for tables. This parameter should really
21115 have been called <literal>table.block.properties</literal> or something
21116 like that, but we&#8217;re leaving it to avoid backwards-compatibility
21117 problems.</para>
21118
21119 <para>See also <parameter>table.table.properties</parameter>.</para>
21120
21121 </refsection>
21122 </refentry>
21123
21124 <refentry version="5.0" id="informalfigure.properties">
21125 <refmeta>
21126 <refentrytitle>informalfigure.properties</refentrytitle>
21127 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21128 </refmeta>
21129 <refnamediv>
21130 <refname>informalfigure.properties</refname>
21131 <refpurpose>Properties associated with an informalfigure</refpurpose>
21132 </refnamediv>
21133
21134 <refsynopsisdiv>
21135 <programlisting id="informalfigure.properties.frag">
21136 &lt;xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21137 </programlisting>
21138 </refsynopsisdiv>
21139
21140 <refsection><info><title>Description</title></info>
21141
21142 <para>The styling for informalfigures.</para>
21143
21144 </refsection>
21145 </refentry>
21146
21147 <refentry version="5.0" id="informalexample.properties">
21148 <refmeta>
21149 <refentrytitle>informalexample.properties</refentrytitle>
21150 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21151 </refmeta>
21152 <refnamediv>
21153 <refname>informalexample.properties</refname>
21154 <refpurpose>Properties associated with an informalexample</refpurpose>
21155 </refnamediv>
21156
21157 <refsynopsisdiv>
21158 <programlisting id="informalexample.properties.frag">
21159 &lt;xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21160 </programlisting>
21161 </refsynopsisdiv>
21162
21163 <refsection><info><title>Description</title></info>
21164
21165 <para>The styling for informalexamples.</para>
21166
21167 </refsection>
21168 </refentry>
21169
21170 <refentry version="5.0" id="informalequation.properties">
21171 <refmeta>
21172 <refentrytitle>informalequation.properties</refentrytitle>
21173 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21174 </refmeta>
21175 <refnamediv>
21176 <refname>informalequation.properties</refname>
21177 <refpurpose>Properties associated with an informalequation</refpurpose>
21178 </refnamediv>
21179
21180 <refsynopsisdiv>
21181 <programlisting id="informalequation.properties.frag">
21182 &lt;xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21183 </programlisting>
21184 </refsynopsisdiv>
21185
21186 <refsection><info><title>Description</title></info>
21187
21188 <para>The styling for informalequations.</para>
21189
21190 </refsection>
21191 </refentry>
21192
21193 <refentry version="5.0" id="informaltable.properties">
21194 <refmeta>
21195 <refentrytitle>informaltable.properties</refentrytitle>
21196 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21197 </refmeta>
21198 <refnamediv>
21199 <refname>informaltable.properties</refname>
21200 <refpurpose>Properties associated with the block surrounding an informaltable</refpurpose>
21201 </refnamediv>
21202
21203 <refsynopsisdiv>
21204 <programlisting id="informaltable.properties.frag">
21205 &lt;xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"&gt;&lt;/xsl:attribute-set&gt;
21206 </programlisting>
21207 </refsynopsisdiv>
21208
21209 <refsection><info><title>Description</title></info>
21210
21211 <para>Block styling properties for informaltables. This parameter should really
21212 have been called <literal>informaltable.block.properties</literal> or something
21213 like that, but we&#8217;re leaving it to avoid backwards-compatibility
21214 problems.</para>
21215
21216 <para>See also <parameter>table.table.properties</parameter>.</para>
21217
21218 </refsection>
21219 </refentry>
21220
21221 <refentry version="5.0" id="procedure.properties">
21222 <refmeta>
21223 <refentrytitle>procedure.properties</refentrytitle>
21224 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21225 </refmeta>
21226 <refnamediv>
21227 <refname>procedure.properties</refname>
21228 <refpurpose>Properties associated with a procedure</refpurpose>
21229 </refnamediv>
21230
21231 <refsynopsisdiv>
21232 <programlisting id="procedure.properties.frag">
21233 &lt;xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties"&gt;
21234   &lt;xsl:attribute name="keep-together.within-column"&gt;auto&lt;/xsl:attribute&gt;
21235 &lt;/xsl:attribute-set&gt;
21236 </programlisting>
21237 </refsynopsisdiv>
21238
21239 <refsection><info><title>Description</title></info>
21240
21241 <para>The styling for procedures.</para>
21242
21243 </refsection>
21244 </refentry>
21245
21246 <refentry version="5.0" id="root.properties">
21247 <refmeta>
21248 <refentrytitle>root.properties</refentrytitle>
21249 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21250 </refmeta>
21251 <refnamediv>
21252 <refname>root.properties</refname>
21253 <refpurpose>The properties of the fo:root element</refpurpose>
21254 </refnamediv>
21255
21256 <refsynopsisdiv>
21257 <programlisting id="root.properties.frag">
21258 &lt;xsl:attribute-set name="root.properties"&gt;
21259   &lt;xsl:attribute name="font-family"&gt;
21260     &lt;xsl:value-of select="$body.fontset"&gt;&lt;/xsl:value-of&gt;
21261   &lt;/xsl:attribute&gt;
21262   &lt;xsl:attribute name="font-size"&gt;
21263     &lt;xsl:value-of select="$body.font.size"&gt;&lt;/xsl:value-of&gt;
21264   &lt;/xsl:attribute&gt;
21265   &lt;xsl:attribute name="text-align"&gt;
21266     &lt;xsl:value-of select="$alignment"&gt;&lt;/xsl:value-of&gt;
21267   &lt;/xsl:attribute&gt;
21268   &lt;xsl:attribute name="line-height"&gt;
21269     &lt;xsl:value-of select="$line-height"&gt;&lt;/xsl:value-of&gt;
21270   &lt;/xsl:attribute&gt;
21271   &lt;xsl:attribute name="font-selection-strategy"&gt;character-by-character&lt;/xsl:attribute&gt;
21272   &lt;xsl:attribute name="line-height-shift-adjustment"&gt;disregard-shifts&lt;/xsl:attribute&gt;
21273   &lt;xsl:attribute name="writing-mode"&gt;
21274     &lt;xsl:value-of select="$direction.mode"&gt;&lt;/xsl:value-of&gt;
21275   &lt;/xsl:attribute&gt;
21276 &lt;/xsl:attribute-set&gt;
21277 </programlisting>
21278 </refsynopsisdiv>
21279
21280 <refsection><info><title>Description</title></info>
21281
21282 <para>This property set is used on the <tag>fo:root</tag> element of
21283 an FO file. It defines a set of default, global parameters.</para>
21284
21285 </refsection>
21286 </refentry>
21287
21288 <refentry version="5.0" id="qanda.title.properties">
21289 <refmeta>
21290 <refentrytitle>qanda.title.properties</refentrytitle>
21291 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21292 </refmeta>
21293 <refnamediv>
21294 <refname>qanda.title.properties</refname>
21295 <refpurpose>Properties for qanda set titles</refpurpose>
21296 </refnamediv>
21297
21298 <refsynopsisdiv>
21299 <programlisting id="qanda.title.properties.frag">
21300 &lt;xsl:attribute-set name="qanda.title.properties"&gt;
21301   &lt;xsl:attribute name="font-family"&gt;
21302     &lt;xsl:value-of select="$title.font.family"&gt;&lt;/xsl:value-of&gt;
21303   &lt;/xsl:attribute&gt;
21304   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
21305   &lt;!-- font size is calculated dynamically by qanda.heading template --&gt;
21306   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
21307   &lt;xsl:attribute name="space-before.minimum"&gt;0.8em&lt;/xsl:attribute&gt;
21308   &lt;xsl:attribute name="space-before.optimum"&gt;1.0em&lt;/xsl:attribute&gt;
21309   &lt;xsl:attribute name="space-before.maximum"&gt;1.2em&lt;/xsl:attribute&gt;
21310 &lt;/xsl:attribute-set&gt;
21311 </programlisting>
21312 </refsynopsisdiv>
21313
21314 <refsection><info><title>Description</title></info>
21315
21316 <para>The properties common to all qanda set titles.</para>
21317
21318 </refsection>
21319 </refentry>
21320
21321 <refentry version="5.0" id="qanda.title.level1.properties">
21322 <refmeta>
21323 <refentrytitle>qanda.title.level1.properties</refentrytitle>
21324 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21325 </refmeta>
21326 <refnamediv>
21327 <refname>qanda.title.level1.properties</refname>
21328 <refpurpose>Properties for level-1 qanda set titles</refpurpose>
21329 </refnamediv>
21330
21331 <refsynopsisdiv>
21332 <programlisting id="qanda.title.level1.properties.frag">
21333 &lt;xsl:attribute-set name="qanda.title.level1.properties"&gt;
21334   &lt;xsl:attribute name="font-size"&gt;
21335     &lt;xsl:value-of select="$body.font.master * 2.0736"&gt;&lt;/xsl:value-of&gt;
21336     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
21337   &lt;/xsl:attribute&gt;
21338 &lt;/xsl:attribute-set&gt;
21339 </programlisting>
21340 </refsynopsisdiv>
21341
21342 <refsection><info><title>Description</title></info>
21343
21344 <para>The properties of level-1 qanda set titles.</para>
21345
21346 </refsection>
21347 </refentry>
21348
21349 <refentry version="5.0" id="qanda.title.level2.properties">
21350 <refmeta>
21351 <refentrytitle>qanda.title.level2.properties</refentrytitle>
21352 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21353 </refmeta>
21354 <refnamediv>
21355 <refname>qanda.title.level2.properties</refname>
21356 <refpurpose>Properties for level-2 qanda set titles</refpurpose>
21357 </refnamediv>
21358
21359 <refsynopsisdiv>
21360 <programlisting id="qanda.title.level2.properties.frag">
21361 &lt;xsl:attribute-set name="qanda.title.level2.properties"&gt;
21362   &lt;xsl:attribute name="font-size"&gt;
21363     &lt;xsl:value-of select="$body.font.master * 1.728"&gt;&lt;/xsl:value-of&gt;
21364     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
21365   &lt;/xsl:attribute&gt;
21366 &lt;/xsl:attribute-set&gt;
21367 </programlisting>
21368 </refsynopsisdiv>
21369
21370 <refsection><info><title>Description</title></info>
21371
21372 <para>The properties of level-2 qanda set titles.</para>
21373
21374 </refsection>
21375 </refentry>
21376
21377 <refentry version="5.0" id="qanda.title.level3.properties">
21378 <refmeta>
21379 <refentrytitle>qanda.title.level3.properties</refentrytitle>
21380 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21381 </refmeta>
21382 <refnamediv>
21383 <refname>qanda.title.level3.properties</refname>
21384 <refpurpose>Properties for level-3 qanda set titles</refpurpose>
21385 </refnamediv>
21386
21387 <refsynopsisdiv>
21388 <programlisting id="qanda.title.level3.properties.frag">
21389 &lt;xsl:attribute-set name="qanda.title.level3.properties"&gt;
21390   &lt;xsl:attribute name="font-size"&gt;
21391     &lt;xsl:value-of select="$body.font.master * 1.44"&gt;&lt;/xsl:value-of&gt;
21392     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
21393   &lt;/xsl:attribute&gt;
21394 &lt;/xsl:attribute-set&gt;
21395 </programlisting>
21396 </refsynopsisdiv>
21397
21398 <refsection><info><title>Description</title></info>
21399
21400 <para>The properties of level-3 qanda set titles.</para>
21401
21402 </refsection>
21403 </refentry>
21404
21405 <refentry version="5.0" id="qanda.title.level4.properties">
21406 <refmeta>
21407 <refentrytitle>qanda.title.level4.properties</refentrytitle>
21408 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21409 </refmeta>
21410 <refnamediv>
21411 <refname>qanda.title.level4.properties</refname>
21412 <refpurpose>Properties for level-4 qanda set titles</refpurpose>
21413 </refnamediv>
21414
21415 <refsynopsisdiv>
21416 <programlisting id="qanda.title.level4.properties.frag">
21417 &lt;xsl:attribute-set name="qanda.title.level4.properties"&gt;
21418   &lt;xsl:attribute name="font-size"&gt;
21419     &lt;xsl:value-of select="$body.font.master * 1.2"&gt;&lt;/xsl:value-of&gt;
21420     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
21421   &lt;/xsl:attribute&gt;
21422 &lt;/xsl:attribute-set&gt;
21423 </programlisting>
21424 </refsynopsisdiv>
21425
21426 <refsection><info><title>Description</title></info>
21427
21428 <para>The properties of level-4 qanda set titles.</para>
21429
21430 </refsection>
21431 </refentry>
21432
21433 <refentry version="5.0" id="qanda.title.level5.properties">
21434 <refmeta>
21435 <refentrytitle>qanda.title.level5.properties</refentrytitle>
21436 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21437 </refmeta>
21438 <refnamediv>
21439 <refname>qanda.title.level5.properties</refname>
21440 <refpurpose>Properties for level-5 qanda set titles</refpurpose>
21441 </refnamediv>
21442
21443 <refsynopsisdiv>
21444 <programlisting id="qanda.title.level5.properties.frag">
21445 &lt;xsl:attribute-set name="qanda.title.level5.properties"&gt;
21446   &lt;xsl:attribute name="font-size"&gt;
21447     &lt;xsl:value-of select="$body.font.master"&gt;&lt;/xsl:value-of&gt;
21448     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
21449   &lt;/xsl:attribute&gt;
21450 &lt;/xsl:attribute-set&gt;
21451 </programlisting>
21452 </refsynopsisdiv>
21453
21454 <refsection><info><title>Description</title></info>
21455
21456 <para>The properties of level-5 qanda set titles.</para>
21457
21458 </refsection>
21459 </refentry>
21460
21461 <refentry version="5.0" id="qanda.title.level6.properties">
21462 <refmeta>
21463 <refentrytitle>qanda.title.level6.properties</refentrytitle>
21464 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21465 </refmeta>
21466 <refnamediv>
21467 <refname>qanda.title.level6.properties</refname>
21468 <refpurpose>Properties for level-6 qanda set titles</refpurpose>
21469 </refnamediv>
21470
21471 <refsynopsisdiv>
21472 <programlisting id="qanda.title.level6.properties.frag">
21473 &lt;xsl:attribute-set name="qanda.title.level6.properties"&gt;
21474   &lt;xsl:attribute name="font-size"&gt;
21475     &lt;xsl:value-of select="$body.font.master"&gt;&lt;/xsl:value-of&gt;
21476     &lt;xsl:text&gt;pt&lt;/xsl:text&gt;
21477   &lt;/xsl:attribute&gt;
21478 &lt;/xsl:attribute-set&gt;
21479 </programlisting>
21480 </refsynopsisdiv>
21481
21482 <refsection><info><title>Description</title></info>
21483
21484 <para>The properties of level-6 qanda set titles.
21485 This property set is actually
21486 used for all titles below level 5.</para>
21487
21488 </refsection>
21489 </refentry>
21490
21491 <refentry version="5.0" id="article.appendix.title.properties">
21492 <refmeta>
21493 <refentrytitle>article.appendix.title.properties</refentrytitle>
21494 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21495 </refmeta>
21496 <refnamediv>
21497 <refname>article.appendix.title.properties</refname>
21498 <refpurpose>Properties for appendix titles that appear in an article</refpurpose>
21499 </refnamediv>
21500
21501 <refsynopsisdiv>
21502 <programlisting id="article.appendix.title.properties.frag">
21503 &lt;xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties                          section.title.level1.properties"&gt;
21504   &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;
21505     &lt;xsl:value-of select="$title.margin.left"&gt;&lt;/xsl:value-of&gt;
21506   &lt;/xsl:attribute&gt;
21507 &lt;/xsl:attribute-set&gt;
21508 </programlisting>
21509 </refsynopsisdiv>
21510
21511 <refsection><info><title>Description</title></info>
21512
21513 <para>The properties for the title of an appendix that
21514 appears inside an article.  The default is to use
21515 the properties of sect1 titles.</para>
21516
21517 </refsection>
21518 </refentry>
21519
21520 <refentry version="5.0" id="abstract.properties">
21521 <refmeta>
21522 <refentrytitle>abstract.properties</refentrytitle>
21523 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21524 </refmeta>
21525 <refnamediv>
21526 <refname>abstract.properties</refname>
21527 <refpurpose>Properties associated with the block surrounding an abstract</refpurpose>
21528 </refnamediv>
21529
21530 <refsynopsisdiv>
21531 <programlisting id="abstract.properties.frag">
21532 &lt;xsl:attribute-set name="abstract.properties"&gt;
21533   &lt;xsl:attribute name="start-indent"&gt;0.0in&lt;/xsl:attribute&gt;
21534   &lt;xsl:attribute name="end-indent"&gt;0.0in&lt;/xsl:attribute&gt;
21535 &lt;/xsl:attribute-set&gt;
21536 </programlisting>
21537 </refsynopsisdiv>
21538
21539 <refsection><info><title>Description</title></info>
21540
21541 <para>Block styling properties for abstract.</para>
21542
21543 <para>See also <parameter>abstract.title.properties</parameter>.</para>
21544
21545 </refsection>
21546 </refentry>
21547
21548 <refentry version="5.0" id="abstract.title.properties">
21549 <refmeta>
21550 <refentrytitle>abstract.title.properties</refentrytitle>
21551 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21552 </refmeta>
21553 <refnamediv>
21554 <refname>abstract.title.properties</refname>
21555 <refpurpose>Properties for abstract titles</refpurpose>
21556 </refnamediv>
21557
21558 <refsynopsisdiv>
21559 <programlisting id="abstract.title.properties.frag">
21560 &lt;xsl:attribute-set name="abstract.title.properties"&gt;
21561   &lt;xsl:attribute name="font-family"&gt;&lt;xsl:value-of select="$title.fontset"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
21562   &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
21563   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
21564   &lt;xsl:attribute name="keep-with-next.within-column"&gt;always&lt;/xsl:attribute&gt;
21565   &lt;xsl:attribute name="space-before.optimum"&gt;&lt;xsl:value-of select="concat($body.font.master, 'pt')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
21566   &lt;xsl:attribute name="space-before.minimum"&gt;&lt;xsl:value-of select="concat($body.font.master, 'pt * 0.8')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
21567   &lt;xsl:attribute name="space-before.maximum"&gt;&lt;xsl:value-of select="concat($body.font.master, 'pt * 1.2')"&gt;&lt;/xsl:value-of&gt;&lt;/xsl:attribute&gt;
21568   &lt;xsl:attribute name="hyphenate"&gt;false&lt;/xsl:attribute&gt;
21569   &lt;xsl:attribute name="text-align"&gt;center&lt;/xsl:attribute&gt;
21570 &lt;/xsl:attribute-set&gt;
21571 </programlisting>
21572 </refsynopsisdiv>
21573
21574 <refsection><info><title>Description</title></info>
21575
21576 <para>The properties for abstract titles.</para>
21577
21578 <para>See also <parameter>abstract.properties</parameter>.</para>
21579
21580 </refsection>
21581 </refentry>
21582
21583 <refentry version="5.0" id="index.page.number.properties">
21584 <refmeta>
21585 <refentrytitle>index.page.number.properties</refentrytitle>
21586 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21587 </refmeta>
21588 <refnamediv>
21589 <refname>index.page.number.properties</refname>
21590 <refpurpose>Properties associated with index page numbers</refpurpose>
21591 </refnamediv>
21592
21593 <refsynopsisdiv>
21594 <programlisting id="index.page.number.properties.frag">
21595 &lt;xsl:attribute-set name="index.page.number.properties"&gt;
21596 &lt;/xsl:attribute-set&gt;
21597 </programlisting>
21598 </refsynopsisdiv>
21599
21600 <refsection><info><title>Description</title></info>
21601
21602 <para>Properties associated with page numbers in indexes. 
21603 Changing color to indicate the page number is a link is
21604 one possibility.
21605 </para>
21606
21607 </refsection>
21608 </refentry>
21609
21610 <refentry version="5.0" id="revhistory.table.properties">
21611 <refmeta>
21612 <refentrytitle>revhistory.table.properties</refentrytitle>
21613 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21614 </refmeta>
21615 <refnamediv>
21616 <refname>revhistory.table.properties</refname>
21617 <refpurpose>The properties of table used for formatting revhistory</refpurpose>
21618 </refnamediv>
21619
21620 <refsynopsisdiv>
21621 <programlisting id="revhistory.table.properties.frag">
21622 &lt;xsl:attribute-set name="revhistory.table.properties"&gt;
21623 &lt;/xsl:attribute-set&gt;
21624 </programlisting>
21625 </refsynopsisdiv>
21626
21627 <refsection><info><title>Description</title></info>
21628
21629 <para>This property set defines appearance of revhistory table.</para>
21630
21631 </refsection>
21632 </refentry>
21633
21634 <refentry version="5.0" id="revhistory.table.cell.properties">
21635 <refmeta>
21636 <refentrytitle>revhistory.table.cell.properties</refentrytitle>
21637 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21638 </refmeta>
21639 <refnamediv>
21640 <refname>revhistory.table.cell.properties</refname>
21641 <refpurpose>The properties of table cells used for formatting revhistory</refpurpose>
21642 </refnamediv>
21643
21644 <refsynopsisdiv>
21645 <programlisting id="revhistory.table.cell.properties.frag">
21646 &lt;xsl:attribute-set name="revhistory.table.cell.properties"&gt;
21647 &lt;/xsl:attribute-set&gt;
21648 </programlisting>
21649 </refsynopsisdiv>
21650
21651 <refsection><info><title>Description</title></info>
21652
21653 <para>This property set defines appearance of individual cells in revhistory table.</para>
21654
21655 </refsection>
21656 </refentry>
21657
21658 <refentry version="5.0" id="revhistory.title.properties">
21659 <refmeta>
21660 <refentrytitle>revhistory.title.properties</refentrytitle>
21661 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21662 </refmeta>
21663 <refnamediv>
21664 <refname>revhistory.title.properties</refname>
21665 <refpurpose>The properties of revhistory title</refpurpose>
21666 </refnamediv>
21667
21668 <refsynopsisdiv>
21669 <programlisting id="revhistory.title.properties.frag">
21670 &lt;xsl:attribute-set name="revhistory.title.properties"&gt;
21671 &lt;/xsl:attribute-set&gt;
21672 </programlisting>
21673 </refsynopsisdiv>
21674
21675 <refsection><info><title>Description</title></info>
21676
21677 <para>This property set defines appearance of revhistory title.</para>
21678
21679 </refsection>
21680 </refentry>
21681
21682 </reference><reference id="profiling" xml:base="../fo/param.xml"><title>Profiling</title>
21683 <partintro id="profiling_partintro">
21684 <para>The following parameters can be used for attribute-based
21685 profiling of your document. For more information about profiling, see 
21686 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
21687 </partintro>
21688 <refentry version="5.0" id="profile.arch">
21689 <refmeta>
21690 <refentrytitle>profile.arch</refentrytitle>
21691 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21692 </refmeta>
21693 <refnamediv>
21694 <refname>profile.arch</refname>
21695 <refpurpose>Target profile for <tag class="attribute">arch</tag>
21696 attribute</refpurpose>
21697 </refnamediv>
21698
21699 <refsynopsisdiv>
21700 <programlisting id="profile.arch.frag">
21701 &lt;xsl:param name="profile.arch"&gt;&lt;/xsl:param&gt;
21702 </programlisting>
21703 </refsynopsisdiv>
21704
21705
21706 <refsection><info><title>Description</title></info>
21707
21708 <para>The value of this parameter specifies profiles which should be
21709 included in the output. You can specify multiple profiles by
21710 separating them by semicolon. You can change separator character by
21711 <parameter>profile.separator</parameter>
21712 parameter.</para>
21713
21714 <para>This parameter has effect only when you are using profiling
21715 stylesheets (<filename>profile-docbook.xsl</filename>,
21716 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21717 ones (<filename>docbook.xsl</filename>,
21718 <filename>chunk.xsl</filename>, &#8230;).</para>
21719
21720 </refsection>
21721 </refentry>
21722
21723 <refentry version="5.0" id="profile.audience">
21724 <refmeta>
21725 <refentrytitle>profile.audience</refentrytitle>
21726 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21727 </refmeta>
21728 <refnamediv>
21729 <refname>profile.audience</refname>
21730 <refpurpose>Target profile for <tag class="attribute">audience</tag>
21731 attribute</refpurpose>
21732 </refnamediv>
21733
21734 <refsynopsisdiv>
21735 <programlisting id="profile.audience.frag">
21736 &lt;xsl:param name="profile.audience"&gt;&lt;/xsl:param&gt;
21737 </programlisting>
21738 </refsynopsisdiv>
21739
21740 <refsection><info><title>Description</title></info>
21741
21742 <para>Value of this parameter specifies profiles which should be
21743 included in the output. You can specify multiple profiles by
21744 separating them by semicolon. You can change separator character by
21745 <parameter>profile.separator</parameter>
21746 parameter.</para>
21747
21748 <para>This parameter has effect only when you are using profiling
21749 stylesheets (<filename>profile-docbook.xsl</filename>,
21750 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21751 ones (<filename>docbook.xsl</filename>,
21752 <filename>chunk.xsl</filename>, &#8230;).</para>
21753
21754 </refsection>
21755 </refentry>
21756
21757 <refentry version="5.0" id="profile.condition">
21758 <refmeta>
21759 <refentrytitle>profile.condition</refentrytitle>
21760 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21761 </refmeta>
21762 <refnamediv>
21763 <refname>profile.condition</refname>
21764 <refpurpose>Target profile for <tag class="attribute">condition</tag>
21765 attribute</refpurpose>
21766 </refnamediv>
21767
21768 <refsynopsisdiv>
21769 <programlisting id="profile.condition.frag">
21770 &lt;xsl:param name="profile.condition"&gt;&lt;/xsl:param&gt;
21771 </programlisting>
21772 </refsynopsisdiv>
21773
21774 <refsection><info><title>Description</title></info>
21775
21776 <para>The value of this parameter specifies profiles which should be
21777 included in the output. You can specify multiple profiles by
21778 separating them by semicolon. You can change separator character by
21779 <parameter>profile.separator</parameter>
21780 parameter.</para>
21781
21782 <para>This parameter has effect only when you are using profiling
21783 stylesheets (<filename>profile-docbook.xsl</filename>,
21784 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21785 ones (<filename>docbook.xsl</filename>,
21786 <filename>chunk.xsl</filename>, &#8230;).</para>
21787
21788 </refsection>
21789 </refentry>
21790
21791 <refentry version="5.0" id="profile.conformance">
21792 <refmeta>
21793 <refentrytitle>profile.conformance</refentrytitle>
21794 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21795 </refmeta>
21796 <refnamediv>
21797 <refname>profile.conformance</refname>
21798 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
21799 attribute</refpurpose>
21800 </refnamediv>
21801
21802 <refsynopsisdiv>
21803 <programlisting id="profile.conformance.frag">
21804 &lt;xsl:param name="profile.conformance"&gt;&lt;/xsl:param&gt;
21805 </programlisting>
21806 </refsynopsisdiv>
21807
21808 <refsection><info><title>Description</title></info>
21809
21810 <para>The value of this parameter specifies profiles which should be
21811 included in the output. You can specify multiple profiles by
21812 separating them by semicolon. You can change separator character by
21813 <parameter>profile.separator</parameter>
21814 parameter.</para>
21815
21816 <para>This parameter has effect only when you are using profiling
21817 stylesheets (<filename>profile-docbook.xsl</filename>,
21818 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21819 ones (<filename>docbook.xsl</filename>,
21820 <filename>chunk.xsl</filename>, &#8230;).</para>
21821
21822 </refsection>
21823 </refentry>
21824
21825 <refentry version="5.0" id="profile.lang">
21826 <refmeta>
21827 <refentrytitle>profile.lang</refentrytitle>
21828 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21829 </refmeta>
21830 <refnamediv>
21831 <refname>profile.lang</refname>
21832 <refpurpose>Target profile for <tag class="attribute">lang</tag>
21833 attribute</refpurpose>
21834 </refnamediv>
21835
21836 <refsynopsisdiv>
21837 <programlisting id="profile.lang.frag">
21838 &lt;xsl:param name="profile.lang"&gt;&lt;/xsl:param&gt;
21839 </programlisting>
21840 </refsynopsisdiv>
21841
21842 <refsection><info><title>Description</title></info>
21843
21844 <para>The value of this parameter specifies profiles which should be
21845 included in the output. You can specify multiple profiles by
21846 separating them by semicolon. You can change separator character by
21847 <parameter>profile.separator</parameter>
21848 parameter.</para>
21849
21850 <para>This parameter has effect only when you are using profiling
21851 stylesheets (<filename>profile-docbook.xsl</filename>,
21852 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21853 ones (<filename>docbook.xsl</filename>,
21854 <filename>chunk.xsl</filename>, &#8230;).</para>
21855
21856 </refsection>
21857 </refentry>
21858
21859 <refentry version="5.0" id="profile.os">
21860 <refmeta>
21861 <refentrytitle>profile.os</refentrytitle>
21862 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21863 </refmeta>
21864 <refnamediv>
21865 <refname>profile.os</refname>
21866 <refpurpose>Target profile for <tag class="attribute">os</tag>
21867 attribute</refpurpose>
21868 </refnamediv>
21869
21870 <refsynopsisdiv>
21871 <programlisting id="profile.os.frag">
21872 &lt;xsl:param name="profile.os"&gt;&lt;/xsl:param&gt;
21873 </programlisting>
21874 </refsynopsisdiv>
21875
21876 <refsection><info><title>Description</title></info>
21877
21878 <para>The value of this parameter specifies profiles which should be
21879 included in the output. You can specify multiple profiles by
21880 separating them by semicolon. You can change separator character by
21881 <parameter>profile.separator</parameter>
21882 parameter.</para>
21883
21884 <para>This parameter has effect only when you are using profiling
21885 stylesheets (<filename>profile-docbook.xsl</filename>,
21886 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21887 ones (<filename>docbook.xsl</filename>,
21888 <filename>chunk.xsl</filename>, &#8230;).</para>
21889
21890 </refsection>
21891 </refentry>
21892
21893 <refentry version="5.0" id="profile.revision">
21894 <refmeta>
21895 <refentrytitle>profile.revision</refentrytitle>
21896 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21897 </refmeta>
21898 <refnamediv>
21899 <refname>profile.revision</refname>
21900 <refpurpose>Target profile for <tag class="attribute">revision</tag>
21901 attribute</refpurpose>
21902 </refnamediv>
21903
21904 <refsynopsisdiv>
21905 <programlisting id="profile.revision.frag">
21906 &lt;xsl:param name="profile.revision"&gt;&lt;/xsl:param&gt;
21907 </programlisting>
21908 </refsynopsisdiv>
21909
21910 <refsection><info><title>Description</title></info>
21911
21912 <para>The value of this parameter specifies profiles which should be
21913 included in the output. You can specify multiple profiles by
21914 separating them by semicolon. You can change separator character by
21915 <parameter>profile.separator</parameter>
21916 parameter.</para>
21917
21918 <para>This parameter has effect only when you are using profiling
21919 stylesheets (<filename>profile-docbook.xsl</filename>,
21920 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21921 ones (<filename>docbook.xsl</filename>,
21922 <filename>chunk.xsl</filename>, &#8230;).</para>
21923
21924 </refsection>
21925 </refentry>
21926
21927 <refentry version="5.0" id="profile.revisionflag">
21928 <refmeta>
21929 <refentrytitle>profile.revisionflag</refentrytitle>
21930 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21931 </refmeta>
21932 <refnamediv>
21933 <refname>profile.revisionflag</refname>
21934 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
21935 attribute</refpurpose>
21936 </refnamediv>
21937
21938 <refsynopsisdiv>
21939 <programlisting id="profile.revisionflag.frag">
21940 &lt;xsl:param name="profile.revisionflag"&gt;&lt;/xsl:param&gt;
21941 </programlisting>
21942 </refsynopsisdiv>
21943
21944 <refsection><info><title>Description</title></info>
21945
21946 <para>The value of this parameter specifies profiles which should be
21947 included in the output. You can specify multiple profiles by
21948 separating them by semicolon. You can change separator character by
21949 <parameter>profile.separator</parameter>
21950 parameter.</para>
21951
21952 <para>This parameter has effect only when you are using profiling
21953 stylesheets (<filename>profile-docbook.xsl</filename>,
21954 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21955 ones (<filename>docbook.xsl</filename>,
21956 <filename>chunk.xsl</filename>, &#8230;).</para>
21957
21958 </refsection>
21959 </refentry>
21960
21961 <refentry version="5.0" id="profile.role">
21962 <refmeta>
21963 <refentrytitle>profile.role</refentrytitle>
21964 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21965 </refmeta>
21966 <refnamediv>
21967 <refname>profile.role</refname>
21968 <refpurpose>Target profile for <tag class="attribute">role</tag>
21969 attribute</refpurpose>
21970 </refnamediv>
21971
21972 <refsynopsisdiv>
21973 <programlisting id="profile.role.frag">
21974 &lt;xsl:param name="profile.role"&gt;&lt;/xsl:param&gt;
21975 </programlisting>
21976 </refsynopsisdiv>
21977
21978 <refsection><info><title>Description</title></info>
21979
21980 <para>The value of this parameter specifies profiles which should be
21981 included in the output. You can specify multiple profiles by
21982 separating them by semicolon. You can change separator character by
21983 <parameter>profile.separator</parameter>
21984 parameter.</para>
21985
21986 <para>This parameter has effect only when you are using profiling
21987 stylesheets (<filename>profile-docbook.xsl</filename>,
21988 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
21989 ones (<filename>docbook.xsl</filename>,
21990 <filename>chunk.xsl</filename>, &#8230;).</para>
21991
21992 <warning>
21993 <para>Note that <tag class="attribute">role</tag> is often
21994 used for other purposes than profiling. For example it is commonly
21995 used to get emphasize in bold font:</para>
21996
21997 <programlisting>&lt;emphasis role="bold"&gt;very important&lt;/emphasis&gt;</programlisting>
21998
21999 <para>If you are using <tag class="attribute">role</tag> for
22000 these purposes do not forget to add values like <literal>bold</literal> to
22001 value of this parameter. If you forgot you will get document with
22002 small pieces missing which are very hard to track.</para>
22003
22004 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
22005 rather use profiling specific attributes like <tag class="attribute">userlevel</tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag class="attribute">condition</tag>, etc.</para>
22006 </warning>
22007
22008 </refsection>
22009 </refentry>
22010
22011 <refentry version="5.0" id="profile.security">
22012 <refmeta>
22013 <refentrytitle>profile.security</refentrytitle>
22014 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22015 </refmeta>
22016 <refnamediv>
22017 <refname>profile.security</refname>
22018 <refpurpose>Target profile for <tag class="attribute">security</tag>
22019 attribute</refpurpose>
22020 </refnamediv>
22021
22022 <refsynopsisdiv>
22023 <programlisting id="profile.security.frag">
22024 &lt;xsl:param name="profile.security"&gt;&lt;/xsl:param&gt;
22025 </programlisting>
22026 </refsynopsisdiv>
22027
22028 <refsection><info><title>Description</title></info>
22029
22030 <para>The value of this parameter specifies profiles which should be
22031 included in the output. You can specify multiple profiles by
22032 separating them by semicolon. You can change separator character by
22033 <parameter>profile.separator</parameter>
22034 parameter.</para>
22035
22036 <para>This parameter has effect only when you are using profiling
22037 stylesheets (<filename>profile-docbook.xsl</filename>,
22038 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22039 ones (<filename>docbook.xsl</filename>,
22040 <filename>chunk.xsl</filename>, &#8230;).</para>
22041
22042 </refsection>
22043 </refentry>
22044
22045 <refentry version="5.0" id="profile.status">
22046 <refmeta>
22047 <refentrytitle>profile.status</refentrytitle>
22048 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22049 </refmeta>
22050 <refnamediv>
22051 <refname>profile.status</refname>
22052 <refpurpose>Target profile for <tag class="attribute">status</tag>
22053 attribute</refpurpose>
22054 </refnamediv>
22055
22056 <refsynopsisdiv>
22057 <programlisting id="profile.status.frag">
22058 &lt;xsl:param name="profile.status"&gt;&lt;/xsl:param&gt;
22059 </programlisting>
22060 </refsynopsisdiv>
22061
22062 <refsection><info><title>Description</title></info>
22063
22064 <para>The value of this parameter specifies profiles which should be
22065 included in the output. You can specify multiple profiles by
22066 separating them by semicolon. You can change separator character by
22067 <parameter>profile.separator</parameter>
22068 parameter.</para>
22069
22070 <para>This parameter has effect only when you are using profiling
22071 stylesheets (<filename>profile-docbook.xsl</filename>,
22072 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22073 ones (<filename>docbook.xsl</filename>,
22074 <filename>chunk.xsl</filename>, &#8230;).</para>
22075
22076 </refsection>
22077 </refentry>
22078
22079 <refentry version="5.0" id="profile.userlevel">
22080 <refmeta>
22081 <refentrytitle>profile.userlevel</refentrytitle>
22082 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22083 </refmeta>
22084 <refnamediv>
22085 <refname>profile.userlevel</refname>
22086 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
22087 attribute</refpurpose>
22088 </refnamediv>
22089
22090 <refsynopsisdiv>
22091 <programlisting id="profile.userlevel.frag">
22092 &lt;xsl:param name="profile.userlevel"&gt;&lt;/xsl:param&gt;
22093 </programlisting>
22094 </refsynopsisdiv>
22095
22096 <refsection><info><title>Description</title></info>
22097
22098 <para>The value of this parameter specifies profiles which should be
22099 included in the output. You can specify multiple profiles by
22100 separating them by semicolon. You can change separator character by
22101 <parameter>profile.separator</parameter>
22102 parameter.</para>
22103
22104 <para>This parameter has effect only when you are using profiling
22105 stylesheets (<filename>profile-docbook.xsl</filename>,
22106 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22107 ones (<filename>docbook.xsl</filename>,
22108 <filename>chunk.xsl</filename>, &#8230;).</para>
22109
22110 </refsection>
22111 </refentry>
22112
22113 <refentry version="5.0" id="profile.vendor">
22114 <refmeta>
22115 <refentrytitle>profile.vendor</refentrytitle>
22116 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22117 </refmeta>
22118 <refnamediv>
22119 <refname>profile.vendor</refname>
22120 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
22121 attribute</refpurpose>
22122 </refnamediv>
22123
22124 <refsynopsisdiv>
22125 <programlisting id="profile.vendor.frag">
22126 &lt;xsl:param name="profile.vendor"&gt;&lt;/xsl:param&gt;
22127 </programlisting>
22128 </refsynopsisdiv>
22129
22130 <refsection><info><title>Description</title></info>
22131
22132 <para>The value of this parameter specifies profiles which should be
22133 included in the output. You can specify multiple profiles by
22134 separating them by semicolon. You can change separator character by
22135 <parameter>profile.separator</parameter>
22136 parameter.</para>
22137
22138 <para>This parameter has effect only when you are using profiling
22139 stylesheets (<filename>profile-docbook.xsl</filename>,
22140 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22141 ones (<filename>docbook.xsl</filename>,
22142 <filename>chunk.xsl</filename>, &#8230;).</para>
22143
22144 </refsection>
22145 </refentry>
22146
22147 <refentry version="5.0" id="profile.wordsize">
22148 <refmeta>
22149 <refentrytitle>profile.wordsize</refentrytitle>
22150 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22151 </refmeta>
22152 <refnamediv>
22153 <refname>profile.wordsize</refname>
22154 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
22155 attribute</refpurpose>
22156 </refnamediv>
22157
22158 <refsynopsisdiv>
22159 <programlisting id="profile.wordsize.frag">
22160 &lt;xsl:param name="profile.wordsize"&gt;&lt;/xsl:param&gt;
22161 </programlisting>
22162 </refsynopsisdiv>
22163
22164 <refsection><info><title>Description</title></info>
22165
22166 <para>The value of this parameter specifies profiles which should be
22167 included in the output. You can specify multiple profiles by
22168 separating them by semicolon. You can change separator character by
22169 <parameter>profile.separator</parameter>
22170 parameter.</para>
22171
22172 <para>This parameter has effect only when you are using profiling
22173 stylesheets (<filename>profile-docbook.xsl</filename>,
22174 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22175 ones (<filename>docbook.xsl</filename>,
22176 <filename>chunk.xsl</filename>, &#8230;).</para>
22177
22178 </refsection>
22179 </refentry>
22180
22181 <refentry version="5.0" id="profile.attribute">
22182 <refmeta>
22183 <refentrytitle>profile.attribute</refentrytitle>
22184 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22185 </refmeta>
22186 <refnamediv>
22187 <refname>profile.attribute</refname>
22188 <refpurpose>Name of user-specified profiling attribute</refpurpose>
22189 </refnamediv>
22190
22191 <refsynopsisdiv>
22192 <programlisting id="profile.attribute.frag">
22193 &lt;xsl:param name="profile.attribute"&gt;&lt;/xsl:param&gt;
22194 </programlisting>
22195 </refsynopsisdiv>
22196
22197 <refsection><info><title>Description</title></info>
22198
22199 <para>This parameter is used in conjuction with
22200 <parameter>profile.value</parameter>.</para>
22201
22202 <para>This parameter has effect only when you are using profiling
22203 stylesheets (<filename>profile-docbook.xsl</filename>,
22204 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22205 ones (<filename>docbook.xsl</filename>,
22206 <filename>chunk.xsl</filename>, &#8230;).</para>
22207
22208 </refsection>
22209 </refentry>
22210
22211 <refentry version="5.0" id="profile.value">
22212 <refmeta>
22213 <refentrytitle>profile.value</refentrytitle>
22214 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22215 </refmeta>
22216 <refnamediv>
22217 <refname>profile.value</refname>
22218 <refpurpose>Target profile for user-specified attribute</refpurpose>
22219 </refnamediv>
22220
22221 <refsynopsisdiv>
22222 <programlisting id="profile.value.frag">
22223 &lt;xsl:param name="profile.value"&gt;&lt;/xsl:param&gt;
22224 </programlisting>
22225 </refsynopsisdiv>
22226
22227 <refsection><info><title>Description</title></info>
22228
22229 <para>When you are using this parameter you must also specify name of
22230 profiling attribute with parameter
22231 <parameter>profile.attribute</parameter>.</para>
22232
22233 <para>The value of this parameter specifies profiles which should be
22234 included in the output. You can specify multiple profiles by
22235 separating them by semicolon. You can change separator character by
22236 <parameter>profile.separator</parameter>
22237 parameter.</para>
22238
22239 <para>This parameter has effect only when you are using profiling
22240 stylesheets (<filename>profile-docbook.xsl</filename>,
22241 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
22242 ones (<filename>docbook.xsl</filename>,
22243 <filename>chunk.xsl</filename>, &#8230;).</para>
22244
22245 </refsection>
22246 </refentry>
22247
22248 <refentry version="5.0" id="profile.separator">
22249 <refmeta>
22250 <refentrytitle>profile.separator</refentrytitle>
22251 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22252 </refmeta>
22253 <refnamediv>
22254 <refname>profile.separator</refname>
22255 <refpurpose>Separator character for compound profile values</refpurpose>
22256 </refnamediv>
22257
22258 <refsynopsisdiv>
22259 <programlisting id="profile.separator.frag">
22260 &lt;xsl:param name="profile.separator"&gt;;&lt;/xsl:param&gt;
22261 </programlisting>
22262 </refsynopsisdiv>
22263
22264 <refsection><info><title>Description</title></info>
22265
22266 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
22267
22268 </refsection>
22269 </refentry>
22270
22271 </reference><reference id="l10n" xml:base="../fo/param.xml"><title>Localization</title>
22272 <refentry version="5.0" id="l10n.gentext.language">
22273 <refmeta>
22274 <refentrytitle>l10n.gentext.language</refentrytitle>
22275 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22276 </refmeta>
22277 <refnamediv>
22278 <refname>l10n.gentext.language</refname>
22279 <refpurpose>Sets the gentext language</refpurpose>
22280 </refnamediv>
22281
22282 <refsynopsisdiv>
22283 <programlisting id="l10n.gentext.language.frag">
22284 &lt;xsl:param name="l10n.gentext.language"&gt;&lt;/xsl:param&gt;
22285 </programlisting>
22286 </refsynopsisdiv>
22287
22288 <refsection><info><title>Description</title></info>
22289
22290 <para>If this parameter is set to any value other than the empty string, its
22291 value will be used as the value for the language when generating text. Setting
22292 <parameter>l10n.gentext.language</parameter> overrides any settings within the
22293 document being formatted.</para>
22294
22295 <para>It's much more likely that you might want to set the
22296 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
22297
22298 </refsection>
22299 </refentry>
22300
22301 <refentry version="5.0" id="l10n.gentext.default.language">
22302   <refmeta>
22303     <refentrytitle>l10n.gentext.default.language</refentrytitle>
22304     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22305   </refmeta>
22306   <refnamediv>
22307     <refname>l10n.gentext.default.language</refname>
22308     <refpurpose>Sets the default language for generated text</refpurpose>
22309   </refnamediv>
22310
22311   <refsynopsisdiv>
22312 <programlisting id="l10n.gentext.default.language.frag">
22313 &lt;xsl:param name="l10n.gentext.default.language"&gt;en&lt;/xsl:param&gt;
22314 </programlisting>
22315 </refsynopsisdiv>
22316
22317 <refsection><info><title>Description</title></info>
22318
22319 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
22320 parameter is used as the language for generated text if no setting is provided
22321 in the source document.</para>
22322
22323 </refsection>
22324 </refentry>
22325
22326 <refentry version="5.0" id="l10n.gentext.use.xref.language">
22327 <refmeta>
22328 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
22329 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22330 </refmeta>
22331 <refnamediv>
22332 <refname>l10n.gentext.use.xref.language</refname>
22333 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
22334 </refnamediv>
22335
22336 <refsynopsisdiv>
22337 <programlisting id="l10n.gentext.use.xref.language.frag">
22338 &lt;xsl:param name="l10n.gentext.use.xref.language" select="0"&gt;&lt;/xsl:param&gt;
22339 </programlisting>
22340 </refsynopsisdiv>
22341
22342 <refsection><info><title>Description</title></info>
22343
22344 <para>If non-zero, the language of the target will be used when
22345 generating cross reference text. Usually, the <quote>current</quote>
22346 language is used when generating text (that is, the language of the
22347 element that contains the cross-reference element). But setting this parameter
22348 allows the language of the element <emphasis>pointed to</emphasis> to control
22349 the generated text.</para>
22350
22351 <para>Consider the following example:</para>
22352
22353 <informalexample>
22354 <programlisting>&lt;para lang="en"&gt;See also &lt;xref linkend="chap3"/&gt;.&lt;/para&gt;
22355 </programlisting>
22356 </informalexample>
22357
22358 <para>Suppose that Chapter 3 happens to be written in German.
22359 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
22360 resulting text will be something like this:</para>
22361
22362 <blockquote>
22363 <para>See also Kapital 3.</para>
22364 </blockquote>
22365
22366 <para>Where the more traditional rendering would be:</para>
22367
22368 <blockquote>
22369 <para>See also Chapter 3.</para>
22370 </blockquote>
22371
22372 </refsection>
22373 </refentry>
22374
22375 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
22376 <refmeta>
22377 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
22378 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22379 </refmeta>
22380 <refnamediv>
22381 <refname>l10n.lang.value.rfc.compliant</refname>
22382 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
22383 </refnamediv>
22384
22385 <refsynopsisdiv>
22386 <programlisting id="l10n.lang.value.rfc.compliant.frag">
22387 &lt;xsl:param name="l10n.lang.value.rfc.compliant" select="1"&gt;&lt;/xsl:param&gt;
22388 </programlisting>
22389 </refsynopsisdiv>
22390
22391 <refsection><info><title>Description</title></info>
22392
22393 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
22394 compliant<footnote><para>Section 8.1.1, <link xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that:
22395
22396 <blockquote><para>[RFC1766] defines and explains the language codes
22397 that must be used in HTML documents.</para>
22398 <para>Briefly, language codes consist of a primary code and a possibly
22399 empty series of subcodes:
22400
22401 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
22402 </para>
22403 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
22404 of Languages</link>, the EBNF for "language tag" is given as:
22405
22406 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
22407 Primary-tag = 1*8ALPHA
22408 Subtag = 1*8ALPHA</literallayout>
22409 </para>
22410 </blockquote>
22411 </para></footnote>.
22412
22413 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
22414 replacing them with hyphen characters in output HTML files. For
22415 example, <literal>zh_CN</literal> in a source document becomes
22416 <literal>zh-CN</literal> in the HTML output form that source.
22417
22418 <note>
22419 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
22420 explicitly states that all "language tags" (as it calls them) "are
22421 to be treated as case insensitive".</para>
22422 </note>
22423 </para>
22424
22425 </refsection>
22426 </refentry>
22427
22428 <refentry version="5.0" id="writing.mode">
22429 <refmeta>
22430 <refentrytitle>writing.mode</refentrytitle>
22431 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22432 </refmeta>
22433 <refnamediv>
22434 <refname>writing.mode</refname>
22435 <refpurpose>Direction of text flow based on locale</refpurpose>
22436 </refnamediv>
22437
22438 <refsynopsisdiv>
22439 <programlisting id="writing.mode.frag">
22440 &lt;xsl:param name="writing.mode"&gt;
22441   &lt;xsl:call-template name="gentext"&gt;
22442     &lt;xsl:with-param name="key"&gt;writing-mode&lt;/xsl:with-param&gt;
22443     &lt;xsl:with-param name="lang"&gt;
22444       &lt;xsl:call-template name="l10n.language"&gt;
22445         &lt;xsl:with-param name="target" select="/*[1]"&gt;&lt;/xsl:with-param&gt;
22446       &lt;/xsl:call-template&gt;
22447     &lt;/xsl:with-param&gt;
22448   &lt;/xsl:call-template&gt;
22449 &lt;/xsl:param&gt;
22450 </programlisting>
22451 </refsynopsisdiv>
22452
22453 <refsection><info><title>Description</title></info>
22454
22455 <para>Sets direction of text flow and text alignment based on locale.
22456 The value is normally taken from the gentext file for the 
22457 lang attribute of the document's root element, using the 
22458 key name 'writing-mode' to look it up in the gentext file.
22459 But the param can also be
22460 set on the command line to override that gentext value.
22461 </para>
22462 <para>Accepted values are:
22463 <variablelist>
22464   <varlistentry>
22465     <term>lr-tb</term>
22466     <listitem>
22467       <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
22468     </listitem>
22469   </varlistentry>
22470   <varlistentry>
22471     <term>rl-tb</term>
22472     <listitem>
22473       <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
22474     </listitem>
22475   </varlistentry>
22476   <varlistentry>
22477     <term>tb-rl</term>
22478     <listitem>
22479       <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
22480       Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
22481     </listitem>
22482   </varlistentry>
22483   <varlistentry>
22484     <term>lr</term>
22485     <listitem>
22486       <para>Shorthand for lr-tb.</para>
22487     </listitem>
22488   </varlistentry>
22489   <varlistentry>
22490     <term>rl</term>
22491     <listitem>
22492       <para>Shorthand for rl-tb.</para>
22493     </listitem>
22494   </varlistentry>
22495   <varlistentry>
22496     <term>tb</term>
22497     <listitem>
22498       <para>Shorthand for tb-rl.</para>
22499     </listitem>
22500   </varlistentry>
22501 </variablelist>
22502 </para>
22503
22504 </refsection>
22505 </refentry>
22506
22507 </reference><reference id="ebnf" xml:base="../fo/param.xml"><title>EBNF</title>
22508 <refentry version="5.0" id="ebnf.assignment">
22509 <refmeta>
22510 <refentrytitle>ebnf.assignment</refentrytitle>
22511 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
22512 </refmeta>
22513 <refnamediv>
22514 <refname>ebnf.assignment</refname>
22515 <refpurpose>The EBNF production assignment operator</refpurpose>
22516 </refnamediv>
22517
22518 <refsynopsisdiv>
22519 <programlisting id="ebnf.assignment.frag">
22520
22521 &lt;xsl:param name="ebnf.assignment"&gt;
22522   &lt;fo:inline font-family="{$monospace.font.family}"&gt;
22523     &lt;xsl:text&gt;::=&lt;/xsl:text&gt;
22524   &lt;/fo:inline&gt;
22525 &lt;/xsl:param&gt;
22526 </programlisting>
22527 </refsynopsisdiv>
22528
22529 <refsection><info><title>Description</title></info>
22530
22531 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
22532 text is used to show <quote>assignment</quote> in <tag>production</tag>s
22533 in <tag>productionset</tag>s.</para>
22534
22535 <para>While <quote><literal>::=</literal></quote> is common, so are several
22536 other operators.</para>
22537
22538 </refsection>
22539 </refentry>
22540
22541 <refentry version="5.0" id="ebnf.statement.terminator">
22542 <refmeta>
22543 <refentrytitle>ebnf.statement.terminator</refentrytitle>
22544 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
22545 </refmeta>
22546 <refnamediv>
22547 <refname>ebnf.statement.terminator</refname>
22548 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
22549 </refnamediv>
22550
22551 <refsynopsisdiv>
22552 <programlisting id="ebnf.statement.terminator.frag">
22553
22554 &lt;xsl:param name="ebnf.statement.terminator"&gt;&lt;/xsl:param&gt;
22555 </programlisting>
22556 </refsynopsisdiv>
22557
22558 <refsection><info><title>Description</title></info>
22559
22560 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
22561 text is used to terminate each <tag>production</tag>
22562 in <tag>productionset</tag>.</para>
22563
22564 <para>Some notations end each statement with a period.</para>
22565
22566 </refsection>
22567 </refentry>
22568
22569 </reference><reference id="prepress" xml:base="../fo/param.xml"><title>Prepress</title>
22570 <refentry version="5.0" id="crop.marks">
22571 <refmeta>
22572 <refentrytitle>crop.marks</refentrytitle>
22573 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22574 </refmeta>
22575 <refnamediv>
22576 <refname>crop.marks</refname>
22577 <refpurpose>Output crop marks?</refpurpose>
22578 </refnamediv>
22579
22580 <refsynopsisdiv>
22581 <programlisting id="crop.marks.frag">
22582 &lt;xsl:param name="crop.marks" select="0"&gt;&lt;/xsl:param&gt;
22583 </programlisting>
22584 </refsynopsisdiv>
22585
22586 <refsection><info><title>Description</title></info>
22587
22588 <para>If non-zero, crop marks will be added to each page. Currently this
22589 works only with XEP if you have <parameter>xep.extensions</parameter> set.</para>
22590
22591 </refsection>
22592 </refentry>
22593
22594 <refentry version="5.0" id="crop.mark.width">
22595 <refmeta>
22596 <refentrytitle>crop.mark.width</refentrytitle>
22597 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22598 </refmeta>
22599 <refnamediv>
22600 <refname>crop.mark.width</refname>
22601 <refpurpose>Width of crop marks.</refpurpose>
22602 </refnamediv>
22603
22604 <refsynopsisdiv>
22605 <programlisting id="crop.mark.width.frag">
22606 &lt;xsl:param name="crop.mark.width"&gt;0.5pt&lt;/xsl:param&gt;
22607 </programlisting>
22608 </refsynopsisdiv>
22609
22610 <refsection><info><title>Description</title></info>
22611
22612 <para>Width of crop marks. Crop marks are controlled by
22613 <parameter>crop.marks</parameter> parameter.</para>
22614
22615 </refsection>
22616 </refentry>
22617
22618 <refentry version="5.0" id="crop.mark.offset">
22619 <refmeta>
22620 <refentrytitle>crop.mark.offset</refentrytitle>
22621 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22622 </refmeta>
22623 <refnamediv>
22624 <refname>crop.mark.offset</refname>
22625 <refpurpose>Length of crop marks.</refpurpose>
22626 </refnamediv>
22627
22628 <refsynopsisdiv>
22629 <programlisting id="crop.mark.offset.frag">
22630 &lt;xsl:param name="crop.mark.offset"&gt;24pt&lt;/xsl:param&gt;
22631 </programlisting>
22632 </refsynopsisdiv>
22633
22634 <refsection><info><title>Description</title></info>
22635
22636 <para>Length of crop marks. Crop marks are controlled by
22637 <parameter>crop.marks</parameter> parameter.</para>
22638
22639 </refsection>
22640 </refentry>
22641
22642 <refentry version="5.0" id="crop.mark.bleed">
22643 <refmeta>
22644 <refentrytitle>crop.mark.bleed</refentrytitle>
22645 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22646 </refmeta>
22647 <refnamediv>
22648 <refname>crop.mark.bleed</refname>
22649 <refpurpose>Length of invisible part of crop marks.</refpurpose>
22650 </refnamediv>
22651
22652 <refsynopsisdiv>
22653 <programlisting id="crop.mark.bleed.frag">
22654 &lt;xsl:param name="crop.mark.bleed"&gt;6pt&lt;/xsl:param&gt;
22655 </programlisting>
22656 </refsynopsisdiv>
22657
22658 <refsection><info><title>Description</title></info>
22659
22660 <para>Length of invisible part of crop marks. Crop marks are controlled by
22661 <parameter>crop.marks</parameter> parameter.</para>
22662
22663 </refsection>
22664 </refentry>
22665
22666 </reference>
22667     </part>
22668     <part id="manpages">
22669       <?dbhtml dir="manpages"?>
22670       <?dbhtml filename="index.html"?>
22671       <title xml:base="../manpages/param.xml">Manpages Parameter Reference</title>
22672       <partintro id="manintro">
22673         
22674       <para xml:base="../manpages/param.xml">This is reference documentation for all user-configurable
22675       parameters in the DocBook XSL "manpages" stylesheet (for
22676       generating groff/nroff output). Note that the manpages
22677       stylesheet is a customization layer of the DocBook XSL HTML
22678       stylesheet. Therefore, you can also use a number of <link xlink:href="../html/">HTML stylesheet parameters</link>
22679       to control manpages output (in addition to the
22680       manpages-specific parameters listed in this section).</para>
22681     
22682       </partintro>
22683       <reference id="general" xml:base="../manpages/param.xml">
22684   <title>Hyphenation, justification, and breaking</title>
22685 <refentry version="5.0" id="man.hyphenate">
22686 <refmeta>
22687 <refentrytitle>man.hyphenate</refentrytitle>
22688 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22689 </refmeta>
22690 <refnamediv>
22691 <refname>man.hyphenate</refname>
22692 <refpurpose>Enable hyphenation?</refpurpose>
22693 </refnamediv>
22694
22695 <refsynopsisdiv>
22696 <programlisting id="man.hyphenate.frag">
22697 &lt;xsl:param name="man.hyphenate"&gt;0&lt;/xsl:param&gt;</programlisting>
22698 </refsynopsisdiv>
22699
22700 <refsection><info><title>Description</title></info>
22701
22702 <para>If non-zero, hyphenation is enabled.</para>
22703
22704 <note>
22705 <para>The default value for this parameter is zero because groff is
22706 not particularly smart about how it does hyphenation; it can end up
22707 hyphenating a lot of things that you don't want hyphenated. To
22708 mitigate that, the default behavior of the stylesheets is to suppress
22709 hyphenation of computer inlines, filenames, and URLs. (You can
22710 override the default behavior by setting non-zero values for the
22711 <parameter>man.hyphenate.urls</parameter>,
22712 <parameter>man.hyphenate.filenames</parameter>, and
22713 <parameter>man.hyphenate.computer.inlines</parameter> parameters.) But
22714 the best way is still to just globally disable hyphenation, as the
22715 stylesheets do by default.</para>
22716
22717 <para>The only good reason to enabled hyphenation is if you have also
22718 enabled justification (which is disabled by default). The reason is
22719 that justified text can look very bad unless you also hyphenate it; to
22720 quote the <quote>Hypenation</quote> node from the groff info page:
22721
22722 <blockquote>
22723   <para><emphasis>Since the odds are not great for finding a set of
22724   words, for every output line, which fit nicely on a line without
22725   inserting excessive amounts of space between words, 'gtroff'
22726   hyphenates words so that it can justify lines without inserting too
22727   much space between words.</emphasis></para>
22728 </blockquote>
22729
22730 So, if you set a non-zero value for the
22731 <parameter>man.justify</parameter> parameter (to enable
22732 justification), then you should probably also set a non-zero value for
22733 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
22734 </note>
22735
22736
22737 </refsection>
22738 </refentry>
22739
22740 <refentry version="5.0" id="man.hyphenate.urls">
22741 <refmeta>
22742 <refentrytitle>man.hyphenate.urls</refentrytitle>
22743 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22744 </refmeta>
22745 <refnamediv>
22746 <refname>man.hyphenate.urls</refname>
22747 <refpurpose>Hyphenate URLs?</refpurpose>
22748 </refnamediv>
22749
22750 <refsynopsisdiv>
22751 <programlisting id="man.hyphenate.urls.frag">
22752 &lt;xsl:param name="man.hyphenate.urls"&gt;0&lt;/xsl:param&gt;</programlisting>
22753 </refsynopsisdiv>
22754
22755 <refsection><info><title>Description</title></info>
22756
22757 <para>If zero (the default), hyphenation is suppressed for output of
22758 the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>
22759
22760 <note>
22761   <para>If hyphenation is already turned off globally (that is, if
22762   <parameter>man.hyphenate</parameter> is zero, setting
22763   <parameter>man.hyphenate.urls</parameter> is not necessary.</para>
22764 </note>
22765
22766 <para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs
22767 will not be treated specially and are subject to hyphenation just like
22768 other words.</para>
22769
22770 <note>
22771   <para>If you are thinking about setting a non-zero value for
22772   <parameter>man.hyphenate.urls</parameter> in order to make long
22773   URLs break across lines, you'd probably be better off
22774   experimenting with setting the
22775   <parameter>man.break.after.slash</parameter> parameter first. That
22776   will cause long URLs to be broken after slashes.</para>
22777 </note>
22778
22779 </refsection>
22780 </refentry>
22781
22782 <refentry version="5.0" id="man.hyphenate.filenames">
22783 <refmeta>
22784 <refentrytitle>man.hyphenate.filenames</refentrytitle>
22785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22786 </refmeta>
22787 <refnamediv>
22788 <refname>man.hyphenate.filenames</refname>
22789 <refpurpose>Hyphenate filenames?</refpurpose>
22790 </refnamediv>
22791
22792 <refsynopsisdiv>
22793 <programlisting id="man.hyphenate.filenames.frag">
22794 &lt;xsl:param name="man.hyphenate.filenames"&gt;0&lt;/xsl:param&gt;</programlisting>
22795 </refsynopsisdiv>
22796
22797 <refsection><info><title>Description</title></info>
22798
22799 <para>If zero (the default), hyphenation is suppressed for
22800 <tag>filename</tag> output.</para>
22801
22802 <note>
22803   <para>If hyphenation is already turned off globally (that is, if
22804   <parameter>man.hyphenate</parameter> is zero, setting
22805   <parameter>man.hyphenate.filenames</parameter> is not
22806   necessary.</para>
22807 </note>
22808
22809 <para>If <parameter>man.hyphenate.filenames</parameter> is non-zero,
22810 filenames will not be treated specially and are subject to hyphenation
22811 just like other words.</para>
22812
22813 <note>
22814   <para>If you are thinking about setting a non-zero value for
22815   <parameter>man.hyphenate.filenames</parameter> in order to make long
22816   filenames/pathnames break across lines, you'd probably be better off
22817   experimenting with setting the
22818   <parameter>man.break.after.slash</parameter> parameter first. That
22819   will cause long pathnames to be broken after slashes.</para>
22820 </note>
22821
22822 </refsection>
22823 </refentry>
22824
22825 <refentry version="5.0" id="man.hyphenate.computer.inlines">
22826 <refmeta>
22827 <refentrytitle>man.hyphenate.computer.inlines</refentrytitle>
22828 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22829 </refmeta>
22830 <refnamediv>
22831 <refname>man.hyphenate.computer.inlines</refname>
22832 <refpurpose>Hyphenate computer inlines?</refpurpose>
22833 </refnamediv>
22834
22835 <refsynopsisdiv>
22836 <programlisting id="man.hyphenate.computer.inlines.frag">
22837 &lt;xsl:param name="man.hyphenate.computer.inlines"&gt;0&lt;/xsl:param&gt;</programlisting>
22838 </refsynopsisdiv>
22839
22840 <refsection><info><title>Description</title></info>
22841
22842 <para>If zero (the default), hyphenation is suppressed for
22843 <quote>computer inlines</quote> such as environment variables,
22844 constants, etc. This parameter current affects output of the following
22845 elements:
22846 <simplelist type="inline">
22847   
22848   <member><tag>classname</tag></member>
22849   <member><tag>constant</tag></member>
22850   <member><tag>envar</tag></member>
22851   <member><tag>errorcode</tag></member>
22852   <member><tag>option</tag></member>
22853   <member><tag>replaceable</tag></member>
22854   <member><tag>userinput</tag></member>
22855   <member><tag>type</tag></member>
22856   <member><tag>varname</tag></member>
22857 </simplelist>
22858 </para>
22859
22860 <note>
22861   <para>If hyphenation is already turned off globally (that is, if
22862   <parameter>man.hyphenate</parameter> is zero, setting the
22863   <parameter>man.hyphenate.computer.inlines</parameter> is not
22864   necessary.</para>
22865 </note>
22866
22867 <para>If <parameter>man.hyphenate.computer.inlines</parameter> is
22868 non-zero, computer inlines will not be treated specially and will be
22869 hyphenated like other words when needed.</para>
22870
22871 </refsection>
22872 </refentry>
22873
22874 <refentry version="5.0" id="man.justify">
22875 <refmeta>
22876 <refentrytitle>man.justify</refentrytitle>
22877 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22878 </refmeta>
22879 <refnamediv>
22880 <refname>man.justify</refname>
22881 <refpurpose>Justify text to both right and left margins?</refpurpose>
22882 </refnamediv>
22883
22884 <refsynopsisdiv>
22885 <programlisting id="man.justify.frag">
22886 &lt;xsl:param name="man.justify"&gt;0&lt;/xsl:param&gt;</programlisting>
22887 </refsynopsisdiv>
22888
22889 <refsection><info><title>Description</title></info>
22890
22891 <para>If non-zero, text is justified to both the right and left
22892 margins (or, in roff terminology, "adjusted and filled" to both the
22893 right and left margins). If zero (the default), text is adjusted to
22894 the left margin only -- producing what is traditionally called
22895 "ragged-right" text.</para>
22896
22897 <note>
22898 <para>The default value for this parameter is zero because justified
22899 text looks good only when it is also hyphenated. Without hyphenation,
22900 excessive amounts of space often end up getting between words, in
22901 order to "pad" lines out to align on the right margin.</para>
22902
22903 <para>The problem is that groff is not particularly smart about how it
22904 does hyphenation; it can end up hyphenating a lot of things that you
22905 don't want hyphenated. So, disabling both justification and
22906 hyphenation ensures that hyphens won't get inserted where you don't
22907 want to them, and you don't end up with lines containing excessive
22908 amounts of space between words.</para>
22909
22910 <para>However, if do you decide to set a non-zero value for the
22911 <parameter>man.justify</parameter> parameter (to enable
22912 justification), then you should probably also set a non-zero value for
22913 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
22914
22915 <para>Yes, these default settings run counter to how most existing man
22916 pages are formatted. But there are some notable exceptions, such as
22917 the <literal>perl</literal> man pages.</para>
22918 </note>
22919 </refsection>
22920 </refentry>
22921
22922 <refentry version="5.0" id="man.break.after.slash">
22923 <refmeta>
22924 <refentrytitle>man.break.after.slash</refentrytitle>
22925 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22926 </refmeta>
22927 <refnamediv>
22928 <refname>man.break.after.slash</refname>
22929 <refpurpose>Enable line-breaking after slashes?</refpurpose>
22930 </refnamediv>
22931
22932 <refsynopsisdiv>
22933 <programlisting id="man.break.after.slash.frag">
22934 &lt;xsl:param name="man.break.after.slash"&gt;0&lt;/xsl:param&gt;</programlisting>
22935 </refsynopsisdiv>
22936
22937 <refsection><info><title>Description</title></info>
22938
22939 <para>If non-zero, line-breaking after slashes is enabled. This is
22940 mainly useful for causing long URLs or pathnames/filenames to be
22941 broken up or "wrapped" across lines (though it also has the side
22942 effect of sometimes causing relatively short URLs and pathnames to be
22943 broken up across lines too).</para>
22944
22945 <para>If zero (the default), line-breaking after slashes is
22946 disabled. In that case, strings containing slashes (for example, URLs
22947 or filenames) are not broken across lines, even if they exceed the
22948 maximum column widith.</para>
22949
22950 <warning>
22951   <para>If you set a non-zero value for this parameter, check your
22952   man-page output carefuly afterwards, in order to make sure that the
22953   setting has not introduced an excessive amount of breaking-up of URLs
22954   or pathnames. If your content contains mostly short URLs or
22955   pathnames, setting a non-zero value for
22956   <parameter>man.break.after.slash</parameter> will probably result in
22957   in a significant number of relatively short URLs and pathnames being
22958   broken across lines, which is probably not what you want.</para>
22959 </warning>
22960
22961 </refsection>
22962 </refentry>
22963
22964   </reference><reference id="indent" xml:base="../manpages/param.xml">
22965   <title>Indentation</title>
22966 <refentry version="5.0" id="man.indent.width">
22967 <refmeta>
22968 <refentrytitle>man.indent.width</refentrytitle>
22969 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22970 </refmeta>
22971 <refnamediv>
22972 <refname>man.indent.width</refname>
22973 <refpurpose>Specifies width used for adjusted indents</refpurpose>
22974 </refnamediv>
22975
22976 <refsynopsisdiv>
22977 <programlisting id="man.indent.width.frag">
22978 &lt;xsl:param name="man.indent.width"&gt;4&lt;/xsl:param&gt;
22979 </programlisting>
22980 </refsynopsisdiv>
22981
22982 <refsection><info><title>Description</title></info>
22983 <para>The <parameter>man.indent.width</parameter> parameter specifies
22984 the width used for adjusted indents. The value of
22985 <parameter>man.indent.width</parameter> is used for indenting of
22986 lists, verbatims, headings, and elsewhere, depending on whether the
22987 values of certain <literal>man.indent.*</literal> boolean parameters
22988 are non-zero.</para>
22989
22990 <para>The value of <parameter>man.indent.width</parameter> should
22991 include a valid roff measurement unit (for example,
22992 <literal>n</literal> or <literal>u</literal>). The default value of
22993 <literal>4n</literal> specifies a 4-en width; when viewed on a
22994 console, that amounts to the width of four characters. For details
22995 about roff measurment units, see the <literal>Measurements</literal>
22996 node in the groff info page.</para>
22997
22998 </refsection>
22999 </refentry>
23000
23001 <refentry version="5.0" id="man.indent.refsect">
23002 <refmeta>
23003 <refentrytitle>man.indent.refsect</refentrytitle>
23004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23005 </refmeta>
23006 <refnamediv>
23007 <refname>man.indent.refsect</refname>
23008 <refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>
23009 </refnamediv>
23010
23011 <refsynopsisdiv>
23012 <programlisting id="man.indent.refsect.frag">
23013 &lt;xsl:param name="man.indent.refsect" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
23014 </refsynopsisdiv>
23015
23016 <refsection><info><title>Description</title></info>
23017
23018 <para>If the value of <parameter>man.indent.refsect</parameter> is
23019 non-zero, the width of the left margin for
23020 <tag>refsect1</tag>, <tag>refsect2</tag> and
23021 <tag>refsect3</tag> contents and titles (and first-level,
23022 second-level, and third-level nested
23023 <tag>refsection</tag>instances) is adjusted by the value of
23024 the <parameter>man.indent.width</parameter> parameter. With
23025 <parameter>man.indent.width</parameter> set to its default value of
23026 <literal>3n</literal>, the main results are that:
23027
23028 <itemizedlist>
23029   <listitem>
23030     <para>contents of <tag>refsect1</tag> are output with a
23031     left margin of three characters instead the roff default of seven
23032     or eight characters</para>
23033   </listitem>
23034   <listitem>
23035     <para>contents of <tag>refsect2</tag> are displayed in
23036     console output with a left margin of six characters instead the of
23037     the roff default of seven characters</para>
23038   </listitem>
23039   <listitem>
23040     <para> the contents of <tag>refsect3</tag> and nested
23041     <tag>refsection</tag> instances are adjusted
23042     accordingly.</para>
23043   </listitem>
23044 </itemizedlist>
23045
23046 If instead the value of <parameter>man.indent.refsect</parameter> is
23047 zero, no margin adjustment is done for <literal>refsect*</literal>
23048 output.</para>
23049
23050 <tip>
23051   <para>If your content is primarly comprised of
23052   <tag>refsect1</tag> and <tag>refsect2</tag> content
23053   (or the <tag>refsection</tag> equivalent)&#160;&#8211; with few or
23054   no <tag>refsect3</tag> or lower nested sections , you may be
23055   able to &#8220;conserve&#8221; space in your output by setting
23056   <parameter>man.indent.refsect</parameter> to a non-zero value. Doing
23057   so will &#8220;squeeze&#8221; the left margin in such as way as to provide an
23058   additional four characters of &#8220;room&#8221; per line in
23059   <tag>refsect1</tag> output. That extra room may be useful
23060   if, for example, you have many verbatim sections with long lines in
23061   them.</para>
23062 </tip>
23063
23064 </refsection>
23065 </refentry>
23066
23067 <refentry version="5.0" id="man.indent.blurbs">
23068 <refmeta>
23069 <refentrytitle>man.indent.blurbs</refentrytitle>
23070 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23071 </refmeta>
23072 <refnamediv>
23073 <refname>man.indent.blurbs</refname>
23074 <refpurpose>Adjust indentation of blurbs?</refpurpose>
23075 </refnamediv>
23076
23077 <refsynopsisdiv>
23078 <programlisting id="man.indent.blurbs.frag">
23079 &lt;xsl:param name="man.indent.blurbs" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
23080 </refsynopsisdiv>
23081
23082 <refsection><info><title>Description</title></info>
23083
23084 <para>If the value of <parameter>man.indent.blurbs</parameter> is
23085 non-zero, the width of the left margin for
23086 <tag>authorblurb</tag>, <tag>personblurb</tag>, and
23087 <tag>contrib</tag> output is set to the value of the
23088 <parameter>man.indent.width</parameter> parameter
23089 (<literal>3n</literal> by default). If instead the value of
23090 <parameter>man.indent.blurbs</parameter> is zero, the built-in roff
23091 default width (<literal>7.2n</literal>) is used.</para>
23092
23093 </refsection>
23094 </refentry>
23095
23096 <refentry version="5.0" id="man.indent.lists">
23097 <refmeta>
23098 <refentrytitle>man.indent.lists</refentrytitle>
23099 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23100 </refmeta>
23101 <refnamediv>
23102 <refname>man.indent.lists</refname>
23103 <refpurpose>Adjust indentation of lists?</refpurpose>
23104 </refnamediv>
23105
23106 <refsynopsisdiv>
23107 <programlisting id="man.indent.lists.frag">
23108 &lt;xsl:param name="man.indent.lists" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
23109 </refsynopsisdiv>
23110
23111 <refsection><info><title>Description</title></info>
23112
23113 <para>If the value of <parameter>man.indent.lists</parameter> is
23114 non-zero, the width of the left margin for list items in
23115 <tag>itemizedlist</tag>,
23116 <tag>orderedlist</tag>,
23117 <tag>variablelist</tag> output (and output of some other
23118 lists) is set to the value of the
23119 <parameter>man.indent.width</parameter> parameter
23120 (<literal>4n</literal> by default). If instead the value of
23121 <parameter>man.indent.lists</parameter> is zero, the built-in roff
23122 default width (<literal>7.2n</literal>) is used.</para>
23123
23124 </refsection>
23125 </refentry>
23126
23127 <refentry version="5.0" id="man.indent.verbatims">
23128 <refmeta>
23129 <refentrytitle>man.indent.verbatims</refentrytitle>
23130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23131 </refmeta>
23132 <refnamediv>
23133 <refname>man.indent.verbatims</refname>
23134 <refpurpose>Adjust indentation of verbatims?</refpurpose>
23135 </refnamediv>
23136
23137 <refsynopsisdiv>
23138 <programlisting id="man.indent.verbatims.frag">
23139 &lt;xsl:param name="man.indent.verbatims" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
23140 </refsynopsisdiv>
23141
23142 <refsection><info><title>Description</title></info>
23143
23144 <para>If the value of <parameter>man.indent.verbatims</parameter> is
23145 non-zero, the width of the left margin for output of verbatim
23146 environments (<tag>programlisting</tag>,
23147 <tag>screen</tag>, and so on) is set to the value of the
23148 <parameter>man.indent.width</parameter> parameter
23149 (<literal>3n</literal> by default). If instead the value of
23150 <parameter>man.indent.verbatims</parameter> is zero, the built-in roff
23151 default width (<literal>7.2n</literal>) is used.</para>
23152
23153 </refsection>
23154 </refentry>
23155
23156   </reference><reference id="fonts" xml:base="../manpages/param.xml">
23157   <title>Fonts</title>
23158 <refentry version="5.0" id="man.font.funcprototype">
23159 <refmeta>
23160 <refentrytitle>man.font.funcprototype</refentrytitle>
23161 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23162 </refmeta>
23163 <refnamediv>
23164 <refname>man.font.funcprototype</refname>
23165 <refpurpose>Specifies font for funcprototype output</refpurpose>
23166 </refnamediv>
23167
23168 <refsynopsisdiv>
23169 <programlisting id="man.font.funcprototype.frag">
23170   &lt;xsl:param name="man.font.funcprototype"&gt;BI&lt;/xsl:param&gt;
23171 </programlisting>
23172 </refsynopsisdiv>
23173
23174 <refsection><info><title>Description</title></info>
23175
23176 <para>The <parameter>man.font.funcprototype</parameter> parameter
23177 specifies the font for <tag>funcprototype</tag> output. It
23178 should be a valid roff font name, such as <literal>BI</literal> or
23179 <literal>B</literal>.</para>
23180
23181 </refsection>
23182 </refentry>
23183
23184 <refentry version="5.0" id="man.font.funcsynopsisinfo">
23185 <refmeta>
23186 <refentrytitle>man.font.funcsynopsisinfo</refentrytitle>
23187 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23188 </refmeta>
23189 <refnamediv>
23190 <refname>man.font.funcsynopsisinfo</refname>
23191 <refpurpose>Specifies font for funcsynopsisinfo output</refpurpose>
23192 </refnamediv>
23193
23194 <refsynopsisdiv>
23195 <programlisting id="man.font.funcsynopsisinfo.frag">
23196   &lt;xsl:param name="man.font.funcsynopsisinfo"&gt;B&lt;/xsl:param&gt;
23197 </programlisting>
23198 </refsynopsisdiv>
23199
23200 <refsection><info><title>Description</title></info>
23201
23202 <para>The <parameter>man.font.funcsynopsisinfo</parameter> parameter
23203 specifies the font for <tag>funcsynopsisinfo</tag> output. It
23204 should be a valid roff font name, such as <literal>B</literal> or
23205 <literal>I</literal>.</para>
23206
23207 </refsection>
23208 </refentry>
23209
23210 <refentry version="5.0" id="man.font.links">
23211 <refmeta>
23212 <refentrytitle>man.font.links</refentrytitle>
23213 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23214 </refmeta>
23215 <refnamediv>
23216 <refname>man.font.links</refname>
23217 <refpurpose>Specifies font for links</refpurpose>
23218 </refnamediv>
23219
23220 <refsynopsisdiv>
23221 <programlisting id="man.font.links.frag">
23222 &lt;xsl:param name="man.font.links"&gt;B&lt;/xsl:param&gt;
23223 </programlisting>
23224 </refsynopsisdiv>
23225
23226 <refsection><info><title>Description</title></info>
23227
23228 <para>The <parameter>man.font.links</parameter> parameter
23229 specifies the font for output of links (<tag>ulink</tag> instances
23230 and any instances of any element with an <tag class="attribute">xlink:href</tag> attribute).</para>
23231
23232 <para>The value of <parameter>man.font.links</parameter> must be
23233   either <literal>B</literal> or <literal>I</literal>, or empty. If
23234 the value is empty, no font formatting is applied to links.</para>
23235
23236 <para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or
23237 <parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then
23238 you should probably also set an empty value for
23239 <parameter>man.font.links</parameter>. But if
23240 <parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled),
23241 you should probably keep
23242 <parameter>man.font.links</parameter> set to
23243 <literal>B</literal> or <literal>I</literal><footnote><para>The
23244     main purpose of applying a font format to links in most output
23245 formats it to indicate that the formatted text is
23246 &#8220;clickable&#8221;; given that links rendered in man pages are
23247 not &#8220;real&#8221; hyperlinks that users can click on, it might
23248 seem like there is never a good reason to have font formatting for
23249 link contents in man output.</para>
23250 <para>In fact, if you suppress the
23251 display of inline link references (by setting
23252 <parameter>man.endnotes.are.numbered</parameter> to zero), there is no
23253 good reason to apply font formatting to links. However, if
23254 <parameter>man.endnotes.are.numbered</parameter> is non-zero, having
23255 font formatting for links (arguably) serves a purpose: It provides
23256 &#8220;context&#8221; information about exactly what part of the text
23257 is being &#8220;annotated&#8221; by the link. Depending on how you
23258 mark up your content, that context information may or may not
23259 have value.</para></footnote>.</para>
23260 </refsection>
23261
23262 <refsection><info><title>Related Parameters</title></info>
23263   <para><parameter>man.endnotes.list.enabled</parameter>,
23264     <parameter>man.endnotes.are.numbered</parameter></para>
23265 </refsection>
23266
23267 </refentry>
23268
23269 <refentry version="5.0" id="man.font.table.headings">
23270 <refmeta>
23271 <refentrytitle>man.font.table.headings</refentrytitle>
23272 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23273 </refmeta>
23274 <refnamediv>
23275 <refname>man.font.table.headings</refname>
23276 <refpurpose>Specifies font for table headings</refpurpose>
23277 </refnamediv>
23278
23279 <refsynopsisdiv>
23280 <programlisting id="man.font.table.headings.frag">
23281   &lt;xsl:param name="man.font.table.headings"&gt;B&lt;/xsl:param&gt;
23282 </programlisting>
23283 </refsynopsisdiv>
23284
23285 <refsection><info><title>Description</title></info>
23286
23287 <para>The <parameter>man.font.table.headings</parameter> parameter
23288 specifies the font for <tag>table</tag> headings. It should be
23289 a valid roff font, such as <literal>B</literal> or
23290 <literal>I</literal>.</para>
23291
23292 </refsection>
23293 </refentry>
23294
23295 <refentry version="5.0" id="man.font.table.title">
23296 <refmeta>
23297 <refentrytitle>man.font.table.title</refentrytitle>
23298 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23299 </refmeta>
23300 <refnamediv>
23301 <refname>man.font.table.title</refname>
23302 <refpurpose>Specifies font for table headings</refpurpose>
23303 </refnamediv>
23304
23305 <refsynopsisdiv>
23306 <programlisting id="man.font.table.title.frag">
23307   &lt;xsl:param name="man.font.table.title"&gt;B&lt;/xsl:param&gt;
23308 </programlisting>
23309 </refsynopsisdiv>
23310
23311 <refsection><info><title>Description</title></info>
23312
23313 <para>The <parameter>man.font.table.title</parameter> parameter
23314 specifies the font for <tag>table</tag> titles. It should be
23315 a valid roff font, such as <literal>B</literal> or
23316 <literal>I</literal>.</para>
23317
23318 </refsection>
23319 </refentry>
23320
23321   </reference><reference id="synopsis" xml:base="../manpages/param.xml">
23322   <title>SYNOPSIS section</title>
23323 <refentry version="5.0" id="man.funcsynopsis.style">
23324 <refmeta>
23325 <refentrytitle>man.funcsynopsis.style</refentrytitle>
23326 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
23327 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
23328 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
23329 </refmeta>
23330 <refnamediv>
23331 <refname>man.funcsynopsis.style</refname>
23332 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
23333 </refnamediv>
23334 <refsynopsisdiv>
23335 <programlisting id="man.funcsynopsis.style.frag">&lt;xsl:param name="man.funcsynopsis.style"&gt;ansi&lt;/xsl:param&gt;</programlisting>
23336 </refsynopsisdiv>
23337 <refsection><info><title>Description</title></info>
23338 <para>If <parameter>man.funcsynopsis.style</parameter> is
23339 <literal>ansi</literal>, ANSI-style function synopses are
23340 generated for a <tag>funcsynopsis</tag>, otherwise K&amp;R-style
23341 function synopses are generated.</para>
23342 </refsection>
23343 </refentry>
23344
23345   </reference><reference id="authors" xml:base="../manpages/param.xml">
23346   <title>AUTHORS and COPYRIGHT sections</title>
23347   <refentry version="5.0" id="man.authors.section.enabled">
23348 <refmeta>
23349 <refentrytitle>man.authors.section.enabled</refentrytitle>
23350 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23351 </refmeta>
23352 <refnamediv>
23353 <refname>man.authors.section.enabled</refname>
23354 <refpurpose>Display auto-generated AUTHORS section?</refpurpose>
23355 </refnamediv>
23356 <refsynopsisdiv>
23357 <programlisting id="man.authors.section.enabled.frag">
23358 &lt;xsl:param name="man.authors.section.enabled"&gt;1&lt;/xsl:param&gt;
23359 </programlisting>
23360 </refsynopsisdiv>
23361 <refsection><info><title>Description</title></info>
23362
23363 <para>If the value of
23364 <parameter>man.authors.section.enabled</parameter> is non-zero
23365 (the default), then an <literal>AUTHORS</literal> section is
23366 generated near the end of each man page. The output of the
23367 <literal>AUTHORS</literal> section is assembled from any
23368 <tag>author</tag>, <tag>editor</tag>, and <tag>othercredit</tag>
23369 metadata found in the contents of the child <tag>info</tag> or
23370 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
23371 itself, or from any <tag>author</tag>, <tag>editor</tag>, and
23372 <tag>othercredit</tag> metadata that may appear in <tag>info</tag>
23373 contents of any ancestors of the <tag>refentry</tag>.</para>
23374
23375 <para>If the value of
23376 <parameter>man.authors.section.enabled</parameter> is zero, the
23377 the auto-generated <literal>AUTHORS</literal> section is
23378 suppressed.</para>
23379
23380 <para>Set the value of
23381   <parameter>man.authors.section.enabled</parameter> to zero if
23382   you want to have a manually created <literal>AUTHORS</literal>
23383   section in your source, and you want it to appear in output
23384   instead of the auto-generated <literal>AUTHORS</literal>
23385   section.</para>
23386 </refsection>
23387 </refentry>
23388
23389   <refentry version="5.0" id="man.copyright.section.enabled">
23390 <refmeta>
23391 <refentrytitle>man.copyright.section.enabled</refentrytitle>
23392 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23393 </refmeta>
23394 <refnamediv>
23395 <refname>man.copyright.section.enabled</refname>
23396 <refpurpose>Display auto-generated COPYRIGHT section?</refpurpose>
23397 </refnamediv>
23398 <refsynopsisdiv>
23399 <programlisting id="man.copyright.section.enabled.frag">
23400 &lt;xsl:param name="man.copyright.section.enabled"&gt;1&lt;/xsl:param&gt;
23401 </programlisting>
23402 </refsynopsisdiv>
23403 <refsection><info><title>Description</title></info>
23404
23405 <para>If the value of
23406 <parameter>man.copyright.section.enabled</parameter> is non-zero
23407 (the default), then a <literal>COPYRIGHT</literal> section is
23408 generated near the end of each man page. The output of the
23409 <literal>COPYRIGHT</literal> section is assembled from any
23410 <tag>copyright</tag> and <tag>legalnotice</tag> metadata found in
23411 the contents of the child <tag>info</tag> or
23412 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
23413 itself, or from any <tag>copyright</tag> and
23414 <tag>legalnotice</tag> metadata that may appear in <tag>info</tag>
23415 contents of any ancestors of the <tag>refentry</tag>.</para>
23416
23417 <para>If the value of
23418 <parameter>man.copyright.section.enabled</parameter> is zero, the
23419 the auto-generated <literal>COPYRIGHT</literal> section is
23420 suppressed.</para>
23421
23422 <para>Set the value of
23423   <parameter>man.copyright.section.enabled</parameter> to zero if
23424   you want to have a manually created <literal>COPYRIGHT</literal>
23425   section in your source, and you want it to appear in output
23426   instead of the auto-generated <literal>COPYRIGHT</literal>
23427   section.</para>
23428 </refsection>
23429 </refentry>
23430
23431   </reference><reference id="endnotes" xml:base="../manpages/param.xml">
23432   <title>Endnotes and link handling</title>
23433 <refentry version="5.0" id="man.endnotes.list.enabled">
23434 <refmeta>
23435 <refentrytitle>man.endnotes.list.enabled</refentrytitle>
23436 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23437 </refmeta>
23438 <refnamediv>
23439 <refname>man.endnotes.list.enabled</refname>
23440 <refpurpose>Display endnotes list at end of man page?</refpurpose>
23441 </refnamediv>
23442
23443 <refsynopsisdiv>
23444 <programlisting id="man.endnotes.list.enabled.frag">
23445 &lt;xsl:param name="man.endnotes.list.enabled"&gt;1&lt;/xsl:param&gt;
23446 </programlisting>
23447 </refsynopsisdiv>
23448
23449 <refsection><info><title>Description</title></info>
23450
23451 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
23452 non-zero (the default), then an endnotes list is added to the end of
23453 the output man page.</para>
23454
23455 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
23456 zero, the list is suppressed &#8212; unless link numbering is enabled (that
23457 is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in
23458 which case, that setting overrides the
23459 <parameter>man.endnotes.list.enabled</parameter> setting, and the
23460 endnotes list is still displayed. The reason is that inline
23461 numbering of notesources associated with endnotes only makes sense
23462 if a (numbered) list of endnotes is also generated.</para>
23463
23464 <note>
23465   <para>Leaving
23466   <parameter>man.endnotes.list.enabled</parameter> at its default
23467   (non-zero) value ensures that no &#8220;out of line&#8221; information (such
23468   as the URLs for hyperlinks and images) gets lost in your
23469   man-page output. It just gets &#8220;rearranged&#8221;.</para>
23470   <para>So if you&#8217;re thinking about disabling endnotes listing by
23471     setting the value of
23472     <parameter>man.endnotes.list.enabled</parameter> to zero:
23473     Before you do so, first take some time to carefully consider
23474     the information needs and experiences of your users. The &#8220;out
23475     of line&#8221; information has value even if the presentation of it
23476     in text output is not as interactive as it may be in other
23477     output formats.</para>
23478   <para>As far as the specific case of URLs: Even though the URLs
23479     displayed in text output may not be &#8220;real&#8221; (clickable)
23480     hyperlinks, many X terminals have convenience features for
23481     recognizing URLs and can, for example, present users with
23482     an options to open a URL in a browser with the user clicks on
23483     the URL is a terminal window. And short of those, users with X
23484     terminals can always manually cut and paste the URLs into a web
23485     browser.</para>
23486   <para>Also, note that various &#8220;man to html&#8221; tools, such as the
23487     widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
23488     application, automatically mark up URLs with <literal>a@href</literal> markup
23489   during conversion &#8212; resulting in &#8220;real&#8221; hyperlinks in HTML
23490   output from those tools.</para>
23491 </note>
23492
23493 <para>To &#8220;turn off&#8221; numbering of endnotes in the
23494 endnotes list, set <parameter>man.endnotes.are.numbered</parameter>
23495 to zero. The endnotes list will
23496 still be displayed; it will just be displayed without the
23497 numbers<footnote><para>It can still make sense to have
23498 the list of endnotes displayed even if you have endnotes numbering turned
23499 off. In that case, your endnotes list basically becomes a &#8220;list
23500 of references&#8221; without any association with specific text in
23501 your document. This is probably the best option if you find the inline
23502 endnotes numbering obtrusive. Your users will still have access to all the &#8220;out of line&#8221;
23503 such as URLs for hyperlinks.</para></footnote>
23504 </para>
23505
23506 <para>The default heading for the endnotes list is
23507 <literal>NOTES</literal>. To change that, set a non-empty
23508 value for the <parameter>man.endnotes.list.heading</parameter>
23509 parameter.</para>
23510
23511 <para>In the case of notesources that are links: Along with the
23512 URL for each link, the endnotes list includes the contents of the
23513 link. The list thus includes only non-empty<footnote>
23514
23515 <para>A &#8220;non-empty&#8221; link is one that looks like
23516 this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"&gt;manpages&lt;/ulink&gt;</literallayout>
23517 an &#8220;empty link&#8221; is on that looks like this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/&gt;</literallayout>
23518 </para></footnote> links.
23519
23520 Empty links are never included, and never numbered. They are simply
23521 displayed inline, without any numbering.</para>
23522
23523 <para>In addition, if there are multiple instances of links in a
23524 <tag>refentry</tag> that have the same URL, the URL is listed only
23525 once. The contents listed for that link in the endnotes list are
23526 the contents of the first link which has that URL.</para>
23527
23528 <para>If you disable endnotes listing, you should probably also set
23529 <parameter>man.links.are.underlined</parameter> to zero (to disable
23530 link underlining).</para>
23531 </refsection>
23532 </refentry>
23533
23534 <refentry version="5.0" id="man.endnotes.list.heading">
23535 <refmeta>
23536 <refentrytitle>man.endnotes.list.heading</refentrytitle>
23537 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23538 </refmeta>
23539 <refnamediv>
23540 <refname>man.endnotes.list.heading</refname>
23541 <refpurpose>Specifies an alternate name for endnotes list</refpurpose>
23542 </refnamediv>
23543
23544 <refsynopsisdiv>
23545 <programlisting id="man.endnotes.list.heading.frag">
23546 &lt;xsl:param name="man.endnotes.list.heading"&gt;&lt;/xsl:param&gt;
23547 </programlisting>
23548 </refsynopsisdiv>
23549
23550 <refsection><info><title>Description</title></info>
23551
23552 <para>If the value of the
23553 <parameter>man.endnotes.are.numbered</parameter> parameter
23554 and/or the <parameter>man.endnotes.list.enabled</parameter>
23555 parameter is non-zero (the defaults for both are non-zero), a
23556 numbered list of endnotes is generated near the end of each man
23557 page. The default heading for the list of endnotes is the
23558 equivalent of the English word <literal>NOTES</literal> in
23559 the current locale. To cause an alternate heading to be displayed,
23560 set a non-empty value for the
23561 <parameter>man.endnotes.list.heading</parameter> parameter &#8212;
23562 for example, <literal>REFERENCES</literal>.</para>
23563 </refsection>
23564 </refentry>
23565
23566 <refentry version="5.0" id="man.endnotes.are.numbered">
23567 <refmeta>
23568 <refentrytitle>man.endnotes.are.numbered</refentrytitle>
23569 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23570 </refmeta>
23571 <refnamediv>
23572 <refname>man.endnotes.are.numbered</refname>
23573 <refpurpose>Number endnotes?</refpurpose>
23574 </refnamediv>
23575
23576 <refsynopsisdiv>
23577 <programlisting id="man.endnotes.are.numbered.frag">
23578 &lt;xsl:param name="man.endnotes.are.numbered"&gt;1&lt;/xsl:param&gt;
23579 </programlisting>
23580 </refsynopsisdiv>
23581
23582 <refsection><info><title>Description</title></info>
23583
23584 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
23585 non-zero (the default), then for each non-empty<footnote>
23586 <para>A &#8220;non-empty&#8221; notesource is one that looks like
23587 this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"&gt;manpages&lt;/ulink&gt;</literallayout>
23588 an &#8220;empty&#8221; notesource is on that looks like this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/&gt;</literallayout>
23589 </para></footnote> &#8220;notesource&#8221;:
23590
23591 <itemizedlist>
23592   <listitem>
23593     <para>a number (in square brackets) is displayed inline after the
23594     rendered inline contents (if any) of the notesource</para>
23595   </listitem>
23596   <listitem>
23597     <para>the contents of the notesource are included in a
23598       numbered list of endnotes that is generated at the end of
23599       each man page; the number for each endnote corresponds to
23600       the inline number for the notesource with which it is
23601       associated</para>
23602   </listitem>
23603 </itemizedlist>
23604 The default heading for the list of endnotes is
23605 <literal>NOTES</literal>. To output a different heading, set a value
23606 for the <parameter>man.endnotes.section.heading</parameter>
23607 parameter.</para>
23608
23609 <note>
23610   <para>The endnotes list is also displayed (but without
23611     numbers) if the value of
23612     <parameter>man.endnotes.list.enabled</parameter> is
23613     non-zero.</para>
23614 </note>
23615
23616
23617 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
23618 zero, numbering of endnotess is suppressed; only inline
23619 contents (if any) of the notesource are displayed inline.
23620 <important>
23621   <para>If you are thinking about disabling endnote numbering by setting
23622   the value of <parameter>man.endnotes.are.numbered</parameter> to zero,
23623   before you do so, first take some time to carefully
23624   consider the information needs and experiences of your users. The
23625   square-bracketed numbers displayed inline after notesources may seem
23626   obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might
23627   think it would be better to just display URLs for non-empty
23628   links inline, after their content, rather than displaying
23629   square-bracketed numbers all over the place. But it's not better. In
23630   fact, it's not even practical, because many (most) URLs for links
23631   are too long to be displayed inline. They end up overflowing the
23632   right margin. You can set a non-zero value for
23633   <parameter>man.break.after.slash</parameter> parameter to deal with
23634   that, but it could be argued that what you end up with is at least
23635   as ugly, and definitely more obstrusive, then having short
23636   square-bracketed numbers displayed inline.</para></footnote>,
23637
23638   but in a text-only output format, the
23639   numbered-notesources/endnotes-listing mechanism is the only
23640   practical way to handle this kind of content.</para>
23641
23642   <para>Also, users of &#8220;text based&#8221; browsers such as
23643   <command>lynx</command> will already be accustomed to seeing inline
23644   numbers for links. And various "man to html" applications, such as
23645   the widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
23646   application, can automatically turn URLs into "real" HTML hyperlinks
23647   in output. So leaving <parameter>man.endnotes.are.numbered</parameter>
23648   at its default (non-zero) value ensures that no information is
23649   lost in your man-page output. It just gets
23650   &#8220;rearranged&#8221;.</para>
23651 </important>
23652 </para>
23653 <para>The handling of empty links is not affected by this
23654 parameter. Empty links are handled simply by displaying their URLs
23655 inline. Empty links are never auto-numbered.</para>
23656
23657 <para>If you disable endnotes numbering, you should probably also set
23658 <parameter>man.font.links</parameter> to an empty value (to
23659 disable font formatting for links.</para>
23660 </refsection>
23661
23662 <refsection><info><title>Related Parameters</title></info>
23663   <para><parameter>man.endnotes.list.enabled</parameter>,
23664     <parameter>man.font.links</parameter></para>
23665 </refsection>
23666 </refentry>
23667
23668 <refentry version="5.0" id="man.base.url.for.relative.links">
23669   <refmeta>
23670     <refentrytitle>man.base.url.for.relative.links</refentrytitle>
23671     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23672   </refmeta>
23673   <refnamediv>
23674     <refname>man.base.url.for.relative.links</refname>
23675     <refpurpose>Specifies a base URL for relative links</refpurpose>
23676   </refnamediv>
23677
23678   <refsynopsisdiv>
23679     <programlisting id="man.base.url.for.relative.links.frag">&lt;xsl:param name="man.base.url.for.relative.links"&gt;[set $man.base.url.for.relative.links]/&lt;/xsl:param&gt;</programlisting>
23680   </refsynopsisdiv>
23681
23682   <refsection><info><title>Description</title></info>
23683
23684     <para>For any &#8220;notesource&#8221; listed in the auto-generated
23685       &#8220;NOTES&#8221; section of output man pages (which is generated when
23686       the value of the
23687       <parameter>man.endnotes.list.enabled</parameter> parameter
23688       is non-zero), if the notesource is a link source with a
23689       relative URI, the URI is displayed in output with the value
23690       of the
23691       <parameter>man.base.url.for.relative.links</parameter>
23692       parameter prepended to the value of the link URI.</para>
23693
23694     <note>
23695       <para>A link source is an notesource that references an
23696         external resource:
23697         <itemizedlist>
23698           <listitem>
23699             <para>a <tag>ulink</tag> element with a <tag class="attribute">url</tag> attribute</para>
23700           </listitem>
23701           <listitem>
23702             <para>any element with an <tag class="attribute">xlink:href</tag> attribute</para>
23703           </listitem>
23704           <listitem>
23705             <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or
23706               <tag>videodata</tag> element</para>
23707           </listitem>
23708         </itemizedlist>
23709       </para>
23710     </note>
23711
23712     <para>If you use relative URIs in link sources in your DocBook
23713       <tag>refentry</tag> source, and you leave
23714       <parameter>man.base.url.for.relative.links</parameter>
23715       unset, the relative links will appear &#8220;as is&#8221; in the &#8220;Notes&#8221;
23716       section of any man-page output generated from your source.
23717       That&#8217;s probably not what you want, because such relative
23718       links are only usable in the context of HTML output. So, to
23719       make the links meaningful and usable in the context of
23720       man-page output, set a value for
23721       <parameter>man.base.url.for.relative.links</parameter> that
23722       points to the online version of HTML output generated from
23723       your DocBook <tag>refentry</tag> source. For
23724       example:
23725       <programlisting>&lt;xsl:param name="man.base.url.for.relative.links"
23726         &gt;http://www.kernel.org/pub/software/scm/git/docs/&lt;/xsl:param&gt;</programlisting>
23727     </para>
23728
23729   </refsection>
23730
23731   <refsection><info><title>Related Parameters</title></info>
23732     <para><parameter>man.endnotes.list.enabled</parameter></para>
23733   </refsection>
23734
23735 </refentry>
23736
23737   </reference><reference id="lists" xml:base="../manpages/param.xml">
23738   <title>Lists</title>
23739 <refentry version="5.0" id="man.segtitle.suppress">
23740 <refmeta>
23741 <refentrytitle>man.segtitle.suppress</refentrytitle>
23742 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23743 </refmeta>
23744 <refnamediv>
23745 <refname>man.segtitle.suppress</refname>
23746 <refpurpose>Suppress display of segtitle contents?</refpurpose>
23747 </refnamediv>
23748
23749 <refsynopsisdiv>
23750 <programlisting id="man.segtitle.suppress.frag">
23751 &lt;xsl:param name="man.segtitle.suppress" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
23752 </refsynopsisdiv>
23753
23754 <refsection><info><title>Description</title></info>
23755
23756 <para>If the value of <parameter>man.segtitle.suppress</parameter> is
23757 non-zero, then display of <tag>segtitle</tag> contents is
23758 suppressed in output.</para>
23759
23760 </refsection>
23761 </refentry>
23762
23763   </reference><reference id="charmap" xml:base="../manpages/param.xml">
23764   <title>Character/string substitution</title>
23765 <refentry version="5.0" id="man.charmap.enabled">
23766 <refmeta>
23767 <refentrytitle>man.charmap.enabled</refentrytitle>
23768 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23769 </refmeta>
23770 <refnamediv>
23771 <refname>man.charmap.enabled</refname>
23772 <refpurpose>Apply character map before final output?</refpurpose>
23773 </refnamediv>
23774
23775 <refsynopsisdiv>
23776 <programlisting id="man.charmap.enabled.frag">
23777 &lt;xsl:param name="man.charmap.enabled" select="1"&gt;&lt;/xsl:param&gt;
23778 </programlisting>
23779 </refsynopsisdiv>
23780
23781 <refsection><info><title>Description</title></info>
23782
23783 <para>If the value of the <parameter>man.charmap.enabled</parameter>
23784 parameter is non-zero, a "character map" is used to substitute certain
23785 Unicode symbols and special characters with appropriate roff/groff
23786 equivalents, just before writing each man-page file to the
23787 filesystem. If instead the value of
23788 <parameter>man.charmap.enabled</parameter> is zero, Unicode characters
23789 are passed through "as is".</para>
23790
23791 <refsection><info><title>Details</title></info>
23792
23793 <para>For converting certain Unicode symbols and special characters in
23794 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23795 equivalents in man-page output, the DocBook XSL Stylesheets
23796 distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
23797 map</link> format as detailed in the XSLT 2.0 specification. The map
23798 contains more than 800 character mappings and can be considered the
23799 standard roff character map for the distribution.</para>
23800
23801 <para>You can use the <parameter>man.charmap.uri</parameter>
23802 parameter to specify a URI for the location for an alternate roff
23803 character map to use in place of the standard roff character map
23804 provided in the distribution.</para>
23805
23806 <para>You can also use a subset of a character map. For details,
23807 see the <parameter>man.charmap.use.subset</parameter>,
23808 <parameter>man.charmap.subset.profile</parameter>, and
23809 <parameter>man.charmap.subset.profile.english</parameter>
23810 parameters.</para>
23811
23812 </refsection>
23813 </refsection>
23814 </refentry>
23815
23816 <refentry version="5.0" id="man.charmap.uri">
23817 <refmeta>
23818 <refentrytitle>man.charmap.uri</refentrytitle>
23819 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
23820 </refmeta>
23821 <refnamediv>
23822 <refname>man.charmap.uri</refname>
23823 <refpurpose>URI for custom roff character map</refpurpose>
23824 </refnamediv>
23825
23826 <refsynopsisdiv>
23827 <programlisting id="man.charmap.uri.frag">
23828 &lt;xsl:param name="man.charmap.uri"&gt;&lt;/xsl:param&gt;
23829 </programlisting>
23830 </refsynopsisdiv>
23831
23832 <refsection><info><title>Description</title></info>
23833
23834 <para>For converting certain Unicode symbols and special characters in
23835 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23836 equivalents in man-page output, the DocBook XSL Stylesheets
23837 distribution includes an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
23838 map</link>. That character map can be considered the standard roff
23839 character map for the distribution.</para>
23840
23841 <para>If the value of the <parameter>man.charmap.uri</parameter>
23842 parameter is non-empty, that value is used as the URI for the location
23843 for an alternate roff character map to use in place of the standard
23844 roff character map provided in the distribution.</para>
23845
23846 <warning>
23847 <para>Do not set a value for <parameter>man.charmap.uri</parameter>
23848 unless you have a custom roff character map that differs from the
23849 standard one provided in the distribution.</para>
23850 </warning>
23851 </refsection>
23852 </refentry>
23853
23854 <refentry version="5.0" id="man.charmap.use.subset">
23855 <refmeta>
23856 <refentrytitle>man.charmap.use.subset</refentrytitle>
23857 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23858 </refmeta>
23859 <refnamediv>
23860 <refname>man.charmap.use.subset</refname>
23861 <refpurpose>Use subset of character map instead of full map?</refpurpose>
23862 </refnamediv>
23863
23864 <refsynopsisdiv>
23865 <programlisting id="man.charmap.use.subset.frag">
23866 &lt;xsl:param name="man.charmap.use.subset" select="1"&gt;&lt;/xsl:param&gt;
23867 </programlisting>
23868 </refsynopsisdiv>
23869
23870 <refsection><info><title>Description</title></info>
23871
23872 <para>If the value of the
23873 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
23874 a subset of the roff character map is used instead of the full roff
23875 character map. The profile of the subset used is determined either
23876 by the value of the
23877 <parameter>man.charmap.subset.profile</parameter>
23878 parameter (if the source is not in English) or the
23879 <parameter>man.charmap.subset.profile.english</parameter>
23880 parameter (if the source is in English).</para>
23881
23882 <note>
23883   <para>You may want to experiment with setting a non-zero value of
23884   <parameter>man.charmap.use.subset</parameter>, so that the full
23885   character map is used. Depending on which XSLT engine you run,
23886   setting a non-zero value for
23887   <parameter>man.charmap.use.subset</parameter> may significantly
23888   increase the time needed to process your documents. Or it may
23889   not. For example, if you set it and run it with xsltproc, it seems
23890   to dramatically increase processing time; on the other hand, if you
23891   set it and run it with Saxon, it does not seem to increase
23892   processing time nearly as much.</para>
23893
23894   <para>If processing time is not a important concern and/or you can
23895   tolerate the increase in processing time imposed by using the full
23896   character map, set <parameter>man.charmap.use.subset</parameter> to
23897   zero.</para>
23898 </note>
23899
23900 <refsection><info><title>Details</title></info>
23901
23902 <para>For converting certain Unicode symbols and special characters in
23903 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23904 equivalents in man-page output, the DocBook XSL Stylesheets
23905 distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
23906 map</link> format as detailed in the XSLT 2.0 specification. The map
23907 contains more than 800 character mappings and can be considered the
23908 standard roff character map for the distribution.</para>
23909
23910 <note>
23911 <para>You can use the <parameter>man.charmap.uri</parameter>
23912 parameter to specify a URI for the location for an alternate roff
23913 character map to use in place of the standard roff character map
23914 provided in the distribution.</para>
23915 </note>
23916
23917 <para>Because it is not terrifically efficient to use the standard
23918 800-character character map in full -- and for most (or all) users,
23919 never necessary to use it in full -- the DocBook XSL Stylesheets
23920 support a mechanism for using, within any given character map, a
23921 subset of character mappings instead of the full set. You can use the
23922 <parameter>man.charmap.subset.profile</parameter> or
23923 <parameter>man.charmap.subset.profile.english</parameter>
23924 parameter to tune the profile of that subset to use.</para>
23925
23926 </refsection>
23927 </refsection>
23928 </refentry>
23929
23930 <refentry version="5.0" id="man.charmap.subset.profile">
23931 <refmeta>
23932 <refentrytitle>man.charmap.subset.profile</refentrytitle>
23933 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23934 </refmeta>
23935 <refnamediv>
23936 <refname>man.charmap.subset.profile</refname>
23937 <refpurpose>Profile of character map subset</refpurpose>
23938 </refnamediv>
23939
23940 <refsynopsisdiv>
23941 <programlisting id="man.charmap.subset.profile.frag">
23942 &lt;xsl:param name="man.charmap.subset.profile"&gt;
23943 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
23944 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
23945  (@*[local-name() = 'class'] = 'symbols' or
23946   @*[local-name() = 'class'] = 'letters')
23947 ) or
23948 @*[local-name() = 'block'] = 'Latin Extended-A'
23949 or
23950 (@*[local-name() = 'block'] = 'General Punctuation' and
23951  (@*[local-name() = 'class'] = 'spaces' or
23952   @*[local-name() = 'class'] = 'dashes' or
23953   @*[local-name() = 'class'] = 'quotes' or
23954   @*[local-name() = 'class'] = 'bullets'
23955  )
23956 ) or
23957 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
23958 @*[local-name() = 'name'] = 'WORD JOINER' or
23959 @*[local-name() = 'name'] = 'SERVICE MARK' or
23960 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
23961 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
23962 &lt;/xsl:param&gt;
23963 </programlisting>
23964 </refsynopsisdiv>
23965
23966 <refsection><info><title>Description</title></info>
23967
23968 <para>If the value of the
23969 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
23970 and your DocBook source is not written in English (that
23971   is, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
23972   in your DocBook source or on the first <tag>refentry</tag>
23973   element in your source has a value other than
23974   <literal>en</literal>), then the character-map subset specified
23975   by the <parameter>man.charmap.subset.profile</parameter>
23976   parameter is used instead of the full roff character map.</para>
23977
23978 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root
23979   element in your DocBook
23980   source or on the first <tag>refentry</tag> element in your source
23981   has the value <literal>en</literal> or if it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute, then the character-map
23982   subset specified by the
23983   <parameter>man.charmap.subset.profile.english</parameter>
23984   parameter is used instead of
23985   <parameter>man.charmap.subset.profile</parameter>.</para>
23986
23987 <para>The difference between the two subsets is that
23988   <parameter>man.charmap.subset.profile</parameter> provides
23989   mappings for characters in Western European languages that are
23990   not part of the Roman (English) alphabet (ASCII character set).</para>
23991
23992 <para>The value of <parameter>man.charmap.subset.profile</parameter>
23993 is a string representing an XPath expression that matches attribute
23994 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>
23995 elements in the character map.</para>
23996
23997 <para>The attributes supported in the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map included in the distribution</link> are:
23998 <variablelist>
23999   <varlistentry>
24000     <term>character</term>
24001     <listitem>
24002       <simpara>a raw Unicode character or numeric Unicode
24003       character-entity value (either in decimal or hex); all
24004       characters have this attribute</simpara>
24005     </listitem>
24006   </varlistentry>
24007   <varlistentry>
24008     <term>name</term>
24009     <listitem>
24010       <simpara>a standard full/long ISO/Unicode character name (e.g.,
24011       "OHM SIGN"); all characters have this attribute</simpara>
24012     </listitem>
24013   </varlistentry>
24014   <varlistentry>
24015     <term>block</term>
24016     <listitem>
24017       <simpara>a standard Unicode "block" name (e.g., "General
24018       Punctuation"); all characters have this attribute. For the full
24019       list of Unicode block names supported in the standard roff
24020       character map, see <xref linkend="BlocksAndClasses"/>.</simpara>
24021     </listitem>
24022   </varlistentry>
24023   <varlistentry>
24024     <term>class</term>
24025     <listitem>
24026       <simpara>a class of characters (e.g., "spaces"). Not all
24027       characters have this attribute; currently, it is used only with
24028       certain characters within the "C1 Controls And Latin-1
24029       Supplement" and "General Punctuation" blocks. For details, see
24030       <xref linkend="BlocksAndClasses"/>.</simpara>
24031     </listitem>
24032   </varlistentry>
24033   <varlistentry>
24034     <term>entity</term>
24035     <listitem>
24036       <simpara>an ISO entity name (e.g., "ohm"); not all characters
24037       have this attribute, because not all characters have ISO entity
24038       names; for example, of the 800 or so characters in the standard
24039       roff character map included in the distribution, only around 300
24040       have ISO entity names.
24041       </simpara>
24042     </listitem>
24043   </varlistentry>
24044   <varlistentry>
24045     <term>string</term>
24046     <listitem>
24047       <simpara>a string representing an roff/groff escape-code (with
24048       "@esc@" used in place of the backslash), or a simple ASCII
24049       string; all characters in the roff character map have this
24050       attribute</simpara>
24051     </listitem>
24052   </varlistentry>
24053 </variablelist>
24054 </para>
24055 <para>The value of <parameter>man.charmap.subset.profile</parameter>
24056 is evaluated as an XPath expression at run-time to select a portion of
24057 the roff character map to use. You can tune the subset used by adding
24058 or removing parts. For example, if you need to use a wide range of
24059 mathematical operators in a document, and you want to have them
24060 converted into roff markup properly, you might add the following:
24061
24062 <literallayout class="monospaced">  @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>
24063
24064 That will cause a additional set of around 67 additional "math"
24065 characters to be converted into roff markup. </para>
24066
24067 <note>
24068 <para>Depending on which XSLT engine you use, either the EXSLT
24069 <function>dyn:evaluate</function> extension function (for xsltproc or
24070 Xalan) or <function>saxon:evaluate</function> extension function (for
24071 Saxon) are used to dynamically evaluate the value of
24072 <parameter>man.charmap.subset.profile</parameter> at run-time. If you
24073 don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that
24074 supports <function>dyn:evaluate</function> -- you must either set the
24075 value of the <parameter>man.charmap.use.subset</parameter> parameter
24076 to zero and process your documents using the full character map
24077 instead, or set the value of the
24078 <parameter>man.charmap.enabled</parameter> parameter to zero instead
24079 (so that character-map processing is disabled completely.</para>
24080 </note>
24081
24082 <para>An alternative to using
24083 <parameter>man.charmap.subset.profile</parameter> is to create your
24084 own custom character map, and set the value of
24085 <parameter>man.charmap.uri</parameter> to the URI/filename for
24086 that. If you use a custom character map, you will probably want to
24087 include in it just the characters you want to use, and so you will
24088 most likely also want to set the value of
24089 <parameter>man.charmap.use.subset</parameter> to zero.</para>
24090 <para>You can create a
24091 custom character map by making a copy of the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map</link> provided in the distribution, and
24092 then adding to, changing, and/or deleting from that.</para>
24093
24094 <caution>
24095 <para>If you author your DocBook XML source in UTF-8 or UTF-16
24096 encoding and aren't sure what OSes or environments your man-page
24097 output might end up being viewed on, and not sure what version of
24098 nroff/groff those environments might have, you should be careful about
24099 what Unicode symbols and special characters you use in your source and
24100 what parts you add to the value of
24101 <parameter>man.charmap.subset.profile</parameter>.</para>
24102 <para>Many of the escape codes used are specific to groff and using
24103 them may not provide the expected output on an OS or environment that
24104 uses nroff instead of groff.</para>
24105 <para>On the other hand, if you intend for your man-page output to be
24106 viewed only on modern systems (for example, GNU/Linux systems, FreeBSD
24107 systems, or Cygwin environments) that have a good, up-to-date groff,
24108 then you can safely include a wide range of Unicode symbols and
24109 special characters in your UTF-8 or UTF-16 encoded DocBook XML source
24110 and add any of the supported Unicode block names to the value of
24111 <parameter>man.charmap.subset.profile</parameter>.</para>
24112 </caution>
24113
24114
24115 <para>For other details, see the documentation for the
24116 <parameter>man.charmap.use.subset</parameter> parameter.</para>
24117
24118 <refsection id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>
24119   
24120
24121   <para>Below is the full list of Unicode block names and "class"
24122   values supported in the standard roff stylesheet provided in the
24123   distribution, along with a description of which codepoints from the
24124   Unicode range corresponding to that block name or block/class
24125   combination are supported.</para>
24126
24127   <itemizedlist>
24128     <listitem>
24129       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=C1%20Controls%20and%20Latin-1%20Supplement%20(Latin-1%20Supplement)">C1 Controls And Latin-1 Supplement (Latin-1 Supplement)</link> (x00a0 to x00ff)
24130       <itemizedlist><info><title>class values</title></info>
24131         
24132         <listitem>
24133           <para>symbols</para>
24134         </listitem>
24135         <listitem>
24136           <para>letters</para>
24137         </listitem>
24138       </itemizedlist></para>
24139     </listitem>
24140     <listitem>
24141       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Latin%20Extended-A">Latin Extended-A</link> (x0100 to x017f, partial)</para>
24142     </listitem>
24143     <listitem>
24144       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Spacing%20Modifier%20Letters">Spacing Modifier Letters</link> (x02b0 to x02ee, partial)</para>
24145     </listitem>
24146     <listitem>
24147       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Greek%20and%20Coptic">Greek and Coptic</link> (x0370 to x03ff, partial)</para>
24148     </listitem>
24149     <listitem>
24150       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)
24151       <itemizedlist><info><title>class values</title></info>
24152         
24153         <listitem>
24154           <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;start=8192&amp;end=8203">spaces</link></para>
24155         </listitem>
24156         <listitem>
24157           <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;start=8208&amp;end=8213">dashes</link></para>
24158         </listitem>
24159         <listitem>
24160           <para>quotes</para>
24161         </listitem>
24162         <listitem>
24163           <para>daggers</para>
24164         </listitem>
24165         <listitem>
24166           <para>bullets</para>
24167         </listitem>
24168         <listitem>
24169           <para>leaders</para>
24170         </listitem>
24171         <listitem>
24172           <para>primes</para>
24173         </listitem>
24174       </itemizedlist>
24175       </para>
24176     </listitem>
24177     <listitem>
24178       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Superscripts%20and%20Subscripts">Superscripts and Subscripts</link> (x2070 to x209f)</para>
24179     </listitem>
24180     <listitem>
24181       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>
24182     </listitem>
24183     <listitem>
24184       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>
24185     </listitem>
24186     <listitem>
24187       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>
24188     </listitem>
24189     <listitem>
24190       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>
24191     </listitem>
24192     <listitem>
24193       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Mathematical%20Operators">Mathematical Operators</link> (x2200 to x22ff, partial)</para>
24194     </listitem>
24195     <listitem>
24196       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>
24197     </listitem>
24198     <listitem>
24199       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>
24200     </listitem>
24201     <listitem>
24202       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Geometric%20Shapes">Geometric Shapes</link> (x25a0 to x25f7, partial)</para>
24203     </listitem>
24204     <listitem>
24205       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Miscellaneous%20Symbols">Miscellaneous Symbols</link> (x2600 to x26ff, partial)</para>
24206     </listitem>
24207     <listitem>
24208       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>
24209     </listitem>
24210     <listitem>
24211       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Alphabetic%20Presentation%20Forms">Alphabetic Presentation Forms</link> (xfb00 to xfb04 only)</para>
24212     </listitem>
24213   </itemizedlist>
24214 </refsection>
24215 </refsection>
24216 </refentry>
24217
24218 <refentry version="5.0" id="man.charmap.subset.profile.english">
24219 <refmeta>
24220 <refentrytitle>man.charmap.subset.profile.english</refentrytitle>
24221 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24222 </refmeta>
24223 <refnamediv>
24224 <refname>man.charmap.subset.profile.english</refname>
24225 <refpurpose>Profile of character map subset</refpurpose>
24226 </refnamediv>
24227
24228 <refsynopsisdiv>
24229 <programlisting id="man.charmap.subset.profile.english.frag">
24230 &lt;xsl:param name="man.charmap.subset.profile.english"&gt;
24231 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
24232 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
24233  @*[local-name() = 'class'] = 'symbols')
24234 or
24235 (@*[local-name() = 'block'] = 'General Punctuation' and
24236  (@*[local-name() = 'class'] = 'spaces' or
24237   @*[local-name() = 'class'] = 'dashes' or
24238   @*[local-name() = 'class'] = 'quotes' or
24239   @*[local-name() = 'class'] = 'bullets'
24240  )
24241 ) or
24242 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
24243 @*[local-name() = 'name'] = 'WORD JOINER' or
24244 @*[local-name() = 'name'] = 'SERVICE MARK' or
24245 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
24246 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
24247 &lt;/xsl:param&gt;
24248 </programlisting>
24249 </refsynopsisdiv>
24250
24251 <refsection><info><title>Description</title></info>
24252
24253 <para>If the value of the
24254   <parameter>man.charmap.use.subset</parameter> parameter is
24255   non-zero, and your DocBook source is written in English (that
24256   is, if its <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
24257   in your DocBook source or on the first <tag>refentry</tag>
24258   element in your source has the value <literal>en</literal> or if
24259   it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute), then the
24260   character-map subset specified by the
24261   <parameter>man.charmap.subset.profile.english</parameter>
24262   parameter is used instead of the full roff character map.</para>
24263
24264 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute
24265   on the root element in your DocBook source or on the first
24266   <tag>refentry</tag> element in your source has a value other
24267   than <literal>en</literal>, then the character-map subset
24268   specified by the
24269   <parameter>man.charmap.subset.profile</parameter> parameter is
24270   used instead of
24271   <parameter>man.charmap.subset.profile.english</parameter>.</para>
24272
24273 <para>The difference between the two subsets is that
24274   <parameter>man.charmap.subset.profile</parameter> provides
24275   mappings for characters in Western European languages that are
24276   not part of the Roman (English) alphabet (ASCII character set).</para>
24277
24278 <para>The value of <parameter>man.charmap.subset.profile.english</parameter>
24279 is a string representing an XPath expression that matches attribute
24280 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag> elements in the character map.</para>
24281
24282 <para>For other details, see the documentation for the
24283 <parameter>man.charmap.subset.profile.english</parameter> and
24284 <parameter>man.charmap.use.subset</parameter> parameters.</para>
24285
24286 </refsection>
24287 </refentry>
24288
24289 <refentry version="5.0" id="man.string.subst.map.local.pre">
24290 <refmeta>
24291 <refentrytitle>man.string.subst.map.local.pre</refentrytitle>
24292 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24293 </refmeta>
24294 <refnamediv>
24295 <refname>man.string.subst.map.local.pre</refname>
24296 <refpurpose>Specifies &#8220;local&#8221; string substitutions</refpurpose>
24297 </refnamediv>
24298
24299 <refsynopsisdiv>
24300 <programlisting id="man.string.subst.map.local.pre.frag">
24301   &lt;xsl:param name="man.string.subst.map.local.pre"&gt;&lt;/xsl:param&gt;
24302 </programlisting>
24303 </refsynopsisdiv>
24304
24305 <refsection><info><title>Description</title></info>
24306
24307 <para>Use the <parameter>man.string.subst.map.local.pre</parameter>
24308 parameter to specify any &#8220;local&#8221; string substitutions to perform over
24309 the entire roff source for each man page <emphasis>before</emphasis>
24310 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
24311
24312 <para>For details about the format of this parameter, see the
24313 documentation for the <parameter>man.string.subst.map</parameter>
24314 parameter.</para>
24315
24316 </refsection>
24317 </refentry>
24318
24319 <refentry version="5.0" id="man.string.subst.map">
24320 <refmeta>
24321 <refentrytitle>man.string.subst.map</refentrytitle>
24322 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
24323 </refmeta>
24324 <refnamediv>
24325 <refname>man.string.subst.map</refname>
24326 <refpurpose>Specifies a set of string substitutions</refpurpose>
24327 </refnamediv>
24328
24329 <refsynopsisdiv>
24330 <programlisting id="man.string.subst.map.frag">
24331 &lt;xsl:param name="man.string.subst.map"&gt;
24332
24333   &lt;!-- * remove no-break marker at beginning of line (stylesheet artifact) --&gt; 
24334   &lt;ss:substitution oldstring="&#9618;&#9600;" newstring="&#9618;"&gt;&lt;/ss:substitution&gt;
24335   &lt;!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space --&gt;
24336   &lt;ss:substitution oldstring="&#9600;" newstring="\ "&gt;&lt;/ss:substitution&gt;
24337
24338   &lt;!-- ==================================================================== --&gt;
24339
24340   &lt;!-- * squeeze multiple newlines before a roff request  --&gt;
24341   &lt;ss:substitution oldstring="
24342
24343 ." newstring="
24344 ."&gt;&lt;/ss:substitution&gt;
24345   &lt;!-- * remove any .sp instances that directly precede a .PP  --&gt;
24346   &lt;ss:substitution oldstring=".sp
24347 .PP" newstring=".PP"&gt;&lt;/ss:substitution&gt;
24348   &lt;!-- * remove any .sp instances that directly follow a .PP  --&gt;
24349   &lt;ss:substitution oldstring=".sp
24350 .sp" newstring=".sp"&gt;&lt;/ss:substitution&gt;
24351   &lt;!-- * squeeze multiple .sp instances into a single .sp--&gt;
24352   &lt;ss:substitution oldstring=".PP
24353 .sp" newstring=".PP"&gt;&lt;/ss:substitution&gt;
24354   &lt;!-- * squeeze multiple newlines after start of no-fill (verbatim) env. --&gt;
24355   &lt;ss:substitution oldstring=".nf
24356
24357 " newstring=".nf
24358 "&gt;&lt;/ss:substitution&gt;
24359   &lt;!-- * squeeze multiple newlines after REstoring margin --&gt;
24360   &lt;ss:substitution oldstring=".RE
24361
24362 " newstring=".RE
24363 "&gt;&lt;/ss:substitution&gt;
24364   &lt;!-- * U+2591 is a marker we add before and after every Parameter in --&gt;
24365   &lt;!-- * Funcprototype output --&gt;
24366   &lt;ss:substitution oldstring="&#9617;" newstring=" "&gt;&lt;/ss:substitution&gt;
24367   &lt;!-- * U+2592 is a marker we add for the newline before output of &lt;sbr&gt;; --&gt;
24368   &lt;ss:substitution oldstring="&#9618;" newstring="
24369 "&gt;&lt;/ss:substitution&gt;
24370   &lt;!-- * --&gt;
24371   &lt;!-- * Now deal with some other characters that are added by the --&gt;
24372   &lt;!-- * stylesheets during processing. --&gt;
24373   &lt;!-- * --&gt;
24374   &lt;!-- * bullet --&gt;
24375   &lt;ss:substitution oldstring="&#8226;" newstring="\(bu"&gt;&lt;/ss:substitution&gt;
24376   &lt;!-- * left double quote --&gt;
24377   &lt;ss:substitution oldstring="&#8220;" newstring="\(lq"&gt;&lt;/ss:substitution&gt;
24378   &lt;!-- * right double quote --&gt;
24379   &lt;ss:substitution oldstring="&#8221;" newstring="\(rq"&gt;&lt;/ss:substitution&gt;
24380   &lt;!-- * left single quote --&gt;
24381   &lt;ss:substitution oldstring="&#8216;" newstring="\(oq"&gt;&lt;/ss:substitution&gt;
24382   &lt;!-- * right single quote --&gt;
24383   &lt;ss:substitution oldstring="&#8217;" newstring="\(cq"&gt;&lt;/ss:substitution&gt;
24384   &lt;!-- * copyright sign --&gt;
24385   &lt;ss:substitution oldstring="&#169;" newstring="\(co"&gt;&lt;/ss:substitution&gt;
24386   &lt;!-- * registered sign --&gt;
24387   &lt;ss:substitution oldstring="&#174;" newstring="\(rg"&gt;&lt;/ss:substitution&gt;
24388   &lt;!-- * ...servicemark... --&gt;
24389   &lt;!-- * There is no groff equivalent for it. --&gt;
24390   &lt;ss:substitution oldstring="&#8480;" newstring="(SM)"&gt;&lt;/ss:substitution&gt;
24391   &lt;!-- * ...trademark... --&gt;
24392   &lt;!-- * We don't do "\(tm" because for console output, --&gt;
24393   &lt;!-- * groff just renders that as "tm"; that is: --&gt;
24394   &lt;!-- * --&gt;
24395   &lt;!-- *   Product&amp;#x2122; -&gt; Producttm --&gt;
24396   &lt;!-- * --&gt;
24397   &lt;!-- * So we just make it to "(TM)" instead; thus: --&gt;
24398   &lt;!-- * --&gt;
24399   &lt;!-- *   Product&amp;#x2122; -&gt; Product(TM) --&gt;
24400   &lt;ss:substitution oldstring="&#8482;" newstring="(TM)"&gt;&lt;/ss:substitution&gt;
24401
24402 &lt;/xsl:param&gt;
24403 </programlisting>
24404 </refsynopsisdiv>
24405
24406 <refsection><info><title>Description</title></info>
24407
24408 <para>The <parameter>man.string.subst.map</parameter> parameter
24409 contains <link linkend="map">a map</link> that specifies a set of
24410 string substitutions to perform over the entire roff source for each
24411 man page, either just before generating final man-page output (that
24412 is, before writing man-page files to disk) or, if the value of the
24413 <parameter>man.charmap.enabled</parameter> parameter is non-zero,
24414 before applying the roff character map.</para>
24415
24416 <para>You can use <parameter>man.string.subst.map</parameter> as a
24417 &#8220;lightweight&#8221; character map to perform &#8220;essential&#8221; substitutions --
24418 that is, substitutions that are <emphasis>always</emphasis> performed,
24419 even if the value of the <parameter>man.charmap.enabled</parameter>
24420 parameter is zero. For example, you can use it to replace quotation
24421 marks or other special characters that are generated by the DocBook
24422 XSL stylesheets for a particular locale setting (as opposed to those
24423 characters that are actually in source XML documents), or to replace
24424 any special characters that may be automatically generated by a
24425 particular customization of the DocBook XSL stylesheets.</para>
24426
24427 <warning>
24428   <para>Do you not change value of the
24429   <parameter>man.string.subst.map</parameter> parameter unless you are
24430   sure what you are doing. First consider adding your
24431   string-substitution mappings to either or both of the following
24432   parameters:
24433   <variablelist>
24434     <varlistentry>
24435       <term><parameter>man.string.subst.map.local.pre</parameter></term>
24436       <listitem><para>applied before
24437       <parameter>man.string.subst.map</parameter></para></listitem>
24438     </varlistentry>
24439     <varlistentry>
24440       <term><parameter>man.string.subst.map.local.post</parameter></term>
24441       <listitem><para>applied after
24442       <parameter>man.string.subst.map</parameter></para></listitem>
24443     </varlistentry>
24444   </variablelist>
24445   By default, both of those parameters contain no
24446   string substitutions. They are intended as a means for you to
24447   specify your own local string-substitution mappings.</para>
24448
24449   <para>If you remove any of default mappings from the value of the
24450   <parameter>man.string.subst.map</parameter> parameter, you are
24451   likely to end up with broken output. And be very careful about adding
24452   anything to it; it&#8217;s used for doing string substitution over the
24453   entire roff source of each man page &#8211; it causes target strings to be
24454   replaced in roff requests and escapes, not just in the visible
24455   contents of the page.</para>
24456
24457 </warning>
24458
24459 <refsection id="map">
24460   <info>
24461     <title>Contents of the substitution map</title>
24462   </info>
24463   <para>The string-substitution map contains one or more
24464   <tag>ss:substitution</tag> elements, each of which has two
24465   attributes:
24466   <variablelist>
24467     <varlistentry>
24468       <term>oldstring</term>
24469       <listitem>
24470         <simpara>string to replace</simpara>
24471       </listitem>
24472     </varlistentry>
24473     <varlistentry>
24474       <term>newstring</term>
24475       <listitem>
24476         <simpara>string with which to replace <tag class="attribute">oldstring</tag></simpara>
24477       </listitem>
24478     </varlistentry>
24479   </variablelist>
24480   It may also include XML comments (that is, delimited with
24481   "<literal>&lt;!--</literal>" and "<literal>--&gt;</literal>").
24482   </para>
24483 </refsection>
24484
24485 </refsection>
24486 </refentry>
24487
24488 <refentry version="5.0" id="man.string.subst.map.local.post">
24489 <refmeta>
24490 <refentrytitle>man.string.subst.map.local.post</refentrytitle>
24491 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24492 </refmeta>
24493 <refnamediv>
24494 <refname>man.string.subst.map.local.post</refname>
24495 <refpurpose>Specifies &#8220;local&#8221; string substitutions</refpurpose>
24496 </refnamediv>
24497
24498 <refsynopsisdiv>
24499 <programlisting id="man.string.subst.map.local.post.frag">
24500 &lt;xsl:param name="man.string.subst.map.local.post"&gt;&lt;/xsl:param&gt;
24501 </programlisting>
24502 </refsynopsisdiv>
24503
24504 <refsection><info><title>Description</title></info>
24505
24506 <para>Use the <parameter>man.string.subst.map.local.post</parameter>
24507 parameter to specify any &#8220;local&#8221; string substitutions to perform over
24508 the entire roff source for each man page <emphasis>after</emphasis>
24509 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
24510
24511 <para>For details about the format of this parameter, see the
24512 documentation for the <parameter>man.string.subst.map</parameter>
24513 parameter.</para>
24514
24515 </refsection>
24516 </refentry>
24517
24518   </reference><reference id="refmeta" xml:base="../manpages/param.xml">
24519   <title>Refentry metadata gathering</title>
24520 <refentry version="5.0" id="refentry.meta.get.quietly">
24521 <refmeta>
24522 <refentrytitle>refentry.meta.get.quietly</refentrytitle>
24523 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24524 </refmeta>
24525 <refnamediv>
24526 <refname>refentry.meta.get.quietly</refname>
24527 <refpurpose>Suppress notes and warnings when gathering refentry metadata?</refpurpose>
24528 </refnamediv>
24529
24530 <refsynopsisdiv>
24531 <programlisting id="refentry.meta.get.quietly.frag">
24532 &lt;xsl:param name="refentry.meta.get.quietly" select="0"&gt;&lt;/xsl:param&gt;
24533 </programlisting>
24534 </refsynopsisdiv>
24535
24536 <refsection><info><title>Description</title></info>
24537
24538 <para>If zero (the default), notes and warnings about &#8220;missing&#8221; markup
24539 are generated during gathering of refentry metadata. If non-zero, the
24540 metadata is gathered &#8220;quietly&#8221; -- that is, the notes and warnings are
24541 suppressed.</para>
24542
24543 <tip>
24544   <para>If you are processing a large amount of <tag>refentry</tag>
24545   content, you may be able to speed up processing significantly by
24546   setting a non-zero value for
24547   <parameter>refentry.meta.get.quietly</parameter>.</para>
24548 </tip>
24549
24550 </refsection>
24551 </refentry>
24552
24553 <refentry version="5.0" id="refentry.date.profile">
24554 <refmeta>
24555 <refentrytitle>refentry.date.profile</refentrytitle>
24556 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24557 </refmeta>
24558 <refnamediv>
24559 <refname>refentry.date.profile</refname>
24560 <refpurpose>Specifies profile for refentry "date" data</refpurpose>
24561 </refnamediv>
24562
24563 <refsynopsisdiv>
24564 <programlisting id="refentry.date.profile.frag">
24565 &lt;xsl:param name="refentry.date.profile"&gt;
24566   (($info[//date])[last()]/date)[1]|
24567   (($info[//pubdate])[last()]/pubdate)[1]
24568 &lt;/xsl:param&gt;
24569 </programlisting>
24570 </refsynopsisdiv>
24571
24572 <refsection><info><title>Description</title></info>
24573
24574 <para>The value of <parameter>refentry.date.profile</parameter> is a
24575 string representing an XPath expression. It is evaluated at run-time
24576 and used only if <parameter>refentry.date.profile.enabled</parameter>
24577 is non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering
24578 logic "hard coded" into the stylesheets is used.</para>
24579
24580 <para> The <literal>man(7)</literal> man page describes this content
24581 as "the date of the last revision". In man pages, it is the content
24582 that is usually displayed in the center footer.</para>
24583
24584 </refsection>
24585 </refentry>
24586
24587 <refentry version="5.0" id="refentry.date.profile.enabled">
24588 <refmeta>
24589 <refentrytitle>refentry.date.profile.enabled</refentrytitle>
24590 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24591 </refmeta>
24592 <refnamediv>
24593 <refname>refentry.date.profile.enabled</refname>
24594 <refpurpose>Enable refentry "date" profiling?</refpurpose>
24595 </refnamediv>
24596
24597 <refsynopsisdiv>
24598 <programlisting id="refentry.date.profile.enabled.frag">
24599 &lt;xsl:param name="refentry.date.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
24600 </refsynopsisdiv>
24601
24602 <refsection><info><title>Description</title></info>
24603
24604 <para>If the value of
24605 <parameter>refentry.date.profile.enabled</parameter> is non-zero, then
24606 during <tag>refentry</tag> metadata gathering, the info profile
24607 specified by the customizable
24608 <parameter>refentry.date.profile</parameter> parameter is used.</para>
24609
24610 <para>If instead the value of
24611 <parameter>refentry.date.profile.enabled</parameter> is zero (the
24612 default), then "hard coded" logic within the DocBook XSL stylesheets
24613 is used for gathering <tag>refentry</tag> "date" data.</para>
24614
24615 <para>If you find that the default <tag>refentry</tag>
24616 metadata-gathering behavior is causing incorrect "date" data to show
24617 up in your output, then consider setting a non-zero value for
24618 <parameter>refentry.date.profile.enabled</parameter> and adjusting the
24619 value of <parameter>refentry.date.profile</parameter> to cause correct
24620 data to be gathered. </para>
24621
24622 <para>Note that the terms "source" and "date" have special meanings in
24623 this context. For details, see the documentation for the
24624 <parameter>refentry.date.profile</parameter> parameter.</para>
24625
24626 </refsection>
24627 </refentry>
24628
24629 <refentry version="5.0" id="refentry.manual.profile">
24630 <refmeta>
24631 <refentrytitle>refentry.manual.profile</refentrytitle>
24632 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24633 </refmeta>
24634 <refnamediv>
24635 <refname>refentry.manual.profile</refname>
24636 <refpurpose>Specifies profile for refentry "manual" data</refpurpose>
24637 </refnamediv>
24638
24639 <refsynopsisdiv>
24640 <programlisting id="refentry.manual.profile.frag">
24641 &lt;xsl:param name="refentry.manual.profile"&gt;
24642   (($info[//title])[last()]/title)[1]|
24643   ../title/node()
24644 &lt;/xsl:param&gt;
24645 </programlisting>
24646 </refsynopsisdiv>
24647
24648 <refsection><info><title>Description</title></info>
24649
24650 <para>The value of <parameter>refentry.manual.profile</parameter> is
24651 a string representing an XPath expression. It is evaluated at
24652 run-time and used only if
24653 <parameter>refentry.manual.profile.enabled</parameter> is
24654 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24655 "hard coded" into the stylesheets is used.</para>
24656
24657 <para>In man pages, this content is usually displayed in the middle of
24658 the header of the page. The <literal>man(7)</literal> man page
24659 describes this as "the title of the manual (e.g., <citetitle>Linux
24660 Programmer's Manual</citetitle>)". Here are some examples from
24661 existing man pages:
24662 <itemizedlist>
24663   <listitem>
24664     <para><citetitle>dpkg utilities</citetitle>
24665     (<command>dpkg-name</command>)</para>
24666   </listitem>
24667   <listitem>
24668     <para><citetitle>User Contributed Perl Documentation</citetitle>
24669     (<command>GET</command>)</para>
24670   </listitem>
24671   <listitem>
24672     <para><citetitle>GNU Development Tools</citetitle>
24673     (<command>ld</command>)</para>
24674   </listitem>
24675   <listitem>
24676     <para><citetitle>Emperor Norton Utilities</citetitle>
24677     (<command>ddate</command>)</para>
24678   </listitem>
24679   <listitem>
24680     <para><citetitle>Debian GNU/Linux manual</citetitle>
24681     (<command>faked</command>)</para>
24682   </listitem>
24683   <listitem>
24684     <para><citetitle>GIMP Manual Pages</citetitle>
24685     (<command>gimp</command>)</para>
24686   </listitem>
24687   <listitem>
24688     <para><citetitle>KDOC Documentation System</citetitle>
24689     (<command>qt2kdoc</command>)</para>
24690   </listitem>
24691 </itemizedlist>
24692 </para>
24693
24694 </refsection>
24695 </refentry>
24696
24697 <refentry version="5.0" id="refentry.manual.profile.enabled">
24698 <refmeta>
24699 <refentrytitle>refentry.manual.profile.enabled</refentrytitle>
24700 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24701 </refmeta>
24702 <refnamediv>
24703 <refname>refentry.manual.profile.enabled</refname>
24704 <refpurpose>Enable refentry "manual" profiling?</refpurpose>
24705 </refnamediv>
24706
24707 <refsynopsisdiv>
24708 <programlisting id="refentry.manual.profile.enabled.frag">
24709 &lt;xsl:param name="refentry.manual.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
24710 </refsynopsisdiv>
24711
24712 <refsection><info><title>Description</title></info>
24713
24714 <para>If the value of
24715 <parameter>refentry.manual.profile.enabled</parameter> is
24716 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24717 profile specified by the customizable
24718 <parameter>refentry.manual.profile</parameter> parameter is
24719 used.</para>
24720
24721 <para>If instead the value of
24722 <parameter>refentry.manual.profile.enabled</parameter> is zero (the
24723 default), then "hard coded" logic within the DocBook XSL stylesheets
24724 is used for gathering <tag>refentry</tag> "manual" data.</para>
24725
24726 <para>If you find that the default <tag>refentry</tag>
24727 metadata-gathering behavior is causing incorrect "manual" data to show
24728 up in your output, then consider setting a non-zero value for
24729 <parameter>refentry.manual.profile.enabled</parameter> and adjusting
24730 the value of <parameter>refentry.manual.profile</parameter> to cause
24731 correct data to be gathered. </para>
24732
24733 <para>Note that the term "manual" has a special meanings in this
24734 context. For details, see the documentation for the
24735 <parameter>refentry.manual.profile</parameter> parameter.</para>
24736
24737 </refsection>
24738 </refentry>
24739
24740 <refentry version="5.0" id="refentry.source.name.suppress">
24741 <refmeta>
24742 <refentrytitle>refentry.source.name.suppress</refentrytitle>
24743 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24744 </refmeta>
24745 <refnamediv>
24746 <refname>refentry.source.name.suppress</refname>
24747 <refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose>
24748 </refnamediv>
24749
24750 <refsynopsisdiv>
24751 <programlisting id="refentry.source.name.suppress.frag">
24752 &lt;xsl:param name="refentry.source.name.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>
24753 </refsynopsisdiv>
24754
24755 <refsection><info><title>Description</title></info>
24756
24757 <para>If the value of
24758 <parameter>refentry.source.name.suppress</parameter> is non-zero, then
24759 during <tag>refentry</tag> metadata gathering, no "source name" data
24760 is added to the <tag>refentry</tag> "source" contents. Instead (unless
24761 <parameter>refentry.version.suppress</parameter> is also non-zero),
24762 only "version" data is added to the "source" contents.</para>
24763
24764 <para>If you find that the <tag>refentry</tag> metadata gathering
24765 mechanism is causing unwanted "source name" data to show up in your
24766 output -- for example, in the footer (or possibly header) of a man
24767 page -- then you might consider setting a non-zero value for
24768 <parameter>refentry.source.name.suppress</parameter>.</para>
24769
24770 <para>Note that the terms "source", "source name", and "version" have
24771 special meanings in this context. For details, see the documentation
24772 for the <parameter>refentry.source.name.profile</parameter>
24773 parameter.</para>
24774
24775 </refsection>
24776 </refentry>
24777
24778 <refentry version="5.0" id="refentry.source.name.profile">
24779 <refmeta>
24780 <refentrytitle>refentry.source.name.profile</refentrytitle>
24781 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24782 </refmeta>
24783 <refnamediv>
24784 <refname>refentry.source.name.profile</refname>
24785 <refpurpose>Specifies profile for refentry "source name" data</refpurpose>
24786 </refnamediv>
24787
24788 <refsynopsisdiv>
24789 <programlisting id="refentry.source.name.profile.frag">
24790 &lt;xsl:param name="refentry.source.name.profile"&gt;
24791   (($info[//productname])[last()]/productname)[1]|
24792   (($info[//corpname])[last()]/corpname)[1]|
24793   (($info[//corpcredit])[last()]/corpcredit)[1]|
24794   (($info[//corpauthor])[last()]/corpauthor)[1]|
24795   (($info[//orgname])[last()]/orgname)[1]|
24796   (($info[//publishername])[last()]/publishername)[1]
24797 &lt;/xsl:param&gt;
24798 </programlisting>
24799 </refsynopsisdiv>
24800
24801 <refsection><info><title>Description</title></info>
24802
24803 <para>The value of <parameter>refentry.source.name.profile</parameter>
24804 is a string representing an XPath expression. It is evaluated at
24805 run-time and used only if
24806 <parameter>refentry.source.name.profile.enabled</parameter> is
24807 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24808 "hard coded" into the stylesheets is used.</para>
24809
24810 <para>A "source name" is one part of a (potentially) two-part
24811 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>
24812 "source" field. In man pages, it is usually displayed in the left
24813 footer of the page. It typically indicates the software system or
24814 product that the item documented in the man page belongs to. The
24815 <literal>man(7)</literal> man page describes it as "the source of
24816 the command", and provides the following examples:
24817 <itemizedlist>
24818   <listitem>
24819     <para>For binaries, use something like: GNU, NET-2, SLS
24820     Distribution, MCC Distribution.</para>
24821   </listitem>
24822   <listitem>
24823     <para>For system calls, use the version of the kernel that you
24824     are currently looking at: Linux 0.99.11.</para>
24825   </listitem>
24826   <listitem>
24827     <para>For library calls, use the source of the function: GNU, BSD
24828     4.3, Linux DLL 4.4.1.</para>
24829   </listitem>
24830 </itemizedlist>
24831 </para>
24832
24833 <para>In practice, there are many pages that simply have a Version
24834 number in the "source" field. So, it looks like what we have is a
24835 two-part field,
24836 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>,
24837 where:
24838 <variablelist>
24839   <varlistentry>
24840     <term>Name</term>
24841     <listitem>
24842       <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
24843     </listitem>
24844   </varlistentry>
24845   <varlistentry>
24846     <term>Version</term>
24847     <listitem>
24848       <para>version number</para>
24849     </listitem>
24850   </varlistentry>
24851 </variablelist>
24852 Each part is optional. If the <replaceable>Name</replaceable> is a
24853 product name, then the <replaceable>Version</replaceable> is probably
24854 the version of the product. Or there may be no
24855 <replaceable>Name</replaceable>, in which case, if there is a
24856 <replaceable>Version</replaceable>, it is probably the version
24857 of the item itself, not the product it is part of. Or, if the
24858 <replaceable>Name</replaceable> is an organization name, then there
24859 probably will be no <replaceable>Version</replaceable>.</para>
24860 </refsection>
24861 </refentry>
24862
24863 <refentry version="5.0" id="refentry.source.name.profile.enabled">
24864 <refmeta>
24865 <refentrytitle>refentry.source.name.profile.enabled</refentrytitle>
24866 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24867 </refmeta>
24868 <refnamediv>
24869 <refname>refentry.source.name.profile.enabled</refname>
24870 <refpurpose>Enable refentry "source name" profiling?</refpurpose>
24871 </refnamediv>
24872
24873 <refsynopsisdiv>
24874 <programlisting id="refentry.source.name.profile.enabled.frag">
24875 &lt;xsl:param name="refentry.source.name.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
24876 </refsynopsisdiv>
24877
24878 <refsection><info><title>Description</title></info>
24879
24880 <para>If the value of
24881 <parameter>refentry.source.name.profile.enabled</parameter> is
24882 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24883 profile specified by the customizable
24884 <parameter>refentry.source.name.profile</parameter> parameter is
24885 used.</para>
24886
24887 <para>If instead the value of
24888 <parameter>refentry.source.name.profile.enabled</parameter> is zero (the
24889 default), then "hard coded" logic within the DocBook XSL stylesheets
24890 is used for gathering <tag>refentry</tag> "source name" data.</para>
24891
24892 <para>If you find that the default <tag>refentry</tag>
24893 metadata-gathering behavior is causing incorrect "source name" data to
24894 show up in your output, then consider setting a non-zero value for
24895 <parameter>refentry.source.name.profile.enabled</parameter> and
24896 adjusting the value of
24897 <parameter>refentry.source.name.profile</parameter> to cause correct
24898 data to be gathered. </para>
24899
24900 <para>Note that the terms "source" and "source name" have special
24901 meanings in this context. For details, see the documentation for the
24902 <parameter>refentry.source.name.profile</parameter> parameter.</para>
24903
24904 </refsection>
24905 </refentry>
24906
24907 <refentry version="5.0" id="refentry.version.suppress">
24908 <refmeta>
24909 <refentrytitle>refentry.version.suppress</refentrytitle>
24910 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24911 </refmeta>
24912 <refnamediv>
24913 <refname>refentry.version.suppress</refname>
24914 <refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose>
24915 </refnamediv>
24916
24917 <refsynopsisdiv>
24918 <programlisting id="refentry.version.suppress.frag">
24919 &lt;xsl:param name="refentry.version.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>
24920 </refsynopsisdiv>
24921
24922 <refsection><info><title>Description</title></info>
24923
24924 <para>If the value of <parameter>refentry.version.suppress</parameter>
24925 is non-zero, then during <tag>refentry</tag> metadata gathering, no
24926 "version" data is added to the <tag>refentry</tag> "source"
24927 contents. Instead (unless
24928 <parameter>refentry.source.name.suppress</parameter> is also
24929 non-zero), only "source name" data is added to the "source"
24930 contents.</para>
24931
24932 <para>If you find that the <tag>refentry</tag> metadata gathering
24933 mechanism is causing unwanted "version" data to show up in your output
24934 -- for example, in the footer (or possibly header) of a man page --
24935 then you might consider setting a non-zero value for
24936 <parameter>refentry.version.suppress</parameter>.</para>
24937
24938 <para>Note that the terms "source", "source name", and "version" have
24939 special meanings in this context. For details, see the documentation
24940 for the <parameter>refentry.source.name.profile</parameter>
24941 parameter.</para>
24942
24943 </refsection>
24944 </refentry>
24945
24946 <refentry version="5.0" id="refentry.version.profile">
24947 <refmeta>
24948 <refentrytitle>refentry.version.profile</refentrytitle>
24949 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24950 </refmeta>
24951 <refnamediv>
24952 <refname>refentry.version.profile</refname>
24953 <refpurpose>Specifies profile for refentry "version" data</refpurpose>
24954 </refnamediv>
24955
24956 <refsynopsisdiv>
24957 <programlisting id="refentry.version.profile.frag">
24958 &lt;xsl:param name="refentry.version.profile"&gt;
24959   (($info[//productnumber])[last()]/productnumber)[1]|
24960   (($info[//edition])[last()]/edition)[1]|
24961   (($info[//releaseinfo])[last()]/releaseinfo)[1]
24962 &lt;/xsl:param&gt;
24963 </programlisting>
24964 </refsynopsisdiv>
24965
24966 <refsection><info><title>Description</title></info>
24967
24968 <para>The value of <parameter>refentry.version.profile</parameter> is
24969 a string representing an XPath expression. It is evaluated at
24970 run-time and used only if
24971 <parameter>refentry.version.profile.enabled</parameter> is
24972 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24973 "hard coded" into the stylesheets is used.</para>
24974
24975 <para>A "source.name" is one part of a (potentially) two-part
24976 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>
24977 "source" field. For more details, see the documentation for the
24978 <parameter>refentry.source.name.profile</parameter> parameter.</para>
24979
24980 </refsection>
24981 </refentry>
24982
24983 <refentry version="5.0" id="refentry.version.profile.enabled">
24984 <refmeta>
24985 <refentrytitle>refentry.version.profile.enabled</refentrytitle>
24986 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24987 </refmeta>
24988 <refnamediv>
24989 <refname>refentry.version.profile.enabled</refname>
24990 <refpurpose>Enable refentry "version" profiling?</refpurpose>
24991 </refnamediv>
24992
24993 <refsynopsisdiv>
24994 <programlisting id="refentry.version.profile.enabled.frag">
24995 &lt;xsl:param name="refentry.version.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
24996 </refsynopsisdiv>
24997
24998 <refsection><info><title>Description</title></info>
24999
25000 <para>If the value of
25001 <parameter>refentry.version.profile.enabled</parameter> is
25002 non-zero, then during <tag>refentry</tag> metadata gathering, the info
25003 profile specified by the customizable
25004 <parameter>refentry.version.profile</parameter> parameter is
25005 used.</para>
25006
25007 <para>If instead the value of
25008 <parameter>refentry.version.profile.enabled</parameter> is zero (the
25009 default), then "hard coded" logic within the DocBook XSL stylesheets
25010 is used for gathering <tag>refentry</tag> "version" data.</para>
25011
25012 <para>If you find that the default <tag>refentry</tag>
25013 metadata-gathering behavior is causing incorrect "version" data to show
25014 up in your output, then consider setting a non-zero value for
25015 <parameter>refentry.version.profile.enabled</parameter> and adjusting
25016 the value of <parameter>refentry.version.profile</parameter> to cause
25017 correct data to be gathered. </para>
25018
25019 <para>Note that the terms "source" and "version" have special
25020 meanings in this context. For details, see the documentation for the
25021 <parameter>refentry.version.profile</parameter> parameter.</para>
25022
25023 </refsection>
25024 </refentry>
25025
25026 <refentry version="5.0" id="refentry.manual.fallback.profile">
25027 <refmeta>
25028 <refentrytitle>refentry.manual.fallback.profile</refentrytitle>
25029 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25030 </refmeta>
25031 <refnamediv>
25032 <refname>refentry.manual.fallback.profile</refname>
25033 <refpurpose>Specifies profile of "fallback" for refentry "manual" data</refpurpose>
25034 </refnamediv>
25035
25036 <refsynopsisdiv>
25037 <programlisting id="refentry.manual.fallback.profile.frag">
25038 &lt;xsl:param name="refentry.manual.fallback.profile"&gt;
25039 refmeta/refmiscinfo[not(@class = 'date')][1]/node()&lt;/xsl:param&gt;
25040 </programlisting>
25041 </refsynopsisdiv>
25042
25043 <refsection><info><title>Description</title></info>
25044
25045 <para>The value of
25046 <parameter>refentry.manual.fallback.profile</parameter> is a string
25047 representing an XPath expression. It is evaluated at run-time and
25048 used only if no "manual" data can be found by other means (that is,
25049 either using the <tag>refentry</tag> metadata-gathering logic "hard
25050 coded" in the stylesheets, or the value of
25051 <parameter>refentry.manual.profile</parameter>, if it is
25052 enabled).</para>
25053
25054 <important>
25055 <para>Depending on which XSLT engine you run, either the EXSLT
25056 <function>dyn:evaluate</function> extension function (for xsltproc or
25057 Xalan) or <function>saxon:evaluate</function> extension function (for
25058 Saxon) are used to dynamically evaluate the value of
25059 <parameter>refentry.manual.fallback.profile</parameter> at
25060 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
25061 XSLT engine that supports <function>dyn:evaluate</function> -- you
25062 must manually disable fallback processing by setting an empty value
25063 for the <parameter>refentry.manual.fallback.profile</parameter>
25064 parameter.</para>
25065 </important>
25066
25067 </refsection>
25068 </refentry>
25069
25070 <refentry version="5.0" id="refentry.source.fallback.profile">
25071 <refmeta>
25072 <refentrytitle>refentry.source.fallback.profile</refentrytitle>
25073 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25074 </refmeta>
25075 <refnamediv>
25076 <refname>refentry.source.fallback.profile</refname>
25077 <refpurpose>Specifies profile of "fallback" for refentry "source" data</refpurpose>
25078 </refnamediv>
25079
25080 <refsynopsisdiv>
25081 <programlisting id="refentry.source.fallback.profile.frag">
25082 &lt;xsl:param name="refentry.source.fallback.profile"&gt;
25083 refmeta/refmiscinfo[not(@class = 'date')][1]/node()&lt;/xsl:param&gt;
25084 </programlisting>
25085 </refsynopsisdiv>
25086
25087 <refsection><info><title>Description</title></info>
25088
25089 <para>The value of
25090 <parameter>refentry.source.fallback.profile</parameter> is a string
25091 representing an XPath expression. It is evaluated at run-time and used
25092 only if no "source" data can be found by other means (that is, either
25093 using the <tag>refentry</tag> metadata-gathering logic "hard coded" in
25094 the stylesheets, or the value of the
25095 <parameter>refentry.source.name.profile</parameter> and
25096 <parameter>refentry.version.profile</parameter> parameters, if those
25097 are enabled).</para>
25098
25099 <important>
25100 <para>Depending on which XSLT engine you run, either the EXSLT
25101 <function>dyn:evaluate</function> extension function (for xsltproc or
25102 Xalan) or <function>saxon:evaluate</function> extension function (for
25103 Saxon) are used to dynamically evaluate the value of
25104 <parameter>refentry.source.fallback.profile</parameter> at
25105 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
25106 XSLT engine that supports <function>dyn:evaluate</function> -- you
25107 must manually disable fallback processing by setting an empty value
25108 for the <parameter>refentry.source.fallback.profile</parameter>
25109 parameter.</para>
25110 </important>
25111
25112 </refsection>
25113 </refentry>
25114
25115   </reference><reference id="th" xml:base="../manpages/param.xml">
25116   <title>Page header/footer</title>
25117 <refentry version="5.0" id="man.th.extra1.suppress">
25118 <refmeta>
25119 <refentrytitle>man.th.extra1.suppress</refentrytitle>
25120 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25121 </refmeta>
25122 <refnamediv>
25123 <refname>man.th.extra1.suppress</refname>
25124 <refpurpose>Suppress extra1 part of header/footer?</refpurpose>
25125 </refnamediv>
25126
25127 <refsynopsisdiv>
25128 <programlisting id="man.th.extra1.suppress.frag">
25129 &lt;xsl:param name="man.th.extra1.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>
25130 </refsynopsisdiv>
25131
25132 <refsection><info><title>Description</title></info>
25133
25134 <para>If the value of <parameter>man.th.extra1.suppress</parameter> is
25135 non-zero, then the <literal>extra1</literal> part of the
25136 <literal>.TH</literal> title line header/footer is suppressed.</para>
25137
25138 <para>The content of the <literal>extra1</literal> field is almost
25139 always displayed in the center footer of the page and is, universally,
25140 a date.</para>
25141
25142 </refsection>
25143 </refentry>
25144
25145 <refentry version="5.0" id="man.th.extra2.suppress">
25146 <refmeta>
25147 <refentrytitle>man.th.extra2.suppress</refentrytitle>
25148 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25149 </refmeta>
25150 <refnamediv>
25151 <refname>man.th.extra2.suppress</refname>
25152 <refpurpose>Suppress extra2 part of header/footer?</refpurpose>
25153 </refnamediv>
25154
25155 <refsynopsisdiv>
25156 <programlisting id="man.th.extra2.suppress.frag">
25157 &lt;xsl:param name="man.th.extra2.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>
25158 </refsynopsisdiv>
25159
25160 <refsection><info><title>Description</title></info>
25161
25162 <para>If the value of <parameter>man.th.extra2.suppress</parameter> is
25163 non-zero, then the <literal>extra2</literal> part of the
25164 <literal>.TH</literal> title line header/footer is suppressed.</para>
25165
25166 <para>The content of the <literal>extra2</literal> field is usually
25167 displayed in the left footer of the page and is typically "source"
25168 data, often in the form
25169 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>;
25170 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
25171 man page).</para>
25172
25173 <note>
25174   <para>You can use the
25175   <parameter>refentry.source.name.suppress</parameter> and
25176   <parameter>refentry.version.suppress</parameter> parameters to
25177   independently suppress the <replaceable>Name</replaceable> and
25178   <replaceable>Version</replaceable> parts of the
25179   <literal>extra2</literal> field.</para>
25180 </note>
25181
25182 </refsection>
25183 </refentry>
25184
25185 <refentry version="5.0" id="man.th.extra3.suppress">
25186 <refmeta>
25187 <refentrytitle>man.th.extra3.suppress</refentrytitle>
25188 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25189 </refmeta>
25190 <refnamediv>
25191 <refname>man.th.extra3.suppress</refname>
25192 <refpurpose>Suppress extra3 part of header/footer?</refpurpose>
25193 </refnamediv>
25194
25195 <refsynopsisdiv>
25196 <programlisting id="man.th.extra3.suppress.frag">
25197 &lt;xsl:param name="man.th.extra3.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>
25198 </refsynopsisdiv>
25199
25200 <refsection><info><title>Description</title></info>
25201
25202 <para>If the value of <parameter>man.th.extra3.suppress</parameter> is
25203 non-zero, then the <literal>extra3</literal> part of the
25204 <literal>.TH</literal> title line header/footer is
25205 suppressed.</para>
25206
25207 <para>The content of the <literal>extra3</literal> field is usually
25208 displayed in the middle header of the page and is typically a "manual
25209 name"; for example, "GTK+ User's Manual" (from the
25210 <literal>gtk-options(7)</literal> man page).</para>
25211
25212 </refsection>
25213 </refentry>
25214
25215 <refentry version="5.0" id="man.th.title.max.length">
25216 <refmeta>
25217 <refentrytitle>man.th.title.max.length</refentrytitle>
25218 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
25219 </refmeta>
25220 <refnamediv>
25221 <refname>man.th.title.max.length</refname>
25222 <refpurpose>Maximum length of title in header/footer</refpurpose>
25223 </refnamediv>
25224
25225 <refsynopsisdiv>
25226 <programlisting id="man.th.title.max.length.frag">
25227 &lt;xsl:param name="man.th.title.max.length"&gt;20&lt;/xsl:param&gt;
25228 </programlisting>
25229 </refsynopsisdiv>
25230
25231 <refsection><info><title>Description</title></info>
25232
25233 <para>Specifies the maximum permitted length of the title part of the
25234 man-page <literal>.TH</literal> title line header/footer. If the title
25235 exceeds the maxiumum specified, it is truncated down to the maximum
25236 permitted length.</para>
25237
25238 <refsection><info><title>Details</title></info>
25239   
25240
25241 <para>Every man page generated using the DocBook stylesheets has a
25242 title line, specified using the <literal>TH</literal> roff
25243 macro. Within that title line, there is always, at a minimum, a title,
25244 followed by a section value (representing a man "section" -- usually
25245 just a number).</para>
25246
25247 <para>The title and section are displayed, together, in the visible
25248 header of each page. Where in the header they are displayed depends on
25249 OS the man page is viewed on, and on what version of nroff/groff/man
25250 is used for viewing the page. But, at a minimum and across all
25251 systems, the title and section are displayed on the right-hand column
25252 of the header. On many systems -- those with a modern groff, including
25253 Linux systems -- they are displayed twice: both in the left and right
25254 columns of the header.</para>
25255
25256 <para>So if the length of the title exceeds a certain percentage of
25257 the column width in which the page is viewed, the left and right
25258 titles can end up overlapping, making them unreadable, or breaking to
25259 another line, which doesn't look particularly good.</para>
25260
25261 <para>So the stylesheets provide the
25262 <parameter>man.th.title.max.length</parameter> parameter as a means
25263 for truncating titles that exceed the maximum length that can be
25264 viewing properly in a page header.</para>
25265
25266 <para>The default value is reasonable but somewhat arbitrary. If you
25267 have pages with long titles, you may want to experiment with changing
25268 the value in order to achieve the correct aesthetic results.</para>
25269 </refsection>
25270
25271 </refsection>
25272 </refentry>
25273
25274 <refentry version="5.0" id="man.th.extra2.max.length">
25275 <refmeta>
25276 <refentrytitle>man.th.extra2.max.length</refentrytitle>
25277 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
25278 </refmeta>
25279 <refnamediv>
25280 <refname>man.th.extra2.max.length</refname>
25281 <refpurpose>Maximum length of extra2 in header/footer</refpurpose>
25282 </refnamediv>
25283
25284 <refsynopsisdiv>
25285 <programlisting id="man.th.extra2.max.length.frag">
25286 &lt;xsl:param name="man.th.extra2.max.length"&gt;30&lt;/xsl:param&gt;
25287 </programlisting>
25288 </refsynopsisdiv>
25289
25290 <refsection><info><title>Description</title></info>
25291
25292 <para>Specifies the maximum permitted length of the
25293 <literal>extra2</literal> part of the man-page part of the
25294 <literal>.TH</literal> title line header/footer. If the
25295 <literal>extra2</literal> content exceeds the maxiumum specified, it
25296 is truncated down to the maximum permitted length.</para>
25297
25298 <para>The content of the <literal>extra2</literal> field is usually
25299 displayed in the left footer of the page and is typically "source"
25300 data indicating the software system or product that the item
25301 documented in the man page belongs to, often in the form
25302 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>;
25303 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
25304 man page).</para>
25305
25306 <para>The default value for this parameter is reasonable but somewhat
25307 arbitrary. If you are processing pages with long "source" information,
25308 you may want to experiment with changing the value in order to achieve
25309 the correct aesthetic results.</para>
25310 </refsection>
25311 </refentry>
25312
25313 <refentry version="5.0" id="man.th.extra3.max.length">
25314 <refmeta>
25315 <refentrytitle>man.th.extra3.max.length</refentrytitle>
25316 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
25317 </refmeta>
25318 <refnamediv>
25319 <refname>man.th.extra3.max.length</refname>
25320 <refpurpose>Maximum length of extra3 in header/footer</refpurpose>
25321 </refnamediv>
25322
25323 <refsynopsisdiv>
25324 <programlisting id="man.th.extra3.max.length.frag">
25325 &lt;xsl:param name="man.th.extra3.max.length"&gt;30&lt;/xsl:param&gt;
25326 </programlisting>
25327 </refsynopsisdiv>
25328
25329 <refsection><info><title>Description</title></info>
25330
25331 <para>Specifies the maximum permitted length of the
25332 <literal>extra3</literal> part of the man-page <literal>.TH</literal>
25333 title line header/footer. If the <literal>extra3</literal> content
25334 exceeds the maxiumum specified, it is truncated down to the maximum
25335 permitted length.</para>
25336
25337 <para>The content of the <literal>extra3</literal> field is usually
25338 displayed in the middle header of the page and is typically a "manual
25339 name"; for example, "GTK+ User's Manual" (from the
25340 <literal>gtk-options(7)</literal> man page).</para>
25341
25342 <para>The default value for this parameter is reasonable but somewhat
25343 arbitrary. If you are processing pages with long "manual names" -- or
25344 especially if you are processing pages that have both long "title"
25345 parts (command/function, etc. names) <emphasis>and</emphasis> long
25346 manual names -- you may want to experiment with changing the value in
25347 order to achieve the correct aesthetic results.</para>
25348 </refsection>
25349 </refentry>
25350
25351   </reference><reference id="output" xml:base="../manpages/param.xml">
25352   <title>Output</title>
25353 <refentry version="5.0" id="man.output.manifest.enabled">
25354   <refmeta>
25355     <refentrytitle>man.output.manifest.enabled</refentrytitle>
25356     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25357   </refmeta>
25358   <refnamediv>
25359     <refname>man.output.manifest.enabled</refname>
25360     <refpurpose>Generate a manifest file?</refpurpose>
25361   </refnamediv>
25362
25363   <refsynopsisdiv>
25364     <programlisting id="man.output.manifest.enabled.frag">&lt;xsl:param name="man.output.manifest.enabled" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
25365   </refsynopsisdiv>
25366
25367   <refsection><info><title>Description</title></info>
25368
25369     <para>If non-zero, a list of filenames for man pages generated by
25370     the stylesheet transformation is written to the file named by the
25371     <parameter>man.output.manifest.filename</parameter> parameter.</para>
25372
25373   </refsection>
25374 </refentry>
25375
25376 <refentry version="5.0" id="man.output.manifest.filename">
25377   <refmeta>
25378     <refentrytitle>man.output.manifest.filename</refentrytitle>
25379     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25380   </refmeta>
25381   <refnamediv>
25382     <refname>man.output.manifest.filename</refname>
25383     <refpurpose>Name of manifest file</refpurpose>
25384   </refnamediv>
25385
25386   <refsynopsisdiv>
25387     <programlisting id="man.output.manifest.filename.frag">&lt;xsl:param name="man.output.manifest.filename"&gt;MAN.MANIFEST&lt;/xsl:param&gt;</programlisting>
25388   </refsynopsisdiv>
25389
25390   <refsection><info><title>Description</title></info>
25391
25392     <para>The <parameter>man.output.manifest.filename</parameter> parameter
25393     specifies the name of the file to which the manpages manifest file
25394     is written (if the value of the
25395     <parameter>man.output.manifest.enabled</parameter> parameter is
25396     non-zero).</para>
25397
25398   </refsection>
25399 </refentry>
25400
25401 <refentry version="5.0" id="man.output.in.separate.dir">
25402 <refmeta>
25403 <refentrytitle>man.output.in.separate.dir</refentrytitle>
25404 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25405 </refmeta>
25406 <refnamediv>
25407 <refname>man.output.in.separate.dir</refname>
25408 <refpurpose>Output man-page files in separate output directory?</refpurpose>
25409 </refnamediv>
25410
25411 <refsynopsisdiv>
25412 <programlisting id="man.output.in.separate.dir.frag">
25413 &lt;xsl:param name="man.output.in.separate.dir" select="0"&gt;&lt;/xsl:param&gt;
25414 </programlisting>
25415 </refsynopsisdiv>
25416
25417 <refsection><info><title>Description</title></info>
25418
25419 <para>If the value of <literal>man.output.in.separate.dir</literal>
25420 parameter is non-zero, man-page files are output in a separate
25421 directory, specified by the <parameter>man.output.base.dir</parameter>
25422 parameter; otherwise, if the value of
25423 <literal>man.output.in.separate.dir</literal> is zero, man-page files
25424 are not output in a separate directory.</para>
25425
25426 </refsection>
25427 </refentry>
25428
25429 <refentry version="5.0" id="man.output.lang.in.name.enabled">
25430 <refmeta>
25431 <refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
25432 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25433 </refmeta>
25434 <refnamediv>
25435 <refname>man.output.lang.in.name.enabled</refname>
25436 <refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
25437 </refnamediv>
25438
25439 <refsynopsisdiv>
25440 <programlisting id="man.output.lang.in.name.enabled.frag">
25441 &lt;xsl:param name="man.output.lang.in.name.enabled" select="0"&gt;&lt;/xsl:param&gt;
25442 </programlisting>
25443 </refsynopsisdiv>
25444
25445 <refsection><info><title>Description</title></info>
25446
25447   <para>The <parameter>man.output.lang.in.name.enabled</parameter>
25448   parameter specifies whether a <literal>$lang</literal> value is
25449   included in man-page filenames and pathnames.</para>
25450
25451   <para>If the value of
25452   <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
25453   man-page files are output with the <literal>$lang</literal> value
25454   included in their filenames or pathnames as follows;
25455
25456   <itemizedlist>
25457     <listitem>
25458       <para>if <parameter>man.output.subdirs.enabled</parameter> is
25459       non-zero, each file is output to, e.g., a
25460       <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
25461       pathname</para>
25462     </listitem>
25463     <listitem>
25464       <para>if <parameter>man.output.subdirs.enabled</parameter> is
25465       zero, each file is output with a
25466       <literal>foo.<replaceable>$lang</replaceable>.8</literal>
25467       filename</para>
25468     </listitem>
25469   </itemizedlist>
25470   </para>
25471
25472 </refsection>
25473 </refentry>
25474
25475 <refentry version="5.0" id="man.output.base.dir">
25476 <refmeta>
25477 <refentrytitle>man.output.base.dir</refentrytitle>
25478 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25479 </refmeta>
25480 <refnamediv>
25481 <refname>man.output.base.dir</refname>
25482 <refpurpose>Specifies separate output directory</refpurpose>
25483 </refnamediv>
25484
25485 <refsynopsisdiv>
25486 <programlisting id="man.output.base.dir.frag">&lt;xsl:param name="man.output.base.dir"&gt;man/&lt;/xsl:param&gt;</programlisting>
25487 </refsynopsisdiv>
25488
25489 <refsection><info><title>Description</title></info>
25490
25491 <para>The <parameter>man.output.base.dir</parameter> parameter
25492 specifies the base directory into which man-page files are output. The
25493 <parameter>man.output.subdirs.enabled</parameter> parameter controls
25494 whether the files are output in subdirectories within the base
25495 directory.</para>
25496
25497 <note>
25498   <para>The values of the <parameter>man.output.base.dir</parameter>
25499   and <parameter>man.output.subdirs.enabled</parameter> parameters are
25500   used only if the value of
25501   <parameter>man.output.in.separate.dir</parameter> parameter is
25502   non-zero. If the value of the
25503   <parameter>man.output.in.separate.dir</parameter> is zero, man-page
25504   files are not output in a separate directory.</para>
25505 </note>
25506
25507 </refsection>
25508 </refentry>
25509
25510 <refentry version="5.0" id="man.output.subdirs.enabled">
25511 <refmeta>
25512 <refentrytitle>man.output.subdirs.enabled</refentrytitle>
25513 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25514 </refmeta>
25515 <refnamediv>
25516 <refname>man.output.subdirs.enabled</refname>
25517 <refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>
25518 </refnamediv>
25519
25520 <refsynopsisdiv>
25521 <programlisting id="man.output.subdirs.enabled.frag">
25522 &lt;xsl:param name="man.output.subdirs.enabled" select="1"&gt;&lt;/xsl:param&gt;
25523 </programlisting>
25524 </refsynopsisdiv>
25525
25526 <refsection><info><title>Description</title></info>
25527
25528 <para>The <parameter>man.output.subdirs.enabled</parameter> parameter
25529 controls whether man-pages files are output in subdirectories within
25530 the base directory specified by the directory specified by the
25531 <parameter>man.output.base.dir</parameter> parameter.</para>
25532
25533 <note>
25534   <para>The values of the <parameter>man.output.base.dir</parameter>
25535   and <parameter>man.output.subdirs.enabled</parameter> parameters are
25536   used only if the value of
25537   <parameter>man.output.in.separate.dir</parameter> parameter is
25538   non-zero. If the value of the
25539   <parameter>man.output.in.separate.dir</parameter> is zero, man-page
25540   files are not output in a separate directory.</para>
25541 </note>
25542
25543 </refsection>
25544 </refentry>
25545
25546 <refentry version="5.0" id="man.output.quietly">
25547 <refmeta>
25548 <refentrytitle>man.output.quietly</refentrytitle>
25549 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25550 </refmeta>
25551 <refnamediv>
25552 <refname>man.output.quietly</refname>
25553 <refpurpose>Suppress filename messages emitted when generating output?</refpurpose>
25554 </refnamediv>
25555
25556 <refsynopsisdiv>
25557 <programlisting id="man.output.quietly.frag">
25558 &lt;xsl:param name="man.output.quietly" select="0"&gt;&lt;/xsl:param&gt;
25559 </programlisting>
25560 </refsynopsisdiv>
25561
25562 <refsection><info><title>Description</title></info>
25563
25564 <para>If zero (the default), for each man-page file created, a message
25565 with the name of the file is emitted. If non-zero, the files are
25566 output "quietly" -- that is, the filename messages are
25567 suppressed.</para>
25568
25569 <tip>
25570   <para>If you are processing a large amount of <tag>refentry</tag>
25571   content, you may be able to speed up processing significantly by
25572   setting a non-zero value for
25573   <parameter>man.output.quietly</parameter>.</para>
25574 </tip>
25575
25576 </refsection>
25577 </refentry>
25578
25579 <refentry version="5.0" id="man.output.encoding">
25580 <refmeta>
25581 <refentrytitle>man.output.encoding</refentrytitle>
25582 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25583 </refmeta>
25584 <refnamediv>
25585 <refname>man.output.encoding</refname>
25586 <refpurpose>Encoding used for man-page output</refpurpose>
25587 </refnamediv>
25588
25589 <refsynopsisdiv>
25590 <programlisting id="man.output.encoding.frag">
25591 &lt;xsl:param name="man.output.encoding"&gt;UTF-8&lt;/xsl:param&gt;
25592 </programlisting>
25593 </refsynopsisdiv>
25594
25595 <refsection><info><title>Description</title></info>
25596
25597 <para>This parameter specifies the encoding to use for files generated
25598 by the manpages stylesheet. Not all processors support specification
25599 of this parameter.</para>
25600
25601 <important>
25602   <para>If the value of the <parameter>man.charmap.enabled</parameter>
25603   parameter is non-zero (the default), keeping the
25604   <parameter>man.output.encoding</parameter> parameter at its default
25605   value (<literal>UTF-8</literal>) or setting it to
25606   <literal>UTF-16</literal> <emphasis role="bold">does not cause your
25607   man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
25608   any Unicode characters for which matches are found in the enabled
25609   character map will be replaced with roff escape sequences before the
25610   final man-page files are generated.</para>
25611
25612   <para>So if you want to generate "real" UTF-8 man pages, without any
25613   character substitution being performed on your content, you need to
25614   set <parameter>man.charmap.enabled</parameter> to zero (which will
25615   completely disable character-map processing). </para>
25616
25617   <para>You may also need to set
25618   <parameter>man.charmap.enabled</parameter> to zero if you want to
25619   output man pages in an encoding other than <literal>UTF-8</literal>
25620   or <literal>UTF-16</literal>. Character-map processing is based on
25621   Unicode character values and may not work with other output
25622   encodings.</para>
25623 </important>
25624
25625 </refsection>
25626 </refentry>
25627
25628 <refentry version="5.0" id="man.output.better.ps.enabled">
25629 <refmeta>
25630 <refentrytitle>man.output.better.ps.enabled</refentrytitle>
25631 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25632 </refmeta>
25633 <refnamediv>
25634 <refname>man.output.better.ps.enabled</refname>
25635 <refpurpose>Enable enhanced print/PostScript output?</refpurpose>
25636 </refnamediv>
25637 <refsynopsisdiv>
25638 <programlisting id="man.output.better.ps.enabled.frag">
25639 &lt;xsl:param name="man.output.better.ps.enabled"&gt;0&lt;/xsl:param&gt;
25640 </programlisting>
25641 </refsynopsisdiv>
25642 <refsection><info><title>Description</title></info>
25643
25644 <para>If the value of the
25645 <parameter>man.output.better.ps.enabled</parameter> parameter is
25646 non-zero, certain markup is embedded in each generated man page
25647 such that PostScript output from the <command>man -Tps</command>
25648 command for that page will include a number of enhancements
25649 designed to improve the quality of that output.</para>
25650
25651 <para>If <parameter>man.output.better.ps.enabled</parameter> is
25652 zero (the default), no such markup is embedded in generated man
25653 pages, and no enhancements are included in the PostScript
25654 output generated from those man pages by the <command>man
25655  -Tps</command> command.</para>
25656
25657 <warning>
25658   <para>The enhancements provided by this parameter rely on
25659     features that are specific to groff (GNU troff) and that are
25660     not part of &#8220;classic&#8221; AT&amp;T troff or any of its
25661     derivatives. Therefore, any man pages you generate with this
25662     parameter enabled will be readable only on systems on which
25663     the groff (GNU troff) program is installed, such as GNU/Linux
25664     systems. The pages <emphasis role="bold">will not not be
25665       readable on systems on with the classic troff (AT&amp;T
25666       troff) command is installed</emphasis>.</para>
25667 </warning>
25668
25669 <para>The value of this parameter only affects PostScript output
25670   generated from the <command>man</command> command. It has no
25671   effect on output generated using the FO backend.</para>
25672
25673 <tip>
25674   <para>You can generate PostScript output for any man page by
25675     running the following command:</para>
25676   <programlisting>  man <replaceable>FOO</replaceable> -Tps &gt; <replaceable>FOO</replaceable>.ps</programlisting>
25677   <para>You can then generate PDF output by running the following
25678     command:</para>
25679   <programlisting>  ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
25680 </tip>
25681
25682 </refsection>
25683 </refentry>
25684
25685   </reference><reference id="other" xml:base="../manpages/param.xml">
25686   <title>Other</title>
25687 <refentry version="5.0" id="man.table.footnotes.divider">
25688 <refmeta>
25689 <refentrytitle>man.table.footnotes.divider</refentrytitle>
25690 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25691 </refmeta>
25692 <refnamediv>
25693 <refname>man.table.footnotes.divider</refname>
25694 <refpurpose>Specifies divider string that appears before table footnotes</refpurpose>
25695 </refnamediv>
25696
25697 <refsynopsisdiv>
25698 <programlisting id="man.table.footnotes.divider.frag">
25699 &lt;xsl:param name="man.table.footnotes.divider"&gt;----&lt;/xsl:param&gt;
25700 </programlisting>
25701 </refsynopsisdiv>
25702
25703 <refsection><info><title>Description</title></info>
25704
25705 <para>In each table that contains footenotes, the string specified by
25706 the <parameter>man.table.footnotes.divider</parameter> parameter is
25707 output before the list of footnotes for the table.</para>
25708
25709 </refsection>
25710 </refentry>
25711
25712 <refentry version="5.0" id="man.subheading.divider.enabled">
25713 <refmeta>
25714 <refentrytitle>man.subheading.divider.enabled</refentrytitle>
25715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25716 </refmeta>
25717 <refnamediv>
25718 <refname>man.subheading.divider.enabled</refname>
25719 <refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>
25720 </refnamediv>
25721
25722 <refsynopsisdiv>
25723 <programlisting id="man.subheading.divider.enabled.frag">
25724 &lt;xsl:param name="man.subheading.divider.enabled"&gt;0&lt;/xsl:param&gt;
25725 </programlisting>
25726 </refsynopsisdiv>
25727
25728 <refsection><info><title>Description</title></info>
25729
25730 <para>If the value of the
25731 <parameter>man.subheading.divider.enabled</parameter> parameter is
25732 non-zero, the contents of the
25733 <parameter>man.subheading.divider</parameter> parameter are used to
25734 add a "divider" before and after subheadings in the roff
25735 output. <emphasis role="bold">The divider is not visisble in the
25736 rendered man page</emphasis>; it is added as a comment, in the source,
25737 simply for the purpose of increasing reability of the source.</para>
25738
25739 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
25740 (the default), the subheading divider is suppressed.</para>
25741
25742 </refsection>
25743 </refentry>
25744
25745 <refentry version="5.0" id="man.subheading.divider">
25746 <refmeta>
25747 <refentrytitle>man.subheading.divider</refentrytitle>
25748 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25749 </refmeta>
25750 <refnamediv>
25751 <refname>man.subheading.divider</refname>
25752 <refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose>
25753 </refnamediv>
25754
25755 <refsynopsisdiv>
25756 <programlisting id="man.subheading.divider.frag">
25757 &lt;xsl:param name="man.subheading.divider"&gt;========================================================================&lt;/xsl:param&gt;
25758 </programlisting>
25759 </refsynopsisdiv>
25760
25761 <refsection><info><title>Description</title></info>
25762
25763 <para>If the value of the
25764 <parameter>man.subheading.divider.enabled</parameter> parameter is
25765 non-zero, the contents of the
25766 <parameter>man.subheading.divider</parameter> parameter are used to
25767 add a "divider" before and after subheadings in the roff
25768 output. <emphasis role="bold">The divider is not visisble in the
25769 rendered man page</emphasis>; it is added as a comment, in the source,
25770 simply for the purpose of increasing reability of the source.</para>
25771
25772 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
25773 (the default), the subheading divider is suppressed.</para>
25774
25775 </refsection>
25776 </refentry>
25777
25778   </reference>
25779     </part>
25780     <part id="roundtrip">
25781       <?dbhtml dir="roundtrip"?>
25782       <?dbhtml filename="index.html"?>
25783       <title xml:base="../roundtrip/param.xml">Roundtrip Parameter Reference</title>
25784       <partintro id="roundtripintro">
25785         
25786       <para xml:base="../roundtrip/param.xml">This is reference documentation for all user-configurable
25787       parameters in the DocBook &#8220;Roundtrip&#8221; Stylesheets (for
25788       transforming DocBook to WordML, OpenDocument, and Apple Pages,
25789       and for converting from those formats back to DocBook).</para>
25790     
25791       </partintro>
25792       
25793   
25794 <refentry version="5.0" id="wordml.template" xml:base="../roundtrip/param.xml">
25795 <refmeta>
25796 <refentrytitle>wordml.template</refentrytitle>
25797 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25798 </refmeta>
25799 <refnamediv>
25800 <refname>wordml.template</refname>
25801 <refpurpose>Specify the template WordML document</refpurpose>
25802 </refnamediv>
25803
25804 <refsynopsisdiv>
25805 <programlisting id="wordml.template.frag">
25806 &lt;xsl:param name="wordml.template"&gt;&lt;/xsl:param&gt;
25807 </programlisting>
25808 </refsynopsisdiv>
25809
25810 <refsection><info><title>Description</title></info>
25811
25812 <para>The <parameter>wordml.template</parameter> parameter specifies a WordML document to use as a template for the generated document.  The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements.  Any content in the template document is ignored.</para>
25813
25814 <para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Word itself, rather than these XSL stylesheets.</para>
25815
25816 </refsection>
25817 </refentry>
25818
25819 <refentry version="5.0" id="pages.template" xml:base="../roundtrip/param.xml">
25820 <refmeta>
25821 <refentrytitle>pages.template</refentrytitle>
25822 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25823 </refmeta>
25824 <refnamediv>
25825 <refname>pages.template</refname>
25826 <refpurpose>Specify the template Pages document</refpurpose>
25827 </refnamediv>
25828
25829 <refsynopsisdiv>
25830 <programlisting id="pages.template.frag">
25831 &lt;xsl:param name="pages.template"&gt;&lt;/xsl:param&gt;
25832 </programlisting>
25833 </refsynopsisdiv>
25834
25835 <refsection><info><title>Description</title></info>
25836
25837 <para>The <parameter>pages.template</parameter> parameter specifies a Pages (the Apple word processing application) document to use as a template for the generated document.  The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements.  Any content in the template document is ignored.</para>
25838
25839 <para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Pages itself, rather than these XSL stylesheets.</para>
25840
25841 </refsection>
25842 </refentry>
25843
25844   
25845     </part>
25846     <part id="slides"><title>Slides Parameter Reference</title>
25847       <?dbhtml dir="slides"?>
25848       <?dbhtml filename="index.html"?>
25849       <partintro id="slidesintro">
25850         <para>This is reference documentation for all
25851           user-configurable parameters in the DocBook XSL Slides
25852           stylesheets (for generating HTML and PDF slide
25853           presentations).</para>
25854         <note>
25855           <para>The Slides stylesheet for HTML output is a
25856             customization layer of the DocBook XSL HTML
25857             stylesheet; the Slides stylesheet for FO output is a
25858             customization layer of the DocBook XSL FO stylesheet.
25859             Therefore, in addition to the slides-specific
25860             parameters listed in this section, you can also use a
25861             number of <link xlink:href="../html">HTML stylesheet
25862               parameters</link> and <link xlink:href="../fo">FO
25863               stylesheet parameters</link> to control Slides
25864             output.</para>
25865         </note>
25866       </partintro>
25867       <reference id="html" xml:base="../slides/html/param.xml">
25868 <title>HTML: General Parameters</title>
25869 <refentry version="5.0" id="keyboard.nav">
25870 <refmeta>
25871 <refentrytitle>keyboard.nav</refentrytitle>
25872 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25873 </refmeta>
25874 <refnamediv>
25875 <refname>keyboard.nav</refname>
25876 <refpurpose>Enable keyboard navigation?</refpurpose>
25877 </refnamediv>
25878
25879 <refsynopsisdiv>
25880 <programlisting id="keyboard.nav.frag">
25881 &lt;xsl:param name="keyboard.nav" select="1"&gt;&lt;/xsl:param&gt;
25882 </programlisting>
25883 </refsynopsisdiv>
25884
25885 <refsection><info><title>Description</title></info>
25886
25887 <para>If non-zero, JavaScript is added to the slides to enable keyboard
25888 navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves
25889 backward.</para>
25890
25891 </refsection>
25892 </refentry>
25893
25894 <refentry version="5.0" id="css.stylesheet">
25895 <refmeta>
25896 <refentrytitle>css.stylesheet</refentrytitle>
25897 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25898 </refmeta>
25899 <refnamediv>
25900 <refname>css.stylesheet</refname>
25901 <refpurpose>CSS stylesheet for slides</refpurpose>
25902 </refnamediv>
25903
25904 <refsynopsisdiv>
25905 <programlisting id="css.stylesheet.frag">
25906 &lt;xsl:param name="css.stylesheet"&gt;slides.css&lt;/xsl:param&gt;
25907 </programlisting>
25908 </refsynopsisdiv>
25909
25910 <refsection><info><title>Description</title></info>
25911
25912 <para>Identifies the CSS stylesheet used by all the slides. This parameter
25913 can be set in the source document with the &lt;?dbhtml?&gt; pseudo-attribute
25914 <literal>css-stylesheet</literal>.</para>
25915
25916 </refsection>
25917 </refentry>
25918
25919 <refentry version="5.0" id="css.stylesheet.dir">
25920 <refmeta>
25921 <refentrytitle>css.stylesheet.dir</refentrytitle>
25922 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25923 </refmeta>
25924 <refnamediv>
25925 <refname>css.stylesheet.dir</refname>
25926 <refpurpose>Default directory for CSS stylesheets</refpurpose>
25927 </refnamediv>
25928
25929 <refsynopsisdiv>
25930 <programlisting id="css.stylesheet.dir.frag">
25931 &lt;xsl:param name="css.stylesheet.dir"&gt;&lt;/xsl:param&gt;
25932 </programlisting>
25933 </refsynopsisdiv>
25934
25935 <refsection><info><title>Description</title></info>
25936
25937 <para>Identifies the default directory for the CSS stylesheet
25938 generated on all the slides. This parameter can be set in the source
25939 document with the &lt;?dbhtml?&gt; pseudo-attribute
25940 <literal>css-stylesheet-dir</literal>.</para>
25941
25942 <para>If non-empty, this value is prepended to each of the stylesheets.
25943 </para>
25944
25945 </refsection>
25946 </refentry>
25947
25948 <refentry version="5.0" id="titlefoil.html">
25949 <refmeta>
25950 <refentrytitle>titlefoil.html</refentrytitle>
25951 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
25952 </refmeta>
25953 <refnamediv>
25954 <refname>titlefoil.html</refname>
25955 <refpurpose>Name of title foil HTML file</refpurpose>
25956 </refnamediv>
25957
25958 <refsynopsisdiv>
25959 <programlisting id="titlefoil.html.frag">
25960 &lt;xsl:param name="titlefoil.html" select="concat('index', $html.ext)"&gt;&lt;/xsl:param&gt;
25961 </programlisting>
25962 </refsynopsisdiv>
25963
25964 <refsection><info><title>Description</title></info>
25965
25966 <para>Sets the filename used for the slides titlepage.</para>
25967
25968 </refsection>
25969 </refentry>
25970
25971 <refentry version="5.0" id="toc.html">
25972 <refmeta>
25973 <refentrytitle>toc.html</refentrytitle>
25974 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
25975 </refmeta>
25976 <refnamediv>
25977 <refname>toc.html</refname>
25978 <refpurpose>Name of ToC HTML file</refpurpose>
25979 </refnamediv>
25980
25981 <refsynopsisdiv>
25982 <programlisting id="toc.html.frag">
25983 &lt;xsl:param name="toc.html" select="concat('toc', $html.ext)"&gt;&lt;/xsl:param&gt;
25984 </programlisting>
25985 </refsynopsisdiv>
25986
25987 <refsection><info><title>Description</title></info>
25988
25989 <para>Sets the filename used for the table of contents page.</para>
25990
25991 </refsection>
25992 </refentry>
25993
25994 <refentry version="5.0" id="foilgroup.toc">
25995 <refmeta>
25996 <refentrytitle>foilgroup.toc</refentrytitle>
25997 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25998 </refmeta>
25999 <refnamediv>
26000 <refname>foilgroup.toc</refname>
26001 <refpurpose>Put ToC on foilgroup pages?</refpurpose>
26002 </refnamediv>
26003
26004 <refsynopsisdiv>
26005 <programlisting id="foilgroup.toc.frag">
26006 &lt;xsl:param name="foilgroup.toc" select="1"&gt;&lt;/xsl:param&gt;
26007 </programlisting>
26008 </refsynopsisdiv>
26009
26010 <refsection><info><title>Description</title></info>
26011
26012 <para>If non-zero, a ToC will be placed on foilgroup pages (after any
26013 other content).
26014 </para>
26015
26016 </refsection>
26017 </refentry>
26018
26019 <refentry version="5.0" id="output.indent">
26020 <refmeta>
26021 <refentrytitle>output.indent</refentrytitle>
26022 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
26023 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
26024 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
26025 </refmeta>
26026 <refnamediv>
26027 <refname>output.indent</refname>
26028 <refpurpose>Indent output?</refpurpose>
26029 </refnamediv>
26030
26031 <refsynopsisdiv>
26032 <programlisting id="output.indent.frag">
26033 &lt;xsl:param name="output.indent"&gt;no&lt;/xsl:param&gt;
26034 </programlisting>
26035 </refsynopsisdiv>
26036
26037 <refsection><info><title>Description</title></info>
26038
26039 <para>Specifies the setting of the <parameter>indent</parameter>
26040 parameter on the HTML slides. For more information, see the discussion
26041 of the <tag>xsl:output</tag> element in the XSLT specification.</para>
26042 <para>Select from <literal>yes</literal> or <literal>no</literal>.</para>
26043
26044 </refsection>
26045 </refentry>
26046
26047 <refentry version="5.0" id="overlay">
26048 <refmeta>
26049 <refentrytitle>overlay</refentrytitle>
26050 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26051 </refmeta>
26052 <refnamediv>
26053 <refname>overlay</refname>
26054 <refpurpose>Overlay footer navigation?</refpurpose>
26055 </refnamediv>
26056
26057 <refsynopsisdiv>
26058 <programlisting id="overlay.frag">
26059 &lt;xsl:param name="overlay" select="0"&gt;&lt;/xsl:param&gt;
26060 </programlisting>
26061 </refsynopsisdiv>
26062
26063 <refsection><info><title>Description</title></info>
26064
26065 <para>If non-zero, JavaScript is added to the slides to make the
26066 bottom navigation appear at the bottom of each page. This option and
26067 <link linkend="multiframe">multiframe</link> are mutually exclusive.</para>
26068
26069 <para>If this parameter is zero, the bottom navigation simply appears
26070 below the content of each slide.</para>
26071
26072 </refsection>
26073 </refentry>
26074
26075 <refentry version="5.0" id="show.foil.number">
26076 <refmeta>
26077 <refentrytitle>show.foil.number</refentrytitle>
26078 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26079 </refmeta>
26080 <refnamediv>
26081 <refname>show.foil.number</refname>
26082 <refpurpose>Show foil number on each foil?</refpurpose>
26083 </refnamediv>
26084
26085 <refsynopsisdiv>
26086 <programlisting id="show.foil.number.frag">
26087 &lt;xsl:param name="show.foil.number" select="0"&gt;&lt;/xsl:param&gt;
26088 </programlisting>
26089 </refsynopsisdiv>
26090
26091 <refsection><info><title>Description</title></info>
26092
26093 <para>If non-zero, on each slide there will be its number. Currently
26094 not supported in all output formats.</para>
26095
26096 </refsection>
26097 </refentry>
26098
26099 </reference><reference id="frames" xml:base="../slides/html/param.xml">
26100 <title>HTML: Frames Parameters</title>
26101 <refentry version="5.0" id="nav.separator">
26102 <refmeta>
26103 <refentrytitle>nav.separator</refentrytitle>
26104 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26105 </refmeta>
26106 <refnamediv>
26107 <refname>nav.separator</refname>
26108 <refpurpose>Output separator between navigation and body?</refpurpose>
26109 </refnamediv>
26110
26111 <refsynopsisdiv>
26112 <programlisting id="nav.separator.frag">
26113 &lt;xsl:param name="nav.separator" select="1"&gt;&lt;/xsl:param&gt;
26114 </programlisting>
26115 </refsynopsisdiv>
26116
26117 <refsection><info><title>Description</title></info>
26118
26119 <para>If non-zero, a separator (<literal>&lt;HR&gt;</literal>) is
26120 added between the navigation links and the content of each slide.</para>
26121
26122 </refsection>
26123 </refentry>
26124
26125 <refentry version="5.0" id="toc.row.height">
26126 <refmeta>
26127 <refentrytitle>toc.row.height</refentrytitle>
26128 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26129 </refmeta>
26130 <refnamediv>
26131 <refname>toc.row.height</refname>
26132 <refpurpose>Height of ToC rows in dynamic ToCs</refpurpose>
26133 </refnamediv>
26134
26135 <refsynopsisdiv>
26136 <programlisting id="toc.row.height.frag">
26137 &lt;xsl:param name="toc.row.height"&gt;22&lt;/xsl:param&gt;
26138 </programlisting>
26139 </refsynopsisdiv>
26140
26141 <refsection><info><title>Description</title></info>
26142
26143 <para>This parameter specifies the height of each row in the table of
26144 contents. This is only applicable if a <link linkend="dynamic.toc">dynamic ToC</link> is used. You may want to
26145 adjust this parameter for optimal appearance with the font and image
26146 sizes selected by your <link linkend="css.stylesheet">CSS
26147 stylesheet</link>.
26148 </para>
26149
26150 </refsection>
26151 </refentry>
26152
26153 <refentry version="5.0" id="toc.bg.color">
26154 <refmeta>
26155 <refentrytitle>toc.bg.color</refentrytitle>
26156 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26157 </refmeta>
26158 <refnamediv>
26159 <refname>toc.bg.color</refname>
26160 <refpurpose>Background color for ToC frame</refpurpose>
26161 </refnamediv>
26162
26163 <refsynopsisdiv>
26164 <programlisting id="toc.bg.color.frag">
26165 &lt;xsl:param name="toc.bg.color"&gt;#FFFFFF&lt;/xsl:param&gt;
26166 </programlisting>
26167 </refsynopsisdiv>
26168
26169 <refsection><info><title>Description</title></info>
26170
26171 <para>Specifies the background color used in the ToC frame.</para>
26172
26173 </refsection>
26174 </refentry>
26175
26176 <refentry version="5.0" id="body.bg.color">
26177 <refmeta>
26178 <refentrytitle>body.bg.color</refentrytitle>
26179 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26180 </refmeta>
26181 <refnamediv>
26182 <refname>body.bg.color</refname>
26183 <refpurpose>Background color for body frame</refpurpose>
26184 </refnamediv>
26185
26186 <refsynopsisdiv>
26187 <programlisting id="body.bg.color.frag">
26188 &lt;xsl:param name="body.bg.color"&gt;#FFFFFF&lt;/xsl:param&gt;
26189 </programlisting>
26190 </refsynopsisdiv>
26191
26192 <refsection><info><title>Description</title></info>
26193
26194 <para>Specifies the background color used in the body column of
26195 tabular slides.</para>
26196
26197 </refsection>
26198 </refentry>
26199
26200 <refentry version="5.0" id="toc.width">
26201 <refmeta>
26202 <refentrytitle>toc.width</refentrytitle>
26203 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26204 </refmeta>
26205 <refnamediv>
26206 <refname>toc.width</refname>
26207 <refpurpose>Width of ToC frame</refpurpose>
26208 </refnamediv>
26209
26210 <refsynopsisdiv>
26211 <programlisting id="toc.width.frag">
26212 &lt;xsl:param name="toc.width"&gt;250&lt;/xsl:param&gt;
26213 &lt;!-- Presumably in pixels? --&gt;
26214 </programlisting>
26215 </refsynopsisdiv>
26216
26217 <refsection><info><title>Description</title></info>
26218
26219 <para>Specifies the width of the ToC frame in pixels.</para>
26220
26221 </refsection>
26222 </refentry>
26223
26224 <refentry version="5.0" id="toc.hide.show">
26225 <refmeta>
26226 <refentrytitle>toc.hide.show</refentrytitle>
26227 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26228 </refmeta>
26229 <refnamediv>
26230 <refname>toc.hide.show</refname>
26231 <refpurpose>Enable hide/show button for ToC frame</refpurpose>
26232 </refnamediv>
26233
26234 <refsynopsisdiv>
26235 <programlisting id="toc.hide.show.frag">
26236 &lt;xsl:param name="toc.hide.show" select="0"&gt;&lt;/xsl:param&gt;
26237 </programlisting>
26238 </refsynopsisdiv>
26239
26240 <refsection><info><title>Description</title></info>
26241
26242 <para>If non-zero, JavaScript (and an additional icon, see
26243 <link linkend="hidetoc.image">hidetoc.image</link> and
26244 <link linkend="hidetoc.image">showtoc.image</link>) is added to each slide
26245 to allow the ToC panel to be <quote>toggled</quote> on each panel.</para>
26246
26247 <note><para>There is a bug in Mozilla 1.0 (at least as of CR3) that causes
26248 the browser to reload the titlepage when this feature is used.</para></note>
26249
26250 </refsection>
26251 </refentry>
26252
26253 <refentry version="5.0" id="dynamic.toc">
26254 <refmeta>
26255 <refentrytitle>dynamic.toc</refentrytitle>
26256 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26257 </refmeta>
26258 <refnamediv>
26259 <refname>dynamic.toc</refname>
26260 <refpurpose>Dynamic ToCs?</refpurpose>
26261 </refnamediv>
26262
26263 <refsynopsisdiv>
26264 <programlisting id="dynamic.toc.frag">
26265 &lt;xsl:param name="dynamic.toc" select="0"&gt;&lt;/xsl:param&gt;
26266 </programlisting>
26267 </refsynopsisdiv>
26268
26269 <refsection><info><title>Description</title></info>
26270
26271 <para>If non-zero, JavaScript is used to make the ToC panel <quote>dynamic</quote>.
26272 In a dynamic ToC, each section in the ToC can be expanded and collapsed by
26273 clicking on the appropriate image.</para>
26274
26275 </refsection>
26276 </refentry>
26277
26278 <refentry version="5.0" id="active.toc">
26279 <refmeta>
26280 <refentrytitle>active.toc</refentrytitle>
26281 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26282 </refmeta>
26283 <refnamediv>
26284 <refname>active.toc</refname>
26285 <refpurpose>Active ToCs?</refpurpose>
26286 </refnamediv>
26287
26288 <refsynopsisdiv>
26289 <programlisting id="active.toc.frag">
26290 &lt;xsl:param name="active.toc" select="0"&gt;&lt;/xsl:param&gt;
26291 </programlisting>
26292 </refsynopsisdiv>
26293
26294 <refsection><info><title>Description</title></info>
26295
26296 <para>If non-zero, JavaScript is used to keep the ToC and the current slide
26297 <quote>in sync</quote>. That is, each time the slide changes, the corresponding
26298 ToC entry will be underlined.</para>
26299
26300 </refsection>
26301 </refentry>
26302
26303 <refentry version="5.0" id="overlay.logo">
26304 <refmeta>
26305 <refentrytitle>overlay.logo</refentrytitle>
26306 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26307 </refmeta>
26308 <refnamediv>
26309 <refname>overlay.logo</refname>
26310 <refpurpose>Logo to overlay on ToC frame</refpurpose>
26311 </refnamediv>
26312
26313 <refsynopsisdiv>
26314 <programlisting id="overlay.logo.frag">
26315 &lt;xsl:param name="overlay.logo"&gt;http://docbook.sourceforge.net/release/buttons/slides-1.png&lt;/xsl:param&gt;
26316 </programlisting>
26317 </refsynopsisdiv>
26318
26319 <refsection><info><title>Description</title></info>
26320
26321 <para>If this URI is non-empty, JavaScript is used to overlay the
26322 specified image on the ToC frame.</para>
26323
26324 </refsection>
26325 </refentry>
26326
26327 <refentry version="5.0" id="multiframe">
26328 <refmeta>
26329 <refentrytitle>multiframe</refentrytitle>
26330 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26331 </refmeta>
26332 <refnamediv>
26333 <refname>multiframe</refname>
26334 <refpurpose>Use multiple frames for slide bodies?</refpurpose>
26335 </refnamediv>
26336
26337 <refsynopsisdiv>
26338 <programlisting id="multiframe.frag">
26339 &lt;xsl:param name="multiframe" select="0"&gt;&lt;/xsl:param&gt;
26340 </programlisting>
26341 </refsynopsisdiv>
26342
26343 <refsection><info><title>Description</title></info>
26344
26345 <para>If non-zero, multiple frames are used for the body of each
26346 slide. This is one way of forcing the slide navigation elements to
26347 appear in constant locations. The other way is with <link linkend="overlay">overlays</link>. The <link linkend="overlay"><parameter>overlay</parameter></link> and
26348 <parameter>multiframe</parameter> parameters are mutually
26349 exclusive.</para>
26350
26351 </refsection>
26352 </refentry>
26353
26354 <refentry version="5.0" id="multiframe.top.bgcolor">
26355 <refmeta>
26356 <refentrytitle>multiframe.top.bgcolor</refentrytitle>
26357 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26358 </refmeta>
26359 <refnamediv>
26360 <refname>multiframe.top.bgcolor</refname>
26361 <refpurpose>Background color for top navigation frame</refpurpose>
26362 </refnamediv>
26363
26364 <refsynopsisdiv>
26365 <programlisting id="multiframe.top.bgcolor.frag">
26366 &lt;xsl:param name="multiframe.top.bgcolor"&gt;white&lt;/xsl:param&gt;
26367 </programlisting>
26368 </refsynopsisdiv>
26369
26370 <refsection><info><title>Description</title></info>
26371
26372 <para>Specifies the background color of the top navigation frame when
26373 <link linkend="multiframe">multiframe</link> is enabled.</para>
26374
26375 </refsection>
26376 </refentry>
26377
26378 <refentry version="5.0" id="multiframe.bottom.bgcolor">
26379 <refmeta>
26380 <refentrytitle>multiframe.bottom.bgcolor</refentrytitle>
26381 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26382 </refmeta>
26383 <refnamediv>
26384 <refname>multiframe.bottom.bgcolor</refname>
26385 <refpurpose>Background color for bottom navigation frame</refpurpose>
26386 </refnamediv>
26387
26388 <refsynopsisdiv>
26389 <programlisting id="multiframe.bottom.bgcolor.frag">
26390 &lt;xsl:param name="multiframe.bottom.bgcolor"&gt;white&lt;/xsl:param&gt;
26391 </programlisting>
26392 </refsynopsisdiv>
26393
26394 <refsection><info><title>Description</title></info>
26395
26396 <para>Specifies the background color of the bottom navigation frame when
26397 <link linkend="multiframe">multiframe</link> is enabled.</para>
26398
26399 </refsection>
26400 </refentry>
26401
26402 <refentry version="5.0" id="multiframe.navigation.height">
26403 <refmeta>
26404 <refentrytitle>multiframe.navigation.height</refentrytitle>
26405 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26406 </refmeta>
26407 <refnamediv>
26408 <refname>multiframe.navigation.height</refname>
26409 <refpurpose>Height of navigation frames</refpurpose>
26410 </refnamediv>
26411
26412 <refsynopsisdiv>
26413 <programlisting id="multiframe.navigation.height.frag">
26414 &lt;xsl:param name="multiframe.navigation.height"&gt;40&lt;/xsl:param&gt;
26415 </programlisting>
26416 </refsynopsisdiv>
26417
26418 <refsection><info><title>Description</title></info>
26419
26420 <para>Specifies the height of the navigation frames in pixels when
26421 <link linkend="multiframe">multiframe</link> is enabled.</para>
26422
26423 </refsection>
26424 </refentry>
26425
26426 </reference><reference id="graphics" xml:base="../slides/html/param.xml">
26427 <title>HTML: Graphics Parameters</title>
26428 <refentry version="5.0" id="graphics.dir">
26429 <refmeta>
26430 <refentrytitle>graphics.dir</refentrytitle>
26431 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26432 </refmeta>
26433 <refnamediv>
26434 <refname>graphics.dir</refname>
26435 <refpurpose>Graphics directory</refpurpose>
26436 </refnamediv>
26437
26438 <refsynopsisdiv>
26439 <programlisting id="graphics.dir.frag">
26440 &lt;xsl:param name="graphics.dir"&gt;&lt;/xsl:param&gt;
26441 </programlisting>
26442 </refsynopsisdiv>
26443
26444 <refsection><info><title>Description</title></info>
26445
26446 <para>Identifies the graphics directory for the navigation components
26447 generated on all the slides. This parameter can be set in the source
26448 document with the &lt;?dbhtml?&gt; pseudo-attribute
26449 <literal>graphics-dir</literal>.</para>
26450
26451 <para>If non-empty, this value is prepended to each of the graphic
26452 image paths.</para>
26453
26454 </refsection>
26455 </refentry>
26456
26457 <refentry version="5.0" id="bullet.image">
26458 <refmeta>
26459 <refentrytitle>bullet.image</refentrytitle>
26460 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26461 </refmeta>
26462 <refnamediv>
26463 <refname>bullet.image</refname>
26464 <refpurpose>Bullet image</refpurpose>
26465 </refnamediv>
26466
26467 <refsynopsisdiv>
26468 <programlisting id="bullet.image.frag">
26469 &lt;xsl:param name="bullet.image"&gt;toc/bullet.png&lt;/xsl:param&gt;
26470 </programlisting>
26471 </refsynopsisdiv>
26472
26473 <refsection><info><title>Description</title></info>
26474
26475 <para>Specifies the filename of the bullet image used for foils in the
26476 framed ToC.</para>
26477
26478 </refsection>
26479 </refentry>
26480
26481 <refentry version="5.0" id="next.image">
26482 <refmeta>
26483 <refentrytitle>next.image</refentrytitle>
26484 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26485 </refmeta>
26486 <refnamediv>
26487 <refname>next.image</refname>
26488 <refpurpose>Right-arrow image</refpurpose>
26489 </refnamediv>
26490
26491 <refsynopsisdiv>
26492 <programlisting id="next.image.frag">
26493 &lt;xsl:param name="next.image"&gt;active/nav-next.png&lt;/xsl:param&gt;
26494 </programlisting>
26495 </refsynopsisdiv>
26496
26497 <refsection><info><title>Description</title></info>
26498
26499 <para>Specifies the filename of the right-pointing navigation arrow.</para>
26500
26501 </refsection>
26502 </refentry>
26503
26504 <refentry version="5.0" id="prev.image">
26505 <refmeta>
26506 <refentrytitle>prev.image</refentrytitle>
26507 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26508 </refmeta>
26509 <refnamediv>
26510 <refname>prev.image</refname>
26511 <refpurpose>Left-arrow image</refpurpose>
26512 </refnamediv>
26513
26514 <refsynopsisdiv>
26515 <programlisting id="prev.image.frag">
26516 &lt;xsl:param name="prev.image"&gt;active/nav-prev.png&lt;/xsl:param&gt;
26517 </programlisting>
26518 </refsynopsisdiv>
26519
26520 <refsection><info><title>Description</title></info>
26521
26522 <para>Specifies the filename of the left-pointing navigation arrow.</para>
26523
26524 </refsection>
26525 </refentry>
26526
26527 <refentry version="5.0" id="up.image">
26528 <refmeta>
26529 <refentrytitle>up.image</refentrytitle>
26530 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26531 </refmeta>
26532 <refnamediv>
26533 <refname>up.image</refname>
26534 <refpurpose>Up-arrow image</refpurpose>
26535 </refnamediv>
26536
26537 <refsynopsisdiv>
26538 <programlisting id="up.image.frag">
26539 &lt;xsl:param name="up.image"&gt;active/nav-up.png&lt;/xsl:param&gt;
26540 </programlisting>
26541 </refsynopsisdiv>
26542
26543 <refsection><info><title>Description</title></info>
26544
26545 <para>Specifies the filename of the upward-pointing navigation arrow.</para>
26546
26547 </refsection>
26548 </refentry>
26549
26550 <refentry version="5.0" id="home.image">
26551 <refmeta>
26552 <refentrytitle>home.image</refentrytitle>
26553 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26554 </refmeta>
26555 <refnamediv>
26556 <refname>home.image</refname>
26557 <refpurpose>Home image</refpurpose>
26558 </refnamediv>
26559
26560 <refsynopsisdiv>
26561 <programlisting id="home.image.frag">
26562 &lt;xsl:param name="home.image"&gt;active/nav-home.png&lt;/xsl:param&gt;
26563 </programlisting>
26564 </refsynopsisdiv>
26565
26566 <refsection><info><title>Description</title></info>
26567
26568 <para>Specifies the filename of the home navigation icon.</para>
26569
26570 </refsection>
26571 </refentry>
26572
26573 <refentry version="5.0" id="toc.image">
26574 <refmeta>
26575 <refentrytitle>toc.image</refentrytitle>
26576 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26577 </refmeta>
26578 <refnamediv>
26579 <refname>toc.image</refname>
26580 <refpurpose>ToC image</refpurpose>
26581 </refnamediv>
26582
26583 <refsynopsisdiv>
26584 <programlisting id="toc.image.frag">
26585 &lt;xsl:param name="toc.image"&gt;active/nav-toc.png&lt;/xsl:param&gt;
26586 </programlisting>
26587 </refsynopsisdiv>
26588
26589 <refsection><info><title>Description</title></info>
26590
26591 <para>Specifies the filename of the ToC navigation icon.</para>
26592
26593 </refsection>
26594 </refentry>
26595
26596
26597 <refentry version="5.0" id="no.next.image">
26598 <refmeta>
26599 <refentrytitle>no.next.image</refentrytitle>
26600 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26601 </refmeta>
26602 <refnamediv>
26603 <refname>no.next.image</refname>
26604 <refpurpose>Inactive right-arrow image</refpurpose>
26605 </refnamediv>
26606
26607 <refsynopsisdiv>
26608 <programlisting id="no.next.image.frag">
26609 &lt;xsl:param name="no.next.image"&gt;inactive/nav-next.png&lt;/xsl:param&gt;
26610 </programlisting>
26611 </refsynopsisdiv>
26612
26613 <refsection><info><title>Description</title></info>
26614
26615 <para>Specifies the filename of the inactive right-pointing navigation arrow.</para>
26616
26617 </refsection>
26618 </refentry>
26619
26620 <refentry version="5.0" id="no.prev.image">
26621 <refmeta>
26622 <refentrytitle>no.prev.image</refentrytitle>
26623 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26624 </refmeta>
26625 <refnamediv>
26626 <refname>no.prev.image</refname>
26627 <refpurpose>Inactive left-arrow image</refpurpose>
26628 </refnamediv>
26629
26630 <refsynopsisdiv>
26631 <programlisting id="no.prev.image.frag">
26632 &lt;xsl:param name="no.prev.image"&gt;inactive/nav-prev.png&lt;/xsl:param&gt;
26633 </programlisting>
26634 </refsynopsisdiv>
26635
26636 <refsection><info><title>Description</title></info>
26637
26638 <para>Specifies the filename of the inactive left-pointing navigation arrow.</para>
26639
26640 </refsection>
26641 </refentry>
26642
26643 <refentry version="5.0" id="no.up.image">
26644 <refmeta>
26645 <refentrytitle>no.up.image</refentrytitle>
26646 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26647 </refmeta>
26648 <refnamediv>
26649 <refname>no.up.image</refname>
26650 <refpurpose>Inactive up-arrow image</refpurpose>
26651 </refnamediv>
26652
26653 <refsynopsisdiv>
26654 <programlisting id="no.up.image.frag">
26655 &lt;xsl:param name="no.up.image"&gt;inactive/nav-up.png&lt;/xsl:param&gt;
26656 </programlisting>
26657 </refsynopsisdiv>
26658
26659 <refsection><info><title>Description</title></info>
26660
26661 <para>Specifies the filename of the inactive upward-pointing navigation arrow.</para>
26662
26663 </refsection>
26664 </refentry>
26665
26666 <refentry version="5.0" id="no.home.image">
26667 <refmeta>
26668 <refentrytitle>no.home.image</refentrytitle>
26669 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26670 </refmeta>
26671 <refnamediv>
26672 <refname>no.home.image</refname>
26673 <refpurpose>Inactive home image</refpurpose>
26674 </refnamediv>
26675
26676 <refsynopsisdiv>
26677 <programlisting id="no.home.image.frag">
26678 &lt;xsl:param name="no.home.image"&gt;inactive/nav-home.png&lt;/xsl:param&gt;
26679 </programlisting>
26680 </refsynopsisdiv>
26681
26682 <refsection><info><title>Description</title></info>
26683
26684 <para>Specifies the filename of the inactive home navigation icon.</para>
26685
26686 </refsection>
26687 </refentry>
26688
26689 <refentry version="5.0" id="no.toc.image">
26690 <refmeta>
26691 <refentrytitle>no.toc.image</refentrytitle>
26692 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26693 </refmeta>
26694 <refnamediv>
26695 <refname>no.toc.image</refname>
26696 <refpurpose>Inactive ToC image</refpurpose>
26697 </refnamediv>
26698
26699 <refsynopsisdiv>
26700 <programlisting id="no.toc.image.frag">
26701 &lt;xsl:param name="no.toc.image"&gt;inactive/nav-toc.png&lt;/xsl:param&gt;
26702 </programlisting>
26703 </refsynopsisdiv>
26704
26705 <refsection><info><title>Description</title></info>
26706
26707 <para>Specifies the filename of the inactive ToC navigation icon.</para>
26708
26709 </refsection>
26710 </refentry>
26711
26712
26713 <refentry version="5.0" id="plus.image">
26714 <refmeta>
26715 <refentrytitle>plus.image</refentrytitle>
26716 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26717 </refmeta>
26718 <refnamediv>
26719 <refname>plus.image</refname>
26720 <refpurpose>Plus image</refpurpose>
26721 </refnamediv>
26722
26723 <refsynopsisdiv>
26724 <programlisting id="plus.image.frag">
26725 &lt;xsl:param name="plus.image"&gt;toc/closed.png&lt;/xsl:param&gt;
26726 </programlisting>
26727 </refsynopsisdiv>
26728
26729 <refsection><info><title>Description</title></info>
26730
26731 <para>Specifies the filename of the <quote>plus</quote> image; the image used in a
26732 <link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section
26733 can be expanded.</para>
26734
26735 </refsection>
26736 </refentry>
26737
26738 <refentry version="5.0" id="minus.image">
26739 <refmeta>
26740 <refentrytitle>minus.image</refentrytitle>
26741 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26742 </refmeta>
26743 <refnamediv>
26744 <refname>minus.image</refname>
26745 <refpurpose>Minus image</refpurpose>
26746 </refnamediv>
26747
26748 <refsynopsisdiv>
26749 <programlisting id="minus.image.frag">
26750 &lt;xsl:param name="minus.image"&gt;toc/open.png&lt;/xsl:param&gt;
26751 </programlisting>
26752 </refsynopsisdiv>
26753
26754 <refsection><info><title>Description</title></info>
26755
26756 <para>Specifies the filename of the <quote>minus</quote> image; the image used in a
26757 <link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section
26758 can be collapsed.</para>
26759
26760 </refsection>
26761 </refentry>
26762
26763 <refentry version="5.0" id="hidetoc.image">
26764 <refmeta>
26765 <refentrytitle>hidetoc.image</refentrytitle>
26766 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26767 </refmeta>
26768 <refnamediv>
26769 <refname>hidetoc.image</refname>
26770 <refpurpose>Hide ToC image</refpurpose>
26771 </refnamediv>
26772
26773 <refsynopsisdiv>
26774 <programlisting id="hidetoc.image.frag">
26775 &lt;xsl:param name="hidetoc.image"&gt;hidetoc.gif&lt;/xsl:param&gt;
26776 </programlisting>
26777 </refsynopsisdiv>
26778
26779 <refsection><info><title>Description</title></info>
26780
26781 <para>Specifies the filename of the <quote>hide ToC</quote> image. This is used
26782 when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is
26783 enabled.</para>
26784
26785 </refsection>
26786 </refentry>
26787
26788 <refentry version="5.0" id="showtoc.image">
26789 <refmeta>
26790 <refentrytitle>showtoc.image</refentrytitle>
26791 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26792 </refmeta>
26793 <refnamediv>
26794 <refname>showtoc.image</refname>
26795 <refpurpose>Show ToC image</refpurpose>
26796 </refnamediv>
26797
26798 <refsynopsisdiv>
26799 <programlisting id="showtoc.image.frag">
26800 &lt;xsl:param name="showtoc.image"&gt;showtoc.gif&lt;/xsl:param&gt;
26801 </programlisting>
26802 </refsynopsisdiv>
26803
26804 <refsection><info><title>Description</title></info>
26805
26806 <para>Specifies the filename of the <quote>show ToC</quote> image. This is used
26807 when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is
26808 enabled.</para>
26809
26810 </refsection>
26811 </refentry>
26812
26813 </reference><reference id="javascript" xml:base="../slides/html/param.xml">
26814 <title>HTML: JavaScript Parameters</title>
26815 <refentry version="5.0" id="script.dir">
26816 <refmeta>
26817 <refentrytitle>script.dir</refentrytitle>
26818 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26819 </refmeta>
26820 <refnamediv>
26821 <refname>script.dir</refname>
26822 <refpurpose>Script directory</refpurpose>
26823 </refnamediv>
26824
26825 <refsynopsisdiv>
26826 <programlisting id="script.dir.frag">
26827 &lt;xsl:param name="script.dir"&gt;&lt;/xsl:param&gt;
26828 </programlisting>
26829 </refsynopsisdiv>
26830
26831 <refsection><info><title>Description</title></info>
26832
26833 <para>Identifies the JavaScript source directory for the slides.
26834 This parameter can be set in the source
26835 document with the &lt;?dbhtml?&gt; pseudo-attribute
26836 <literal>script-dir</literal>.</para>
26837
26838 <para>If non-empty, this value is prepended to each of the JavaScript files.
26839 </para>
26840
26841 </refsection>
26842 </refentry>
26843
26844 <refentry version="5.0" id="ua.js">
26845 <refmeta>
26846 <refentrytitle>ua.js</refentrytitle>
26847 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26848 </refmeta>
26849 <refnamediv>
26850 <refname>ua.js</refname>
26851 <refpurpose>UA JavaScript file</refpurpose>
26852 </refnamediv>
26853
26854 <refsynopsisdiv>
26855 <programlisting id="ua.js.frag">
26856 &lt;xsl:param name="ua.js"&gt;ua.js&lt;/xsl:param&gt;
26857 </programlisting>
26858 </refsynopsisdiv>
26859
26860 <refsection><info><title>Description</title></info>
26861
26862 <para>Specifies the filename of the UA JavaScript file. It's unlikely
26863 that you will ever need to change this parameter.</para>
26864
26865 </refsection>
26866 </refentry>
26867
26868 <refentry version="5.0" id="xbDOM.js">
26869 <refmeta>
26870 <refentrytitle>xbDOM.js</refentrytitle>
26871 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26872 </refmeta>
26873 <refnamediv>
26874 <refname>xbDOM.js</refname>
26875 <refpurpose>xbDOM JavaScript file</refpurpose>
26876 </refnamediv>
26877
26878 <refsynopsisdiv>
26879 <programlisting id="xbDOM.js.frag">
26880 &lt;xsl:param name="xbDOM.js"&gt;xbDOM.js&lt;/xsl:param&gt;
26881 </programlisting>
26882 </refsynopsisdiv>
26883
26884 <refsection><info><title>Description</title></info>
26885
26886 <para>Specifies the filename of the xbDOM JavaScript file. It's unlikely
26887 that you will ever need to change this parameter.</para>
26888
26889 </refsection>
26890 </refentry>
26891
26892 <refentry version="5.0" id="xbStyle.js">
26893 <refmeta>
26894 <refentrytitle>xbStyle.js</refentrytitle>
26895 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26896 </refmeta>
26897 <refnamediv>
26898 <refname>xbStyle.js</refname>
26899 <refpurpose>xbStyle JavaScript file</refpurpose>
26900 </refnamediv>
26901
26902 <refsynopsisdiv>
26903 <programlisting id="xbStyle.js.frag">
26904 &lt;xsl:param name="xbStyle.js"&gt;xbStyle.js&lt;/xsl:param&gt;
26905 </programlisting>
26906 </refsynopsisdiv>
26907
26908 <refsection><info><title>Description</title></info>
26909
26910 <para>Specifies the filename of the xbStyle JavaScript file. It's unlikely
26911 that you will ever need to change this parameter.</para>
26912
26913 </refsection>
26914 </refentry>
26915
26916 <refentry version="5.0" id="xbLibrary.js">
26917 <refmeta>
26918 <refentrytitle>xbLibrary.js</refentrytitle>
26919 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26920 </refmeta>
26921 <refnamediv>
26922 <refname>xbLibrary.js</refname>
26923 <refpurpose>xbLibrary JavaScript file</refpurpose>
26924 </refnamediv>
26925
26926 <refsynopsisdiv>
26927 <programlisting id="xbLibrary.js.frag">
26928 &lt;xsl:param name="xbLibrary.js"&gt;xbLibrary.js&lt;/xsl:param&gt;
26929 </programlisting>
26930 </refsynopsisdiv>
26931
26932 <refsection><info><title>Description</title></info>
26933
26934 <para>Specifies the filename of the xbLibrary JavaScript file. It's unlikely
26935 that you will ever need to change this parameter.</para>
26936
26937 </refsection>
26938 </refentry>
26939
26940 <refentry version="5.0" id="xbCollapsibleLists.js">
26941 <refmeta>
26942 <refentrytitle>xbCollapsibleLists.js</refentrytitle>
26943 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26944 </refmeta>
26945 <refnamediv>
26946 <refname>xbCollapsibleLists.js</refname>
26947 <refpurpose>xbCollapsibleLists JavaScript file</refpurpose>
26948 </refnamediv>
26949
26950 <refsynopsisdiv>
26951 <programlisting id="xbCollapsibleLists.js.frag">
26952 &lt;xsl:param name="xbCollapsibleLists.js"&gt;xbCollapsibleLists.js&lt;/xsl:param&gt;
26953 </programlisting>
26954 </refsynopsisdiv>
26955
26956 <refsection><info><title>Description</title></info>
26957
26958 <para>Specifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely
26959 that you will ever need to change this parameter.</para>
26960
26961 </refsection>
26962 </refentry>
26963
26964 <refentry version="5.0" id="overlay.js">
26965 <refmeta>
26966 <refentrytitle>overlay.js</refentrytitle>
26967 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26968 </refmeta>
26969 <refnamediv>
26970 <refname>overlay.js</refname>
26971 <refpurpose>Overlay JavaScript file</refpurpose>
26972 </refnamediv>
26973
26974 <refsynopsisdiv>
26975 <programlisting id="overlay.js.frag">
26976 &lt;xsl:param name="overlay.js"&gt;overlay.js&lt;/xsl:param&gt;
26977 </programlisting>
26978 </refsynopsisdiv>
26979
26980 <refsection><info><title>Description</title></info>
26981
26982 <para>Specifies the filename of the overlay JavaScript file. It's unlikely
26983 that you will ever need to change this parameter.</para>
26984
26985 </refsection>
26986 </refentry>
26987
26988 <refentry version="5.0" id="slides.js">
26989 <refmeta>
26990 <refentrytitle>slides.js</refentrytitle>
26991 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26992 </refmeta>
26993 <refnamediv>
26994 <refname>slides.js</refname>
26995 <refpurpose>Slides overlay file</refpurpose>
26996 </refnamediv>
26997
26998 <refsynopsisdiv>
26999 <programlisting id="slides.js.frag">
27000 &lt;xsl:param name="slides.js"&gt;slides.js&lt;/xsl:param&gt;
27001 </programlisting>
27002 </refsynopsisdiv>
27003
27004 <refsection><info><title>Description</title></info>
27005
27006 <para>Specifies the filename of the slides JavaScript file. It's unlikely
27007 that you will ever need to change this parameter.</para>
27008
27009 </refsection>
27010 </refentry>
27011
27012 </reference><reference id="l10n" xml:base="../slides/html/param.xml">
27013 <title>HTML: Localization Parameters</title>
27014 <refentry version="5.0" id="text.home">
27015 <refmeta>
27016 <refentrytitle>text.home</refentrytitle>
27017 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27018 </refmeta>
27019 <refnamediv>
27020 <refname>text.home</refname>
27021 <refpurpose>Home</refpurpose>
27022 </refnamediv>
27023
27024 <refsynopsisdiv>
27025 <programlisting id="text.home.frag">
27026 &lt;xsl:param name="text.home"&gt;Home&lt;/xsl:param&gt;
27027 </programlisting>
27028 </refsynopsisdiv>
27029
27030 <refsection><info><title>Description</title></info>
27031
27032 <para>FIXME:</para>
27033
27034 </refsection>
27035 </refentry>
27036
27037 <refentry version="5.0" id="text.toc">
27038 <refmeta>
27039 <refentrytitle>text.toc</refentrytitle>
27040 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27041 </refmeta>
27042 <refnamediv>
27043 <refname>text.toc</refname>
27044 <refpurpose>FIXME:</refpurpose>
27045 </refnamediv>
27046
27047 <refsynopsisdiv>
27048 <programlisting id="text.toc.frag">
27049 &lt;xsl:param name="text.toc"&gt;ToC&lt;/xsl:param&gt;
27050 </programlisting>
27051 </refsynopsisdiv>
27052
27053 <refsection><info><title>Description</title></info>
27054
27055 <para>FIXME:</para>
27056
27057 </refsection>
27058 </refentry>
27059
27060 <refentry version="5.0" id="text.prev">
27061 <refmeta>
27062 <refentrytitle>text.prev</refentrytitle>
27063 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27064 </refmeta>
27065 <refnamediv>
27066 <refname>text.prev</refname>
27067 <refpurpose>FIXME:</refpurpose>
27068 </refnamediv>
27069
27070 <refsynopsisdiv>
27071 <programlisting id="text.prev.frag">
27072 &lt;xsl:param name="text.prev"&gt;Prev&lt;/xsl:param&gt;
27073 </programlisting>
27074 </refsynopsisdiv>
27075
27076 <refsection><info><title>Description</title></info>
27077
27078 <para>FIXME:</para>
27079
27080 </refsection>
27081 </refentry>
27082
27083 <refentry version="5.0" id="text.up">
27084 <refmeta>
27085 <refentrytitle>text.up</refentrytitle>
27086 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27087 </refmeta>
27088 <refnamediv>
27089 <refname>text.up</refname>
27090 <refpurpose>FIXME:</refpurpose>
27091 </refnamediv>
27092
27093 <refsynopsisdiv>
27094 <programlisting id="text.up.frag">
27095 &lt;xsl:param name="text.up"&gt;Up&lt;/xsl:param&gt;
27096 </programlisting>
27097 </refsynopsisdiv>
27098
27099 <refsection><info><title>Description</title></info>
27100
27101 <para>FIXME:</para>
27102
27103 </refsection>
27104 </refentry>
27105
27106 <refentry version="5.0" id="text.next">
27107 <refmeta>
27108 <refentrytitle>text.next</refentrytitle>
27109 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27110 </refmeta>
27111 <refnamediv>
27112 <refname>text.next</refname>
27113 <refpurpose>FIXME:</refpurpose>
27114 </refnamediv>
27115
27116 <refsynopsisdiv>
27117 <programlisting id="text.next.frag">
27118 &lt;xsl:param name="text.next"&gt;Next&lt;/xsl:param&gt;
27119 </programlisting>
27120 </refsynopsisdiv>
27121
27122 <refsection><info><title>Description</title></info>
27123
27124 <para>FIXME:</para>
27125
27126 </refsection>
27127 </refentry>
27128
27129
27130
27131 </reference>
27132       <reference id="fo" xml:base="../slides/fo/param.xml">
27133   <title>FO: General Params</title>
27134 <refentry version="5.0" id="slide.title.font.family">
27135 <refmeta>
27136 <refentrytitle>slide.title.font.family</refentrytitle>
27137 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
27138 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
27139 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
27140 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
27141 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
27142 </refmeta>
27143 <refnamediv>
27144 <refname>slide.title.font.family</refname>
27145 <refpurpose>Specifies font family to use for slide titles</refpurpose>
27146 </refnamediv>
27147
27148 <refsynopsisdiv>
27149 <programlisting id="slide.title.font.family.frag">
27150 &lt;xsl:param name="slide.title.font.family"&gt;Helvetica&lt;/xsl:param&gt;
27151 </programlisting>
27152 </refsynopsisdiv>
27153
27154 <refsection><info><title>Description</title></info>
27155
27156 <para>Specifies the font family to use for slides titles.</para>
27157
27158 </refsection>
27159 </refentry>
27160
27161 <refentry version="5.0" id="slide.font.family">
27162 <refmeta>
27163 <refentrytitle>slide.font.family</refentrytitle>
27164 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
27165 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
27166 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
27167 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
27168 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
27169 </refmeta>
27170 <refnamediv>
27171 <refname>slide.font.family</refname>
27172 <refpurpose>Specifies font family to use for slide bodies</refpurpose>
27173 </refnamediv>
27174
27175 <refsynopsisdiv>
27176 <programlisting id="slide.font.family.frag">
27177 &lt;xsl:param name="slide.font.family"&gt;Helvetica&lt;/xsl:param&gt;
27178 </programlisting>
27179 </refsynopsisdiv>
27180
27181 <refsection><info><title>Description</title></info>
27182
27183 <para>Specifies the font family to use for slides bodies.</para>
27184
27185 </refsection>
27186 </refentry>
27187
27188 <refentry version="5.0" id="foil.title.master">
27189 <refmeta>
27190 <refentrytitle>foil.title.master</refentrytitle>
27191 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
27192 </refmeta>
27193 <refnamediv>
27194 <refname>foil.title.master</refname>
27195 <refpurpose>Specifies unitless font size to use for foil titles</refpurpose>
27196 </refnamediv>
27197
27198 <refsynopsisdiv>
27199 <programlisting id="foil.title.master.frag">
27200 &lt;xsl:param name="foil.title.master"&gt;36&lt;/xsl:param&gt;
27201 &lt;!-- Inconsistant use of point size? --&gt;
27202 </programlisting>
27203 </refsynopsisdiv>
27204
27205 <refsection><info><title>Description</title></info>
27206
27207 <para>Specifies a unitless font size to use for foil titles; used in
27208 combination with the <parameter>foil.title.size</parameter>
27209 parameter.</para>
27210 </refsection>
27211 </refentry>
27212
27213 <refentry version="5.0" id="foil.title.size">
27214 <refmeta>
27215 <refentrytitle>foil.title.size</refentrytitle>
27216 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27217 </refmeta>
27218 <refnamediv>
27219 <refname>foil.title.size</refname>
27220 <refpurpose>Specifies font size to use for foil titles, including units</refpurpose>
27221 </refnamediv>
27222
27223 <refsynopsisdiv>
27224   <programlisting id="foil.title.size.frag">
27225     &lt;xsl:param name="foil.title.size"&gt;
27226       &lt;xsl:value-of select="$foil.title.master"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
27227     &lt;/xsl:param&gt;
27228   </programlisting>
27229 </refsynopsisdiv>
27230
27231 <refsection><info><title>Description</title></info>
27232
27233 <para>This parameter combines the value of the
27234 <parameter>foil.title.master</parameter> parameter with a unit
27235 specification. The default unit is <literal>pt</literal>
27236 (points).</para>
27237
27238 </refsection>
27239 </refentry>
27240
27241 </reference><reference id="propsets" xml:base="../slides/fo/param.xml">
27242   <title>FO: Property Sets</title>
27243 <refentry version="5.0" id="slides.properties">
27244 <refmeta>
27245 <refentrytitle>slides.properties</refentrytitle>
27246 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27247 </refmeta>
27248 <refnamediv>
27249 <refname>slides.properties</refname>
27250 <refpurpose>Specifies properties for all slides</refpurpose>
27251 </refnamediv>
27252
27253 <refsynopsisdiv>
27254   <programlisting id="slides.properties.frag">
27255     &lt;xsl:attribute-set name="slides.properties"&gt;
27256       &lt;xsl:attribute name="font-family"&gt;
27257         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
27258       &lt;/xsl:attribute&gt;
27259     &lt;/xsl:attribute-set&gt;
27260   </programlisting>
27261 </refsynopsisdiv>
27262
27263 <refsection><info><title>Description</title></info>
27264
27265 <para>This parameter specifies properties that are applied to all slides.</para>
27266
27267 </refsection>
27268 </refentry>
27269
27270 <refentry version="5.0" id="foilgroup.properties">
27271 <refmeta>
27272 <refentrytitle>foilgroup.properties</refentrytitle>
27273 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>  
27274 </refmeta>
27275 <refnamediv>
27276 <refname>foilgroup.properties</refname>
27277 <refpurpose>Specifies properties for all foilgroups</refpurpose>
27278 </refnamediv>
27279
27280 <refsynopsisdiv>
27281   <programlisting id="foilgroup.properties.frag">
27282     &lt;xsl:attribute-set name="foilgroup.properties"&gt;
27283       &lt;xsl:attribute name="font-family"&gt;
27284         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
27285       &lt;/xsl:attribute&gt;
27286     &lt;/xsl:attribute-set&gt;
27287   </programlisting>
27288 </refsynopsisdiv>
27289
27290 <refsection><info><title>Description</title></info>
27291
27292 <para>This parameter specifies properties that are applied to all foilgroups.</para>
27293
27294 </refsection>
27295 </refentry>
27296
27297 <refentry version="5.0" id="foil.subtitle.properties">
27298 <refmeta>
27299 <refentrytitle>foil.subtitle.properties</refentrytitle>
27300 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27301 </refmeta>
27302 <refnamediv>
27303 <refname>foil.subtitle.properties</refname>
27304 <refpurpose>Specifies properties for all foil subtitles</refpurpose>
27305 </refnamediv>
27306
27307 <refsynopsisdiv>
27308   <programlisting id="foil.subtitle.properties.frag">
27309     &lt;xsl:attribute-set name="foil.subtitle.properties"&gt;
27310       &lt;xsl:attribute name="font-family"&gt;
27311         &lt;xsl:value-of select="$slide.title.font.family"&gt;&lt;/xsl:value-of&gt;
27312       &lt;/xsl:attribute&gt;
27313       &lt;xsl:attribute name="text-align"&gt;center&lt;/xsl:attribute&gt;
27314       &lt;xsl:attribute name="font-size"&gt;
27315         &lt;xsl:value-of select="$foil.title.master * 0.8"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
27316       &lt;/xsl:attribute&gt;
27317       &lt;xsl:attribute name="space-after"&gt;12pt&lt;/xsl:attribute&gt;
27318     &lt;/xsl:attribute-set&gt;
27319   </programlisting>
27320 </refsynopsisdiv>
27321
27322 <refsection><info><title>Description</title></info>
27323
27324 <para>This parameter specifies properties that are applied to all foil subtitles.</para>
27325
27326 </refsection>
27327 </refentry>
27328
27329 <refentry version="5.0" id="foil.properties">
27330 <refmeta>
27331 <refentrytitle>foil.properties</refentrytitle>
27332 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27333 </refmeta>
27334 <refnamediv>
27335 <refname>foil.properties</refname>
27336 <refpurpose>Specifies properties for all foils</refpurpose>
27337 </refnamediv>
27338
27339 <refsynopsisdiv>
27340   <programlisting id="foil.properties.frag">
27341     &lt;xsl:attribute-set name="foil.properties"&gt;
27342       &lt;xsl:attribute name="font-family"&gt;
27343         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
27344       &lt;/xsl:attribute&gt;
27345       &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;1in&lt;/xsl:attribute&gt;
27346       &lt;xsl:attribute name="margin-{$direction.align.end}"&gt;1in&lt;/xsl:attribute&gt;
27347       &lt;xsl:attribute name="font-size"&gt;
27348         &lt;xsl:value-of select="$body.font.size"&gt;&lt;/xsl:value-of&gt;
27349       &lt;/xsl:attribute&gt;
27350       &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
27351     &lt;/xsl:attribute-set&gt;
27352   </programlisting>
27353 </refsynopsisdiv>
27354
27355 <refsection><info><title>Description</title></info>
27356
27357 <para>This parameter specifies properties that are applied to all foils.</para>
27358
27359 </refsection>
27360 </refentry>
27361
27362 <refentry version="5.0" id="speakernote.properties">
27363 <refmeta>
27364 <refentrytitle>speakernote.properties</refentrytitle>
27365 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27366 </refmeta>
27367 <refnamediv>
27368 <refname>speakernote.properties</refname>
27369 <refpurpose>Specifies properties for all speakernotes</refpurpose>
27370 </refnamediv>
27371
27372 <refsynopsisdiv>
27373   <programlisting id="speakernote.properties.frag">
27374     &lt;xsl:attribute-set name="speakernote.properties"&gt;
27375       &lt;xsl:attribute name="font-family"&gt;Times Roman&lt;/xsl:attribute&gt;
27376       &lt;xsl:attribute name="font-style"&gt;italic&lt;/xsl:attribute&gt;
27377       &lt;xsl:attribute name="font-size"&gt;12pt&lt;/xsl:attribute&gt;
27378       &lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
27379     &lt;/xsl:attribute-set&gt;
27380   </programlisting>
27381 </refsynopsisdiv>
27382
27383 <refsection><info><title>Description</title></info>
27384
27385 <para>This parameter specifies properties that are applied to all speakernotes.</para>
27386
27387 </refsection>
27388 </refentry>
27389
27390 <refentry version="5.0" id="running.foot.properties">
27391 <refmeta>
27392 <refentrytitle>running.foot.properties</refentrytitle>
27393 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27394 </refmeta>
27395 <refnamediv>
27396 <refname>running.foot.properties</refname>
27397 <refpurpose>Specifies properties for running foot on each slide</refpurpose>
27398 </refnamediv>
27399
27400 <refsynopsisdiv>
27401   <programlisting id="running.foot.properties.frag">
27402     &lt;xsl:attribute-set name="running.foot.properties"&gt;
27403       &lt;xsl:attribute name="font-family"&gt;
27404         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
27405       &lt;/xsl:attribute&gt;
27406       &lt;xsl:attribute name="font-size"&gt;14pt&lt;/xsl:attribute&gt;
27407       &lt;xsl:attribute name="color"&gt;#9F9F9F&lt;/xsl:attribute&gt;
27408     &lt;/xsl:attribute-set&gt;
27409   </programlisting>
27410 </refsynopsisdiv>
27411
27412 <refsection><info><title>Description</title></info>
27413
27414 <para>This parameter specifies properties that are applied to the
27415 running foot area of each slide.</para>
27416
27417 </refsection>
27418 </refentry>
27419
27420 </reference>
27421     </part>
27422     <part id="website">
27423       <?dbhtml dir="website"?>
27424       <?dbhtml filename="index.html"?>
27425       <title xml:base="../website/param.xml">Website Parameter Reference</title>
27426       <partintro id="websiteintro">
27427         
27428   <para xml:base="../website/param.xml">This is reference documentation for all user-configurable
27429     parameters in the DocBook XSL Website stylesheet (for
27430     generating websites from DocBook XML sources). Note that the
27431     Website stylesheet is a customization layer of the DocBook XSL
27432     HTML stylesheet.  Therefore, in addition to the
27433     Website-specific parameters listed in this section, you can
27434     also use a number of <link xlink:href="../html/">HTML
27435      stylesheet parameters</link> to control Website output.</para>
27436
27437       </partintro>
27438       <reference id="general" xml:base="../website/param.xml">
27439 <title>General Parameters</title>
27440 <refentry version="5.0" id="autolayout-file">
27441 <refmeta>
27442 <refentrytitle>autolayout-file</refentrytitle>
27443 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27444 </refmeta>
27445 <refnamediv>
27446 <refname>autolayout-file</refname>
27447 <refpurpose>Identifies the autolayout.xml file</refpurpose>
27448 </refnamediv>
27449
27450 <refsynopsisdiv>
27451 <programlisting id="autolayout-file.frag">
27452 &lt;xsl:param name="autolayout-file"&gt;autolayout.xml&lt;/xsl:param&gt;
27453 </programlisting>
27454 </refsynopsisdiv>
27455
27456 <refsection><info><title>Description</title></info>
27457 <para>When the source pages are spread over several directories, this
27458 parameter can be set (for example, from the command line of a batch-mode
27459 XSLT processor) to indicate the location of the autolayout.xml file.</para>
27460 <para>FIXME: for browser-based use, there needs to be a PI for this...
27461 </para>
27462 </refsection>
27463 </refentry>
27464
27465 <refentry version="5.0" id="body.attributes">
27466 <refmeta>
27467 <refentrytitle>body.attributes</refentrytitle>
27468 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27469 </refmeta>
27470 <refnamediv>
27471 <refname>body.attributes</refname>
27472 <refpurpose>DEPRECATED</refpurpose>
27473 </refnamediv>
27474
27475 <refsynopsisdiv>
27476 <programlisting id="body.attributes.frag">
27477 &lt;xsl:attribute-set name="body.attributes"&gt;
27478   &lt;xsl:attribute name="bgcolor"&gt;white&lt;/xsl:attribute&gt;
27479   &lt;xsl:attribute name="text"&gt;black&lt;/xsl:attribute&gt;
27480   &lt;xsl:attribute name="link"&gt;#0000FF&lt;/xsl:attribute&gt;
27481   &lt;xsl:attribute name="vlink"&gt;#840084&lt;/xsl:attribute&gt;
27482   &lt;xsl:attribute name="alink"&gt;#0000FF&lt;/xsl:attribute&gt;
27483 &lt;/xsl:attribute-set&gt;
27484 </programlisting>
27485 </refsynopsisdiv>
27486
27487 <refsection><info><title>Description</title></info>
27488 <para>DEPRECATED</para>
27489 </refsection>
27490 </refentry>
27491
27492 <refentry version="5.0" id="currentpage.marker">
27493 <refmeta>
27494 <refentrytitle>currentpage.marker</refentrytitle>
27495 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27496 </refmeta>
27497 <refnamediv>
27498 <refname>currentpage.marker</refname>
27499 <refpurpose>The text symbol used to mark the current page</refpurpose>
27500 </refnamediv>
27501
27502 <refsynopsisdiv>
27503 <programlisting id="currentpage.marker.frag">
27504 &lt;xsl:param name="currentpage.marker"&gt;@&lt;/xsl:param&gt;
27505 </programlisting>
27506 </refsynopsisdiv>
27507
27508 <refsection><info><title>Description</title></info>
27509 <para>Character to use as identifying the current page in </para>
27510 </refsection>
27511 </refentry>
27512
27513 <refentry version="5.0" id="dry-run">
27514 <refmeta>
27515 <refentrytitle>dry-run</refentrytitle>
27516 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27517 </refmeta>
27518 <refnamediv>
27519 <refname>dry-run</refname>
27520 <refpurpose>Indicates that no files should be produced</refpurpose>
27521 </refnamediv>
27522 <refsynopsisdiv>
27523   <programlisting id="dry-run.frag">
27524     &lt;xsl:param name="dry-run" select="0"&gt;&lt;/xsl:param&gt;
27525   </programlisting>
27526 </refsynopsisdiv>
27527 <refsection><info><title>Description</title></info>
27528 <para>When using the XSLT processor to manage dependencies and construct
27529 the website, this parameter can be used to suppress the generation of
27530 new and updated files. Effectively, this allows you to see what the
27531 stylesheet would do, without actually making any changes.</para>
27532 <para>Only applies when XSLT-based chunking is being used.</para>
27533 </refsection>
27534 </refentry>
27535
27536 <refentry version="5.0" id="feedback.href">
27537 <refmeta>
27538 <refentrytitle>feedback.href</refentrytitle>
27539 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
27540 </refmeta>
27541 <refnamediv>
27542 <refname>feedback.href</refname>
27543 <refpurpose>HREF (URI) for feedback link</refpurpose>
27544 </refnamediv>
27545
27546 <refsynopsisdiv>
27547 <programlisting id="feedback.href.frag">
27548 &lt;xsl:param name="feedback.href"&gt;&lt;/xsl:param&gt;
27549 </programlisting>
27550 </refsynopsisdiv>
27551
27552 <refsection><info><title>Description</title></info>
27553 <para>The <varname>feedback.href</varname> value is used as the value
27554 for the <tag class="attribute">href</tag> attribute on the feedback
27555 link. If <varname>feedback.href</varname>
27556 is empty, no feedback link is generated.</para>
27557 </refsection>
27558 </refentry>
27559
27560 <refentry version="5.0" id="feedback.link.text">
27561 <refmeta>
27562 <refentrytitle>feedback.link.text</refentrytitle>
27563 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27564 </refmeta>
27565 <refnamediv>
27566 <refname>feedback.link.text</refname>
27567 <refpurpose>The text of the feedback link</refpurpose>
27568 </refnamediv>
27569
27570 <refsynopsisdiv>
27571 <programlisting id="feedback.link.text.frag">
27572 &lt;xsl:param name="feedback.link.text"&gt;Feedback&lt;/xsl:param&gt;
27573 </programlisting>
27574 </refsynopsisdiv>
27575
27576 <refsection><info><title>Description</title></info>
27577 <para>The contents of this variable is used as the text of the feedback
27578 link if <varname>feedback.href</varname> is not empty. If
27579 <varname>feedback.href</varname> is empty, no feedback link is
27580 generated.</para>
27581 </refsection>
27582 </refentry>
27583
27584 <refentry version="5.0" id="feedback.with.ids">
27585 <refmeta>
27586 <refentrytitle>feedback.with.ids</refentrytitle>
27587 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27588 </refmeta>
27589 <refnamediv>
27590 <refname>feedback.with.ids</refname>
27591 <refpurpose>Toggle use of IDs in feedback</refpurpose>
27592 </refnamediv>
27593
27594 <refsynopsisdiv>
27595 <programlisting id="feedback.with.ids.frag">
27596 &lt;xsl:param name="feedback.with.ids" select="0"&gt;&lt;/xsl:param&gt;
27597 </programlisting>
27598 </refsynopsisdiv>
27599
27600 <refsection><info><title>Description</title></info>
27601 <para>If <varname>feedback.with.ids</varname> is non-zero, the ID of the
27602 current page will be added to the feedback link. This can be used, for
27603 example, if the <varname>feedback.href</varname> is a CGI script.</para>
27604 </refsection>
27605 </refentry>
27606
27607 <refentry version="5.0" id="filename-prefix">
27608 <refmeta>
27609 <refentrytitle>filename-prefix</refentrytitle>
27610 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27611 </refmeta>
27612 <refnamediv>
27613 <refname>filename-prefix</refname>
27614 <refpurpose>Prefix added to all filenames</refpurpose>
27615 </refnamediv>
27616
27617 <refsynopsisdiv>
27618 <programlisting id="filename-prefix.frag">
27619 &lt;xsl:param name="filename-prefix"&gt;&lt;/xsl:param&gt;
27620 </programlisting>
27621 </refsynopsisdiv>
27622
27623 <refsection><info><title>Description</title></info>
27624 <para>To produce the <quote>text-only</quote> (that is, non-tabular) layout
27625 of a website simultaneously with the tabular layout, the filenames have to
27626 be distinguished. That's accomplished by adding the
27627 <varname>filename-prefix</varname> to the front of each filename.</para>
27628 </refsection>
27629 </refentry>
27630
27631 <refentry version="5.0" id="footer.hr">
27632 <refmeta>
27633 <refentrytitle>footer.hr</refentrytitle>
27634 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27635 </refmeta>
27636 <refnamediv>
27637 <refname>footer.hr</refname>
27638 <refpurpose>Toggle &lt;HR&gt; before footer</refpurpose>
27639 </refnamediv>
27640
27641 <refsynopsisdiv>
27642 <programlisting id="footer.hr.frag">
27643 &lt;xsl:param name="footer.hr" select="1"&gt;&lt;/xsl:param&gt;
27644 </programlisting>
27645 </refsynopsisdiv>
27646
27647 <refsection><info><title>Description</title></info>
27648 <para>If non-zero, an &lt;HR&gt; is generated at the bottom of each web page,
27649 before the footer.</para>
27650 </refsection>
27651 </refentry>
27652
27653 <refentry version="5.0" id="header.hr">
27654 <refmeta>
27655 <refentrytitle>header.hr</refentrytitle>
27656 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27657 </refmeta>
27658 <refnamediv>
27659 <refname>header.hr</refname>
27660 <refpurpose>Toggle &lt;HR&gt; after header</refpurpose>
27661 </refnamediv>
27662
27663 <refsynopsisdiv>
27664 <programlisting id="header.hr.frag">
27665 &lt;xsl:param name="header.hr" select="1"&gt;&lt;/xsl:param&gt;
27666 </programlisting>
27667 </refsynopsisdiv>
27668
27669 <refsection><info><title>Description</title></info>
27670 <para>If non-zero, an &lt;HR&gt; is generated at the bottom of each web page,
27671 before the footer.</para>
27672 </refsection>
27673 </refentry>
27674
27675 <refentry version="5.0" id="output-root">
27676 <refmeta>
27677 <refentrytitle>output-root</refentrytitle>
27678 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27679 </refmeta>
27680 <refnamediv>
27681 <refname>output-root</refname>
27682 <refpurpose>Specifies the root directory of the website</refpurpose>
27683 </refnamediv>
27684
27685 <refsynopsisdiv>
27686 <programlisting id="output-root.frag">
27687 &lt;xsl:param name="output-root"&gt;.&lt;/xsl:param&gt;
27688 </programlisting>
27689 </refsynopsisdiv>
27690
27691 <refsection><info><title>Description</title></info>
27692 <para>When using the XSLT processor to manage dependencies and construct
27693 the website, this parameter can be used to indicate the root directory
27694 where the resulting pages are placed.</para>
27695 <para>Only applies when XSLT-based chunking is being used.</para>
27696 </refsection>
27697 </refentry>
27698
27699 <refentry version="5.0" id="rebuild-all">
27700 <refmeta>
27701 <refentrytitle>rebuild-all</refentrytitle>
27702 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27703 </refmeta>
27704 <refnamediv>
27705 <refname>rebuild-all</refname>
27706 <refpurpose>Indicates that all files should be produced</refpurpose>
27707 </refnamediv>
27708
27709 <refsynopsisdiv>
27710 <programlisting id="rebuild-all.frag">
27711 &lt;xsl:param name="rebuild-all" select="0"&gt;&lt;/xsl:param&gt;
27712 </programlisting>
27713 </refsynopsisdiv>
27714
27715 <refsection><info><title>Description</title></info>
27716 <para>When using the XSLT processor to manage dependencies and construct
27717 the website, this parameter can be used to regenerate the whole website,
27718 updating even pages that don't appear to need to be updated.</para>
27719 <para>The dependency extension only looks at the source documents. So
27720 if you change something in the stylesheet, for example, that has a global
27721 effect, you can use this parameter to force the stylesheet to rebuild the
27722 whole website.
27723 </para>
27724 <para>Only applies when XSLT-based chunking is being used.</para>
27725 </refsection>
27726 </refentry>
27727
27728 <refentry version="5.0" id="sequential.links">
27729 <refmeta>
27730 <refentrytitle>sequential.links</refentrytitle>
27731 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27732 </refmeta>
27733 <refnamediv>
27734 <refname>sequential.links</refname>
27735 <refpurpose>Make sequentional links?</refpurpose>
27736 </refnamediv>
27737
27738 <refsynopsisdiv>
27739 <programlisting id="sequential.links.frag">
27740 &lt;xsl:param name="sequential.links" select="0"&gt;&lt;/xsl:param&gt;
27741 </programlisting>
27742 </refsynopsisdiv>
27743
27744 <refsection><info><title>Description</title></info>
27745 <para>FIXME</para>
27746 </refsection>
27747 </refentry>
27748
27749 <refentry version="5.0" id="suppress.homepage.title">
27750 <refmeta>
27751 <refentrytitle>suppress.homepage.title</refentrytitle>
27752 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27753 </refmeta>
27754 <refnamediv>
27755 <refname>suppress.homepage.title</refname>
27756 <refpurpose>Suppress title on homepage?</refpurpose>
27757 </refnamediv>
27758
27759 <refsynopsisdiv>
27760 <programlisting id="suppress.homepage.title.frag">
27761 &lt;xsl:param name="suppress.homepage.title" select="1"&gt;&lt;/xsl:param&gt;
27762 </programlisting>
27763 </refsynopsisdiv>
27764
27765 <refsection><info><title>Description</title></info>
27766 <para>FIXME:If non-zero, the title on the homepage is suppressed?</para>
27767 </refsection>
27768 </refentry>
27769
27770 <refentry version="5.0" id="table.spacer.image">
27771 <refmeta>
27772 <refentrytitle>table.spacer.image</refentrytitle>
27773 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27774 </refmeta>
27775 <refnamediv>
27776 <refname>table.spacer.image</refname>
27777 <refpurpose>Invisible pixel for tabular accessibility</refpurpose>
27778 </refnamediv>
27779
27780 <refsynopsisdiv>
27781 <programlisting id="table.spacer.image.frag">
27782 &lt;xsl:param name="table.spacer.image"&gt;graphics/spacer.gif&lt;/xsl:param&gt;
27783 </programlisting>
27784 </refsynopsisdiv>
27785
27786 <refsection><info><title>Description</title></info>
27787 <para>This is the 1x1 pixel, transparent pixel used for <link xlink:href="http://diveintoaccessibility.org/day_10_presenting_your_main_content_first.html">the table trick</link> to increase the accessibility of the tabular
27788 website presentation.</para>
27789 </refsection>
27790 </refentry>
27791
27792 </reference><reference id="nav" xml:base="../website/param.xml">
27793 <title>Navigation Parameters</title>
27794 <refentry version="5.0" id="banner.before.navigation">
27795 <refmeta>
27796 <refentrytitle>banner.before.navigation</refentrytitle>
27797 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27798 </refmeta>
27799 <refnamediv>
27800 <refname>banner.before.navigation</refname>
27801 <refpurpose>Put banner before navigation?</refpurpose>
27802 </refnamediv>
27803
27804 <refsynopsisdiv>
27805 <programlisting id="banner.before.navigation.frag">
27806 &lt;xsl:param name="banner.before.navigation" select="1"&gt;&lt;/xsl:param&gt;
27807 </programlisting>
27808 </refsynopsisdiv>
27809
27810 <refsection><info><title>Description</title></info>
27811 <para>FIXME</para>
27812 </refsection>
27813 </refentry>
27814
27815 <refentry version="5.0" id="navbgcolor">
27816 <refmeta>
27817 <refentrytitle>navbgcolor</refentrytitle>
27818 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
27819 </refmeta>
27820 <refnamediv>
27821 <refname>navbgcolor</refname>
27822 <refpurpose>The background color of the navigation TOC</refpurpose>
27823 </refnamediv>
27824
27825 <refsynopsisdiv>
27826 <programlisting id="navbgcolor.frag">
27827 &lt;xsl:param name="navbgcolor"&gt;#4080FF&lt;/xsl:param&gt;
27828 </programlisting>
27829 </refsynopsisdiv>
27830
27831 <refsection><info><title>Description</title></info>
27832 <para>The background color of the navigation TOC.</para>
27833 <para>Only applies with the tabular presentation is being used.</para>
27834 </refsection>
27835 </refentry>
27836
27837 <refentry version="5.0" id="navbodywidth">
27838 <refmeta>
27839 <refentrytitle>navbodywidth</refentrytitle>
27840 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27841 </refmeta>
27842 <refnamediv>
27843 <refname>navbodywidth</refname>
27844 <refpurpose>Specifies the width of the navigation table body</refpurpose>
27845 </refnamediv>
27846
27847 <refsynopsisdiv>
27848 <programlisting id="navbodywidth.frag">
27849 &lt;xsl:param name="navbodywidth"&gt;&lt;/xsl:param&gt;
27850 </programlisting>
27851 </refsynopsisdiv>
27852
27853 <refsection><info><title>Description</title></info>
27854 <para>The width of the body column.</para>
27855 <para>Only applies with the tabular presentation is being used.</para>
27856 </refsection>
27857 </refentry>
27858
27859 <refentry version="5.0" id="nav.table.summary">
27860 <refmeta>
27861 <refentrytitle>nav.table.summary</refentrytitle>
27862 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27863 </refmeta>
27864 <refnamediv>
27865 <refname>nav.table.summary</refname>
27866 <refpurpose>HTML Table summary attribute value for navigation tables</refpurpose>
27867 </refnamediv>
27868
27869 <refsynopsisdiv>
27870 <programlisting id="nav.table.summary.frag">
27871 &lt;xsl:param name="nav.table.summary"&gt;Navigation&lt;/xsl:param&gt;
27872 </programlisting>
27873 </refsynopsisdiv>
27874
27875 <refsection><info><title>Description</title></info>
27876 <para>The value of this parameter is used as the value of the table
27877 summary attribute for the navigation table.</para>
27878 <para>Only applies with the tabular presentation is being used.</para>
27879 </refsection>
27880 </refentry>
27881
27882 <refentry version="5.0" id="navtocwidth">
27883 <refmeta>
27884 <refentrytitle>navtocwidth</refentrytitle>
27885 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27886 </refmeta>
27887 <refnamediv>
27888 <refname>navtocwidth</refname>
27889 <refpurpose>Specifies the width of the navigation table TOC</refpurpose>
27890 </refnamediv>
27891
27892 <refsynopsisdiv>
27893 <programlisting id="navtocwidth.frag">
27894 &lt;xsl:param name="navtocwidth"&gt;220&lt;/xsl:param&gt;
27895 </programlisting>
27896 </refsynopsisdiv>
27897
27898 <refsection><info><title>Description</title></info>
27899 <para>The width, in pixels, of the navigation column.</para>
27900 <para>Only applies with the tabular presentation is being used.</para>
27901 </refsection>
27902 </refentry>
27903
27904 <refentry version="5.0" id="textbgcolor">
27905 <refmeta>
27906 <refentrytitle>textbgcolor</refentrytitle>
27907 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
27908 </refmeta>
27909 <refnamediv>
27910 <refname>textbgcolor</refname>
27911 <refpurpose>The background color of the table body</refpurpose>
27912 </refnamediv>
27913
27914 <refsynopsisdiv>
27915 <programlisting id="textbgcolor.frag">
27916 &lt;xsl:param name="textbgcolor"&gt;white&lt;/xsl:param&gt;
27917 </programlisting>
27918 </refsynopsisdiv>
27919
27920 <refsection><info><title>Description</title></info>
27921 <para>The background color of the table body.</para>
27922 <para>Only applies with the tabular presentation is being used.</para>
27923 </refsection>
27924 </refentry>
27925
27926 </reference><reference id="toc" xml:base="../website/param.xml">
27927 <title>ToC Parameters</title>
27928 <refentry version="5.0" id="toc.blank.graphic">
27929 <refmeta>
27930 <refentrytitle>toc.blank.graphic</refentrytitle>
27931 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27932 </refmeta>
27933 <refnamediv>
27934 <refname>toc.blank.graphic</refname>
27935 <refpurpose>Use graphic for "blanks" in TOC?</refpurpose>
27936 </refnamediv>
27937
27938 <refsynopsisdiv>
27939 <programlisting id="toc.blank.graphic.frag">
27940 &lt;xsl:param name="toc.blank.graphic" select="1"&gt;&lt;/xsl:param&gt;
27941 </programlisting>
27942 </refsynopsisdiv>
27943
27944 <refsection><info><title>Description</title></info>
27945 <para>If non-zero, "blanks" in the the TOC will be accomplished
27946 with the graphic identified by <varname>toc.spacer.image</varname>.
27947 </para>
27948 <para>Only applies with the tabular presentation is being used.</para>
27949 </refsection>
27950 </refentry>
27951
27952 <refentry version="5.0" id="toc.blank.image">
27953 <refmeta>
27954 <refentrytitle>toc.blank.image</refentrytitle>
27955 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27956 </refmeta>
27957 <refnamediv>
27958 <refname>toc.blank.image</refname>
27959 <refpurpose>The image for "blanks" in the TOC</refpurpose>
27960 </refnamediv>
27961
27962 <refsynopsisdiv>
27963 <programlisting id="toc.blank.image.frag">
27964 &lt;xsl:param name="toc.blank.image"&gt;graphics/blank.gif&lt;/xsl:param&gt;
27965 </programlisting>
27966 </refsynopsisdiv>
27967
27968 <refsection><info><title>Description</title></info>
27969 <para>If <varname>toc.blank.graphic</varname> is non-zero, this image
27970 will be used to for "blanks" in the TOC.</para>
27971 <para>Only applies with the tabular presentation is being used.</para>
27972 </refsection>
27973 </refentry>
27974
27975 <refentry version="5.0" id="toc.blank.text">
27976 <refmeta>
27977 <refentrytitle>toc.blank.text</refentrytitle>
27978 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27979 </refmeta>
27980 <refnamediv>
27981 <refname>toc.blank.text</refname>
27982 <refpurpose>The text for "blanks" in the TOC</refpurpose>
27983 </refnamediv>
27984
27985 <refsynopsisdiv>
27986 <programlisting id="toc.blank.text.frag">
27987 &lt;xsl:param name="toc.blank.text"&gt;&#160;&#160;&#160;&lt;/xsl:param&gt;
27988 </programlisting>
27989 </refsynopsisdiv>
27990
27991 <refsection><info><title>Description</title></info>
27992 <para>If <varname>toc.blank.graphic</varname> is zero, this text string
27993 will be used for "blanks" in the TOC.</para>
27994 <para>Only applies with the tabular presentation is being used.</para>
27995 </refsection>
27996 </refentry>
27997
27998 <refentry version="5.0" id="toc.pointer.graphic">
27999 <refmeta>
28000 <refentrytitle>toc.pointer.graphic</refentrytitle>
28001 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28002 </refmeta>
28003 <refnamediv>
28004 <refname>toc.pointer.graphic</refname>
28005 <refpurpose>Use graphic for TOC pointer?</refpurpose>
28006 </refnamediv>
28007
28008 <refsynopsisdiv>
28009 <programlisting id="toc.pointer.graphic.frag">
28010 &lt;xsl:param name="toc.pointer.graphic" select="1"&gt;&lt;/xsl:param&gt;
28011 </programlisting>
28012 </refsynopsisdiv>
28013
28014 <refsection><info><title>Description</title></info>
28015 <para>If non-zero, the "pointer" in the TOC will be displayed
28016 with the graphic identified by <varname>toc.pointer.image</varname>.
28017 </para>
28018 <para>Only applies with the tabular presentation is being used.</para>
28019 </refsection>
28020 </refentry>
28021
28022 <refentry version="5.0" id="toc.pointer.image">
28023 <refmeta>
28024 <refentrytitle>toc.pointer.image</refentrytitle>
28025 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28026 </refmeta>
28027 <refnamediv>
28028 <refname>toc.pointer.image</refname>
28029 <refpurpose>The image for the "pointer" in the TOC</refpurpose>
28030 </refnamediv>
28031
28032 <refsynopsisdiv>
28033 <programlisting id="toc.pointer.image.frag">
28034 &lt;xsl:param name="toc.pointer.image"&gt;graphics/arrow.gif&lt;/xsl:param&gt;
28035 </programlisting>
28036 </refsynopsisdiv>
28037
28038 <refsection><info><title>Description</title></info>
28039 <para>If <varname>toc.pointer.graphic</varname> is non-zero, this image
28040 will be used for the "pointer" in the TOC.</para>
28041 <para>Only applies with the tabular presentation is being used.</para>
28042 </refsection>
28043 </refentry>
28044
28045 <refentry version="5.0" id="toc.pointer.text">
28046 <refmeta>
28047 <refentrytitle>toc.pointer.text</refentrytitle>
28048 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
28049 </refmeta>
28050 <refnamediv>
28051 <refname>toc.pointer.text</refname>
28052 <refpurpose>The text for the "pointer" in the TOC</refpurpose>
28053 </refnamediv>
28054
28055 <refsynopsisdiv>
28056 <programlisting id="toc.pointer.text.frag">
28057 &lt;xsl:param name="toc.pointer.text"&gt;&#160;&gt;&#160;&lt;/xsl:param&gt;
28058 </programlisting>
28059 </refsynopsisdiv>
28060
28061 <refsection><info><title>Description</title></info>
28062 <para>If <varname>toc.pointer.graphic</varname> is zero, this text string
28063 will be used to display the "pointer" in the TOC.</para>
28064 <para>Only applies with the tabular presentation is being used.</para>
28065 </refsection>
28066 </refentry>
28067
28068 <refentry version="5.0" id="toc.spacer.graphic">
28069 <refmeta>
28070 <refentrytitle>toc.spacer.graphic</refentrytitle>
28071 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28072 </refmeta>
28073 <refnamediv>
28074 <refname>toc.spacer.graphic</refname>
28075 <refpurpose>Use graphic for TOC spacer?</refpurpose>
28076 </refnamediv>
28077
28078 <refsynopsisdiv>
28079 <programlisting id="toc.spacer.graphic.frag">
28080 &lt;xsl:param name="toc.spacer.graphic" select="1"&gt;&lt;/xsl:param&gt;
28081 </programlisting>
28082 </refsynopsisdiv>
28083
28084 <refsection><info><title>Description</title></info>
28085 <para>If non-zero, the indentation in the TOC will be accomplished
28086 with the graphic identified by <varname>toc.spacer.image</varname>.
28087 </para>
28088 <para>Only applies with the tabular presentation is being used.</para>
28089 </refsection>
28090 </refentry>
28091
28092 <refentry version="5.0" id="toc.spacer.image">
28093 <refmeta>
28094 <refentrytitle>toc.spacer.image</refentrytitle>
28095 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28096 </refmeta>
28097 <refnamediv>
28098 <refname>toc.spacer.image</refname>
28099 <refpurpose>The image for spacing the TOC</refpurpose>
28100 </refnamediv>
28101
28102 <refsynopsisdiv>
28103 <programlisting id="toc.spacer.image.frag">
28104 &lt;xsl:param name="toc.spacer.image"&gt;graphics/blank.gif&lt;/xsl:param&gt;
28105 </programlisting>
28106 </refsynopsisdiv>
28107
28108 <refsection><info><title>Description</title></info>
28109 <para>If <varname>toc.spacer.graphic</varname> is non-zero, this image
28110 will be used to indent the TOC.</para>
28111 <para>Only applies with the tabular presentation is being used.</para>
28112 </refsection>
28113 </refentry>
28114
28115 <refentry version="5.0" id="toc.spacer.text">
28116 <refmeta>
28117 <refentrytitle>toc.spacer.text</refentrytitle>
28118 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
28119 </refmeta>
28120 <refnamediv>
28121 <refname>toc.spacer.text</refname>
28122 <refpurpose>The text for spacing the TOC</refpurpose>
28123 </refnamediv>
28124
28125 <refsynopsisdiv>
28126 <programlisting id="toc.spacer.text.frag">
28127 &lt;xsl:param name="toc.spacer.text"&gt;&#160;&#160;&#160;&lt;/xsl:param&gt;
28128 </programlisting>
28129 </refsynopsisdiv>
28130
28131 <refsection><info><title>Description</title></info>
28132 <para>If <varname>toc.spacer.graphic</varname> is zero, this text string
28133 will be used to indent the TOC.</para>
28134 <para>Only applies with the tabular presentation is being used.</para>
28135 </refsection>
28136 </refentry>
28137
28138 </reference>
28139     </part>
28140   </book>
28141   <book id="pi"><title>DocBook XSL Stylesheets User&#160;Reference:&#160;PIs</title>
28142     <?dbhtml dir="pi"?>
28143     <?dbhtml filename="index.html"?>
28144     <info>
28145       <abstract>
28146         <para>This is generated reference documentation for all
28147           user-specifiable processing instructions in the DocBook
28148           XSL stylesheets.
28149           <note>
28150             <para>You add these PIs at particular points in a document to
28151               cause specific &#8220;exceptions&#8221; to formatting/output behavior. To
28152               make global changes in formatting/output behavior across an
28153               entire document, it&#8217;s better to do it by setting an
28154               appropriate stylesheet parameter (if there is one).</para>
28155           </note>
28156         </para>
28157       </abstract>
28158     </info>
28159     <part id="pi-html">
28160       <info xml:base="../html/pi.xml"><title>HTML Processing Instruction Reference</title>
28161     <releaseinfo role="meta">
28162       $Id: pi.xsl 8394 2009-04-02 20:31:30Z mzjn $
28163     </releaseinfo>
28164   </info>
28165   <partintro id="partintro" xml:base="../html/pi.xml">
28166     <title>Introduction</title>
28167     
28168 <para>This is generated reference documentation for all
28169       user-specifiable processing instructions (PIs) in the DocBook
28170       XSL stylesheets for HTML output.
28171       <note>
28172         
28173 <para>You add these PIs at particular points in a document to
28174           cause specific &#8220;exceptions&#8221; to formatting/output behavior. To
28175           make global changes in formatting/output behavior across an
28176           entire document, it&#8217;s better to do it by setting an
28177           appropriate stylesheet parameter (if there is one).</para>
28178
28179       </note>
28180     </para>
28181
28182   </partintro>
28183
28184 <refentry id="dbhtml_background-color" xml:base="../html/pi.xml">
28185 <refnamediv>
28186 <refname>dbhtml_background-color</refname>
28187 <refpurpose>Sets background color for an image</refpurpose>
28188 </refnamediv>
28189 <refsynopsisdiv>
28190
28191     <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
28192   
28193 </refsynopsisdiv>
28194 <refsect1><title>Description</title>
28195     
28196 <para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or
28197       after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
28198       <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
28199       sibling to the element, to set a background color for the
28200       image.</para>
28201
28202   </refsect1><refsect1><title>Parameters</title>
28203     
28204 <variablelist>
28205       <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
28206         <listitem>
28207           
28208 <para>An HTML color value</para>
28209
28210         </listitem>
28211       </varlistentry>
28212     </variablelist>
28213
28214   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28215     
28216 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
28217
28218   </refsect1></refentry>
28219
28220 <refentry id="dbhtml_bgcolor" xml:base="../html/pi.xml">
28221 <refnamediv>
28222 <refname>dbhtml_bgcolor</refname>
28223 <refpurpose>Sets background color on a CALS table row or table cell</refpurpose>
28224 </refnamediv>
28225 <refsynopsisdiv>
28226
28227     <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
28228   
28229 </refsynopsisdiv>
28230 <refsect1><title>Description</title>
28231     
28232 <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row
28233       or cell to set a background color for that table row or cell.</para>
28234
28235   </refsect1><refsect1><title>Parameters</title>
28236     
28237 <variablelist>
28238       <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
28239         <listitem>
28240           
28241 <para>An HTML color value</para>
28242
28243         </listitem>
28244       </varlistentry>
28245     </variablelist>
28246
28247   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28248     
28249 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
28250
28251   </refsect1></refentry>
28252
28253 <refentry id="dbhtml_cellpadding" xml:base="../html/pi.xml">
28254 <refnamediv>
28255 <refname>dbhtml_cellpadding</refname>
28256 <refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>
28257 </refnamediv>
28258 <refsynopsisdiv>
28259
28260     <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
28261   
28262 </refsynopsisdiv>
28263 <refsect1><title>Description</title>
28264     
28265 <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
28266       CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
28267       for the HTML <literal>cellpadding</literal> attribute in the
28268       output HTML table.</para>
28269
28270   </refsect1><refsect1><title>Parameters</title>
28271     
28272 <variablelist>
28273       <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
28274         <listitem>
28275           
28276 <para>Specifies the cellpadding</para>
28277
28278         </listitem>
28279       </varlistentry>
28280     </variablelist>
28281
28282   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28283     
28284 <para><parameter>html.cellpadding</parameter></para>
28285
28286   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28287     
28288 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
28289       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28290
28291   </refsect1></refentry>
28292
28293 <refentry id="dbhtml_cellspacing" xml:base="../html/pi.xml">
28294 <refnamediv>
28295 <refname>dbhtml_cellspacing</refname>
28296 <refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>
28297 </refnamediv>
28298 <refsynopsisdiv>
28299
28300     <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
28301   
28302 </refsynopsisdiv>
28303 <refsect1><title>Description</title>
28304     
28305 <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
28306       CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
28307       for the HTML <literal>cellspacing</literal> attribute in the
28308       output HTML table.</para>
28309
28310   </refsect1><refsect1><title>Parameters</title>
28311     
28312 <variablelist>
28313       <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
28314         <listitem>
28315           
28316 <para>Specifies the cellspacing</para>
28317
28318         </listitem>
28319       </varlistentry>
28320     </variablelist>
28321
28322   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28323     
28324 <para><parameter>html.cellspacing</parameter></para>
28325
28326   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28327     
28328 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
28329       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28330
28331     </refsect1></refentry>
28332
28333 <refentry id="dbhtml_class" xml:base="../html/pi.xml">
28334 <refnamediv>
28335 <refname>dbhtml_class</refname>
28336 <refpurpose>Set value of the class attribute for a CALS table row</refpurpose>
28337 </refnamediv>
28338 <refsynopsisdiv>
28339
28340     <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
28341   
28342 </refsynopsisdiv>
28343 <refsect1><title>Description</title>
28344     
28345 <para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a
28346       <tag>row</tag> to specify a <literal>class</literal>
28347       attribute and value in the HTML output for that row.</para>
28348
28349   </refsect1><refsect1><title>Parameters</title>
28350     
28351 <variablelist>
28352       <varlistentry><term>class="<replaceable>name</replaceable>"</term>
28353         <listitem>
28354           
28355 <para>Specifies the class name</para>
28356
28357         </listitem>
28358       </varlistentry>
28359     </variablelist>
28360
28361   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28362     
28363 <para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>
28364
28365   </refsect1></refentry>
28366
28367 <refentry id="dbhtml_dir" xml:base="../html/pi.xml">
28368 <refnamediv>
28369 <refname>dbhtml_dir</refname>
28370 <refpurpose>Specifies a directory name in which to write files</refpurpose>
28371 </refnamediv>
28372 <refsynopsisdiv>
28373
28374     <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
28375   
28376 </refsynopsisdiv>
28377 <refsect1><title>Description</title>
28378     
28379 <para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI
28380       as a child of a chunk source to cause the output of that
28381       chunk to be written to the specified directory; also, use it
28382       as a child of a <tag>mediaobject</tag> to specify a
28383       directory into which any long-description files for that
28384       <tag>mediaobject</tag> will be written.</para>
28385
28386   </refsect1><refsect1><title>Parameters</title>
28387     
28388 <variablelist>
28389       <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
28390         <listitem>
28391           
28392 <para>Specifies the pathname for the directory</para>
28393
28394         </listitem>
28395       </varlistentry>
28396     </variablelist>
28397
28398   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28399     
28400 <para><parameter>base.dir</parameter></para>
28401
28402   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28403     
28404 <para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>
28405
28406   </refsect1></refentry>
28407
28408 <refentry id="dbhtml_filename" xml:base="../html/pi.xml">
28409 <refnamediv>
28410 <refname>dbhtml_filename</refname>
28411 <refpurpose>Specifies a filename for a chunk</refpurpose>
28412 </refnamediv>
28413 <refsynopsisdiv>
28414
28415     <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
28416   
28417 </refsynopsisdiv>
28418 <refsect1><title>Description</title>
28419     
28420 <para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
28421       PI as a child of a chunk source to specify a filename for
28422       the output file for that chunk.</para>
28423
28424   </refsect1><refsect1><title>Parameters</title>
28425     
28426 <variablelist>
28427       <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
28428         <listitem>
28429           
28430 <para>Specifies the filename for the file</para>
28431
28432         </listitem>
28433       </varlistentry>
28434     </variablelist>
28435
28436   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28437     
28438 <para><parameter>use.id.as.filename</parameter></para>
28439
28440   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28441     
28442 <para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>
28443
28444   </refsect1></refentry>
28445
28446 <refentry id="dbhtml_funcsynopsis-style" xml:base="../html/pi.xml">
28447 <refnamediv>
28448 <refname>dbhtml_funcsynopsis-style</refname>
28449 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
28450 </refnamediv>
28451 <refsynopsisdiv>
28452
28453     <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
28454   
28455 </refsynopsisdiv>
28456 <refsect1><title>Description</title>
28457     
28458 <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
28459       a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
28460       to control the presentation style for output of all
28461       <tag>funcprototype</tag> instances within that funcsynopsis.</para>
28462
28463   </refsect1><refsect1><title>Parameters</title>
28464     
28465 <variablelist>
28466       <varlistentry><term>funcsynopsis-style="kr"</term>
28467         <listitem>
28468           
28469 <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>
28470
28471         </listitem>
28472       </varlistentry>
28473       <varlistentry><term>funcsynopsis-style="ansi"</term>
28474         <listitem>
28475           
28476 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
28477
28478         </listitem>
28479       </varlistentry>
28480     </variablelist>
28481
28482   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28483     
28484 <para><parameter>funcsynopsis.style</parameter></para>
28485
28486   </refsect1></refentry>
28487
28488 <refentry id="dbhtml_img.src.path" xml:base="../html/pi.xml">
28489 <refnamediv>
28490 <refname>dbhtml_img.src.path</refname>
28491 <refpurpose>Specifies a path to the location of an image file</refpurpose>
28492 </refnamediv>
28493 <refsynopsisdiv>
28494
28495     <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
28496   
28497 </refsynopsisdiv>
28498 <refsect1><title>Description</title>
28499     
28500 <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
28501       after an image (<tag>graphic</tag>,
28502       <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
28503       <tag>videodata</tag> element) as a sibling to the element,
28504       to specify a path to the location of the image; in HTML
28505       output, the value specified for the
28506       <code>img.src.path</code> attribute is prepended to the
28507       filename.</para>
28508
28509   </refsect1><refsect1><title>Parameters</title>
28510     
28511 <variablelist>
28512       <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
28513         <listitem>
28514           
28515 <para>Specifies the pathname to prepend to the name of the image file</para>
28516
28517         </listitem>
28518       </varlistentry>
28519     </variablelist>
28520
28521   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28522     
28523 <para><parameter>img.src.path</parameter></para>
28524
28525   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28526     
28527 <para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>
28528
28529   </refsect1></refentry>
28530
28531 <refentry id="dbhtml_label-width" xml:base="../html/pi.xml">
28532 <refnamediv>
28533 <refname>dbhtml_label-width</refname>
28534 <refpurpose>Specifies the label width for a qandaset</refpurpose>
28535 </refnamediv>
28536 <refsynopsisdiv>
28537
28538     <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
28539   
28540 </refsynopsisdiv>
28541 <refsect1><title>Description</title>
28542     
28543 <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
28544       <tag>qandaset</tag> to specify the width of labels.</para>
28545
28546   </refsect1><refsect1><title>Parameters</title>
28547     
28548 <variablelist>
28549       <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
28550         <listitem>
28551           
28552 <para>Specifies the label width (including units)</para>
28553
28554         </listitem>
28555       </varlistentry>
28556     </variablelist>
28557
28558   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28559     
28560 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28561
28562   </refsect1></refentry>
28563
28564 <refentry id="dbhtml_linenumbering.everyNth" xml:base="../html/pi.xml">
28565 <refnamediv>
28566 <refname>dbhtml_linenumbering.everyNth</refname>
28567 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
28568 </refnamediv>
28569 <refsynopsisdiv>
28570
28571     <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
28572   
28573 </refsynopsisdiv>
28574 <refsect1><title>Description</title>
28575     
28576 <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
28577       of a &#8220;verbatim&#8221; element &#8211; <tag>programlisting</tag>,
28578       <tag>screen</tag>, <tag>synopsis</tag> &#8212; to specify
28579       the interval at which lines are numbered.</para>
28580
28581   </refsect1><refsect1><title>Parameters</title>
28582     
28583 <variablelist>
28584       <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
28585         <listitem>
28586           
28587 <para>Specifies numbering interval; a number is output
28588             before every <replaceable>N</replaceable>th line</para>
28589
28590         </listitem>
28591       </varlistentry>
28592     </variablelist>
28593
28594   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28595     
28596 <para><parameter>linenumbering.everyNth</parameter></para>
28597
28598   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28599     
28600 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28601
28602   </refsect1></refentry>
28603
28604 <refentry id="dbhtml_linenumbering.separator" xml:base="../html/pi.xml">
28605 <refnamediv>
28606 <refname>dbhtml_linenumbering.separator</refname>
28607 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
28608 </refnamediv>
28609 <refsynopsisdiv>
28610
28611     <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
28612   
28613 </refsynopsisdiv>
28614 <refsect1><title>Description</title>
28615     
28616 <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
28617       of a &#8220;verbatim&#8221; element &#8211; <tag>programlisting</tag>,
28618       <tag>screen</tag>, <tag>synopsis</tag> &#8212; to specify
28619       the separator text output between the line numbers and content.</para>
28620
28621   </refsect1><refsect1><title>Parameters</title>
28622     
28623 <variablelist>
28624       <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
28625         <listitem>
28626           
28627 <para>Specifies the text (zero or more characters)</para>
28628
28629         </listitem>
28630       </varlistentry>
28631     </variablelist>
28632
28633   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28634     
28635 <para><parameter>linenumbering.separator</parameter></para>
28636
28637   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28638     
28639 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28640
28641   </refsect1></refentry>
28642
28643 <refentry id="dbhtml_linenumbering.width" xml:base="../html/pi.xml">
28644 <refnamediv>
28645 <refname>dbhtml_linenumbering.width</refname>
28646 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
28647 </refnamediv>
28648 <refsynopsisdiv>
28649
28650     <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
28651   
28652 </refsynopsisdiv>
28653 <refsect1><title>Description</title>
28654     
28655 <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
28656       of a &#8220;verbatim&#8221; element &#8211; <tag>programlisting</tag>,
28657       <tag>screen</tag>, <tag>synopsis</tag> &#8212; to specify
28658       the width set aside for line numbers.</para>
28659
28660   </refsect1><refsect1><title>Parameters</title>
28661     
28662 <variablelist>
28663       <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
28664         <listitem>
28665           
28666 <para>Specifies the width (inluding units)</para>
28667
28668         </listitem>
28669       </varlistentry>
28670     </variablelist>
28671
28672   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28673     
28674 <para><parameter>linenumbering.width</parameter></para>
28675
28676   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28677     
28678 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28679
28680   </refsect1></refentry>
28681
28682 <refentry id="dbhtml_list-presentation" xml:base="../html/pi.xml">
28683 <refnamediv>
28684 <refname>dbhtml_list-presentation</refname>
28685 <refpurpose>Specifies presentation style for a variablelist or
28686     segmentedlist</refpurpose>
28687 </refnamediv>
28688 <refsynopsisdiv>
28689
28690     <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
28691   
28692 </refsynopsisdiv>
28693 <refsect1><title>Description</title>
28694     
28695 <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
28696       a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
28697       control the presentation style for the list (to cause it, for
28698       example, to be displayed as a table).</para>
28699
28700   </refsect1><refsect1><title>Parameters</title>
28701     
28702 <variablelist>
28703       <varlistentry><term>list-presentation="list"</term>
28704         <listitem>
28705           
28706 <para>Displays the list as a list</para>
28707
28708         </listitem>
28709       </varlistentry>
28710       <varlistentry><term>list-presentation="table"</term>
28711         <listitem>
28712           
28713 <para>Displays the list as a table</para>
28714
28715         </listitem>
28716       </varlistentry>
28717     </variablelist>
28718
28719   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28720     
28721 <itemizedlist>
28722       <listitem>
28723         
28724 <para><parameter>variablelist.as.table</parameter></para>
28725
28726       </listitem>
28727       <listitem>
28728         
28729 <para><parameter>segmentedlist.as.table</parameter></para>
28730
28731       </listitem>
28732     </itemizedlist>
28733
28734   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28735     
28736 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28737
28738   </refsect1></refentry>
28739
28740 <refentry id="dbhtml_list-width" xml:base="../html/pi.xml">
28741 <refnamediv>
28742 <refname>dbhtml_list-width</refname>
28743 <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
28744 </refnamediv>
28745 <refsynopsisdiv>
28746
28747     <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
28748   
28749 </refsynopsisdiv>
28750 <refsect1><title>Description</title>
28751     
28752 <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
28753       <tag>variablelist</tag> or a <tag>simplelist</tag> presented
28754       as a table, to specify the output width.</para>
28755
28756   </refsect1><refsect1><title>Parameters</title>
28757     
28758 <variablelist>
28759       <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
28760         <listitem>
28761           
28762 <para>Specifies the output width (including units)</para>
28763
28764         </listitem>
28765       </varlistentry>
28766     </variablelist>
28767
28768   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28769     
28770 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28771
28772   </refsect1></refentry>
28773
28774 <refentry id="dbhtml_row-height" xml:base="../html/pi.xml">
28775 <refnamediv>
28776 <refname>dbhtml_row-height</refname>
28777 <refpurpose>Specifies the height for a CALS table row</refpurpose>
28778 </refnamediv>
28779 <refsynopsisdiv>
28780
28781     <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
28782   
28783 </refsynopsisdiv>
28784 <refsect1><title>Description</title>
28785     
28786 <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
28787       <tag>row</tag> to specify the height of the row.</para>
28788
28789   </refsect1><refsect1><title>Parameters</title>
28790     
28791 <variablelist>
28792       <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
28793         <listitem>
28794           
28795 <para>Specifies the row height (including units)</para>
28796
28797         </listitem>
28798       </varlistentry>
28799     </variablelist>
28800
28801   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28802     
28803 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
28804
28805   </refsect1></refentry>
28806
28807 <refentry id="dbhtml_start" xml:base="../html/pi.xml">
28808 <refnamediv>
28809 <refname>dbhtml_start</refname>
28810 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
28811 </refnamediv>
28812 <refsynopsisdiv>
28813
28814     <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
28815   
28816 </refsynopsisdiv>
28817 <refsect1><title>Description</title>
28818     
28819 <para><emphasis>This PI is obsolete</emphasis>. The intent of
28820       this PI was to provide a means for setting a specific starting
28821       number for an ordered list. Instead of this PI, set a value
28822       for the <literal>override</literal> attribute on the first
28823       <tag>listitem</tag> in the list; that will have the same
28824       effect as what this PI was intended for.</para>
28825
28826   </refsect1><refsect1><title>Parameters</title>
28827     
28828 <variablelist>
28829       <varlistentry><term>start="<replaceable>character</replaceable>"</term>
28830         <listitem>
28831           
28832 <para>Specifies the character to use as the starting
28833             number; use 0-9, a-z, A-Z, or lowercase or uppercase
28834             Roman numerals</para>
28835
28836         </listitem>
28837       </varlistentry>
28838     </variablelist>
28839
28840   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28841     
28842 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
28843
28844   </refsect1></refentry>
28845
28846 <refentry id="dbhtml_stop-chunking" xml:base="../html/pi.xml">
28847 <refnamediv>
28848 <refname>dbhtml_stop-chunking</refname>
28849 <refpurpose>Do not chunk any descendants of this element.</refpurpose>
28850 </refnamediv>
28851 <refsynopsisdiv>
28852
28853     <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
28854   
28855 </refsynopsisdiv>
28856 <refsect1><title>Description</title>
28857     
28858 <para>When generating chunked HTML output, adding this PI as the child of an element that contains elements that would normally be generated on separate pages if generating chunked output causes chunking to stop at this point. No descendants of the current element will be split into new HTML pages:
28859 <programlisting>&lt;section&gt;
28860 &lt;title&gt;Configuring pencil&lt;/title&gt;
28861 &lt;?dbhtml stop-chunking?&gt;
28862
28863 ...
28864
28865 &lt;/section&gt;</programlisting>
28866 </para>
28867
28868   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28869     
28870 <para><link role="tcg" xlink:href="Chunking.html">Chunking into multiple HTML files</link></para>
28871
28872   </refsect1></refentry>
28873
28874 <refentry id="dbhtml_table-summary" xml:base="../html/pi.xml">
28875 <refnamediv>
28876 <refname>dbhtml_table-summary</refname>
28877 <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
28878 </refnamediv>
28879 <refsynopsisdiv>
28880
28881     <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
28882   
28883 </refsynopsisdiv>
28884 <refsect1><title>Description</title>
28885     
28886 <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
28887       a CALS <tag>table</tag>, <tag>variablelist</tag>,
28888       <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
28889       the text for the HTML <literal>summary</literal> attribute
28890       in the output HTML table.</para>
28891
28892   </refsect1><refsect1><title>Parameters</title>
28893     
28894 <variablelist>
28895       <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
28896         <listitem>
28897           
28898 <para>Specifies the summary text (zero or more characters)</para>
28899
28900         </listitem>
28901       </varlistentry>
28902     </variablelist>
28903
28904   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28905     
28906 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link>,
28907       <link role="tcg" xlink:href="TableSummary.html">Table summary text</link></para>
28908
28909   </refsect1></refentry>
28910
28911 <refentry id="dbhtml_table-width" xml:base="../html/pi.xml">
28912 <refnamediv>
28913 <refname>dbhtml_table-width</refname>
28914 <refpurpose>Specifies the width for a CALS table</refpurpose>
28915 </refnamediv>
28916 <refsynopsisdiv>
28917
28918     <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
28919   
28920 </refsynopsisdiv>
28921 <refsect1><title>Description</title>
28922     
28923 <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
28924       CALS <tag>table</tag> to specify the width of the table in
28925       output.</para>
28926
28927   </refsect1><refsect1><title>Parameters</title>
28928     
28929 <variablelist>
28930       <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
28931         <listitem>
28932           
28933 <para>Specifies the table width (including units or as a percentage)</para>
28934
28935         </listitem>
28936       </varlistentry>
28937     </variablelist>
28938
28939   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28940     
28941 <para><parameter>default.table.width</parameter></para>
28942
28943   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28944     
28945 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
28946
28947   </refsect1></refentry>
28948
28949 <refentry id="dbhtml_term-presentation" xml:base="../html/pi.xml">
28950 <refnamediv>
28951 <refname>dbhtml_term-presentation</refname>
28952 <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
28953 </refnamediv>
28954 <refsynopsisdiv>
28955
28956     <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
28957   
28958 </refsynopsisdiv>
28959 <refsect1><title>Description</title>
28960     
28961 <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
28962       of a <tag>variablelist</tag> to set character formatting for
28963       the <tag>term</tag> output of the list.</para>
28964
28965   </refsect1><refsect1><title>Parameters</title>
28966     
28967 <variablelist>
28968       <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
28969         <listitem>
28970           
28971 <para>Specifies that terms are displayed in bold</para>
28972
28973         </listitem>
28974       </varlistentry>
28975       <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
28976         <listitem>
28977           
28978 <para>Specifies that terms are displayed in italic</para>
28979
28980         </listitem>
28981       </varlistentry>
28982       <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
28983         <listitem>
28984           
28985 <para>Specifies that terms are displayed in bold-italic</para>
28986
28987         </listitem>
28988       </varlistentry>
28989     </variablelist>
28990
28991   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28992     
28993 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28994
28995   </refsect1></refentry>
28996
28997 <refentry id="dbhtml_term-separator" xml:base="../html/pi.xml">
28998 <refnamediv>
28999 <refname>dbhtml_term-separator</refname>
29000 <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
29001 </refnamediv>
29002 <refsynopsisdiv>
29003
29004     <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
29005   
29006 </refsynopsisdiv>
29007 <refsect1><title>Description</title>
29008     
29009 <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
29010       of a <tag>variablelist</tag> to specify the separator text
29011       among <tag>term</tag> instances.</para>
29012
29013   </refsect1><refsect1><title>Parameters</title>
29014     
29015 <variablelist>
29016       <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
29017         <listitem>
29018           
29019 <para>Specifies the text (zero or more characters)</para>
29020
29021         </listitem>
29022       </varlistentry>
29023     </variablelist>
29024
29025   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29026     
29027 <para><parameter>variablelist.term.separator</parameter></para>
29028
29029   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29030     
29031 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
29032
29033   </refsect1></refentry>
29034
29035 <refentry id="dbhtml_term-width" xml:base="../html/pi.xml">
29036 <refnamediv>
29037 <refname>dbhtml_term-width</refname>
29038 <refpurpose>Specifies the term width for a variablelist</refpurpose>
29039 </refnamediv>
29040 <refsynopsisdiv>
29041
29042     <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
29043   
29044 </refsynopsisdiv>
29045 <refsect1><title>Description</title>
29046     
29047 <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
29048       <tag>variablelist</tag> to specify the width for
29049       <tag>term</tag> output.</para>
29050
29051   </refsect1><refsect1><title>Parameters</title>
29052     
29053 <variablelist>
29054       <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
29055         <listitem>
29056           
29057 <para>Specifies the term width (including units)</para>
29058
29059         </listitem>
29060       </varlistentry>
29061     </variablelist>
29062
29063   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29064     
29065 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
29066
29067   </refsect1></refentry>
29068
29069 <refentry id="dbhtml_toc" xml:base="../html/pi.xml">
29070 <refnamediv>
29071 <refname>dbhtml_toc</refname>
29072 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
29073 </refnamediv>
29074 <refsynopsisdiv>
29075
29076     <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
29077   
29078 </refsynopsisdiv>
29079 <refsect1><title>Description</title>
29080     
29081 <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
29082       <tag>qandaset</tag> to specify whether a table of contents
29083       (TOC) is generated for the <tag>qandaset</tag>.</para>
29084
29085   </refsect1><refsect1><title>Parameters</title>
29086     
29087 <variablelist>
29088       <varlistentry><term>toc="0"</term>
29089         <listitem>
29090           
29091 <para>If zero, no TOC is generated</para>
29092
29093         </listitem>
29094       </varlistentry>
29095       <varlistentry><term>toc="1"</term>
29096         <listitem>
29097           
29098 <para>If <code>1</code> (or any non-zero value),
29099             a TOC is generated</para>
29100
29101         </listitem>
29102       </varlistentry>
29103     </variablelist>
29104
29105   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29106     
29107 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
29108       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
29109
29110   </refsect1></refentry>
29111
29112 <refentry id="dbcmdlist" xml:base="../html/pi.xml">
29113 <refnamediv>
29114 <refname>dbcmdlist</refname>
29115 <refpurpose>Generates a hyperlinked list of commands</refpurpose>
29116 </refnamediv>
29117 <refsynopsisdiv>
29118
29119     <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
29120   
29121 </refsynopsisdiv>
29122 <refsect1><title>Description</title>
29123     
29124 <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
29125       element (for example, <tag>refsynopsisdiv</tag>) containing multiple
29126       <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
29127       &#8220;command list&#8221; will be generated at the top of output for that
29128       element, enabling users to quickly jump
29129       to each command synopsis.</para>
29130
29131   </refsect1><refsect1><title>Parameters</title>
29132     
29133 <para>[No parameters]</para>
29134
29135   </refsect1></refentry>
29136
29137 <refentry id="dbfunclist" xml:base="../html/pi.xml">
29138 <refnamediv>
29139 <refname>dbfunclist</refname>
29140 <refpurpose>Generates a hyperlinked list of functions</refpurpose>
29141 </refnamediv>
29142 <refsynopsisdiv>
29143
29144     <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
29145   
29146 </refsynopsisdiv>
29147 <refsect1><title>Description</title>
29148     
29149 <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
29150       element (for example, <tag>refsynopsisdiv</tag>) containing multiple
29151       <tag>funcsynopsis</tag> instances; a hyperlinked
29152       navigational &#8220;function list&#8221; will be generated at the top of
29153       output for that element, enabling users to quickly
29154       jump to to each function synopsis.</para>
29155
29156   </refsect1><refsect1><title>Parameters</title>
29157     
29158 <para>[No parameters]</para>
29159
29160   </refsect1></refentry>
29161
29162 <refentry id="dbhtml-include_href" xml:base="../html/pi.xml">
29163 <refnamediv>
29164 <refname>dbhtml-include_href</refname>
29165 <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
29166 </refnamediv>
29167 <refsynopsisdiv>
29168
29169     <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
29170   
29171 </refsynopsisdiv>
29172 <refsect1><title>Description</title>
29173     
29174 <para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a
29175       document to cause the contents of the file referenced by the
29176       <code>href</code> pseudo-attribute to be copied/inserted &#8220;as
29177       is&#8221; into your HTML output at the point in document order
29178       where the PI occurs in the source.</para>
29179
29180     <note>
29181       
29182 <para>The referenced file may contain plain text (as long as
29183         it is &#8220;wrapped&#8221; in an <tag>html</tag> element &#8212; see the
29184         note below) or markup in any arbitrary vocabulary,
29185         including HTML &#8212; but it must conform to XML
29186         well-formedness constraints (because the feature in XSLT
29187         1.0 for opening external files, the
29188         <function>document()</function> function, can only handle
29189         files that meet XML well-formedness constraints).</para>
29190
29191       
29192 <para>Among other things, XML well-formedness constraints
29193         require a document to have <emphasis>a single root
29194           element</emphasis>. So if the content you want to
29195         include is plain text or is markup that does
29196         <emphasis>not</emphasis> have a single root element,
29197         <emphasis role="strong">wrap the content in an
29198           <tag>html</tag> element</emphasis>. The stylesheets will
29199         strip out that surrounding <tag>html</tag> &#8220;wrapper&#8221; when
29200         they find it, leaving just the content you want to
29201         insert.</para>
29202
29203     </note>
29204   </refsect1><refsect1><title>Parameters</title>
29205     
29206 <variablelist>
29207       <varlistentry><term>href="<replaceable>URI</replaceable>"</term>
29208         <listitem>
29209           
29210 <para>Specifies the URI for the file to include; the URI
29211             can be, for example, a remote <literal>http:</literal>
29212             URI, or a local filesystem <literal>file:</literal>
29213             URI</para>
29214
29215         </listitem>
29216       </varlistentry>
29217     </variablelist>
29218
29219   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29220     
29221 <para><parameter>textinsert.extension</parameter></para>
29222
29223   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29224     
29225 <para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,
29226       <link role="tcg" xlink:href="ExternalCode.html">External code files</link></para>
29227
29228   </refsect1></refentry>
29229
29230 <refentry id="dbhh" xml:base="../html/pi.xml">
29231 <refnamediv>
29232 <refname>dbhh</refname>
29233 <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
29234 </refnamediv>
29235 <refsynopsisdiv>
29236
29237     <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
29238   
29239 </refsynopsisdiv>
29240 <refsect1><title>Description</title>
29241     
29242 <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
29243       that should be used as targets for context-sensitive help requests.</para>
29244
29245   </refsect1><refsect1><title>Parameters</title>
29246     
29247 <variablelist>
29248       <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
29249         <listitem>
29250           
29251 <para>Specifies a unique string constant that identifies a help topic</para>
29252
29253         </listitem>
29254       </varlistentry>
29255       <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
29256         <listitem>
29257           
29258 <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
29259
29260         </listitem>
29261       </varlistentry>
29262     </variablelist>
29263
29264   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29265     
29266 <para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>
29267
29268   </refsect1></refentry>
29269
29270     </part>
29271     <part id="pi-fo">
29272       <info xml:base="../fo/pi.xml"><title>FO Processing Instruction Reference</title>
29273     <releaseinfo role="meta">
29274       $Id: pi.xsl 8487 2009-07-14 21:43:36Z bobstayton $
29275     </releaseinfo>
29276   </info>
29277
29278   <partintro id="partintro" xml:base="../fo/pi.xml">
29279     <title>Introduction</title>
29280
29281     
29282 <para>This is generated reference documentation for all
29283       user-specifiable processing instructions (PIs) in the DocBook
29284       XSL stylesheets for FO output.
29285       <note>
29286         
29287 <para>You add these PIs at particular points in a document to
29288           cause specific &#8220;exceptions&#8221; to formatting/output behavior. To
29289           make global changes in formatting/output behavior across an
29290           entire document, it&#8217;s better to do it by setting an
29291           appropriate stylesheet parameter (if there is one).</para>
29292
29293       </note>
29294     </para>
29295
29296   </partintro>
29297
29298 <refentry id="dbfo_background-color" xml:base="../fo/pi.xml">
29299 <refnamediv>
29300 <refname>dbfo_background-color</refname>
29301 <refpurpose>Sets background color for an image</refpurpose>
29302 </refnamediv>
29303 <refsynopsisdiv>
29304
29305     <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
29306   
29307 </refsynopsisdiv>
29308 <refsect1><title>Description</title>
29309     
29310 <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
29311       after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
29312       <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
29313       sibling to the element, to set a background color for the
29314       image.</para>
29315
29316   </refsect1><refsect1><title>Parameters</title>
29317     
29318 <variablelist>
29319       <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
29320         <listitem>
29321           
29322 <para>An HTML color value</para>
29323
29324         </listitem>
29325       </varlistentry>
29326     </variablelist>
29327
29328   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29329     
29330 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
29331
29332   </refsect1></refentry>
29333
29334 <refentry id="dbfo_bgcolor" xml:base="../fo/pi.xml">
29335 <refnamediv>
29336 <refname>dbfo_bgcolor</refname>
29337 <refpurpose>Sets background color on a table row or table cell</refpurpose>
29338 </refnamediv>
29339 <refsynopsisdiv>
29340
29341     <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
29342   
29343 </refsynopsisdiv>
29344 <refsect1><title>Description</title>
29345     
29346 <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
29347       or cell to set a background color for that table row or cell.</para>
29348
29349     
29350 <para>This PI works for both CALS and HTML tables.</para>
29351
29352   </refsect1><refsect1><title>Parameters</title>
29353     
29354 <variablelist>
29355       <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
29356         <listitem>
29357           
29358 <para>An HTML color value</para>
29359
29360         </listitem>
29361       </varlistentry>
29362     </variablelist>
29363
29364   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29365     
29366 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
29367
29368   </refsect1></refentry>
29369
29370 <refentry id="dbfo_float-type" xml:base="../fo/pi.xml">
29371 <refnamediv>
29372 <refname>dbfo_float-type</refname>
29373 <refpurpose>Specifies float behavior for a sidebar</refpurpose>
29374 </refnamediv>
29375 <refsynopsisdiv>
29376
29377     <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
29378   
29379 </refsynopsisdiv>
29380 <refsect1><title>Description</title>
29381     
29382 <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
29383       behavior for a <tag>sidebar</tag> (to cause the sidebar to be
29384       displayed as a marginal note).</para>
29385
29386   </refsect1><refsect1><title>Parameters</title>
29387     
29388 <variablelist>
29389       <varlistentry><term>float-type="margin.note"</term>
29390         <listitem>
29391           
29392 <para>Specifies that the <tag>sidebar</tag> should be
29393             displayed as a marginal note.</para>
29394
29395         </listitem>
29396       </varlistentry>
29397     </variablelist>
29398
29399   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29400     
29401 <para><parameter>sidebar.float.type</parameter> (parameter),
29402       <parameter>sidebar.float.width</parameter> (parameter), 
29403       <parameter>sidebar.properties</parameter> (attribute-set),
29404       <parameter>sidebar.title.properties</parameter> (attribute-set)
29405     </para>
29406
29407   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29408     
29409 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
29410         side float</link></para>
29411
29412   </refsect1></refentry>
29413
29414 <refentry id="dbfo_funcsynopsis-style" xml:base="../fo/pi.xml">
29415 <refnamediv>
29416 <refname>dbfo_funcsynopsis-style</refname>
29417 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
29418 </refnamediv>
29419 <refsynopsisdiv>
29420
29421     <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
29422   
29423 </refsynopsisdiv>
29424 <refsect1><title>Description</title>
29425     
29426 <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
29427       a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
29428       to control the presentation style for output of all
29429       <tag>funcprototype</tag> instances within that funcsynopsis.</para>
29430
29431   </refsect1><refsect1><title>Parameters</title>
29432     
29433 <variablelist>
29434       <varlistentry><term>funcsynopsis-style="kr"</term>
29435         <listitem>
29436           
29437 <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>
29438
29439         </listitem>
29440       </varlistentry>
29441       <varlistentry><term>funcsynopsis-style="ansi"</term>
29442         <listitem>
29443           
29444 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
29445
29446         </listitem>
29447       </varlistentry>
29448     </variablelist>
29449
29450   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29451     
29452 <para><parameter>funcsynopsis.style</parameter></para>
29453
29454   </refsect1></refentry>
29455
29456 <refentry id="dbfo_glossary-presentation" xml:base="../fo/pi.xml">
29457 <refnamediv>
29458 <refname>dbfo_glossary-presentation</refname>
29459 <refpurpose>Specifies presentation style for a glossary</refpurpose>
29460 </refnamediv>
29461 <refsynopsisdiv>
29462
29463     <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
29464   
29465 </refsynopsisdiv>
29466 <refsect1><title>Description</title>
29467     
29468 <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
29469       a <tag>glossary</tag> to control its presentation style.</para>
29470
29471   </refsect1><refsect1><title>Parameters</title>
29472     
29473 <variablelist>
29474       <varlistentry><term>glossary-presentation="list"</term>
29475         <listitem>
29476           
29477 <para>Displays the glossary as a list</para>
29478
29479         </listitem>
29480       </varlistentry>
29481       <varlistentry><term>glossary-presentation="blocks"</term>
29482         <listitem>
29483           
29484 <para>Displays the glossary as blocks</para>
29485
29486         </listitem>
29487       </varlistentry>
29488     </variablelist>
29489
29490   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29491     
29492 <para><parameter>glossary.as.blocks</parameter></para>
29493
29494   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29495     
29496 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29497         formatting in print</link></para>
29498
29499   </refsect1></refentry>
29500
29501 <refentry id="dbfo_glosslist-presentation" xml:base="../fo/pi.xml">
29502 <refnamediv>
29503 <refname>dbfo_glosslist-presentation</refname>
29504 <refpurpose>Specifies presentation style for a glosslist</refpurpose>
29505 </refnamediv>
29506 <refsynopsisdiv>
29507
29508     <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
29509   
29510 </refsynopsisdiv>
29511 <refsect1><title>Description</title>
29512     
29513 <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
29514       a <tag>glosslist</tag> to control its presentation style.</para>
29515
29516   </refsect1><refsect1><title>Parameters</title>
29517     
29518 <variablelist>
29519       <varlistentry><term>glosslist-presentation="list"</term>
29520         <listitem>
29521           
29522 <para>Displays the glosslist as a list</para>
29523
29524         </listitem>
29525       </varlistentry>
29526       <varlistentry><term>glosslist-presentation="blocks"</term>
29527         <listitem>
29528           
29529 <para>Displays the glosslist as blocks</para>
29530
29531         </listitem>
29532       </varlistentry>
29533     </variablelist>
29534
29535   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29536     
29537 <para><parameter>glosslist.as.blocks</parameter> </para>
29538
29539   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29540     
29541 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29542         formatting in print</link></para>
29543
29544   </refsect1></refentry>
29545
29546 <refentry id="dbfo_glossterm-width" xml:base="../fo/pi.xml">
29547 <refnamediv>
29548 <refname>dbfo_glossterm-width</refname>
29549 <refpurpose>Specifies the glossterm width for a glossary or
29550     glosslist</refpurpose>
29551 </refnamediv>
29552 <refsynopsisdiv>
29553
29554     <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
29555   
29556 </refsynopsisdiv>
29557 <refsect1><title>Description</title>
29558     
29559 <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
29560       <tag>glossary</tag> or <tag>glosslist</tag> to specify the
29561       width for output of <tag>glossterm</tag> instances in the
29562       output.</para>
29563
29564   </refsect1><refsect1><title>Parameters</title>
29565     
29566 <variablelist>
29567       <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
29568         <listitem>
29569           
29570 <para>Specifies the glossterm width (including units)</para>
29571
29572         </listitem>
29573       </varlistentry>
29574     </variablelist>
29575
29576   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29577     
29578 <para><parameter>glossterm.width</parameter>,
29579       <parameter>glossterm.separation</parameter>
29580     </para>
29581
29582   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29583     
29584 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29585         formatting in print</link></para>
29586
29587   </refsect1></refentry>
29588
29589 <refentry id="dbfo_keep-together" xml:base="../fo/pi.xml">
29590 <refnamediv>
29591 <refname>dbfo_keep-together</refname>
29592 <refpurpose>Specifies &#8220;keep&#8221; behavior for a table, example,
29593     figure, equation, procedure, or task</refpurpose>
29594 </refnamediv>
29595 <refsynopsisdiv>
29596
29597     <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
29598   
29599 </refsynopsisdiv>
29600 <refsect1><title>Description</title>
29601     
29602 <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
29603       formal object (<tag>table</tag>, <tag>example</tag>,
29604       <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
29605       <tag>task</tag>) to specify &#8220;keep&#8221; behavior (to allow the object to 
29606     &#8220;break&#8221; across a page).</para>
29607
29608     
29609 <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
29610       <tag>informalfigure</tag> and <tag>informalequation</tag>.
29611     </para>
29612
29613
29614   </refsect1><refsect1><title>Parameters</title>
29615     
29616 <variablelist>
29617       <varlistentry><term>keep-together="auto"</term>
29618         <listitem>
29619           
29620 <para>Enables the object to break across a page</para>
29621
29622         </listitem>
29623       </varlistentry>
29624       <varlistentry><term>keep-together="always"</term>
29625         <listitem>
29626           
29627 <para>Prevents the object from breaking across a page (the
29628             default stylesheet behavior)</para>
29629
29630         </listitem>
29631       </varlistentry>
29632     </variablelist>
29633
29634   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29635     
29636 <para>formal.object.properties</para>
29637
29638   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29639     
29640 <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
29641
29642   </refsect1></refentry>
29643
29644 <refentry id="dbfo_label-width" xml:base="../fo/pi.xml">
29645 <refnamediv>
29646 <refname>dbfo_label-width</refname>
29647 <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
29648   or calloutlist</refpurpose>
29649 </refnamediv>
29650 <refsynopsisdiv>
29651
29652     <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
29653   
29654 </refsynopsisdiv>
29655 <refsect1><title>Description</title>
29656     
29657 <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
29658       <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>, 
29659       or <tag>calloutlist</tag> to specify the width of labels.</para>
29660
29661   </refsect1><refsect1><title>Parameters</title>
29662     
29663 <variablelist>
29664       <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
29665         <listitem>
29666           
29667 <para>Specifies the label width (including units)</para>
29668
29669         </listitem>
29670       </varlistentry>
29671     </variablelist>
29672
29673   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29674     
29675 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
29676
29677   </refsect1></refentry>
29678
29679 <refentry id="dbfo_linenumbering.everyNth" xml:base="../fo/pi.xml">
29680 <refnamediv>
29681 <refname>dbfo_linenumbering.everyNth</refname>
29682 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
29683 </refnamediv>
29684 <refsynopsisdiv>
29685
29686     <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
29687   
29688 </refsynopsisdiv>
29689 <refsect1><title>Description</title>
29690     
29691 <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
29692       of a &#8220;verbatim&#8221; element &#8211; <tag>programlisting</tag>,
29693       <tag>screen</tag>, <tag>synopsis</tag> &#8212; to specify
29694       the interval at which lines are numbered.</para>
29695
29696   </refsect1><refsect1><title>Parameters</title>
29697     
29698 <variablelist>
29699       <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
29700         <listitem>
29701           
29702 <para>Specifies numbering interval; a number is output
29703             before every <replaceable>N</replaceable>th line</para>
29704
29705         </listitem>
29706       </varlistentry>
29707     </variablelist>
29708
29709   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29710     
29711 <para><parameter>linenumbering.everyNth</parameter></para>
29712
29713   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29714     
29715 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29716
29717   </refsect1></refentry>
29718
29719 <refentry id="dbfo_linenumbering.separator" xml:base="../fo/pi.xml">
29720 <refnamediv>
29721 <refname>dbfo_linenumbering.separator</refname>
29722 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
29723 </refnamediv>
29724 <refsynopsisdiv>
29725
29726     <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
29727   
29728 </refsynopsisdiv>
29729 <refsect1><title>Description</title>
29730     
29731 <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
29732       of a &#8220;verbatim&#8221; element &#8211; <tag>programlisting</tag>,
29733       <tag>screen</tag>, <tag>synopsis</tag> &#8212; to specify
29734       the separator text output between the line numbers and content.</para>
29735
29736   </refsect1><refsect1><title>Parameters</title>
29737     
29738 <variablelist>
29739       <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
29740         <listitem>
29741           
29742 <para>Specifies the text (zero or more characters)</para>
29743
29744         </listitem>
29745       </varlistentry>
29746     </variablelist>
29747
29748   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29749     
29750 <para><parameter>linenumbering.separator</parameter></para>
29751
29752   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29753     
29754 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29755
29756   </refsect1></refentry>
29757
29758 <refentry id="dbfo_linenumbering.width" xml:base="../fo/pi.xml">
29759 <refnamediv>
29760 <refname>dbfo_linenumbering.width</refname>
29761 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
29762 </refnamediv>
29763 <refsynopsisdiv>
29764
29765     <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
29766   
29767 </refsynopsisdiv>
29768 <refsect1><title>Description</title>
29769     
29770 <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
29771       of a &#8220;verbatim&#8221; element &#8211; <tag>programlisting</tag>,
29772       <tag>screen</tag>, <tag>synopsis</tag> &#8212; to specify
29773       the width set aside for line numbers.</para>
29774
29775   </refsect1><refsect1><title>Parameters</title>
29776     
29777 <variablelist>
29778       <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
29779         <listitem>
29780           
29781 <para>Specifies the width (inluding units)</para>
29782
29783         </listitem>
29784       </varlistentry>
29785     </variablelist>
29786
29787   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29788     
29789 <para><parameter>linenumbering.width</parameter></para>
29790
29791   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29792     
29793 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29794
29795   </refsect1></refentry>
29796
29797 <refentry id="dbfo_list-presentation" xml:base="../fo/pi.xml">
29798 <refnamediv>
29799 <refname>dbfo_list-presentation</refname>
29800 <refpurpose>Specifies presentation style for a variablelist or
29801     segmentedlist</refpurpose>
29802 </refnamediv>
29803 <refsynopsisdiv>
29804
29805     <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
29806   
29807 </refsynopsisdiv>
29808 <refsect1><title>Description</title>
29809     
29810 <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
29811       a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
29812       control the presentation style for the list (to cause it, for
29813       example, to be displayed as a table).</para>
29814
29815   </refsect1><refsect1><title>Parameters</title>
29816     
29817 <variablelist>
29818       <varlistentry><term>list-presentation="list"</term>
29819         <listitem>
29820           
29821 <para>Displays the list as a list</para>
29822
29823         </listitem>
29824       </varlistentry>
29825       <varlistentry><term>list-presentation="blocks"</term>
29826         <listitem>
29827           
29828 <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
29829
29830         </listitem>
29831       </varlistentry>
29832       <varlistentry><term>list-presentation="table"</term>
29833         <listitem>
29834           
29835 <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
29836
29837         </listitem>
29838       </varlistentry>
29839     </variablelist>
29840
29841   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29842     
29843 <itemizedlist>
29844       <listitem>
29845         
29846 <para><parameter>variablelist.as.blocks</parameter></para>
29847
29848       </listitem>
29849       <listitem>
29850         
29851 <para><parameter>variablelist.as.table</parameter></para>
29852
29853       </listitem>
29854     </itemizedlist>
29855
29856   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29857     
29858 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
29859
29860   </refsect1></refentry>
29861
29862 <refentry id="dbfo_list-width" xml:base="../fo/pi.xml">
29863 <refnamediv>
29864 <refname>dbfo_list-width</refname>
29865 <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
29866 </refnamediv>
29867 <refsynopsisdiv>
29868
29869     <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
29870   
29871 </refsynopsisdiv>
29872 <refsect1><title>Description</title>
29873     
29874 <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
29875       <tag>simplelist</tag> whose <tag class="attribute">class</tag>
29876       value is <literal>horizontal</literal>, to specify the width
29877       of the <tag>simplelist</tag>.</para>
29878
29879   </refsect1><refsect1><title>Parameters</title>
29880     
29881 <variablelist>
29882       <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
29883         <listitem>
29884           
29885 <para>Specifies the <tag>simplelist</tag> width (including units)</para>
29886
29887         </listitem>
29888       </varlistentry>
29889     </variablelist>
29890
29891   </refsect1></refentry>
29892
29893 <refentry id="dbfo_orientation" xml:base="../fo/pi.xml">
29894 <refnamediv>
29895 <refname>dbfo_orientation</refname>
29896 <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
29897 </refnamediv>
29898 <refsynopsisdiv>
29899
29900     <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
29901   
29902 </refsynopsisdiv>
29903 <refsect1><title>Description</title>
29904     
29905 <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
29906       <tag>table</tag> row or cell to specify the orientation
29907       (rotation) for the row or cell.</para>
29908
29909   </refsect1><refsect1><title>Parameters</title>
29910     
29911 <variablelist>
29912       <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
29913         <listitem>
29914           
29915 <para>Specifies the number of degrees by which the cell or
29916             row is rotated</para>
29917
29918         </listitem>
29919       </varlistentry>
29920     </variablelist>
29921
29922   </refsect1></refentry>
29923
29924 <refentry id="dbfo_pgwide" xml:base="../fo/pi.xml">
29925 <refnamediv>
29926 <refname>dbfo_pgwide</refname>
29927 <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
29928 </refnamediv>
29929 <refsynopsisdiv>
29930
29931     <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
29932   
29933 </refsynopsisdiv>
29934 <refsect1><title>Description</title>
29935     
29936 <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
29937       <tag>equation</tag> or <tag>example</tag> to specify that the
29938       content should rendered across the full width of the page.</para>
29939
29940   </refsect1><refsect1><title>Parameters</title>
29941     
29942 <variablelist>
29943       <varlistentry><term>pgwide="0"</term>
29944         <listitem>
29945           
29946 <para>If zero, the content is rendered across the current
29947             text flow</para>
29948
29949         </listitem>
29950       </varlistentry>
29951       <varlistentry><term>pgwide="1"</term>
29952         <listitem>
29953           
29954 <para>If <code>1</code> (or any non-zero value), the
29955             content is rendered across the full width of the page</para>
29956
29957         </listitem>
29958       </varlistentry>
29959     </variablelist>
29960
29961   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29962     
29963 <para><parameter>pgwide.properties</parameter></para>
29964
29965   </refsect1></refentry>
29966
29967 <refentry id="dbfo_rotated-width" xml:base="../fo/pi.xml">
29968 <refnamediv>
29969 <refname>dbfo_rotated-width</refname>
29970 <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
29971     <tag>row</tag></refpurpose>
29972 </refnamediv>
29973 <refsynopsisdiv>
29974
29975     <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
29976   
29977 </refsynopsisdiv>
29978 <refsect1><title>Description</title>
29979     
29980 <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of 
29981       <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
29982       width of that the <tag>entry</tag> or <tag>row</tag>; or
29983       use it higher up in table to cause the width to be inherited
29984       recursively down.</para>
29985
29986   </refsect1><refsect1><title>Parameters</title>
29987     
29988 <variablelist>
29989       <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
29990         <listitem>
29991           
29992 <para>Specifies the width of a row or cell (including units)</para>
29993
29994         </listitem>
29995       </varlistentry>
29996     </variablelist>
29997
29998   </refsect1></refentry>
29999
30000 <refentry id="dbfo_sidebar-width" xml:base="../fo/pi.xml">
30001 <refnamediv>
30002 <refname>dbfo_sidebar-width</refname>
30003 <refpurpose>Specifies the width of a sidebar</refpurpose>
30004 </refnamediv>
30005 <refsynopsisdiv>
30006
30007     <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
30008   
30009 </refsynopsisdiv>
30010 <refsect1><title>Description</title>
30011     
30012 <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
30013       <tag>sidebar</tag> to specify the width of the sidebar.</para>
30014
30015   </refsect1><refsect1><title>Parameters</title>
30016     
30017 <variablelist>
30018       <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
30019         <listitem>
30020           
30021 <para>Specifies the <tag>sidebar</tag> width (including units)</para>
30022
30023         </listitem>
30024       </varlistentry>
30025     </variablelist>
30026
30027   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30028     
30029 <para><parameter>sidebar.float.type parameter</parameter>,
30030       <parameter>sidebar.float.width parameter</parameter>, 
30031       <parameter>sidebar.properties attribute-set</parameter>,
30032       <parameter>sidebar.title.properties</parameter>
30033     </para>
30034
30035   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30036     
30037 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
30038         side float</link></para>
30039
30040   </refsect1></refentry>
30041
30042 <refentry id="dbfo_start" xml:base="../fo/pi.xml">
30043 <refnamediv>
30044 <refname>dbfo_start</refname>
30045 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
30046 </refnamediv>
30047 <refsynopsisdiv>
30048
30049     <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
30050   
30051 </refsynopsisdiv>
30052 <refsect1><title>Description</title>
30053     
30054 <para><emphasis>This PI is obsolete</emphasis>. The intent of
30055       it was to provide a means for setting a specific starting
30056       number for an ordered list. Instead of this PI, set a value
30057       for the <literal>override</literal> attribute on the first
30058       <tag>listitem</tag> in the list; that will have the same
30059       effect as what this PI was intended for.</para>
30060
30061   </refsect1><refsect1><title>Parameters</title>
30062     
30063 <variablelist>
30064       <varlistentry><term>start="<replaceable>character</replaceable>"</term>
30065         <listitem>
30066           
30067 <para>Specifies the character to use as the starting
30068             number; use 0-9, a-z, A-Z, or lowercase or uppercase
30069             Roman numerals</para>
30070
30071         </listitem>
30072       </varlistentry>
30073     </variablelist>
30074
30075   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30076     
30077 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
30078
30079   </refsect1></refentry>
30080
30081 <refentry id="dbfo_table-width" xml:base="../fo/pi.xml">
30082 <refnamediv>
30083 <refname>dbfo_table-width</refname>
30084 <refpurpose>Specifies the width for a CALS table or for revhistory
30085     output</refpurpose>
30086 </refnamediv>
30087 <refsynopsisdiv>
30088
30089     <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
30090   
30091 </refsynopsisdiv>
30092 <refsect1><title>Description</title>
30093     
30094 <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
30095       sibling of a CALS <tag>table</tag>, or as a child of an
30096       <tag>informaltable</tag>, <tag>entrytbl</tag>, or
30097       <tag>revhistory</tag> instance (which is rendered as a table
30098       in output) to specify the width of the table in output.</para>
30099
30100   </refsect1><refsect1><title>Parameters</title>
30101     
30102 <variablelist>
30103       <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
30104         <listitem>
30105           
30106 <para>Specifies the table width (including units or as a percentage)</para>
30107
30108         </listitem>
30109       </varlistentry>
30110     </variablelist>
30111
30112   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30113     
30114 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
30115
30116   </refsect1></refentry>
30117
30118 <refentry id="dbfo_term-width" xml:base="../fo/pi.xml">
30119 <refnamediv>
30120 <refname>dbfo_term-width</refname>
30121 <refpurpose>Specifies the term width for a variablelist</refpurpose>
30122 </refnamediv>
30123 <refsynopsisdiv>
30124
30125     <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
30126   
30127 </refsynopsisdiv>
30128 <refsect1><title>Description</title>
30129     
30130 <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
30131       <tag>variablelist</tag> to specify the width for
30132       <tag>term</tag> output.</para>
30133
30134   </refsect1><refsect1><title>Parameters</title>
30135     
30136 <variablelist>
30137       <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
30138         <listitem>
30139           
30140 <para>Specifies the term width (including units)</para>
30141
30142         </listitem>
30143       </varlistentry>
30144     </variablelist>
30145
30146   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30147     
30148 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
30149
30150   </refsect1></refentry>
30151
30152 <refentry id="dbfo_toc" xml:base="../fo/pi.xml">
30153 <refnamediv>
30154 <refname>dbfo_toc</refname>
30155 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
30156 </refnamediv>
30157 <refsynopsisdiv>
30158
30159     <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
30160   
30161 </refsynopsisdiv>
30162 <refsect1><title>Description</title>
30163     
30164 <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
30165       <tag>qandaset</tag> to specify whether a table of contents
30166       (TOC) is generated for the <tag>qandaset</tag>.</para>
30167
30168   </refsect1><refsect1><title>Parameters</title>
30169     
30170 <variablelist>
30171       <varlistentry><term>toc="0"</term>
30172         <listitem>
30173           
30174 <para>If zero, no TOC is generated</para>
30175
30176         </listitem>
30177       </varlistentry>
30178       <varlistentry><term>toc="1"</term>
30179         <listitem>
30180           
30181 <para>If <code>1</code> (or any non-zero value),
30182             a TOC is generated</para>
30183
30184         </listitem>
30185       </varlistentry>
30186     </variablelist>
30187
30188   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30189     
30190 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
30191       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
30192
30193   </refsect1></refentry>
30194
30195 <refentry id="dbfo-need" xml:base="../fo/pi.xml">
30196 <refnamediv>
30197 <refname>dbfo-need</refname>
30198 <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
30199 </refnamediv>
30200 <refsynopsisdiv>
30201
30202     <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
30203   
30204 </refsynopsisdiv>
30205 <refsect1><title>Description</title>
30206     
30207 <para>A &#8220;need&#8221; is a request for space on a page.  If the
30208       requested space is not available, the page breaks and the
30209       content that follows the need request appears on the next
30210       page. If the requested space is available, then no page break
30211       is inserted.</para>
30212
30213   </refsect1><refsect1><title>Parameters</title>
30214     
30215 <variablelist>
30216       <varlistentry><term>height="<replaceable>n</replaceable>"</term>
30217         <listitem>
30218           
30219 <para>The amount of height needed (including units)</para>
30220
30221         </listitem>
30222       </varlistentry>
30223       <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
30224         <listitem>
30225           
30226 <para>The amount of extra vertical space to add (including units)</para>
30227
30228         </listitem>
30229       </varlistentry>
30230     </variablelist>
30231
30232   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30233     
30234 <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
30235
30236   </refsect1></refentry>
30237
30238 <refentry id="dbfo_row-height" xml:base="../fo/pi.xml">
30239 <refnamediv>
30240 <refname>dbfo_row-height</refname>
30241 <refpurpose>Specifies the height for a CALS table row</refpurpose>
30242 </refnamediv>
30243 <refsynopsisdiv>
30244
30245     <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
30246   
30247 </refsynopsisdiv>
30248 <refsect1><title>Description</title>
30249     
30250 <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
30251       <tag>row</tag> to specify the height of the row.</para>
30252
30253   </refsect1><refsect1><title>Parameters</title>
30254     
30255 <variablelist>
30256       <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
30257         <listitem>
30258           
30259 <para>Specifies the row height (including units)</para>
30260
30261         </listitem>
30262       </varlistentry>
30263     </variablelist>
30264
30265   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30266     
30267 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
30268
30269   </refsect1></refentry>
30270
30271     </part>
30272     <part id="pi-man">
30273       <info xml:base="../manpages/pi.xml"><title>manpages Processing Instruction Reference</title>
30274     <releaseinfo role="meta">
30275       $Id: pi.xsl 7644 2008-01-16 11:04:07Z xmldoc $
30276     </releaseinfo>
30277   </info>
30278   <partintro id="partintro" xml:base="../manpages/pi.xml">
30279     <title>Introduction</title>
30280     
30281 <para>This is generated reference documentation for all
30282       user-specifiable processing instructions (PIs) in the DocBook
30283       XSL stylesheets for manpages output.
30284       <note>
30285         
30286 <para>You add these PIs at particular points in a document to
30287           cause specific &#8220;exceptions&#8221; to formatting/output behavior. To
30288           make global changes in formatting/output behavior across an
30289           entire document, it&#8217;s better to do it by setting an
30290           appropriate stylesheet parameter (if there is one).</para>
30291
30292       </note>
30293     </para>
30294
30295   </partintro>
30296
30297 <refentry id="dbman_funcsynopsis-style" xml:base="../manpages/pi.xml">
30298 <refnamediv>
30299 <refname>dbman_funcsynopsis-style</refname>
30300 <refpurpose>Specifies presentation style for a funcsynopsis.</refpurpose>
30301 </refnamediv>
30302 <refsynopsisdiv>
30303
30304     <synopsis><tag class="xmlpi">dbman funcsynopsis-style="kr"|"ansi"</tag></synopsis>
30305   
30306 </refsynopsisdiv>
30307 <refsect1><title>Description</title>
30308     
30309 <para>Use the <tag class="xmlpi">dbman
30310         funcsynopsis-style</tag> PI as a child of a
30311       <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
30312       to control the presentation style for output of all
30313       <tag>funcprototype</tag> instances within that funcsynopsis.</para>
30314
30315   </refsect1><refsect1><title>Parameters</title>
30316     
30317 <variablelist>
30318       <varlistentry><term>funcsynopsis-style="kr"</term>
30319         <listitem>
30320           
30321 <para>Displays the <tag>funcprototype</tag> in K&amp;R style</para>
30322
30323         </listitem>
30324       </varlistentry>
30325       <varlistentry><term>funcsynopsis-style="ansi"</term>
30326         <listitem>
30327           
30328 <para>Displays the <tag>funcprototype</tag> in ANSI style</para>
30329
30330         </listitem>
30331       </varlistentry>
30332     </variablelist>
30333
30334   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30335     
30336 <para><parameter>man.funcsynopsis.style</parameter></para>
30337
30338   </refsect1></refentry>
30339
30340     </part>
30341     <part id="pi-common">
30342       <info xml:base="../common/pi.xml"><title>Common Processing Instruction Reference</title>
30343     <releaseinfo role="meta">
30344       $Id: pi.xsl 8782 2010-07-27 21:15:17Z mzjn $
30345     </releaseinfo>
30346   </info>
30347   <partintro id="partintro" xml:base="../common/pi.xml">
30348     <title>Introduction</title>
30349     
30350 <para>This is generated reference documentation for all
30351       user-specifiable processing instructions (PIs) in the
30352       &#8220;common&#8221; part of the DocBook XSL stylesheets.
30353       <note>
30354         
30355 <para>You add these PIs at particular points in a document to
30356           cause specific &#8220;exceptions&#8221; to formatting/output behavior. To
30357           make global changes in formatting/output behavior across an
30358           entire document, it&#8217;s better to do it by setting an
30359           appropriate stylesheet parameter (if there is one).</para>
30360
30361       </note>
30362     </para>
30363
30364   </partintro>
30365
30366 <refentry id="dbchoice_choice" xml:base="../common/pi.xml">
30367 <refnamediv>
30368 <refname>dbchoice_choice</refname>
30369 <refpurpose>Generates a localized choice separator</refpurpose>
30370 </refnamediv>
30371 <refsynopsisdiv>
30372
30373     <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
30374   
30375 </refsynopsisdiv>
30376 <refsect1><title>Description</title>
30377     
30378 <para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
30379       generate an appropriate localized &#8220;choice&#8221; separator (for
30380       example, <literal>and</literal> or <literal>or</literal>)
30381       before the final item in an inline <tag>simplelist</tag></para>
30382
30383     <warning>
30384       
30385 <para>This PI is a less-than-ideal hack; support for it may
30386         disappear in the future (particularly if and when a more
30387         appropriate means for marking up "choice" lists becomes
30388         available in DocBook).</para>
30389
30390     </warning>
30391   </refsect1><refsect1><title>Parameters</title>
30392     
30393 <variablelist>
30394       <varlistentry><term>choice="and"</term>
30395         <listitem>
30396           
30397 <para>generates a localized <literal>and</literal> separator</para>
30398
30399         </listitem>
30400       </varlistentry>
30401       <varlistentry><term>choice="or"</term>
30402         <listitem>
30403           
30404 <para>generates a localized <literal>or</literal> separator</para>
30405
30406         </listitem>
30407       </varlistentry>
30408       <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
30409         <listitem>
30410           
30411 <para>generates a literal <replaceable>string</replaceable> separator</para>
30412
30413         </listitem>
30414       </varlistentry>
30415     </variablelist>
30416
30417   </refsect1></refentry>
30418
30419 <refentry id="dbtimestamp" xml:base="../common/pi.xml">
30420 <refnamediv>
30421 <refname>dbtimestamp</refname>
30422 <refpurpose>Inserts a date timestamp</refpurpose>
30423 </refnamediv>
30424 <refsynopsisdiv>
30425
30426     <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
30427   
30428 </refsynopsisdiv>
30429 <refsect1><title>Description</title>
30430     
30431 <para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
30432       source document to cause a date timestamp (a formatted
30433       string representing the current date and time) to be
30434       inserted in output of the document.</para>
30435
30436   </refsect1><refsect1><title>Parameters</title>
30437     
30438 <variablelist>
30439       <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
30440         <listitem>
30441           
30442 <para>Specifies format in which the date and time are
30443             output</para>
30444
30445         <note>
30446           
30447 <para>For details of the content of the format string,
30448             see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
30449
30450         </note>
30451         </listitem>
30452       </varlistentry>
30453       <varlistentry><term>padding="0"|"1"</term>
30454         <listitem>
30455           
30456 <para>Specifies padding behavior; if non-zero, padding is is added</para>
30457
30458         </listitem>
30459       </varlistentry>
30460     </variablelist>
30461
30462   </refsect1></refentry>
30463
30464 <refentry id="dbtex_delims" xml:base="../common/pi.xml">
30465 <refnamediv>
30466 <refname>dbtex_delims</refname>
30467 <refpurpose>Generates delimiters around embedded TeX equations
30468     in output</refpurpose>
30469 </refnamediv>
30470 <refsynopsisdiv>
30471
30472     <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
30473   
30474 </refsynopsisdiv>
30475 <refsect1><title>Description</title>
30476     
30477 <para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
30478       child of a <tag>textobject</tag> containing embedded TeX
30479       markup, to cause that markup to be surrounded by
30480       <literal>$</literal> delimiter characters in output.</para>
30481
30482       <warning>
30483        
30484 <para>This feature is useful for print/PDF output only if you
30485        use the obsolete and now unsupported PassiveTeX XSL-FO
30486        engine.</para>
30487
30488       </warning>
30489   </refsect1><refsect1><title>Parameters</title>
30490     
30491 <variablelist>
30492       <varlistentry><term>dbtex delims="no"|"yes"</term>
30493         <listitem>
30494           
30495 <para>Specifies whether delimiters are output</para>
30496
30497         </listitem>
30498       </varlistentry>
30499     </variablelist>
30500
30501   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30502     
30503 <para><parameter>tex.math.delims</parameter></para>
30504
30505   </refsect1></refentry>
30506
30507     </part>
30508   </book>
30509   <book id="developer"><title>DocBook XSL Stylesheets Developer&#160;Reference</title>
30510     <info>
30511       <abstract>
30512         <para>This is technical reference documentation for
30513           developers using the DocBook XSL Stylesheets. It is not
30514           intended to be user documentation, but is instead
30515           provided for developers writing customization layers for
30516           the stylesheets.</para>
30517       </abstract>
30518     </info>
30519     <part id="lib">
30520       <?dbhtml dir="lib"?>
30521       <?dbhtml filename="index.html"?>
30522       <title xml:base="../lib/lib.xml">XSL Library Template Reference</title>
30523       <partintro id="libintro">
30524         <title xml:base="../lib/lib.xml">Introduction</title>
30525       <para xml:base="../lib/lib.xml">This is technical reference documentation for the
30526         vocabulary-independent &#8220;library&#8221; templates in the DocBook XSL
30527         Stylesheets.</para>
30528       <para xml:base="../lib/lib.xml">This is not intended to be user documentation.  It is
30529         provided for developers writing customization layers for the
30530         stylesheets.</para>
30531     
30532       </partintro>
30533       <reference id="generallibrary" xml:base="../lib/lib.xml">
30534     <title>General Library Templates</title>
30535
30536 <refentry id="dot.count">
30537 <refnamediv>
30538 <refname>dot.count</refname>
30539 <refpurpose>Returns the number of <quote>.</quote> characters in a string</refpurpose>
30540 </refnamediv>
30541
30542 <refsect1><title>Description</title>
30543
30544   <para>Given a string, the <function>dot.count</function>
30545     template returns the number of dot/period characters in the
30546     string. This template is useful, for example, when testing the
30547     nesting level of nested inline markup (for nested emphasis,
30548     quotations, etc.).</para>
30549
30550 <programlisting id="dot.count.frag">
30551 &lt;xsl:template name="dot.count"&gt;
30552   &lt;!-- Returns the number of "." characters in a string --&gt;
30553   &lt;xsl:param name="string"&gt;&lt;/xsl:param&gt;
30554   &lt;xsl:param name="count" select="0"&gt;&lt;/xsl:param&gt;
30555   &lt;xsl:choose&gt;
30556     &lt;xsl:when test="contains($string, '.')"&gt;
30557       &lt;xsl:call-template name="dot.count"&gt;
30558         &lt;xsl:with-param name="string" select="substring-after($string, '.')"&gt;&lt;/xsl:with-param&gt;
30559         &lt;xsl:with-param name="count" select="$count+1"&gt;&lt;/xsl:with-param&gt;
30560       &lt;/xsl:call-template&gt;
30561     &lt;/xsl:when&gt;
30562     &lt;xsl:otherwise&gt;
30563       &lt;xsl:value-of select="$count"&gt;&lt;/xsl:value-of&gt;
30564     &lt;/xsl:otherwise&gt;
30565   &lt;/xsl:choose&gt;
30566 &lt;/xsl:template&gt;
30567 </programlisting>
30568
30569 </refsect1>
30570 </refentry>
30571
30572
30573
30574 <refentry id="copy-string">
30575 <refnamediv>
30576 <refname>copy-string</refname>
30577 <refpurpose>Returns <quote>count</quote> copies of a string</refpurpose>
30578 </refnamediv>
30579
30580 <refsect1><title>Description</title>
30581
30582   <para>Given a string, the <function>copy-string</function>
30583     template creates <replaceable>n</replaceable> copies of the
30584     string, when the value of <replaceable>n</replaceable> is
30585     given by the <parameter>count</parameter> parameter.</para>
30586
30587 <programlisting id="copy-string.frag">
30588 &lt;xsl:template name="copy-string"&gt;
30589   &lt;!-- returns 'count' copies of 'string' --&gt;
30590   &lt;xsl:param name="string"&gt;&lt;/xsl:param&gt;
30591   &lt;xsl:param name="count" select="0"&gt;&lt;/xsl:param&gt;
30592   &lt;xsl:param name="result"&gt;&lt;/xsl:param&gt;
30593
30594   &lt;xsl:choose&gt;
30595     &lt;xsl:when test="$count&gt;0"&gt;
30596       &lt;xsl:call-template name="copy-string"&gt;
30597         &lt;xsl:with-param name="string" select="$string"&gt;&lt;/xsl:with-param&gt;
30598         &lt;xsl:with-param name="count" select="$count - 1"&gt;&lt;/xsl:with-param&gt;
30599         &lt;xsl:with-param name="result"&gt;
30600           &lt;xsl:value-of select="$result"&gt;&lt;/xsl:value-of&gt;
30601           &lt;xsl:value-of select="$string"&gt;&lt;/xsl:value-of&gt;
30602         &lt;/xsl:with-param&gt;
30603       &lt;/xsl:call-template&gt;
30604     &lt;/xsl:when&gt;
30605     &lt;xsl:otherwise&gt;
30606       &lt;xsl:value-of select="$result"&gt;&lt;/xsl:value-of&gt;
30607     &lt;/xsl:otherwise&gt;
30608   &lt;/xsl:choose&gt;
30609 &lt;/xsl:template&gt;
30610 </programlisting>
30611
30612 </refsect1>
30613 </refentry>
30614
30615
30616
30617 <refentry id="string.subst">
30618 <refnamediv>
30619 <refname>string.subst</refname>
30620 <refpurpose>Substitute one text string for another in a string</refpurpose>
30621 </refnamediv>
30622
30623 <refsect1><title>Description</title>
30624
30625 <para>The <function>string.subst</function> template replaces all
30626 occurances of <parameter>target</parameter> in <parameter>string</parameter>
30627 with <parameter>replacement</parameter> and returns the result.
30628 </para>
30629
30630 <programlisting id="string.subst.frag">
30631 &lt;xsl:template name="string.subst"&gt;
30632   &lt;xsl:param name="string"&gt;&lt;/xsl:param&gt;
30633   &lt;xsl:param name="target"&gt;&lt;/xsl:param&gt;
30634   &lt;xsl:param name="replacement"&gt;&lt;/xsl:param&gt;
30635
30636   &lt;xsl:choose&gt;
30637     &lt;xsl:when test="contains($string, $target)"&gt;
30638       &lt;xsl:variable name="rest"&gt;
30639         &lt;xsl:call-template name="string.subst"&gt;
30640           &lt;xsl:with-param name="string" select="substring-after($string, $target)"&gt;&lt;/xsl:with-param&gt;
30641           &lt;xsl:with-param name="target" select="$target"&gt;&lt;/xsl:with-param&gt;
30642           &lt;xsl:with-param name="replacement" select="$replacement"&gt;&lt;/xsl:with-param&gt;
30643         &lt;/xsl:call-template&gt;
30644       &lt;/xsl:variable&gt;
30645       &lt;xsl:value-of select="concat(substring-before($string, $target),                                    $replacement,                                    $rest)"&gt;&lt;/xsl:value-of&gt;
30646     &lt;/xsl:when&gt;
30647     &lt;xsl:otherwise&gt;
30648       &lt;xsl:value-of select="$string"&gt;&lt;/xsl:value-of&gt;
30649     &lt;/xsl:otherwise&gt;
30650   &lt;/xsl:choose&gt;
30651 &lt;/xsl:template&gt;
30652 </programlisting>
30653
30654 </refsect1>
30655 </refentry>
30656
30657
30658
30659 <refentry id="xpointer.idref">
30660 <refnamediv>
30661 <refname>xpointer.idref</refname>
30662 <refpurpose>Extract IDREF from an XPointer</refpurpose>
30663 </refnamediv>
30664
30665 <refsect1><title>Description</title>
30666
30667 <para>The <function>xpointer.idref</function> template returns the
30668 ID portion of an XPointer which is a pointer to an ID within the current
30669 document, or the empty string if it is not.</para>
30670 <para>In other words, <function>xpointer.idref</function> returns
30671 <quote>foo</quote> when passed either <literal>#foo</literal>
30672 or <literal>#xpointer(id('foo'))</literal>, otherwise it returns
30673 the empty string.</para>
30674
30675 <programlisting id="xpointer.idref.frag">
30676 &lt;xsl:template name="xpointer.idref"&gt;
30677   &lt;xsl:param name="xpointer"&gt;http://...&lt;/xsl:param&gt;
30678   &lt;xsl:choose&gt;
30679     &lt;xsl:when test="starts-with($xpointer, '#xpointer(id(')"&gt;
30680       &lt;xsl:variable name="rest" select="substring-after($xpointer, '#xpointer(id(')"&gt;&lt;/xsl:variable&gt;
30681       &lt;xsl:variable name="quote" select="substring($rest, 1, 1)"&gt;&lt;/xsl:variable&gt;
30682       &lt;xsl:value-of select="substring-before(substring-after($xpointer, $quote), $quote)"&gt;&lt;/xsl:value-of&gt;
30683     &lt;/xsl:when&gt;
30684     &lt;xsl:when test="starts-with($xpointer, '#')"&gt;
30685       &lt;xsl:value-of select="substring-after($xpointer, '#')"&gt;&lt;/xsl:value-of&gt;
30686     &lt;/xsl:when&gt;
30687     &lt;!-- otherwise it's a pointer to some other document --&gt;
30688   &lt;/xsl:choose&gt;
30689 &lt;/xsl:template&gt;
30690 </programlisting>
30691
30692 </refsect1>
30693 </refentry>
30694
30695
30696
30697
30698 <refentry id="length-magnitude">
30699 <refnamediv>
30700 <refname>length-magnitude</refname>
30701 <refpurpose>Return the unqualified dimension from a length specification</refpurpose>
30702 </refnamediv>
30703
30704 <refsect1><title>Description</title>
30705
30706 <para>The <function>length-magnitude</function> template returns the
30707 unqualified length ("20" for "20pt") from a dimension.
30708 </para>
30709
30710 <programlisting id="length-magnitude.frag">
30711 &lt;xsl:template name="length-magnitude"&gt;
30712   &lt;xsl:param name="length" select="'0pt'"&gt;&lt;/xsl:param&gt;
30713
30714   &lt;xsl:choose&gt;
30715     &lt;xsl:when test="string-length($length) = 0"&gt;&lt;/xsl:when&gt;
30716     &lt;xsl:when test="substring($length,1,1) = '0'                     or substring($length,1,1) = '1'                     or substring($length,1,1) = '2'                     or substring($length,1,1) = '3'                     or substring($length,1,1) = '4'                     or substring($length,1,1) = '5'                     or substring($length,1,1) = '6'                     or substring($length,1,1) = '7'                     or substring($length,1,1) = '8'                     or substring($length,1,1) = '9'                     or substring($length,1,1) = '.'"&gt;
30717       &lt;xsl:value-of select="substring($length,1,1)"&gt;&lt;/xsl:value-of&gt;
30718       &lt;xsl:call-template name="length-magnitude"&gt;
30719         &lt;xsl:with-param name="length" select="substring($length,2)"&gt;&lt;/xsl:with-param&gt;
30720       &lt;/xsl:call-template&gt;
30721     &lt;/xsl:when&gt;
30722   &lt;/xsl:choose&gt;
30723 &lt;/xsl:template&gt;
30724 </programlisting>
30725
30726 </refsect1>
30727 </refentry>
30728
30729
30730
30731 <refentry id="length-units">
30732 <refnamediv>
30733 <refname>length-units</refname>
30734 <refpurpose>Return the units from a length specification</refpurpose>
30735 </refnamediv>
30736
30737 <refsect1><title>Description</title>
30738
30739 <para>The <function>length-units</function> template returns the
30740 units ("pt" for "20pt") from a length. If no units are supplied on the
30741 length, the <parameter>defauilt.units</parameter> are returned.</para>
30742
30743 <programlisting id="length-units.frag">
30744 &lt;xsl:template name="length-units"&gt;
30745   &lt;xsl:param name="length" select="'0pt'"&gt;&lt;/xsl:param&gt;
30746   &lt;xsl:param name="default.units" select="'px'"&gt;&lt;/xsl:param&gt;
30747   &lt;xsl:variable name="magnitude"&gt;
30748     &lt;xsl:call-template name="length-magnitude"&gt;
30749       &lt;xsl:with-param name="length" select="$length"&gt;&lt;/xsl:with-param&gt;
30750     &lt;/xsl:call-template&gt;
30751   &lt;/xsl:variable&gt;
30752
30753   &lt;xsl:variable name="units"&gt;
30754     &lt;xsl:value-of select="substring($length, string-length($magnitude)+1)"&gt;&lt;/xsl:value-of&gt;
30755   &lt;/xsl:variable&gt;
30756
30757   &lt;xsl:choose&gt;
30758     &lt;xsl:when test="$units = ''"&gt;
30759       &lt;xsl:value-of select="$default.units"&gt;&lt;/xsl:value-of&gt;
30760     &lt;/xsl:when&gt;
30761     &lt;xsl:otherwise&gt;
30762       &lt;xsl:value-of select="$units"&gt;&lt;/xsl:value-of&gt;
30763     &lt;/xsl:otherwise&gt;
30764   &lt;/xsl:choose&gt;
30765 &lt;/xsl:template&gt;
30766 </programlisting>
30767
30768 </refsect1>
30769 </refentry>
30770
30771
30772
30773 <refentry id="length-spec">
30774 <refnamediv>
30775 <refname>length-spec</refname>
30776 <refpurpose>Return a fully qualified length specification</refpurpose>
30777 </refnamediv>
30778
30779 <refsect1><title>Description</title>
30780
30781 <para>The <function>length-spec</function> template returns the
30782 qualified length from a dimension. If an unqualified length is given,
30783 the <parameter>default.units</parameter> will be added to it.
30784 </para>
30785
30786 <programlisting id="length-spec.frag">
30787 &lt;xsl:template name="length-spec"&gt;
30788   &lt;xsl:param name="length" select="'0pt'"&gt;&lt;/xsl:param&gt;
30789   &lt;xsl:param name="default.units" select="'px'"&gt;&lt;/xsl:param&gt;
30790
30791   &lt;xsl:variable name="magnitude"&gt;
30792     &lt;xsl:call-template name="length-magnitude"&gt;
30793       &lt;xsl:with-param name="length" select="$length"&gt;&lt;/xsl:with-param&gt;
30794     &lt;/xsl:call-template&gt;
30795   &lt;/xsl:variable&gt;
30796
30797   &lt;xsl:variable name="units"&gt;
30798     &lt;xsl:value-of select="substring($length, string-length($magnitude)+1)"&gt;&lt;/xsl:value-of&gt;
30799   &lt;/xsl:variable&gt;
30800
30801   &lt;xsl:value-of select="$magnitude"&gt;&lt;/xsl:value-of&gt;
30802   &lt;xsl:choose&gt;
30803     &lt;xsl:when test="$units='cm'                     or $units='mm'                     or $units='in'                     or $units='pt'                     or $units='pc'                     or $units='px'                     or $units='em'"&gt;
30804       &lt;xsl:value-of select="$units"&gt;&lt;/xsl:value-of&gt;
30805     &lt;/xsl:when&gt;
30806     &lt;xsl:when test="$units = ''"&gt;
30807       &lt;xsl:value-of select="$default.units"&gt;&lt;/xsl:value-of&gt;
30808     &lt;/xsl:when&gt;
30809     &lt;xsl:otherwise&gt;
30810       &lt;xsl:message&gt;
30811         &lt;xsl:text&gt;Unrecognized unit of measure: &lt;/xsl:text&gt;
30812         &lt;xsl:value-of select="$units"&gt;&lt;/xsl:value-of&gt;
30813         &lt;xsl:text&gt;.&lt;/xsl:text&gt;
30814       &lt;/xsl:message&gt;
30815     &lt;/xsl:otherwise&gt;
30816   &lt;/xsl:choose&gt;
30817 &lt;/xsl:template&gt;
30818 </programlisting>
30819
30820 </refsect1>
30821 </refentry>
30822
30823
30824
30825 <refentry id="length-in-points">
30826 <refnamediv>
30827 <refname>length-in-points</refname>
30828 <refpurpose>Returns the size, in points, of a specified length</refpurpose>
30829 </refnamediv>
30830
30831 <refsect1><title>Description</title>
30832
30833 <para>The <function>length-in-points</function> template converts a length
30834 specification to points and returns that value as an unqualified
30835 number.
30836 </para>
30837
30838 <caution>
30839 <para>There is no way for the template to infer the size of an
30840 <literal>em</literal>. It relies on the default <parameter>em.size</parameter>
30841 which is initially <literal>10</literal> (for 10pt).</para>
30842
30843 <para>Similarly, converting pixels to points relies on the
30844 <parameter>pixels.per.inch</parameter> parameter which is initially
30845 <literal>90</literal>.
30846 </para>
30847 </caution>
30848
30849 <programlisting id="length-in-points.frag">
30850 &lt;xsl:template name="length-in-points"&gt;
30851   &lt;xsl:param name="length" select="'0pt'"&gt;&lt;/xsl:param&gt;
30852   &lt;xsl:param name="em.size" select="10"&gt;&lt;/xsl:param&gt;
30853   &lt;xsl:param name="pixels.per.inch" select="90"&gt;&lt;/xsl:param&gt;
30854
30855   &lt;xsl:variable name="magnitude"&gt;
30856     &lt;xsl:call-template name="length-magnitude"&gt;
30857       &lt;xsl:with-param name="length" select="$length"&gt;&lt;/xsl:with-param&gt;
30858     &lt;/xsl:call-template&gt;
30859   &lt;/xsl:variable&gt;
30860
30861   &lt;xsl:variable name="units"&gt;
30862     &lt;xsl:value-of select="substring($length, string-length($magnitude)+1)"&gt;&lt;/xsl:value-of&gt;
30863   &lt;/xsl:variable&gt;
30864
30865   &lt;xsl:choose&gt;
30866     &lt;xsl:when test="$units = 'pt'"&gt;
30867       &lt;xsl:value-of select="$magnitude"&gt;&lt;/xsl:value-of&gt;
30868     &lt;/xsl:when&gt;
30869     &lt;xsl:when test="$units = 'cm'"&gt;
30870       &lt;xsl:value-of select="$magnitude div 2.54 * 72.0"&gt;&lt;/xsl:value-of&gt;
30871     &lt;/xsl:when&gt;
30872     &lt;xsl:when test="$units = 'mm'"&gt;
30873       &lt;xsl:value-of select="$magnitude div 25.4 * 72.0"&gt;&lt;/xsl:value-of&gt;
30874     &lt;/xsl:when&gt;
30875     &lt;xsl:when test="$units = 'in'"&gt;
30876       &lt;xsl:value-of select="$magnitude * 72.0"&gt;&lt;/xsl:value-of&gt;
30877     &lt;/xsl:when&gt;
30878     &lt;xsl:when test="$units = 'pc'"&gt;
30879       &lt;xsl:value-of select="$magnitude * 12.0"&gt;&lt;/xsl:value-of&gt;
30880     &lt;/xsl:when&gt;
30881     &lt;xsl:when test="$units = 'px'"&gt;
30882       &lt;xsl:value-of select="$magnitude div $pixels.per.inch * 72.0"&gt;&lt;/xsl:value-of&gt;
30883     &lt;/xsl:when&gt;
30884     &lt;xsl:when test="$units = 'em'"&gt;
30885       &lt;xsl:value-of select="$magnitude * $em.size"&gt;&lt;/xsl:value-of&gt;
30886     &lt;/xsl:when&gt;
30887     &lt;xsl:otherwise&gt;
30888       &lt;xsl:message&gt;
30889         &lt;xsl:text&gt;Unrecognized unit of measure: &lt;/xsl:text&gt;
30890         &lt;xsl:value-of select="$units"&gt;&lt;/xsl:value-of&gt;
30891         &lt;xsl:text&gt;.&lt;/xsl:text&gt;
30892       &lt;/xsl:message&gt;
30893     &lt;/xsl:otherwise&gt;
30894   &lt;/xsl:choose&gt;
30895 &lt;/xsl:template&gt;
30896 </programlisting>
30897
30898 </refsect1>
30899 </refentry>
30900
30901
30902
30903 <refentry id="pi-attribute">
30904 <refnamediv>
30905 <refname>pi-attribute</refname>
30906 <refpurpose>Extract a pseudo-attribute from a PI</refpurpose>
30907 </refnamediv>
30908
30909 <refsect1><title>Description</title>
30910
30911 <para>The <function>pi-attribute</function> template extracts a pseudo-attribute
30912 from a processing instruction. For example, given the PI
30913 <quote><literal>&lt;?foo bar="1" baz='red'?&gt;</literal></quote>,</para>
30914 <programlisting>&lt;xsl:call-template name="pi-attribute"&gt;
30915   &lt;xsl:with-param name="pis" select="processing-instruction('foo')"/&gt;
30916   &lt;xsl:with-param name="attribute" select="'baz'"/&gt;
30917 &lt;/xsl:call-template&gt;</programlisting>
30918 <para>will return <quote>red</quote>. This template returns the first matching
30919 attribute that it finds. Presented with processing instructions that
30920 contain badly formed pseudo-attributes (missing or unbalanced quotes,
30921 for example), the template may silently return erroneous results.</para>
30922
30923 <programlisting id="pi-attribute.frag">
30924 &lt;xsl:template name="pi-attribute"&gt;
30925   &lt;xsl:param name="pis" select="processing-instruction('BOGUS_PI')"&gt;&lt;/xsl:param&gt;
30926   &lt;xsl:param name="attribute"&gt;filename&lt;/xsl:param&gt;
30927   &lt;xsl:param name="count"&gt;1&lt;/xsl:param&gt;
30928
30929   &lt;xsl:choose&gt;
30930     &lt;xsl:when test="$count&gt;count($pis)"&gt;
30931       &lt;!-- not found --&gt;
30932     &lt;/xsl:when&gt;
30933     &lt;xsl:otherwise&gt;
30934       &lt;xsl:variable name="pi"&gt;
30935         &lt;xsl:value-of select="$pis[$count]"&gt;&lt;/xsl:value-of&gt;
30936       &lt;/xsl:variable&gt;
30937       &lt;xsl:variable name="pivalue"&gt;
30938         &lt;xsl:value-of select="concat(' ', normalize-space($pi))"&gt;&lt;/xsl:value-of&gt;
30939       &lt;/xsl:variable&gt;
30940       &lt;xsl:choose&gt;
30941         &lt;xsl:when test="contains($pivalue,concat(' ', $attribute, '='))"&gt;
30942           &lt;xsl:variable name="rest" select="substring-after($pivalue,concat(' ', $attribute,'='))"&gt;&lt;/xsl:variable&gt;
30943           &lt;xsl:variable name="quote" select="substring($rest,1,1)"&gt;&lt;/xsl:variable&gt;
30944           &lt;xsl:value-of select="substring-before(substring($rest,2),$quote)"&gt;&lt;/xsl:value-of&gt;
30945         &lt;/xsl:when&gt;
30946         &lt;xsl:otherwise&gt;
30947           &lt;xsl:call-template name="pi-attribute"&gt;
30948             &lt;xsl:with-param name="pis" select="$pis"&gt;&lt;/xsl:with-param&gt;
30949             &lt;xsl:with-param name="attribute" select="$attribute"&gt;&lt;/xsl:with-param&gt;
30950             &lt;xsl:with-param name="count" select="$count + 1"&gt;&lt;/xsl:with-param&gt;
30951           &lt;/xsl:call-template&gt;
30952         &lt;/xsl:otherwise&gt;
30953       &lt;/xsl:choose&gt;
30954     &lt;/xsl:otherwise&gt;
30955   &lt;/xsl:choose&gt;
30956 &lt;/xsl:template&gt;
30957 </programlisting>
30958
30959 </refsect1>
30960 </refentry>
30961
30962
30963
30964 <refentry id="lookup.key">
30965 <refnamediv>
30966 <refname>lookup.key</refname>
30967 <refpurpose>Retrieve the value associated with a particular key in a table</refpurpose>
30968 </refnamediv>
30969
30970 <refsect1><title>Description</title>
30971
30972 <para>Given a table of space-delimited key/value pairs,
30973 the <function>lookup.key</function> template extracts the value associated
30974 with a particular key.</para>
30975
30976 <programlisting id="lookup.key.frag">
30977 &lt;xsl:template name="lookup.key"&gt;
30978   &lt;xsl:param name="key" select="''"&gt;&lt;/xsl:param&gt;
30979   &lt;xsl:param name="table" select="''"&gt;&lt;/xsl:param&gt;
30980
30981   &lt;xsl:if test="contains($table, ' ')"&gt;
30982     &lt;xsl:choose&gt;
30983       &lt;xsl:when test="substring-before($table, ' ') = $key"&gt;
30984         &lt;xsl:variable name="rest" select="substring-after($table, ' ')"&gt;&lt;/xsl:variable&gt;
30985         &lt;xsl:choose&gt;
30986           &lt;xsl:when test="contains($rest, ' ')"&gt;
30987             &lt;xsl:value-of select="substring-before($rest, ' ')"&gt;&lt;/xsl:value-of&gt;
30988           &lt;/xsl:when&gt;
30989           &lt;xsl:otherwise&gt;
30990             &lt;xsl:value-of select="$rest"&gt;&lt;/xsl:value-of&gt;
30991           &lt;/xsl:otherwise&gt;
30992         &lt;/xsl:choose&gt;
30993       &lt;/xsl:when&gt;
30994       &lt;xsl:otherwise&gt;
30995         &lt;xsl:call-template name="lookup.key"&gt;
30996           &lt;xsl:with-param name="key" select="$key"&gt;&lt;/xsl:with-param&gt;
30997           &lt;xsl:with-param name="table" select="substring-after(substring-after($table,' '), ' ')"&gt;&lt;/xsl:with-param&gt;
30998         &lt;/xsl:call-template&gt;
30999       &lt;/xsl:otherwise&gt;
31000     &lt;/xsl:choose&gt;
31001   &lt;/xsl:if&gt;
31002 &lt;/xsl:template&gt;
31003 </programlisting>
31004
31005 </refsect1>
31006 </refentry>
31007
31008
31009
31010 <refentry id="xpath.location">
31011 <refnamediv>
31012 <refname>xpath.location</refname>
31013 <refpurpose>Calculate the XPath child-sequence to the current node</refpurpose>
31014 </refnamediv>
31015
31016 <refsect1><title>Description</title>
31017
31018 <para>The <function>xpath.location</function> template calculates the
31019 absolute path from the root of the tree to the current element node.
31020 </para>
31021
31022 <programlisting id="xpath.location.frag">
31023 &lt;xsl:template name="xpath.location"&gt;
31024   &lt;xsl:param name="node" select="."&gt;&lt;/xsl:param&gt;
31025   &lt;xsl:param name="path" select="''"&gt;&lt;/xsl:param&gt;
31026
31027   &lt;xsl:variable name="next.path"&gt;
31028     &lt;xsl:value-of select="local-name($node)"&gt;&lt;/xsl:value-of&gt;
31029     &lt;xsl:if test="$path != ''"&gt;/&lt;/xsl:if&gt;
31030     &lt;xsl:value-of select="$path"&gt;&lt;/xsl:value-of&gt;
31031   &lt;/xsl:variable&gt;
31032
31033   &lt;xsl:choose&gt;
31034     &lt;xsl:when test="$node/parent::*"&gt;
31035       &lt;xsl:call-template name="xpath.location"&gt;
31036         &lt;xsl:with-param name="node" select="$node/parent::*"&gt;&lt;/xsl:with-param&gt;
31037         &lt;xsl:with-param name="path" select="$next.path"&gt;&lt;/xsl:with-param&gt;
31038       &lt;/xsl:call-template&gt;
31039     &lt;/xsl:when&gt;
31040     &lt;xsl:otherwise&gt;
31041       &lt;xsl:text&gt;/&lt;/xsl:text&gt;
31042       &lt;xsl:value-of select="$next.path"&gt;&lt;/xsl:value-of&gt;
31043     &lt;/xsl:otherwise&gt;
31044   &lt;/xsl:choose&gt;
31045 &lt;/xsl:template&gt;
31046 </programlisting>
31047
31048 </refsect1>
31049 </refentry>
31050
31051
31052
31053 <refentry id="comment-escape-string">
31054 <refnamediv>
31055 <refname>comment-escape-string</refname>
31056 <refpurpose>Prepare a string for inclusion in an XML comment</refpurpose>
31057 </refnamediv>
31058
31059 <refsect1><title>Description</title>
31060
31061 <para>The <function>comment-escape-string</function> template returns a string
31062 that has been transformed so that it can safely be output as an XML comment.
31063 Internal occurrences of "--" will be replaced with "- -" and a leading and/or
31064 trailing space will be added to the string, if necessary.</para>
31065
31066 <programlisting id="comment-escape-string.frag">
31067 &lt;xsl:template name="comment-escape-string"&gt;
31068   &lt;xsl:param name="string" select="''"&gt;&lt;/xsl:param&gt;
31069
31070   &lt;xsl:if test="starts-with($string, '-')"&gt;
31071     &lt;xsl:text&gt; &lt;/xsl:text&gt;
31072   &lt;/xsl:if&gt;
31073
31074   &lt;xsl:call-template name="comment-escape-string.recursive"&gt;
31075     &lt;xsl:with-param name="string" select="$string"&gt;&lt;/xsl:with-param&gt;
31076   &lt;/xsl:call-template&gt;
31077
31078   &lt;xsl:if test="substring($string, string-length($string), 1) = '-'"&gt;
31079     &lt;xsl:text&gt; &lt;/xsl:text&gt;
31080   &lt;/xsl:if&gt;
31081 &lt;/xsl:template&gt;
31082 </programlisting>
31083
31084 </refsect1>
31085 </refentry>
31086
31087
31088
31089 <refentry id="comment-escape-string.recursive">
31090 <refnamediv>
31091 <refname>comment-escape-string.recursive</refname>
31092 <refpurpose>Internal function used by comment-escape-string</refpurpose>
31093 </refnamediv>
31094
31095 <refsect1><title>Description</title>
31096
31097 <para>The <function>comment-escape-string.recursive</function> template is used
31098 by <function>comment-escape-string</function>.</para>
31099
31100 <programlisting id="comment-escape-string.recursive.frag">
31101 &lt;xsl:template name="comment-escape-string.recursive"&gt;
31102   &lt;xsl:param name="string" select="''"&gt;&lt;/xsl:param&gt;
31103   &lt;xsl:choose&gt;
31104     &lt;xsl:when test="contains($string, '--')"&gt;
31105       &lt;xsl:value-of select="substring-before($string, '--')"&gt;&lt;/xsl:value-of&gt;
31106       &lt;xsl:value-of select="'- -'"&gt;&lt;/xsl:value-of&gt;
31107       &lt;xsl:call-template name="comment-escape-string.recursive"&gt;
31108         &lt;xsl:with-param name="string" select="substring-after($string, '--')"&gt;&lt;/xsl:with-param&gt;
31109       &lt;/xsl:call-template&gt;
31110     &lt;/xsl:when&gt;
31111     &lt;xsl:otherwise&gt;
31112       &lt;xsl:value-of select="$string"&gt;&lt;/xsl:value-of&gt;
31113     &lt;/xsl:otherwise&gt;
31114   &lt;/xsl:choose&gt;
31115 &lt;/xsl:template&gt;
31116 </programlisting>
31117 </refsect1>
31118 </refentry>
31119
31120
31121
31122 <refentry id="trim.text">
31123 <refnamediv>
31124 <refname>trim.text</refname>
31125 <refpurpose>Trim leading and trailing whitespace from a text node</refpurpose>
31126 </refnamediv>
31127
31128 <refsect1><title>Description</title>
31129
31130 <para>Given a text node, this function trims leading and trailing
31131 whitespace from it and returns the trimmed contents.</para>
31132
31133 <programlisting id="trim.text.frag">
31134
31135   &lt;xsl:template name="trim.text"&gt;
31136     &lt;xsl:param name="contents" select="."&gt;&lt;/xsl:param&gt;
31137     &lt;xsl:variable name="contents-left-trimmed"&gt;
31138       &lt;xsl:call-template name="trim-left"&gt;
31139         &lt;xsl:with-param name="contents" select="$contents"&gt;&lt;/xsl:with-param&gt;
31140       &lt;/xsl:call-template&gt;
31141     &lt;/xsl:variable&gt;
31142     &lt;xsl:variable name="contents-trimmed"&gt;
31143       &lt;xsl:call-template name="trim-right"&gt;
31144         &lt;xsl:with-param name="contents" select="$contents-left-trimmed"&gt;&lt;/xsl:with-param&gt;
31145       &lt;/xsl:call-template&gt;
31146     &lt;/xsl:variable&gt;
31147     &lt;xsl:value-of select="$contents-trimmed"&gt;&lt;/xsl:value-of&gt;
31148   &lt;/xsl:template&gt;
31149
31150   &lt;xsl:template name="trim-left"&gt;
31151     &lt;xsl:param name="contents"&gt;&lt;/xsl:param&gt;
31152     &lt;xsl:choose&gt;
31153       &lt;xsl:when test="starts-with($contents,'
31154 ') or                       starts-with($contents,'&#xD;') or                       starts-with($contents,' ') or                       starts-with($contents,' ')"&gt;
31155         &lt;xsl:call-template name="trim-left"&gt;
31156           &lt;xsl:with-param name="contents" select="substring($contents, 2)"&gt;&lt;/xsl:with-param&gt;
31157         &lt;/xsl:call-template&gt;
31158       &lt;/xsl:when&gt;
31159       &lt;xsl:otherwise&gt;
31160         &lt;xsl:value-of select="$contents"&gt;&lt;/xsl:value-of&gt;
31161       &lt;/xsl:otherwise&gt;
31162     &lt;/xsl:choose&gt;
31163   &lt;/xsl:template&gt;
31164
31165   &lt;xsl:template name="trim-right"&gt;
31166     &lt;xsl:param name="contents"&gt;&lt;/xsl:param&gt;
31167     &lt;xsl:variable name="last-char"&gt;
31168       &lt;xsl:value-of select="substring($contents, string-length($contents), 1)"&gt;&lt;/xsl:value-of&gt;
31169     &lt;/xsl:variable&gt;
31170     &lt;xsl:choose&gt;
31171       &lt;xsl:when test="($last-char = '
31172 ') or                       ($last-char = '&#xD;') or                       ($last-char = ' ') or                       ($last-char = ' ')"&gt;
31173         &lt;xsl:call-template name="trim-right"&gt;
31174           &lt;xsl:with-param name="contents" select="substring($contents, 1, string-length($contents) - 1)"&gt;&lt;/xsl:with-param&gt;
31175         &lt;/xsl:call-template&gt;
31176       &lt;/xsl:when&gt;
31177       &lt;xsl:otherwise&gt;
31178         &lt;xsl:value-of select="$contents"&gt;&lt;/xsl:value-of&gt;
31179       &lt;/xsl:otherwise&gt;
31180     &lt;/xsl:choose&gt;
31181   &lt;/xsl:template&gt;
31182 </programlisting>
31183
31184 </refsect1>
31185 </refentry>
31186
31187
31188
31189 <refentry id="str.tokenize.keep.delimiters">
31190 <refnamediv>
31191 <refname>str.tokenize.keep.delimiters</refname>
31192 <refpurpose>Tokenize a string while preserving any delimiters</refpurpose>
31193 </refnamediv>
31194 <refsect1><title>Description</title>
31195 <para>Based on the occurrence of one or more delimiter characters,
31196 this function breaks a string into a list of tokens and delimiters,
31197 marking up each of the tokens with a <tag>token</tag> element
31198 and preserving the delimiters as text nodes between the tokens.</para>
31199 <note>
31200   <para>This function is a very slightly modified version of a
31201   function from the <link xlink:href="http://www.exslt.org/">EXSLT
31202   site</link>. The original is available at:
31203
31204 <blockquote><para><link xlink:href="http://www.exslt.org/str/functions/tokenize/str.tokenize.template.xsl"/></para></blockquote>
31205
31206   The <function>str.tokenize.keep.delimiters</function> function
31207   differs only in that it preserves the delimiters instead of
31208   discarding them.</para>
31209 </note>
31210 <programlisting id="str.tokenize.keep.delimiters.frag">
31211   &lt;xsl:template name="str.tokenize.keep.delimiters"&gt;
31212     &lt;xsl:param name="string" select="''"&gt;&lt;/xsl:param&gt;
31213     &lt;xsl:param name="delimiters" select="' '"&gt;&lt;/xsl:param&gt;
31214     &lt;xsl:choose&gt;
31215       &lt;xsl:when test="not($string)"&gt;&lt;/xsl:when&gt;
31216       &lt;xsl:when test="not($delimiters)"&gt;
31217         &lt;xsl:call-template name="str.tokenize.keep.delimiters-characters"&gt;
31218           &lt;xsl:with-param name="string" select="$string"&gt;&lt;/xsl:with-param&gt;
31219         &lt;/xsl:call-template&gt;
31220       &lt;/xsl:when&gt;
31221       &lt;xsl:otherwise&gt;
31222         &lt;xsl:call-template name="str.tokenize.keep.delimiters-delimiters"&gt;
31223           &lt;xsl:with-param name="string" select="$string"&gt;&lt;/xsl:with-param&gt;
31224           &lt;xsl:with-param name="delimiters" select="$delimiters"&gt;&lt;/xsl:with-param&gt;
31225         &lt;/xsl:call-template&gt;
31226       &lt;/xsl:otherwise&gt;
31227     &lt;/xsl:choose&gt;
31228   &lt;/xsl:template&gt;
31229   &lt;xsl:template name="str.tokenize.keep.delimiters-characters"&gt;
31230     &lt;xsl:param name="string"&gt;&lt;/xsl:param&gt;
31231     &lt;xsl:if test="$string"&gt;
31232       &lt;ssb:token&gt;&lt;xsl:value-of select="substring($string, 1, 1)"&gt;&lt;/xsl:value-of&gt;&lt;/ssb:token&gt;
31233       &lt;xsl:call-template name="str.tokenize.keep.delimiters-characters"&gt;
31234         &lt;xsl:with-param name="string" select="substring($string, 2)"&gt;&lt;/xsl:with-param&gt;
31235       &lt;/xsl:call-template&gt;
31236     &lt;/xsl:if&gt;
31237   &lt;/xsl:template&gt;
31238   &lt;xsl:template name="str.tokenize.keep.delimiters-delimiters"&gt;
31239     &lt;xsl:param name="string"&gt;&lt;/xsl:param&gt;
31240     &lt;xsl:param name="delimiters"&gt;&lt;/xsl:param&gt;
31241     &lt;xsl:variable name="delimiter" select="substring($delimiters, 1, 1)"&gt;&lt;/xsl:variable&gt;
31242     &lt;xsl:choose&gt;
31243       &lt;xsl:when test="not($delimiter)"&gt;
31244         &lt;ssb:token&gt;&lt;xsl:value-of select="$string"&gt;&lt;/xsl:value-of&gt;&lt;/ssb:token&gt;
31245       &lt;/xsl:when&gt;
31246       &lt;xsl:when test="contains($string, $delimiter)"&gt;
31247         &lt;xsl:if test="not(starts-with($string, $delimiter))"&gt;
31248           &lt;xsl:call-template name="str.tokenize.keep.delimiters-delimiters"&gt;
31249             &lt;xsl:with-param name="string" select="substring-before($string, $delimiter)"&gt;&lt;/xsl:with-param&gt;
31250             &lt;xsl:with-param name="delimiters" select="substring($delimiters, 2)"&gt;&lt;/xsl:with-param&gt;
31251           &lt;/xsl:call-template&gt;
31252         &lt;/xsl:if&gt;
31253         &lt;!-- output each delimiter --&gt;
31254         &lt;xsl:value-of select="$delimiter"&gt;&lt;/xsl:value-of&gt;
31255         &lt;xsl:call-template name="str.tokenize.keep.delimiters-delimiters"&gt;
31256           &lt;xsl:with-param name="string" select="substring-after($string, $delimiter)"&gt;&lt;/xsl:with-param&gt;
31257           &lt;xsl:with-param name="delimiters" select="$delimiters"&gt;&lt;/xsl:with-param&gt;
31258         &lt;/xsl:call-template&gt;
31259       &lt;/xsl:when&gt;
31260       &lt;xsl:otherwise&gt;
31261         &lt;xsl:call-template name="str.tokenize.keep.delimiters-delimiters"&gt;
31262           &lt;xsl:with-param name="string" select="$string"&gt;&lt;/xsl:with-param&gt;
31263           &lt;xsl:with-param name="delimiters" select="substring($delimiters, 2)"&gt;&lt;/xsl:with-param&gt;
31264         &lt;/xsl:call-template&gt;
31265       &lt;/xsl:otherwise&gt;
31266     &lt;/xsl:choose&gt;
31267   &lt;/xsl:template&gt;
31268 </programlisting>
31269 </refsect1>
31270 </refentry>
31271
31272
31273
31274 <refentry id="apply-string-subst-map">
31275   <refnamediv>
31276     <refname>apply-string-subst-map</refname>
31277     <refpurpose>Apply a string-substitution map</refpurpose>
31278   </refnamediv>
31279   <refsect1><title>Description</title>
31280   <para>This function applies a &#8220;string substitution&#8221; map. Use it when
31281   you want to do multiple string substitutions on the same target
31282   content. It reads in two things: <parameter>content</parameter>, the
31283   content on which to perform the substitution, and
31284   <parameter>map.contents</parameter>, a node set of
31285   elements (the names of the elements don't matter), with each element
31286   having the following attributes:
31287   <itemizedlist>
31288     <listitem>
31289       <simpara><tag class="attribute">oldstring</tag>, a string to
31290       be replaced</simpara>
31291     </listitem>
31292     <listitem>
31293       <simpara><tag class="attribute">newstring</tag>, a string with
31294       which to replace <tag class="attribute">oldstring</tag></simpara>
31295     </listitem>
31296   </itemizedlist>
31297   The function uses <parameter>map.contents</parameter> to
31298   do substitution on <parameter>content</parameter>, and then
31299   returns the modified contents.</para>
31300   <note>
31301     <para>This function is a very slightly modified version of Jeni
31302     Tennison&#8217;s <function>replace_strings</function> function in the
31303     <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/StringReplace.html#d9351e13">multiple string replacements</link> section of Dave Pawson&#8217;s
31304     <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
31305     FAQ</link>.</para>
31306     <para>The <function>apply-string-subst-map</function> function is
31307     essentially the same function as the
31308     <function>apply-character-map</function> function; the only
31309     difference is that in the map that
31310     <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used instead of
31311     <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
31312   </note>
31313   <programlisting id="apply-string-subst-map.frag">
31314     &lt;xsl:template name="apply-string-subst-map"&gt;
31315       &lt;xsl:param name="content"&gt;&lt;/xsl:param&gt;
31316       &lt;xsl:param name="map.contents"&gt;&lt;/xsl:param&gt;
31317       &lt;xsl:variable name="replaced_text"&gt;
31318         &lt;xsl:call-template name="string.subst"&gt;
31319           &lt;xsl:with-param name="string" select="$content"&gt;&lt;/xsl:with-param&gt;
31320           &lt;xsl:with-param name="target" select="$map.contents[1]/@oldstring"&gt;&lt;/xsl:with-param&gt;
31321           &lt;xsl:with-param name="replacement" select="$map.contents[1]/@newstring"&gt;&lt;/xsl:with-param&gt;
31322         &lt;/xsl:call-template&gt;
31323       &lt;/xsl:variable&gt;
31324       &lt;xsl:choose&gt;
31325         &lt;xsl:when test="$map.contents[2]"&gt;
31326           &lt;xsl:call-template name="apply-string-subst-map"&gt;
31327             &lt;xsl:with-param name="content" select="$replaced_text"&gt;&lt;/xsl:with-param&gt;
31328             &lt;xsl:with-param name="map.contents" select="$map.contents[position() &gt; 1]"&gt;&lt;/xsl:with-param&gt;
31329           &lt;/xsl:call-template&gt;
31330         &lt;/xsl:when&gt;
31331         &lt;xsl:otherwise&gt;
31332           &lt;xsl:value-of select="$replaced_text"&gt;&lt;/xsl:value-of&gt;
31333         &lt;/xsl:otherwise&gt;
31334       &lt;/xsl:choose&gt;
31335     &lt;/xsl:template&gt;
31336   </programlisting>
31337   </refsect1>
31338 </refentry>
31339 </reference><reference id="relativeuri" xml:base="../lib/lib.xml">
31340 <title>Relative URI Functions</title>
31341
31342 <partintro id="partintro"><title>Introduction</title>
31343
31344 <para>These functions manipulate relative URI references.</para>
31345
31346 <para>The following assumptions must hold true:</para>
31347
31348 <orderedlist>
31349 <listitem>
31350 <para>All URIs are relative.</para>
31351 </listitem>
31352 <listitem>
31353 <para>No URI contains the <quote><literal>../</literal></quote> sequence
31354 which would effectively move <quote>up</quote> the hierarchy.</para>
31355 </listitem>
31356 </orderedlist>
31357
31358 <para>If these assumptions do not hold, the results are unpredictable.</para>
31359
31360 </partintro>
31361
31362
31363
31364 <refentry id="count.uri.path.depth">
31365 <refnamediv>
31366 <refname>count.uri.path.depth</refname>
31367 <refpurpose>Count the number of path components in a relative URI</refpurpose>
31368 </refnamediv>
31369
31370 <refsect1><title>Description</title>
31371
31372 <para>This function counts the number of path components in a relative URI.</para>
31373
31374 <programlisting id="count.uri.path.depth.frag">
31375 &lt;xsl:template name="count.uri.path.depth"&gt;
31376   &lt;xsl:param name="filename" select="''"&gt;&lt;/xsl:param&gt;
31377   &lt;xsl:param name="count" select="0"&gt;&lt;/xsl:param&gt;
31378
31379   &lt;xsl:choose&gt;
31380     &lt;xsl:when test="contains($filename, '/')"&gt;
31381       &lt;xsl:call-template name="count.uri.path.depth"&gt;
31382         &lt;xsl:with-param name="filename" select="substring-after($filename, '/')"&gt;&lt;/xsl:with-param&gt;
31383         &lt;xsl:with-param name="count" select="$count + 1"&gt;&lt;/xsl:with-param&gt;
31384       &lt;/xsl:call-template&gt;
31385     &lt;/xsl:when&gt;
31386     &lt;xsl:otherwise&gt;
31387       &lt;xsl:value-of select="$count"&gt;&lt;/xsl:value-of&gt;
31388     &lt;/xsl:otherwise&gt;
31389   &lt;/xsl:choose&gt;
31390 &lt;/xsl:template&gt;
31391 </programlisting>
31392
31393 </refsect1>
31394 </refentry>
31395
31396
31397
31398 <refentry id="trim.common.uri.paths">
31399 <refnamediv>
31400 <refname>trim.common.uri.paths</refname>
31401 <refpurpose>Trim common leading path components from a relative URI</refpurpose>
31402 </refnamediv>
31403
31404 <refsect1><title>Description</title>
31405
31406 <para>This function trims common leading path components from a relative URI.</para>
31407
31408 <programlisting id="trim.common.uri.paths.frag">
31409 &lt;xsl:template name="trim.common.uri.paths"&gt;
31410   &lt;xsl:param name="uriA" select="''"&gt;&lt;/xsl:param&gt;
31411   &lt;xsl:param name="uriB" select="''"&gt;&lt;/xsl:param&gt;
31412   &lt;xsl:param name="return" select="'A'"&gt;&lt;/xsl:param&gt;
31413
31414   &lt;xsl:choose&gt;
31415     &lt;xsl:when test="contains($uriA, '/') and contains($uriB, '/')                     and substring-before($uriA, '/') = substring-before($uriB, '/')"&gt;
31416       &lt;xsl:call-template name="trim.common.uri.paths"&gt;
31417         &lt;xsl:with-param name="uriA" select="substring-after($uriA, '/')"&gt;&lt;/xsl:with-param&gt;
31418         &lt;xsl:with-param name="uriB" select="substring-after($uriB, '/')"&gt;&lt;/xsl:with-param&gt;
31419         &lt;xsl:with-param name="return" select="$return"&gt;&lt;/xsl:with-param&gt;
31420       &lt;/xsl:call-template&gt;
31421     &lt;/xsl:when&gt;
31422     &lt;xsl:otherwise&gt;
31423       &lt;xsl:choose&gt;
31424         &lt;xsl:when test="$return = 'A'"&gt;
31425           &lt;xsl:value-of select="$uriA"&gt;&lt;/xsl:value-of&gt;
31426         &lt;/xsl:when&gt;
31427         &lt;xsl:otherwise&gt;
31428           &lt;xsl:value-of select="$uriB"&gt;&lt;/xsl:value-of&gt;
31429         &lt;/xsl:otherwise&gt;
31430       &lt;/xsl:choose&gt;
31431     &lt;/xsl:otherwise&gt;
31432   &lt;/xsl:choose&gt;
31433 &lt;/xsl:template&gt;
31434 </programlisting>
31435
31436 </refsect1>
31437 </refentry>
31438
31439 </reference>
31440     </part>
31441     <part id="common-part"><title>Common&#160;Template&#160;Reference</title>
31442       <?dbhtml dir="common"?>
31443       <?dbhtml filename="index.html"?>
31444       <info>
31445         <abstract>
31446           <para>This is technical reference documentation for the
31447             &#8220;base&#8221;, &#8220;refentry&#8221;, and &#8220;utility&#8221; sets of common
31448             templates in the DocBook XSL Stylesheets. These
31449             templates are &#8220;common&#8221; in that they are shared across
31450             output formats (that is, they&#8217;re not
31451             output-format-dependent)</para>
31452           <para>This documentation is not intended to be user
31453             documentation. It is provided for developers writing
31454             customization layers for the stylesheets.</para>
31455         </abstract>
31456       </info>
31457         <reference id="base" xml:base="../common/common.xml">
31458   <info>
31459     <title>Common &#187; Base Template Reference</title>
31460     <releaseinfo role="meta">
31461       $Id: common.xsl 8784 2010-07-28 12:32:54Z mzjn $
31462     </releaseinfo>
31463   </info>
31464   
31465   <partintro id="partintro">
31466     <title>Introduction</title>
31467     
31468 <para>This is technical reference documentation for the &#8220;base&#8221;
31469       set of common templates in the DocBook XSL Stylesheets.</para>
31470
31471     
31472 <para>This is not intended to be user documentation. It is
31473       provided for developers writing customization layers for the
31474       stylesheets.</para>
31475
31476   </partintro>
31477
31478 <refentry id="template.is.component">
31479 <refnamediv>
31480 <refname>is.component</refname>
31481 <refpurpose>Tests if a given node is a component-level element</refpurpose>
31482 </refnamediv>
31483 <refsynopsisdiv>
31484 <synopsis>&lt;xsl:template name="is.component"&gt;
31485 &lt;xsl:param name="node" select="."/&gt;
31486   ...
31487 &lt;/xsl:template&gt;</synopsis>
31488 </refsynopsisdiv>
31489 <refsect1><title>Description</title>
31490
31491 <para>This template returns '1' if the specified node is a component
31492 (Chapter, Appendix, etc.), and '0' otherwise.</para>
31493
31494 </refsect1><refsect1><title>Parameters</title>
31495
31496 <variablelist>
31497 <varlistentry><term>node</term>
31498 <listitem>
31499
31500 <para>The node which is to be tested.</para>
31501
31502 </listitem>
31503 </varlistentry>
31504 </variablelist>
31505
31506 </refsect1><refsect1><title>Returns</title>
31507
31508 <para>This template returns '1' if the specified node is a component
31509 (Chapter, Appendix, etc.), and '0' otherwise.</para>
31510
31511 </refsect1></refentry>
31512
31513 <refentry id="template.is.section">
31514 <refnamediv>
31515 <refname>is.section</refname>
31516 <refpurpose>Tests if a given node is a section-level element</refpurpose>
31517 </refnamediv>
31518 <refsynopsisdiv>
31519 <synopsis>&lt;xsl:template name="is.section"&gt;
31520 &lt;xsl:param name="node" select="."/&gt;
31521   ...
31522 &lt;/xsl:template&gt;</synopsis>
31523 </refsynopsisdiv>
31524 <refsect1><title>Description</title>
31525
31526 <para>This template returns '1' if the specified node is a section
31527 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
31528
31529 </refsect1><refsect1><title>Parameters</title>
31530
31531 <variablelist>
31532 <varlistentry><term>node</term>
31533 <listitem>
31534
31535 <para>The node which is to be tested.</para>
31536
31537 </listitem>
31538 </varlistentry>
31539 </variablelist>
31540
31541 </refsect1><refsect1><title>Returns</title>
31542
31543 <para>This template returns '1' if the specified node is a section
31544 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
31545
31546 </refsect1></refentry>
31547
31548 <refentry id="template.section.level">
31549 <refnamediv>
31550 <refname>section.level</refname>
31551 <refpurpose>Returns the hierarchical level of a section</refpurpose>
31552 </refnamediv>
31553 <refsynopsisdiv>
31554 <synopsis>&lt;xsl:template name="section.level"&gt;
31555 &lt;xsl:param name="node" select="."/&gt;
31556   ...
31557 &lt;/xsl:template&gt;</synopsis>
31558 </refsynopsisdiv>
31559 <refsect1><title>Description</title>
31560
31561 <para>This template calculates the hierarchical level of a section.
31562 The element <tag>sect1</tag> is at level 1, <tag>sect2</tag> is
31563 at level 2, etc.</para>
31564
31565
31566
31567 <para>Recursive sections are calculated down to the fifth level.</para>
31568
31569 </refsect1><refsect1><title>Parameters</title>
31570
31571 <variablelist>
31572 <varlistentry><term>node</term>
31573 <listitem>
31574
31575 <para>The section node for which the level should be calculated.
31576 Defaults to the context node.</para>
31577
31578 </listitem>
31579 </varlistentry>
31580 </variablelist>
31581
31582 </refsect1><refsect1><title>Returns</title>
31583
31584 <para>The section level, <quote>1</quote>, <quote>2</quote>, etc.
31585 </para>
31586
31587 </refsect1></refentry>
31588
31589 <refentry id="template.qanda.section.level">
31590 <refnamediv>
31591 <refname>qanda.section.level</refname>
31592 <refpurpose>Returns the hierarchical level of a QandASet</refpurpose>
31593 </refnamediv>
31594 <refsynopsisdiv>
31595 <synopsis>&lt;xsl:template name="qanda.section.level"/&gt;</synopsis>
31596 </refsynopsisdiv>
31597 <refsect1><title>Description</title>
31598
31599 <para>This template calculates the hierarchical level of a QandASet.
31600 </para>
31601
31602 </refsect1><refsect1><title>Returns</title>
31603
31604 <para>The level, <quote>1</quote>, <quote>2</quote>, etc.
31605 </para>
31606
31607 </refsect1></refentry>
31608
31609 <refentry id="template.select.mediaobject">
31610 <refnamediv>
31611 <refname>select.mediaobject</refname>
31612 <refpurpose>Selects and processes an appropriate media object from a list</refpurpose>
31613 </refnamediv>
31614 <refsynopsisdiv>
31615 <synopsis>&lt;xsl:template name="select.mediaobject"&gt;
31616 &lt;xsl:param name="olist" select="imageobject|imageobjectco                      |videoobject|audioobject|textobject"/&gt;
31617   ...
31618 &lt;/xsl:template&gt;</synopsis>
31619 </refsynopsisdiv>
31620 <refsect1><title>Description</title>
31621
31622 <para>This template takes a list of media objects (usually the
31623 children of a mediaobject or inlinemediaobject) and processes
31624 the "right" object.</para>
31625
31626
31627
31628 <para>This template relies on a template named 
31629 "select.mediaobject.index" to determine which object
31630 in the list is appropriate.</para>
31631
31632
31633
31634 <para>If no acceptable object is located, nothing happens.</para>
31635
31636 </refsect1><refsect1><title>Parameters</title>
31637
31638 <variablelist>
31639 <varlistentry><term>olist</term>
31640 <listitem>
31641
31642 <para>The node list of potential objects to examine.</para>
31643
31644 </listitem>
31645 </varlistentry>
31646 </variablelist>
31647
31648 </refsect1><refsect1><title>Returns</title>
31649
31650 <para>Calls &lt;xsl:apply-templates&gt; on the selected object.</para>
31651
31652 </refsect1></refentry>
31653
31654 <refentry id="template.select.mediaobject.index">
31655 <refnamediv>
31656 <refname>select.mediaobject.index</refname>
31657 <refpurpose>Selects the position of the appropriate media object from a list</refpurpose>
31658 </refnamediv>
31659 <refsynopsisdiv>
31660 <synopsis>&lt;xsl:template name="select.mediaobject.index"&gt;
31661 &lt;xsl:param name="olist" select="imageobject|imageobjectco                      |videoobject|audioobject|textobject"/&gt;
31662 &lt;xsl:param name="count"&gt;1&lt;/xsl:param&gt;
31663   ...
31664 &lt;/xsl:template&gt;</synopsis>
31665 </refsynopsisdiv>
31666 <refsect1><title>Description</title>
31667
31668 <para>This template takes a list of media objects (usually the
31669 children of a mediaobject or inlinemediaobject) and determines
31670 the "right" object. It returns the position of that object
31671 to be used by the calling template.</para>
31672
31673
31674
31675 <para>If the parameter <parameter>use.role.for.mediaobject</parameter>
31676 is nonzero, then it first checks for an object with
31677 a role attribute of the appropriate value.  It takes the first
31678 of those.  Otherwise, it takes the first acceptable object
31679 through a recursive pass through the list.</para>
31680
31681
31682
31683 <para>This template relies on a template named "is.acceptable.mediaobject"
31684 to determine if a given object is an acceptable graphic. The semantics
31685 of media objects is that the first acceptable graphic should be used.
31686 </para>
31687
31688
31689
31690 <para>If no acceptable object is located, no index is returned.</para>
31691
31692 </refsect1><refsect1><title>Parameters</title>
31693
31694 <variablelist>
31695 <varlistentry><term>olist</term>
31696 <listitem>
31697
31698 <para>The node list of potential objects to examine.</para>
31699
31700 </listitem>
31701 </varlistentry>
31702 <varlistentry><term>count</term>
31703 <listitem>
31704
31705 <para>The position in the list currently being considered by the 
31706 recursive process.</para>
31707
31708 </listitem>
31709 </varlistentry>
31710 </variablelist>
31711
31712 </refsect1><refsect1><title>Returns</title>
31713
31714 <para>Returns the position in the original list of the selected object.</para>
31715
31716 </refsect1></refentry>
31717
31718 <refentry id="template.is.acceptable.mediaobject">
31719 <refnamediv>
31720 <refname>is.acceptable.mediaobject</refname>
31721 <refpurpose>Returns '1' if the specified media object is recognized</refpurpose>
31722 </refnamediv>
31723 <refsynopsisdiv>
31724 <synopsis>&lt;xsl:template name="is.acceptable.mediaobject"&gt;
31725 &lt;xsl:param name="object"/&gt;
31726   ...
31727 &lt;/xsl:template&gt;</synopsis>
31728 </refsynopsisdiv>
31729 <refsect1><title>Description</title>
31730
31731 <para>This template examines a media object and returns '1' if the
31732 object is recognized as a graphic.</para>
31733
31734 </refsect1><refsect1><title>Parameters</title>
31735
31736 <variablelist>
31737 <varlistentry><term>object</term>
31738 <listitem>
31739
31740 <para>The media object to consider.</para>
31741
31742 </listitem>
31743 </varlistentry>
31744 </variablelist>
31745
31746 </refsect1><refsect1><title>Returns</title>
31747
31748 <para>0 or 1</para>
31749
31750 </refsect1></refentry>
31751
31752 <refentry id="template.check.id.unique">
31753 <refnamediv>
31754 <refname>check.id.unique</refname>
31755 <refpurpose>Warn users about references to non-unique IDs</refpurpose>
31756 </refnamediv>
31757 <refsynopsisdiv>
31758 <synopsis>&lt;xsl:template name="check.id.unique"&gt;
31759 &lt;xsl:param name="linkend"/&gt;
31760   ...
31761 &lt;/xsl:template&gt;</synopsis>
31762 </refsynopsisdiv>
31763 <refsect1><title>Description</title>
31764
31765 <para>If passed an ID in <varname>linkend</varname>,
31766 <function>check.id.unique</function> prints
31767 a warning message to the user if either the ID does not exist or
31768 the ID is not unique.</para>
31769
31770 </refsect1></refentry>
31771
31772 <refentry id="template.check.idref.targets">
31773 <refnamediv>
31774 <refname>check.idref.targets</refname>
31775 <refpurpose>Warn users about incorrectly typed references</refpurpose>
31776 </refnamediv>
31777 <refsynopsisdiv>
31778 <synopsis>&lt;xsl:template name="check.idref.targets"&gt;
31779 &lt;xsl:param name="linkend"/&gt;
31780 &lt;xsl:param name="element-list"/&gt;
31781   ...
31782 &lt;/xsl:template&gt;</synopsis>
31783 </refsynopsisdiv>
31784 <refsect1><title>Description</title>
31785
31786 <para>If passed an ID in <varname>linkend</varname>,
31787 <function>check.idref.targets</function> makes sure that the element
31788 pointed to by the link is one of the elements listed in
31789 <varname>element-list</varname> and warns the user otherwise.</para>
31790
31791 </refsect1></refentry>
31792
31793 <refentry id="template.copyright.years">
31794 <refnamediv>
31795 <refname>copyright.years</refname>
31796 <refpurpose>Print a set of years with collapsed ranges</refpurpose>
31797 </refnamediv>
31798 <refsynopsisdiv>
31799 <synopsis>&lt;xsl:template name="copyright.years"&gt;
31800 &lt;xsl:param name="years"/&gt;
31801 &lt;xsl:param name="print.ranges" select="1"/&gt;
31802 &lt;xsl:param name="single.year.ranges" select="0"/&gt;
31803 &lt;xsl:param name="firstyear" select="0"/&gt;
31804 &lt;xsl:param name="nextyear" select="0"/&gt;
31805   ...
31806 &lt;/xsl:template&gt;</synopsis>
31807 </refsynopsisdiv>
31808 <refsect1><title>Description</title>
31809
31810 <para>This template prints a list of year elements with consecutive
31811 years printed as a range. In other words:</para>
31812
31813
31814 <screen>&lt;year&gt;1992&lt;/year&gt;
31815 &lt;year&gt;1993&lt;/year&gt;
31816 &lt;year&gt;1994&lt;/year&gt;</screen>
31817
31818
31819 <para>is printed <quote>1992-1994</quote>, whereas:</para>
31820
31821
31822 <screen>&lt;year&gt;1992&lt;/year&gt;
31823 &lt;year&gt;1994&lt;/year&gt;</screen>
31824
31825
31826 <para>is printed <quote>1992, 1994</quote>.</para>
31827
31828
31829
31830 <para>This template assumes that all the year elements contain only
31831 decimal year numbers, that the elements are sorted in increasing
31832 numerical order, that there are no duplicates, and that all the years
31833 are expressed in full <quote>century+year</quote>
31834 (<quote>1999</quote> not <quote>99</quote>) notation.</para>
31835
31836 </refsect1><refsect1><title>Parameters</title>
31837
31838 <variablelist>
31839 <varlistentry><term>years</term>
31840 <listitem>
31841
31842 <para>The initial set of year elements.</para>
31843
31844 </listitem>
31845 </varlistentry>
31846 <varlistentry><term>print.ranges</term>
31847 <listitem>
31848
31849 <para>If non-zero, multi-year ranges are collapsed. If zero, all years
31850 are printed discretely.</para>
31851
31852 </listitem>
31853 </varlistentry>
31854 <varlistentry><term>single.year.ranges</term>
31855 <listitem>
31856
31857 <para>If non-zero, two consecutive years will be printed as a range,
31858 otherwise, they will be printed discretely. In other words, a single
31859 year range is <quote>1991-1992</quote> but discretely it's
31860 <quote>1991, 1992</quote>.</para>
31861
31862 </listitem>
31863 </varlistentry>
31864 </variablelist>
31865
31866 </refsect1><refsect1><title>Returns</title>
31867
31868 <para>This template returns the formatted list of years.</para>
31869
31870 </refsect1></refentry>
31871
31872 <refentry id="template.find.path.params">
31873 <refnamediv>
31874 <refname>find.path.params</refname>
31875 <refpurpose>Search in a table for the "best" match for the node</refpurpose>
31876 </refnamediv>
31877 <refsynopsisdiv>
31878 <synopsis>&lt;xsl:template name="find.path.params"&gt;
31879 &lt;xsl:param name="node" select="."/&gt;
31880 &lt;xsl:param name="table" select="''"/&gt;
31881 &lt;xsl:param name="location"&gt;
31882     &lt;xsl:call-template name="xpath.location"&gt;
31883       &lt;xsl:with-param name="node" select="$node"/&gt;
31884     &lt;/xsl:call-template&gt;
31885   &lt;/xsl:param&gt;
31886   ...
31887 &lt;/xsl:template&gt;</synopsis>
31888 </refsynopsisdiv>
31889 <refsect1><title>Description</title>
31890
31891 <para>This template searches in a table for the value that most-closely
31892 (in the typical best-match sense of XSLT) matches the current (element)
31893 node location.</para>
31894
31895 </refsect1></refentry>
31896
31897 <refentry id="template.string.upper">
31898 <refnamediv>
31899 <refname>string.upper</refname>
31900 <refpurpose>Converts a string to all uppercase letters</refpurpose>
31901 </refnamediv>
31902 <refsynopsisdiv>
31903 <synopsis>&lt;xsl:template name="string.upper"&gt;
31904 &lt;xsl:param name="string" select="''"/&gt;
31905   ...
31906 &lt;/xsl:template&gt;</synopsis>
31907 </refsynopsisdiv>
31908 <refsect1><title>Description</title>
31909
31910 <para>Given a string, this template does a language-aware conversion
31911 of that string to all uppercase letters, based on the values of the
31912 <literal>lowercase.alpha</literal> and
31913 <literal>uppercase.alpha</literal> gentext keys for the current
31914 locale. It affects only those characters found in the values of
31915 <literal>lowercase.alpha</literal> and
31916 <literal>uppercase.alpha</literal>. All other characters are left
31917 unchanged.</para>
31918
31919 </refsect1><refsect1><title>Parameters</title>
31920
31921 <variablelist>
31922 <varlistentry><term>string</term>
31923 <listitem>
31924
31925 <para>The string to convert to uppercase.</para>
31926
31927 </listitem>
31928 </varlistentry>
31929 </variablelist>
31930
31931 </refsect1></refentry>
31932
31933 <refentry id="template.string.lower">
31934 <refnamediv>
31935 <refname>string.lower</refname>
31936 <refpurpose>Converts a string to all lowercase letters</refpurpose>
31937 </refnamediv>
31938 <refsynopsisdiv>
31939 <synopsis>&lt;xsl:template name="string.lower"&gt;
31940 &lt;xsl:param name="string" select="''"/&gt;
31941   ...
31942 &lt;/xsl:template&gt;</synopsis>
31943 </refsynopsisdiv>
31944 <refsect1><title>Description</title>
31945
31946 <para>Given a string, this template does a language-aware conversion
31947 of that string to all lowercase letters, based on the values of the
31948 <literal>uppercase.alpha</literal> and
31949 <literal>lowercase.alpha</literal> gentext keys for the current
31950 locale. It affects only those characters found in the values of
31951 <literal>uppercase.alpha</literal> and
31952 <literal>lowercase.alpha</literal>. All other characters are left
31953 unchanged.</para>
31954
31955 </refsect1><refsect1><title>Parameters</title>
31956
31957 <variablelist>
31958 <varlistentry><term>string</term>
31959 <listitem>
31960
31961 <para>The string to convert to lowercase.</para>
31962
31963 </listitem>
31964 </varlistentry>
31965 </variablelist>
31966
31967 </refsect1></refentry>
31968
31969 <refentry id="template.select.choice.separator">
31970 <refnamediv>
31971 <refname>select.choice.separator</refname>
31972 <refpurpose>Returns localized choice separator</refpurpose>
31973 </refnamediv>
31974 <refsynopsisdiv>
31975 <synopsis>&lt;xsl:template name="select.choice.separator"/&gt;</synopsis>
31976 </refsynopsisdiv>
31977 <refsect1><title>Description</title>
31978     
31979 <para>This template enables auto-generation of an appropriate
31980     localized "choice" separator (for example, "and" or "or") before
31981     the final item in an inline list (though it could also be useful
31982     for generating choice separators for non-inline lists).</para>
31983
31984     
31985 <para>It currently works by evaluating a processing instruction
31986     (PI) of the form &lt;?dbchoice&#160;choice="foo"?&gt; :
31987     
31988 <itemizedlist>
31989       <listitem>
31990         <simpara>if the value of the <tag>choice</tag>
31991         pseudo-attribute is "and" or "or", returns a localized "and"
31992         or "or"</simpara>
31993       </listitem>
31994       <listitem>
31995         <simpara>otherwise returns the literal value of the
31996         <tag>choice</tag> pseudo-attribute</simpara>
31997       </listitem>
31998     </itemizedlist>
31999
32000     The latter is provided only as a temporary workaround because the
32001     locale files do not currently have translations for the word
32002     <wordasword>or</wordasword>. So if you want to generate a a
32003     logical "or" separator in French (for example), you currently need
32004     to do this:
32005     <literallayout>&lt;?dbchoice choice="ou"?&gt;</literallayout>
32006     </para>
32007
32008     <warning>
32009       
32010 <para>The <tag>dbchoice</tag> processing instruction is
32011       an unfortunate hack; support for it may disappear in the future
32012       (particularly if and when a more appropriate means for marking
32013       up "choice" lists becomes available in DocBook).</para>
32014
32015     </warning>
32016   </refsect1></refentry>
32017
32018 <refentry id="template.evaluate.info.profile">
32019 <refnamediv>
32020 <refname>evaluate.info.profile</refname>
32021 <refpurpose>Evaluates an info profile</refpurpose>
32022 </refnamediv>
32023 <refsynopsisdiv>
32024 <synopsis>&lt;xsl:template name="evaluate.info.profile"&gt;
32025 &lt;xsl:param name="profile"/&gt;
32026 &lt;xsl:param name="info"/&gt;
32027   ...
32028 &lt;/xsl:template&gt;</synopsis>
32029 </refsynopsisdiv>
32030 <refsect1><title>Description</title>
32031     
32032 <para>This template evaluates an "info profile" matching the XPath
32033     expression given by the <parameter>profile</parameter>
32034     parameter. It relies on the XSLT <function>evaluate()</function>
32035     extension function.</para>
32036
32037
32038     
32039 <para>The value of the <parameter>profile</parameter> parameter
32040     can include the literal string <literal>$info</literal>. If found
32041     in the value of the <parameter>profile</parameter> parameter, the
32042     literal string <literal>$info</literal> string is replaced with
32043     the value of the <parameter>info</parameter> parameter, which
32044     should be a set of <replaceable>*info</replaceable> nodes; the
32045     expression is then evaluated using the XSLT
32046     <function>evaluate()</function> extension function.</para>
32047
32048   </refsect1><refsect1><title>Parameters</title>
32049     
32050 <variablelist>
32051        <varlistentry>
32052         <term>profile</term>
32053         <listitem>
32054           
32055 <para>A string representing an XPath expression </para>
32056
32057         </listitem>
32058       </varlistentry>
32059        <varlistentry>
32060         <term>info</term>
32061         <listitem>
32062           
32063 <para>A set of *info nodes</para>
32064
32065         </listitem>
32066       </varlistentry>
32067     </variablelist>
32068
32069   </refsect1><refsect1><title>Returns</title>
32070     
32071 <para>Returns a node (the result of evaluating the
32072     <parameter>profile</parameter> parameter)</para>
32073
32074   </refsect1></refentry>
32075 </reference>
32076         <reference id="refentry" xml:base="../common/refentry.xml">
32077   <info>
32078     <title>Common &#187; Refentry Metadata Template Reference</title>
32079     <releaseinfo role="meta">
32080       $Id: refentry.xsl 7867 2008-03-07 09:54:25Z xmldoc $
32081     </releaseinfo>
32082   </info>
32083   
32084   <partintro id="partintro">
32085     <title>Introduction</title>
32086     
32087 <para>This is technical reference documentation for the &#8220;refentry
32088     metadata&#8221; templates in the DocBook XSL Stylesheets.</para>
32089
32090     
32091 <para>This is not intended to be user documentation. It is provided
32092     for developers writing customization layers for the stylesheets.</para>
32093
32094     <note>
32095       
32096 <para>Currently, only the manpages stylesheets make use of these
32097       templates. They are, however, potentially useful elsewhere.</para>
32098
32099     </note>
32100   </partintro>
32101
32102 <refentry id="template.get.refentry.metadata">
32103 <refnamediv>
32104 <refname>get.refentry.metadata</refname>
32105 <refpurpose>Gathers metadata from a refentry and its ancestors</refpurpose>
32106 </refnamediv>
32107 <refsynopsisdiv>
32108 <synopsis>&lt;xsl:template name="get.refentry.metadata"&gt;
32109 &lt;xsl:param name="refname"/&gt;
32110 &lt;xsl:param name="info"/&gt;
32111 &lt;xsl:param name="prefs"/&gt;
32112   ...
32113 &lt;/xsl:template&gt;</synopsis>
32114 </refsynopsisdiv>
32115 <refsect1><title>Description</title>
32116     
32117 <para>Reference documentation for particular commands, functions,
32118     etc., is sometimes viewed in isolation from its greater "context". For
32119     example, users view Unix man pages as, well, individual pages, not as
32120     part of a "book" of some kind. Therefore, it is sometimes necessary to
32121     embed "context" information in output for each <tag>refentry</tag>.</para>
32122
32123
32124     
32125 <para>However, one problem is that different users mark up that
32126     context information in different ways. Often (usually), the
32127     context information is not actually part of the content of the
32128     <tag>refentry</tag> itself, but instead part of the content of a
32129     parent or ancestor element to the <tag>refentry</tag>. And
32130     even then, DocBook provides a variety of elements that users might
32131     potentially use to mark up the same kind of information. One user
32132     might use the <tag>productnumber</tag> element to mark up version
32133     information about a particular product, while another might use
32134     the <tag>releaseinfo</tag> element.</para>
32135
32136
32137     
32138 <para>Taking all that in mind, the
32139     <function>get.refentry.metadata</function> template tries to gather
32140     metadata from a <tag>refentry</tag> element and its ancestor
32141     elements in an intelligent and user-configurable way. The basic
32142     mechanism used in the XPath expressions throughout this stylesheet
32143     is to select the relevant metadata from the *info element that is
32144     closest to the actual <tag>refentry</tag>&#160;&#8211; either on the
32145     <tag>refentry</tag> itself, or on its nearest ancestor.</para>
32146
32147
32148     <note>
32149       
32150 <para>The <function>get.refentry.metadata</function>
32151         template is actually just sort of a "driver" template; it
32152         calls other templates that do the actual data collection,
32153         then returns the data as a set.</para>
32154
32155     </note>
32156
32157   </refsect1><refsect1><title>Parameters</title>
32158     
32159 <variablelist>
32160       <varlistentry>
32161         <term>refname</term>
32162         <listitem>
32163           
32164 <para>The first <tag>refname</tag> in the refentry</para>
32165
32166         </listitem>
32167       </varlistentry>
32168       <varlistentry>
32169         <term>info</term>
32170         <listitem>
32171           
32172 <para>A set of info nodes (from a <tag>refentry</tag>
32173           element and its ancestors)</para>
32174
32175         </listitem>
32176       </varlistentry>
32177       <varlistentry>
32178         <term>prefs</term>
32179         <listitem>
32180           
32181 <para>A node containing user preferences (from global
32182           stylesheet parameters)</para>
32183
32184         </listitem>
32185       </varlistentry>
32186     </variablelist>
32187
32188   </refsect1><refsect1><title>Returns</title>
32189     
32190 <para>Returns a node set with the following elements. The
32191     descriptions are verbatim from the <literal>man(7)</literal> man
32192     page.
32193     
32194 <variablelist>
32195       <varlistentry>
32196         <term>title</term>
32197         <listitem>
32198           
32199 <para>the title of the man page (e.g., <literal>MAN</literal>)</para>
32200
32201         </listitem>
32202       </varlistentry>
32203       <varlistentry>
32204         <term>section</term>
32205         <listitem>
32206           
32207 <para>the section number the man page should be placed in (e.g.,
32208           <literal>7</literal>)</para>
32209
32210         </listitem>
32211       </varlistentry>
32212       <varlistentry>
32213         <term>date</term>
32214         <listitem>
32215           
32216 <para>the date of the last revision</para>
32217
32218         </listitem>
32219       </varlistentry>
32220       <varlistentry>
32221         <term>source</term>
32222         <listitem>
32223           
32224 <para>the source of the command</para>
32225
32226         </listitem>
32227       </varlistentry>
32228       <varlistentry>
32229         <term>manual</term>
32230         <listitem>
32231           
32232 <para>the title of the manual (e.g., <citetitle>Linux
32233           Programmer's Manual</citetitle>)</para>
32234
32235         </listitem>
32236       </varlistentry>
32237     </variablelist>
32238
32239     </para>
32240
32241   </refsect1></refentry>
32242
32243 <refentry id="template.get.refentry.title">
32244 <refnamediv>
32245 <refname>get.refentry.title</refname>
32246 <refpurpose>Gets title metadata for a refentry</refpurpose>
32247 </refnamediv>
32248 <refsynopsisdiv>
32249 <synopsis>&lt;xsl:template name="get.refentry.title"&gt;
32250 &lt;xsl:param name="refname"/&gt;
32251   ...
32252 &lt;/xsl:template&gt;</synopsis>
32253 </refsynopsisdiv>
32254 <refsect1><title>Description</title>
32255     
32256 <para>The <literal>man(7)</literal> man page describes this as "the
32257     title of the man page (e.g., <literal>MAN</literal>). This differs
32258     from <tag>refname</tag> in that, if the <tag>refentry</tag> has a
32259     <tag>refentrytitle</tag>, we use that as the <tag>title</tag>;
32260     otherwise, we just use first <tag>refname</tag> in the first
32261     <tag>refnamediv</tag> in the source.</para>
32262
32263   </refsect1><refsect1><title>Parameters</title>
32264     
32265 <variablelist>
32266       <varlistentry>
32267         <term>refname</term>
32268         <listitem>
32269           
32270 <para>The first <tag>refname</tag> in the refentry</para>
32271
32272         </listitem>
32273       </varlistentry>
32274     </variablelist>
32275
32276   </refsect1><refsect1><title>Returns</title>
32277   
32278 <para>Returns a <tag>title</tag> node.</para>
32279 </refsect1></refentry>
32280
32281 <refentry id="template.get.refentry.section">
32282 <refnamediv>
32283 <refname>get.refentry.section</refname>
32284 <refpurpose>Gets section metadata for a refentry</refpurpose>
32285 </refnamediv>
32286 <refsynopsisdiv>
32287 <synopsis>&lt;xsl:template name="get.refentry.section"&gt;
32288 &lt;xsl:param name="refname"/&gt;
32289 &lt;xsl:param name="quiet" select="0"/&gt;
32290   ...
32291 &lt;/xsl:template&gt;</synopsis>
32292 </refsynopsisdiv>
32293 <refsect1><title>Description</title>
32294     
32295 <para>The <literal>man(7)</literal> man page describes this as "the
32296     section number the man page should be placed in (e.g.,
32297     <literal>7</literal>)". If we do not find a <tag>manvolnum</tag>
32298     specified in the source, and we find that the <tag>refentry</tag> is
32299     for a function, we use the section number <literal>3</literal>
32300     ["Library calls (functions within program libraries)"]; otherwise, we
32301     default to using <literal>1</literal> ["Executable programs or shell
32302     commands"].</para>
32303
32304   </refsect1><refsect1><title>Parameters</title>
32305     
32306 <variablelist>
32307       <varlistentry>
32308         <term>refname</term>
32309         <listitem>
32310           
32311 <para>The first <tag>refname</tag> in the refentry</para>
32312
32313         </listitem>
32314       </varlistentry>
32315       <varlistentry>
32316         <term>quiet</term>
32317         <listitem>
32318           
32319 <para>If non-zero, no "missing" message is emitted</para>
32320
32321         </listitem>
32322       </varlistentry>
32323     </variablelist>
32324
32325   </refsect1><refsect1><title>Returns</title>
32326   
32327 <para>Returns a string representing a section number.</para>
32328 </refsect1></refentry>
32329
32330 <refentry id="template.get.refentry.date">
32331 <refnamediv>
32332 <refname>get.refentry.date</refname>
32333 <refpurpose>Gets date metadata for a refentry</refpurpose>
32334 </refnamediv>
32335 <refsynopsisdiv>
32336 <synopsis>&lt;xsl:template name="get.refentry.date"&gt;
32337 &lt;xsl:param name="refname"/&gt;
32338 &lt;xsl:param name="info"/&gt;
32339 &lt;xsl:param name="prefs"/&gt;
32340   ...
32341 &lt;/xsl:template&gt;</synopsis>
32342 </refsynopsisdiv>
32343 <refsect1><title>Description</title>
32344     
32345 <para>The <literal>man(7)</literal> man page describes this as "the
32346     date of the last revision". If we cannot find a date in the source, we
32347     generate one.</para>
32348
32349   </refsect1><refsect1><title>Parameters</title>
32350     
32351 <variablelist>
32352       <varlistentry>
32353         <term>refname</term>
32354         <listitem>
32355           
32356 <para>The first <tag>refname</tag> in the refentry</para>
32357
32358         </listitem>
32359       </varlistentry>
32360       <varlistentry>
32361         <term>info</term>
32362         <listitem>
32363           
32364 <para>A set of info nodes (from a <tag>refentry</tag>
32365           element and its ancestors)</para>
32366
32367         </listitem>
32368       </varlistentry>
32369       <varlistentry>
32370         <term>prefs</term>
32371         <listitem>
32372           
32373 <para>A node containing users preferences (from global stylesheet parameters)</para>
32374
32375         </listitem>
32376       </varlistentry>
32377     </variablelist>
32378
32379   </refsect1><refsect1><title>Returns</title>
32380     
32381 <para>Returns a <tag>date</tag> node.</para>
32382
32383   </refsect1></refentry>
32384
32385 <refentry id="template.get.refentry.source">
32386 <refnamediv>
32387 <refname>get.refentry.source</refname>
32388 <refpurpose>Gets source metadata for a refentry</refpurpose>
32389 </refnamediv>
32390 <refsynopsisdiv>
32391 <synopsis>&lt;xsl:template name="get.refentry.source"&gt;
32392 &lt;xsl:param name="refname"/&gt;
32393 &lt;xsl:param name="info"/&gt;
32394 &lt;xsl:param name="prefs"/&gt;
32395   ...
32396 &lt;/xsl:template&gt;</synopsis>
32397 </refsynopsisdiv>
32398 <refsect1><title>Description</title>
32399     
32400 <para>The <literal>man(7)</literal> man page describes this as "the
32401     source of the command", and provides the following examples:
32402     
32403 <itemizedlist>
32404       <listitem>
32405         
32406 <para>For binaries, use something like: GNU, NET-2, SLS
32407         Distribution, MCC Distribution.</para>
32408
32409       </listitem>
32410       <listitem>
32411         
32412 <para>For system calls, use the version of the kernel that you are
32413         currently looking at: Linux 0.99.11.</para>
32414
32415       </listitem>
32416       <listitem>
32417         
32418 <para>For library calls, use the source of the function: GNU, BSD
32419         4.3, Linux DLL 4.4.1.</para>
32420
32421       </listitem>
32422     </itemizedlist>
32423
32424     </para>
32425
32426
32427     
32428 <para>The <literal>solbook(5)</literal> man page describes
32429     something very much like what <literal>man(7)</literal> calls
32430     "source", except that <literal>solbook(5)</literal> names it
32431     "software" and describes it like this:
32432     <blockquote>
32433       
32434 <para>This is the name of the software product that the topic
32435       discussed on the reference page belongs to. For example UNIX
32436       commands are part of the <literal>SunOS x.x</literal>
32437       release.</para>
32438
32439     </blockquote>
32440     </para>
32441
32442
32443     
32444 <para>In practice, there are many pages that simply have a version
32445     number in the "source" field. So, it looks like what we have is a
32446     two-part field,
32447     <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>,
32448     where:
32449     
32450 <variablelist>
32451       <varlistentry>
32452         <term>Name</term>
32453         <listitem>
32454           
32455 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
32456
32457         </listitem>
32458       </varlistentry>
32459       <varlistentry>
32460         <term>Version</term>
32461         <listitem>
32462           
32463 <para>version name</para>
32464
32465         </listitem>
32466       </varlistentry>
32467     </variablelist>
32468
32469     Each part is optional. If the <replaceable>Name</replaceable> is a
32470     product name, then the <replaceable>Version</replaceable> is probably
32471     the version of the product. Or there may be no
32472     <replaceable>Name</replaceable>, in which case, if there is a
32473     <replaceable>Version</replaceable>, it is probably the version of the
32474     item itself, not the product it is part of. Or, if the
32475     <replaceable>Name</replaceable> is an organization name, then there
32476     probably will be no <replaceable>Version</replaceable>.
32477     </para>
32478
32479   </refsect1><refsect1><title>Parameters</title>
32480     
32481 <variablelist>
32482       <varlistentry>
32483         <term>refname</term>
32484         <listitem>
32485           
32486 <para>The first <tag>refname</tag> in the refentry</para>
32487
32488         </listitem>
32489       </varlistentry>
32490       <varlistentry>
32491         <term>info</term>
32492         <listitem>
32493           
32494 <para>A set of info nodes (from a <tag>refentry</tag>
32495           element and its ancestors)</para>
32496
32497         </listitem>
32498       </varlistentry>
32499       <varlistentry>
32500         <term>prefs</term>
32501         <listitem>
32502           
32503 <para>A node containing users preferences (from global
32504           stylesheet parameters)</para>
32505
32506         </listitem>
32507       </varlistentry>
32508     </variablelist>
32509
32510   </refsect1><refsect1><title>Returns</title>
32511     
32512 <para>Returns a <tag>source</tag> node.</para>
32513
32514   </refsect1></refentry>
32515
32516 <refentry id="template.get.refentry.source.name">
32517 <refnamediv>
32518 <refname>get.refentry.source.name</refname>
32519 <refpurpose>Gets source-name metadata for a refentry</refpurpose>
32520 </refnamediv>
32521 <refsynopsisdiv>
32522 <synopsis>&lt;xsl:template name="get.refentry.source.name"&gt;
32523 &lt;xsl:param name="refname"/&gt;
32524 &lt;xsl:param name="info"/&gt;
32525 &lt;xsl:param name="prefs"/&gt;
32526   ...
32527 &lt;/xsl:template&gt;</synopsis>
32528 </refsynopsisdiv>
32529 <refsect1><title>Description</title>
32530     
32531 <para>A "source name" is one part of a (potentially) two-part
32532     <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>
32533     source field. For more details, see the documentation for the
32534     <function>get.refentry.source</function> template.</para>
32535
32536   </refsect1><refsect1><title>Parameters</title>
32537     
32538 <variablelist>
32539       <varlistentry>
32540         <term>refname</term>
32541         <listitem>
32542           
32543 <para>The first <tag>refname</tag> in the refentry</para>
32544
32545         </listitem>
32546       </varlistentry>
32547       <varlistentry>
32548         <term>info</term>
32549         <listitem>
32550           
32551 <para>A set of info nodes (from a <tag>refentry</tag>
32552           element and its ancestors)</para>
32553
32554         </listitem>
32555       </varlistentry>
32556       <varlistentry>
32557         <term>prefs</term>
32558         <listitem>
32559           
32560 <para>A node containing users preferences (from global
32561           stylesheet parameters)</para>
32562
32563         </listitem>
32564       </varlistentry>
32565     </variablelist>
32566
32567   </refsect1><refsect1><title>Returns</title>
32568     
32569 <para>Depending on what output method is used for the
32570   current stylesheet, either returns a text node or possibly an element
32571   node, containing "source name" data.</para>
32572
32573   </refsect1></refentry>
32574
32575 <refentry id="template.get.refentry.version">
32576 <refnamediv>
32577 <refname>get.refentry.version</refname>
32578 <refpurpose>Gets version metadata for a refentry</refpurpose>
32579 </refnamediv>
32580 <refsynopsisdiv>
32581 <synopsis>&lt;xsl:template name="get.refentry.version"&gt;
32582 &lt;xsl:param name="refname"/&gt;
32583 &lt;xsl:param name="info"/&gt;
32584 &lt;xsl:param name="prefs"/&gt;
32585   ...
32586 &lt;/xsl:template&gt;</synopsis>
32587 </refsynopsisdiv>
32588 <refsect1><title>Description</title>
32589     
32590 <para>A "version" is one part of a (potentially) two-part
32591     <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>
32592     source field. For more details, see the documentation for the
32593     <function>get.refentry.source</function> template.</para>
32594
32595   </refsect1><refsect1><title>Parameters</title>
32596     
32597 <variablelist>
32598       <varlistentry>
32599         <term>refname</term>
32600         <listitem>
32601           
32602 <para>The first <tag>refname</tag> in the refentry</para>
32603
32604         </listitem>
32605       </varlistentry>
32606       <varlistentry>
32607         <term>info</term>
32608         <listitem>
32609           
32610 <para>A set of info nodes (from a <tag>refentry</tag>
32611           element and its ancestors)</para>
32612
32613         </listitem>
32614       </varlistentry>
32615       <varlistentry>
32616         <term>prefs</term>
32617         <listitem>
32618           
32619 <para>A node containing users preferences (from global
32620           stylesheet parameters)</para>
32621
32622         </listitem>
32623       </varlistentry>
32624     </variablelist>
32625
32626   </refsect1><refsect1><title>Returns</title>
32627     
32628 <para>Depending on what output method is used for the
32629   current stylesheet, either returns a text node or possibly an element
32630   node, containing "version" data.</para>
32631
32632   </refsect1></refentry>
32633
32634 <refentry id="template.get.refentry.manual">
32635 <refnamediv>
32636 <refname>get.refentry.manual</refname>
32637 <refpurpose>Gets source metadata for a refentry</refpurpose>
32638 </refnamediv>
32639 <refsynopsisdiv>
32640 <synopsis>&lt;xsl:template name="get.refentry.manual"&gt;
32641 &lt;xsl:param name="refname"/&gt;
32642 &lt;xsl:param name="info"/&gt;
32643 &lt;xsl:param name="prefs"/&gt;
32644   ...
32645 &lt;/xsl:template&gt;</synopsis>
32646 </refsynopsisdiv>
32647 <refsect1><title>Description</title>
32648     
32649 <para>The <literal>man(7)</literal> man page describes this as "the
32650     title of the manual (e.g., <citetitle>Linux Programmer's
32651     Manual</citetitle>)". Here are some examples from existing man pages:
32652     
32653 <itemizedlist>
32654       <listitem>
32655         
32656 <para><citetitle>dpkg utilities</citetitle>
32657         (<command>dpkg-name</command>)</para>
32658
32659       </listitem>
32660       <listitem>
32661         
32662 <para><citetitle>User Contributed Perl Documentation</citetitle>
32663         (<command>GET</command>)</para>
32664
32665       </listitem>
32666       <listitem>
32667         
32668 <para><citetitle>GNU Development Tools</citetitle>
32669         (<command>ld</command>)</para>
32670
32671       </listitem>
32672       <listitem>
32673         
32674 <para><citetitle>Emperor Norton Utilities</citetitle>
32675         (<command>ddate</command>)</para>
32676
32677       </listitem>
32678       <listitem>
32679         
32680 <para><citetitle>Debian GNU/Linux manual</citetitle>
32681         (<command>faked</command>)</para>
32682
32683       </listitem>
32684       <listitem>
32685         
32686 <para><citetitle>GIMP Manual Pages</citetitle>
32687         (<command>gimp</command>)</para>
32688
32689       </listitem>
32690       <listitem>
32691         
32692 <para><citetitle>KDOC Documentation System</citetitle>
32693         (<command>qt2kdoc</command>)</para>
32694
32695       </listitem>
32696     </itemizedlist>
32697
32698     </para>
32699
32700
32701     
32702 <para>The <literal>solbook(5)</literal> man page describes
32703     something very much like what <literal>man(7)</literal> calls
32704     "manual", except that <literal>solbook(5)</literal> names it
32705     "sectdesc" and describes it like this:
32706     <blockquote>
32707       
32708 <para>This is the section title of the reference page; for
32709       example <literal>User Commands</literal>.</para>
32710
32711     </blockquote>
32712     </para>
32713
32714
32715   </refsect1><refsect1><title>Parameters</title>
32716     
32717 <variablelist>
32718       <varlistentry>
32719         <term>refname</term>
32720         <listitem>
32721           
32722 <para>The first <tag>refname</tag> in the refentry</para>
32723
32724         </listitem>
32725       </varlistentry>
32726       <varlistentry>
32727         <term>info</term>
32728         <listitem>
32729           
32730 <para>A set of info nodes (from a <tag>refentry</tag>
32731           element and its ancestors)</para>
32732
32733         </listitem>
32734       </varlistentry>
32735       <varlistentry>
32736         <term>prefs</term>
32737         <listitem>
32738           
32739 <para>A node containing users preferences (from global
32740           stylesheet parameters)</para>
32741
32742         </listitem>
32743       </varlistentry>
32744     </variablelist>
32745
32746   </refsect1><refsect1><title>Returns</title>
32747     
32748 <para>Returns a <tag>manual</tag> node.</para>
32749
32750   </refsect1></refentry>
32751
32752 <refentry id="template.get.refentry.metadata.prefs">
32753 <refnamediv>
32754 <refname>get.refentry.metadata.prefs</refname>
32755 <refpurpose>Gets user preferences for refentry metadata gathering</refpurpose>
32756 </refnamediv>
32757 <refsynopsisdiv>
32758 <synopsis>&lt;xsl:template name="get.refentry.metadata.prefs"/&gt;</synopsis>
32759 </refsynopsisdiv>
32760 <refsect1><title>Description</title>
32761     
32762 <para>The DocBook XSL stylesheets include several user-configurable
32763     global stylesheet parameters for controlling <tag>refentry</tag>
32764     metadata gathering. Those parameters are not read directly by the
32765     other <tag>refentry</tag> metadata-gathering
32766     templates. Instead, they are read only by the
32767     <function>get.refentry.metadata.prefs</function> template,
32768     which assembles them into a structure that is then passed to
32769     the other <tag>refentry</tag> metadata-gathering
32770     templates.</para>
32771
32772
32773     
32774 <para>So the, <function>get.refentry.metadata.prefs</function>
32775     template is the only interface to collecting stylesheet parameters for
32776     controlling <tag>refentry</tag> metadata gathering.</para>
32777
32778   </refsect1><refsect1><title>Parameters</title>
32779     
32780 <para>There are no local parameters for this template; however, it
32781     does rely on a number of global parameters.</para>
32782
32783   </refsect1><refsect1><title>Returns</title>
32784     
32785 <para>Returns a <tag>manual</tag> node.</para>
32786
32787   </refsect1></refentry>
32788
32789 <refentry id="template.set.refentry.metadata">
32790 <refnamediv>
32791 <refname>set.refentry.metadata</refname>
32792 <refpurpose>Sets content of a refentry metadata item</refpurpose>
32793 </refnamediv>
32794 <refsynopsisdiv>
32795 <synopsis>&lt;xsl:template name="set.refentry.metadata"&gt;
32796 &lt;xsl:param name="refname"/&gt;
32797 &lt;xsl:param name="info"/&gt;
32798 &lt;xsl:param name="contents"/&gt;
32799 &lt;xsl:param name="context"/&gt;
32800 &lt;xsl:param name="preferred"/&gt;
32801   ...
32802 &lt;/xsl:template&gt;</synopsis>
32803 </refsynopsisdiv>
32804 <refsect1><title>Description</title>
32805     
32806 <para>The <function>set.refentry.metadata</function> template is
32807     called each time a suitable source element is found for a certain
32808     metadata field.</para>
32809
32810   </refsect1><refsect1><title>Parameters</title>
32811     
32812 <variablelist>
32813       <varlistentry>
32814         <term>refname</term>
32815         <listitem>
32816           
32817 <para>The first <tag>refname</tag> in the refentry</para>
32818
32819         </listitem>
32820       </varlistentry>
32821       <varlistentry>
32822         <term>info</term>
32823         <listitem>
32824           
32825 <para>A single *info node that contains the selected source element.</para>
32826
32827         </listitem>
32828       </varlistentry>
32829       <varlistentry>
32830         <term>contents</term>
32831         <listitem>
32832           
32833 <para>A node containing the selected source element.</para>
32834
32835         </listitem>
32836       </varlistentry>
32837       <varlistentry>
32838         <term>context</term>
32839         <listitem>
32840           
32841 <para>A string describing the metadata context in which the
32842           <function>set.refentry.metadata</function> template was
32843           called: either "date", "source", "version", or "manual".</para>
32844
32845         </listitem>
32846       </varlistentry>
32847     </variablelist>
32848
32849   </refsect1><refsect1><title>Returns</title>
32850   
32851 <para>Returns formatted contents of a selected source element.</para>
32852 </refsect1></refentry>
32853 </reference>
32854         <reference id="utility" xml:base="../common/utility.xml">
32855   <info>
32856     <title>Common &#187; Utility Template Reference</title>
32857     <releaseinfo role="meta">
32858       $Id: utility.xsl 7101 2007-07-20 15:32:12Z xmldoc $
32859     </releaseinfo>
32860   </info>
32861   
32862   <partintro id="partintro">
32863     <title>Introduction</title>
32864     
32865 <para>This is technical reference documentation for the
32866       miscellaneous utility templates in the DocBook XSL
32867       Stylesheets.</para>
32868
32869     <note>
32870       
32871 <para>These templates are defined in a separate file from the set
32872         of &#8220;common&#8221; templates because some of the common templates
32873         reference DocBook XSL stylesheet parameters, requiring the
32874         entire set of parameters to be imported/included in any
32875         stylesheet that imports/includes the common templates.</para>
32876
32877       
32878 <para>The utility templates don&#8217;t import or include any DocBook
32879         XSL stylesheet parameters, so the utility templates can be used
32880         without importing the whole set of parameters.</para>
32881
32882     </note>
32883     
32884 <para>This is not intended to be user documentation. It is
32885       provided for developers writing customization layers for the
32886       stylesheets.</para>
32887
32888   </partintro>
32889
32890 <refentry id="template.log.message">
32891 <refnamediv>
32892 <refname>log.message</refname>
32893 <refpurpose>Logs/emits formatted notes and warnings</refpurpose>
32894 </refnamediv>
32895 <refsynopsisdiv>
32896 <synopsis>&lt;xsl:template name="log.message"&gt;
32897 &lt;xsl:param name="level"/&gt;
32898 &lt;xsl:param name="source"/&gt;
32899 &lt;xsl:param name="context-desc"/&gt;
32900 &lt;xsl:param name="context-desc-field-length"&gt;12&lt;/xsl:param&gt;
32901 &lt;xsl:param name="context-desc-padded"&gt;
32902     &lt;xsl:if test="not($context-desc = '')"&gt;
32903       &lt;xsl:call-template name="pad-string"&gt;
32904         &lt;xsl:with-param name="leftRight"&gt;right&lt;/xsl:with-param&gt;
32905         &lt;xsl:with-param name="padVar" select="substring($context-desc, 1, $context-desc-field-length)"/&gt;
32906         &lt;xsl:with-param name="length" select="$context-desc-field-length"/&gt;
32907       &lt;/xsl:call-template&gt;
32908     &lt;/xsl:if&gt;
32909   &lt;/xsl:param&gt;
32910 &lt;xsl:param name="message"/&gt;
32911 &lt;xsl:param name="message-field-length" select="45"/&gt;
32912 &lt;xsl:param name="message-padded"&gt;
32913     &lt;xsl:variable name="spaces-for-blank-level"&gt;
32914       &lt;!-- * if the level field is blank, we'll need to pad out --&gt;
32915       &lt;!-- * the message field with spaces to compensate --&gt;
32916       &lt;xsl:choose&gt;
32917         &lt;xsl:when test="$level = ''"&gt;
32918           &lt;xsl:value-of select="4 + 2"/&gt;
32919           &lt;!-- * 4 = hard-coded length of comment text ("Note" or "Warn") --&gt;
32920           &lt;!-- * + 2 = length of colon-plus-space separator ": " --&gt;
32921         &lt;/xsl:when&gt;
32922         &lt;xsl:otherwise&gt;
32923           &lt;xsl:value-of select="0"/&gt;
32924         &lt;/xsl:otherwise&gt;
32925       &lt;/xsl:choose&gt;
32926     &lt;/xsl:variable&gt;
32927     &lt;xsl:variable name="spaces-for-blank-context-desc"&gt;
32928       &lt;!-- * if the context-description field is blank, we'll need --&gt;
32929       &lt;!-- * to pad out the message field with spaces to compensate --&gt;
32930       &lt;xsl:choose&gt;
32931         &lt;xsl:when test="$context-desc = ''"&gt;
32932           &lt;xsl:value-of select="$context-desc-field-length + 2"/&gt;
32933           &lt;!-- * + 2 = length of colon-plus-space separator ": " --&gt;
32934         &lt;/xsl:when&gt;
32935         &lt;xsl:otherwise&gt;
32936           &lt;xsl:value-of select="0"/&gt;
32937         &lt;/xsl:otherwise&gt;
32938       &lt;/xsl:choose&gt;
32939     &lt;/xsl:variable&gt;
32940     &lt;xsl:variable name="extra-spaces" select="$spaces-for-blank-level + $spaces-for-blank-context-desc"/&gt;
32941     &lt;xsl:call-template name="pad-string"&gt;
32942       &lt;xsl:with-param name="leftRight"&gt;right&lt;/xsl:with-param&gt;
32943       &lt;xsl:with-param name="padVar" select="substring($message, 1, ($message-field-length + $extra-spaces))"/&gt;
32944       &lt;xsl:with-param name="length" select="$message-field-length + $extra-spaces"/&gt;
32945     &lt;/xsl:call-template&gt;
32946   &lt;/xsl:param&gt;
32947   ...
32948 &lt;/xsl:template&gt;</synopsis>
32949 </refsynopsisdiv>
32950 <refsect1><title>Description</title>
32951     
32952 <para>The <function>log.message</function> template is a utility
32953     template for logging/emitting formatted messages&#160;&#8211; that is,
32954     notes and warnings, along with a given log &#8220;level&#8221; and an
32955     identifier for the &#8220;source&#8221; that the message relates to.</para>
32956
32957   </refsect1><refsect1><title>Parameters</title>
32958     
32959 <variablelist>
32960       <varlistentry><term>level</term>
32961         <listitem>
32962           
32963 <para>Text to log/emit in the message-level field to
32964             indicate the message level
32965           (<literal>Note</literal> or
32966           <literal>Warning</literal>)</para>
32967
32968         </listitem>
32969       </varlistentry>
32970       <varlistentry><term>source</term>
32971         <listitem>
32972           
32973 <para>Text to log/emit in the source field to identify the
32974             &#8220;source&#8221; to which the notification/warning relates.
32975             This can be any arbitrary string, but because the
32976             message lacks line and column numbers to identify the
32977             exact part of the source document to which it
32978             relates, the intention is that the value you pass
32979             into the <literal>source</literal> parameter should
32980             give the user some way to identify the portion of
32981             their source document on which to take potentially
32982             take action in response to the log message (for
32983             example, to edit, change, or add content).</para>
32984
32985           
32986 <para>So the <literal>source</literal> value should be,
32987             for example, an ID, book/chapter/article title, title
32988             of some formal object, or even a string giving an
32989             XPath expression.</para>
32990
32991         </listitem>
32992       </varlistentry>
32993       <varlistentry><term>context-desc</term>
32994         <listitem>
32995           
32996 <para>Text to log/emit in the context-description field to
32997             describe the context for the message.</para>
32998
32999         </listitem>
33000       </varlistentry>
33001       <varlistentry><term>context-desc-field-length</term>
33002         <listitem>
33003           
33004 <para>Specifies length of the context-description field
33005             (in characters); default is 12</para>
33006
33007           
33008 <para>If the text specified by the
33009             <literal>context-desc</literal> parameter is longer
33010             than the number of characters specified in
33011             <literal>context-desc-field-length</literal>, it is
33012             truncated to <literal>context-desc-field-length</literal>
33013             (12 characters by default).</para>
33014
33015           
33016 <para>If the specified text is shorter than
33017             <literal>context-desc-field-length</literal>,
33018           it is right-padded out to
33019           <literal>context-desc-field-length</literal> (12 by
33020           default).</para>
33021
33022         
33023 <para>If no value has been specified for the
33024           <literal>context-desc</literal> parameter, the field is
33025           left empty and the text of the log message begins with
33026           the value of the <literal>message</literal>
33027           parameter.</para>
33028
33029         </listitem>
33030       </varlistentry>
33031       <varlistentry><term>message</term>
33032         <listitem>
33033           
33034 <para>Text to log/emit in the actual message field</para>
33035
33036         </listitem>
33037       </varlistentry>
33038       <varlistentry><term>message-field-length</term>
33039         <listitem>
33040           
33041 <para>Specifies length of the message
33042             field (in characters); default is 45</para>
33043
33044         </listitem>
33045       </varlistentry>
33046     </variablelist>
33047
33048   </refsect1><refsect1><title>Returns</title>
33049   
33050 <para>Outputs a message (generally, to standard error).</para>
33051 </refsect1></refentry>
33052
33053 <refentry id="template.get.doc.title">
33054 <refnamediv>
33055 <refname>get.doc.title</refname>
33056 <refpurpose>Gets a title from the current document</refpurpose>
33057 </refnamediv>
33058 <refsynopsisdiv>
33059 <synopsis>&lt;xsl:template name="get.doc.title"/&gt;</synopsis>
33060 </refsynopsisdiv>
33061 <refsect1><title>Description</title>
33062     
33063 <para>The <function>get.doc.title</function> template is a
33064       utility template for returning the first title found in the
33065       current document.</para>
33066
33067   </refsect1><refsect1><title>Returns</title>
33068   
33069 <para>Returns a string containing some identifying title for the
33070     current document .</para>
33071 </refsect1></refentry>
33072
33073 <refentry id="template.pad-string">
33074 <refnamediv>
33075 <refname>pad-string</refname>
33076 <refpurpose>Right-pads or left-pads a string out to a certain length</refpurpose>
33077 </refnamediv>
33078 <refsynopsisdiv>
33079 <synopsis>&lt;xsl:template name="pad-string"&gt;
33080 &lt;xsl:param name="padChar" select="' '"/&gt;
33081 &lt;xsl:param name="leftRight"&gt;left&lt;/xsl:param&gt;
33082 &lt;xsl:param name="padVar"/&gt;
33083 &lt;xsl:param name="length"/&gt;
33084   ...
33085 &lt;/xsl:template&gt;</synopsis>
33086 </refsynopsisdiv>
33087 <refsect1><title>Description</title>
33088     
33089 <para>This function takes string <parameter>padVar</parameter> and
33090       pads it out in the direction <parameter>rightLeft</parameter> to
33091       the string-length <parameter>length</parameter>, using string
33092       <parameter>padChar</parameter> (a space character by default) as
33093       the padding string (note that <parameter>padChar</parameter> can
33094       be a string; it is not limited to just being a single
33095       character).</para>
33096
33097     <note>
33098       
33099 <para>This function began as a copy of Nate Austin's
33100         <function>prepend-pad</function> function in the <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/padding.html">Padding
33101           Content</link> section of Dave Pawson's <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
33102           FAQ</link>.</para>
33103
33104     </note>
33105   </refsect1><refsect1><title>Returns</title>
33106   
33107 <para>Returns a (padded) string.</para>
33108 </refsect1></refentry>
33109 </reference>
33110         <reference id="charmap" xml:base="../common/charmap.xml">
33111   <info>
33112     <title>Common &#187; Character-Map Template Reference</title>
33113     <releaseinfo role="meta">
33114       $Id: charmap.xsl 7266 2007-08-22 11:58:42Z xmldoc $
33115     </releaseinfo>
33116   </info>
33117   
33118   <partintro id="partintro">
33119     <title>Introduction</title>
33120     
33121 <para>This is technical reference documentation for the
33122       character-map templates in the DocBook XSL Stylesheets.</para>
33123
33124     <note>
33125       
33126 <para>These templates are defined in a separate file from the set
33127         of &#8220;common&#8221; templates because some of the common templates
33128         reference DocBook XSL stylesheet parameters, requiring the
33129         entire set of parameters to be imported/included in any
33130         stylesheet that imports/includes the common templates.</para>
33131
33132       
33133 <para>The character-map templates don&#8217;t import or include
33134         any DocBook XSL stylesheet parameters, so the
33135         character-map templates can be used without importing the
33136         whole set of parameters.</para>
33137
33138     </note>
33139     
33140 <para>This is not intended to be user documentation. It is
33141       provided for developers writing customization layers for the
33142       stylesheets.</para>
33143
33144   </partintro>
33145
33146 <refentry id="template.apply-character-map">
33147 <refnamediv>
33148 <refname>apply-character-map</refname>
33149 <refpurpose>Applies an XSLT character map</refpurpose>
33150 </refnamediv>
33151 <refsynopsisdiv>
33152 <synopsis>&lt;xsl:template name="apply-character-map"&gt;
33153 &lt;xsl:param name="content"/&gt;
33154 &lt;xsl:param name="map.contents"/&gt;
33155   ...
33156 &lt;/xsl:template&gt;</synopsis>
33157 </refsynopsisdiv>
33158 <refsect1><title>Description</title>
33159     
33160 <para>This template applies an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character map</link>; that is, it causes certain
33161       individual characters to be substituted with strings of one
33162       or more characters. It is useful mainly for replacing
33163       multiple &#8220;special&#8221; characters or symbols in the same target
33164       content. It uses the value of
33165       <parameter>map.contents</parameter> to do substitution on
33166       <parameter>content</parameter>, and then returns the
33167       modified contents.</para>
33168
33169     <note>
33170       
33171 <para>This template is a very slightly modified version of
33172         Jeni Tennison&#8217;s <function>replace_strings</function>
33173         template in the <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/StringReplace.html#d9351e13">multiple string replacements</link> section of Dave Pawson&#8217;s
33174         <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT FAQ</link>.</para>
33175
33176       
33177 <para>The <function>apply-string-subst-map</function>
33178         template is essentially the same template as the
33179         <function>apply-character-map</function> template; the
33180         only difference is that in the map that
33181         <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used
33182         instead of <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
33183
33184     </note>
33185   </refsect1><refsect1><title>Parameters</title>
33186     
33187 <variablelist>
33188       <varlistentry><term>content</term>
33189         <listitem>
33190           
33191 <para>The content on which to perform the character-map
33192             substitution.</para>
33193
33194         </listitem>
33195       </varlistentry>
33196       <varlistentry><term>map.contents</term>
33197         <listitem>
33198           
33199 <para>A node set of elements, with each element having
33200             the following attributes:
33201             
33202 <itemizedlist>
33203               <listitem>
33204                 <simpara><tag class="attribute">character</tag>, a
33205                   character to be replaced</simpara>
33206               </listitem>
33207               <listitem>
33208                 <simpara><tag class="attribute">string</tag>, a
33209                   string with which to replace <tag class="attribute">character</tag></simpara>
33210               </listitem>
33211             </itemizedlist>
33212
33213           </para>
33214
33215         </listitem>
33216       </varlistentry>
33217     </variablelist>
33218
33219   </refsect1></refentry>
33220
33221 <refentry id="template.read-character-map">
33222 <refnamediv>
33223 <refname>read-character-map</refname>
33224 <refpurpose>Reads in all or part of an XSLT character map</refpurpose>
33225 </refnamediv>
33226 <refsynopsisdiv>
33227 <synopsis>&lt;xsl:template name="read-character-map"&gt;
33228 &lt;xsl:param name="use.subset"/&gt;
33229 &lt;xsl:param name="subset.profile"/&gt;
33230 &lt;xsl:param name="uri"/&gt;
33231   ...
33232 &lt;/xsl:template&gt;</synopsis>
33233 </refsynopsisdiv>
33234 <refsect1><title>Description</title>
33235     
33236 <para>The XSLT 2.0 specification describes <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">character maps</link> and explains how they may be used
33237       to allow a specific character appearing in a text or
33238       attribute node in a final result tree to be substituted by
33239       a specified string of characters during serialization. The
33240       <function>read-character-map</function> template provides a
33241       means for reading and using character maps with XSLT
33242       1.0-based tools.</para>
33243
33244     
33245 <para>This template reads the character-map contents from
33246       <parameter>uri</parameter> (in full or in part, depending on
33247       the value of the <parameter>use.subset</parameter>
33248       parameter), then passes those contents to the
33249       <function>apply-character-map</function> template, along with
33250       <parameter>content</parameter>, the data on which to perform
33251       the character substitution.</para>
33252
33253     
33254 <para>Using the character map &#8220;in part&#8221; means that it uses only
33255       those <tag>output-character</tag> elements that match the
33256       XPath expression given in the value of the
33257       <parameter>subset.profile</parameter> parameter. The current
33258       implementation of that capability here relies on the
33259       <function>evaluate</function> extension XSLT function.</para>
33260
33261   </refsect1><refsect1><title>Parameters</title>
33262     
33263 <variablelist>
33264       <varlistentry><term>use.subset</term>
33265         <listitem>
33266           
33267 <para>Specifies whether to use a subset of the character
33268             map instead of the whole map; boolean
33269             <literal>0</literal> or <literal>1</literal></para>
33270
33271         </listitem>
33272       </varlistentry>
33273       <varlistentry><term>subset.profile</term>
33274         <listitem>
33275           
33276 <para>XPath expression that specifies what subset of the
33277             character map to use</para>
33278
33279         </listitem>
33280       </varlistentry>
33281       <varlistentry><term>uri</term>
33282         <listitem>
33283           
33284 <para>URI for a character map</para>
33285
33286         </listitem>
33287       </varlistentry>
33288     </variablelist>
33289
33290   </refsect1></refentry>
33291 </reference>
33292     </part>
33293     <part id="table-templates">
33294       <?dbhtml dir="fo"?>
33295   
33296   <info xml:base="../fo/table.xml">
33297     <title>Formatting Object Table Reference</title>
33298     <releaseinfo role="meta">
33299       $Id: table.xsl 8814 2010-08-09 21:19:53Z bobstayton $
33300     </releaseinfo>
33301   </info>
33302   <partintro id="partintro" xml:base="../fo/table.xml">
33303     <title>Introduction</title>
33304     
33305 <para>This is technical reference documentation for the FO
33306       table-processing templates in the DocBook XSL Stylesheets.</para>
33307
33308     
33309 <para>This is not intended to be user documentation.  It is
33310       provided for developers writing customization layers for the
33311       stylesheets.</para>
33312
33313   </partintro>
33314
33315 <refentry id="template.calc.column.width" xml:base="../fo/table.xml">
33316 <refnamediv>
33317 <refname>calc.column.width</refname>
33318 <refpurpose>Calculate an XSL FO table column width specification from a
33319 CALS table column width specification.</refpurpose>
33320 </refnamediv>
33321 <refsynopsisdiv>
33322 <synopsis>&lt;xsl:template name="calc.column.width"&gt;
33323 &lt;xsl:param name="colwidth"&gt;1*&lt;/xsl:param&gt;
33324   ...
33325 &lt;/xsl:template&gt;</synopsis>
33326 </refsynopsisdiv>
33327 <refsect1><title>Description</title>
33328
33329 <para>CALS expresses table column widths in the following basic
33330 forms:</para>
33331
33332
33333
33334 <itemizedlist>
33335 <listitem>
33336
33337 <para><emphasis>99.99units</emphasis>, a fixed length specifier.</para>
33338
33339 </listitem>
33340 <listitem>
33341
33342 <para><emphasis>99.99</emphasis>, a fixed length specifier without any units.</para>
33343
33344 </listitem>
33345 <listitem>
33346
33347 <para><emphasis>99.99*</emphasis>, a relative length specifier.</para>
33348
33349 </listitem>
33350 <listitem>
33351
33352 <para><emphasis>99.99*+99.99units</emphasis>, a combination of both.</para>
33353
33354 </listitem>
33355 </itemizedlist>
33356
33357
33358
33359 <para>The CALS units are points (pt), picas (pi), centimeters (cm),
33360 millimeters (mm), and inches (in). These are the same units as XSL,
33361 except that XSL abbreviates picas "pc" instead of "pi". If a length
33362 specifier has no units, the CALS default unit (pt) is assumed.</para>
33363
33364
33365
33366 <para>Relative length specifiers are represented in XSL with the
33367 proportional-column-width() function.</para>
33368
33369
33370
33371 <para>Here are some examples:</para>
33372
33373
33374
33375 <itemizedlist>
33376 <listitem>
33377
33378 <para>"36pt" becomes "36pt"</para>
33379
33380 </listitem>
33381 <listitem>
33382
33383 <para>"3pi" becomes "3pc"</para>
33384
33385 </listitem>
33386 <listitem>
33387
33388 <para>"36" becomes "36pt"</para>
33389
33390 </listitem>
33391 <listitem>
33392
33393 <para>"3*" becomes "proportional-column-width(3)"</para>
33394
33395 </listitem>
33396 <listitem>
33397
33398 <para>"3*+2pi" becomes "proportional-column-width(3)+2pc"</para>
33399
33400 </listitem>
33401 <listitem>
33402
33403 <para>"1*+2" becomes "proportional-column-width(1)+2pt"</para>
33404
33405 </listitem>
33406 </itemizedlist>
33407
33408 </refsect1><refsect1><title>Parameters</title>
33409
33410 <variablelist>
33411 <varlistentry><term>colwidth</term>
33412 <listitem>
33413
33414 <para>The CALS column width specification.</para>
33415
33416 </listitem>
33417 </varlistentry>
33418 </variablelist>
33419
33420 </refsect1><refsect1><title>Returns</title>
33421
33422 <para>The XSL column width specification.</para>
33423
33424 </refsect1></refentry>
33425
33426     </part>
33427     <part id="template"> 
33428       <?dbhtml dir="template"?><?dbhtml filename="index.html"?>
33429   
33430   
33431   <info xml:base="../template/titlepage.xml">
33432     <title>Titlepage Template Stylesheet Reference</title>
33433     <releaseinfo role="meta">
33434       $Id: titlepage.xsl 7058 2007-07-17 13:59:29Z xmldoc $
33435     </releaseinfo>
33436   </info>
33437   <partintro id="intro_partintro" xml:base="../template/titlepage.xml">
33438     <title>Introduction</title>
33439     
33440 <para>This is technical reference documentation for the
33441       &#8220;titlepage&#8221; templates in the DocBook XSL Stylesheets.</para>
33442
33443     
33444 <para>This is not intended to be user documentation.  It is
33445       provided for developers writing customization layers for the
33446       stylesheets.</para>
33447
33448   </partintro>
33449
33450 <refentry id="templates" xml:base="../template/titlepage.xml">
33451 <refnamediv>
33452 <refname>t:templates</refname>
33453 <refpurpose>Construct a stylesheet for the templates provided</refpurpose>
33454 </refnamediv>
33455 <refsynopsisdiv>
33456 <synopsis>&lt;xsl:template match="t:templates"/&gt;</synopsis>
33457 </refsynopsisdiv>
33458 <refsect1><title>Description</title>
33459
33460 <para>The <literal>t:templates</literal> element is the root of a
33461 set of templates. This template creates an appropriate
33462 <literal>xsl:stylesheet</literal> for the templates.</para>
33463
33464
33465
33466 <para>If the <literal>t:templates</literal> element has a
33467 <literal>base-stylesheet</literal> attribute, an
33468 <literal>xsl:import</literal> statement is constructed for it.</para>
33469
33470 </refsect1></refentry>
33471
33472 <refentry id="star" xml:base="../template/titlepage.xml">
33473 <refnamediv>
33474 <refname>xsl:*</refname>
33475 <refpurpose>Copy xsl: elements straight through</refpurpose>
33476 </refnamediv>
33477 <refsynopsisdiv>
33478 <synopsis>&lt;xsl:template match="xsl:*"/&gt;</synopsis>
33479 </refsynopsisdiv>
33480 <refsect1><title>Description</title>
33481
33482 <para>This template simply copies the xsl: elements
33483 straight through into the result tree.</para>
33484
33485 </refsect1></refentry>
33486
33487 <refentry id="titlepage" xml:base="../template/titlepage.xml">
33488 <refnamediv>
33489 <refname>t:titlepage</refname>
33490 <refpurpose>Create the templates necessary to construct a title page</refpurpose>
33491 </refnamediv>
33492 <refsynopsisdiv>
33493 <synopsis>&lt;xsl:template match="t:titlepage"/&gt;</synopsis>
33494 </refsynopsisdiv>
33495 <refsect1><title>Description</title>
33496
33497 <para>The <literal>t:titlepage</literal> element creates a set of
33498 templates for processing the titlepage for an element. The
33499 <quote>root</quote> of this template set is the template named
33500 <quote><literal>wrapper.titlepage</literal></quote>. That is the
33501 template that should be called to generate the title page.
33502 </para>
33503
33504
33505
33506 <para>The <literal>t:titlepage</literal> element has three attributes:
33507
33508
33509 <variablelist>
33510 <varlistentry><term>element</term>
33511 <listitem>
33512 <para>The name of the source document element for which
33513 these templates apply. In other words, to make a title page for the
33514 <tag>article</tag> element, set the
33515 <tag class="attribute">element</tag> attribute to
33516 <quote><literal>article</literal></quote>. This attribute is required.
33517 </para>
33518 </listitem>
33519 </varlistentry>
33520 <varlistentry><term>wrapper</term>
33521 <listitem>
33522 <para>The entire title page can be wrapped with an element.
33523 This attribute identifies that element.
33524 </para>
33525 </listitem>
33526 </varlistentry>
33527 <varlistentry><term>class</term>
33528 <listitem>
33529 <para>If the <tag class="attribute">class</tag> attribute
33530 is set, a <tag class="attribute">class</tag> attribute with this
33531 value will be added to the wrapper element that surrounds the entire
33532 title page.
33533 </para>
33534 </listitem>
33535 </varlistentry>
33536 </variablelist>
33537
33538 </para>
33539
33540
33541
33542 <para>Any other attributes are copied through literally to the
33543 wrapper element.</para>
33544
33545
33546
33547 <para>The content of a <literal>t:titlepage</literal> is one or
33548 more <literal>t:titlepage-content</literal>,
33549 <literal>t:titlepage-separator</literal>, and
33550 <literal>t:titlepage-before</literal> elements.</para>
33551
33552
33553
33554 <para>Each of these elements may be provided for the <quote>recto</quote>
33555 and <quote>verso</quote> sides of the title page.</para>
33556
33557
33558 </refsect1></refentry>
33559
33560 <refentry id="attr_star_in_copy.literal.atts" xml:base="../template/titlepage.xml">
33561 <refnamediv>
33562 <refname>@* (in copy.literal.atts mode)</refname>
33563 <refpurpose>Copy t:titlepage attributes</refpurpose>
33564 </refnamediv>
33565 <refsynopsisdiv>
33566 <synopsis>&lt;xsl:template match="@*" mode="copy.literal.atts"/&gt;</synopsis>
33567 </refsynopsisdiv>
33568 <refsect1><title>Description</title>
33569
33570 <para>This template copies all of the <quote>other</quote> attributes
33571 from a <literal>t:titlepage</literal> element onto the specified
33572 wrapper.</para>
33573
33574 </refsect1></refentry>
33575
33576 <refentry id="titlepage-content" xml:base="../template/titlepage.xml">
33577 <refnamediv>
33578 <refname>t:titlepage-content</refname>
33579 <refpurpose>Create templates for the content of one side of a title page</refpurpose>
33580 </refnamediv>
33581 <refsynopsisdiv>
33582 <synopsis>&lt;xsl:template match="t:titlepage-content"/&gt;</synopsis>
33583 </refsynopsisdiv>
33584 <refsect1><title>Description</title>
33585
33586 <para>The title page content, that is, the elements from the source
33587 document that are rendered on the title page, can be controlled independently
33588 for the recto and verso sides of the title page.</para>
33589
33590
33591
33592 <para>The <literal>t:titlepage-content</literal> element has two attributes:
33593
33594
33595 <variablelist>
33596 <varlistentry><term>side</term>
33597 <listitem>
33598 <para>Identifies the side of the page to which this title
33599 page content applies. The
33600 <tag class="attribute">side</tag> attribute is required and
33601 must be set to either 
33602 <quote><literal>recto</literal></quote> or
33603 <quote><literal>verso</literal></quote>. In addition, you must specify
33604 exactly one <literal>t:titlepage-content</literal> for each side
33605 within each <literal>t:titlepage</literal>.</para>
33606
33607 </listitem>
33608 </varlistentry>
33609 <varlistentry><term>order</term>
33610 <listitem>
33611 <para>Indicates how the order of the elements presented on
33612 the title page is determined. If the
33613 <tag class="attribute">order</tag> is
33614 <quote><literal>document</literal></quote>, the elements are presented
33615 in document order. Otherwise (if the
33616 <tag class="attribute">order</tag> is
33617 <quote><literal>stylesheet</literal></quote>), the elements are presented
33618 in the order that they appear in the template (and consequently in
33619 the stylesheet).</para>
33620
33621 </listitem>
33622 </varlistentry>
33623 </variablelist>
33624
33625 </para>
33626
33627
33628
33629 <para>The content of a <literal>t:titlepage-content</literal> element is
33630 a list of element names. These names should be unqualified.  They identify
33631 the elements in the source document that should appear on the title page.
33632 </para>
33633
33634
33635
33636 <para>Each element may have a single attribute:
33637 <tag class="attribute">predicate</tag>. The value of this
33638 attribute is used as a predicate for the expression that matches
33639 the element on which it occurs.</para>
33640
33641
33642
33643 <para>In other words, to put only the first three authors on the
33644 recto-side of a title
33645 page, you could specify:
33646
33647 <screen>
33648   &lt;t:titlepage-contents side="recto"&gt;
33649     &lt;!-- other titlepage elements --&gt;
33650     &lt;author predicate="[count(previous-sibling::author)&lt;2]"/&gt;
33651     &lt;!-- other titlepage elements --&gt;
33652   &lt;/t:titlepage-contents&gt;
33653 </screen>
33654 </para>
33655
33656
33657
33658 <para>Usually, the elements so named are empty. But it is possible to
33659 make one level of selection within them. Suppose that you want to
33660 process <literal>authorgroup</literal> elements on the title page, but
33661 you want to select only proper authors, editors, or corporate authors,
33662 not collaborators or other credited authors.</para>
33663
33664
33665
33666 <para>In that case, you can put a <literal>t:or</literal> group inside
33667 the <literal>authorgroup</literal> element:
33668
33669 <screen>
33670   &lt;t:titlepage-contents side="recto"&gt;
33671     &lt;!-- other titlepage elements --&gt;
33672     &lt;authorgroup&gt;
33673       &lt;t:or&gt;
33674         &lt;author/&gt;
33675         &lt;editor/&gt;
33676         &lt;corpauthor/&gt;
33677       &lt;/t:or&gt;
33678     &lt;/authorgroup&gt;
33679     &lt;!-- other titlepage elements --&gt;
33680   &lt;/t:titlepage-contents&gt;
33681 </screen>
33682 </para>
33683
33684
33685
33686 <para>This will have the effect of automatically generating a template
33687 for processing <literal>authorgroup</literal>s in the title page mode,
33688 selecting only the specified children. If you need more complex processing,
33689 you'll have to construct the templates by hand.</para>
33690
33691
33692 </refsect1></refentry>
33693
33694 <refentry id="titlepage-separator" xml:base="../template/titlepage.xml">
33695 <refnamediv>
33696 <refname>t:titlepage-separator</refname>
33697 <refpurpose>Create templates for the separator</refpurpose>
33698 </refnamediv>
33699 <refsynopsisdiv>
33700 <synopsis>&lt;xsl:template match="t:titlepage-separator"/&gt;</synopsis>
33701 </refsynopsisdiv>
33702 <refsect1><title>Description</title>
33703
33704 <para>The title page is separated from the content which follows it by
33705 the markup specified in the <literal>t:titlepage-separator</literal>
33706 element.</para>
33707
33708 </refsect1></refentry>
33709
33710 <refentry id="titlepage-before" xml:base="../template/titlepage.xml">
33711 <refnamediv>
33712 <refname>t:titlepage-before</refname>
33713 <refpurpose>Create templates for what precedes a title page</refpurpose>
33714 </refnamediv>
33715 <refsynopsisdiv>
33716 <synopsis>&lt;xsl:template match="t:titlepage-before"/&gt;</synopsis>
33717 </refsynopsisdiv>
33718 <refsect1><title>Description</title>
33719
33720 <para>Each side of the title page is preceded by the markup specified
33721 in the <literal>t:titlepage-before</literal> element for that
33722 side.</para>
33723
33724 </refsect1></refentry>
33725
33726 <refentry id="star_in_copy" xml:base="../template/titlepage.xml">
33727 <refnamediv>
33728 <refname>* (in copy mode)</refname>
33729 <refpurpose>Copy elements</refpurpose>
33730 </refnamediv>
33731 <refsynopsisdiv>
33732 <synopsis>&lt;xsl:template match="*" mode="copy"/&gt;</synopsis>
33733 </refsynopsisdiv>
33734 <refsect1><title>Description</title>
33735
33736 <para>This template simply copies the elements that it applies to
33737 straight through into the result tree.</para>
33738
33739 </refsect1></refentry>
33740
33741 <refentry id="attr_star_in_copy" xml:base="../template/titlepage.xml">
33742 <refnamediv>
33743 <refname>@* (in copy mode)</refname>
33744 <refpurpose>Copy attributes</refpurpose>
33745 </refnamediv>
33746 <refsynopsisdiv>
33747 <synopsis>&lt;xsl:template match="@*" mode="copy"/&gt;</synopsis>
33748 </refsynopsisdiv>
33749 <refsect1><title>Description</title>
33750
33751 <para>This template simply copies the attributes that it applies to
33752 straight through into the result tree.</para>
33753
33754 </refsect1></refentry>
33755
33756 <refentry id="attr_star_in_document.order" xml:base="../template/titlepage.xml">
33757 <refnamediv>
33758 <refname>* (in document.order mode)</refname>
33759 <refpurpose>Create rules to process titlepage elements in document order</refpurpose>
33760 </refnamediv>
33761 <refsynopsisdiv>
33762 <synopsis>&lt;xsl:template match="*" mode="document.order"/&gt;</synopsis>
33763 </refsynopsisdiv>
33764 <refsect1><title>Description</title>
33765
33766 <para>This template is called to process all of the children of the
33767 <literal>t:titlepage-content</literal> element. It creates the hairy
33768 select expression necessary to process each of those elements in
33769 the title page.</para>
33770
33771
33772
33773 <para>Note that this template automatically handles the case where
33774 some DocBook elements, like title and subtitle, can occur both inside
33775 the *info elements where metadata is usually stored and outside.
33776 </para>
33777
33778
33779
33780 <para>It also automatically calculates the name for the *info container
33781 and handles elements that have historically had containers with different
33782 names.</para>
33783
33784
33785 </refsect1></refentry>
33786
33787 <refentry id="star_in_document.order" xml:base="../template/titlepage.xml">
33788 <refnamediv>
33789 <refname>* (in document.order mode)</refname>
33790 <refpurpose>Create rules to process titlepage elements in stylesheet order</refpurpose>
33791 </refnamediv>
33792 <refsynopsisdiv>
33793 <synopsis>&lt;xsl:template match="*" mode="document.order"/&gt;</synopsis>
33794 </refsynopsisdiv>
33795 <refsect1><title>Description</title>
33796
33797 <para>This template is called to process all of the children of the
33798 <literal>t:titlepage-content</literal> element. It creates the set
33799 of <literal>xsl:apply-templates</literal> elements necessary
33800 process each of those elements in the title page.</para>
33801
33802
33803
33804 <para>Note that this template automatically handles the case where
33805 some DocBook elements, like title and subtitle, can occur both inside
33806 the *info elements where metadata is usually stored and outside.
33807 </para>
33808
33809
33810
33811 <para>It also automatically calculates the name for the *info container
33812 and handles elements that have historically had containers with different
33813 names.</para>
33814
33815
33816 </refsect1></refentry>
33817
33818 <refentry id="star_in_titlepage.specialrules" xml:base="../template/titlepage.xml">
33819 <refnamediv>
33820 <refname>* (in titlepage.specialrules mode)</refname>
33821 <refpurpose>Create templates for special rules</refpurpose>
33822 </refnamediv>
33823 <refsynopsisdiv>
33824 <synopsis>&lt;xsl:template match="*" mode="titlepage.specialrules"/&gt;</synopsis>
33825 </refsynopsisdiv>
33826 <refsect1><title>Description</title>
33827
33828 <para>This template is called to process all of the descendants of the
33829 <literal>t:titlepage-content</literal> element that require special
33830 processing. At present, that's just <literal>t:or</literal> elements.
33831 </para>
33832
33833 </refsect1></refentry>
33834
33835 <refentry id="star_in_titlepage.subrules" xml:base="../template/titlepage.xml">
33836 <refnamediv>
33837 <refname>* (in titlepage.subrules mode)</refname>
33838 <refpurpose>Create template for individual special rules</refpurpose>
33839 </refnamediv>
33840 <refsynopsisdiv>
33841 <synopsis>&lt;xsl:template match="*" mode="titlepage.subrules"/&gt;</synopsis>
33842 </refsynopsisdiv>
33843 <refsect1><title>Description</title>
33844
33845 <para>This template is called to process the children of special
33846 template elements.
33847 </para>
33848
33849 </refsect1></refentry>
33850
33851 <refentry id="or" xml:base="../template/titlepage.xml">
33852 <refnamediv>
33853 <refname>t:or</refname>
33854 <refpurpose>Process the t:or special rule</refpurpose>
33855 </refnamediv>
33856 <refsynopsisdiv>
33857 <synopsis>&lt;xsl:template match="t:or"/&gt;&lt;xsl:template match="t:or" mode="titlepage.subrules"/&gt;</synopsis>
33858 </refsynopsisdiv>
33859 <refsect1><title>Description</title>
33860
33861 <para>This template processes t:or.</para>
33862
33863 </refsect1></refentry>
33864
33865 <refentry id="or_in_titlepage.subrules" xml:base="../template/titlepage.xml">
33866 <refnamediv>
33867 <refname>t:or (in titlepage.subrules mode)</refname>
33868 <refpurpose>Process the t:or special rule in
33869 titlepage.subrules mode</refpurpose>
33870 </refnamediv>
33871 <refsynopsisdiv>
33872 <synopsis>&lt;xsl:template match="t:or" mode="titlepage.subrules"/&gt;</synopsis>
33873 </refsynopsisdiv>
33874 <refsect1><title>Description</title>
33875
33876 <para>The titlepage.subrules mode doesn't apply to t:or, so just
33877 reprocess this node in the normal mode.</para>
33878
33879 </refsect1></refentry>
33880
33881 <refentry id="template.element-or-list" xml:base="../template/titlepage.xml">
33882 <refnamediv>
33883 <refname>element-or-list</refname>
33884 <refpurpose>Construct the "or-list" used in the select attribute for
33885 special rules.</refpurpose>
33886 </refnamediv>
33887 <refsynopsisdiv>
33888 <synopsis>&lt;xsl:template name="element-or-list"&gt;
33889 &lt;xsl:param name="elements" select="*"/&gt;
33890 &lt;xsl:param name="element.count" select="count($elements)"/&gt;
33891 &lt;xsl:param name="count" select="1"/&gt;
33892 &lt;xsl:param name="orlist"/&gt;
33893   ...
33894 &lt;/xsl:template&gt;</synopsis>
33895 </refsynopsisdiv>
33896 <refsect1><title>Description</title>
33897
33898 <para>Walk through each of the children of t:or, producing the
33899 text of the select attribute.</para>
33900
33901 </refsect1></refentry>
33902
33903     </part>
33904   </book>
33905 </set><!-- * vim: set ft=docbk foldlevel=2: -->