doc/xslt/html/param.xml

   1 <?xml version="1.0" encoding="ASCII"?>
   2 <book version="5.0">
   3 <info>
   4 <title>HTML Parameter Reference</title>
   5 <releaseinfo role="meta">
   6 $Id: param.xweb 8552 2009-12-07 17:45:26Z bobstayton $
   7 </releaseinfo>
   8 <author>
   9   <personname>
  10     <surname>Walsh</surname>
  11     <firstname>Norman</firstname>
  12   </personname>
  13 </author>
  14 <copyright>
  15   <year>1999</year>
  16   <year>2000</year>
  17   <year>2001</year>
  18   <year>2002</year>
  19   <year>2003</year>
  20   <year>2004</year>
  21   <year>2005</year>
  22   <year>2006</year>
  23   <year>2007</year>
  24   <holder>Norman Walsh</holder>
  25 </copyright>
  26 <abstract>
  27   <para>This is reference documentation for all user-configurable
  28   parameters in the DocBook XSL HTML stylesheets (for generating
  29   HTML output).</para>
  30 </abstract>
  31 </info>
  32 <reference xml:id="admons"><title>Admonitions</title>
  33 <refentry version="5.0" xml:id="admon.graphics.extension">
  34 <refmeta>
  35 <refentrytitle>admon.graphics.extension</refentrytitle>
  36 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  37 </refmeta>
  38 <refnamediv>
  39 <refname>admon.graphics.extension</refname>
  40 <refpurpose>Filename extension for admonition graphics</refpurpose>
  41 </refnamediv>
  42
  43 <refsynopsisdiv>
  44 <programlisting xml:id="admon.graphics.extension.frag">
  45 &lt;xsl:param name="admon.graphics.extension"&gt;.png&lt;/xsl:param&gt;
  46 </programlisting>
  47 </refsynopsisdiv>
  48
  49 <refsection><info><title>Description</title></info>
  50
  51 <para>Sets the filename extension to use on admonition graphics.</para>
  52
  53 </refsection>
  54 </refentry>
  55
  56 <refentry version="5.0" xml:id="admon.graphics.path">
  57 <refmeta>
  58 <refentrytitle>admon.graphics.path</refentrytitle>
  59 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  60 </refmeta>
  61 <refnamediv>
  62 <refname>admon.graphics.path</refname>
  63 <refpurpose>Path to admonition graphics</refpurpose>
  64 </refnamediv>
  65
  66 <refsynopsisdiv>
  67 <programlisting xml:id="admon.graphics.path.frag">&lt;xsl:param name="admon.graphics.path"&gt;images/&lt;/xsl:param&gt;</programlisting>
  68 </refsynopsisdiv>
  69
  70 <refsection><info><title>Description</title></info>
  71
  72 <para>Sets the path to the directory containing the admonition graphics
  73 (caution.png, important.png etc). This location is normally relative
  74 to the output html directory. See <parameter>base.dir</parameter></para>
  75
  76 </refsection>
  77 </refentry>
  78
  79 <refentry version="5.0" xml:id="admon.graphics">
  80 <refmeta>
  81 <refentrytitle>admon.graphics</refentrytitle>
  82 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  83 </refmeta>
  84 <refnamediv>
  85 <refname>admon.graphics</refname>
  86 <refpurpose>Use graphics in admonitions?</refpurpose>
  87 </refnamediv>
  88
  89 <refsynopsisdiv>
  90 <programlisting xml:id="admon.graphics.frag">
  91 &lt;xsl:param name="admon.graphics" select="0"&gt;&lt;/xsl:param&gt;
  92 </programlisting>
  93 </refsynopsisdiv>
  94
  95 <refsection><info><title>Description</title></info>
  96
  97 <para>If true (non-zero), admonitions are presented in an alternate style that uses
  98 a graphic.  Default graphics are provided in the distribution.
  99 </para>
 100
 101 </refsection>
 102 </refentry>
 103
 104 <refentry version="5.0" xml:id="admon.textlabel">
 105 <refmeta>
 106 <refentrytitle>admon.textlabel</refentrytitle>
 107 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 108 </refmeta>
 109 <refnamediv>
 110 <refname>admon.textlabel</refname>
 111 <refpurpose>Use text label in admonitions?</refpurpose>
 112 </refnamediv>
 113
 114 <refsynopsisdiv>
 115 <programlisting xml:id="admon.textlabel.frag">
 116 &lt;xsl:param name="admon.textlabel" select="1"&gt;&lt;/xsl:param&gt;
 117 </programlisting>
 118 </refsynopsisdiv>
 119
 120 <refsection><info><title>Description</title></info>
 121
 122 <para>If true (non-zero), admonitions are presented with a generated
 123 text label such as Note or Warning in the appropriate language.
 124 If zero, such labels are turned off, but any title child
 125 of the admonition element are still output.
 126 The default value is 1.
 127 </para>
 128
 129 </refsection>
 130 </refentry>
 131
 132 <refentry version="5.0" xml:id="admon.style">
 133 <refmeta>
 134 <refentrytitle>admon.style</refentrytitle>
 135 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
 136 </refmeta>
 137 <refnamediv>
 138 <refname>admon.style</refname>
 139 <refpurpose>Specifies the CSS style attribute that should be added to
 140 admonitions.</refpurpose>
 141 </refnamediv>
 142
 143 <refsynopsisdiv>
 144 <programlisting xml:id="admon.style.frag">&lt;xsl:param name="admon.style"&gt;
 145   &lt;xsl:value-of select="concat('margin-', $direction.align.start,            ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"&gt;&lt;/xsl:value-of&gt;
 146 &lt;/xsl:param&gt;</programlisting>
 147 </refsynopsisdiv>
 148
 149 <refsection><info><title>Description</title></info>
 150
 151 <para>Specifies the value of the CSS <tag class="attribute">style</tag>
 152 attribute that should be added to admonitions.
 153 </para>
 154
 155 </refsection>
 156 </refentry>
 157
 158 </reference>
 159 <reference xml:id="callouts"><title>Callouts</title>
 160 <refentry version="5.0" xml:id="callout.defaultcolumn">
 161 <refmeta>
 162 <refentrytitle>callout.defaultcolumn</refentrytitle>
 163 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 164 </refmeta>
 165 <refnamediv>
 166 <refname>callout.defaultcolumn</refname>
 167 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
 168 </refnamediv>
 169
 170 <refsynopsisdiv>
 171 <programlisting xml:id="callout.defaultcolumn.frag">
 172 &lt;xsl:param name="callout.defaultcolumn"&gt;60&lt;/xsl:param&gt;
 173 </programlisting>
 174 </refsynopsisdiv>
 175
 176 <refsection><info><title>Description</title></info>
 177
 178 <para>If a callout does not identify a column (for example, if it uses
 179 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
 180 it will appear in the default column.
 181 </para>
 182
 183 </refsection>
 184 </refentry>
 185
 186 <refentry version="5.0" xml:id="callout.graphics.extension">
 187 <refmeta>
 188 <refentrytitle>callout.graphics.extension</refentrytitle>
 189 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
 190 </refmeta>
 191 <refnamediv>
 192 <refname>callout.graphics.extension</refname>
 193 <refpurpose>Filename extension for callout graphics</refpurpose>
 194 </refnamediv>
 195
 196 <refsynopsisdiv>
 197 <programlisting xml:id="callout.graphics.extension.frag">
 198 &lt;xsl:param name="callout.graphics.extension"&gt;.png&lt;/xsl:param&gt;
 199
 200 </programlisting>
 201 </refsynopsisdiv>
 202
 203 <refsection><info><title>Description</title></info>
 204 <para>Sets the filename extension to use on callout graphics. </para>
 205
 206 <itemizedlist>
 207 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
 208 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
 209 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
 210 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
 211 </itemizedlist>
 212 </refsection>
 213 </refentry>
 214
 215 <refentry version="5.0" xml:id="callout.graphics.number.limit">
 216 <refmeta>
 217 <refentrytitle>callout.graphics.number.limit</refentrytitle>
 218 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 219 </refmeta>
 220 <refnamediv>
 221 <refname>callout.graphics.number.limit</refname>
 222 <refpurpose>Number of the largest callout graphic</refpurpose>
 223 </refnamediv>
 224
 225 <refsynopsisdiv>
 226 <programlisting xml:id="callout.graphics.number.limit.frag">
 227 &lt;xsl:param name="callout.graphics.number.limit"&gt;15&lt;/xsl:param&gt;
 228
 229 </programlisting>
 230 </refsynopsisdiv>
 231
 232 <refsection><info><title>Description</title></info>
 233
 234 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
 235 are used to represent callout numbers instead of plain text. The value
 236 of <parameter>callout.graphics.number.limit</parameter> is the largest
 237 number for which a graphic exists. If the callout number exceeds this
 238 limit, the default presentation "(plain text instead of a graphic)"
 239 will  be used.
 240 </para>
 241
 242 </refsection>
 243 </refentry>
 244
 245 <refentry version="5.0" xml:id="callout.graphics.path">
 246 <refmeta>
 247 <refentrytitle>callout.graphics.path</refentrytitle>
 248 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
 249 </refmeta>
 250 <refnamediv>
 251 <refname>callout.graphics.path</refname>
 252 <refpurpose>Path to callout graphics</refpurpose>
 253 </refnamediv>
 254
 255 <refsynopsisdiv>
 256 <programlisting xml:id="callout.graphics.path.frag">
 257 &lt;xsl:param name="callout.graphics.path"&gt;images/callouts/&lt;/xsl:param&gt;
 258 </programlisting>
 259 </refsynopsisdiv>
 260
 261 <refsection><info><title>Description</title></info>
 262
 263 <para>Sets the path to the directory holding the callout graphics. his
 264 location is normally relative to the output html directory. see
 265 base.dir. Always terminate the directory with / since the graphic file
 266 is appended to this string, hence needs the separator.
 267 </para>
 268
 269 </refsection>
 270 </refentry>
 271
 272 <refentry version="5.0" xml:id="callout.graphics">
 273 <refmeta>
 274 <refentrytitle>callout.graphics</refentrytitle>
 275 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 276 </refmeta>
 277 <refnamediv>
 278 <refname>callout.graphics</refname>
 279 <refpurpose>Use graphics for callouts?</refpurpose>
 280 </refnamediv>
 281
 282 <refsynopsisdiv>
 283 <programlisting xml:id="callout.graphics.frag">
 284 &lt;xsl:param name="callout.graphics" select="1"&gt;&lt;/xsl:param&gt;
 285 </programlisting>
 286 </refsynopsisdiv>
 287
 288 <refsection><info><title>Description</title></info>
 289
 290 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
 291 circled numbers instead of "(1)", "(2)", etc.).
 292 Default graphics are provided in the distribution.
 293 </para>
 294
 295 </refsection>
 296 </refentry>
 297
 298 <refentry version="5.0" xml:id="callout.list.table">
 299 <refmeta>
 300 <refentrytitle>callout.list.table</refentrytitle>
 301 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 302 </refmeta>
 303 <refnamediv>
 304 <refname>callout.list.table</refname>
 305 <refpurpose>Present callout lists using a table?</refpurpose>
 306 </refnamediv>
 307
 308 <refsynopsisdiv>
 309 <programlisting xml:id="callout.list.table.frag">
 310 &lt;xsl:param name="callout.list.table" select="1"&gt;&lt;/xsl:param&gt;
 311 </programlisting>
 312 </refsynopsisdiv>
 313
 314 <refsection><info><title>Description</title></info>
 315
 316 <para>The default presentation of <tag>calloutlist</tag>s uses
 317 an HTML <tag>DL</tag> element. Some browsers don't align DLs very well
 318 if <parameter>callout.graphics</parameter> is used. With this option
 319 turned on, <tag>calloutlist</tag>s are presented in an HTML
 320 <tag>TABLE</tag>, which usually results in better alignment
 321 of the callout number with the callout description.</para>
 322
 323 </refsection>
 324 </refentry>
 325
 326 <refentry version="5.0" xml:id="callout.unicode.number.limit">
 327 <refmeta>
 328 <refentrytitle>callout.unicode.number.limit</refentrytitle>
 329 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 330 </refmeta>
 331 <refnamediv>
 332 <refname>callout.unicode.number.limit</refname>
 333 <refpurpose>Number of the largest unicode callout character</refpurpose>
 334 </refnamediv>
 335
 336 <refsynopsisdiv>
 337 <programlisting xml:id="callout.unicode.number.limit.frag">
 338 &lt;xsl:param name="callout.unicode.number.limit"&gt;10&lt;/xsl:param&gt;
 339 </programlisting>
 340 </refsynopsisdiv>
 341
 342 <refsection><info><title>Description</title></info>
 343
 344 <para>If <parameter>callout.unicode</parameter>
 345 is non-zero, unicode characters are used to represent
 346 callout numbers. The value of
 347 <parameter>callout.unicode.number.limit</parameter>
 348 is
 349 the largest number for which a unicode character exists. If the callout number
 350 exceeds this limit, the default presentation "(nnn)" will always
 351 be used.
 352 </para>
 353
 354 </refsection>
 355 </refentry>
 356
 357 <refentry version="5.0" xml:id="callout.unicode.start.character">
 358 <refmeta>
 359 <refentrytitle>callout.unicode.start.character</refentrytitle>
 360 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 361 </refmeta>
 362 <refnamediv>
 363 <refname>callout.unicode.start.character</refname>
 364 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
 365 </refnamediv>
 366
 367 <refsynopsisdiv>
 368 <programlisting xml:id="callout.unicode.start.character.frag">
 369 &lt;xsl:param name="callout.unicode.start.character"&gt;10102&lt;/xsl:param&gt;
 370 </programlisting>
 371 </refsynopsisdiv>
 372
 373 <refsection><info><title>Description</title></info>
 374
 375 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
 376 is non-zero, unicode characters are used to represent
 377 callout numbers. The value of
 378 <parameter>callout.unicode.start.character</parameter>
 379 is the decimal unicode value used for callout number one. Currently,
 380 only 10102 is supported in the stylesheets for this parameter.
 381 </para>
 382
 383 </refsection>
 384 </refentry>
 385
 386 <refentry version="5.0" xml:id="callout.unicode">
 387 <refmeta>
 388 <refentrytitle>callout.unicode</refentrytitle>
 389 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 390 </refmeta>
 391 <refnamediv>
 392 <refname>callout.unicode</refname>
 393 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
 394 </refnamediv>
 395
 396 <refsynopsisdiv>
 397 <programlisting xml:id="callout.unicode.frag">&lt;xsl:param name="callout.unicode" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
 398 </refsynopsisdiv>
 399
 400 <refsection><info><title>Description</title></info>
 401
 402 <para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option.
 403 </para>
 404
 405 </refsection>
 406 </refentry>
 407
 408 <refentry version="5.0" xml:id="callouts.extension">
 409 <refmeta>
 410 <refentrytitle>callouts.extension</refentrytitle>
 411 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 412 </refmeta>
 413 <refnamediv>
 414 <refname>callouts.extension</refname>
 415 <refpurpose>Enable the callout extension</refpurpose>
 416 </refnamediv>
 417
 418 <refsynopsisdiv>
 419 <programlisting xml:id="callouts.extension.frag">
 420 &lt;xsl:param name="callouts.extension" select="1"&gt;&lt;/xsl:param&gt;
 421 </programlisting>
 422 </refsynopsisdiv>
 423
 424 <refsection><info><title>Description</title></info>
 425
 426 <para>The callouts extension processes <tag>areaset</tag>
 427 elements in <tag>programlistingco</tag> and other text-based
 428 callout elements.
 429 </para>
 430
 431 </refsection>
 432 </refentry>
 433
 434 </reference>
 435 <reference xml:id="ebnf"><title>EBNF</title>
 436 <refentry version="5.0" xml:id="ebnf.table.bgcolor">
 437 <refmeta>
 438 <refentrytitle>ebnf.table.bgcolor</refentrytitle>
 439 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
 440 </refmeta>
 441 <refnamediv>
 442 <refname>ebnf.table.bgcolor</refname>
 443 <refpurpose>Background color for EBNF tables</refpurpose>
 444 </refnamediv>
 445
 446 <refsynopsisdiv>
 447 <programlisting xml:id="ebnf.table.bgcolor.frag">
 448 &lt;xsl:param name="ebnf.table.bgcolor"&gt;#F5DCB3&lt;/xsl:param&gt;
 449 </programlisting>
 450 </refsynopsisdiv>
 451
 452 <refsection><info><title>Description</title></info>
 453
 454 <para>Sets the background color for EBNF tables (a pale brown). No
 455 <tag>bgcolor</tag> attribute is output if
 456 <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para>
 457
 458
 459 </refsection>
 460 </refentry>
 461
 462 <refentry version="5.0" xml:id="ebnf.table.border">
 463 <refmeta>
 464 <refentrytitle>ebnf.table.border</refentrytitle>
 465 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 466 </refmeta>
 467 <refnamediv>
 468 <refname>ebnf.table.border</refname>
 469 <refpurpose>Selects border on EBNF tables</refpurpose>
 470 </refnamediv>
 471
 472 <refsynopsisdiv>
 473 <programlisting xml:id="ebnf.table.border.frag">&lt;xsl:param name="ebnf.table.border" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
 474 </refsynopsisdiv>
 475
 476 <refsection><info><title>Description</title></info>
 477
 478 <para>Selects the border on EBNF tables. If non-zero, the tables have
 479 borders, otherwise they don't.</para>
 480
 481 </refsection>
 482 </refentry>
 483
 484 <refentry version="5.0" xml:id="ebnf.assignment">
 485 <refmeta>
 486 <refentrytitle>ebnf.assignment</refentrytitle>
 487 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
 488 </refmeta>
 489 <refnamediv>
 490 <refname>ebnf.assignment</refname>
 491 <refpurpose>The EBNF production assignment operator</refpurpose>
 492 </refnamediv>
 493
 494 <refsynopsisdiv>
 495 <programlisting xml:id="ebnf.assignment.frag">
 496 &lt;xsl:param name="ebnf.assignment"&gt;
 497 &lt;code&gt;::=&lt;/code&gt;
 498 &lt;/xsl:param&gt;
 499
 500 </programlisting>
 501 </refsynopsisdiv>
 502
 503 <refsection><info><title>Description</title></info>
 504
 505 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
 506 text is used to show <quote>assignment</quote> in <tag>production</tag>s
 507 in <tag>productionset</tag>s.</para>
 508
 509 <para>While <quote><literal>::=</literal></quote> is common, so are several
 510 other operators.</para>
 511
 512 </refsection>
 513 </refentry>
 514
 515 <refentry version="5.0" xml:id="ebnf.statement.terminator">
 516 <refmeta>
 517 <refentrytitle>ebnf.statement.terminator</refentrytitle>
 518 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
 519 </refmeta>
 520 <refnamediv>
 521 <refname>ebnf.statement.terminator</refname>
 522 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
 523 </refnamediv>
 524
 525 <refsynopsisdiv>
 526 <programlisting xml:id="ebnf.statement.terminator.frag">
 527 &lt;xsl:param name="ebnf.statement.terminator"&gt;&lt;/xsl:param&gt;
 528
 529 </programlisting>
 530 </refsynopsisdiv>
 531
 532 <refsection><info><title>Description</title></info>
 533
 534 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
 535 text is used to terminate each <tag>production</tag>
 536 in <tag>productionset</tag>.</para>
 537
 538 <para>Some notations end each statement with a period.</para>
 539
 540 </refsection>
 541 </refentry>
 542
 543 </reference>
 544 <reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title>
 545 <refentry version="5.0" xml:id="annotate.toc">
 546 <refmeta>
 547 <refentrytitle>annotate.toc</refentrytitle>
 548 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 549 </refmeta>
 550 <refnamediv>
 551 <refname>annotate.toc</refname>
 552 <refpurpose>Annotate the Table of Contents?</refpurpose>
 553 </refnamediv>
 554
 555 <refsynopsisdiv>
 556 <programlisting xml:id="annotate.toc.frag">&lt;xsl:param name="annotate.toc" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
 557 </refsynopsisdiv>
 558
 559 <refsection><info><title>Description</title></info>
 560
 561 <para>If true, TOCs will be annotated. At present, this just means
 562 that the <tag>refpurpose</tag> of <tag>refentry</tag>
 563 TOC entries will be displayed.
 564 </para>
 565
 566 </refsection>
 567 </refentry>
 568
 569 <refentry version="5.0" xml:id="autotoc.label.separator">
 570 <refmeta>
 571 <refentrytitle>autotoc.label.separator</refentrytitle>
 572 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
 573 </refmeta>
 574 <refnamediv>
 575 <refname>autotoc.label.separator</refname>
 576 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
 577 </refnamediv>
 578
 579 <refsynopsisdiv>
 580 <programlisting xml:id="autotoc.label.separator.frag">
 581 &lt;xsl:param name="autotoc.label.separator"&gt;. &lt;/xsl:param&gt;
 582 </programlisting>
 583 </refsynopsisdiv>
 584
 585 <refsection><info><title>Description</title></info>
 586
 587 <para>String used to separate labels and titles in a table of contents.</para>
 588
 589 </refsection>
 590 </refentry>
 591
 592 <refentry version="5.0" xml:id="autotoc.label.in.hyperlink">
 593 <refmeta>
 594 <refentrytitle>autotoc.label.in.hyperlink</refentrytitle>
 595 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 596 </refmeta>
 597 <refnamediv>
 598 <refname>autotoc.label.in.hyperlink</refname>
 599 <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose>
 600 </refnamediv>
 601
 602 <refsynopsisdiv>
 603 <programlisting xml:id="autotoc.label.in.hyperlink.frag">&lt;xsl:param name="autotoc.label.in.hyperlink" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
 604 </refsynopsisdiv>
 605
 606 <refsection><info><title>Description</title></info>
 607
 608 <para>If the value of
 609 <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels
 610 are included in hyperlinked titles in the TOC. If it is instead zero,
 611 labels are still displayed prior to the hyperlinked titles, but
 612 are not hyperlinked along with the titles.</para>
 613
 614 </refsection>
 615 </refentry>
 616
 617 <refentry version="5.0" xml:id="process.source.toc">
 618 <refmeta>
 619 <refentrytitle>process.source.toc</refentrytitle>
 620 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 621 </refmeta>
 622 <refnamediv>
 623 <refname>process.source.toc</refname>
 624 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
 625 </refnamediv>
 626
 627 <refsynopsisdiv>
 628 <programlisting xml:id="process.source.toc.frag">&lt;xsl:param name="process.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
 629 </refsynopsisdiv>
 630
 631 <refsection><info><title>Description</title></info>
 632
 633 <para>Specifies that the contents of a non-empty "hard-coded"
 634 <tag>toc</tag> element in a source document are processed to
 635 generate a TOC in output.
 636 <note>
 637   <para>This parameter has no effect on automated generation of
 638   TOCs. An automated TOC may still be generated along with the
 639   "hard-coded" TOC. To suppress automated TOC generation, adjust the
 640   value of the <parameter>generate.toc</parameter> paramameter.</para>
 641
 642   <para>The <tag>process.source.toc</tag> parameter also has
 643   no effect if the <tag>toc</tag> element is empty; handling
 644   for empty <tag>toc</tag> is controlled by the
 645   <parameter>process.empty.source.toc</parameter> parameter.</para>
 646 </note>
 647 </para>
 648
 649 </refsection>
 650 </refentry>
 651
 652 <refentry version="5.0" xml:id="process.empty.source.toc">
 653 <refmeta>
 654 <refentrytitle>process.empty.source.toc</refentrytitle>
 655 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 656 </refmeta>
 657 <refnamediv>
 658 <refname>process.empty.source.toc</refname>
 659 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
 660 </refnamediv>
 661
 662 <refsynopsisdiv>
 663 <programlisting xml:id="process.empty.source.toc.frag">&lt;xsl:param name="process.empty.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
 664 </refsynopsisdiv>
 665
 666 <refsection><info><title>Description</title></info>
 667
 668 <para>Specifies that if an empty <tag>toc</tag> element is found in a
 669 source document, an automated TOC is generated at this point in the
 670 document.
 671 <note>
 672   <para>Depending on what the value of the
 673   <parameter>generate.toc</parameter> parameter is, setting this
 674   parameter to <literal>1</literal> could result in generation of
 675   duplicate automated TOCs. So the
 676   <parameter>process.empty.source.toc</parameter> is primarily useful
 677   as an "override": by placing an empty <tag>toc</tag> in your
 678   document and setting this parameter to <literal>1</literal>, you can
 679   force a TOC to be generated even if <tag>generate.toc</tag>
 680   says not to.</para>
 681 </note>
 682 </para>
 683
 684 </refsection>
 685 </refentry>
 686
 687 <refentry version="5.0" xml:id="bridgehead.in.toc">
 688 <refmeta>
 689 <refentrytitle>bridgehead.in.toc</refentrytitle>
 690 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 691 </refmeta>
 692 <refnamediv>
 693 <refname>bridgehead.in.toc</refname>
 694 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
 695 </refnamediv>
 696
 697 <refsynopsisdiv>
 698 <programlisting xml:id="bridgehead.in.toc.frag">&lt;xsl:param name="bridgehead.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
 699 </refsynopsisdiv>
 700
 701 <refsection><info><title>Description</title></info>
 702
 703 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
 704 this option is not fully supported and may be removed in a future
 705 version of the stylesheets.
 706 </para>
 707
 708 </refsection>
 709 </refentry>
 710
 711 <refentry version="5.0" xml:id="simplesect.in.toc">
 712 <refmeta>
 713 <refentrytitle>simplesect.in.toc</refentrytitle>
 714 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 715 </refmeta>
 716 <refnamediv>
 717 <refname>simplesect.in.toc</refname>
 718 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
 719 </refnamediv>
 720
 721 <refsynopsisdiv>
 722 <programlisting xml:id="simplesect.in.toc.frag">&lt;xsl:param name="simplesect.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
 723 </refsynopsisdiv>
 724
 725 <refsection><info><title>Description</title></info>
 726
 727 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
 728 </para>
 729
 730 </refsection>
 731 </refentry>
 732
 733 <refentry version="5.0" xml:id="manual.toc">
 734 <refmeta>
 735 <refentrytitle>manual.toc</refentrytitle>
 736 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
 737 </refmeta>
 738 <refnamediv>
 739 <refname>manual.toc</refname>
 740 <refpurpose>An explicit TOC to be used for the TOC</refpurpose>
 741 </refnamediv>
 742
 743 <refsynopsisdiv>
 744 <programlisting xml:id="manual.toc.frag">
 745 &lt;xsl:param name="manual.toc"&gt;&lt;/xsl:param&gt;
 746 </programlisting>
 747 </refsynopsisdiv>
 748
 749 <refsection><info><title>Description</title></info>
 750
 751 <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that
 752 will be used for building the printed TOC.
 753 </para>
 754
 755 </refsection>
 756 </refentry>
 757
 758 <refentry version="5.0" xml:id="toc.list.type">
 759 <refmeta>
 760 <refentrytitle>toc.list.type</refentrytitle>
 761 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
 762 <refmiscinfo class="other" otherclass="value">dl</refmiscinfo>
 763 <refmiscinfo class="other" otherclass="value">ul</refmiscinfo>
 764 <refmiscinfo class="other" otherclass="value">ol</refmiscinfo>
 765 </refmeta>
 766 <refnamediv>
 767 <refname>toc.list.type</refname>
 768 <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose>
 769 </refnamediv>
 770
 771 <refsynopsisdiv>
 772 <programlisting xml:id="toc.list.type.frag">&lt;xsl:param name="toc.list.type"&gt;dl&lt;/xsl:param&gt;</programlisting>
 773 </refsynopsisdiv>
 774
 775 <refsection><info><title>Description</title></info>
 776
 777 <para>When an automatically generated Table of Contents (or List of Titles)
 778 is produced, this HTML element will be used to make the list.
 779 </para>
 780
 781 </refsection>
 782 </refentry>
 783
 784 <refentry version="5.0" xml:id="toc.section.depth">
 785 <refmeta>
 786 <refentrytitle>toc.section.depth</refentrytitle>
 787 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 788 </refmeta>
 789 <refnamediv>
 790 <refname>toc.section.depth</refname>
 791 <refpurpose>How deep should recursive <tag>section</tag>s appear
 792 in the TOC?</refpurpose>
 793 </refnamediv>
 794
 795 <refsynopsisdiv>
 796 <programlisting xml:id="toc.section.depth.frag">&lt;xsl:param name="toc.section.depth"&gt;2&lt;/xsl:param&gt;</programlisting>
 797 </refsynopsisdiv>
 798
 799 <refsection><info><title>Description</title></info>
 800
 801 <para>Specifies the depth to which recursive sections should appear in the
 802 TOC.
 803 </para>
 804
 805 </refsection>
 806 </refentry>
 807
 808 <refentry version="5.0" xml:id="toc.max.depth">
 809 <refmeta>
 810 <refentrytitle>toc.max.depth</refentrytitle>
 811 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 812 </refmeta>
 813 <refnamediv>
 814 <refname>toc.max.depth</refname>
 815 <refpurpose>How many levels should be created for each TOC?</refpurpose>
 816 </refnamediv>
 817
 818 <refsynopsisdiv>
 819 <programlisting xml:id="toc.max.depth.frag">&lt;xsl:param name="toc.max.depth"&gt;8&lt;/xsl:param&gt;</programlisting>
 820 </refsynopsisdiv>
 821
 822 <refsection><info><title>Description</title></info>
 823
 824 <para>Specifies the maximal depth of TOC on all levels.</para>
 825
 826 </refsection>
 827 </refentry>
 828
 829 <refentry version="5.0" xml:id="generate.toc">
 830 <refmeta>
 831 <refentrytitle>generate.toc</refentrytitle>
 832 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
 833 </refmeta>
 834 <refnamediv>
 835 <refname>generate.toc</refname>
 836 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
 837 </refnamediv>
 838
 839 <refsynopsisdiv>
 840 <programlisting xml:id="generate.toc.frag">
 841 &lt;xsl:param name="generate.toc"&gt;
 842 appendix  toc,title
 843 article/appendix  nop
 844 article   toc,title
 845 book      toc,title,figure,table,example,equation
 846 chapter   toc,title
 847 part      toc,title
 848 preface   toc,title
 849 qandadiv  toc
 850 qandaset  toc
 851 reference toc,title
 852 sect1     toc
 853 sect2     toc
 854 sect3     toc
 855 sect4     toc
 856 sect5     toc
 857 section   toc
 858 set       toc,title
 859 &lt;/xsl:param&gt;
 860
 861 </programlisting>
 862 </refsynopsisdiv>
 863
 864 <refsection><info><title>Description</title></info>
 865
 866 <para>This parameter has a structured value. It is a table of space-delimited
 867 path/value pairs. Each path identifies some element in the source document
 868 using a restricted subset of XPath (only the implicit child axis, no wildcards,
 869 no predicates). Paths can be either relative or absolute.</para>
 870
 871 <para>When processing a particular element, the stylesheets consult this table to
 872 determine if a ToC (or LoT(s)) should be generated.</para>
 873
 874 <para>For example, consider the entry:</para>
 875
 876 <screen>book toc,figure</screen>
 877
 878 <para>This indicates that whenever a <tag>book</tag> is formatted, a
 879 Table Of Contents and a List of Figures should be generated. Similarly,</para>
 880
 881 <screen>/chapter toc</screen>
 882
 883 <para>indicates that whenever a document <emphasis>that has a root
 884 of</emphasis> <tag>chapter</tag> is formatted, a Table of
 885 Contents should be generated. The entry <literal>chapter</literal> would match
 886 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
 887 document elements.</para>
 888
 889 <para>Generally, the longest match wins. So, for example, if you want to distinguish
 890 articles in books from articles in parts, you could use these two entries:</para>
 891
 892 <screen>book/article toc,figure
 893 part/article toc</screen>
 894
 895 <para>Note that an article in a part can never match a <literal>book/article</literal>,
 896 so if you want nothing to be generated for articles in parts, you can simply leave
 897 that rule out.</para>
 898
 899 <para>If you want to leave the rule in, to make it explicit that you're turning
 900 something off, use the value <quote>nop</quote>. For example, the following
 901 entry disables ToCs and LoTs for articles:</para>
 902
 903 <screen>article nop</screen>
 904
 905 <para>Do not simply leave the word <quote>article</quote> in the file
 906 without a matching value. That'd be just begging the silly little
 907 path/value parser to get confused.</para>
 908
 909 <para>Section ToCs are further controlled by the
 910 <parameter>generate.section.toc.level</parameter> parameter.
 911 For a given section level to have a ToC, it must have both an entry in
 912 <parameter>generate.toc</parameter> and be within the range enabled by
 913 <parameter>generate.section.toc.level</parameter>.</para>
 914 </refsection>
 915 </refentry>
 916
 917 <refentry version="5.0" xml:id="generate.section.toc.level">
 918 <refmeta>
 919 <refentrytitle>generate.section.toc.level</refentrytitle>
 920 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
 921 </refmeta>
 922 <refnamediv>
 923 <refname>generate.section.toc.level</refname>
 924 <refpurpose>Control depth of TOC generation in sections</refpurpose>
 925 </refnamediv>
 926
 927 <refsynopsisdiv>
 928 <programlisting xml:id="generate.section.toc.level.frag">
 929 &lt;xsl:param name="generate.section.toc.level" select="0"&gt;&lt;/xsl:param&gt;
 930 </programlisting>
 931 </refsynopsisdiv>
 932
 933 <refsection><info><title>Description</title></info>
 934
 935 <para>The <parameter>generate.section.toc.level</parameter> parameter
 936 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
 937 that this is related to, but not the same as
 938 <parameter>toc.section.depth</parameter>, which controls the depth to
 939 which TOC entries will be generated in a given TOC.</para>
 940 <para>If, for example, <parameter>generate.section.toc.level</parameter>
 941 is <literal>3</literal>, TOCs will be generated in first, second, and third
 942 level sections, but not in fourth level sections.
 943 </para>
 944
 945 </refsection>
 946 </refentry>
 947
 948 <refentry version="5.0" xml:id="generate.index">
 949 <refmeta>
 950 <refentrytitle>generate.index</refentrytitle>
 951 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
 952 </refmeta>
 953 <refnamediv>
 954 <refname>generate.index</refname>
 955 <refpurpose>Do you want an index?</refpurpose>
 956 </refnamediv>
 957
 958 <refsynopsisdiv>
 959 <programlisting xml:id="generate.index.frag">&lt;xsl:param name="generate.index" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
 960 </refsynopsisdiv>
 961
 962 <refsection><info><title>Description</title></info>
 963
 964 <para>Specify if an index should be generated. </para>
 965
 966 </refsection>
 967 </refentry>
 968
 969 <refentry version="5.0" xml:id="index.method">
 970 <refmeta>
 971 <refentrytitle>index.method</refentrytitle>
 972 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
 973 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
 974 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
 975 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
 976 </refmeta>
 977 <refnamediv>
 978 <refname>index.method</refname>
 979 <refpurpose>Select method used to group index entries in an index</refpurpose>
 980 </refnamediv>
 981
 982 <refsynopsisdiv>
 983 <programlisting xml:id="index.method.frag">
 984 &lt;xsl:param name="index.method"&gt;basic&lt;/xsl:param&gt;
 985 </programlisting>
 986 </refsynopsisdiv>
 987
 988 <refsection><info><title>Description</title></info>
 989
 990 <para>This parameter lets you select which method to use for sorting and grouping
 991  index entries in an index.
 992 Indexes in Latin-based languages that have accented characters typically
 993 sort together accented words and unaccented words.
 994 Thus <quote>&#193;</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
 995 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
 996 section of the index.
 997 Languages using other alphabets (such as Russian,  which is written in the Cyrillic alphabet)
 998 and languages using ideographic chararacters (such as Japanese)
 999 require grouping specific to the languages and alphabets.
1000 </para>
1001
1002 <para>The default indexing method is limited.
1003 It can group accented characters in Latin-based languages only.
1004 It cannot handle non-Latin alphabets or ideographic languages.
1005 The other indexing methods require extensions of one type or
1006 another, and do not work with
1007 all XSLT processors, which is why they are not used by default.</para>
1008
1009 <para>The three choices for indexing method are:</para>
1010 <variablelist>
1011 <varlistentry>
1012 <term><literal>basic</literal></term>
1013 <listitem>
1014 <para>
1015 (default)  Sort and groups words based only on the Latin alphabet.
1016 Words with accented Latin letters will group and sort with
1017 their respective primary letter, but
1018 words in non-Latin alphabets will be
1019 put in the <quote>Symbols</quote> section of the index.
1020 </para>
1021 </listitem>
1022 </varlistentry>
1023 <varlistentry>
1024 <term><literal>kosek</literal></term>
1025 <listitem>
1026 <para>
1027 This method sorts and groups words based on letter groups configured in
1028 the DocBook locale file for the given language.
1029 See, for example, the French locale file <filename>common/fr.xml</filename>.
1030 This method requires that the XSLT processor
1031 supports the EXSLT extensions (most do).
1032 It also requires support for using
1033 user-defined functions in xsl:key (xsltproc does not).
1034 </para>
1035 <para>This method is suitable for any language for which you can
1036 list all the individual characters that should appear
1037 in each letter group in an index.
1038 It is probably not practical to use it for ideographic languages
1039 such as Chinese that have hundreds or thousands of characters.
1040 </para>
1041
1042 <para>To use the kosek method, you must:</para>
1043
1044 <orderedlist>
1045 <listitem>
1046 <para>Use a processor that supports its extensions, such as
1047 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
1048 </para>
1049 </listitem>
1050 <listitem>
1051 <para>Set the index.method parameter's value to <quote>kosek</quote>.
1052 </para>
1053 </listitem>
1054 <listitem>
1055 <para>Import the appropriate index extensions stylesheet module
1056 <filename>fo/autoidx-kosek.xsl</filename> or
1057 <filename>html/autoidx-kosek.xsl</filename> into your
1058 customization.
1059 </para>
1060 </listitem>
1061 </orderedlist>
1062
1063 </listitem>
1064 </varlistentry>
1065 <varlistentry>
1066 <term><literal>kimber</literal></term>
1067 <listitem>
1068 <para>
1069 This method uses extensions to the Saxon processor to implement
1070 sophisticated indexing processes. It uses its own
1071 configuration file, which can include information for any number of
1072 languages. Each language's configuration can group
1073 words using one of two processes. In the
1074 enumerated process similar to that used in the kosek method,
1075 you indicate the groupings character-by-character.
1076 In the between-key process, you specify the
1077 break-points in the sort order that should start a new group.
1078 The latter configuration is useful for ideographic languages
1079 such as Chinese, Japanese, and Korean.
1080 You can also define your own collation algorithms and how you
1081 want mixed Latin-alphabet words sorted.</para>
1082 <itemizedlist>
1083 <listitem>
1084 <para>For a whitepaper describing the extensions, see:
1085 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>.
1086 </para>
1087 </listitem>
1088 <listitem>
1089 <para>To download the extension library, see
1090 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
1091 </para>
1092 </listitem>
1093 </itemizedlist>
1094
1095 <para>To use the kimber method, you must:</para>
1096
1097 <orderedlist>
1098 <listitem>
1099 <para>Use Saxon (version 6 or 8) as your XSLT processor.
1100 </para>
1101 </listitem>
1102 <listitem>
1103 <para>Install and configure the Innodata Isogen library, using
1104 the documentation that comes with it.
1105 </para>
1106 </listitem>
1107 <listitem>
1108 <para>Set the index.method parameter's value to <quote>kimber</quote>.
1109 </para>
1110 </listitem>
1111 <listitem>
1112 <para>Import the appropriate index extensions stylesheet module
1113 <filename>fo/autoidx-kimber.xsl</filename> or
1114 <filename>html/autoidx-kimber.xsl</filename> into your
1115 customization.
1116 </para>
1117 </listitem>
1118 </orderedlist>
1119
1120 </listitem>
1121 </varlistentry>
1122 </variablelist>
1123
1124 </refsection>
1125 </refentry>
1126
1127 <refentry version="5.0" xml:id="index.on.type">
1128 <refmeta>
1129 <refentrytitle>index.on.type</refentrytitle>
1130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1131 </refmeta>
1132 <refnamediv>
1133 <refname>index.on.type</refname>
1134 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
1135 attribute value</refpurpose>
1136 </refnamediv>
1137
1138 <refsynopsisdiv>
1139 <programlisting xml:id="index.on.type.frag">
1140 &lt;xsl:param name="index.on.type" select="0"&gt;&lt;/xsl:param&gt;
1141 </programlisting>
1142 </refsynopsisdiv>
1143
1144 <refsection><info><title>Description</title></info>
1145
1146 <para>
1147 If non-zero,
1148 then an <tag>index</tag> element that has a
1149 <tag class="attribute">type</tag> attribute
1150 value will contain only those <tag>indexterm</tag>
1151 elements with a matching <tag class="attribute">type</tag> attribute value.
1152 If an <tag>index</tag> has no <tag class="attribute">type</tag>
1153 attribute or it is blank, then the index will contain
1154 all <tag>indexterm</tag>s in the current scope.
1155 </para>
1156
1157 <para>
1158 If <literal>index.on.type</literal> is zero, then the
1159 <tag class="attribute">type</tag> attribute has no effect
1160 on selecting indexterms for an index.
1161 </para>
1162
1163 <para>For those using DocBook version 4.2 or earlier,
1164 the <tag class="attribute">type</tag> attribute is not available
1165 for index terms.  However, you can achieve the same
1166 effect by using the <tag class="attribute">role</tag> attribute
1167 in the same manner on <tag>indexterm</tag>
1168 and <tag>index</tag>, and setting the stylesheet parameter
1169 <parameter>index.on.role</parameter> to a nonzero value.
1170 </para>
1171
1172 </refsection>
1173 </refentry>
1174
1175 <refentry version="5.0" xml:id="index.on.role">
1176 <refmeta>
1177 <refentrytitle>index.on.role</refentrytitle>
1178 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1179 </refmeta>
1180 <refnamediv>
1181 <refname>index.on.role</refname>
1182 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
1183 </refnamediv>
1184
1185 <refsynopsisdiv>
1186 <programlisting xml:id="index.on.role.frag">
1187 &lt;xsl:param name="index.on.role" select="0"&gt;&lt;/xsl:param&gt;
1188 </programlisting>
1189 </refsynopsisdiv>
1190
1191 <refsection><info><title>Description</title></info>
1192
1193 <para>
1194 If non-zero,
1195 then an <tag>index</tag> element that has a
1196 <tag class="attribute">role</tag> attribute
1197 value will contain only those <tag>indexterm</tag>
1198 elements with a matching role value.
1199 If an <tag>index</tag> has no <tag class="attribute">role</tag>
1200 attribute or it is blank, then the index will contain
1201 all <tag>indexterm</tag>s in the current scope.
1202 </para>
1203 <para>
1204 If <literal>index.on.role</literal> is zero, then the
1205 <tag class="attribute">role</tag> attribute has no effect
1206 on selecting indexterms for an index.
1207 </para>
1208
1209 <para>If you are using DocBook version 4.3 or later, you should
1210 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
1211 on <tag>indexterm</tag> and <tag>index</tag>,
1212 and set the <parameter>index.on.type</parameter> to a nonzero
1213 value.
1214 </para>
1215
1216 </refsection>
1217 </refentry>
1218
1219 <refentry version="5.0" xml:id="index.links.to.section">
1220 <refmeta>
1221 <refentrytitle>index.links.to.section</refentrytitle>
1222 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1223 </refmeta>
1224 <refnamediv>
1225 <refname>index.links.to.section</refname>
1226 <refpurpose>HTML index entries link to container section title</refpurpose>
1227 </refnamediv>
1228
1229 <refsynopsisdiv>
1230 <programlisting xml:id="index.links.to.section.frag">
1231 &lt;xsl:param name="index.links.to.section" select="1"&gt;&lt;/xsl:param&gt;
1232 </programlisting>
1233 </refsynopsisdiv>
1234
1235 <refsection><info><title>Description</title></info>
1236
1237 <para>If zero, then an index entry in an index links
1238 directly to the location of the
1239 generated <tag>anchor</tag> that is output
1240 for the indexterm. If two identical indexterm elements
1241 exist in the same section, then both entries appear
1242 in the index with the same title but link to different
1243 locations.</para>
1244
1245 <para>If non-zero, then an index entry in an index links to the
1246 section title containing the <tag>indexterm</tag>, rather than
1247 directly to the <tag>anchor</tag> output for the indexterm.
1248 Duplicate indexterm entries in the same section are dropped.
1249 </para>
1250
1251 <para>The default value is 1, so index entries link to
1252 section titles by default.</para>
1253
1254 <para>In both cases, the link text in an index entry is the
1255 title of the section containing the indexterm.
1256 That is because HTML does not have numbered pages.
1257 It also provides the reader with context information
1258 for each link.</para>
1259
1260 <para>This parameter lets you choose which style of
1261 index linking you want. </para>
1262
1263 <itemizedlist>
1264 <listitem>
1265 <para>When set to 0, an index entry takes you
1266 to the precise location of its corresponding indexterm.
1267 However, if you have a lot of duplicate
1268 entries in sections, then you have a lot of duplicate
1269 titles in the index, which makes it more cluttered.
1270 The reader may not recognize why duplicate titles
1271 appear until they follow the links. Also, the links
1272 may land the reader in the middle of a section where the
1273 section title is not visible, which may also be
1274 confusing to the reader.</para>
1275 </listitem>
1276 <listitem>
1277 <para>When set to 1, an index entry link is
1278 less precise, but duplicate titles in the
1279 index entries are eliminated.
1280 Landing on the section title location may confirm the reader's
1281 expectation that a link that
1282 shows a section title will take them to that section title,
1283 not a location within the section.
1284 </para>
1285 </listitem>
1286 </itemizedlist>
1287
1288 </refsection>
1289 </refentry>
1290
1291 <refentry version="5.0" xml:id="index.prefer.titleabbrev">
1292 <refmeta>
1293 <refentrytitle>index.prefer.titleabbrev</refentrytitle>
1294 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1295 </refmeta>
1296 <refnamediv>
1297 <refname>index.prefer.titleabbrev</refname>
1298 <refpurpose>Should abbreviated titles be used as back references?</refpurpose>
1299 </refnamediv>
1300
1301 <refsynopsisdiv>
1302 <programlisting xml:id="index.prefer.titleabbrev.frag">
1303 &lt;xsl:param name="index.prefer.titleabbrev" select="0"&gt;&lt;/xsl:param&gt;
1304 </programlisting>
1305 </refsynopsisdiv>
1306
1307 <refsection><info><title>Description</title></info>
1308
1309 <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
1310 is used as the link text of a back reference in the index.
1311 </para>
1312
1313 </refsection>
1314 </refentry>
1315
1316 <refentry version="5.0" xml:id="index.term.separator">
1317 <refmeta>
1318 <refentrytitle>index.term.separator</refentrytitle>
1319 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1320 </refmeta>
1321 <refnamediv>
1322 <refname>index.term.separator</refname>
1323 <refpurpose>Override for punctuation separating an index term
1324 from its list of page references in an index</refpurpose>
1325 </refnamediv>
1326
1327 <refsynopsisdiv>
1328 <programlisting xml:id="index.term.separator.frag">
1329 &lt;xsl:param name="index.term.separator"&gt;&lt;/xsl:param&gt;
1330 </programlisting>
1331 </refsynopsisdiv>
1332
1333 <refsection><info><title>Description</title></info>
1334
1335 <para>This parameter permits you to override
1336 the text to insert between
1337 the end of an index term and its list of page references.
1338 Typically that might be a comma and a space.
1339 </para>
1340
1341 <para>Because this text may be locale dependent,
1342 this parameter's value is normally taken from a gentext
1343 template named 'term-separator' in the
1344 context 'index' in the stylesheet
1345 locale file for the language
1346 of the current document.
1347 This parameter can be used to override the gentext string,
1348 and would typically be used on the command line.
1349 This parameter would apply to all languages.
1350 </para>
1351
1352 <para>So this text string can be customized in two ways.
1353 You can reset the default gentext string using
1354 the <parameter>local.l10n.xml</parameter> parameter, or you can
1355 fill in the content for this normally empty
1356 override parameter.
1357 The content can be a simple string, or it can be
1358 something more complex such as a call-template.
1359 For fo output, it could be an <tag>fo:leader</tag>
1360 element to provide space of a specific length, or a dot leader.
1361 </para>
1362
1363 </refsection>
1364 </refentry>
1365
1366 <refentry version="5.0" xml:id="index.number.separator">
1367 <refmeta>
1368 <refentrytitle>index.number.separator</refentrytitle>
1369 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1370 </refmeta>
1371 <refnamediv>
1372 <refname>index.number.separator</refname>
1373 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
1374 </refnamediv>
1375
1376 <refsynopsisdiv>
1377 <programlisting xml:id="index.number.separator.frag">
1378 &lt;xsl:param name="index.number.separator"&gt;&lt;/xsl:param&gt;
1379 </programlisting>
1380 </refsynopsisdiv>
1381
1382 <refsection><info><title>Description</title></info>
1383
1384 <para>This parameter permits you to override the text to insert between
1385 page references in a formatted index entry.  Typically
1386 that would be a comma and a space.
1387 </para>
1388
1389 <para>Because this text may be locale dependent,
1390 this parameter's value is normally taken from a gentext
1391 template named 'number-separator' in the
1392 context 'index' in the stylesheet
1393 locale file for the language
1394 of the current document.
1395 This parameter can be used to override the gentext string,
1396 and would typically be used on the command line.
1397 This parameter would apply to all languages.
1398 </para>
1399
1400 <para>So this text string can be customized in two ways.
1401 You can reset the default gentext string using
1402 the <parameter>local.l10n.xml</parameter> parameter, or you can
1403 override the gentext with the content of this parameter.
1404 The content can be a simple string, or it can be
1405 something more complex such as a call-template.
1406 </para>
1407
1408 <para>In HTML index output, section title references are used instead of
1409 page number references.  This punctuation appears between
1410 such section titles in an HTML index.
1411 </para>
1412
1413 </refsection>
1414 </refentry>
1415
1416 <refentry version="5.0" xml:id="index.range.separator">
1417 <refmeta>
1418 <refentrytitle>index.range.separator</refentrytitle>
1419 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1420 </refmeta>
1421 <refnamediv>
1422 <refname>index.range.separator</refname>
1423 <refpurpose>Override for punctuation separating the two numbers
1424 in a page range in index</refpurpose>
1425 </refnamediv>
1426
1427 <refsynopsisdiv>
1428 <programlisting xml:id="index.range.separator.frag">
1429 &lt;xsl:param name="index.range.separator"&gt;&lt;/xsl:param&gt;
1430 </programlisting>
1431 </refsynopsisdiv>
1432
1433 <refsection><info><title>Description</title></info>
1434
1435 <para>This parameter permits you
1436 to override the text to insert between
1437 the two numbers of a page range in an index.
1438 This parameter is only used by those XSL-FO processors
1439 that support an extension for generating such page ranges
1440 (such as XEP).</para>
1441
1442 <para>Because this text may be locale dependent,
1443 this parameter's value is normally taken from a gentext
1444 template named 'range-separator' in the
1445 context 'index' in the stylesheet
1446 locale file for the language
1447 of the current document.
1448 This parameter can be used to override the gentext string,
1449 and would typically be used on the command line.
1450 This parameter would apply to all languages.
1451 </para>
1452
1453 <para>So this text string can be customized in two ways.
1454 You can reset the default gentext string using
1455 the <parameter>local.l10n.xml</parameter> parameter, or you can
1456 override the gentext with the content of this parameter.
1457 The content can be a simple string, or it can be
1458 something more complex such as a call-template.
1459 </para>
1460
1461 <para>In HTML index output, section title references are used instead of
1462 page number references. So there are no page ranges
1463 and this parameter has no effect.
1464 </para>
1465
1466 </refsection>
1467 </refentry>
1468
1469 </reference>
1470 <reference xml:id="dbk_ext"><title>Stylesheet Extensions</title>
1471 <refentry version="5.0" xml:id="linenumbering.everyNth">
1472 <refmeta>
1473 <refentrytitle>linenumbering.everyNth</refentrytitle>
1474 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1475 </refmeta>
1476 <refnamediv>
1477 <refname>linenumbering.everyNth</refname>
1478 <refpurpose>Indicate which lines should be numbered</refpurpose>
1479 </refnamediv>
1480
1481 <refsynopsisdiv>
1482 <programlisting xml:id="linenumbering.everyNth.frag">
1483 &lt;xsl:param name="linenumbering.everyNth"&gt;5&lt;/xsl:param&gt;
1484 </programlisting>
1485 </refsynopsisdiv>
1486
1487 <refsection><info><title>Description</title></info>
1488
1489 <para>If line numbering is enabled, everyNth line will be
1490 numbered. Note that numbering is one based, not zero based.
1491 </para>
1492
1493 </refsection>
1494 </refentry>
1495
1496 <refentry version="5.0" xml:id="linenumbering.extension">
1497 <refmeta>
1498 <refentrytitle>linenumbering.extension</refentrytitle>
1499 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1500 </refmeta>
1501 <refnamediv>
1502 <refname>linenumbering.extension</refname>
1503 <refpurpose>Enable the line numbering extension</refpurpose>
1504 </refnamediv>
1505
1506 <refsynopsisdiv>
1507 <programlisting xml:id="linenumbering.extension.frag">
1508 &lt;xsl:param name="linenumbering.extension" select="1"&gt;&lt;/xsl:param&gt;
1509 </programlisting>
1510 </refsynopsisdiv>
1511
1512 <refsection><info><title>Description</title></info>
1513
1514 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
1515 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
1516 have line numbers.
1517 </para>
1518
1519 </refsection>
1520 </refentry>
1521
1522 <refentry version="5.0" xml:id="linenumbering.separator">
1523 <refmeta>
1524 <refentrytitle>linenumbering.separator</refentrytitle>
1525 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1526 </refmeta>
1527 <refnamediv>
1528 <refname>linenumbering.separator</refname>
1529 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
1530 </refnamediv>
1531
1532 <refsynopsisdiv>
1533 <programlisting xml:id="linenumbering.separator.frag">
1534 &lt;xsl:param name="linenumbering.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;
1535 </programlisting>
1536 </refsynopsisdiv>
1537
1538 <refsection><info><title>Description</title></info>
1539
1540 <para>The separator is inserted between line numbers and lines in the
1541 verbatim environment. The default value is a single white space.
1542  Note the interaction with <parameter>linenumbering.width</parameter>
1543 </para>
1544
1545 </refsection>
1546 </refentry>
1547
1548 <refentry version="5.0" xml:id="linenumbering.width">
1549 <refmeta>
1550 <refentrytitle>linenumbering.width</refentrytitle>
1551 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1552 </refmeta>
1553 <refnamediv>
1554 <refname>linenumbering.width</refname>
1555 <refpurpose>Indicates the width of line numbers</refpurpose>
1556 </refnamediv>
1557
1558 <refsynopsisdiv>
1559 <programlisting xml:id="linenumbering.width.frag">
1560 &lt;xsl:param name="linenumbering.width"&gt;3&lt;/xsl:param&gt;
1561 </programlisting>
1562 </refsynopsisdiv>
1563
1564 <refsection><info><title>Description</title></info>
1565
1566 <para>If line numbering is enabled, line numbers will appear right
1567 justified in a field "width" characters wide.
1568 </para>
1569
1570 </refsection>
1571 </refentry>
1572
1573 <refentry version="5.0" xml:id="tablecolumns.extension">
1574 <refmeta>
1575 <refentrytitle>tablecolumns.extension</refentrytitle>
1576 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1577 </refmeta>
1578 <refnamediv>
1579 <refname>tablecolumns.extension</refname>
1580 <refpurpose>Enable the table columns extension function</refpurpose>
1581 </refnamediv>
1582
1583 <refsynopsisdiv>
1584 <programlisting xml:id="tablecolumns.extension.frag">
1585 &lt;xsl:param name="tablecolumns.extension" select="1"&gt;&lt;/xsl:param&gt;
1586 </programlisting>
1587 </refsynopsisdiv>
1588
1589 <refsection><info><title>Description</title></info>
1590
1591 <para>The table columns extension function adjusts the widths of table
1592 columns in the HTML result to more accurately reflect the specifications
1593 in the CALS table.
1594 </para>
1595
1596 </refsection>
1597 </refentry>
1598
1599 <refentry version="5.0" xml:id="textinsert.extension">
1600   <refmeta>
1601     <refentrytitle>textinsert.extension</refentrytitle>
1602     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1603   </refmeta>
1604   <refnamediv>
1605     <refname>textinsert.extension</refname>
1606     <refpurpose>Enables the textinsert extension element</refpurpose>
1607   </refnamediv>
1608   <refsynopsisdiv>
1609     <programlisting xml:id="textinsert.extension.frag">
1610   &lt;xsl:param name="textinsert.extension" select="1"&gt;&lt;/xsl:param&gt;
1611 </programlisting>
1612   </refsynopsisdiv>
1613   <refsection><info><title>Description</title></info>
1614     <para>The textinsert extension element inserts the contents of
1615       a file into the result tree (as text).</para>
1616     <note>
1617       <para>To use the textinsert extension element, you must use
1618         either Saxon or Xalan as your XSLT processor (it doesn&#8217;t
1619         work with xsltproc), along with either the DocBook Saxon
1620         extensions or DocBook Xalan extensions (for more
1621         information about those extensions, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
1622         the <parameter>use.extensions</parameter> and
1623         <parameter>textinsert.extension</parameter> parameters to
1624         <literal>1</literal>.</para>
1625       <para>As an alternative to using the textinsert element,
1626         consider using an Xinclude element with the
1627         <literal>parse="text"</literal> attribute and value
1628         specified, as detailed in <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
1629     </note>
1630   </refsection>
1631   <refsection><info><title>See Also</title></info>
1632     <para>You can also use the <tag class="xmlpi">dbhtml-include&#160;href</tag> processing
1633       instruction to insert external files &#8212; both files containing
1634       plain text and files with markup content (including HTML
1635       content).</para>
1636   </refsection>
1637   <refsection><info><title>More information</title></info>
1638     <para>For how-to documentation on inserting contents of
1639       external code files and other text files into output, see
1640       <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
1641     <para>For guidelines on inserting contents of
1642       HTML files into output, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
1643   </refsection>
1644 </refentry>
1645
1646 <refentry version="5.0" xml:id="textdata.default.encoding">
1647 <refmeta>
1648 <refentrytitle>textdata.default.encoding</refentrytitle>
1649 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1650 </refmeta>
1651 <refnamediv>
1652 <refname>textdata.default.encoding</refname>
1653 <refpurpose>Default encoding of external text files which are included
1654 using textdata element</refpurpose>
1655 </refnamediv>
1656
1657 <refsynopsisdiv>
1658 <programlisting xml:id="textdata.default.encoding.frag">
1659 &lt;xsl:param name="textdata.default.encoding"&gt;&lt;/xsl:param&gt;
1660 </programlisting>
1661 </refsynopsisdiv>
1662
1663 <refsection><info><title>Description</title></info>
1664
1665 <para>Specifies the encoding of any external text files included using
1666 <tag>textdata</tag> element. This value is used only when you do
1667 not specify encoding by the appropriate attribute
1668 directly on textdata. An empty string is interpreted as the system
1669 default encoding.</para>
1670
1671 </refsection>
1672 </refentry>
1673
1674 <refentry version="5.0" xml:id="graphicsize.extension">
1675 <refmeta>
1676 <refentrytitle>graphicsize.extension</refentrytitle>
1677 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1678 </refmeta>
1679 <refnamediv>
1680 <refname>graphicsize.extension</refname>
1681 <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose>
1682 </refnamediv>
1683
1684 <refsynopsisdiv>
1685 <programlisting xml:id="graphicsize.extension.frag">
1686 &lt;xsl:param name="graphicsize.extension" select="1"&gt;&lt;/xsl:param&gt;
1687 </programlisting>
1688 </refsynopsisdiv>
1689
1690 <refsection><info><title>Description</title></info>
1691
1692 <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero
1693 and if you're using a processor that supports extension functions), the
1694 <function>getWidth</function> and <function>getDepth</function> functions
1695 will be used to extract image sizes from graphics.</para>
1696
1697 </refsection>
1698 </refentry>
1699
1700 <refentry version="5.0" xml:id="graphicsize.use.img.src.path">
1701 <refmeta>
1702 <refentrytitle>graphicsize.use.img.src.path</refentrytitle>
1703 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1704 </refmeta>
1705 <refnamediv>
1706 <refname>graphicsize.use.img.src.path</refname>
1707 <refpurpose>Prepend <parameter>img.src.path</parameter> before
1708 filenames passed to extension functions</refpurpose>
1709 </refnamediv>
1710
1711 <refsynopsisdiv>
1712 <programlisting xml:id="graphicsize.use.img.src.path.frag">
1713 &lt;xsl:param name="graphicsize.use.img.src.path" select="0"&gt;&lt;/xsl:param&gt;
1714 </programlisting>
1715 </refsynopsisdiv>
1716
1717 <refsection><info><title>Description</title></info>
1718
1719 <para>If non-zero <parameter>img.src.path</parameter> parameter will
1720 be appended before filenames passed to extension functions for
1721 measuring image dimensions.</para>
1722
1723 </refsection>
1724 </refentry>
1725
1726 <refentry version="5.0" xml:id="use.extensions">
1727 <refmeta>
1728 <refentrytitle>use.extensions</refentrytitle>
1729 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1730 </refmeta>
1731 <refnamediv>
1732 <refname>use.extensions</refname>
1733 <refpurpose>Enable extensions</refpurpose>
1734 </refnamediv>
1735
1736 <refsynopsisdiv>
1737 <programlisting xml:id="use.extensions.frag">
1738 &lt;xsl:param name="use.extensions" select="0"&gt;&lt;/xsl:param&gt;
1739 </programlisting>
1740 </refsynopsisdiv>
1741
1742 <refsection><info><title>Description</title></info>
1743
1744 <para>If non-zero, extensions may be used. Each extension is
1745 further controlled by its own parameter. But if
1746 <parameter>use.extensions</parameter> is zero, no extensions will
1747 be used.
1748 </para>
1749
1750 </refsection>
1751 </refentry>
1752
1753 </reference>
1754 <reference xml:id="labels"><title>Automatic labelling</title>
1755 <refentry version="5.0" xml:id="chapter.autolabel">
1756 <refmeta>
1757 <refentrytitle>chapter.autolabel</refentrytitle>
1758 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1759 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1760 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1761 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1762 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1763 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1764 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1765 </refmeta>
1766 <refnamediv>
1767 <refname>chapter.autolabel</refname>
1768 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
1769 </refnamediv>
1770
1771 <refsynopsisdiv>
1772 <programlisting xml:id="chapter.autolabel.frag">
1773 &lt;xsl:param name="chapter.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
1774 </refsynopsisdiv>
1775
1776 <refsection><info><title>Description</title></info>
1777
1778 <para>If non-zero, then chapters will be numbered using the parameter
1779 value as the number format if the value matches one of the following:
1780 </para>
1781
1782 <variablelist>
1783   <varlistentry>
1784     <term>1 or arabic</term>
1785     <listitem>
1786       <para>Arabic numeration (1, 2, 3 ...).</para>
1787     </listitem>
1788   </varlistentry>
1789   <varlistentry>
1790     <term>A or upperalpha</term>
1791     <listitem>
1792       <para>Uppercase letter numeration (A, B, C ...).</para>
1793     </listitem>
1794   </varlistentry>
1795   <varlistentry>
1796     <term>a or loweralpha</term>
1797     <listitem>
1798       <para>Lowercase letter numeration (a, b, c ...).</para>
1799     </listitem>
1800   </varlistentry>
1801   <varlistentry>
1802     <term>I or upperroman</term>
1803     <listitem>
1804       <para>Uppercase roman numeration (I, II, III ...).</para>
1805     </listitem>
1806   </varlistentry>
1807   <varlistentry>
1808     <term>i or lowerroman</term>
1809     <listitem>
1810       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1811     </listitem>
1812   </varlistentry>
1813 </variablelist>
1814
1815 <para>Any nonzero value other than the above will generate
1816 the default number format (arabic).
1817 </para>
1818
1819 </refsection>
1820 </refentry>
1821
1822 <refentry version="5.0" xml:id="appendix.autolabel">
1823 <refmeta>
1824 <refentrytitle>appendix.autolabel</refentrytitle>
1825 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1826 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1827 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1828 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1829 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1830 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1831 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1832 </refmeta>
1833 <refnamediv>
1834 <refname>appendix.autolabel</refname>
1835 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
1836 </refnamediv>
1837
1838 <refsynopsisdiv>
1839 <programlisting xml:id="appendix.autolabel.frag">
1840 &lt;xsl:param name="appendix.autolabel"&gt;A&lt;/xsl:param&gt;
1841 </programlisting>
1842 </refsynopsisdiv>
1843
1844 <refsection><info><title>Description</title></info>
1845
1846 <para>If non-zero, then appendices will be numbered using the
1847 parameter value as the number format if the value matches one of the
1848 following:
1849 </para>
1850
1851 <variablelist>
1852   <varlistentry>
1853     <term>1 or arabic</term>
1854     <listitem>
1855       <para>Arabic numeration (1, 2, 3 ...).</para>
1856     </listitem>
1857   </varlistentry>
1858   <varlistentry>
1859     <term>A or upperalpha</term>
1860     <listitem>
1861       <para>Uppercase letter numeration (A, B, C ...).</para>
1862     </listitem>
1863   </varlistentry>
1864   <varlistentry>
1865     <term>a or loweralpha</term>
1866     <listitem>
1867       <para>Lowercase letter numeration (a, b, c ...).</para>
1868     </listitem>
1869   </varlistentry>
1870   <varlistentry>
1871     <term>I or upperroman</term>
1872     <listitem>
1873       <para>Uppercase roman numeration (I, II, III ...).</para>
1874     </listitem>
1875   </varlistentry>
1876   <varlistentry>
1877     <term>i or lowerroman</term>
1878     <listitem>
1879       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1880     </listitem>
1881   </varlistentry>
1882 </variablelist>
1883
1884 <para>Any nonzero value other than the above will generate
1885 the default number format (upperalpha).
1886 </para>
1887
1888 </refsection>
1889 </refentry>
1890
1891 <refentry version="5.0" xml:id="part.autolabel">
1892 <refmeta>
1893 <refentrytitle>part.autolabel</refentrytitle>
1894 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1895 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1896 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1897 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1898 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1899 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1900 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1901 </refmeta>
1902 <refnamediv>
1903 <refname>part.autolabel</refname>
1904 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
1905 </refnamediv>
1906
1907 <refsynopsisdiv>
1908 <programlisting xml:id="part.autolabel.frag">
1909 &lt;xsl:param name="part.autolabel"&gt;I&lt;/xsl:param&gt;
1910 </programlisting>
1911 </refsynopsisdiv>
1912
1913 <refsection><info><title>Description</title></info>
1914
1915 <para>If non-zero, then parts will be numbered using the parameter
1916 value as the number format if the value matches one of the following:
1917 </para>
1918
1919 <variablelist>
1920   <varlistentry>
1921     <term>1 or arabic</term>
1922     <listitem>
1923       <para>Arabic numeration (1, 2, 3 ...).</para>
1924     </listitem>
1925   </varlistentry>
1926   <varlistentry>
1927     <term>A or upperalpha</term>
1928     <listitem>
1929       <para>Uppercase letter numeration (A, B, C ...).</para>
1930     </listitem>
1931   </varlistentry>
1932   <varlistentry>
1933     <term>a or loweralpha</term>
1934     <listitem>
1935       <para>Lowercase letter numeration (a, b, c ...).</para>
1936     </listitem>
1937   </varlistentry>
1938   <varlistentry>
1939     <term>I or upperroman</term>
1940     <listitem>
1941       <para>Uppercase roman numeration (I, II, III ...).</para>
1942     </listitem>
1943   </varlistentry>
1944   <varlistentry>
1945     <term>i or lowerroman</term>
1946     <listitem>
1947       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1948     </listitem>
1949   </varlistentry>
1950 </variablelist>
1951
1952 <para>Any nonzero value other than the above will generate
1953 the default number format (upperroman).
1954 </para>
1955
1956
1957 </refsection>
1958 </refentry>
1959
1960 <refentry version="5.0" xml:id="reference.autolabel">
1961 <refmeta>
1962 <refentrytitle>reference.autolabel</refentrytitle>
1963 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1964 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1965 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1966 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1967 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1968 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1969 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1970 </refmeta>
1971 <refnamediv>
1972 <refname>reference.autolabel</refname>
1973 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
1974 </refnamediv>
1975 <refsynopsisdiv>
1976 <programlisting xml:id="reference.autolabel.frag">
1977   &lt;xsl:param name="reference.autolabel"&gt;I&lt;/xsl:param&gt;
1978 </programlisting>
1979 </refsynopsisdiv>
1980 <refsection><info><title>Description</title></info>
1981 <para>If non-zero, references will be numbered using the parameter
1982   value as the number format if the value matches one of the
1983   following:
1984 </para>
1985 <variablelist>
1986   <varlistentry>
1987     <term>1 or arabic</term>
1988     <listitem>
1989       <para>Arabic numeration (1, 2, 3 ...).</para>
1990     </listitem>
1991   </varlistentry>
1992   <varlistentry>
1993     <term>A or upperalpha</term>
1994     <listitem>
1995       <para>Uppercase letter numeration (A, B, C ...).</para>
1996     </listitem>
1997   </varlistentry>
1998   <varlistentry>
1999     <term>a or loweralpha</term>
2000     <listitem>
2001       <para>Lowercase letter numeration (a, b, c ...).</para>
2002     </listitem>
2003   </varlistentry>
2004   <varlistentry>
2005     <term>I or upperroman</term>
2006     <listitem>
2007       <para>Uppercase roman numeration (I, II, III ...).</para>
2008     </listitem>
2009   </varlistentry>
2010   <varlistentry>
2011     <term>i or lowerroman</term>
2012     <listitem>
2013       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2014     </listitem>
2015   </varlistentry>
2016 </variablelist>
2017 <para>Any non-zero value other than the above will generate
2018 the default number format (upperroman).
2019 </para>
2020 </refsection>
2021 </refentry>
2022
2023 <refentry version="5.0" xml:id="preface.autolabel">
2024 <refmeta>
2025 <refentrytitle>preface.autolabel</refentrytitle>
2026 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2027 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2028 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2029 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2030 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2031 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2032 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2033 </refmeta>
2034 <refnamediv>
2035 <refname>preface.autolabel</refname>
2036 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
2037 </refnamediv>
2038
2039 <refsynopsisdiv>
2040 <programlisting xml:id="preface.autolabel.frag">&lt;xsl:param name="preface.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2041 </refsynopsisdiv>
2042
2043 <refsection><info><title>Description</title></info>
2044
2045 <para>If non-zero then prefaces will be numbered using the parameter
2046 value as the number format if the value matches one of the following:
2047 </para>
2048
2049 <variablelist>
2050   <varlistentry>
2051     <term>1 or arabic</term>
2052     <listitem>
2053       <para>Arabic numeration (1, 2, 3 ...).</para>
2054     </listitem>
2055   </varlistentry>
2056   <varlistentry>
2057     <term>A or upperalpha</term>
2058     <listitem>
2059       <para>Uppercase letter numeration (A, B, C ...).</para>
2060     </listitem>
2061   </varlistentry>
2062   <varlistentry>
2063     <term>a or loweralpha</term>
2064     <listitem>
2065       <para>Lowercase letter numeration (a, b, c ...).</para>
2066     </listitem>
2067   </varlistentry>
2068   <varlistentry>
2069     <term>I or upperroman</term>
2070     <listitem>
2071       <para>Uppercase roman numeration (I, II, III ...).</para>
2072     </listitem>
2073   </varlistentry>
2074   <varlistentry>
2075     <term>i or lowerroman</term>
2076     <listitem>
2077       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2078     </listitem>
2079   </varlistentry>
2080 </variablelist>
2081
2082 <para>Any nonzero value other than the above will generate
2083 the default number format (arabic).
2084 </para>
2085
2086
2087 </refsection>
2088 </refentry>
2089
2090 <refentry version="5.0" xml:id="qandadiv.autolabel">
2091 <refmeta>
2092 <refentrytitle>qandadiv.autolabel</refentrytitle>
2093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2094 </refmeta>
2095 <refnamediv>
2096 <refname>qandadiv.autolabel</refname>
2097 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
2098 </refnamediv>
2099
2100 <refsynopsisdiv>
2101 <programlisting xml:id="qandadiv.autolabel.frag">&lt;xsl:param name="qandadiv.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
2102 </refsynopsisdiv>
2103
2104 <refsection><info><title>Description</title></info>
2105
2106 <para>If non-zero, unlabeled qandadivs will be enumerated.
2107 </para>
2108
2109 </refsection>
2110 </refentry>
2111
2112 <refentry version="5.0" xml:id="section.autolabel">
2113 <refmeta>
2114 <refentrytitle>section.autolabel</refentrytitle>
2115 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2116 </refmeta>
2117 <refnamediv>
2118 <refname>section.autolabel</refname>
2119 <refpurpose>Are sections enumerated?</refpurpose>
2120 </refnamediv>
2121
2122 <refsynopsisdiv>
2123 <programlisting xml:id="section.autolabel.frag">&lt;xsl:param name="section.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2124 </refsynopsisdiv>
2125
2126 <refsection><info><title>Description</title></info>
2127
2128 <para>If true (non-zero), unlabeled sections will be enumerated.
2129 </para>
2130
2131 </refsection>
2132 </refentry>
2133
2134 <refentry version="5.0" xml:id="section.autolabel.max.depth">
2135 <refmeta>
2136 <refentrytitle>section.autolabel.max.depth</refentrytitle>
2137 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2138 </refmeta>
2139 <refnamediv>
2140 <refname>section.autolabel.max.depth</refname>
2141 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
2142 </refnamediv>
2143
2144 <refsynopsisdiv>
2145 <programlisting xml:id="section.autolabel.max.depth.frag">
2146 &lt;xsl:param name="section.autolabel.max.depth"&gt;8&lt;/xsl:param&gt;
2147 </programlisting>
2148 </refsynopsisdiv>
2149
2150 <refsection><info><title>Description</title></info>
2151
2152 <para>When section numbering is turned on by the
2153 <parameter>section.autolabel</parameter> parameter, then this
2154 parameter controls the depth of <tag>section</tag> nesting that is
2155 numbered.  Sections nested to a level deeper than this value will not
2156 be numbered.
2157 </para>
2158
2159 </refsection>
2160 </refentry>
2161
2162 <refentry version="5.0" xml:id="section.label.includes.component.label">
2163 <refmeta>
2164 <refentrytitle>section.label.includes.component.label</refentrytitle>
2165 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2166 </refmeta>
2167 <refnamediv>
2168 <refname>section.label.includes.component.label</refname>
2169 <refpurpose>Do section labels include the component label?</refpurpose>
2170 </refnamediv>
2171
2172 <refsynopsisdiv>
2173 <programlisting xml:id="section.label.includes.component.label.frag">&lt;xsl:param name="section.label.includes.component.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2174 </refsynopsisdiv>
2175
2176 <refsection><info><title>Description</title></info>
2177
2178 <para>If non-zero, section labels are prefixed with the label of the
2179 component that contains them.
2180 </para>
2181
2182 </refsection>
2183 </refentry>
2184
2185 <refentry version="5.0" xml:id="label.from.part">
2186 <refmeta>
2187 <refentrytitle>label.from.part</refentrytitle>
2188 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2189 </refmeta>
2190 <refnamediv>
2191 <refname>label.from.part</refname>
2192 <refpurpose>Renumber components in each part?</refpurpose>
2193 </refnamediv>
2194
2195 <refsynopsisdiv>
2196 <programlisting xml:id="label.from.part.frag">
2197 &lt;xsl:param name="label.from.part" select="0"&gt;&lt;/xsl:param&gt;
2198 </programlisting>
2199 </refsynopsisdiv>
2200
2201 <refsection><info><title>Description</title></info>
2202
2203 <para>If <parameter>label.from.part</parameter> is non-zero, then
2204   numbering of components &#8212; <tag>preface</tag>,
2205   <tag>chapter</tag>, <tag>appendix</tag>, and
2206   <tag>reference</tag> (when <tag>reference</tag> occurs at the
2207   component level) &#8212; is re-started within each
2208   <tag>part</tag>.</para>
2209 <para>If <parameter>label.from.part</parameter> is zero (the
2210   default), numbering of components is <emphasis>not</emphasis>
2211   re-started within each <tag>part</tag>; instead, components are
2212   numbered sequentially throughout each <tag>book</tag>,
2213   regardless of whether or not they occur within <tag>part</tag>
2214   instances.</para>
2215
2216 </refsection>
2217 </refentry>
2218
2219 <refentry version="5.0" xml:id="component.label.includes.part.label">
2220 <refmeta>
2221 <refentrytitle>component.label.includes.part.label</refentrytitle>
2222 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2223 </refmeta>
2224 <refnamediv>
2225 <refname>component.label.includes.part.label</refname>
2226 <refpurpose>Do component labels include the part label?</refpurpose>
2227 </refnamediv>
2228
2229 <refsynopsisdiv>
2230 <programlisting xml:id="component.label.includes.part.label.frag">&lt;xsl:param name="component.label.includes.part.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
2231 </refsynopsisdiv>
2232
2233 <refsection><info><title>Description</title></info>
2234
2235 <para>If non-zero, number labels for <tag>chapter</tag>,
2236 <tag>appendix</tag>, and other component elements are prefixed with
2237 the label of the part element that contains them.  So you might see
2238 Chapter II.3 instead of Chapter 3.  Also, the labels for formal
2239 elements such as <tag>table</tag> and <tag>figure</tag> will include
2240 the part label.  If there is no part element container, then no prefix
2241 is generated.
2242 </para>
2243 <para>
2244 This feature is most useful when the
2245 <parameter>label.from.part</parameter> parameter is turned on.
2246 In that case, there would be more than one <tag>chapter</tag>
2247 <quote>1</quote>, and the extra part label prefix will identify
2248 each chapter unambiguously.
2249 </para>
2250
2251 </refsection>
2252 </refentry>
2253
2254 </reference>
2255
2256 <reference xml:id="html"><title>HTML</title>
2257 <refentry version="5.0" xml:id="html.base">
2258 <refmeta>
2259 <refentrytitle>html.base</refentrytitle>
2260 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2261 </refmeta>
2262 <refnamediv>
2263 <refname>html.base</refname>
2264 <refpurpose>An HTML base URI</refpurpose>
2265 </refnamediv>
2266
2267 <refsynopsisdiv>
2268 <programlisting xml:id="html.base.frag">
2269 &lt;xsl:param name="html.base"&gt;&lt;/xsl:param&gt;</programlisting>
2270 </refsynopsisdiv>
2271
2272 <refsection><info><title>Description</title></info>
2273
2274 <para>If html.base is set, it is used for the <tag>base</tag> element
2275 in the <tag>head</tag> of the html documents.  The parameter specifies
2276 the base URL for all relative URLs in the document.  This is useful
2277 for dynamically served html where the base URI needs to be
2278 shifted.</para>
2279
2280 </refsection>
2281 </refentry>
2282
2283 <refentry version="5.0" xml:id="html.stylesheet.type">
2284 <refmeta>
2285 <refentrytitle>html.stylesheet.type</refentrytitle>
2286 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2287 </refmeta>
2288 <refnamediv>
2289 <refname>html.stylesheet.type</refname>
2290 <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose>
2291 </refnamediv>
2292
2293 <refsynopsisdiv>
2294 <programlisting xml:id="html.stylesheet.type.frag">&lt;xsl:param name="html.stylesheet.type"&gt;text/css&lt;/xsl:param&gt;</programlisting>
2295 </refsynopsisdiv>
2296
2297 <refsection><info><title>Description</title></info>
2298
2299 <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag.
2300 </para>
2301
2302 </refsection>
2303 </refentry>
2304
2305 <refentry version="5.0" xml:id="html.stylesheet">
2306 <refmeta>
2307 <refentrytitle>html.stylesheet</refentrytitle>
2308 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2309 </refmeta>
2310 <refnamediv>
2311 <refname>html.stylesheet</refname>
2312 <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose>
2313 </refnamediv>
2314
2315 <refsynopsisdiv>
2316 <programlisting xml:id="html.stylesheet.frag">
2317 &lt;xsl:param name="html.stylesheet"&gt;&lt;/xsl:param&gt;
2318 </programlisting>
2319 </refsynopsisdiv>
2320
2321 <refsection><info><title>Description</title></info>
2322
2323 <para>The <parameter>html.stylesheet</parameter> parameter is either
2324 empty, indicating that no stylesheet <tag>link</tag> tag should be
2325 generated in the html output, or it is a list of one or more
2326 stylesheet files.</para>
2327
2328 <para>Multiple stylesheets are space-delimited. If you need to
2329 reference a stylesheet URI that includes a space, encode it with
2330 <literal>%20</literal>. A separate html <literal>link</literal> element will
2331 be generated for each stylesheet in the order they are listed in the
2332 parameter.</para>
2333
2334 </refsection>
2335 </refentry>
2336
2337 <refentry version="5.0" xml:id="css.decoration">
2338 <refmeta>
2339 <refentrytitle>css.decoration</refentrytitle>
2340 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2341 </refmeta>
2342 <refnamediv>
2343 <refname>css.decoration</refname>
2344 <refpurpose>Enable CSS decoration of elements</refpurpose>
2345 </refnamediv>
2346
2347 <refsynopsisdiv>
2348 <programlisting xml:id="css.decoration.frag">
2349 &lt;xsl:param name="css.decoration" select="1"&gt;&lt;/xsl:param&gt;
2350 </programlisting>
2351 </refsynopsisdiv>
2352
2353 <refsection><info><title>Description</title></info>
2354
2355 <para>
2356 If non-zero, then html elements produced by the stylesheet may be
2357 decorated with <literal>style</literal> attributes.  For example, the
2358 <literal>li</literal> tags produced for list items may include a
2359 fragment of CSS in the <literal>style</literal> attribute which sets
2360 the CSS property "list-style-type".
2361 </para>
2362
2363 </refsection>
2364 </refentry>
2365
2366 <refentry version="5.0" xml:id="spacing.paras">
2367 <refmeta>
2368 <refentrytitle>spacing.paras</refentrytitle>
2369 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2370 </refmeta>
2371 <refnamediv>
2372 <refname>spacing.paras</refname>
2373 <refpurpose>Insert additional &lt;p&gt; elements for spacing?</refpurpose>
2374 </refnamediv>
2375
2376 <refsynopsisdiv>
2377 <programlisting xml:id="spacing.paras.frag">
2378 &lt;xsl:param name="spacing.paras" select="0"&gt;&lt;/xsl:param&gt;
2379 </programlisting>
2380 </refsynopsisdiv>
2381
2382 <refsection><info><title>Description</title></info>
2383
2384 <para>When non-zero, additional, empty paragraphs are inserted in
2385 several contexts (for example, around informal figures), to create a
2386 more pleasing visual appearance in many browsers.
2387 </para>
2388
2389 </refsection>
2390 </refentry>
2391
2392 <refentry version="5.0" xml:id="emphasis.propagates.style">
2393 <refmeta>
2394 <refentrytitle>emphasis.propagates.style</refentrytitle>
2395 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2396 </refmeta>
2397 <refnamediv>
2398 <refname>emphasis.propagates.style</refname>
2399 <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose>
2400 </refnamediv>
2401 <refsynopsisdiv>
2402 <programlisting xml:id="emphasis.propagates.style.frag">
2403 &lt;xsl:param name="emphasis.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
2404 </programlisting>
2405 </refsynopsisdiv>
2406 <refsection><info><title>Description</title></info>
2407 <para>If non-zero, the <literal>role</literal> attribute of
2408 <tag>emphasis</tag> elements will be passed through to the HTML as a
2409 class attribute on a <literal>span</literal> that surrounds the
2410 emphasis.</para>
2411 </refsection>
2412 </refentry>
2413
2414 <refentry version="5.0" xml:id="para.propagates.style">
2415 <refmeta>
2416 <refentrytitle>para.propagates.style</refentrytitle>
2417 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2418 </refmeta>
2419 <refnamediv>
2420 <refname>para.propagates.style</refname>
2421 <refpurpose>Pass para role attribute through to HTML?</refpurpose>
2422 </refnamediv>
2423
2424 <refsynopsisdiv>
2425 <programlisting xml:id="para.propagates.style.frag">
2426 &lt;xsl:param name="para.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
2427 </programlisting>
2428 </refsynopsisdiv>
2429
2430 <refsection><info><title>Description</title></info>
2431
2432 <para>If true, the role attribute of <tag>para</tag> elements
2433 will be passed through to the HTML as a class attribute on the
2434 <tag>p</tag> generated for the paragraph.</para>
2435
2436 </refsection>
2437 </refentry>
2438
2439 <refentry version="5.0" xml:id="phrase.propagates.style">
2440 <refmeta>
2441 <refentrytitle>phrase.propagates.style</refentrytitle>
2442 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2443 </refmeta>
2444 <refnamediv>
2445 <refname>phrase.propagates.style</refname>
2446 <refpurpose>Pass phrase role attribute through to HTML?</refpurpose>
2447 </refnamediv>
2448
2449 <refsynopsisdiv>
2450 <programlisting xml:id="phrase.propagates.style.frag">
2451 &lt;xsl:param name="phrase.propagates.style" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
2452 </refsynopsisdiv>
2453
2454 <refsection><info><title>Description</title></info>
2455
2456 <para>If non-zero, the role attribute of <tag>phrase</tag> elements
2457 will be passed through to the HTML as a <literal>class</literal>
2458 attribute on a <literal>span</literal> that surrounds the
2459 phrase.</para>
2460
2461 </refsection>
2462 </refentry>
2463
2464 <refentry version="5.0" xml:id="entry.propagates.style">
2465 <refmeta>
2466 <refentrytitle>entry.propagates.style</refentrytitle>
2467 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2468 </refmeta>
2469 <refnamediv>
2470 <refname>entry.propagates.style</refname>
2471 <refpurpose>Pass entry role attribute through to HTML?</refpurpose>
2472 </refnamediv>
2473
2474 <refsynopsisdiv>
2475 <programlisting xml:id="entry.propagates.style.frag">
2476 &lt;xsl:param name="entry.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
2477 </programlisting>
2478 </refsynopsisdiv>
2479
2480 <refsection><info><title>Description</title></info>
2481
2482 <para>If true, the role attribute of <tag>entry</tag> elements
2483 will be passed through to the HTML as a class attribute on the
2484 <tag>td</tag> or <tag>th</tag> generated for the table
2485 cell.</para>
2486
2487 </refsection>
2488 </refentry>
2489
2490 <refentry version="5.0" xml:id="html.longdesc">
2491 <refmeta>
2492 <refentrytitle>html.longdesc</refentrytitle>
2493 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2494 </refmeta>
2495 <refnamediv>
2496 <refname>html.longdesc</refname>
2497 <refpurpose>Should longdesc URIs be created?</refpurpose>
2498 </refnamediv>
2499 <refsynopsisdiv>
2500 <programlisting xml:id="html.longdesc.frag">
2501 &lt;xsl:param name="html.longdesc" select="1"&gt;&lt;/xsl:param&gt;
2502 </programlisting>
2503 </refsynopsisdiv>
2504 <refsection><info><title>Description</title></info>
2505 <para>If non-zero, HTML files will be created for the
2506 <literal>longdesc</literal> attribute. These files
2507 are created from the <tag>textobject</tag>s in
2508 <tag>mediaobject</tag>s and
2509 <tag>inlinemediaobject</tag>.
2510 </para>
2511 </refsection>
2512 </refentry>
2513
2514 <refentry version="5.0" xml:id="html.longdesc.link">
2515 <refmeta>
2516 <refentrytitle>html.longdesc.link</refentrytitle>
2517 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2518 </refmeta>
2519 <refnamediv>
2520 <refname>html.longdesc.link</refname>
2521 <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose>
2522 </refnamediv>
2523
2524 <refsynopsisdiv>
2525 <programlisting xml:id="html.longdesc.link.frag">
2526 &lt;xsl:param name="html.longdesc.link" select="$html.longdesc"&gt;&lt;/xsl:param&gt;
2527 </programlisting>
2528 </refsynopsisdiv>
2529
2530 <refsection><info><title>Description</title></info>
2531
2532 <para>If non-zero, links will be created to the
2533 HTML files created for the
2534 <literal>longdesc</literal> attribute. It makes no
2535 sense to enable this option without also enabling the
2536 <parameter>html.longdesc</parameter> parameter.</para>
2537
2538
2539
2540 </refsection>
2541 </refentry>
2542
2543 <refentry version="5.0" xml:id="make.valid.html">
2544 <refmeta>
2545 <refentrytitle>make.valid.html</refentrytitle>
2546 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2547 </refmeta>
2548 <refnamediv>
2549 <refname>make.valid.html</refname>
2550 <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose>
2551 </refnamediv>
2552
2553 <refsynopsisdiv>
2554 <programlisting xml:id="make.valid.html.frag">
2555 &lt;xsl:param name="make.valid.html" select="0"&gt;&lt;/xsl:param&gt;
2556 </programlisting>
2557 </refsynopsisdiv>
2558
2559 <refsection><info><title>Description</title></info>
2560
2561 <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take
2562 extra effort to ensure that the resulting HTML is valid. This may mean that some
2563 <tag>para</tag> tags are translated into HTML <tag>div</tag>s or
2564 that other substitutions occur.</para>
2565
2566 <para>This parameter is different from <parameter>html.cleanup</parameter>
2567 because it changes the resulting markup; it does not use extension functions
2568 to manipulate result-tree-fragments and is therefore applicable to any
2569 XSLT processor.</para>
2570
2571 </refsection>
2572 </refentry>
2573
2574 <refentry version="5.0" xml:id="html.cleanup">
2575 <refmeta>
2576 <refentrytitle>html.cleanup</refentrytitle>
2577 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2578 </refmeta>
2579 <refnamediv>
2580 <refname>html.cleanup</refname>
2581 <refpurpose>Attempt to clean up the resulting HTML?</refpurpose>
2582 </refnamediv>
2583
2584 <refsynopsisdiv>
2585 <programlisting xml:id="html.cleanup.frag">
2586 &lt;xsl:param name="html.cleanup" select="1"&gt;&lt;/xsl:param&gt;
2587 </programlisting>
2588 </refsynopsisdiv>
2589
2590 <refsection><info><title>Description</title></info>
2591
2592 <para>If non-zero, and if the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.exslt.org/">EXSLT</link>
2593 extensions are supported by your processor, the resulting HTML will be
2594 <quote>cleaned up</quote>. This improves the chances that the
2595 resulting HTML will be valid. It may also improve the formatting of
2596 some elements.</para>
2597
2598 <para>This parameter is different from <parameter>make.valid.html</parameter>
2599 because it uses extension functions to manipulate result-tree-fragments.</para>
2600
2601 </refsection>
2602 </refentry>
2603
2604 <refentry version="5.0" xml:id="html.append">
2605 <refmeta>
2606 <refentrytitle>html.append</refentrytitle>
2607 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2608 </refmeta>
2609 <refnamediv>
2610 <refname>html.append</refname>
2611 <refpurpose>Specifies content to append to HTML output</refpurpose>
2612 </refnamediv>
2613
2614 <refsynopsisdiv>
2615 <programlisting xml:id="html.append.frag">&lt;xsl:param name="html.append"&gt;&lt;/xsl:param&gt;</programlisting>
2616 </refsynopsisdiv>
2617
2618 <refsection><info><title>Description</title></info>
2619
2620 <para>Specifies content to append to the end of HTML files output by
2621 the <filename>html/docbook.xsl</filename> stylesheet, after the
2622 closing <code>&lt;html&gt;</code> tag. You probably don&#8217;t want to set any
2623 value for this parameter; but if you do, the only value it should ever
2624 be set to is a newline character: <code>&amp;#x0a;</code> or
2625 <code>&amp;#10;</code></para>
2626
2627 </refsection>
2628 </refentry>
2629
2630 <refentry version="5.0" xml:id="draft.mode">
2631 <refmeta>
2632 <refentrytitle>draft.mode</refentrytitle>
2633 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2634 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
2635 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
2636 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
2637 </refmeta>
2638 <refnamediv>
2639 <refname>draft.mode</refname>
2640 <refpurpose>Select draft mode</refpurpose>
2641 </refnamediv>
2642
2643 <refsynopsisdiv>
2644 <programlisting xml:id="draft.mode.frag">
2645 &lt;xsl:param name="draft.mode"&gt;no&lt;/xsl:param&gt;
2646 </programlisting>
2647 </refsynopsisdiv>
2648
2649 <refsection><info><title>Description</title></info>
2650
2651 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
2652 <quote><literal>yes</literal></quote>, the entire document will be treated
2653 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
2654 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
2655 individual sections will be treated as draft or final independently, depending
2656 on how their <literal>status</literal> attribute is set.
2657 </para>
2658
2659 </refsection>
2660 </refentry>
2661
2662 <refentry version="5.0" xml:id="draft.watermark.image">
2663 <refmeta>
2664 <refentrytitle>draft.watermark.image</refentrytitle>
2665 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2666 </refmeta>
2667 <refnamediv>
2668 <refname>draft.watermark.image</refname>
2669 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
2670 </refnamediv>
2671
2672 <refsynopsisdiv>
2673 <programlisting xml:id="draft.watermark.image.frag">
2674 &lt;xsl:param name="draft.watermark.image"&gt;images/draft.png&lt;/xsl:param&gt;
2675 </programlisting>
2676 </refsynopsisdiv>
2677
2678 <refsection><info><title>Description</title></info>
2679
2680 <para>The image to be used for draft watermarks.</para>
2681
2682 </refsection>
2683 </refentry>
2684
2685 <refentry version="5.0" xml:id="generate.id.attributes">
2686 <refmeta>
2687 <refentrytitle>generate.id.attributes</refentrytitle>
2688 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2689 </refmeta>
2690 <refnamediv>
2691 <refname>generate.id.attributes</refname>
2692 <refpurpose>Generate ID attributes on container elements?</refpurpose>
2693 </refnamediv>
2694
2695 <refsynopsisdiv>
2696 <programlisting xml:id="generate.id.attributes.frag">
2697 &lt;xsl:param name="generate.id.attributes" select="0"&gt;&lt;/xsl:param&gt;
2698 </programlisting>
2699 </refsynopsisdiv>
2700
2701 <refsection><info><title>Description</title></info>
2702
2703 <para>If non-zero, the HTML stylesheet will generate ID attributes on
2704 containers. For example, the markup:</para>
2705
2706 <screen>&lt;section id="foo"&gt;&lt;title&gt;Some Title&lt;/title&gt;
2707 &lt;para&gt;Some para.&lt;/para&gt;
2708 &lt;/section&gt;</screen>
2709
2710 <para>might produce:</para>
2711
2712 <screen>&lt;div class="section" id="foo"&gt;
2713 &lt;h2&gt;Some Title&lt;/h2&gt;
2714 &lt;p&gt;Some para.&lt;/p&gt;
2715 &lt;/div&gt;</screen>
2716
2717 <para>The alternative is to generate anchors:</para>
2718
2719 <screen>&lt;div class="section"&gt;
2720 &lt;h2&gt;&lt;a name="foo"&gt;&lt;/a&gt;Some Title&lt;/h2&gt;
2721 &lt;p&gt;Some para.&lt;/p&gt;
2722 &lt;/div&gt;</screen>
2723
2724 <para>Because the <tag class="attribute">name</tag> attribute of
2725 the <tag>a</tag> element and the <tag class="attribute">id</tag>
2726 attribute of other tags are both of type <quote>ID</quote>, producing both
2727 generates invalid documents.</para>
2728
2729 <para>As of version 1.50, you can use this switch to control which type of
2730 identifier is generated. For backwards-compatibility, generating
2731 <tag>a</tag> anchors is preferred.</para>
2732
2733 <para>Note: at present, this switch is incompletely implemented.
2734 Disabling ID attributes will suppress them, but enabling ID attributes
2735 will not suppress the anchors.</para>
2736
2737 </refsection>
2738 </refentry>
2739
2740 <refentry version="5.0" xml:id="generate.meta.abstract">
2741 <refmeta>
2742 <refentrytitle>generate.meta.abstract</refentrytitle>
2743 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2744 </refmeta>
2745 <refnamediv>
2746 <refname>generate.meta.abstract</refname>
2747 <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose>
2748 </refnamediv>
2749
2750 <refsynopsisdiv>
2751 <programlisting xml:id="generate.meta.abstract.frag">
2752 &lt;xsl:param name="generate.meta.abstract" select="1"&gt;&lt;/xsl:param&gt;
2753 </programlisting>
2754 </refsynopsisdiv>
2755
2756 <refsection><info><title>Description</title></info>
2757
2758 <para>If non-zero, document abstracts will be reproduced in the HTML
2759 <literal>head</literal>, with <literal>&gt;meta name="description" content="..."</literal></para>
2760
2761
2762 </refsection>
2763 </refentry>
2764
2765 <refentry version="5.0" xml:id="make.clean.html">
2766 <refmeta>
2767 <refentrytitle>make.clean.html</refentrytitle>
2768 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2769 </refmeta>
2770 <refnamediv>
2771 <refname>make.clean.html</refname>
2772 <refpurpose>Make HTML conform to modern coding standards</refpurpose>
2773 </refnamediv>
2774
2775 <refsynopsisdiv>
2776 <programlisting xml:id="make.clean.html.frag">
2777 &lt;xsl:param name="make.clean.html" select="0"&gt;&lt;/xsl:param&gt;
2778 </programlisting>
2779 </refsynopsisdiv>
2780
2781 <refsection><info><title>Description</title></info>
2782
2783 <para>If <parameter>make.clean.html</parameter> is true, the stylesheets take
2784 extra effort to ensure that the resulting HTML is conforms to
2785 modern HTML coding standards.  In addition to eliminating
2786 excessive and noncompliant coding, it moves presentation
2787 HTML coding to a CSS stylesheet.</para>
2788
2789 <para>The resulting HTML is dependent on
2790 CSS for formatting, and so the stylesheet is capable of
2791 generating a supporting CSS file. The <parameter>docbook.css.source</parameter>
2792 and <parameter>custom.css.source</parameter> parameters control
2793 how a CSS file is generated.</para>
2794
2795 <para>If you require your CSS to reside in the HTML
2796 <tag>head</tag> element, then the <parameter>generate.css.header</parameter>
2797 can be used to do that.</para>
2798
2799 <para>The <parameter>make.clean.html</parameter> parameter is
2800 different from <parameter>html.cleanup</parameter>
2801 because the former changes the resulting markup; it does not use extension functions
2802 like the latter to manipulate result-tree-fragments,
2803 and is therefore applicable to any XSLT processor.</para>
2804
2805 <para>If <parameter>make.clean.html</parameter> is set to zero (the default),
2806 then the stylesheet retains its original
2807 <quote>old style</quote>
2808 HTML formatting features.</para>
2809 </refsection>
2810 </refentry>
2811
2812 <refentry version="5.0" xml:id="docbook.css.source">
2813   <refmeta>
2814     <refentrytitle>docbook.css.source</refentrytitle>
2815     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2816   </refmeta>
2817   <refnamediv>
2818     <refname>docbook.css.source</refname>
2819     <refpurpose>Name of the default CSS input file</refpurpose>
2820   </refnamediv>
2821
2822   <refsynopsisdiv>
2823     <programlisting xml:id="docbook.css.source.frag">&lt;xsl:param name="docbook.css.source"&gt;docbook.css.xml&lt;/xsl:param&gt;</programlisting>
2824   </refsynopsisdiv>
2825
2826   <refsection><info><title>Description</title></info>
2827
2828 <para>The <parameter>docbook.css.source</parameter> parameter
2829 specifies the name of the file containing the default DocBook
2830 CSS styles.  Those styles are necessary when the
2831 <parameter>make.clean.html</parameter> parameter is nonzero.</para>
2832
2833 <para>The file is a well-formed XML file that
2834 must consist of a single <tag>style</tag> root
2835 element that contains CSS styles as its text content.
2836 The default value of the parameter (and filename)
2837 is <literal>docbook.css.xml</literal>.
2838 The stylesheets ship with the default file. You can substitute
2839 your own and specify its path in this parameter.</para>
2840
2841 <para>If <parameter>docbook.css.source</parameter> is not blank,
2842 and <parameter>make.clean.html</parameter> is nonzero, then
2843 the stylesheet takes the following actions:</para>
2844
2845 <orderedlist>
2846   <listitem>
2847     <para>The stylesheet uses the XSLT <literal>document()</literal>
2848     function to open the file specified by the parameter and
2849     load it into a variable.</para>
2850   </listitem>
2851   <listitem>
2852     <para>The stylesheet forms an output pathname consisting of the
2853     value of the <parameter>base.dir</parameter> parameter (if it is set)
2854     and the value of <parameter>docbook.css.source</parameter>,
2855     with the <literal>.xml</literal> suffix stripped off.
2856     </para>
2857   </listitem>
2858   <listitem>
2859     <para>The stylesheet removes the <tag>style</tag>
2860     wrapper element and writes just the CSS text content to the output file.</para>
2861   </listitem>
2862   <listitem>
2863     <para>The stylesheet adds a <tag>link</tag> element to the
2864     HTML <tag>HEAD</tag> element to reference the external CSS stylesheet.
2865     For example:</para>
2866     <programlisting>&lt;link rel="stylesheet" href="docbook.css" type="text/css"&gt;
2867     </programlisting>
2868     <para>However, if the <parameter>docbook.css.link</parameter>
2869     parameter is set to zero, then no <tag>link</tag> is written
2870     for the default CSS file.  That is useful if a custom
2871     CSS file will import the default CSS stylesheet to ensure
2872     proper cascading of styles.</para>
2873   </listitem>
2874 </orderedlist>
2875
2876 <para>If the <parameter>docbook.css.source</parameter> parameter
2877 is changed from its default <literal>docbook.css.xml</literal> to blank,
2878 then no default CSS is generated. Likewise if the
2879 <parameter>make.clean.html</parameter> parameter is set to zero,
2880 then no default CSS is generated. The
2881 <parameter>custom.css.source</parameter> parameter can be used
2882 instead to generate a complete custom CSS file.</para>
2883
2884 <para>You can use the <parameter>generate.css.header</parameter>
2885 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
2886 element in a <tag>style</tag> tag instead of an external CSS file.</para>
2887
2888   </refsection>
2889 </refentry>
2890
2891 <refentry version="5.0" xml:id="docbook.css.link">
2892 <refmeta>
2893 <refentrytitle>docbook.css.link</refentrytitle>
2894 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2895 </refmeta>
2896 <refnamediv>
2897 <refname>docbook.css.link</refname>
2898 <refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose>
2899 </refnamediv>
2900
2901 <refsynopsisdiv>
2902 <programlisting xml:id="docbook.css.link.frag">
2903 &lt;xsl:param name="docbook.css.link" select="1"&gt;&lt;/xsl:param&gt;
2904 </programlisting>
2905 </refsynopsisdiv>
2906
2907 <refsection><info><title>Description</title></info>
2908
2909 <para>The stylesheets are capable of generating a default
2910 CSS stylesheet file.  The parameters
2911 <parameter>make.clean.html</parameter> and
2912 <parameter>docbook.css.source</parameter> control that feature.</para>
2913
2914 <para>Normally if a default CSS file is generated, then
2915 the stylesheet inserts a <tag>link</tag> tag in the HTML
2916 <tag>HEAD</tag> element to reference it.
2917 However, you can omit that <tag>link</tag> reference if
2918 you set the <parameter>docbook.css.link</parameter> to zero
2919 (1 is the default).</para>
2920
2921 <para>This parameter is useful when you want to import the
2922 default CSS into a custom CSS file generated using the
2923 <parameter>custom.css.source</parameter> parameter.
2924 </para>
2925
2926 </refsection>
2927 </refentry>
2928
2929 <refentry version="5.0" xml:id="custom.css.source">
2930   <refmeta>
2931     <refentrytitle>custom.css.source</refentrytitle>
2932     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2933   </refmeta>
2934   <refnamediv>
2935     <refname>custom.css.source</refname>
2936     <refpurpose>Name of a custom CSS input file</refpurpose>
2937   </refnamediv>
2938
2939   <refsynopsisdiv>
2940     <programlisting xml:id="custom.css.source.frag">&lt;xsl:param name="custom.css.source"&gt;&lt;/xsl:param&gt;</programlisting>
2941   </refsynopsisdiv>
2942
2943   <refsection><info><title>Description</title></info>
2944
2945 <para>The <parameter>custom.css.source</parameter>
2946 parameter enables you to add CSS styles to DocBook's
2947 HTML output.</para>
2948
2949 <para>The parameter
2950 specifies the name of a file containing custom
2951 CSS styles.  The file must be a well-formed XML file that
2952 consists of a single <tag>style</tag> root
2953 element that contains CSS styles as its text content.
2954 For example:</para>
2955 <programlisting>&lt;?xml version="1.0"?&gt;
2956 &lt;style&gt;
2957 h2 {
2958   font-weight: bold;
2959   color: blue;
2960 }
2961 ...
2962 &lt;/style&gt;
2963 </programlisting>
2964
2965 <para>The filename specified by the parameter
2966 should have a <literal>.xml</literal>
2967 filename suffix, although that is not required.
2968 The default value of this parameter is blank.</para>
2969
2970 <para>If <parameter>custom.css.source</parameter> is not blank, then
2971 the stylesheet takes the following actions.
2972 These actions take place regardless of the value of
2973 the <parameter>make.clean.html</parameter> parameter.</para>
2974
2975 <orderedlist>
2976   <listitem>
2977     <para>The stylesheet uses the XSLT <literal>document()</literal>
2978     function to open the file specified by the parameter and
2979     load it into a variable.</para>
2980   </listitem>
2981   <listitem>
2982     <para>The stylesheet forms an output pathname consisting of the
2983     value of the <parameter>base.dir</parameter> parameter (if it is set)
2984     and the value of <parameter>custom.css.source</parameter>,
2985     with the <literal>.xml</literal> suffix stripped off.
2986     </para>
2987   </listitem>
2988   <listitem>
2989     <para>The stylesheet removes the <tag>style</tag>
2990     wrapper element and writes just the CSS text content to the output file.</para>
2991   </listitem>
2992   <listitem>
2993     <para>The stylesheet adds a <tag>link</tag> element to the
2994     HTML <tag>HEAD</tag> element to reference this external CSS stylesheet.
2995     For example:
2996     <programlisting>&lt;link rel="stylesheet" href="custom.css" type="text/css"&gt;
2997     </programlisting>
2998     </para>
2999   </listitem>
3000 </orderedlist>
3001
3002
3003
3004 <para>If the <parameter>make.clean.html</parameter> parameter is nonzero
3005 (the default is zero),
3006 and if the <parameter>docbook.css.source</parameter> parameter
3007 is not blank (the default is not blank),
3008 then the stylesheet will also generate a default CSS file
3009 and add a <tag>link</tag> tag to reference it.
3010 The <tag>link</tag> to the custom CSS comes after the
3011 <tag>link</tag> to the default, so it should cascade properly
3012 in most browsers.
3013 If you do not want two <tag>link</tag> tags, and
3014 instead want your custom CSS to import the default generated
3015 CSS file, then do the following:
3016 </para>
3017
3018 <orderedlist>
3019   <listitem>
3020     <para>Add a line like the following to your custom CSS source file:</para>
3021     <programlisting>@import url("docbook.css")
3022     </programlisting>
3023   </listitem>
3024   <listitem>
3025     <para>Set the <parameter>docbook.css.link</parameter> parameter
3026     to zero. This will omit the <tag>link</tag> tag
3027     that references the default CSS file.</para>
3028   </listitem>
3029 </orderedlist>
3030
3031 <para>If you set <parameter>make.clean.html</parameter> to nonzero but
3032 you do not want the default CSS generated, then also set
3033 the <parameter>docbook.css.source</parameter> parameter to blank.
3034 Then no default CSS will be generated, and so
3035 all CSS styles must come from your custom CSS file.</para>
3036
3037 <para>You can use the <parameter>generate.css.header</parameter>
3038 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
3039 element in a <tag>style</tag> tag instead of an external CSS file.</para>
3040
3041   </refsection>
3042 </refentry>
3043
3044 <refentry version="5.0" xml:id="generate.css.header">
3045 <refmeta>
3046 <refentrytitle>generate.css.header</refentrytitle>
3047 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3048 </refmeta>
3049 <refnamediv>
3050 <refname>generate.css.header</refname>
3051 <refpurpose>Insert generated CSS styles in HEAD element</refpurpose>
3052 </refnamediv>
3053
3054 <refsynopsisdiv>
3055 <programlisting xml:id="generate.css.header.frag">
3056 &lt;xsl:param name="generate.css.header" select="0"&gt;&lt;/xsl:param&gt;
3057 </programlisting>
3058 </refsynopsisdiv>
3059
3060 <refsection><info><title>Description</title></info>
3061
3062 <para>The stylesheets are capable of generating both default
3063 and custom CSS stylesheet files.  The parameters
3064 <parameter>make.clean.html</parameter>,
3065 <parameter>docbook.css.source</parameter>, and
3066 <parameter>custom.css.source</parameter> control that feature.</para>
3067
3068 <para>If you require that CSS styles reside in the HTML
3069 <tag>HEAD</tag> element instead of external CSS files,
3070 then set the <parameter>generate.css.header</parameter>
3071 parameter to nonzero (it is zero by default).
3072 Then instead of generating the CSS in external files,
3073 they are wrapped in <tag>style</tag> elements in
3074 the <tag>HEAD</tag> element of each HTML output file.
3075 </para>
3076
3077 </refsection>
3078 </refentry>
3079
3080 </reference>
3081 <reference xml:id="xslt"><title>XSLT Processing</title>
3082 <refentry version="5.0" xml:id="rootid">
3083 <refmeta>
3084 <refentrytitle>rootid</refentrytitle>
3085 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3086 </refmeta>
3087 <refnamediv>
3088 <refname>rootid</refname>
3089 <refpurpose>Specify the root element to format</refpurpose>
3090 </refnamediv>
3091
3092 <refsynopsisdiv>
3093 <programlisting xml:id="rootid.frag">
3094 &lt;xsl:param name="rootid"&gt;&lt;/xsl:param&gt;</programlisting>
3095 </refsynopsisdiv>
3096
3097 <refsection><info><title>Description</title></info>
3098
3099 <para>If <parameter>rootid</parameter> is not empty, it must be the
3100 value of an ID that occurs in the document being formatted. The entire
3101 document will be loaded and parsed, but formatting will begin at the
3102 element identified, rather than at the root. For example, this allows
3103 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
3104 <para>Because the entire document is available to the processor, automatic
3105 numbering, cross references, and other dependencies are correctly
3106 resolved.</para>
3107
3108 </refsection>
3109 </refentry>
3110
3111 <refentry version="5.0" xml:id="suppress.navigation">
3112 <refmeta>
3113 <refentrytitle>suppress.navigation</refentrytitle>
3114 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3115 </refmeta>
3116 <refnamediv>
3117 <refname>suppress.navigation</refname>
3118 <refpurpose>Disable header and footer navigation</refpurpose>
3119 </refnamediv>
3120
3121 <refsynopsisdiv>
3122 <programlisting xml:id="suppress.navigation.frag">
3123 &lt;xsl:param name="suppress.navigation" select="0"&gt;&lt;/xsl:param&gt;
3124 </programlisting>
3125 </refsynopsisdiv>
3126
3127 <refsection><info><title>Description</title></info>
3128
3129 <para>
3130 If non-zero, header and footer navigation will be suppressed.</para>
3131
3132 </refsection>
3133 </refentry>
3134
3135 <refentry version="5.0" xml:id="suppress.header.navigation">
3136 <refmeta>
3137 <refentrytitle>suppress.header.navigation</refentrytitle>
3138 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3139 </refmeta>
3140 <refnamediv>
3141 <refname>suppress.header.navigation</refname>
3142 <refpurpose>Disable header navigation</refpurpose>
3143 </refnamediv>
3144
3145 <refsynopsisdiv>
3146 <programlisting xml:id="suppress.header.navigation.frag">
3147 &lt;xsl:param name="suppress.header.navigation" select="0"&gt;&lt;/xsl:param&gt;
3148 </programlisting>
3149 </refsynopsisdiv>
3150
3151 <refsection><info><title>Description</title></info>
3152
3153 <para>If non-zero, header navigation will be suppressed.</para>
3154
3155 </refsection>
3156 </refentry>
3157
3158 <refentry version="5.0" xml:id="suppress.footer.navigation">
3159 <refmeta>
3160 <refentrytitle>suppress.footer.navigation</refentrytitle>
3161 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3162 </refmeta>
3163 <refnamediv>
3164 <refname>suppress.footer.navigation</refname>
3165 <refpurpose>Disable footer navigation</refpurpose>
3166 </refnamediv>
3167
3168 <refsynopsisdiv>
3169 <programlisting xml:id="suppress.footer.navigation.frag">&lt;xsl:param name="suppress.footer.navigation"&gt;0&lt;/xsl:param&gt;</programlisting>
3170 </refsynopsisdiv>
3171
3172 <refsection><info><title>Description</title></info>
3173
3174 <para>
3175 If non-zero, footer navigation will be suppressed.</para>
3176
3177 </refsection>
3178 </refentry>
3179
3180 <refentry version="5.0" xml:id="header.rule">
3181 <refmeta>
3182 <refentrytitle>header.rule</refentrytitle>
3183 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3184 </refmeta>
3185 <refnamediv>
3186 <refname>header.rule</refname>
3187 <refpurpose>Rule under headers?</refpurpose>
3188 </refnamediv>
3189
3190 <refsynopsisdiv>
3191 <programlisting xml:id="header.rule.frag">
3192 &lt;xsl:param name="header.rule" select="1"&gt;&lt;/xsl:param&gt;
3193 </programlisting>
3194 </refsynopsisdiv>
3195
3196 <refsection><info><title>Description</title></info>
3197
3198 <para>If non-zero, a rule will be drawn below the page headers.</para>
3199
3200 </refsection>
3201 </refentry>
3202
3203 <refentry version="5.0" xml:id="footer.rule">
3204 <refmeta>
3205 <refentrytitle>footer.rule</refentrytitle>
3206 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3207 </refmeta>
3208 <refnamediv>
3209 <refname>footer.rule</refname>
3210 <refpurpose>Rule over footers?</refpurpose>
3211 </refnamediv>
3212
3213 <refsynopsisdiv>
3214 <programlisting xml:id="footer.rule.frag">
3215 &lt;xsl:param name="footer.rule" select="1"&gt;&lt;/xsl:param&gt;
3216 </programlisting>
3217 </refsynopsisdiv>
3218
3219 <refsection><info><title>Description</title></info>
3220
3221 <para>If non-zero, a rule will be drawn above the page footers.</para>
3222
3223 </refsection>
3224 </refentry>
3225
3226 <refentry version="5.0" xml:id="id.warnings">
3227 <refmeta>
3228 <refentrytitle>id.warnings</refentrytitle>
3229 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3230 </refmeta>
3231 <refnamediv>
3232 <refname>id.warnings</refname>
3233 <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
3234 </refnamediv>
3235 <refsynopsisdiv>
3236 <programlisting xml:id="id.warnings.frag">
3237 &lt;xsl:param name="id.warnings" select="0"&gt;&lt;/xsl:param&gt;
3238 </programlisting>
3239 </refsynopsisdiv>
3240 <refsection><info><title>Description</title></info>
3241 <para>If non-zero, the stylesheet will issue a warning for any element
3242 (other than the root element) which has a <tag>title</tag> but does not have an
3243 ID.</para>
3244 </refsection>
3245 </refentry>
3246
3247 </reference>
3248 <reference xml:id="meta"><title>Meta/*Info and Titlepages</title>
3249 <refentry version="5.0" xml:id="inherit.keywords">
3250 <refmeta>
3251 <refentrytitle>inherit.keywords</refentrytitle>
3252 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3253 </refmeta>
3254 <refnamediv>
3255 <refname>inherit.keywords</refname>
3256 <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
3257 </refnamediv>
3258
3259 <refsynopsisdiv>
3260 <programlisting xml:id="inherit.keywords.frag">
3261 &lt;xsl:param name="inherit.keywords" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
3262 </refsynopsisdiv>
3263
3264 <refsection><info><title>Description</title></info>
3265
3266 <para>If <parameter>inherit.keywords</parameter>
3267 is non-zero, the keyword <literal>meta</literal> for each HTML
3268 <literal>head</literal> element will include all of the keywords from
3269 ancestor elements. Otherwise, only the keywords from the current section
3270 will be used.
3271 </para>
3272
3273 </refsection>
3274 </refentry>
3275
3276 <refentry version="5.0" xml:id="make.single.year.ranges">
3277 <refmeta>
3278 <refentrytitle>make.single.year.ranges</refentrytitle>
3279 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3280 </refmeta>
3281 <refnamediv>
3282 <refname>make.single.year.ranges</refname>
3283 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
3284 </refnamediv>
3285
3286 <refsynopsisdiv>
3287 <programlisting xml:id="make.single.year.ranges.frag">
3288 &lt;xsl:param name="make.single.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3289 </refsynopsisdiv>
3290
3291 <refsection><info><title>Description</title></info>
3292
3293 <para>If non-zero, year ranges that span a single year will be printed
3294 in range notation (1998-1999) instead of discrete notation
3295 (1998, 1999).</para>
3296
3297 </refsection>
3298 </refentry>
3299
3300 <refentry version="5.0" xml:id="make.year.ranges">
3301 <refmeta>
3302 <refentrytitle>make.year.ranges</refentrytitle>
3303 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3304 </refmeta>
3305 <refnamediv>
3306 <refname>make.year.ranges</refname>
3307 <refpurpose>Collate copyright years into ranges?</refpurpose>
3308 </refnamediv>
3309
3310 <refsynopsisdiv>
3311 <programlisting xml:id="make.year.ranges.frag">&lt;xsl:param name="make.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3312 </refsynopsisdiv>
3313
3314 <refsection><info><title>Description</title></info>
3315
3316 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
3317 collated into ranges.
3318 This works only if each year number is put into a separate
3319 year element.  The copyright element permits multiple
3320 year elements. If a year element contains a dash or
3321 a comma, then that year element will not be merged into
3322 any range.
3323 </para>
3324
3325 </refsection>
3326 </refentry>
3327
3328 <refentry version="5.0" xml:id="author.othername.in.middle">
3329 <refmeta>
3330 <refentrytitle>author.othername.in.middle</refentrytitle>
3331 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3332 </refmeta>
3333 <refnamediv>
3334 <refname>author.othername.in.middle</refname>
3335 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
3336 middle name?</refpurpose>
3337 </refnamediv>
3338
3339 <refsynopsisdiv>
3340 <programlisting xml:id="author.othername.in.middle.frag">
3341 &lt;xsl:param name="author.othername.in.middle" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
3342 </refsynopsisdiv>
3343
3344 <refsection><info><title>Description</title></info>
3345
3346 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
3347 appears between the <tag>firstname</tag> and
3348 <tag>surname</tag>.  Otherwise, <tag>othername</tag>
3349 is suppressed.
3350 </para>
3351
3352 </refsection>
3353 </refentry>
3354
3355 <refentry version="5.0" xml:id="blurb.on.titlepage.enabled">
3356 <refmeta>
3357 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
3358 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3359 </refmeta>
3360 <refnamediv>
3361 <refname>blurb.on.titlepage.enabled</refname>
3362 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
3363 </refnamediv>
3364
3365 <refsynopsisdiv>
3366 <programlisting xml:id="blurb.on.titlepage.enabled.frag">
3367 &lt;xsl:param name="blurb.on.titlepage.enabled" select="0"&gt;&lt;/xsl:param&gt;
3368 </programlisting>
3369 </refsynopsisdiv>
3370
3371 <refsection><info><title>Description</title></info>
3372
3373 <para>If non-zero, output from <tag>authorblurb</tag> and
3374 <tag>personblurb</tag> elements is displayed on title pages. If zero
3375 (the default), output from those elements is suppressed on title pages
3376 (unless you are using a <literal>titlepage</literal> customization
3377 that causes them to be included).</para>
3378
3379 </refsection>
3380 </refentry>
3381
3382 <refentry version="5.0" xml:id="contrib.inline.enabled">
3383 <refmeta>
3384 <refentrytitle>contrib.inline.enabled</refentrytitle>
3385 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3386 </refmeta>
3387 <refnamediv>
3388 <refname>contrib.inline.enabled</refname>
3389 <refpurpose>Display contrib output inline?</refpurpose>
3390 </refnamediv>
3391
3392 <refsynopsisdiv>
3393 <programlisting xml:id="contrib.inline.enabled.frag">&lt;xsl:param name="contrib.inline.enabled"&gt;1&lt;/xsl:param&gt;</programlisting>
3394 </refsynopsisdiv>
3395
3396 <refsection><info><title>Description</title></info>
3397
3398 <para>If non-zero (the default), output of the <tag>contrib</tag> element is
3399 displayed as inline content rather than as block content.</para>
3400
3401 </refsection>
3402 </refentry>
3403
3404 <refentry version="5.0" xml:id="editedby.enabled">
3405 <refmeta>
3406 <refentrytitle>editedby.enabled</refentrytitle>
3407 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3408 </refmeta>
3409 <refnamediv>
3410 <refname>editedby.enabled</refname>
3411 <refpurpose>Display &#8220;Edited by&#8221; heading above editor name?</refpurpose>
3412 </refnamediv>
3413
3414 <refsynopsisdiv>
3415 <programlisting xml:id="editedby.enabled.frag">&lt;xsl:param name="editedby.enabled"&gt;1&lt;/xsl:param&gt;</programlisting>
3416 </refsynopsisdiv>
3417
3418 <refsection><info><title>Description</title></info>
3419
3420 <para>If non-zero, a localized <emphasis role="bold">Edited
3421 by</emphasis> heading is displayed above editor names in output of the
3422 <tag>editor</tag> element.</para>
3423
3424 </refsection>
3425 </refentry>
3426
3427 <refentry version="5.0" xml:id="abstract.notitle.enabled">
3428 <refmeta>
3429 <refentrytitle>abstract.notitle.enabled</refentrytitle>
3430 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3431 </refmeta>
3432 <refnamediv>
3433 <refname>abstract.notitle.enabled</refname>
3434 <refpurpose>Suppress display of abstract titles?</refpurpose>
3435 </refnamediv>
3436 <refsynopsisdiv>
3437   <programlisting xml:id="abstract.notitle.enabled.frag">&lt;xsl:param name="abstract.notitle.enabled" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3438 </refsynopsisdiv>
3439 <refsection><info><title>Description</title></info>
3440 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
3441 display of the abstract title is suppressed.</para>
3442 </refsection>
3443 </refentry>
3444
3445 <refentry version="5.0" xml:id="othercredit.like.author.enabled">
3446 <refmeta>
3447 <refentrytitle>othercredit.like.author.enabled</refentrytitle>
3448 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3449 </refmeta>
3450 <refnamediv>
3451 <refname>othercredit.like.author.enabled</refname>
3452 <refpurpose>Display othercredit in same style as author?</refpurpose>
3453 </refnamediv>
3454
3455 <refsynopsisdiv>
3456 <programlisting xml:id="othercredit.like.author.enabled.frag">&lt;xsl:param name="othercredit.like.author.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
3457 </refsynopsisdiv>
3458
3459 <refsection><info><title>Description</title></info>
3460
3461 <para>If non-zero, output of the
3462 <tag>othercredit</tag> element on titlepages is displayed in
3463 the same style as <tag>author</tag> and
3464 <tag>editor</tag> output. If zero then
3465 <tag>othercredit</tag> output is displayed using a style
3466 different than that of <tag>author</tag> and
3467 <tag>editor</tag>.</para>
3468
3469 </refsection>
3470 </refentry>
3471
3472 <refentry version="5.0" xml:id="generate.legalnotice.link">
3473 <refmeta>
3474 <refentrytitle>generate.legalnotice.link</refentrytitle>
3475 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3476 </refmeta>
3477 <refnamediv>
3478 <refname>generate.legalnotice.link</refname>
3479 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
3480 </refnamediv>
3481
3482 <refsynopsisdiv>
3483 <programlisting xml:id="generate.legalnotice.link.frag">&lt;xsl:param name="generate.legalnotice.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3484 </refsynopsisdiv>
3485
3486 <refsection><info><title>Description</title></info>
3487
3488 <para>If the value of <parameter>generate.legalnotice.link</parameter>
3489 is non-zero, the stylesheet:
3490
3491 <itemizedlist>
3492   <listitem>
3493     <para>writes the contents of <tag>legalnotice</tag> to a separate
3494     HTML file</para>
3495   </listitem>
3496   <listitem>
3497     <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
3498   </listitem>
3499   <listitem>
3500     <para>adds (in the HTML <literal>head</literal>) either a single
3501     <literal>link</literal> or element or multiple
3502     <literal>link</literal> elements (depending on the value of the
3503     <parameter>html.head.legalnotice.link.multiple</parameter>
3504     parameter), with the value or values derived from the
3505     <parameter>html.head.legalnotice.link.types</parameter>
3506     parameter</para>
3507   </listitem>
3508   </itemizedlist>
3509
3510   Otherwise, if <parameter>generate.legalnotice.link</parameter> is
3511   zero, <tag>legalnotice</tag> contents are rendered on the title
3512   page.</para>
3513
3514 <para>The name of the separate HTML file is computed as follows:
3515
3516 <orderedlist>
3517 <listitem>
3518   <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
3519 processing instruction, that filename is used.</para>
3520 </listitem>
3521 <listitem>
3522   <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3523 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
3524 is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
3525 parameter.</para>
3526 </listitem>
3527 <listitem>
3528   <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3529  attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
3530 auto-generated id value, and <parameter>html.ext</parameter> value.
3531   </para>
3532 </listitem>
3533 </orderedlist>
3534
3535 </para>
3536
3537 </refsection>
3538 </refentry>
3539
3540 <refentry version="5.0" xml:id="generate.revhistory.link">
3541 <refmeta>
3542 <refentrytitle>generate.revhistory.link</refentrytitle>
3543 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3544 </refmeta>
3545 <refnamediv>
3546 <refname>generate.revhistory.link</refname>
3547 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
3548 </refnamediv>
3549
3550 <refsynopsisdiv>
3551 <programlisting xml:id="generate.revhistory.link.frag">&lt;xsl:param name="generate.revhistory.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3552 </refsynopsisdiv>
3553
3554 <refsection><info><title>Description</title></info>
3555
3556 <para>If non-zero, the contents of <tag>revhistory</tag> are written
3557 to a separate HTML file and a link to the file is
3558 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
3559 the title page.</para>
3560
3561 <para>The name of the separate HTML file is computed as follows:
3562
3563 <orderedlist>
3564 <listitem>
3565   <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
3566 that filename is used.</para>
3567 </listitem>
3568 <listitem>
3569   <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3570 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
3571 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
3572 </listitem>
3573 <listitem>
3574   <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3575 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
3576 auto-generated id value, and <parameter>html.ext</parameter> value.
3577   </para>
3578 </listitem>
3579 </orderedlist>
3580
3581 </para>
3582
3583 </refsection>
3584 </refentry>
3585
3586 <refentry version="5.0" xml:id="html.head.legalnotice.link.types">
3587 <refmeta>
3588 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
3589 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3590 </refmeta>
3591 <refnamediv>
3592 <refname>html.head.legalnotice.link.types</refname>
3593 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
3594 </refnamediv>
3595
3596 <refsynopsisdiv>
3597 <programlisting xml:id="html.head.legalnotice.link.types.frag">
3598 &lt;xsl:param name="html.head.legalnotice.link.types"&gt;copyright&lt;/xsl:param&gt;
3599 </programlisting>
3600 </refsynopsisdiv>
3601
3602 <refsection><info><title>Description</title></info>
3603
3604 <para>The value of
3605 <parameter>html.head.legalnotice.link.types</parameter> is a
3606 space-separated list of link types, as described in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12
3607 of the HTML 4.01 specification</link>. If the value of the
3608 <parameter>generate.legalnotice.link</parameter> parameter is
3609 non-zero, then the stylesheet generates (in the
3610 <literal>head</literal> section of the HTML source) either a single
3611 HTML <literal>link</literal> element or, if the value of the
3612 <parameter>html.head.legalnotice.link.multiple</parameter> is
3613 non-zero, one <literal>link</literal> element for each link type
3614 specified. Each <literal>link</literal> has the following attributes:
3615
3616 <itemizedlist>
3617   <listitem>
3618     <para>a <tag class="attribute">rel</tag> attribute whose
3619     value is derived from the value of
3620     <parameter>html.head.legalnotice.link.types</parameter></para>
3621   </listitem>
3622   <listitem>
3623     <para>an <tag class="attribute">href</tag> attribute whose
3624     value is set to the URL of the file containing the
3625     <tag>legalnotice</tag></para>
3626   </listitem>
3627   <listitem>
3628     <para>a <tag class="attribute">title</tag> attribute whose
3629     value is set to the title of the corresponding
3630     <tag>legalnotice</tag> (or a title programatically
3631     determined by the stylesheet)</para>
3632   </listitem>
3633 </itemizedlist>
3634
3635 For example:
3636
3637 <screen>  &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
3638 </para>
3639
3640 <refsection><info><title>About the default value</title></info>
3641
3642   <para>In an ideal world, the default value of
3643   <parameter>html.head.legalnotice.link.types</parameter> would
3644   probably be &#8220;<literal>license</literal>&#8221;, since the content of the
3645   DocBook <tag>legalnotice</tag> is typically license
3646   information, not copyright information. However, the default value
3647   is &#8220;<literal>copyright</literal>&#8221; for pragmatic reasons: because
3648   that&#8217;s among the set of &#8220;recognized link types&#8221; listed in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section
3649   6.12 of the HTML 4.01 specification</link>, and because certain
3650   browsers and browser extensions are preconfigured to recognize that
3651   value.</para>
3652 </refsection>
3653
3654 </refsection>
3655 </refentry>
3656
3657 <refentry version="5.0" xml:id="html.head.legalnotice.link.multiple">
3658 <refmeta>
3659 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
3660 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3661 </refmeta>
3662 <refnamediv>
3663 <refname>html.head.legalnotice.link.multiple</refname>
3664 <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
3665 </refnamediv>
3666
3667 <refsynopsisdiv>
3668 <programlisting xml:id="html.head.legalnotice.link.multiple.frag">
3669 &lt;xsl:param name="html.head.legalnotice.link.multiple" select="1"&gt;&lt;/xsl:param&gt;
3670 </programlisting>
3671 </refsynopsisdiv>
3672
3673 <refsection><info><title>Description</title></info>
3674
3675 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
3676 non-zero and the value of
3677 <parameter>html.head.legalnotice.link.types</parameter> contains
3678 multiple link types, then the stylesheet generates (in the
3679 <literal>head</literal> section of the HTML source) one
3680 <literal>link</literal> element for each link type specified. For
3681 example, if the value of
3682 <parameter>html.head.legalnotice.link.types</parameter> is
3683 &#8220;<literal>copyright license</literal>&#8221;:
3684
3685 <screen>  &lt;link rel="copyright" href="ln-id2524073.html" title="Legal Notice"&gt;
3686   &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
3687
3688  Otherwise, the stylesheet generates generates a single
3689  <literal>link</literal> instance; for example:
3690
3691 <screen>  &lt;link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
3692
3693 </para>
3694 </refsection>
3695 </refentry>
3696
3697 </reference>
3698 <reference xml:id="refentry"><title>Reference Pages</title>
3699 <refentry version="5.0" xml:id="funcsynopsis.decoration">
3700 <refmeta>
3701 <refentrytitle>funcsynopsis.decoration</refentrytitle>
3702 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3703 </refmeta>
3704 <refnamediv>
3705 <refname>funcsynopsis.decoration</refname>
3706 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
3707 </refnamediv>
3708
3709 <refsynopsisdiv>
3710 <programlisting xml:id="funcsynopsis.decoration.frag">
3711 &lt;xsl:param name="funcsynopsis.decoration" select="1"&gt;&lt;/xsl:param&gt;
3712 </programlisting>
3713 </refsynopsisdiv>
3714
3715 <refsection><info><title>Description</title></info>
3716
3717 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
3718 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
3719 templates that can be redefined in a customization layer.
3720 </para>
3721
3722 </refsection>
3723 </refentry>
3724
3725 <refentry version="5.0" xml:id="funcsynopsis.style">
3726 <refmeta>
3727 <refentrytitle>funcsynopsis.style</refentrytitle>
3728 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3729 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
3730 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
3731 </refmeta>
3732 <refnamediv>
3733 <refname>funcsynopsis.style</refname>
3734 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
3735 </refnamediv>
3736
3737 <refsynopsisdiv>
3738 <programlisting xml:id="funcsynopsis.style.frag">&lt;xsl:param name="funcsynopsis.style"&gt;kr&lt;/xsl:param&gt;</programlisting>
3739 </refsynopsisdiv>
3740
3741 <refsection><info><title>Description</title></info>
3742
3743 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
3744 ANSI-style function synopses are generated for a
3745 <tag>funcsynopsis</tag>, otherwise K&amp;R-style
3746 function synopses are generated.
3747 </para>
3748
3749 </refsection>
3750 </refentry>
3751
3752 <refentry version="5.0" xml:id="function.parens">
3753 <refmeta>
3754 <refentrytitle>function.parens</refentrytitle>
3755 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3756 </refmeta>
3757 <refnamediv>
3758 <refname>function.parens</refname>
3759 <refpurpose>Generate parens after a function?</refpurpose>
3760 </refnamediv>
3761
3762 <refsynopsisdiv>
3763 <programlisting xml:id="function.parens.frag">
3764 &lt;xsl:param name="function.parens" select="0"&gt;&lt;/xsl:param&gt;
3765 </programlisting>
3766 </refsynopsisdiv>
3767
3768 <refsection><info><title>Description</title></info>
3769
3770 <para>If non-zero, the formatting of a <tag>function</tag> element
3771 will include generated parentheses.
3772 </para>
3773
3774 </refsection>
3775 </refentry>
3776
3777 <refentry version="5.0" xml:id="refentry.generate.name">
3778 <refmeta>
3779 <refentrytitle>refentry.generate.name</refentrytitle>
3780 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3781 </refmeta>
3782 <refnamediv>
3783 <refname>refentry.generate.name</refname>
3784 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
3785 </refnamediv>
3786
3787 <refsynopsisdiv>
3788 <programlisting xml:id="refentry.generate.name.frag">
3789 &lt;xsl:param name="refentry.generate.name" select="1"&gt;&lt;/xsl:param&gt;
3790 </programlisting>
3791 </refsynopsisdiv>
3792
3793 <refsection><info><title>Description</title></info>
3794
3795 <para>If non-zero, a "NAME" section title is output before the list
3796 of <tag>refname</tag>s. This parameter and
3797 <parameter>refentry.generate.title</parameter> are mutually
3798 exclusive. This means that if you change this parameter to zero, you
3799 should set <parameter>refentry.generate.title</parameter> to non-zero unless
3800 you want get quite strange output.
3801 </para>
3802
3803 </refsection>
3804 </refentry>
3805
3806 <refentry version="5.0" xml:id="refentry.generate.title">
3807 <refmeta>
3808 <refentrytitle>refentry.generate.title</refentrytitle>
3809 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3810 </refmeta>
3811 <refnamediv>
3812 <refname>refentry.generate.title</refname>
3813 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
3814 </refnamediv>
3815
3816 <refsynopsisdiv>
3817 <programlisting xml:id="refentry.generate.title.frag">
3818 &lt;xsl:param name="refentry.generate.title" select="0"&gt;&lt;/xsl:param&gt;
3819 </programlisting>
3820 </refsynopsisdiv>
3821
3822 <refsection><info><title>Description</title></info>
3823
3824 <para>If non-zero, the reference page title or first name is
3825 output before the list of <tag>refname</tag>s. This parameter and
3826 <parameter>refentry.generate.name</parameter> are mutually exclusive.
3827 This means that if you change this parameter to non-zero, you
3828 should set <parameter>refentry.generate.name</parameter> to zero unless
3829 you want get quite strange output.</para>
3830
3831
3832 </refsection>
3833 </refentry>
3834
3835 <refentry version="5.0" xml:id="refentry.xref.manvolnum">
3836 <refmeta>
3837 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
3838 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3839 </refmeta>
3840 <refnamediv>
3841 <refname>refentry.xref.manvolnum</refname>
3842 <refpurpose>Output <tag>manvolnum</tag> as part of
3843 <tag>refentry</tag> cross-reference?</refpurpose>
3844 </refnamediv>
3845
3846 <refsynopsisdiv>
3847 <programlisting xml:id="refentry.xref.manvolnum.frag">
3848 &lt;xsl:param name="refentry.xref.manvolnum" select="1"&gt;&lt;/xsl:param&gt;
3849 </programlisting>
3850 </refsynopsisdiv>
3851
3852 <refsection><info><title>Description</title></info>
3853
3854 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
3855 <tag>refentry</tag>s, either with <tag>xref</tag>
3856 or <tag>citerefentry</tag>.
3857 </para>
3858
3859 </refsection>
3860 </refentry>
3861
3862 <refentry version="5.0" xml:id="citerefentry.link">
3863 <refmeta>
3864 <refentrytitle>citerefentry.link</refentrytitle>
3865 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3866 </refmeta>
3867 <refnamediv>
3868 <refname>citerefentry.link</refname>
3869 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
3870 </refnamediv>
3871
3872 <refsynopsisdiv>
3873 <programlisting xml:id="citerefentry.link.frag">
3874 &lt;xsl:param name="citerefentry.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3875 </refsynopsisdiv>
3876
3877 <refsection><info><title>Description</title></info>
3878
3879 <para>If non-zero, a web link will be generated, presumably
3880 to an online man-&gt;HTML gateway. The text of the link is
3881 generated by the <literal>generate.citerefentry.link</literal> template.
3882 </para>
3883
3884 </refsection>
3885 </refentry>
3886
3887 <refentry version="5.0" xml:id="refentry.separator">
3888 <refmeta>
3889 <refentrytitle>refentry.separator</refentrytitle>
3890 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3891 </refmeta>
3892 <refnamediv>
3893 <refname>refentry.separator</refname>
3894 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
3895 </refnamediv>
3896
3897 <refsynopsisdiv>
3898 <programlisting xml:id="refentry.separator.frag">
3899 &lt;xsl:param name="refentry.separator" select="1"&gt;&lt;/xsl:param&gt;
3900 </programlisting>
3901 </refsynopsisdiv>
3902
3903 <refsection><info><title>Description</title></info>
3904
3905 <para>If true, a separator will be generated between consecutive
3906 reference pages.
3907 </para>
3908
3909 </refsection>
3910 </refentry>
3911
3912 <refentry version="5.0" xml:id="refclass.suppress">
3913 <refmeta>
3914 <refentrytitle>refclass.suppress</refentrytitle>
3915 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3916 </refmeta>
3917 <refnamediv>
3918 <refname>refclass.suppress</refname>
3919 <refpurpose>Suppress display of refclass contents?</refpurpose>
3920 </refnamediv>
3921
3922 <refsynopsisdiv>
3923 <programlisting xml:id="refclass.suppress.frag">
3924 &lt;xsl:param name="refclass.suppress" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
3925 </refsynopsisdiv>
3926
3927 <refsection><info><title>Description</title></info>
3928
3929 <para>If the value of <parameter>refclass.suppress</parameter> is
3930 non-zero, then display of <tag>refclass</tag> contents is
3931 suppressed in output.</para>
3932
3933 </refsection>
3934 </refentry>
3935
3936 </reference>
3937 <reference xml:id="tables"><title>Tables</title>
3938 <refentry version="5.0" xml:id="default.table.width">
3939 <refmeta>
3940 <refentrytitle>default.table.width</refentrytitle>
3941 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3942 </refmeta>
3943 <refnamediv>
3944 <refname>default.table.width</refname>
3945 <refpurpose>The default width of tables</refpurpose>
3946 </refnamediv>
3947 <refsynopsisdiv>
3948 <programlisting xml:id="default.table.width.frag">
3949 &lt;xsl:param name="default.table.width"&gt;&lt;/xsl:param&gt;
3950 </programlisting>
3951 </refsynopsisdiv>
3952 <refsection><info><title>Description</title></info>
3953 <para>If non-zero, this value will be used for the
3954 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
3955 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
3956 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
3957 </refsection>
3958 </refentry>
3959
3960 <refentry version="5.0" xml:id="nominal.table.width">
3961 <refmeta>
3962 <refentrytitle>nominal.table.width</refentrytitle>
3963 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3964 </refmeta>
3965 <refnamediv>
3966 <refname>nominal.table.width</refname>
3967 <refpurpose>The (absolute) nominal width of tables</refpurpose>
3968 </refnamediv>
3969
3970 <refsynopsisdiv>
3971 <programlisting xml:id="nominal.table.width.frag">
3972 &lt;xsl:param name="nominal.table.width"&gt;6in&lt;/xsl:param&gt;
3973 </programlisting>
3974 </refsynopsisdiv>
3975
3976 <refsection><info><title>Description</title></info>
3977
3978 <para>In order to convert CALS column widths into HTML column widths, it
3979 is sometimes necessary to have an absolute table width to use for conversion
3980 of mixed absolute and relative widths. This value must be an absolute
3981 length (not a percentage).</para>
3982
3983 </refsection>
3984 </refentry>
3985
3986 <refentry version="5.0" xml:id="table.borders.with.css">
3987 <refmeta>
3988 <refentrytitle>table.borders.with.css</refentrytitle>
3989 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3990 </refmeta>
3991 <refnamediv>
3992 <refname>table.borders.with.css</refname>
3993 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
3994 </refnamediv>
3995
3996 <refsynopsisdiv>
3997 <programlisting xml:id="table.borders.with.css.frag">
3998 &lt;xsl:param name="table.borders.with.css" select="0"&gt;&lt;/xsl:param&gt;
3999 </programlisting>
4000 </refsynopsisdiv>
4001
4002 <refsection><info><title>Description</title></info>
4003
4004 <para>If non-zero, CSS will be used to draw table borders.
4005 </para>
4006
4007 </refsection>
4008 </refentry>
4009
4010 <refentry version="5.0" xml:id="table.cell.border.style">
4011 <refmeta>
4012 <refentrytitle>table.cell.border.style</refentrytitle>
4013 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4014 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4015 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4016 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4017 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4018 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4019 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
4020 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4021 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4022 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
4023 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4024 </refmeta>
4025 <refnamediv>
4026 <refname>table.cell.border.style</refname>
4027 <refpurpose>Specifies the border style of table cells</refpurpose>
4028 </refnamediv>
4029
4030 <refsynopsisdiv>
4031 <programlisting xml:id="table.cell.border.style.frag">
4032 &lt;xsl:param name="table.cell.border.style"&gt;solid&lt;/xsl:param&gt;
4033 </programlisting>
4034 </refsynopsisdiv>
4035
4036 <refsection><info><title>Description</title></info>
4037
4038 <para>Specifies the border style of table cells.</para>
4039
4040 <note>
4041   <para>To control properties of cell borders in HTML output, you must also turn on the
4042   <parameter>table.borders.with.css</parameter> parameter.</para>
4043 </note>
4044
4045 </refsection>
4046 </refentry>
4047
4048 <refentry version="5.0" xml:id="table.cell.border.thickness">
4049 <refmeta>
4050 <refentrytitle>table.cell.border.thickness</refentrytitle>
4051 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4052 </refmeta>
4053 <refnamediv>
4054 <refname>table.cell.border.thickness</refname>
4055 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
4056 </refnamediv>
4057
4058 <refsynopsisdiv>
4059 <programlisting xml:id="table.cell.border.thickness.frag">
4060 &lt;xsl:param name="table.cell.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
4061 </programlisting>
4062 </refsynopsisdiv>
4063
4064 <refsection><info><title>Description</title></info>
4065
4066 <para>If non-zero, specifies the thickness of borders on table
4067 cells. The units are points. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
4068 CSS</link></para>
4069
4070 <note>
4071   <para>To control properties of cell borders in HTML output, you must also turn on the
4072   <parameter>table.borders.with.css</parameter> parameter.</para>
4073 </note>
4074
4075 </refsection>
4076 </refentry>
4077
4078 <refentry version="5.0" xml:id="table.cell.border.color">
4079 <refmeta>
4080 <refentrytitle>table.cell.border.color</refentrytitle>
4081 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4082 </refmeta>
4083 <refnamediv>
4084 <refname>table.cell.border.color</refname>
4085 <refpurpose>Specifies the border color of table cells</refpurpose>
4086 </refnamediv>
4087
4088 <refsynopsisdiv>
4089 <programlisting xml:id="table.cell.border.color.frag">
4090 &lt;xsl:param name="table.cell.border.color"&gt;&lt;/xsl:param&gt;
4091
4092 </programlisting>
4093 </refsynopsisdiv>
4094
4095 <refsection><info><title>Description</title></info>
4096
4097 <para>Set the color of table cell borders. If non-zero, the value is used
4098 for the border coloration. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
4099 <literal>color</literal> is either a keyword or a numerical RGB specification.
4100 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
4101 navy, olive, orange, purple, red, silver, teal, white, and
4102 yellow.</para>
4103
4104 <note>
4105   <para>To control properties of cell borders in HTML output, you must also turn on the
4106   <parameter>table.borders.with.css</parameter> parameter.</para>
4107 </note>
4108
4109 </refsection>
4110 </refentry>
4111
4112 <refentry version="5.0" xml:id="table.frame.border.style">
4113 <refmeta>
4114 <refentrytitle>table.frame.border.style</refentrytitle>
4115 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4116 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4117 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4118 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4119 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4120 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4121 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
4122 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4123 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4124 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
4125 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4126 </refmeta>
4127 <refnamediv>
4128 <refname>table.frame.border.style</refname>
4129 <refpurpose>Specifies the border style of table frames</refpurpose>
4130 </refnamediv>
4131
4132 <refsynopsisdiv>
4133 <programlisting xml:id="table.frame.border.style.frag">
4134 &lt;xsl:param name="table.frame.border.style"&gt;solid&lt;/xsl:param&gt;
4135 </programlisting>
4136 </refsynopsisdiv>
4137
4138 <refsection><info><title>Description</title></info>
4139
4140 <para>Specifies the border style of table frames.</para>
4141
4142 </refsection>
4143 </refentry>
4144
4145 <refentry version="5.0" xml:id="table.frame.border.thickness">
4146 <refmeta>
4147 <refentrytitle>table.frame.border.thickness</refentrytitle>
4148 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4149 </refmeta>
4150 <refnamediv>
4151 <refname>table.frame.border.thickness</refname>
4152 <refpurpose>Specifies the thickness of the frame border</refpurpose>
4153 </refnamediv>
4154
4155 <refsynopsisdiv>
4156 <programlisting xml:id="table.frame.border.thickness.frag">
4157 &lt;xsl:param name="table.frame.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
4158 </programlisting>
4159 </refsynopsisdiv>
4160
4161 <refsection><info><title>Description</title></info>
4162
4163 <para>Specifies the thickness of the border on the table's frame.</para>
4164
4165 </refsection>
4166 </refentry>
4167
4168 <refentry version="5.0" xml:id="table.frame.border.color">
4169 <refmeta>
4170 <refentrytitle>table.frame.border.color</refentrytitle>
4171 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4172 </refmeta>
4173 <refnamediv>
4174 <refname>table.frame.border.color</refname>
4175 <refpurpose>Specifies the border color of table frames</refpurpose>
4176 </refnamediv>
4177
4178 <refsynopsisdiv>
4179 <programlisting xml:id="table.frame.border.color.frag">
4180 &lt;xsl:param name="table.frame.border.color"&gt;&lt;/xsl:param&gt;
4181
4182 </programlisting>
4183 </refsynopsisdiv>
4184
4185 <refsection><info><title>Description</title></info>
4186
4187 <para>Specifies the border color of table frames.</para>
4188
4189 </refsection>
4190 </refentry>
4191
4192 <refentry version="5.0" xml:id="default.table.frame">
4193 <refmeta>
4194 <refentrytitle>default.table.frame</refentrytitle>
4195 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4196 </refmeta>
4197 <refnamediv>
4198 <refname>default.table.frame</refname>
4199 <refpurpose>The default framing of tables</refpurpose>
4200 </refnamediv>
4201
4202 <refsynopsisdiv>
4203 <programlisting xml:id="default.table.frame.frag">
4204 &lt;xsl:param name="default.table.frame"&gt;all&lt;/xsl:param&gt;
4205 </programlisting>
4206 </refsynopsisdiv>
4207
4208 <refsection><info><title>Description</title></info>
4209
4210 <para>This value will be used when there is no frame attribute on the
4211 table. </para>
4212
4213 </refsection>
4214 </refentry>
4215
4216 <refentry version="5.0" xml:id="html.cellspacing">
4217 <refmeta>
4218 <refentrytitle>html.cellspacing</refentrytitle>
4219 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4220 </refmeta>
4221 <refnamediv>
4222 <refname>html.cellspacing</refname>
4223 <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
4224 </refnamediv>
4225
4226 <refsynopsisdiv>
4227 <programlisting xml:id="html.cellspacing.frag">
4228 &lt;xsl:param name="html.cellspacing"&gt;&lt;/xsl:param&gt;
4229 </programlisting>
4230 </refsynopsisdiv>
4231
4232 <refsection><info><title>Description</title></info>
4233
4234 <para>If non-zero, this value will be used as the default cellspacing
4235 value in HTML tables. nn for pixels or nn% for percentage
4236 length. E.g. 5 or 5%</para>
4237
4238 </refsection>
4239 </refentry>
4240
4241 <refentry version="5.0" xml:id="html.cellpadding">
4242 <refmeta>
4243 <refentrytitle>html.cellpadding</refentrytitle>
4244 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4245 </refmeta>
4246 <refnamediv>
4247 <refname>html.cellpadding</refname>
4248 <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
4249 </refnamediv>
4250
4251 <refsynopsisdiv>
4252 <programlisting xml:id="html.cellpadding.frag">
4253 &lt;xsl:param name="html.cellpadding"&gt;&lt;/xsl:param&gt;
4254 </programlisting>
4255 </refsynopsisdiv>
4256
4257 <refsection><info><title>Description</title></info>
4258
4259 <para>If non-zero, this value will be used as the default cellpadding value
4260 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
4261 5%</para>
4262
4263 </refsection>
4264 </refentry>
4265
4266 </reference>
4267 <reference xml:id="qa"><title>QAndASet</title>
4268 <refentry version="5.0" xml:id="qanda.defaultlabel">
4269 <refmeta>
4270 <refentrytitle>qanda.defaultlabel</refentrytitle>
4271 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4272 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
4273 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
4274 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4275 </refmeta>
4276 <refnamediv>
4277 <refname>qanda.defaultlabel</refname>
4278 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
4279 </refnamediv>
4280
4281 <refsynopsisdiv>
4282 <programlisting xml:id="qanda.defaultlabel.frag">
4283 &lt;xsl:param name="qanda.defaultlabel"&gt;number&lt;/xsl:param&gt;
4284 </programlisting>
4285 </refsynopsisdiv>
4286
4287 <refsection><info><title>Description</title></info>
4288
4289 <para>If no <literal>defaultlabel</literal> attribute is specified on
4290 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
4291 values for the defaultlabel attribute (<literal>none</literal>,
4292 <literal>number</literal> or
4293 <literal>qanda</literal>), or one of the additional stylesheet-specific values
4294 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
4295 The default value is 'number'.
4296 </para>
4297 <para>The values are rendered as follows:</para>
4298 <variablelist>
4299 <varlistentry><term><literal>qanda</literal></term>
4300 <listitem>
4301 <para><tag>question</tag>s are labeled "Q:" and
4302 <tag>answer</tag>s are labeled "A:". </para>
4303 </listitem>
4304 </varlistentry>
4305
4306 <varlistentry><term><literal>number</literal></term>
4307 <listitem>
4308 <para>The questions are enumerated and the answers
4309 are not labeled. </para>
4310 </listitem>
4311 </varlistentry>
4312
4313 <varlistentry><term><literal>qnumber</literal></term>
4314 <listitem>
4315 <para>The questions are labeled "Q:" followed by a number, and answers are not
4316 labeled.
4317 When sections are numbered, adding a label
4318 to the number distinguishes the question numbers
4319 from the section numbers.
4320 This value is not allowed in the
4321 <tag class="attribute">defaultlabel</tag> attribute
4322 of a <tag>qandaset</tag> element.</para>
4323 </listitem>
4324 </varlistentry>
4325
4326 <varlistentry><term><literal>qnumberanda</literal></term>
4327 <listitem>
4328 <para>The questions are labeled "Q:" followed by a number, and
4329 the answers are labeled "A:".
4330 When sections are numbered, adding a label
4331 to the number distinguishes the question numbers
4332 from the section numbers.
4333 This value is not allowed in the
4334 <tag class="attribute">defaultlabel</tag> attribute
4335 of a <tag>qandaset</tag> element.</para>
4336 </listitem>
4337 </varlistentry>
4338
4339 <varlistentry><term><literal>none</literal></term>
4340 <listitem>
4341 <para>No distinguishing label precedes Questions or Answers.
4342 </para>
4343 </listitem>
4344 </varlistentry>
4345 </variablelist>
4346
4347 </refsection>
4348 </refentry>
4349
4350 <refentry version="5.0" xml:id="qanda.inherit.numeration">
4351 <refmeta>
4352 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4353 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4354 </refmeta>
4355 <refnamediv>
4356 <refname>qanda.inherit.numeration</refname>
4357 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4358 </refnamediv>
4359
4360 <refsynopsisdiv>
4361 <programlisting xml:id="qanda.inherit.numeration.frag">
4362 &lt;xsl:param name="qanda.inherit.numeration" select="1"&gt;&lt;/xsl:param&gt;
4363 </programlisting>
4364 </refsynopsisdiv>
4365
4366 <refsection><info><title>Description</title></info>
4367
4368 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4369 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4370 the ancestors of the <tag>qandaset</tag>.
4371 </para>
4372
4373 </refsection>
4374 </refentry>
4375
4376 <refentry version="5.0" xml:id="qanda.in.toc">
4377 <refmeta>
4378 <refentrytitle>qanda.in.toc</refentrytitle>
4379 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4380 </refmeta>
4381 <refnamediv>
4382 <refname>qanda.in.toc</refname>
4383 <refpurpose>Should qandaentry questions appear in
4384 the document table of contents?</refpurpose>
4385 </refnamediv>
4386
4387 <refsynopsisdiv>
4388 <programlisting xml:id="qanda.in.toc.frag">&lt;xsl:param name="qanda.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
4389 </refsynopsisdiv>
4390
4391 <refsection><info><title>Description</title></info>
4392
4393 <para>If true (non-zero), then the generated table of contents
4394 for a document will include <tag>qandaset</tag> titles,
4395 <tag>qandadiv</tag> titles,
4396 and <tag>question</tag> elements.  The default value (zero) excludes
4397 them from the TOC.
4398 </para>
4399 <para>This parameter does not affect any tables of contents
4400 that may be generated inside a qandaset or qandadiv.
4401 </para>
4402
4403 </refsection>
4404 </refentry>
4405
4406 <refentry version="5.0" xml:id="qanda.nested.in.toc">
4407 <refmeta>
4408 <refentrytitle>qanda.nested.in.toc</refentrytitle>
4409 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4410 </refmeta>
4411 <refnamediv>
4412 <refname>qanda.nested.in.toc</refname>
4413 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
4414 </refnamediv>
4415
4416 <refsynopsisdiv>
4417 <programlisting xml:id="qanda.nested.in.toc.frag">
4418 &lt;xsl:param name="qanda.nested.in.toc" select="0"&gt;&lt;/xsl:param&gt;
4419 </programlisting>
4420 </refsynopsisdiv>
4421
4422 <refsection><info><title>Description</title></info>
4423
4424 <para>If non-zero, instances of <tag>qandaentry</tag>
4425 that are children of <tag>answer</tag> elements are shown in
4426 the TOC.</para>
4427
4428 </refsection>
4429 </refentry>
4430
4431 </reference>
4432 <reference xml:id="links"><title>Linking</title>
4433 <refentry version="5.0" xml:id="target.database.document">
4434 <refmeta>
4435 <refentrytitle>target.database.document</refentrytitle>
4436 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4437 </refmeta>
4438 <refnamediv>
4439 <refname>target.database.document</refname>
4440 <refpurpose>Name of master database file for resolving
4441 olinks</refpurpose>
4442 </refnamediv>
4443 <refsynopsisdiv>
4444 <programlisting xml:id="target.database.document.frag">
4445  &lt;xsl:param name="target.database.document"&gt;olinkdb.xml&lt;/xsl:param&gt;
4446 </programlisting>
4447 </refsynopsisdiv>
4448 <refsection><info><title>Description</title></info>
4449
4450 <para>
4451 To resolve olinks between documents, the stylesheets use a master
4452 database document that identifies the target datafiles for all the
4453 documents within the scope of the olinks. This parameter value is the
4454 URI of the master document to be read during processing to resolve
4455 olinks.  The default value is <filename>olinkdb.xml</filename>.</para>
4456
4457 <para>The data structure of the file is defined in the
4458 <filename>targetdatabase.dtd</filename> DTD.  The database file
4459 provides the high level elements to record the identifiers, locations,
4460 and relationships of documents. The cross reference data for
4461 individual documents is generally pulled into the database using
4462 system entity references or XIncludes. See also
4463 <parameter>targets.filename</parameter>.  </para> </refsection>
4464 </refentry>
4465
4466 <refentry version="5.0" xml:id="targets.filename">
4467 <refmeta>
4468 <refentrytitle>targets.filename</refentrytitle>
4469 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4470 </refmeta>
4471 <refnamediv>
4472 <refname>targets.filename</refname>
4473 <refpurpose>Name of cross reference targets data file</refpurpose>
4474 </refnamediv>
4475 <refsynopsisdiv> <programlisting xml:id="targets.filename.frag">
4476 &lt;xsl:param name="targets.filename"&gt;target.db&lt;/xsl:param&gt;
4477 </programlisting>
4478 </refsynopsisdiv>
4479 <refsection><info><title>Description</title></info>
4480
4481 <para>
4482 In order to resolve olinks efficiently, the stylesheets can
4483 generate an external data file containing information about
4484 all potential cross reference endpoints in a document.
4485 This parameter lets you change the name of the generated
4486 file from the default name <filename>target.db</filename>.
4487 The name must agree with that used in the target database
4488 used to resolve olinks during processing.
4489 See also <parameter>target.database.document</parameter>.
4490 </para>
4491 </refsection>
4492 </refentry>
4493
4494 <refentry version="5.0" xml:id="olink.base.uri">
4495 <refmeta>
4496 <refentrytitle>olink.base.uri</refentrytitle>
4497 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4498 </refmeta>
4499 <refnamediv>
4500 <refname>olink.base.uri</refname>
4501 <refpurpose>Base URI used in olink hrefs</refpurpose>
4502 </refnamediv>
4503 <refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag">
4504 &lt;xsl:param name="olink.base.uri"&gt;&lt;/xsl:param&gt;
4505 </programlisting>
4506 </refsynopsisdiv>
4507 <refsection><info><title>Description</title></info>
4508
4509 <para>When cross reference data is collected for resolving olinks, it
4510 may be necessary to prepend a base URI to each target's href. This
4511 parameter lets you set that base URI when cross reference data is
4512 collected. This feature is needed when you want to link to a document
4513 that is processed without chunking. The output filename for such a
4514 document is not known to the XSL stylesheet; the only target
4515 information consists of fragment identifiers such as
4516 <literal>#idref</literal>. To enable the resolution of olinks between
4517 documents, you should pass the name of the HTML output file as the
4518 value of this parameter. Then the hrefs recorded in the cross
4519 reference data collection look like
4520 <literal>outfile.html#idref</literal>, which can be reached as links
4521 from other documents.</para>
4522 </refsection>
4523 </refentry>
4524
4525 <refentry version="5.0" xml:id="use.local.olink.style">
4526 <refmeta>
4527 <refentrytitle>use.local.olink.style</refentrytitle>
4528 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4529 </refmeta>
4530 <refnamediv>
4531 <refname>use.local.olink.style</refname>
4532 <refpurpose>Process olinks using xref style of current
4533 document</refpurpose>
4534 </refnamediv>
4535 <refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag">
4536 &lt;xsl:param name="use.local.olink.style" select="0"&gt;&lt;/xsl:param&gt; </programlisting>
4537 </refsynopsisdiv>
4538 <refsection><info><title>Description</title></info>
4539
4540 <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
4541 reference string is formed again from the target title, number, and
4542 element name, using the stylesheet processing the targeting document.
4543 Then olinks will match the xref style in the targeting document
4544 rather than in the target document. If  both documents are processed
4545 with the same stylesheet, then the results will be the same.</para>
4546 </refsection>
4547 </refentry>
4548
4549 <refentry version="5.0" xml:id="current.docid">
4550 <refmeta>
4551 <refentrytitle>current.docid</refentrytitle>
4552 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4553 </refmeta>
4554 <refnamediv>
4555 <refname>current.docid</refname>
4556 <refpurpose>targetdoc identifier for the document being
4557 processed</refpurpose>
4558 </refnamediv>
4559 <refsynopsisdiv> <programlisting xml:id="current.docid.frag">
4560 &lt;xsl:param name="current.docid"&gt;&lt;/xsl:param&gt;
4561 </programlisting>
4562 </refsynopsisdiv>
4563 <refsection><info><title>Description</title></info>
4564
4565 <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
4566 the targetdoc identifier of the current document, since that
4567 identifier does not appear in the document itself. </para>
4568 <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>
4569 </refsection>
4570 </refentry>
4571
4572 <refentry version="5.0" xml:id="olink.doctitle">
4573 <refmeta>
4574 <refentrytitle>olink.doctitle</refentrytitle>
4575 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4576 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4577 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4578 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4579 </refmeta>
4580 <refnamediv>
4581 <refname>olink.doctitle</refname>
4582 <refpurpose>show the document title for external olinks?</refpurpose>
4583
4584 </refnamediv>
4585 <refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag">
4586 &lt;xsl:param name="olink.doctitle"&gt;no&lt;/xsl:param&gt;
4587 </programlisting>
4588 </refsynopsisdiv>
4589 <refsection><info><title>Description</title></info>
4590
4591 <para>When olinks between documents are resolved, the generated text
4592 may not make it clear that the reference is to another document.
4593 It is possible for the stylesheets to append the other document's
4594 title to external olinks. For this to happen, two parameters must
4595 be set.</para>
4596 <itemizedlist>
4597 <listitem>
4598 <para>This <parameter>olink.doctitle</parameter> parameter
4599 should be set to either <literal>yes</literal> or <literal>maybe</literal>
4600 to enable this feature.
4601 </para>
4602 </listitem>
4603 <listitem>
4604 <para>And you should also set the <parameter>current.docid</parameter>
4605 parameter to the document id for the  document currently
4606 being processed for output.
4607 </para>
4608 </listitem>
4609 </itemizedlist>
4610
4611 <para>
4612 Then if an olink's  <literal>targetdoc</literal> id differs from
4613 the <literal>current.docid</literal> value, the stylesheet knows
4614 that it is a reference to another document and can
4615 append the target document's
4616 title to the generated olink text. </para>
4617
4618 <para>The text for the target document's title is copied from the
4619 olink database from the <tag>ttl</tag> element
4620 of the top-level <tag>div</tag> for that document.
4621 If that <tag>ttl</tag> element is missing or empty,
4622 no title is output.
4623 </para>
4624
4625 <para>The supported values for <parameter>olink.doctitle</parameter> are:
4626 </para>
4627 <variablelist>
4628 <varlistentry>
4629 <term><literal>yes</literal></term>
4630 <listitem>
4631 <para>
4632 Always insert the title to the target document if it is not
4633 the current document.
4634 </para>
4635 </listitem>
4636 </varlistentry>
4637 <varlistentry>
4638 <term><literal>no</literal></term>
4639 <listitem>
4640 <para>
4641 Never insert the title to the target document, even if requested
4642 in an <tag class="attribute">xrefstyle</tag> attribute.
4643 </para>
4644 </listitem>
4645 </varlistentry>
4646 <varlistentry>
4647 <term><literal>maybe</literal></term>
4648 <listitem>
4649 <para>
4650 Only insert the title to the target document, if requested
4651 in an <tag class="attribute">xrefstyle</tag> attribute.
4652 </para>
4653 </listitem>
4654 </varlistentry>
4655 </variablelist>
4656 <para>An <tag class="attribute">xrefstyle</tag> attribute
4657 may override the global setting for individual olinks.
4658 The following values are supported in an
4659 <tag class="attribute">xrefstyle</tag>
4660 attribute using the <literal>select:</literal> syntax:
4661 </para>
4662
4663 <variablelist>
4664 <varlistentry>
4665 <term><literal>docname</literal></term>
4666 <listitem>
4667 <para>
4668 Insert the target document name for this olink using the
4669 <literal>docname</literal> gentext template, but only
4670 if the value of <parameter>olink.doctitle</parameter>
4671 is not <literal>no</literal>.
4672 </para>
4673 </listitem>
4674 </varlistentry>
4675 <varlistentry>
4676 <term><literal>docnamelong</literal></term>
4677 <listitem>
4678 <para>
4679 Insert the target document name for this olink using the
4680 <literal>docnamelong</literal> gentext template, but only
4681 if the value of <parameter>olink.doctitle</parameter>
4682 is not <literal>no</literal>.
4683 </para>
4684 </listitem>
4685 </varlistentry>
4686 <varlistentry>
4687 <term><literal>nodocname</literal></term>
4688 <listitem>
4689 <para>
4690 Omit the target document name even if
4691 the value of <parameter>olink.doctitle</parameter>
4692 is <literal>yes</literal>.
4693 </para>
4694 </listitem>
4695 </varlistentry>
4696 </variablelist>
4697 <para>Another way of inserting the target document name
4698 for a single olink is to employ an
4699 <tag class="attribute">xrefstyle</tag>
4700 attribute using the <literal>template:</literal> syntax.
4701 The <literal>%o</literal> placeholder (the letter o, not zero)
4702 in such a template
4703 will be filled in with the target document's title when it is processed.
4704 This will occur regardless of
4705 the value of <parameter>olink.doctitle</parameter>.
4706 </para>
4707 <para>Note that prior to version 1.66 of the XSL stylesheets,
4708 the allowed values for this parameter were 0 and 1.  Those
4709 values are still supported and mapped to 'no' and 'yes', respectively.
4710 </para>
4711 </refsection>
4712 </refentry>
4713
4714 <refentry version="5.0" xml:id="olink.debug">
4715 <refmeta>
4716 <refentrytitle>olink.debug</refentrytitle>
4717 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4718 </refmeta>
4719 <refnamediv>
4720 <refname>olink.debug</refname>
4721 <refpurpose>Turn on debugging messages for olinks</refpurpose>
4722 </refnamediv>
4723
4724 <refsynopsisdiv>
4725 <programlisting xml:id="olink.debug.frag">
4726 &lt;xsl:param name="olink.debug" select="0"&gt;&lt;/xsl:param&gt;
4727 </programlisting>
4728 </refsynopsisdiv>
4729
4730 <refsection><info><title>Description</title></info>
4731
4732 <para>If non-zero, then each olink will generate several
4733 messages about how it is being resolved during processing.
4734 This is useful when an olink does not resolve properly
4735 and the standard error messages are not sufficient to
4736 find the problem.
4737 </para>
4738
4739 <para>You may need to read through the olink XSL templates
4740 to understand the context for some of the debug messages.
4741 </para>
4742
4743 </refsection>
4744 </refentry>
4745
4746 <refentry version="5.0" xml:id="olink.properties">
4747 <refmeta>
4748 <refentrytitle>olink.properties</refentrytitle>
4749 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4750 </refmeta>
4751 <refnamediv>
4752 <refname>olink.properties</refname>
4753 <refpurpose>Properties associated with the cross-reference
4754 text of an olink.</refpurpose>
4755 </refnamediv>
4756
4757 <refsynopsisdiv>
4758 <programlisting xml:id="olink.properties.frag">
4759 &lt;xsl:attribute-set name="olink.properties"&gt;
4760   &lt;xsl:attribute name="show-destination"&gt;replace&lt;/xsl:attribute&gt;
4761 &lt;/xsl:attribute-set&gt;
4762 </programlisting>
4763 </refsynopsisdiv>
4764
4765 <refsection><info><title>Description</title></info>
4766
4767 <para>This <literal>attribute set</literal> is applied to the
4768 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
4769 optional page number or optional title of the external
4770 document.</para>
4771
4772 </refsection>
4773 </refentry>
4774
4775 <refentry version="5.0" xml:id="olink.lang.fallback.sequence">
4776 <refmeta>
4777 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
4778 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4779 </refmeta>
4780 <refnamediv>
4781 <refname>olink.lang.fallback.sequence</refname>
4782 <refpurpose>look up translated documents if olink not found?</refpurpose>
4783
4784 </refnamediv>
4785 <refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag">
4786 &lt;xsl:param name="olink.lang.fallback.sequence"&gt;&lt;/xsl:param&gt;
4787 </programlisting>
4788 </refsynopsisdiv>
4789 <refsection><info><title>Description</title></info>
4790
4791
4792 <para>This parameter defines a list of lang values
4793 to search among to resolve olinks.
4794 </para>
4795
4796 <para>Normally an olink tries to resolve to a document in the same
4797 language as the olink itself.  The language of an olink
4798 is determined by its nearest ancestor element with a
4799 <tag class="attribute">lang</tag> attribute, otherwise the
4800 value of the <parameter>l10n.gentext.default.lang</parameter>
4801 parameter.
4802 </para>
4803
4804 <para>An olink database can contain target data for the same
4805 document in multiple languages.  Each set of data has the
4806 same value for the <tag>targetdoc</tag> attribute in
4807 the <tag>document</tag> element in the database, but with a
4808 different <tag>lang</tag> attribute value.
4809 </para>
4810
4811 <para>When an olink is being resolved, the target is first
4812 sought in the document with the same language as the olink.
4813 If no match is found there, then this parameter is consulted
4814 for additional languages to try.</para>
4815
4816 <para>The <parameter>olink.lang.fallback.sequence</parameter>
4817 must be a whitespace separated list of lang values to
4818 try.  The first one with a match in the olink database is used.
4819 The default value is empty.</para>
4820
4821 <para>For example, a document might be written in German
4822 and contain an olink with
4823 <literal>targetdoc="adminguide"</literal>.
4824 When the document is processed, the processor
4825 first looks for a target dataset in the
4826 olink database starting with:</para>
4827
4828 <literallayout><literal>&lt;document targetdoc="adminguide" lang="de"&gt;</literal>.
4829 </literallayout>
4830
4831 <para>If there is no such element, then the
4832 <parameter>olink.lang.fallback.sequence</parameter>
4833 parameter is consulted.
4834 If its value is, for example, <quote>fr en</quote>, then the processor next
4835 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
4836 then for <literal>targetdoc="adminguide" lang="en"</literal>.
4837 If there is still no match, it looks for
4838 <literal>targetdoc="adminguide"</literal> with no
4839 lang attribute.
4840 </para>
4841
4842 <para>This parameter is useful when a set of documents is only
4843 partially translated, or is in the process of being translated.
4844 If a target of an olink has not yet been translated, then this
4845 parameter permits the processor to look for the document in
4846 other languages.  This assumes the reader would rather have
4847 a link to a document in a different language than to have
4848 a broken link.
4849 </para>
4850
4851 </refsection>
4852 </refentry>
4853
4854 <refentry version="5.0" xml:id="insert.olink.page.number">
4855 <refmeta>
4856 <refentrytitle>insert.olink.page.number</refentrytitle>
4857 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4858 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4859 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4860 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4861 </refmeta>
4862 <refnamediv>
4863 <refname>insert.olink.page.number</refname>
4864 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
4865 </refnamediv>
4866
4867 <refsynopsisdiv>
4868 <programlisting xml:id="insert.olink.page.number.frag">
4869 &lt;xsl:param name="insert.olink.page.number"&gt;no&lt;/xsl:param&gt;
4870 </programlisting>
4871 </refsynopsisdiv>
4872
4873 <refsection><info><title>Description</title></info>
4874
4875 <para>The value of this parameter determines if
4876 cross references made between documents with
4877 <tag>olink</tag> will
4878 include page number citations.
4879 In most cases this is only applicable to references in printed output.
4880 </para>
4881 <para>The parameter has three possible values.
4882 </para>
4883 <variablelist>
4884 <varlistentry>
4885 <term>no</term>
4886 <listitem><para>No page number references will be generated for olinks.
4887 </para></listitem>
4888 </varlistentry>
4889 <varlistentry>
4890 <term>yes</term>
4891 <listitem><para>Page number references will be generated
4892 for all <tag>olink</tag> references.
4893 The style of page reference may be changed
4894 if an <tag class="attribute">xrefstyle</tag>
4895 attribute is used.
4896 </para></listitem>
4897 </varlistentry>
4898 <varlistentry>
4899 <term>maybe</term>
4900 <listitem><para>Page number references will not be generated
4901 for an <tag>olink</tag> element unless
4902 it has an
4903 <tag class="attribute">xrefstyle</tag>
4904 attribute whose value specifies a page reference.
4905 </para></listitem>
4906 </varlistentry>
4907 </variablelist>
4908 <para>Olinks that point to targets within the same document
4909 are treated as <tag>xref</tag>s, and controlled by
4910 the <parameter>insert.xref.page.number</parameter> parameter.
4911 </para>
4912
4913 <para>Page number references for olinks to
4914 external documents can only be inserted if the
4915 information exists in the olink database.
4916 This means each olink target element
4917 (<tag>div</tag> or <tag>obj</tag>)
4918 must have a <tag class="attribute">page</tag> attribute
4919 whose value is its page number in the target document.
4920 The XSL stylesheets are not able to extract that information
4921 during processing because pages have not yet been created in
4922 XSLT transformation.  Only the XSL-FO processor knows what
4923 page each element is placed on.
4924 Therefore some postprocessing must take place to populate
4925 page numbers in the olink database.
4926 </para>
4927
4928
4929
4930 </refsection>
4931 </refentry>
4932
4933 <refentry version="5.0" xml:id="insert.olink.pdf.frag">
4934 <refmeta>
4935 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
4936 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4937 </refmeta>
4938 <refnamediv>
4939 <refname>insert.olink.pdf.frag</refname>
4940 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
4941 </refnamediv>
4942
4943 <refsynopsisdiv>
4944 <programlisting xml:id="insert.olink.pdf.frag.frag">
4945 &lt;xsl:param name="insert.olink.pdf.frag" select="0"&gt;&lt;/xsl:param&gt;
4946 </programlisting>
4947 </refsynopsisdiv>
4948
4949 <refsection><info><title>Description</title></info>
4950
4951 <para>The value of this parameter determines whether
4952 the cross reference URIs to PDF documents made with
4953 <tag>olink</tag> will
4954 include fragment identifiers.
4955 </para>
4956
4957 <para>When forming a URI to link to a PDF document,
4958 a fragment identifier (typically a '#' followed by an
4959 id value) appended to the PDF filename can be used by
4960 the PDF viewer to open
4961 the PDF file to a location within the document instead of
4962 the first page.
4963 However, not all PDF files have id
4964 values embedded in them, and not all PDF viewers can
4965 handle fragment identifiers.
4966 </para>
4967
4968 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
4969 to a non-zero value, then any olink targeting a
4970 PDF file will have the fragment identifier appended to the URI.
4971 The URI is formed by concatenating the value of the
4972 <parameter>olink.base.uri</parameter> parameter, the
4973 value of the <tag class="attribute">baseuri</tag>
4974 attribute from the <tag class="element">document</tag>
4975 element in the olink database with the matching
4976 <tag class="attribute">targetdoc</tag> value,
4977 and the value of the <tag class="attribute">href</tag>
4978 attribute for the targeted element in the olink database.
4979 The <tag class="attribute">href</tag> attribute
4980 contains the fragment identifier.
4981 </para>
4982
4983 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
4984 to zero (the default value), then
4985 the <tag class="attribute">href</tag> attribute
4986 from the olink database
4987 is not appended to PDF olinks, so the fragment identifier is left off.
4988 A PDF olink is any olink for which the
4989 <tag class="attribute">baseuri</tag> attribute
4990 from the matching <tag class="element">document</tag>
4991 element in the olink database ends with '.pdf'.
4992 Any other olinks will still have the fragment identifier added.
4993 </para>
4994 </refsection>
4995 </refentry>
4996
4997 <refentry version="5.0" xml:id="prefer.internal.olink">
4998 <refmeta>
4999 <refentrytitle>prefer.internal.olink</refentrytitle>
5000 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5001 </refmeta>
5002 <refnamediv>
5003 <refname>prefer.internal.olink</refname>
5004 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
5005 </refnamediv>
5006
5007 <refsynopsisdiv>
5008 <programlisting xml:id="prefer.internal.olink.frag">
5009 &lt;xsl:param name="prefer.internal.olink" select="0"&gt;&lt;/xsl:param&gt;
5010 </programlisting>
5011 </refsynopsisdiv>
5012
5013 <refsection><info><title>Description</title></info>
5014
5015 <para>If you are re-using XML content modules in multiple documents,
5016 you may want to redirect some of your olinks.  This parameter
5017 permits you to redirect an olink to the current document.
5018 </para>
5019
5020 <para>For example: you are writing documentation for a  product,
5021 which includes 3 manuals: a little installation
5022 booklet (booklet.xml), a user
5023 guide (user.xml), and a reference manual (reference.xml).
5024 All 3 documents begin with the same introduction section (intro.xml) that
5025 contains a reference to the customization section (custom.xml) which is
5026 included in both user.xml and reference.xml documents.
5027 </para>
5028
5029 <para>How do you write the link to custom.xml in intro.xml
5030 so that it is interpreted correctly in all 3 documents?</para>
5031 <itemizedlist>
5032 <listitem><para>If you use xref, it will fail in user.xml.</para>
5033 </listitem>
5034 <listitem><para>If you use olink (pointing to reference.xml),
5035 the reference in user.xml
5036 will point to the customization section of the reference manual, while it is
5037 actually available in user.xml.</para>
5038 </listitem>
5039 </itemizedlist>
5040
5041 <para>If you set the <parameter>prefer.internal.olink</parameter>
5042 parameter to a non-zero value, then the processor will
5043 first look in the olink database
5044 for the olink's <tag>targetptr</tag> attribute value
5045 in document matching the <parameter>current.docid</parameter>
5046 parameter value.  If it isn't found there, then
5047 it tries the document in the database
5048 with the <tag>targetdoc</tag>
5049 value that matches the olink's <tag>targetdoc</tag>
5050 attribute.
5051 </para>
5052
5053 <para>This feature permits an olink reference to resolve to
5054 the current document if there is an element
5055 with an id matching the olink's <tag>targetptr</tag>
5056 value.  The current document's olink data must be
5057 included in the target database for this to work.</para>
5058
5059 <caution>
5060 <para>There is a potential for incorrect links if
5061 the same <tag>id</tag> attribute value is used for different
5062 content in different documents.
5063 Some of your olinks may be redirected to the current document
5064 when they shouldn't be.  It is not possible to control
5065 individual olink instances.</para>
5066 </caution>
5067
5068 </refsection>
5069 </refentry>
5070
5071 <refentry version="5.0" xml:id="link.mailto.url">
5072 <refmeta>
5073 <refentrytitle>link.mailto.url</refentrytitle>
5074 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5075 </refmeta>
5076 <refnamediv>
5077 <refname>link.mailto.url</refname>
5078 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
5079 </refnamediv>
5080
5081 <refsynopsisdiv>
5082 <programlisting xml:id="link.mailto.url.frag">
5083 &lt;xsl:param name="link.mailto.url"&gt;&lt;/xsl:param&gt;
5084 </programlisting>
5085 </refsynopsisdiv>
5086
5087 <refsection><info><title>Description</title></info>
5088
5089 <para>If not the empty string, this address will be used for the
5090 rel=made <literal>link</literal> element in the html <literal>head</literal>
5091 </para>
5092
5093 </refsection>
5094 </refentry>
5095
5096 <refentry version="5.0" xml:id="ulink.target">
5097 <refmeta>
5098 <refentrytitle>ulink.target</refentrytitle>
5099 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5100 </refmeta>
5101 <refnamediv>
5102 <refname>ulink.target</refname>
5103 <refpurpose>The HTML anchor target for ULinks</refpurpose>
5104 </refnamediv>
5105
5106 <refsynopsisdiv>
5107 <programlisting xml:id="ulink.target.frag">
5108 &lt;xsl:param name="ulink.target"&gt;_top&lt;/xsl:param&gt;
5109 </programlisting>
5110 </refsynopsisdiv>
5111
5112 <refsection><info><title>Description</title></info>
5113
5114 <para>If <parameter>ulink.target</parameter> is non-zero, its value will
5115 be used for the <literal>target</literal> attribute
5116 on anchors generated for <tag>ulink</tag>s.</para>
5117
5118 </refsection>
5119 </refentry>
5120
5121 <refentry version="5.0" xml:id="olink.fragid">
5122 <refmeta>
5123 <refentrytitle>olink.fragid</refentrytitle>
5124 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5125 </refmeta>
5126 <refnamediv>
5127 <refname>olink.fragid</refname>
5128 <refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose>
5129 </refnamediv>
5130 <refsynopsisdiv>
5131 <programlisting xml:id="olink.fragid.frag">
5132 &lt;xsl:param name="olink.fragid"&gt;fragid=&lt;/xsl:param&gt;
5133 </programlisting>
5134 </refsynopsisdiv>
5135 <refsection><info><title>Description</title></info>
5136 <para>The fragment identifier portion of an <tag>olink</tag> target.</para>
5137 </refsection>
5138 </refentry>
5139
5140 <refentry version="5.0" xml:id="olink.outline.ext">
5141 <refmeta>
5142 <refentrytitle>olink.outline.ext</refentrytitle>
5143 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5144 </refmeta>
5145 <refnamediv>
5146 <refname>olink.outline.ext</refname>
5147 <refpurpose>The extension of OLink outline files</refpurpose>
5148 </refnamediv>
5149
5150 <refsynopsisdiv>
5151 <programlisting xml:id="olink.outline.ext.frag">
5152 &lt;xsl:param name="olink.outline.ext"&gt;.olink&lt;/xsl:param&gt;
5153 </programlisting>
5154 </refsynopsisdiv>
5155
5156 <refsection><info><title>Description</title></info>
5157
5158 <para>The extension to be expected for  OLink outline files</para>
5159 <para>Bob has this parameter as dead. Please don't use</para>
5160
5161 </refsection>
5162 </refentry>
5163
5164 <refentry version="5.0" xml:id="olink.pubid">
5165 <refmeta>
5166 <refentrytitle>olink.pubid</refentrytitle>
5167 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5168 </refmeta>
5169 <refnamediv>
5170 <refname>olink.pubid</refname>
5171 <refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose>
5172 </refnamediv>
5173
5174 <refsynopsisdiv>
5175 <programlisting xml:id="olink.pubid.frag">
5176 &lt;xsl:param name="olink.pubid"&gt;pubid&lt;/xsl:param&gt;
5177 </programlisting>
5178 </refsynopsisdiv>
5179
5180 <refsection><info><title>Description</title></info>
5181
5182 <para/>
5183
5184 </refsection>
5185 </refentry>
5186
5187 <refentry version="5.0" xml:id="olink.sysid">
5188 <refmeta>
5189 <refentrytitle>olink.sysid</refentrytitle>
5190 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5191 </refmeta>
5192 <refnamediv>
5193 <refname>olink.sysid</refname>
5194 <refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose>
5195 </refnamediv>
5196
5197 <refsynopsisdiv>
5198 <programlisting xml:id="olink.sysid.frag">
5199 &lt;xsl:param name="olink.sysid"&gt;sysid&lt;/xsl:param&gt;
5200 </programlisting>
5201 </refsynopsisdiv>
5202
5203 <refsection><info><title>Description</title></info>
5204
5205 <para>FIXME</para>
5206
5207 </refsection>
5208 </refentry>
5209
5210 <refentry version="5.0" xml:id="olink.resolver">
5211 <refmeta>
5212 <refentrytitle>olink.resolver</refentrytitle>
5213 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5214 </refmeta>
5215 <refnamediv>
5216 <refname>olink.resolver</refname>
5217 <refpurpose>The root name of the OLink resolver (usually a script)</refpurpose>
5218 </refnamediv>
5219 <refsynopsisdiv>
5220 <programlisting xml:id="olink.resolver.frag">
5221   &lt;xsl:param name="olink.resolver"&gt;/cgi-bin/olink&lt;/xsl:param&gt;
5222 </programlisting>
5223 </refsynopsisdiv>
5224 <refsection><info><title>Description</title></info>
5225 <para>FIXME:</para>
5226 </refsection>
5227 </refentry>
5228
5229 </reference>
5230 <reference xml:id="xrefs"><title>Cross References</title>
5231 <refentry version="5.0" xml:id="collect.xref.targets">
5232 <refmeta>
5233 <refentrytitle>collect.xref.targets</refentrytitle>
5234 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5235 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5236 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5237 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
5238 </refmeta>
5239 <refnamediv>
5240 <refname>collect.xref.targets</refname>
5241 <refpurpose>Controls whether cross reference data is
5242 collected</refpurpose>
5243 </refnamediv>
5244 <refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag">
5245 &lt;xsl:param name="collect.xref.targets"&gt;no&lt;/xsl:param&gt;
5246 </programlisting>
5247 </refsynopsisdiv>
5248 <refsection><info><title>Description</title></info>
5249
5250 <para>
5251 In order to resolve olinks efficiently, the stylesheets can
5252 generate an external data file containing information about
5253 all potential cross reference endpoints in a document.
5254 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.
5255 See also <parameter>targets.filename</parameter>.
5256 </para>
5257 </refsection>
5258 </refentry>
5259
5260 <refentry version="5.0" xml:id="insert.xref.page.number">
5261 <refmeta>
5262 <refentrytitle>insert.xref.page.number</refentrytitle>
5263 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5264 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5265 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5266 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5267 </refmeta>
5268 <refnamediv>
5269 <refname>insert.xref.page.number</refname>
5270 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
5271 </refnamediv>
5272
5273 <refsynopsisdiv>
5274 <programlisting xml:id="insert.xref.page.number.frag">
5275 &lt;xsl:param name="insert.xref.page.number"&gt;no&lt;/xsl:param&gt;
5276 </programlisting>
5277 </refsynopsisdiv>
5278
5279 <refsection><info><title>Description</title></info>
5280
5281 <para>The value of this parameter determines if
5282 cross references (<tag>xref</tag>s) in
5283 printed output will
5284 include page number citations.
5285 It has three possible values.
5286 </para>
5287 <variablelist>
5288 <varlistentry>
5289 <term>no</term>
5290 <listitem><para>No page number references will be generated.
5291 </para></listitem>
5292 </varlistentry>
5293 <varlistentry>
5294 <term>yes</term>
5295 <listitem><para>Page number references will be generated
5296 for all <tag>xref</tag> elements.
5297 The style of page reference may be changed
5298 if an <tag class="attribute">xrefstyle</tag>
5299 attribute is used.
5300 </para></listitem>
5301 </varlistentry>
5302 <varlistentry>
5303 <term>maybe</term>
5304 <listitem><para>Page number references will not be generated
5305 for an <tag>xref</tag> element unless
5306 it has an
5307 <tag class="attribute">xrefstyle</tag>
5308 attribute whose value specifies a page reference.
5309 </para></listitem>
5310 </varlistentry>
5311 </variablelist>
5312
5313 </refsection>
5314 </refentry>
5315
5316 <refentry version="5.0" xml:id="use.role.as.xrefstyle">
5317 <refmeta>
5318 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
5319 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5320 </refmeta>
5321 <refnamediv>
5322 <refname>use.role.as.xrefstyle</refname>
5323 <refpurpose>Use <tag class="attribute">role</tag> attribute for
5324 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
5325 </refnamediv>
5326
5327 <refsynopsisdiv>
5328 <programlisting xml:id="use.role.as.xrefstyle.frag">
5329 &lt;xsl:param name="use.role.as.xrefstyle" select="1"&gt;&lt;/xsl:param&gt;
5330 </programlisting>
5331 </refsynopsisdiv>
5332
5333 <refsection><info><title>Description</title></info>
5334
5335 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
5336 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
5337
5338 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
5339 <tag>xref</tag> will be used to select the cross reference style.
5340 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
5341 If the <tag class="attribute">xrefstyle</tag> attribute is present,
5342 <tag class="attribute">role</tag> will be ignored, regardless of the setting
5343 of this parameter.</para>
5344
5345 </refsection>
5346
5347 <refsection><info><title>Example</title></info>
5348
5349 <para>The following small stylesheet shows how to configure the
5350 stylesheets to make use of the cross reference style:</para>
5351
5352 <programlisting>&lt;?xml version="1.0"?&gt;
5353 &lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
5354                 version="1.0"&gt;
5355
5356 &lt;xsl:import href="../xsl/html/docbook.xsl"/&gt;
5357
5358 &lt;xsl:output method="html"/&gt;
5359
5360 &lt;xsl:param name="local.l10n.xml" select="document('')"/&gt;
5361 &lt;l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"&gt;
5362   &lt;l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"&gt;
5363    &lt;l:context name="xref"&gt;
5364       &lt;l:template name="chapter" style="title" text="Chapter %n, %t"/&gt;
5365       &lt;l:template name="chapter" text="Chapter %n"/&gt;
5366     &lt;/l:context&gt;
5367   &lt;/l:l10n&gt;
5368 &lt;/l:i18n&gt;
5369
5370 &lt;/xsl:stylesheet&gt;</programlisting>
5371
5372 <para>With this stylesheet, the cross references in the following document:</para>
5373
5374 <programlisting>&lt;?xml version="1.0" encoding="utf-8"?&gt;
5375 &lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5376                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
5377 &lt;book id="book"&gt;&lt;title&gt;Book&lt;/title&gt;
5378
5379 &lt;preface&gt;
5380 &lt;title&gt;Preface&lt;/title&gt;
5381
5382 &lt;para&gt;Normal: &lt;xref linkend="ch1"/&gt;.&lt;/para&gt;
5383 &lt;para&gt;Title: &lt;xref xrefstyle="title" linkend="ch1"/&gt;.&lt;/para&gt;
5384
5385 &lt;/preface&gt;
5386
5387 &lt;chapter id="ch1"&gt;
5388 &lt;title&gt;First Chapter&lt;/title&gt;
5389
5390 &lt;para&gt;Irrelevant.&lt;/para&gt;
5391
5392 &lt;/chapter&gt;
5393 &lt;/book&gt;</programlisting>
5394
5395 <para>will appear as:</para>
5396
5397 <informalexample>
5398 <para>Normal: Chapter 1.</para>
5399 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
5400 </informalexample>
5401 </refsection>
5402
5403 </refentry>
5404
5405 <refentry version="5.0" xml:id="xref.with.number.and.title">
5406 <refmeta>
5407 <refentrytitle>xref.with.number.and.title</refentrytitle>
5408 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5409 </refmeta>
5410 <refnamediv>
5411 <refname>xref.with.number.and.title</refname>
5412 <refpurpose>Use number and title in cross references</refpurpose>
5413 </refnamediv>
5414
5415 <refsynopsisdiv>
5416 <programlisting xml:id="xref.with.number.and.title.frag">
5417 &lt;xsl:param name="xref.with.number.and.title" select="1"&gt;&lt;/xsl:param&gt;
5418 </programlisting>
5419 </refsynopsisdiv>
5420
5421 <refsection><info><title>Description</title></info>
5422
5423 <para>A cross reference may include the number (for example, the number of
5424 an example or figure) and the <tag>title</tag> which is a required child of some
5425 targets. This parameter inserts both the relevant number as well as
5426 the title into the link. </para>
5427
5428 </refsection>
5429 </refentry>
5430
5431 <refentry version="5.0" xml:id="xref.label-page.separator">
5432 <refmeta>
5433 <refentrytitle>xref.label-page.separator</refentrytitle>
5434 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5435 </refmeta>
5436 <refnamediv>
5437 <refname>xref.label-page.separator</refname>
5438 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
5439 </refnamediv>
5440
5441 <refsynopsisdiv>
5442 <programlisting xml: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>
5443 </refsynopsisdiv>
5444
5445 <refsection><info><title>Description</title></info>
5446
5447 <para>
5448 This parameter allows you to control the punctuation of certain
5449 types of generated cross reference text.
5450 When cross reference text is generated for an
5451 <tag class="element">xref</tag> or
5452 <tag class="element">olink</tag> element
5453 using an <tag class="attribute">xrefstyle</tag> attribute
5454 that makes use of the <literal>select:</literal> feature,
5455 and the selected components include both label and page
5456 but no title,
5457 then the value of this parameter is inserted between
5458 label and page number in the output.
5459 If a title is included, then other separators are used.
5460 </para>
5461
5462 </refsection>
5463 </refentry>
5464
5465 <refentry version="5.0" xml:id="xref.label-title.separator">
5466 <refmeta>
5467 <refentrytitle>xref.label-title.separator</refentrytitle>
5468 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5469 </refmeta>
5470 <refnamediv>
5471 <refname>xref.label-title.separator</refname>
5472 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
5473 </refnamediv>
5474
5475 <refsynopsisdiv>
5476 <programlisting xml:id="xref.label-title.separator.frag">&lt;xsl:param name="xref.label-title.separator"&gt;: &lt;/xsl:param&gt;</programlisting>
5477 </refsynopsisdiv>
5478
5479 <refsection><info><title>Description</title></info>
5480
5481 <para>
5482 This parameter allows you to control the punctuation of certain
5483 types of generated cross reference text.
5484 When cross reference text is generated for an
5485 <tag class="element">xref</tag> or
5486 <tag class="element">olink</tag> element
5487 using an <tag class="attribute">xrefstyle</tag> attribute
5488 that makes use of the <literal>select:</literal> feature,
5489 and the selected components include both label and title,
5490 then the value of this parameter is inserted between
5491 label and title in the output.
5492 </para>
5493
5494 </refsection>
5495 </refentry>
5496
5497 <refentry version="5.0" xml:id="xref.title-page.separator">
5498 <refmeta>
5499 <refentrytitle>xref.title-page.separator</refentrytitle>
5500 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5501 </refmeta>
5502 <refnamediv>
5503 <refname>xref.title-page.separator</refname>
5504 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
5505 </refnamediv>
5506
5507 <refsynopsisdiv>
5508 <programlisting xml: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>
5509 </refsynopsisdiv>
5510
5511 <refsection><info><title>Description</title></info>
5512
5513 <para>
5514 This parameter allows you to control the punctuation of certain
5515 types of generated cross reference text.
5516 When cross reference text is generated for an
5517 <tag class="element">xref</tag> or
5518 <tag class="element">olink</tag> element
5519 using an <tag class="attribute">xrefstyle</tag> attribute
5520 that makes use of the <literal>select:</literal> feature,
5521 and the selected components include both title and page number,
5522 then the value of this parameter is inserted between
5523 title and page number in the output.
5524 </para>
5525
5526 </refsection>
5527 </refentry>
5528
5529 </reference>
5530 <reference xml:id="lists"><title>Lists</title>
5531 <refentry version="5.0" xml:id="segmentedlist.as.table">
5532 <refmeta>
5533 <refentrytitle>segmentedlist.as.table</refentrytitle>
5534 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5535 </refmeta>
5536 <refnamediv>
5537 <refname>segmentedlist.as.table</refname>
5538 <refpurpose>Format segmented lists as tables?</refpurpose>
5539 </refnamediv>
5540
5541 <refsynopsisdiv>
5542 <programlisting xml:id="segmentedlist.as.table.frag">
5543 &lt;xsl:param name="segmentedlist.as.table" select="0"&gt;&lt;/xsl:param&gt;
5544 </programlisting>
5545 </refsynopsisdiv>
5546
5547 <refsection><info><title>Description</title></info>
5548
5549 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
5550 tables.</para>
5551
5552 </refsection>
5553 </refentry>
5554
5555 <refentry version="5.0" xml:id="variablelist.as.table">
5556 <refmeta>
5557 <refentrytitle>variablelist.as.table</refentrytitle>
5558 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5559 </refmeta>
5560 <refnamediv>
5561 <refname>variablelist.as.table</refname>
5562 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
5563 </refnamediv>
5564
5565 <refsynopsisdiv>
5566 <programlisting xml:id="variablelist.as.table.frag">
5567 &lt;xsl:param name="variablelist.as.table" select="0"&gt;&lt;/xsl:param&gt;
5568 </programlisting>
5569 </refsynopsisdiv>
5570
5571 <refsection><info><title>Description</title></info>
5572
5573 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
5574 tables. A processing instruction exists to specify a particular width for the
5575 column containing the <tag>term</tag>s:
5576 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
5577
5578 <para>You can override this setting with a processing instruction as the
5579 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
5580 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
5581 list-presentation="list"</tag>.</para>
5582
5583 <para>This parameter only applies to the HTML transformations. In the
5584 FO case, proper list markup is robust enough to handle the formatting.
5585 But see also <parameter>variablelist.as.blocks</parameter>.</para>
5586
5587 <programlisting>  &lt;variablelist&gt;
5588         &lt;?dbhtml list-presentation="table"?&gt;
5589         &lt;?dbhtml term-width="1.5in"?&gt;
5590         &lt;?dbfo list-presentation="list"?&gt;
5591         &lt;?dbfo term-width="1in"?&gt;
5592         &lt;varlistentry&gt;
5593           &lt;term&gt;list&lt;/term&gt;
5594           &lt;listitem&gt;
5595                 &lt;para&gt;
5596                   Formatted as a table even if variablelist.as.table is set to 0.
5597                 &lt;/para&gt;
5598           &lt;/listitem&gt;
5599         &lt;/varlistentry&gt;
5600   &lt;/variablelist&gt;</programlisting>
5601
5602 </refsection>
5603 </refentry>
5604
5605 <refentry version="5.0" xml:id="variablelist.term.separator">
5606 <refmeta>
5607 <refentrytitle>variablelist.term.separator</refentrytitle>
5608 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5609 </refmeta>
5610 <refnamediv>
5611 <refname>variablelist.term.separator</refname>
5612 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
5613 <tag>varlistentry</tag></refpurpose>
5614 </refnamediv>
5615
5616 <refsynopsisdiv>
5617 <programlisting xml:id="variablelist.term.separator.frag">
5618 &lt;xsl:param name="variablelist.term.separator"&gt;, &lt;/xsl:param&gt;</programlisting>
5619 </refsynopsisdiv>
5620
5621 <refsection><info><title>Description</title></info>
5622
5623 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
5624 elements, the string specified in the value of the
5625 <parameter>variablelist.term.separator</parameter> parameter is placed
5626 after each <tag>term</tag> except the last.</para>
5627
5628 <note>
5629   <para>To generate a line break between multiple <tag>term</tag>s in
5630   a <tag>varlistentry</tag>, set a non-zero value for the
5631   <parameter>variablelist.term.break.after</parameter> parameter. If
5632   you do so, you may also want to set the value of the
5633   <parameter>variablelist.term.separator</parameter> parameter to an
5634   empty string (to suppress rendering of the default comma and space
5635   after each <tag>term</tag>).</para>
5636 </note>
5637
5638 </refsection>
5639 </refentry>
5640
5641 <refentry version="5.0" xml:id="variablelist.term.break.after">
5642 <refmeta>
5643 <refentrytitle>variablelist.term.break.after</refentrytitle>
5644 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5645 </refmeta>
5646 <refnamediv>
5647 <refname>variablelist.term.break.after</refname>
5648 <refpurpose>Generate line break after each <tag>term</tag> within a
5649 multi-term <tag>varlistentry</tag>?</refpurpose>
5650 </refnamediv>
5651
5652 <refsynopsisdiv>
5653 <programlisting xml:id="variablelist.term.break.after.frag">
5654 &lt;xsl:param name="variablelist.term.break.after"&gt;0&lt;/xsl:param&gt;</programlisting>
5655 </refsynopsisdiv>
5656
5657 <refsection><info><title>Description</title></info>
5658
5659 <para>Set a non-zero value for the
5660 <parameter>variablelist.term.break.after</parameter> parameter to
5661 generate a line break between <tag>term</tag>s in a
5662 multi-term <tag>varlistentry</tag>.</para>
5663
5664 <note>
5665 <para>If you set a non-zero value for
5666 <parameter>variablelist.term.break.after</parameter>, you may also
5667 want to set the value of the
5668 <parameter>variablelist.term.separator</parameter> parameter to an
5669 empty string (to suppress rendering of the default comma and space
5670 after each <tag>term</tag>).</para>
5671 </note>
5672
5673 </refsection>
5674 </refentry>
5675
5676 </reference>
5677 <reference xml:id="biblio"><title>Bibliography</title>
5678 <refentry version="5.0" xml:id="bibliography.style">
5679 <refmeta>
5680 <refentrytitle>bibliography.style</refentrytitle>
5681 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5682 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
5683 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
5684 </refmeta>
5685 <refnamediv>
5686 <refname>bibliography.style</refname>
5687 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
5688 </refnamediv>
5689
5690 <refsynopsisdiv>
5691 <programlisting xml:id="bibliography.style.frag">
5692 &lt;xsl:param name="bibliography.style"&gt;normal&lt;/xsl:param&gt;
5693 </programlisting>
5694 </refsynopsisdiv>
5695
5696 <refsection><info><title>Description</title></info>
5697
5698 <para>Currently only <literal>normal</literal> and
5699 <literal>iso690</literal> styles are supported.</para>
5700
5701 <para>In order to use ISO690 style to the full extent you might need
5702 to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
5703 following WiKi page</link>.</para>
5704
5705 </refsection>
5706 </refentry>
5707
5708 <refentry version="5.0" xml:id="biblioentry.item.separator">
5709 <refmeta>
5710 <refentrytitle>biblioentry.item.separator</refentrytitle>
5711 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5712 </refmeta>
5713 <refnamediv>
5714 <refname>biblioentry.item.separator</refname>
5715 <refpurpose>Text to separate bibliography entries</refpurpose>
5716 </refnamediv>
5717
5718 <refsynopsisdiv>
5719 <programlisting xml:id="biblioentry.item.separator.frag">&lt;xsl:param name="biblioentry.item.separator"&gt;. &lt;/xsl:param&gt;</programlisting>
5720 </refsynopsisdiv>
5721
5722 <refsection><info><title>Description</title></info>
5723
5724 <para>Text to separate bibliography entries
5725 </para>
5726
5727 </refsection>
5728 </refentry>
5729
5730 <refentry version="5.0" xml:id="bibliography.collection">
5731 <refmeta>
5732 <refentrytitle>bibliography.collection</refentrytitle>
5733 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5734 </refmeta>
5735 <refnamediv>
5736 <refname>bibliography.collection</refname>
5737 <refpurpose>Name of the bibliography collection file</refpurpose>
5738 </refnamediv>
5739
5740 <refsynopsisdiv>
5741 <programlisting xml:id="bibliography.collection.frag">
5742 &lt;xsl:param name="bibliography.collection"&gt;http://docbook.sourceforge.net/release/bibliography/bibliography.xml&lt;/xsl:param&gt;
5743
5744 </programlisting>
5745 </refsynopsisdiv>
5746
5747 <refsection><info><title>Description</title></info>
5748
5749 <para>Maintaining bibliography entries across a set of documents is tedious, time
5750 consuming, and error prone. It makes much more sense, usually, to store all of
5751 the bibliography entries in a single place and simply <quote>extract</quote>
5752 the ones you need in each document.</para>
5753
5754 <para>That's the purpose of the
5755 <parameter>bibliography.collection</parameter> parameter. To setup a global
5756 bibliography <quote>database</quote>, follow these steps:</para>
5757
5758 <para>First, create a stand-alone bibliography document that contains all of
5759 the documents that you wish to reference. Make sure that each bibliography
5760 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
5761 has an ID.</para>
5762
5763 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
5764 like this:</para>
5765
5766 <informalexample>
5767 <programlisting>&lt;!DOCTYPE bibliography
5768   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5769   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
5770 &lt;bibliography&gt;&lt;title&gt;References&lt;/title&gt;
5771
5772 &lt;bibliomixed id="xml-rec"&gt;&lt;abbrev&gt;XML 1.0&lt;/abbrev&gt;Tim Bray,
5773 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
5774 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml"&gt;Extensible Markup
5775 Language (XML) 1.0 Second Edition&lt;/ulink&gt;&lt;/citetitle&gt;.
5776 World Wide Web Consortium, 2000.
5777 &lt;/bibliomixed&gt;
5778
5779 &lt;bibliomixed id="xml-names"&gt;&lt;abbrev&gt;Namespaces&lt;/abbrev&gt;Tim Bray,
5780 Dave Hollander,
5781 and Andrew Layman, editors.
5782 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml-names/"&gt;Namespaces in
5783 XML&lt;/ulink&gt;&lt;/citetitle&gt;.
5784 World Wide Web Consortium, 1999.
5785 &lt;/bibliomixed&gt;
5786
5787 &lt;!-- ... --&gt;
5788 &lt;/bibliography&gt;
5789 </programlisting>
5790 </informalexample>
5791
5792 <para>When you create a bibliography in your document, simply
5793 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
5794 entries for each document that you wish to cite. Make sure that these
5795 elements have the same ID as the corresponding <quote>real</quote>
5796 entry in your global bibliography.</para>
5797
5798 <para>For example:</para>
5799
5800 <informalexample>
5801 <programlisting>&lt;bibliography&gt;&lt;title&gt;Bibliography&lt;/title&gt;
5802
5803 &lt;bibliomixed id="xml-rec"/&gt;
5804 &lt;bibliomixed id="xml-names"/&gt;
5805 &lt;bibliomixed id="DKnuth86"&gt;Donald E. Knuth. &lt;citetitle&gt;Computers and
5806 Typesetting: Volume B, TeX: The Program&lt;/citetitle&gt;. Addison-Wesley,
5807 1986.  ISBN 0-201-13437-3.
5808 &lt;/bibliomixed&gt;
5809 &lt;bibliomixed id="relaxng"/&gt;
5810
5811 &lt;/bibliography&gt;</programlisting>
5812 </informalexample>
5813
5814 <para>Note that it's perfectly acceptable to mix entries from your
5815 global bibliography with <quote>normal</quote> entries. You can use
5816 <tag>xref</tag> or other elements to cross-reference your
5817 bibliography entries in exactly the same way you do now.</para>
5818
5819 <para>Finally, when you are ready to format your document, simply set the
5820 <parameter>bibliography.collection</parameter> parameter (in either a
5821 customization layer or directly through your processor's interface) to
5822 point to your global bibliography.</para>
5823
5824 <para>The stylesheets will format the bibliography in your document as if
5825 all of the entries referenced appeared there literally.</para>
5826
5827 </refsection>
5828 </refentry>
5829
5830 <refentry version="5.0" xml:id="bibliography.numbered">
5831 <refmeta>
5832 <refentrytitle>bibliography.numbered</refentrytitle>
5833 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5834 </refmeta>
5835 <refnamediv>
5836 <refname>bibliography.numbered</refname>
5837 <refpurpose>Should bibliography entries be numbered?</refpurpose>
5838 </refnamediv>
5839
5840 <refsynopsisdiv>
5841 <programlisting xml:id="bibliography.numbered.frag">
5842 &lt;xsl:param name="bibliography.numbered" select="0"&gt;&lt;/xsl:param&gt;
5843 </programlisting>
5844 </refsynopsisdiv>
5845
5846 <refsection><info><title>Description</title></info>
5847
5848 <para>If non-zero bibliography entries will be numbered</para>
5849
5850 </refsection>
5851 </refentry>
5852
5853 </reference>
5854 <reference xml:id="glossary"><title>Glossary</title>
5855 <refentry version="5.0" xml:id="glossterm.auto.link">
5856 <refmeta>
5857 <refentrytitle>glossterm.auto.link</refentrytitle>
5858 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5859 </refmeta>
5860 <refnamediv>
5861 <refname>glossterm.auto.link</refname>
5862 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
5863 </refnamediv>
5864
5865 <refsynopsisdiv>
5866 <programlisting xml:id="glossterm.auto.link.frag">
5867 &lt;xsl:param name="glossterm.auto.link" select="0"&gt;&lt;/xsl:param&gt;
5868 </programlisting>
5869 </refsynopsisdiv>
5870
5871 <refsection><info><title>Description</title></info>
5872
5873 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
5874 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
5875 will be automatically generated. This is useful when your glossterms are consistent
5876 and you don't want to add links manually.</para>
5877
5878 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
5879 that have a <tag class="attribute">linkend</tag> attribute.</para>
5880
5881 </refsection>
5882 </refentry>
5883
5884 <refentry version="5.0" xml:id="firstterm.only.link">
5885 <refmeta>
5886 <refentrytitle>firstterm.only.link</refentrytitle>
5887 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5888 </refmeta>
5889 <refnamediv>
5890 <refname>firstterm.only.link</refname>
5891 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
5892 </refnamediv>
5893
5894 <refsynopsisdiv>
5895 <programlisting xml:id="firstterm.only.link.frag">
5896 &lt;xsl:param name="firstterm.only.link" select="0"&gt;&lt;/xsl:param&gt;
5897 </programlisting>
5898 </refsynopsisdiv>
5899
5900 <refsection><info><title>Description</title></info>
5901
5902 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
5903 to the glossary. If glossary linking is not enabled, this parameter
5904 has no effect.</para>
5905
5906 </refsection>
5907 </refentry>
5908
5909 <refentry version="5.0" xml:id="glossary.collection">
5910 <refmeta>
5911 <refentrytitle>glossary.collection</refentrytitle>
5912 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5913 </refmeta>
5914 <refnamediv>
5915 <refname>glossary.collection</refname>
5916 <refpurpose>Name of the glossary collection file</refpurpose>
5917 </refnamediv>
5918
5919 <refsynopsisdiv>
5920 <programlisting xml:id="glossary.collection.frag">
5921 &lt;xsl:param name="glossary.collection"&gt;&lt;/xsl:param&gt;
5922 </programlisting>
5923 </refsynopsisdiv>
5924
5925 <refsection><info><title>Description</title></info>
5926
5927 <para>Glossaries maintained independently across a set of documents
5928 are likely to become inconsistent unless considerable effort is
5929 expended to keep them in sync. It makes much more sense, usually, to
5930 store all of the glossary entries in a single place and simply
5931 <quote>extract</quote> the ones you need in each document.</para>
5932
5933 <para>That's the purpose of the
5934 <parameter>glossary.collection</parameter> parameter. To setup a global
5935 glossary <quote>database</quote>, follow these steps:</para>
5936
5937 <refsection><info><title>Setting Up the Glossary Database</title></info>
5938
5939 <para>First, create a stand-alone glossary document that contains all of
5940 the entries that you wish to reference. Make sure that each glossary
5941 entry has an ID.</para>
5942
5943 <para>Here's an example glossary:</para>
5944
5945 <informalexample>
5946 <programlisting>
5947 &lt;?xml version="1.0" encoding="utf-8"?&gt;
5948 &lt;!DOCTYPE glossary
5949   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5950   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
5951 &lt;glossary&gt;
5952 &lt;glossaryinfo&gt;
5953 &lt;editor&gt;&lt;firstname&gt;Eric&lt;/firstname&gt;&lt;surname&gt;Raymond&lt;/surname&gt;&lt;/editor&gt;
5954 &lt;title&gt;Jargon File 4.2.3 (abridged)&lt;/title&gt;
5955 &lt;releaseinfo&gt;Just some test data&lt;/releaseinfo&gt;
5956 &lt;/glossaryinfo&gt;
5957
5958 &lt;glossdiv&gt;&lt;title&gt;0&lt;/title&gt;
5959
5960 &lt;glossentry&gt;
5961 &lt;glossterm&gt;0&lt;/glossterm&gt;
5962 &lt;glossdef&gt;
5963 &lt;para&gt;Numeric zero, as opposed to the letter `O' (the 15th letter of
5964 the English alphabet). In their unmodified forms they look a lot
5965 alike, and various kluges invented to make them visually distinct have
5966 compounded the confusion. If your zero is center-dotted and letter-O
5967 is not, or if letter-O looks almost rectangular but zero looks more
5968 like an American football stood on end (or the reverse), you're
5969 probably looking at a modern character display (though the dotted zero
5970 seems to have originated as an option on IBM 3270 controllers). If
5971 your zero is slashed but letter-O is not, you're probably looking at
5972 an old-style ASCII graphic set descended from the default typewheel on
5973 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
5974 curse this arrangement). (Interestingly, the slashed zero long
5975 predates computers; Florian Cajori's monumental "A History of
5976 Mathematical Notations" notes that it was used in the twelfth and
5977 thirteenth centuries.) If letter-O has a slash across it and the zero
5978 does not, your display is tuned for a very old convention used at IBM
5979 and a few other early mainframe makers (Scandinavians curse &lt;emphasis&gt;this&lt;/emphasis&gt;
5980 arrangement even more, because it means two of their letters collide).
5981 Some Burroughs/Unisys equipment displays a zero with a &lt;emphasis&gt;reversed&lt;/emphasis&gt;
5982 slash. Old CDC computers rendered letter O as an unbroken oval and 0
5983 as an oval broken at upper right and lower left. And yet another
5984 convention common on early line printers left zero unornamented but
5985 added a tail or hook to the letter-O so that it resembled an inverted
5986 Q or cursive capital letter-O (this was endorsed by a draft ANSI
5987 standard for how to draw ASCII characters, but the final standard
5988 changed the distinguisher to a tick-mark in the upper-left corner).
5989 Are we sufficiently confused yet?&lt;/para&gt;
5990 &lt;/glossdef&gt;
5991 &lt;/glossentry&gt;
5992
5993 &lt;glossentry&gt;
5994 &lt;glossterm&gt;1TBS&lt;/glossterm&gt;
5995 &lt;glossdef&gt;
5996 &lt;para role="accidence"&gt;
5997 &lt;phrase role="pronounce"&gt;&lt;/phrase&gt;
5998 &lt;phrase role="partsofspeach"&gt;n&lt;/phrase&gt;
5999 &lt;/para&gt;
6000 &lt;para&gt;The "One True Brace Style"&lt;/para&gt;
6001 &lt;glossseealso&gt;indent style&lt;/glossseealso&gt;
6002 &lt;/glossdef&gt;
6003 &lt;/glossentry&gt;
6004
6005 &lt;!-- ... --&gt;
6006
6007 &lt;/glossdiv&gt;
6008
6009 &lt;!-- ... --&gt;
6010
6011 &lt;/glossary&gt;</programlisting>
6012 </informalexample>
6013
6014 </refsection>
6015
6016 <refsection><info><title>Marking Up Glossary Terms</title></info>
6017
6018 <para>That takes care of the glossary database, now you have to get the entries
6019 into your document. Unlike bibliography entries, which can be empty, creating
6020 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
6021 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
6022
6023 <para>In your source document, simply use <tag>firstterm</tag> and
6024 <tag>glossterm</tag> to identify the terms you wish to have included
6025 in the glossary. The stylesheets assume that you will either set the
6026 <tag class="attribute">baseform</tag> attribute correctly, or that the
6027 content of the element exactly matches a term in your glossary.</para>
6028
6029 <para>If you're using a <parameter>glossary.collection</parameter>, don't
6030 make explicit links on the terms in your document.</para>
6031
6032 <para>So, in your document, you might write things like this:</para>
6033
6034 <informalexample>
6035 <programlisting>&lt;para&gt;This is dummy text, without any real meaning.
6036 The point is simply to reference glossary terms like &lt;glossterm&gt;0&lt;/glossterm&gt;
6037 and the &lt;firstterm baseform="1TBS"&gt;One True Brace Style (1TBS)&lt;/firstterm&gt;.
6038 The &lt;glossterm&gt;1TBS&lt;/glossterm&gt;, as you can probably imagine, is a nearly
6039 religious issue.&lt;/para&gt;</programlisting>
6040 </informalexample>
6041
6042 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
6043 only the terms marked with <tag>firstterm</tag> will be links.
6044 Otherwise, all the terms will be linked.</para>
6045
6046 </refsection>
6047
6048 <refsection><info><title>Marking Up the Glossary</title></info>
6049
6050 <para>The glossary itself has to be identified for the stylesheets. For lack
6051 of a better choice, the <tag class="attribute">role</tag> is used.
6052 To identify the glossary as the target for automatic processing, set
6053 the role to <quote><literal>auto</literal></quote>. The title of this
6054 glossary (and any other information from the <tag>glossaryinfo</tag>
6055 that's rendered by your stylesheet) will be displayed, but the entries will
6056 come from the database.
6057 </para>
6058
6059 <para>Unfortunately, the glossary can't be empty, so you must put in
6060 at least one <tag>glossentry</tag>. The content of this entry
6061 is irrelevant, it will not be rendered:</para>
6062
6063 <informalexample>
6064 <programlisting>&lt;glossary role="auto"&gt;
6065 &lt;glossentry&gt;
6066 &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
6067 &lt;glossdef&gt;
6068 &lt;para&gt;If you can see this, the document was processed incorrectly. Use
6069 the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
6070 &lt;/glossdef&gt;
6071 &lt;/glossentry&gt;
6072 &lt;/glossary&gt;</programlisting>
6073 </informalexample>
6074
6075 <para>What about glossary divisions? If your glossary database has glossary
6076 divisions <emphasis>and</emphasis> your automatic glossary contains at least
6077 one <tag>glossdiv</tag>, the automic glossary will have divisions.
6078 If the <tag>glossdiv</tag> is missing from either location, no divisions
6079 will be rendered.</para>
6080
6081 <para>Glossary entries (and divisions, if appropriate) in the glossary will
6082 occur in precisely the order they occur in your database.</para>
6083
6084 </refsection>
6085
6086 <refsection><info><title>Formatting the Document</title></info>
6087
6088 <para>Finally, when you are ready to format your document, simply set the
6089 <parameter>glossary.collection</parameter> parameter (in either a
6090 customization layer or directly through your processor's interface) to
6091 point to your global glossary.</para>
6092
6093 <para>The stylesheets will format the glossary in your document as if
6094 all of the entries implicilty referenced appeared there literally.</para>
6095 </refsection>
6096
6097 <refsection><info><title>Limitations</title></info>
6098
6099 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
6100 not supported. For example, this <emphasis>will not</emphasis> work:</para>
6101
6102 <informalexample>
6103 <programlisting>&lt;glossentry&gt;
6104 &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
6105 &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
6106 &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
6107 &lt;/glossdef&gt;
6108 &lt;/glossentry&gt;</programlisting>
6109 </informalexample>
6110
6111 <para>If you put glossary cross-references in your glossary that way,
6112 you'll get the cryptic error: <computeroutput>Warning:
6113 glossary.collection specified, but there are 0 automatic
6114 glossaries</computeroutput>.</para>
6115
6116 <para>Instead, you must do two things:</para>
6117
6118 <orderedlist>
6119 <listitem>
6120 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
6121
6122 <informalexample>
6123 <programlisting>&lt;glossentry&gt;
6124 &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
6125 &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
6126 &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
6127 &lt;/glossdef&gt;
6128 &lt;/glossentry&gt;</programlisting>
6129 </informalexample>
6130 </listitem>
6131
6132 <listitem>
6133 <para>Make sure there is at least one <tag>glossterm</tag> reference to
6134 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
6135 easiest way to do that is probably within a <tag>remark</tag> in your
6136 automatic glossary:</para>
6137
6138 <informalexample>
6139 <programlisting>&lt;glossary role="auto"&gt;
6140 &lt;remark&gt;Make sure there's a reference to &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/remark&gt;
6141 &lt;glossentry&gt;
6142 &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
6143 &lt;glossdef&gt;
6144 &lt;para&gt;If you can see this, the document was processed incorrectly. Use
6145 the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
6146 &lt;/glossdef&gt;
6147 &lt;/glossentry&gt;
6148 &lt;/glossary&gt;</programlisting>
6149 </informalexample>
6150 </listitem>
6151 </orderedlist>
6152 </refsection>
6153
6154 </refsection>
6155 </refentry>
6156
6157 <refentry version="5.0" xml:id="glossary.sort">
6158 <refmeta>
6159 <refentrytitle>glossary.sort</refentrytitle>
6160 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6161 </refmeta>
6162 <refnamediv>
6163 <refname>glossary.sort</refname>
6164 <refpurpose>Sort glossentry elements?</refpurpose>
6165 </refnamediv>
6166
6167 <refsynopsisdiv>
6168 <programlisting xml:id="glossary.sort.frag">
6169 &lt;xsl:param name="glossary.sort" select="0"&gt;&lt;/xsl:param&gt;
6170 </programlisting>
6171 </refsynopsisdiv>
6172
6173 <refsection><info><title>Description</title></info>
6174
6175 <para>If non-zero, then the glossentry elements within a
6176 glossary, glossdiv, or glosslist are sorted on the glossterm, using
6177 the current lang setting.  If zero (the default), then
6178 glossentry elements are not sorted and are presented
6179 in document order.
6180 </para>
6181
6182 </refsection>
6183 </refentry>
6184
6185 <refentry version="5.0" xml:id="glossentry.show.acronym">
6186 <refmeta>
6187 <refentrytitle>glossentry.show.acronym</refentrytitle>
6188 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6189 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
6190 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
6191 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
6192 </refmeta>
6193 <refnamediv>
6194 <refname>glossentry.show.acronym</refname>
6195 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
6196 </refnamediv>
6197
6198 <refsynopsisdiv>
6199 <programlisting xml:id="glossentry.show.acronym.frag">
6200 &lt;xsl:param name="glossentry.show.acronym"&gt;no&lt;/xsl:param&gt;
6201 </programlisting>
6202 </refsynopsisdiv>
6203
6204 <refsection><info><title>Description</title></info>
6205
6206 <para>A setting of <quote>yes</quote> means they should be displayed;
6207 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
6208 then they are shown as the primary text for the entry.</para>
6209
6210 <note>
6211 <para>This setting controls both <tag>acronym</tag> and
6212 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
6213 </note>
6214
6215 </refsection>
6216 </refentry>
6217
6218 </reference>
6219 <reference xml:id="misc"><title>Miscellaneous</title>
6220 <refentry version="5.0" xml:id="formal.procedures">
6221 <refmeta>
6222 <refentrytitle>formal.procedures</refentrytitle>
6223 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6224 </refmeta>
6225 <refnamediv>
6226 <refname>formal.procedures</refname>
6227 <refpurpose>Selects formal or informal procedures</refpurpose>
6228 </refnamediv>
6229
6230 <refsynopsisdiv>
6231 <programlisting xml:id="formal.procedures.frag">
6232 &lt;xsl:param name="formal.procedures" select="1"&gt;&lt;/xsl:param&gt;
6233 </programlisting>
6234 </refsynopsisdiv>
6235
6236 <refsection><info><title>Description</title></info>
6237
6238 <para>Formal procedures are numbered and always have a title.
6239 </para>
6240
6241 </refsection>
6242 </refentry>
6243
6244 <refentry version="5.0" xml:id="formal.title.placement">
6245 <refmeta>
6246 <refentrytitle>formal.title.placement</refentrytitle>
6247 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
6248 </refmeta>
6249 <refnamediv>
6250 <refname>formal.title.placement</refname>
6251 <refpurpose>Specifies where formal object titles should occur</refpurpose>
6252 </refnamediv>
6253
6254 <refsynopsisdiv>
6255 <programlisting xml:id="formal.title.placement.frag">
6256 &lt;xsl:param name="formal.title.placement"&gt;
6257 figure before
6258 example before
6259 equation before
6260 table before
6261 procedure before
6262 task before
6263 &lt;/xsl:param&gt;
6264 </programlisting>
6265 </refsynopsisdiv>
6266
6267 <refsection><info><title>Description</title></info>
6268
6269 <para>Specifies where formal object titles should occur. For each formal object
6270 type (<tag>figure</tag>,
6271 <tag>example</tag>,
6272 <tag>equation</tag>,
6273 <tag>table</tag>, and <tag>procedure</tag>)
6274 you can specify either the keyword
6275 <quote><literal>before</literal></quote> or
6276 <quote><literal>after</literal></quote>.</para>
6277
6278 </refsection>
6279 </refentry>
6280
6281 <refentry version="5.0" xml:id="runinhead.default.title.end.punct">
6282 <refmeta>
6283 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
6284 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6285 </refmeta>
6286 <refnamediv>
6287 <refname>runinhead.default.title.end.punct</refname>
6288 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
6289 </refnamediv>
6290
6291 <refsynopsisdiv>
6292 <programlisting xml:id="runinhead.default.title.end.punct.frag">&lt;xsl:param name="runinhead.default.title.end.punct"&gt;.&lt;/xsl:param&gt;
6293 </programlisting>
6294 </refsynopsisdiv>
6295
6296 <refsection><info><title>Description</title></info>
6297
6298 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
6299 string as the separator between the title and following text. The period is the default value.</para>
6300
6301 </refsection>
6302 </refentry>
6303
6304 <refentry version="5.0" xml:id="runinhead.title.end.punct">
6305 <refmeta>
6306 <refentrytitle>runinhead.title.end.punct</refentrytitle>
6307 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6308 </refmeta>
6309 <refnamediv>
6310 <refname>runinhead.title.end.punct</refname>
6311 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
6312 </refnamediv>
6313
6314 <refsynopsisdiv>
6315 <programlisting xml:id="runinhead.title.end.punct.frag">
6316 &lt;xsl:param name="runinhead.title.end.punct"&gt;.!?:&lt;/xsl:param&gt;
6317 </programlisting>
6318 </refsynopsisdiv>
6319
6320 <refsection><info><title>Description</title></info>
6321
6322 <para>Specify which characters are to be counted as punctuation. These
6323 characters are checked for a match with the last character of the
6324 title. If no match is found, the
6325 <parameter>runinhead.default.title.end.punct</parameter> contents are
6326 inserted. This is to avoid duplicated punctuation in the output.
6327 </para>
6328
6329 </refsection>
6330 </refentry>
6331
6332 <refentry version="5.0" xml:id="show.comments">
6333 <refmeta>
6334 <refentrytitle>show.comments</refentrytitle>
6335 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6336 </refmeta>
6337 <refnamediv>
6338 <refname>show.comments</refname>
6339 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
6340 </refnamediv>
6341
6342 <refsynopsisdiv>
6343 <programlisting xml:id="show.comments.frag">
6344 &lt;xsl:param name="show.comments" select="1"&gt;&lt;/xsl:param&gt;
6345 </programlisting>
6346 </refsynopsisdiv>
6347
6348 <refsection><info><title>Description</title></info>
6349
6350 <para>If non-zero, comments will be displayed, otherwise they
6351 are suppressed.  Comments here refers to the <tag>remark</tag> element
6352 (which was called <literal>comment</literal> prior to DocBook
6353 4.0), not XML comments (&lt;-- like this --&gt;) which are
6354 unavailable.
6355 </para>
6356
6357 </refsection>
6358 </refentry>
6359
6360 <refentry version="5.0" xml:id="show.revisionflag">
6361 <refmeta>
6362 <refentrytitle>show.revisionflag</refentrytitle>
6363 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6364 </refmeta>
6365 <refnamediv>
6366 <refname>show.revisionflag</refname>
6367 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
6368 </refnamediv>
6369
6370 <refsynopsisdiv>
6371 <programlisting xml:id="show.revisionflag.frag">
6372 &lt;xsl:param name="show.revisionflag" select="0"&gt;&lt;/xsl:param&gt;
6373 </programlisting>
6374 </refsynopsisdiv>
6375
6376 <refsection><info><title>Description</title></info>
6377
6378 <para>
6379 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
6380 may produce additional markup designed to allow a CSS stylesheet to
6381 highlight elements that have specific revisionflag settings.</para>
6382
6383 <para>The markup inserted will be usually be either a &lt;span&gt; or
6384 &lt;div&gt; with an appropriate <literal>class</literal>
6385 attribute. (The value of the class attribute will be the same as the
6386 value of the revisionflag attribute). In some contexts, for example
6387 tables, where extra markup would be structurally illegal, the class
6388 attribute will be added to the appropriate container element.</para>
6389
6390 <para>In general, the stylesheets only test for revisionflag in contexts
6391 where an importing stylesheet would have to redefine whole templates.
6392 Most of the revisionflag processing is expected to be done by another
6393 stylesheet, for example <filename>changebars.xsl</filename>.</para>
6394
6395 </refsection>
6396 </refentry>
6397
6398 <refentry version="5.0" xml:id="shade.verbatim">
6399 <refmeta>
6400 <refentrytitle>shade.verbatim</refentrytitle>
6401 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6402 </refmeta>
6403 <refnamediv>
6404 <refname>shade.verbatim</refname>
6405 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6406 </refnamediv>
6407
6408 <refsynopsisdiv>
6409 <programlisting xml:id="shade.verbatim.frag">&lt;xsl:param name="shade.verbatim" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
6410 </refsynopsisdiv>
6411
6412 <refsection><info><title>Description</title></info>
6413
6414 <para>In the FO stylesheet, if this parameter is non-zero then the
6415 <property>shade.verbatim.style</property> properties will be applied
6416 to verbatim environments.</para>
6417
6418 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6419 CSS instead.</para>
6420
6421 </refsection>
6422 </refentry>
6423
6424 <refentry version="5.0" xml:id="shade.verbatim.style">
6425 <refmeta>
6426 <refentrytitle>shade.verbatim.style</refentrytitle>
6427 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6428 </refmeta>
6429 <refnamediv>
6430 <refname>shade.verbatim.style</refname>
6431 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6432 </refnamediv>
6433
6434 <refsynopsisdiv>
6435 <programlisting xml:id="shade.verbatim.style.frag">
6436 &lt;xsl:attribute-set name="shade.verbatim.style"&gt;
6437   &lt;xsl:attribute name="border"&gt;0&lt;/xsl:attribute&gt;
6438   &lt;xsl:attribute name="bgcolor"&gt;#E0E0E0&lt;/xsl:attribute&gt;
6439 &lt;/xsl:attribute-set&gt;
6440
6441 </programlisting>
6442 </refsynopsisdiv>
6443
6444 <refsection><info><title>Description</title></info>
6445
6446 <para>Properties that specify the style of shaded verbatim listings. The
6447 parameters specified (the border and background color) are added to
6448 the styling of the xsl-fo output. A border might be specified as "thin
6449 black solid" for example. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
6450
6451 </refsection>
6452 </refentry>
6453
6454 <refentry version="5.0" xml:id="punct.honorific">
6455 <refmeta>
6456 <refentrytitle>punct.honorific</refentrytitle>
6457 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6458 </refmeta>
6459 <refnamediv>
6460 <refname>punct.honorific</refname>
6461 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
6462 </refnamediv>
6463
6464 <refsynopsisdiv>
6465 <programlisting xml:id="punct.honorific.frag">
6466 &lt;xsl:param name="punct.honorific"&gt;.&lt;/xsl:param&gt;
6467 </programlisting>
6468 </refsynopsisdiv>
6469
6470 <refsection><info><title>Description</title></info>
6471
6472 <para>This parameter specifies the punctuation that should be added after an
6473 honorific in a personal name.</para>
6474
6475 </refsection>
6476 </refentry>
6477
6478 <refentry version="5.0" xml:id="tex.math.in.alt">
6479 <refmeta>
6480 <refentrytitle>tex.math.in.alt</refentrytitle>
6481 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6482 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
6483 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
6484 </refmeta>
6485 <refnamediv>
6486 <refname>tex.math.in.alt</refname>
6487 <refpurpose>TeX notation used for equations</refpurpose>
6488 </refnamediv>
6489
6490 <refsynopsisdiv>
6491 <programlisting xml:id="tex.math.in.alt.frag">
6492 &lt;xsl:param name="tex.math.in.alt"&gt;&lt;/xsl:param&gt;
6493 </programlisting>
6494 </refsynopsisdiv>
6495
6496 <refsection><info><title>Description</title></info>
6497
6498 <para>If you want type math directly in TeX notation in equations,
6499 this parameter specifies notation used. Currently are supported two
6500 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
6501 value means that you are not using TeX math at all.</para>
6502
6503 <para>Preferred way for including TeX alternative of math is inside of
6504 <tag>textobject</tag> element. Eg.:</para>
6505
6506 <programlisting>&lt;inlineequation&gt;
6507 &lt;inlinemediaobject&gt;
6508 &lt;imageobject&gt;
6509 &lt;imagedata fileref="eq1.gif"/&gt;
6510 &lt;/imageobject&gt;
6511 &lt;textobject&gt;&lt;phrase&gt;E=mc squared&lt;/phrase&gt;&lt;/textobject&gt;
6512 &lt;textobject role="tex"&gt;&lt;phrase&gt;E=mc^2&lt;/phrase&gt;&lt;/textobject&gt;
6513 &lt;/inlinemediaobject&gt;
6514 &lt;/inlineequation&gt;</programlisting>
6515
6516 <para>If you are using <tag>graphic</tag> element, you can
6517 store TeX inside <tag>alt</tag> element:</para>
6518
6519 <programlisting>&lt;inlineequation&gt;
6520 &lt;alt role="tex"&gt;a^2+b^2=c^2&lt;/alt&gt;
6521 &lt;graphic fileref="a2b2c2.gif"/&gt;
6522 &lt;/inlineequation&gt;</programlisting>
6523
6524 <para>If you want use this feature, you should process your FO with
6525 PassiveTeX, which only supports TeX math notation. When calling
6526 stylsheet, don't forget to specify also
6527 passivetex.extensions=1.</para>
6528
6529 <para>If you want equations in HTML, just process generated file
6530 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
6531 dvi2bitmap program on result DVI file. You will get images for
6532 equations in your document.</para>
6533
6534 <warning>
6535   <para>This feature is useful for print/PDF output only if you
6536     use the obsolete and now unsupported PassiveTeX XSL-FO
6537     engine.</para>
6538 </warning>
6539
6540 </refsection>
6541
6542 <refsection><info><title>Related Parameters</title></info>
6543   <para><parameter>tex.math.delims</parameter>,
6544     <parameter>passivetex.extensions</parameter>,
6545     <parameter>tex.math.file</parameter></para>
6546 </refsection>
6547
6548 </refentry>
6549
6550 <refentry version="5.0" xml:id="tex.math.file">
6551 <refmeta>
6552 <refentrytitle>tex.math.file</refentrytitle>
6553 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6554 </refmeta>
6555 <refnamediv>
6556 <refname>tex.math.file</refname>
6557 <refpurpose>Name of temporary file for generating images from equations</refpurpose>
6558 </refnamediv>
6559
6560 <refsynopsisdiv>
6561 <programlisting xml:id="tex.math.file.frag">
6562 &lt;xsl:param name="tex.math.file"&gt;tex-math-equations.tex&lt;/xsl:param&gt;
6563 </programlisting>
6564 </refsynopsisdiv>
6565
6566 <refsection><info><title>Description</title></info>
6567
6568 <para>Name of auxiliary file for TeX equations. This file can be
6569 processed by dvi2bitmap to get bitmap versions of equations for HTML
6570 output.</para>
6571
6572 </refsection>
6573 <refsection><info><title>Related Parameters</title></info>
6574   <para><parameter>tex.math.in.alt</parameter>,
6575     <parameter>tex.math.delims</parameter>,
6576   </para>
6577 </refsection>
6578 <refsection><info><title>More information</title></info>
6579   <para>For how-to documentation on embedding TeX equations and
6580     generating output from them, see
6581     <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6582 </refsection>
6583 </refentry>
6584
6585 <refentry version="5.0" xml:id="tex.math.delims">
6586 <refmeta>
6587 <refentrytitle>tex.math.delims</refentrytitle>
6588 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6589 </refmeta>
6590 <refnamediv>
6591 <refname>tex.math.delims</refname>
6592 <refpurpose>Should equations output for processing by TeX be
6593 surrounded by math mode delimiters?</refpurpose>
6594 </refnamediv>
6595
6596 <refsynopsisdiv>
6597 <programlisting xml:id="tex.math.delims.frag">
6598 &lt;xsl:param name="tex.math.delims" select="1"&gt;&lt;/xsl:param&gt;
6599 </programlisting>
6600 </refsynopsisdiv>
6601
6602 <refsection><info><title>Description</title></info>
6603
6604 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
6605 you should set this parameter to 0.</para>
6606
6607 <warning>
6608   <para>This feature is useful for print/PDF output only if you
6609   use the obsolete and now unsupported PassiveTeX XSL-FO
6610   engine.</para>
6611 </warning>
6612
6613 </refsection>
6614 <refsection><info><title>Related Parameters</title></info>
6615   <para><parameter>tex.math.in.alt</parameter>,
6616     <parameter>passivetex.extensions</parameter></para>
6617 </refsection>
6618
6619 <refsection><info><title>See Also</title></info>
6620   <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
6621     instruction to control whether delimiters are output.</para>
6622 </refsection>
6623
6624
6625 </refentry>
6626
6627 <refentry version="5.0" xml:id="pixels.per.inch">
6628 <refmeta>
6629 <refentrytitle>pixels.per.inch</refentrytitle>
6630 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
6631 </refmeta>
6632 <refnamediv>
6633 <refname>pixels.per.inch</refname>
6634 <refpurpose>How many pixels are there per inch?</refpurpose>
6635 </refnamediv>
6636
6637 <refsynopsisdiv>
6638 <programlisting xml:id="pixels.per.inch.frag">
6639 &lt;xsl:param name="pixels.per.inch"&gt;90&lt;/xsl:param&gt;
6640 </programlisting>
6641 </refsynopsisdiv>
6642
6643 <refsection><info><title>Description</title></info>
6644
6645 <para>When lengths are converted to pixels, this value is used to
6646 determine the size of a pixel. The default value is taken from the
6647 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
6648 Recommendation</link>.
6649 </para>
6650
6651 </refsection>
6652 </refentry>
6653
6654 <refentry version="5.0" xml:id="points.per.em">
6655 <refmeta>
6656 <refentrytitle>points.per.em</refentrytitle>
6657 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
6658 </refmeta>
6659 <refnamediv>
6660 <refname>points.per.em</refname>
6661 <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
6662 </refnamediv>
6663
6664 <refsynopsisdiv>
6665 <programlisting xml:id="points.per.em.frag">
6666 &lt;xsl:param name="points.per.em"&gt;10&lt;/xsl:param&gt;
6667 </programlisting>
6668 </refsynopsisdiv>
6669
6670 <refsection><info><title>Description</title></info>
6671
6672 <para>The fixed value used for calculations based upon the size of a
6673 character. The assumption made is that ten point font is in use. This
6674 assumption may not be valid.</para>
6675
6676 </refsection>
6677 </refentry>
6678
6679 <refentry version="5.0" xml:id="use.svg">
6680 <refmeta>
6681 <refentrytitle>use.svg</refentrytitle>
6682 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6683 </refmeta>
6684 <refnamediv>
6685 <refname>use.svg</refname>
6686 <refpurpose>Allow SVG in the result tree?</refpurpose>
6687 </refnamediv>
6688
6689 <refsynopsisdiv>
6690 <programlisting xml:id="use.svg.frag">
6691 &lt;xsl:param name="use.svg" select="1"&gt;&lt;/xsl:param&gt;
6692 </programlisting>
6693 </refsynopsisdiv>
6694
6695 <refsection><info><title>Description</title></info>
6696
6697 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6698 is passed through to the result tree, so correct rendering of the resulting
6699 diagram depends on the formatter (FO processor or web browser) that is used
6700 to process the output from the stylesheet.</para>
6701
6702 </refsection>
6703 </refentry>
6704
6705 <refentry version="5.0" xml:id="menuchoice.separator">
6706 <refmeta>
6707 <refentrytitle>menuchoice.separator</refentrytitle>
6708 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6709 </refmeta>
6710 <refnamediv>
6711 <refname>menuchoice.separator</refname>
6712 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6713 other than <tag>guimenuitem</tag> and
6714 <tag>guisubmenu</tag></refpurpose>
6715 </refnamediv>
6716
6717 <refsynopsisdiv>
6718 <programlisting xml:id="menuchoice.separator.frag">
6719 &lt;xsl:param name="menuchoice.separator"&gt;+&lt;/xsl:param&gt;
6720 </programlisting>
6721 </refsynopsisdiv>
6722
6723 <refsection><info><title>Description</title></info>
6724
6725 <para>Separator used to connect items of a <tag>menuchoice</tag> other
6726 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
6727 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
6728 </para>
6729
6730 </refsection>
6731 </refentry>
6732
6733 <refentry version="5.0" xml:id="menuchoice.menu.separator">
6734 <refmeta>
6735 <refentrytitle>menuchoice.menu.separator</refentrytitle>
6736 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6737 </refmeta>
6738 <refnamediv>
6739 <refname>menuchoice.menu.separator</refname>
6740 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6741 with <tag>guimenuitem</tag> or
6742 <tag>guisubmenu</tag></refpurpose>
6743 </refnamediv>
6744
6745 <refsynopsisdiv>
6746 <programlisting xml:id="menuchoice.menu.separator.frag">
6747 &lt;xsl:param name="menuchoice.menu.separator"&gt; &#8594; &lt;/xsl:param&gt;
6748 </programlisting>
6749 </refsynopsisdiv>
6750
6751 <refsection><info><title>Description</title></info>
6752
6753 <para>Separator used to connect items of a <tag>menuchoice</tag> with
6754 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
6755 are linked with <parameter>menuchoice.separator</parameter>.
6756 </para>
6757 <para>The default value is &amp;#x2192;, which is the
6758 &amp;rarr; (right arrow) character entity.
6759 The current FOP (0.20.5) requires setting the font-family
6760 explicitly.
6761 </para>
6762 <para>The default value also includes spaces around the arrow,
6763 which will allow a line to break.  Replace the spaces with
6764 &amp;#xA0; (nonbreaking space) if you don't want those
6765 spaces to break.
6766 </para>
6767
6768 </refsection>
6769 </refentry>
6770
6771 <refentry version="5.0" xml:id="default.float.class">
6772 <refmeta>
6773 <refentrytitle>default.float.class</refentrytitle>
6774 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6775 </refmeta>
6776 <refnamediv>
6777 <refname>default.float.class</refname>
6778 <refpurpose>Specifies the default float class</refpurpose>
6779 </refnamediv>
6780
6781 <refsynopsisdiv>
6782 <programlisting xml:id="default.float.class.frag">
6783 &lt;xsl:param name="default.float.class"&gt;
6784   &lt;xsl:choose&gt;
6785     &lt;xsl:when test="contains($stylesheet.result.type,'html')"&gt;left&lt;/xsl:when&gt;
6786     &lt;xsl:otherwise&gt;before&lt;/xsl:otherwise&gt;
6787   &lt;/xsl:choose&gt;
6788 &lt;/xsl:param&gt;
6789 </programlisting>
6790 </refsynopsisdiv>
6791
6792 <refsection><info><title>Description</title></info>
6793
6794 <para>Selects the direction in which a float should be placed. for
6795 xsl-fo this is before, for html it is left. For Western texts, the
6796 before direction is the top of the page.</para>
6797
6798 </refsection>
6799 </refentry>
6800
6801 <refentry version="5.0" xml:id="footnote.number.format">
6802 <refmeta>
6803 <refentrytitle>footnote.number.format</refentrytitle>
6804 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6805 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6806 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6807 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6808 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6809 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6810 </refmeta>
6811 <refnamediv>
6812 <refname>footnote.number.format</refname>
6813 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
6814 </refnamediv>
6815
6816 <refsynopsisdiv>
6817 <programlisting xml:id="footnote.number.format.frag">
6818 &lt;xsl:param name="footnote.number.format"&gt;1&lt;/xsl:param&gt;
6819 </programlisting>
6820 </refsynopsisdiv>
6821
6822 <refsection><info><title>Description</title></info>
6823
6824 <para>The <parameter>footnote.number.format</parameter> specifies the format
6825 to use for footnote numeration (1, i, I, a, or A).</para>
6826
6827 </refsection>
6828 </refentry>
6829
6830 <refentry version="5.0" xml:id="table.footnote.number.format">
6831 <refmeta>
6832 <refentrytitle>table.footnote.number.format</refentrytitle>
6833 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6834 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6835 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6836 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6837 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6838 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6839 </refmeta>
6840 <refnamediv>
6841 <refname>table.footnote.number.format</refname>
6842 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
6843 </refnamediv>
6844
6845 <refsynopsisdiv>
6846 <programlisting xml:id="table.footnote.number.format.frag">
6847 &lt;xsl:param name="table.footnote.number.format"&gt;a&lt;/xsl:param&gt;
6848 </programlisting>
6849 </refsynopsisdiv>
6850
6851 <refsection><info><title>Description</title></info>
6852
6853 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
6854 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
6855
6856 </refsection>
6857 </refentry>
6858
6859 <refentry version="5.0" xml:id="footnote.number.symbols">
6860 <refmeta>
6861 <refentrytitle>footnote.number.symbols</refentrytitle>
6862 <refmiscinfo class="other" otherclass="datatype"/>
6863 </refmeta>
6864 <refnamediv>
6865 <refname>footnote.number.symbols</refname>
6866 <refpurpose>Special characters to use as footnote markers</refpurpose>
6867 </refnamediv>
6868
6869 <refsynopsisdiv>
6870 <programlisting xml:id="footnote.number.symbols.frag">
6871 &lt;xsl:param name="footnote.number.symbols"&gt;&lt;/xsl:param&gt;
6872 </programlisting>
6873 </refsynopsisdiv>
6874
6875 <refsection><info><title>Description</title></info>
6876
6877 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
6878 footnotes will use the characters it contains as footnote symbols. For example,
6879 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
6880 footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
6881 <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
6882 than symbols, the stylesheets will fall back to numbered footnotes using
6883 <parameter>footnote.number.format</parameter>.</para>
6884
6885 <para>The use of symbols for footnotes depends on the ability of your
6886 processor (or browser) to render the symbols you select. Not all systems are
6887 capable of displaying the full range of Unicode characters. If the quoted characters
6888 in the preceding paragraph are not displayed properly, that's a good indicator
6889 that you may have trouble using those symbols for footnotes.</para>
6890
6891 </refsection>
6892 </refentry>
6893
6894 <refentry version="5.0" xml:id="table.footnote.number.symbols">
6895 <refmeta>
6896 <refentrytitle>table.footnote.number.symbols</refentrytitle>
6897 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6898 </refmeta>
6899 <refnamediv>
6900 <refname>table.footnote.number.symbols</refname>
6901 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
6902 </refnamediv>
6903
6904 <refsynopsisdiv>
6905 <programlisting xml:id="table.footnote.number.symbols.frag">
6906 &lt;xsl:param name="table.footnote.number.symbols"&gt;&lt;/xsl:param&gt;
6907 </programlisting>
6908 </refsynopsisdiv>
6909
6910 <refsection><info><title>Description</title></info>
6911
6912 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
6913 table footnotes will use the characters it contains as footnote symbols. For example,
6914 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
6915 footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
6916 <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
6917 than symbols, the stylesheets will fall back to numbered footnotes using
6918 <parameter>table.footnote.number.format</parameter>.</para>
6919
6920 <para>The use of symbols for footnotes depends on the ability of your
6921 processor (or browser) to render the symbols you select. Not all systems are
6922 capable of displaying the full range of Unicode characters. If the quoted characters
6923 in the preceding paragraph are not displayed properly, that's a good indicator
6924 that you may have trouble using those symbols for footnotes.</para>
6925
6926 </refsection>
6927 </refentry>
6928
6929 <refentry version="5.0" xml:id="highlight.source">
6930 <refmeta>
6931 <refentrytitle>highlight.source</refentrytitle>
6932 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6933 </refmeta>
6934 <refnamediv>
6935 <refname>highlight.source</refname>
6936 <refpurpose>Should the content of <tag>programlisting</tag>
6937 be syntactically highlighted?</refpurpose>
6938 </refnamediv>
6939
6940 <refsynopsisdiv>
6941 <programlisting xml:id="highlight.source.frag">
6942 &lt;xsl:param name="highlight.source" select="0"&gt;&lt;/xsl:param&gt;
6943 </programlisting>
6944 </refsynopsisdiv>
6945
6946 <refsection><info><title>Description</title></info>
6947
6948 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
6949 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
6950 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
6951 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
6952 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
6953
6954 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
6955 downloaded separately (see below).</para>
6956
6957 <itemizedlist>
6958 <para>In order to use this extension, you must</para>
6959
6960 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
6961 from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
6962 at SourceForge.</para>
6963 </listitem>
6964 <listitem>
6965 <para>use a customization layer in which you import one of the following stylesheet modules:
6966 <itemizedlist>
6967   <listitem>
6968     <para><filename>html/highlight.xsl</filename>
6969     </para>
6970   </listitem>
6971 <listitem>
6972     <para><filename>xhtml/highlight.xsl</filename>
6973     </para>
6974   </listitem>
6975 <listitem>
6976     <para><filename>xhtml-1_1/highlight.xsl</filename>
6977     </para>
6978   </listitem>
6979 <listitem>
6980     <para><filename>fo/highlight.xsl</filename>
6981     </para>
6982 </listitem>
6983 </itemizedlist>
6984 </para>
6985 </listitem>
6986 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
6987 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
6988 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
6989 <filename>highlighting/xslthl-config.xml</filename>.</para>
6990 </listitem>
6991 </itemizedlist>
6992
6993 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
6994 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
6995
6996 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
6997
6998 <informalexample>
6999 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
7000 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
7001 -o test.html test.xml myhtml.xsl</command></para>
7002 </informalexample>
7003
7004 </refsection>
7005 </refentry>
7006
7007 <refentry version="5.0" xml:id="highlight.xslthl.config">
7008 <refmeta>
7009 <refentrytitle>highlight.xslthl.config</refentrytitle>
7010 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7011 </refmeta>
7012 <refnamediv>
7013 <refname>highlight.xslthl.config</refname>
7014 <refpurpose>Location of XSLTHL configuration file</refpurpose>
7015 </refnamediv>
7016
7017 <refsynopsisdiv>
7018 <programlisting xml:id="highlight.xslthl.config.frag">
7019 &lt;xsl:param name="highlight.xslthl.config"&gt;&lt;/xsl:param&gt;
7020 </programlisting>
7021 </refsynopsisdiv>
7022
7023 <refsection><info><title>Description</title></info>
7024
7025 <para>This location has precedence over the corresponding Java property.</para>
7026
7027 <para>Please note that usually you have to specify location as URL not
7028 just as a simple path on the local
7029 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
7030
7031
7032
7033 </refsection>
7034 </refentry>
7035
7036 <refentry version="5.0" xml:id="highlight.default.language">
7037 <refmeta>
7038 <refentrytitle>highlight.default.language</refentrytitle>
7039 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7040 </refmeta>
7041 <refnamediv>
7042 <refname>highlight.default.language</refname>
7043 <refpurpose>Default language of programlisting</refpurpose>
7044 </refnamediv>
7045
7046 <refsynopsisdiv>
7047 <programlisting xml:id="highlight.default.language.frag">
7048 &lt;xsl:param name="highlight.default.language"&gt;&lt;/xsl:param&gt;
7049 </programlisting>
7050 </refsynopsisdiv>
7051
7052 <refsection><info><title>Description</title></info>
7053
7054 <para>This language is used when there is no language attribute on programlisting.</para>
7055
7056 </refsection>
7057 </refentry>
7058
7059 <refentry version="5.0" xml:id="email.delimiters.enabled">
7060 <refmeta>
7061 <refentrytitle>email.delimiters.enabled</refentrytitle>
7062 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7063 </refmeta>
7064 <refnamediv>
7065 <refname>email.delimiters.enabled</refname>
7066 <refpurpose>Generate delimiters around email addresses?</refpurpose>
7067 </refnamediv>
7068
7069 <refsynopsisdiv>
7070 <programlisting xml:id="email.delimiters.enabled.frag">
7071 &lt;xsl:param name="email.delimiters.enabled" select="1"&gt;&lt;/xsl:param&gt;
7072 </programlisting>
7073 </refsynopsisdiv>
7074
7075 <refsection><info><title>Description</title></info>
7076
7077 <para>If non-zero, delimiters
7078
7079 <footnote><para>For delimiters, the
7080 stylesheets are currently hard-coded to output angle
7081 brackets.</para></footnote>
7082
7083 are generated around e-mail addresses
7084 (the output of the <tag>email</tag> element).</para>
7085
7086 </refsection>
7087 </refentry>
7088
7089 <refentry version="5.0" xml:id="exsl.node.set.available">
7090 <refmeta>
7091 <refentrytitle>exsl.node.set.available</refentrytitle>
7092 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7093 </refmeta>
7094 <refnamediv>
7095 <refname>exsl.node.set.available</refname>
7096 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
7097 </refnamediv>
7098
7099 <refsynopsisdiv>
7100 <programlisting xml:id="exsl.node.set.available.frag">&lt;xsl:param name="exsl.node.set.available"&gt;
7101   &lt;xsl:choose&gt;
7102     &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;
7103     &lt;xsl:otherwise&gt;0&lt;/xsl:otherwise&gt;
7104   &lt;/xsl:choose&gt;
7105 &lt;/xsl:param&gt;
7106 </programlisting>
7107 </refsynopsisdiv>
7108
7109 <refsection><info><title>Description</title></info>
7110
7111 <para>If non-zero,
7112 then the exsl:node-set() function is available to be used in
7113 the stylesheet.
7114 If zero, then the function is not available.
7115 This param automatically detects the presence of
7116 the function and does not normally need to be set manually.</para>
7117
7118 <para>This param was created to handle a long-standing
7119 bug in the Xalan processor that fails to detect the
7120 function even though it is available.</para>
7121
7122 </refsection>
7123 </refentry>
7124
7125 </reference>
7126 <reference xml:id="annos"><title>Annotations</title>
7127 <refentry version="5.0" xml:id="annotation.support">
7128 <refmeta>
7129 <refentrytitle>annotation.support</refentrytitle>
7130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7131 </refmeta>
7132 <refnamediv>
7133 <refname>annotation.support</refname>
7134 <refpurpose>Enable annotations?</refpurpose>
7135 </refnamediv>
7136
7137 <refsynopsisdiv>
7138 <programlisting xml:id="annotation.support.frag">
7139 &lt;xsl:param name="annotation.support" select="0"&gt;&lt;/xsl:param&gt;
7140 </programlisting>
7141 </refsynopsisdiv>
7142
7143 <refsection><info><title>Description</title></info>
7144
7145 <para>If non-zero, the stylesheets will attempt to support annotation
7146 elements in HTML by including some JavaScript (see
7147 <parameter>annotation.js</parameter>).</para>
7148
7149 </refsection>
7150 </refentry>
7151
7152 <refentry version="5.0" xml:id="annotation.js">
7153 <refmeta>
7154 <refentrytitle>annotation.js</refentrytitle>
7155 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7156 </refmeta>
7157 <refnamediv>
7158 <refname>annotation.js</refname>
7159 <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
7160 </refnamediv>
7161
7162 <refsynopsisdiv>
7163 <programlisting xml:id="annotation.js.frag">
7164
7165 &lt;xsl:param name="annotation.js"&gt;
7166 &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;
7167
7168 </programlisting>
7169 </refsynopsisdiv>
7170
7171 <refsection><info><title>Description</title></info>
7172
7173 <para>If <property>annotation.support</property> is enabled and the
7174 document contains <tag>annotation</tag>s, then the URIs listed
7175 in this parameter will be included. These JavaScript files are required
7176 for popup annotation support.</para>
7177
7178 </refsection>
7179 </refentry>
7180
7181 <refentry version="5.0" xml:id="annotation.css">
7182 <refmeta>
7183 <refentrytitle>annotation.css</refentrytitle>
7184 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7185 </refmeta>
7186 <refnamediv>
7187 <refname>annotation.css</refname>
7188 <refpurpose>CSS rules for annotations</refpurpose>
7189 </refnamediv>
7190
7191 <refsynopsisdiv>
7192 <programlisting xml:id="annotation.css.frag">
7193 &lt;xsl:param name="annotation.css"&gt;
7194 /* ======================================================================
7195    Annotations
7196 */
7197
7198 div.annotation-list  { visibility: hidden;
7199                      }
7200
7201 div.annotation-nocss { position: absolute;
7202                        visibility: hidden;
7203                      }
7204
7205 div.annotation-popup { position: absolute;
7206                        z-index: 4;
7207                        visibility: hidden;
7208                        padding: 0px;
7209                        margin: 2px;
7210                        border-style: solid;
7211                        border-width: 1px;
7212                        width: 200px;
7213                        background-color: white;
7214                      }
7215
7216 div.annotation-title { padding: 1px;
7217                        font-weight: bold;
7218                        border-bottom-style: solid;
7219                        border-bottom-width: 1px;
7220                        color: white;
7221                        background-color: black;
7222                      }
7223
7224 div.annotation-body  { padding: 2px;
7225                      }
7226
7227 div.annotation-body p { margin-top: 0px;
7228                         padding-top: 0px;
7229                       }
7230
7231 div.annotation-close { position: absolute;
7232                        top: 2px;
7233                        right: 2px;
7234                      }
7235 &lt;/xsl:param&gt;
7236 </programlisting>
7237 </refsynopsisdiv>
7238
7239 <refsection><info><title>Description</title></info>
7240
7241 <para>If <parameter>annotation.support</parameter> is enabled and the
7242 document contains <tag>annotation</tag>s, then the CSS in this
7243 parameter will be included in the document.</para>
7244
7245 </refsection>
7246 </refentry>
7247
7248 <refentry version="5.0" xml:id="annotation.graphic.open">
7249 <refmeta>
7250 <refentrytitle>annotation.graphic.open</refentrytitle>
7251 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7252 </refmeta>
7253 <refnamediv>
7254 <refname>annotation.graphic.open</refname>
7255 <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
7256 </refnamediv>
7257
7258 <refsynopsisdiv>
7259 <programlisting xml:id="annotation.graphic.open.frag">
7260 &lt;xsl:param name="annotation.graphic.open"&gt;http://docbook.sourceforge.net/release/images/annot-open.png&lt;/xsl:param&gt;
7261 </programlisting>
7262 </refsynopsisdiv>
7263
7264 <refsection><info><title>Description</title></info>
7265
7266 <para>This image is used inline to identify the location of
7267 annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7268
7269 </refsection>
7270 </refentry>
7271
7272 <refentry version="5.0" xml:id="annotation.graphic.close">
7273 <refmeta>
7274 <refentrytitle>annotation.graphic.close</refentrytitle>
7275 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7276 </refmeta>
7277 <refnamediv>
7278 <refname>annotation.graphic.close</refname>
7279 <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
7280 </refnamediv>
7281
7282 <refsynopsisdiv>
7283 <programlisting xml:id="annotation.graphic.close.frag">
7284 &lt;xsl:param name="annotation.graphic.close"&gt;
7285 http://docbook.sourceforge.net/release/images/annot-close.png&lt;/xsl:param&gt;
7286 </programlisting>
7287 </refsynopsisdiv>
7288
7289 <refsection><info><title>Description</title></info>
7290
7291 <para>This image is used on popup annotations as the &#8220;x&#8221; that the
7292 user can click to dismiss the popup.</para>
7293 <para>This image is used on popup annotations as the &#8220;x&#8221; that the user can
7294 click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7295
7296 </refsection>
7297 </refentry>
7298
7299 </reference>
7300 <reference xml:id="graphics"><title>Graphics</title>
7301 <refentry version="5.0" xml:id="img.src.path">
7302 <refmeta>
7303 <refentrytitle>img.src.path</refentrytitle>
7304 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7305 </refmeta>
7306 <refnamediv>
7307 <refname>img.src.path</refname>
7308 <refpurpose>Path to HTML/FO image files</refpurpose>
7309 </refnamediv>
7310
7311 <refsynopsisdiv>
7312 <programlisting xml:id="img.src.path.frag">&lt;xsl:param name="img.src.path"&gt;&lt;/xsl:param&gt;</programlisting>
7313 </refsynopsisdiv>
7314
7315 <refsection><info><title>Description</title></info>
7316
7317 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
7318 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
7319 compound path is used in the output as the value of the <tag class="attribute">src</tag>
7320 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7321 </para>
7322
7323 <para>
7324 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7325 files are created, or it could be an absolute URI.
7326 The default value is empty.
7327 Be sure to include a trailing slash if needed.
7328 </para>
7329
7330 <para>This prefix is not applied to any filerefs that start
7331 with "/" or contain "//:".
7332 </para>
7333
7334 </refsection>
7335 </refentry>
7336
7337 <refentry version="5.0" xml:id="keep.relative.image.uris">
7338 <refmeta>
7339 <refentrytitle>keep.relative.image.uris</refentrytitle>
7340 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7341 </refmeta>
7342 <refnamediv>
7343 <refname>keep.relative.image.uris</refname>
7344 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7345 </refnamediv>
7346
7347 <refsynopsisdiv>
7348 <programlisting xml:id="keep.relative.image.uris.frag">
7349 &lt;xsl:param name="keep.relative.image.uris" select="1"&gt;&lt;/xsl:param&gt;
7350
7351 </programlisting>
7352 </refsynopsisdiv>
7353
7354 <refsection><info><title>Description</title></info>
7355
7356 <para>If non-zero, relative URIs (in, for example
7357 <literal>fileref</literal> attributes) will be used in the generated
7358 output. Otherwise, the URIs will be made absolute with respect to the
7359 base URI.</para>
7360
7361 <para>Note that the stylesheets calculate (and use) the absolute form
7362 for some purposes, this only applies to the resulting output.</para>
7363
7364 </refsection>
7365 </refentry>
7366
7367 <refentry version="5.0" xml:id="graphic.default.extension">
7368 <refmeta>
7369 <refentrytitle>graphic.default.extension</refentrytitle>
7370 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7371 </refmeta>
7372 <refnamediv>
7373 <refname>graphic.default.extension</refname>
7374 <refpurpose>Default extension for graphic filenames</refpurpose>
7375 </refnamediv>
7376
7377 <refsynopsisdiv>
7378 <programlisting xml:id="graphic.default.extension.frag">&lt;xsl:param name="graphic.default.extension"&gt;&lt;/xsl:param&gt;</programlisting>
7379 </refsynopsisdiv>
7380
7381 <refsection><info><title>Description</title></info>
7382
7383 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7384 includes a reference to a filename that does not include an extension,
7385 and the <tag class="attribute">format</tag> attribute is
7386 <emphasis>unspecified</emphasis>, the default extension will be used.
7387 </para>
7388
7389 </refsection>
7390 </refentry>
7391
7392 <refentry version="5.0" xml:id="default.image.width">
7393 <refmeta>
7394 <refentrytitle>default.image.width</refentrytitle>
7395 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7396 </refmeta>
7397 <refnamediv>
7398 <refname>default.image.width</refname>
7399 <refpurpose>The default width of images</refpurpose>
7400 </refnamediv>
7401
7402 <refsynopsisdiv>
7403 <programlisting xml:id="default.image.width.frag">
7404 &lt;xsl:param name="default.image.width"&gt;&lt;/xsl:param&gt;
7405 </programlisting>
7406 </refsynopsisdiv>
7407
7408 <refsection><info><title>Description</title></info>
7409
7410 <para>If specified, this value will be used for the
7411 <tag class="attribute">width</tag> attribute on images that do not specify any
7412 <emphasis xmlns:xlink="http://www.w3.org/1999/xlink" xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
7413
7414 </refsection>
7415 </refentry>
7416
7417 <refentry version="5.0" xml:id="nominal.image.width">
7418 <refmeta>
7419 <refentrytitle>nominal.image.width</refentrytitle>
7420 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7421 </refmeta>
7422 <refnamediv>
7423 <refname>nominal.image.width</refname>
7424 <refpurpose>The nominal image width</refpurpose>
7425 </refnamediv>
7426
7427 <refsynopsisdiv>
7428 <programlisting xml:id="nominal.image.width.frag">
7429 &lt;xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"&gt;&lt;/xsl:param&gt;
7430 </programlisting>
7431 </refsynopsisdiv>
7432
7433 <refsection><info><title>Description</title></info>
7434
7435 <para>Graphic widths expressed as a percentage are problematic. In the
7436 following discussion, we speak of width and contentwidth, but
7437 the same issues apply to depth and contentdepth.</para>
7438
7439 <para>A width of 50% means "half of the available space for the image."
7440 That's fine. But note that in HTML, this is a dynamic property and
7441 the image size will vary if the browser window is resized.</para>
7442
7443 <para>A contentwidth of 50% means "half of the actual image width".
7444 But what does that mean if the stylesheets cannot assess the image's
7445 actual size? Treating this as a width of 50% is one possibility, but
7446 it produces behavior (dynamic scaling) that seems entirely out of
7447 character with the meaning.</para>
7448
7449 <para>Instead, the stylesheets define a
7450 <parameter>nominal.image.width</parameter> and convert percentages to
7451 actual values based on that nominal size.</para>
7452
7453 </refsection>
7454 </refentry>
7455
7456 <refentry version="5.0" xml:id="nominal.image.depth">
7457 <refmeta>
7458 <refentrytitle>nominal.image.depth</refentrytitle>
7459 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7460 </refmeta>
7461 <refnamediv>
7462 <refname>nominal.image.depth</refname>
7463 <refpurpose>Nominal image depth</refpurpose>
7464 </refnamediv>
7465
7466 <refsynopsisdiv>
7467 <programlisting xml:id="nominal.image.depth.frag">
7468 &lt;xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"&gt;&lt;/xsl:param&gt;
7469 </programlisting>
7470 </refsynopsisdiv>
7471
7472 <refsection><info><title>Description</title></info>
7473
7474 <para>See <parameter>nominal.image.width</parameter>.</para>
7475
7476 </refsection>
7477 </refentry>
7478
7479 <refentry version="5.0" xml:id="use.embed.for.svg">
7480 <refmeta>
7481 <refentrytitle>use.embed.for.svg</refentrytitle>
7482 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7483 </refmeta>
7484 <refnamediv>
7485 <refname>use.embed.for.svg</refname>
7486 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
7487 </refnamediv>
7488
7489 <refsynopsisdiv>
7490 <programlisting xml:id="use.embed.for.svg.frag">
7491 &lt;xsl:param name="use.embed.for.svg" select="0"&gt;&lt;/xsl:param&gt;
7492 </programlisting>
7493 </refsynopsisdiv>
7494
7495 <refsection><info><title>Description</title></info>
7496
7497 <para>If non-zero, an <tag>embed</tag> element will be created for
7498 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
7499 this parameter merely controls whether or not an additional <tag>embed</tag>
7500 is generated inside the <tag>object</tag>.</para>
7501
7502 <para>On the plus side, this may be more portable among browsers and plug-ins.
7503 On the minus side, it isn't valid HTML.</para>
7504
7505 </refsection>
7506 </refentry>
7507
7508 <refentry version="5.0" xml:id="make.graphic.viewport">
7509 <refmeta>
7510 <refentrytitle>make.graphic.viewport</refentrytitle>
7511 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7512 </refmeta>
7513 <refnamediv>
7514 <refname>make.graphic.viewport</refname>
7515 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
7516 </refnamediv>
7517
7518 <refsynopsisdiv>
7519 <programlisting xml:id="make.graphic.viewport.frag">
7520 &lt;xsl:param name="make.graphic.viewport" select="1"&gt;&lt;/xsl:param&gt;
7521 </programlisting>
7522 </refsynopsisdiv>
7523
7524 <refsection><info><title>Description</title></info>
7525
7526 <para>The HTML <tag>img</tag> element only supports the notion
7527 of content-area scaling; it doesn't support the distinction between a
7528 content-area and a viewport-area, so we have to make some compromises.</para>
7529
7530 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
7531 will be used to frame the image. This creates an effective viewport-area.
7532 </para>
7533
7534 <para>Tables and alignment don't work together, so this parameter is ignored
7535 if alignment is specified on an image.</para>
7536 </refsection>
7537 </refentry>
7538
7539 <refentry version="5.0" xml:id="preferred.mediaobject.role">
7540 <refmeta>
7541 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7542 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7543 </refmeta>
7544 <refnamediv>
7545 <refname>preferred.mediaobject.role</refname>
7546 <refpurpose>Select which mediaobject to use based on
7547 this value of an object's <tag class="attribute">role</tag> attribute.
7548 </refpurpose>
7549 </refnamediv>
7550
7551 <refsynopsisdiv>
7552 <programlisting xml:id="preferred.mediaobject.role.frag">
7553 &lt;xsl:param name="preferred.mediaobject.role"&gt;&lt;/xsl:param&gt;
7554 </programlisting>
7555 </refsynopsisdiv>
7556
7557 <refsection><info><title>Description</title></info>
7558
7559 <para>A mediaobject may contain several objects such as imageobjects.
7560 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7561 non-zero, then the <literal>role</literal> attribute on
7562 <tag>imageobject</tag>s and other objects within a
7563 <tag>mediaobject</tag> container will be used to select which object
7564 will be used.  If one of the objects has a role value that matches the
7565 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7566 has first priority for selection.  If more than one has such a role
7567 value, the first one is used.
7568 </para>
7569 <para>
7570 See the <parameter>use.role.for.mediaobject</parameter> parameter
7571 for the sequence of selection.</para>
7572 </refsection>
7573 </refentry>
7574
7575 <refentry version="5.0" xml:id="use.role.for.mediaobject">
7576 <refmeta>
7577 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7578 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7579 </refmeta>
7580 <refnamediv>
7581 <refname>use.role.for.mediaobject</refname>
7582 <refpurpose>Use <tag class="attribute">role</tag> attribute
7583 value for selecting which of several objects within a mediaobject to use.
7584 </refpurpose>
7585 </refnamediv>
7586
7587 <refsynopsisdiv>
7588 <programlisting xml:id="use.role.for.mediaobject.frag">
7589 &lt;xsl:param name="use.role.for.mediaobject" select="1"&gt;&lt;/xsl:param&gt;
7590 </programlisting>
7591 </refsynopsisdiv>
7592
7593 <refsection><info><title>Description</title></info>
7594
7595 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7596 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7597 used.
7598 </para>
7599 <para>
7600 The order of selection when then parameter is non-zero is:
7601 </para>
7602 <orderedlist>
7603 <listitem>
7604     <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7605 </listitem>
7606 <listitem>
7607 <para>Else if an object's role attribute has a value of
7608 <literal>html</literal> for HTML processing or
7609 <literal>fo</literal> for FO output, then the first
7610 of such objects is selected.
7611 </para>
7612 </listitem>
7613 <listitem>
7614 <para>Else the first suitable object is selected.</para>
7615 </listitem>
7616 </orderedlist>
7617 <para>
7618 If the value of
7619 <parameter>use.role.for.mediaobject</parameter>
7620 is zero, then role attributes are not considered
7621 and the first suitable object
7622 with or without a role value is used.
7623 </para>
7624 </refsection>
7625 </refentry>
7626
7627 <refentry version="5.0" xml:id="ignore.image.scaling">
7628 <refmeta>
7629 <refentrytitle>ignore.image.scaling</refentrytitle>
7630 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7631 </refmeta>
7632 <refnamediv>
7633 <refname>ignore.image.scaling</refname>
7634 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7635 </refnamediv>
7636
7637 <refsynopsisdiv>
7638 <programlisting xml:id="ignore.image.scaling.frag">
7639 &lt;xsl:param name="ignore.image.scaling" select="0"&gt;&lt;/xsl:param&gt;
7640 </programlisting>
7641 </refsynopsisdiv>
7642
7643 <refsection><info><title>Description</title></info>
7644
7645 <para>If non-zero, the scaling attributes on graphics and media objects are
7646 ignored.</para>
7647
7648 </refsection>
7649 </refentry>
7650
7651 </reference>
7652 <reference xml:id="chunking"><title>Chunking</title>
7653 <refentry version="5.0" xml:id="chunker.output.cdata-section-elements">
7654 <refmeta>
7655 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
7656 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7657 </refmeta>
7658 <refnamediv>
7659 <refname>chunker.output.cdata-section-elements</refname>
7660 <refpurpose>List of elements to escape with CDATA sections</refpurpose>
7661 </refnamediv>
7662 <refsynopsisdiv>
7663 <programlisting xml:id="chunker.output.cdata-section-elements.frag">
7664 &lt;xsl:param name="chunker.output.cdata-section-elements"&gt;&lt;/xsl:param&gt;
7665 </programlisting>
7666 </refsynopsisdiv>
7667 <refsection><info><title>Description</title></info>
7668 <para>This parameter specifies the list of elements that should be escaped
7669 as CDATA sections by the chunking stylesheet.  Not all processors support
7670 specification of this parameter.
7671 </para>
7672 <note>
7673 <para>This parameter is documented here, but the declaration is actually
7674 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7675 </note>
7676 </refsection>
7677 </refentry>
7678
7679 <refentry version="5.0" xml:id="chunker.output.doctype-public">
7680 <refmeta>
7681 <refentrytitle>chunker.output.doctype-public</refentrytitle>
7682 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7683 </refmeta>
7684 <refnamediv>
7685 <refname>chunker.output.doctype-public</refname>
7686 <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
7687 </refnamediv>
7688 <refsynopsisdiv>
7689 <programlisting xml:id="chunker.output.doctype-public.frag">
7690 &lt;xsl:param name="chunker.output.doctype-public"&gt;&lt;/xsl:param&gt;
7691 </programlisting>
7692 </refsynopsisdiv>
7693 <refsection><info><title>Description</title></info>
7694 <para>This parameter specifies the public identifier that should be used by
7695 the chunking stylesheet in the document type declaration of chunked pages.
7696 Not all processors support specification of
7697 this parameter.
7698 </para>
7699 <note>
7700 <para>This parameter is documented here, but the declaration is actually
7701 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7702 </note>
7703 </refsection>
7704 </refentry>
7705
7706 <refentry version="5.0" xml:id="chunker.output.doctype-system">
7707 <refmeta>
7708 <refentrytitle>chunker.output.doctype-system</refentrytitle>
7709 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7710 </refmeta>
7711 <refnamediv>
7712 <refname>chunker.output.doctype-system</refname>
7713 <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
7714 </refnamediv>
7715 <refsynopsisdiv>
7716 <programlisting xml:id="chunker.output.doctype-system.frag">
7717 &lt;xsl:param name="chunker.output.doctype-system"&gt;&lt;/xsl:param&gt;
7718 </programlisting>
7719 </refsynopsisdiv>
7720 <refsection><info><title>Description</title></info>
7721 <para>This parameter specifies the system identifier that should be used by
7722 the chunking stylesheet in the document type declaration of chunked pages.
7723 Not all processors support specification of
7724 this parameter.
7725 </para>
7726 <note>
7727 <para>This parameter is documented here, but the declaration is actually
7728 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7729 </note>
7730 </refsection>
7731 </refentry>
7732
7733 <refentry version="5.0" xml:id="chunker.output.encoding">
7734 <refmeta>
7735 <refentrytitle>chunker.output.encoding</refentrytitle>
7736 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7737 </refmeta>
7738 <refnamediv>
7739 <refname>chunker.output.encoding</refname>
7740 <refpurpose>Encoding used in generated pages</refpurpose>
7741 </refnamediv>
7742 <refsynopsisdiv>
7743 <programlisting xml:id="chunker.output.encoding.frag">
7744 &lt;xsl:param name="chunker.output.encoding"&gt;ISO-8859-1&lt;/xsl:param&gt;
7745 </programlisting>
7746 </refsynopsisdiv>
7747 <refsection><info><title>Description</title></info>
7748 <para>This parameter specifies the encoding to be used in files
7749 generated by the chunking stylesheet. Not all processors support
7750 specification of this parameter.
7751 </para>
7752 <para>This parameter used to be named <literal>default.encoding</literal>.</para>
7753 <note>
7754 <para>This parameter is documented here, but the declaration is actually
7755 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7756 </note>
7757 </refsection>
7758 </refentry>
7759
7760 <refentry version="5.0" xml:id="chunker.output.indent">
7761 <refmeta>
7762 <refentrytitle>chunker.output.indent</refentrytitle>
7763 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7764 </refmeta>
7765 <refnamediv>
7766 <refname>chunker.output.indent</refname>
7767 <refpurpose>Specification of indentation on generated pages</refpurpose>
7768 </refnamediv>
7769 <refsynopsisdiv>
7770 <programlisting xml:id="chunker.output.indent.frag">
7771 &lt;xsl:param name="chunker.output.indent"&gt;no&lt;/xsl:param&gt;
7772 </programlisting>
7773 </refsynopsisdiv>
7774 <refsection><info><title>Description</title></info>
7775 <para>This parameter specifies the value of the indent
7776 specification for generated pages. Not all processors support
7777 specification of this parameter.
7778 </para>
7779 <note>
7780 <para>This parameter is documented here, but the declaration is actually
7781 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7782 </note>
7783 </refsection>
7784 </refentry>
7785
7786 <refentry version="5.0" xml:id="chunker.output.media-type">
7787 <refmeta>
7788 <refentrytitle>chunker.output.media-type</refentrytitle>
7789 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7790 </refmeta>
7791 <refnamediv>
7792 <refname>chunker.output.media-type</refname>
7793 <refpurpose>Media type to use in generated pages</refpurpose>
7794 </refnamediv>
7795 <refsynopsisdiv>
7796 <programlisting xml:id="chunker.output.media-type.frag">
7797 &lt;xsl:param name="chunker.output.media-type"&gt;&lt;/xsl:param&gt;
7798 </programlisting>
7799 </refsynopsisdiv>
7800 <refsection><info><title>Description</title></info>
7801 <para>This parameter specifies the media type that should be used by
7802 the chunking stylesheet. Not all processors support specification of
7803 this parameter.
7804 </para>
7805 <para>This parameter specifies the media type that should be used by the
7806 chunking stylesheet. This should be one from those defined in
7807 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link>  and
7808  <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
7809 <note>
7810 <para>This parameter is documented here, but the declaration is actually
7811 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7812 <para>It must be one from html, xml or text</para>
7813 </note>
7814 </refsection>
7815 </refentry>
7816
7817 <refentry version="5.0" xml:id="chunker.output.method">
7818 <refmeta>
7819 <refentrytitle>chunker.output.method</refentrytitle>
7820 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7821 <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
7822 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
7823 </refmeta>
7824 <refnamediv>
7825 <refname>chunker.output.method</refname>
7826 <refpurpose>Method used in generated pages</refpurpose>
7827 </refnamediv>
7828 <refsynopsisdiv>
7829 <programlisting xml:id="chunker.output.method.frag">
7830 &lt;xsl:param name="chunker.output.method"&gt;html&lt;/xsl:param&gt;
7831 </programlisting>
7832 </refsynopsisdiv>
7833 <refsection><info><title>Description</title></info>
7834 <para>This parameter specifies the output method to be used in files
7835 generated by the chunking stylesheet.
7836 </para>
7837 <para>This parameter used to be named <literal>output.method</literal>.</para>
7838 <note>
7839 <para>This parameter is documented here, but the declaration is actually
7840 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7841 </note>
7842 </refsection>
7843 </refentry>
7844
7845 <refentry version="5.0" xml:id="chunker.output.omit-xml-declaration">
7846 <refmeta>
7847 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
7848 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7849 </refmeta>
7850 <refnamediv>
7851 <refname>chunker.output.omit-xml-declaration</refname>
7852 <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
7853 </refnamediv>
7854 <refsynopsisdiv>
7855 <programlisting xml:id="chunker.output.omit-xml-declaration.frag">
7856 &lt;xsl:param name="chunker.output.omit-xml-declaration"&gt;no&lt;/xsl:param&gt;
7857 </programlisting>
7858 </refsynopsisdiv>
7859 <refsection><info><title>Description</title></info>
7860 <para>This parameter specifies the value of the omit-xml-declaration
7861 specification for generated pages. Not all processors support
7862 specification of this parameter.
7863 </para>
7864 <note>
7865 <para>This parameter is documented here, but the declaration is actually
7866 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7867 </note>
7868 </refsection>
7869 </refentry>
7870
7871 <refentry version="5.0" xml:id="chunker.output.standalone">
7872 <refmeta>
7873 <refentrytitle>chunker.output.standalone</refentrytitle>
7874 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7875 </refmeta>
7876 <refnamediv>
7877 <refname>chunker.output.standalone</refname>
7878 <refpurpose>Standalone declaration for generated pages</refpurpose>
7879 </refnamediv>
7880 <refsynopsisdiv>
7881 <programlisting xml:id="chunker.output.standalone.frag">
7882 &lt;xsl:param name="chunker.output.standalone"&gt;no&lt;/xsl:param&gt;
7883 </programlisting>
7884 </refsynopsisdiv>
7885 <refsection><info><title>Description</title></info>
7886 <para>This parameter specifies the value of the standalone
7887   specification for generated pages. It must be either
7888   <literal>yes</literal> or <literal>no</literal>. Not all
7889   processors support specification of this parameter.
7890 </para>
7891 <note>
7892 <para>This parameter is documented here, but the declaration is actually
7893 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7894 </note>
7895 </refsection>
7896 </refentry>
7897
7898 <refentry version="5.0" xml:id="saxon.character.representation">
7899 <refmeta>
7900 <refentrytitle>saxon.character.representation</refentrytitle>
7901 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7902 </refmeta>
7903 <refnamediv>
7904 <refname>saxon.character.representation</refname>
7905 <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
7906 </refnamediv>
7907
7908 <refsynopsisdiv>
7909   <programlisting xml:id="saxon.character.representation.frag">&lt;xsl:param name="saxon.character.representation" select="'entity;decimal'"&gt;&lt;/xsl:param&gt;</programlisting>
7910 </refsynopsisdiv>
7911
7912 <refsection><info><title>Description</title></info>
7913
7914 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later).
7915 It sets the character representation in files generated by the chunking stylesheets.
7916 If you want to suppress entity references for characters with direct representations in
7917 <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>.
7918 </para>
7919
7920 <para> For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
7921
7922 <note>
7923 <para>This parameter is documented here, but the declaration is actually
7924 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7925 </note>
7926
7927 </refsection>
7928
7929 </refentry>
7930
7931 <refentry version="5.0" xml:id="html.ext">
7932 <refmeta>
7933 <refentrytitle>html.ext</refentrytitle>
7934 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7935 </refmeta>
7936 <refnamediv>
7937 <refname>html.ext</refname>
7938 <refpurpose>Identifies the extension of generated HTML files</refpurpose>
7939 </refnamediv>
7940
7941 <refsynopsisdiv>
7942 <programlisting xml:id="html.ext.frag">
7943 &lt;xsl:param name="html.ext"&gt;.html&lt;/xsl:param&gt;
7944 </programlisting>
7945 </refsynopsisdiv>
7946
7947 <refsection><info><title>Description</title></info>
7948
7949 <para>The extension identified by <parameter>html.ext</parameter> will
7950 be used as the filename extension for chunks created by this
7951 stylesheet. </para>
7952
7953 </refsection>
7954 </refentry>
7955
7956 <refentry version="5.0" xml:id="use.id.as.filename">
7957 <refmeta>
7958 <refentrytitle>use.id.as.filename</refentrytitle>
7959 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7960 </refmeta>
7961 <refnamediv>
7962 <refname>use.id.as.filename</refname>
7963 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
7964 </refnamediv>
7965
7966 <refsynopsisdiv>
7967 <programlisting xml:id="use.id.as.filename.frag">
7968 &lt;xsl:param name="use.id.as.filename" select="0"&gt;&lt;/xsl:param&gt;
7969 </programlisting>
7970 </refsynopsisdiv>
7971
7972 <refsection><info><title>Description</title></info>
7973
7974 <para>If <parameter>use.id.as.filename</parameter>
7975 is non-zero, the filename of chunk elements that have IDs will be
7976 derived from the ID value.
7977 </para>
7978
7979 </refsection>
7980 </refentry>
7981
7982 <refentry version="5.0" xml:id="html.extra.head.links">
7983 <refmeta>
7984 <refentrytitle>html.extra.head.links</refentrytitle>
7985 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7986 </refmeta>
7987 <refnamediv>
7988 <refname>html.extra.head.links</refname>
7989 <refpurpose>Toggle extra HTML head link information</refpurpose>
7990 </refnamediv>
7991
7992 <refsynopsisdiv>
7993 <programlisting xml:id="html.extra.head.links.frag">
7994 &lt;xsl:param name="html.extra.head.links" select="0"&gt;&lt;/xsl:param&gt;
7995 </programlisting>
7996 </refsynopsisdiv>
7997
7998 <refsection><info><title>Description</title></info>
7999
8000 <para>If non-zero, extra <tag>link</tag> elements will be
8001 generated in the <tag>head</tag> of chunked HTML files. These
8002 extra links point to chapters, appendixes, sections, etc. as supported
8003 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
8004 </para>
8005
8006 </refsection>
8007 </refentry>
8008
8009 <refentry version="5.0" xml:id="root.filename">
8010 <refmeta>
8011 <refentrytitle>root.filename</refentrytitle>
8012 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8013 </refmeta>
8014 <refnamediv>
8015 <refname>root.filename</refname>
8016 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
8017 </refnamediv>
8018
8019 <refsynopsisdiv>
8020 <programlisting xml:id="root.filename.frag">
8021 &lt;xsl:param name="root.filename"&gt;index&lt;/xsl:param&gt;
8022 </programlisting>
8023 </refsynopsisdiv>
8024
8025 <refsection><info><title>Description</title></info>
8026
8027 <para>The <parameter>root.filename</parameter> is the base filename for
8028 the chunk created for the root of each document processed.
8029 </para>
8030
8031 </refsection>
8032 </refentry>
8033
8034 <refentry version="5.0" xml:id="base.dir">
8035 <refmeta>
8036 <refentrytitle>base.dir</refentrytitle>
8037 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8038 </refmeta>
8039 <refnamediv>
8040 <refname>base.dir</refname>
8041 <refpurpose>The base directory of chunks</refpurpose>
8042 </refnamediv>
8043
8044 <refsynopsisdiv>
8045 <programlisting xml:id="base.dir.frag">
8046 &lt;xsl:param name="base.dir"&gt;&lt;/xsl:param&gt;
8047 </programlisting>
8048 </refsynopsisdiv>
8049
8050 <refsection><info><title>Description</title></info>
8051
8052 <para>If specified, the <parameter>base.dir</parameter> identifies
8053 the output directory for chunks. (If not specified, the output directory
8054 is system dependent.)</para>
8055
8056 </refsection>
8057 </refentry>
8058
8059 <refentry version="5.0" xml:id="generate.manifest">
8060   <refmeta>
8061     <refentrytitle>generate.manifest</refentrytitle>
8062     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8063   </refmeta>
8064   <refnamediv>
8065     <refname>generate.manifest</refname>
8066     <refpurpose>Generate a manifest file?</refpurpose>
8067   </refnamediv>
8068
8069   <refsynopsisdiv>
8070     <programlisting xml:id="generate.manifest.frag">&lt;xsl:param name="generate.manifest" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
8071   </refsynopsisdiv>
8072
8073   <refsection><info><title>Description</title></info>
8074
8075     <para>If non-zero, a list of HTML files generated by the
8076       stylesheet transformation is written to the file named by
8077       the <parameter>manifest</parameter> parameter.</para>
8078
8079   </refsection>
8080 </refentry>
8081
8082 <refentry version="5.0" xml:id="manifest">
8083   <refmeta>
8084     <refentrytitle>manifest</refentrytitle>
8085     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8086   </refmeta>
8087   <refnamediv>
8088     <refname>manifest</refname>
8089     <refpurpose>Name of manifest file</refpurpose>
8090   </refnamediv>
8091
8092   <refsynopsisdiv>
8093     <programlisting xml:id="manifest.frag">
8094     &lt;xsl:param name="manifest"&gt;HTML.manifest&lt;/xsl:param&gt;
8095     </programlisting>
8096   </refsynopsisdiv>
8097
8098   <refsection><info><title>Description</title></info>
8099
8100     <para>The name of the file to which a manifest is written (if the
8101       value of the <parameter>generate.manifest</parameter> parameter
8102       is non-zero).</para>
8103
8104   </refsection>
8105 </refentry>
8106
8107 <refentry version="5.0" xml:id="manifest.in.base.dir">
8108 <refmeta>
8109 <refentrytitle>manifest.in.base.dir</refentrytitle>
8110 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8111 </refmeta>
8112 <refnamediv>
8113 <refname>manifest.in.base.dir</refname>
8114 <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
8115 </refnamediv>
8116
8117 <refsynopsisdiv>
8118 <programlisting xml:id="manifest.in.base.dir.frag">
8119 &lt;xsl:param name="manifest.in.base.dir" select="0"&gt;&lt;/xsl:param&gt;
8120 </programlisting>
8121 </refsynopsisdiv>
8122
8123 <refsection><info><title>Description</title></info>
8124
8125 <para>If non-zero, the manifest file as well as project files for HTML Help and
8126 Eclipse Help are written into <parameter>base.dir</parameter> instead
8127 of the current directory.</para>
8128
8129 </refsection>
8130 </refentry>
8131
8132 <refentry version="5.0" xml:id="chunk.toc">
8133 <refmeta>
8134 <refentrytitle>chunk.toc</refentrytitle>
8135 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8136 </refmeta>
8137 <refnamediv>
8138 <refname>chunk.toc</refname>
8139 <refpurpose>An explicit TOC to be used for chunking</refpurpose>
8140 </refnamediv>
8141
8142 <refsynopsisdiv>
8143 <programlisting xml:id="chunk.toc.frag">
8144 &lt;xsl:param name="chunk.toc"&gt;&lt;/xsl:param&gt;
8145 </programlisting>
8146 </refsynopsisdiv>
8147
8148 <refsection><info><title>Description</title></info>
8149
8150 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
8151 will be used for chunking. This parameter is only used by the
8152 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
8153 from it).</para>
8154
8155 </refsection>
8156 </refentry>
8157
8158 <refentry version="5.0" xml:id="chunk.tocs.and.lots">
8159 <refmeta>
8160 <refentrytitle>chunk.tocs.and.lots</refentrytitle>
8161 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8162 </refmeta>
8163 <refnamediv>
8164 <refname>chunk.tocs.and.lots</refname>
8165 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
8166 </refnamediv>
8167
8168 <refsynopsisdiv>
8169 <programlisting xml:id="chunk.tocs.and.lots.frag">
8170 &lt;xsl:param name="chunk.tocs.and.lots" select="0"&gt;&lt;/xsl:param&gt;
8171 </programlisting>
8172 </refsynopsisdiv>
8173
8174 <refsection><info><title>Description</title></info>
8175
8176 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
8177 will be put in a separate chunk. At the moment, this chunk is not in the
8178 normal forward/backward navigation list. Instead, a new link is added to the
8179 navigation footer.</para>
8180
8181 <para>This feature is still somewhat experimental. Feedback welcome.</para>
8182
8183 </refsection>
8184 </refentry>
8185
8186 <refentry version="5.0" xml:id="chunk.separate.lots">
8187 <refmeta>
8188 <refentrytitle>chunk.separate.lots</refentrytitle>
8189 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8190 </refmeta>
8191 <refnamediv>
8192 <refname>chunk.separate.lots</refname>
8193 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
8194 </refnamediv>
8195
8196 <refsynopsisdiv>
8197 <programlisting xml:id="chunk.separate.lots.frag">
8198 &lt;xsl:param name="chunk.separate.lots" select="0"&gt;&lt;/xsl:param&gt;
8199 </programlisting>
8200 </refsynopsisdiv>
8201
8202 <refsection><info><title>Description</title></info>
8203
8204 <para>If non-zero, each of the ToC and LoTs
8205 (List of Examples, List of Figures, etc.)
8206 will be put in its own separate chunk.
8207 The title page includes generated links to each of the separate files.
8208 </para>
8209 <para>
8210 This feature depends on the
8211 <parameter>chunk.tocs.and.lots</parameter>
8212 parameter also being non-zero.
8213 </para>
8214
8215 </refsection>
8216 </refentry>
8217
8218 <refentry version="5.0" xml:id="chunk.tocs.and.lots.has.title">
8219 <refmeta>
8220 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
8221 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8222 </refmeta>
8223 <refnamediv>
8224 <refname>chunk.tocs.and.lots.has.title</refname>
8225 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
8226 </refnamediv>
8227
8228 <refsynopsisdiv>
8229 <programlisting xml:id="chunk.tocs.and.lots.has.title.frag">
8230 &lt;xsl:param name="chunk.tocs.and.lots.has.title" select="1"&gt;&lt;/xsl:param&gt;
8231 </programlisting>
8232 </refsynopsisdiv>
8233
8234 <refsection><info><title>Description</title></info>
8235
8236 <para>If non-zero title of document is shown before ToC/LoT in
8237 separate chunk.</para>
8238
8239 </refsection>
8240 </refentry>
8241
8242 <refentry version="5.0" xml:id="chunk.section.depth">
8243 <refmeta>
8244 <refentrytitle>chunk.section.depth</refentrytitle>
8245 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8246 </refmeta>
8247 <refnamediv>
8248 <refname>chunk.section.depth</refname>
8249 <refpurpose>Depth to which sections should be chunked</refpurpose>
8250 </refnamediv>
8251
8252 <refsynopsisdiv>
8253 <programlisting xml:id="chunk.section.depth.frag">
8254 &lt;xsl:param name="chunk.section.depth" select="1"&gt;&lt;/xsl:param&gt;
8255 </programlisting>
8256 </refsynopsisdiv>
8257
8258 <refsection><info><title>Description</title></info>
8259
8260 <para>This parameter sets the depth of section chunking.</para>
8261
8262 </refsection>
8263 </refentry>
8264
8265 <refentry version="5.0" xml:id="chunk.first.sections">
8266 <refmeta>
8267 <refentrytitle>chunk.first.sections</refentrytitle>
8268 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8269 </refmeta>
8270 <refnamediv>
8271 <refname>chunk.first.sections</refname>
8272 <refpurpose>Chunk the first top-level section?</refpurpose>
8273 </refnamediv>
8274
8275 <refsynopsisdiv>
8276 <programlisting xml:id="chunk.first.sections.frag">
8277 &lt;xsl:param name="chunk.first.sections" select="0"&gt;&lt;/xsl:param&gt;
8278 </programlisting>
8279 </refsynopsisdiv>
8280
8281 <refsection><info><title>Description</title></info>
8282
8283 <para>If non-zero, a chunk will be created for the first top-level
8284 <tag>sect1</tag> or <tag>section</tag> elements in
8285 each component. Otherwise, that section will be part of the chunk for
8286 its parent.
8287 </para>
8288
8289 </refsection>
8290 </refentry>
8291
8292 <refentry version="5.0" xml:id="chunk.quietly">
8293 <refmeta>
8294 <refentrytitle>chunk.quietly</refentrytitle>
8295 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8296 </refmeta>
8297 <refnamediv>
8298 <refname>chunk.quietly</refname>
8299 <refpurpose>Omit the chunked filename messages.</refpurpose>
8300 </refnamediv>
8301
8302 <refsynopsisdiv>
8303 <programlisting xml:id="chunk.quietly.frag">
8304 &lt;xsl:param name="chunk.quietly" select="0"&gt;&lt;/xsl:param&gt;
8305 </programlisting>
8306 </refsynopsisdiv>
8307
8308 <refsection><info><title>Description</title></info>
8309
8310 <para>If zero (the default), the XSL processor emits a message naming
8311 each separate chunk filename as it is being output.
8312 If nonzero, then the messages are suppressed.
8313 </para>
8314
8315 </refsection>
8316 </refentry>
8317
8318 <refentry version="5.0" xml:id="chunk.append">
8319 <refmeta>
8320 <refentrytitle>chunk.append</refentrytitle>
8321 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8322 </refmeta>
8323 <refnamediv>
8324 <refname>chunk.append</refname>
8325 <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
8326 </refnamediv>
8327
8328 <refsynopsisdiv>
8329 <programlisting xml:id="chunk.append.frag">&lt;xsl:param name="chunk.append"&gt;&lt;/xsl:param&gt;</programlisting>
8330 </refsynopsisdiv>
8331
8332 <refsection><info><title>Description</title></info>
8333
8334 <para>Specifies content to append to the end of HTML files output by
8335 the <filename>html/chunk.xsl</filename> stylesheet, after the closing
8336 <code>&lt;html&gt;</code> tag. You probably don&#8217;t want to set any value
8337 for this parameter; but if you do, the only value it should ever be
8338 set to is a newline character: <code>&amp;#x0a;</code> or
8339 <code>&amp;#10;</code></para>
8340
8341 </refsection>
8342 </refentry>
8343
8344 <refentry version="5.0" xml:id="navig.graphics">
8345 <refmeta>
8346 <refentrytitle>navig.graphics</refentrytitle>
8347 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8348 </refmeta>
8349 <refnamediv>
8350 <refname>navig.graphics</refname>
8351 <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
8352 </refnamediv>
8353
8354 <refsynopsisdiv>
8355 <programlisting xml:id="navig.graphics.frag">
8356 &lt;xsl:param name="navig.graphics" select="0"&gt;&lt;/xsl:param&gt;
8357 </programlisting>
8358 </refsynopsisdiv>
8359
8360 <refsection><info><title>Description</title></info>
8361
8362 <para>If non-zero, the navigational headers and footers in chunked
8363 HTML are presented in an alternate style that uses graphical icons for
8364 Next, Previous, Up, and Home.  Default graphics are provided in the
8365 distribution. If zero, text is used instead of graphics.
8366 </para>
8367
8368 </refsection>
8369 </refentry>
8370
8371 <refentry version="5.0" xml:id="navig.graphics.extension">
8372 <refmeta>
8373 <refentrytitle>navig.graphics.extension</refentrytitle>
8374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8375 </refmeta>
8376 <refnamediv>
8377 <refname>navig.graphics.extension</refname>
8378 <refpurpose>Extension for navigational graphics</refpurpose>
8379 </refnamediv>
8380
8381 <refsynopsisdiv>
8382 <programlisting xml:id="navig.graphics.extension.frag">
8383 &lt;xsl:param name="navig.graphics.extension"&gt;.gif&lt;/xsl:param&gt;
8384 </programlisting>
8385 </refsynopsisdiv>
8386
8387 <refsection><info><title>Description</title></info>
8388
8389 <para>Sets the filename extension to use on navigational graphics used
8390 in the headers and footers of chunked HTML.</para>
8391
8392 </refsection>
8393 </refentry>
8394
8395 <refentry version="5.0" xml:id="navig.graphics.path">
8396 <refmeta>
8397 <refentrytitle>navig.graphics.path</refentrytitle>
8398 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8399 </refmeta>
8400 <refnamediv>
8401 <refname>navig.graphics.path</refname>
8402 <refpurpose>Path to navigational graphics</refpurpose>
8403 </refnamediv>
8404
8405 <refsynopsisdiv>
8406 <programlisting xml:id="navig.graphics.path.frag">
8407 &lt;xsl:param name="navig.graphics.path"&gt;images/&lt;/xsl:param&gt;
8408 </programlisting>
8409 </refsynopsisdiv>
8410
8411 <refsection><info><title>Description</title></info>
8412
8413 <para>Sets the path, probably relative to the directory where the HTML
8414 files are created, to the navigational graphics used in the
8415 headers and footers of chunked HTML.
8416 </para>
8417
8418 </refsection>
8419 </refentry>
8420
8421 <refentry version="5.0" xml:id="navig.showtitles">
8422 <refmeta>
8423 <refentrytitle>navig.showtitles</refentrytitle>
8424 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8425 </refmeta>
8426 <refnamediv>
8427 <refname>navig.showtitles</refname>
8428 <refpurpose>Display titles in HTML headers and footers?</refpurpose>
8429 </refnamediv>
8430
8431 <refsynopsisdiv>
8432 <programlisting xml:id="navig.showtitles.frag">&lt;xsl:param name="navig.showtitles"&gt;1&lt;/xsl:param&gt;</programlisting>
8433 </refsynopsisdiv>
8434
8435 <refsection><info><title>Description</title></info>
8436
8437 <para>If non-zero,
8438 the headers and footers of chunked HTML
8439 display the titles of the next and previous chunks,
8440 along with the words 'Next' and 'Previous' (or the
8441 equivalent graphical icons if navig.graphics is true).
8442 If false (zero), then only the words 'Next' and 'Previous'
8443 (or the icons) are displayed.
8444 </para>
8445
8446 </refsection>
8447 </refentry>
8448
8449 </reference>
8450 <reference xml:id="profiling"><title>Profiling</title>
8451 <partintro xml:id="partintro">
8452 <para>The following parameters can be used for attribute-based
8453 profiling of your document. For more information about profiling, see
8454 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
8455 </partintro>
8456 <refentry version="5.0" xml:id="profile.arch">
8457 <refmeta>
8458 <refentrytitle>profile.arch</refentrytitle>
8459 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8460 </refmeta>
8461 <refnamediv>
8462 <refname>profile.arch</refname>
8463 <refpurpose>Target profile for <tag class="attribute">arch</tag>
8464 attribute</refpurpose>
8465 </refnamediv>
8466
8467 <refsynopsisdiv>
8468 <programlisting xml:id="profile.arch.frag">
8469 &lt;xsl:param name="profile.arch"&gt;&lt;/xsl:param&gt;
8470 </programlisting>
8471 </refsynopsisdiv>
8472
8473
8474 <refsection><info><title>Description</title></info>
8475
8476 <para>The value of this parameter specifies profiles which should be
8477 included in the output. You can specify multiple profiles by
8478 separating them by semicolon. You can change separator character by
8479 <parameter>profile.separator</parameter>
8480 parameter.</para>
8481
8482 <para>This parameter has effect only when you are using profiling
8483 stylesheets (<filename>profile-docbook.xsl</filename>,
8484 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8485 ones (<filename>docbook.xsl</filename>,
8486 <filename>chunk.xsl</filename>, &#8230;).</para>
8487
8488 </refsection>
8489 </refentry>
8490
8491 <refentry version="5.0" xml:id="profile.audience">
8492 <refmeta>
8493 <refentrytitle>profile.audience</refentrytitle>
8494 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8495 </refmeta>
8496 <refnamediv>
8497 <refname>profile.audience</refname>
8498 <refpurpose>Target profile for <tag class="attribute">audience</tag>
8499 attribute</refpurpose>
8500 </refnamediv>
8501
8502 <refsynopsisdiv>
8503 <programlisting xml:id="profile.audience.frag">
8504 &lt;xsl:param name="profile.audience"&gt;&lt;/xsl:param&gt;
8505 </programlisting>
8506 </refsynopsisdiv>
8507
8508 <refsection><info><title>Description</title></info>
8509
8510 <para>Value of this parameter specifies profiles which should be
8511 included in the output. You can specify multiple profiles by
8512 separating them by semicolon. You can change separator character by
8513 <parameter>profile.separator</parameter>
8514 parameter.</para>
8515
8516 <para>This parameter has effect only when you are using profiling
8517 stylesheets (<filename>profile-docbook.xsl</filename>,
8518 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8519 ones (<filename>docbook.xsl</filename>,
8520 <filename>chunk.xsl</filename>, &#8230;).</para>
8521
8522 </refsection>
8523 </refentry>
8524
8525 <refentry version="5.0" xml:id="profile.condition">
8526 <refmeta>
8527 <refentrytitle>profile.condition</refentrytitle>
8528 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8529 </refmeta>
8530 <refnamediv>
8531 <refname>profile.condition</refname>
8532 <refpurpose>Target profile for <tag class="attribute">condition</tag>
8533 attribute</refpurpose>
8534 </refnamediv>
8535
8536 <refsynopsisdiv>
8537 <programlisting xml:id="profile.condition.frag">
8538 &lt;xsl:param name="profile.condition"&gt;&lt;/xsl:param&gt;
8539 </programlisting>
8540 </refsynopsisdiv>
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" xml:id="profile.conformance">
8560 <refmeta>
8561 <refentrytitle>profile.conformance</refentrytitle>
8562 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8563 </refmeta>
8564 <refnamediv>
8565 <refname>profile.conformance</refname>
8566 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
8567 attribute</refpurpose>
8568 </refnamediv>
8569
8570 <refsynopsisdiv>
8571 <programlisting xml:id="profile.conformance.frag">
8572 &lt;xsl:param name="profile.conformance"&gt;&lt;/xsl:param&gt;
8573 </programlisting>
8574 </refsynopsisdiv>
8575
8576 <refsection><info><title>Description</title></info>
8577
8578 <para>The 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" xml:id="profile.lang">
8594 <refmeta>
8595 <refentrytitle>profile.lang</refentrytitle>
8596 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8597 </refmeta>
8598 <refnamediv>
8599 <refname>profile.lang</refname>
8600 <refpurpose>Target profile for <tag class="attribute">lang</tag>
8601 attribute</refpurpose>
8602 </refnamediv>
8603
8604 <refsynopsisdiv>
8605 <programlisting xml:id="profile.lang.frag">
8606 &lt;xsl:param name="profile.lang"&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" xml:id="profile.os">
8628 <refmeta>
8629 <refentrytitle>profile.os</refentrytitle>
8630 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8631 </refmeta>
8632 <refnamediv>
8633 <refname>profile.os</refname>
8634 <refpurpose>Target profile for <tag class="attribute">os</tag>
8635 attribute</refpurpose>
8636 </refnamediv>
8637
8638 <refsynopsisdiv>
8639 <programlisting xml:id="profile.os.frag">
8640 &lt;xsl:param name="profile.os"&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" xml:id="profile.revision">
8662 <refmeta>
8663 <refentrytitle>profile.revision</refentrytitle>
8664 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8665 </refmeta>
8666 <refnamediv>
8667 <refname>profile.revision</refname>
8668 <refpurpose>Target profile for <tag class="attribute">revision</tag>
8669 attribute</refpurpose>
8670 </refnamediv>
8671
8672 <refsynopsisdiv>
8673 <programlisting xml:id="profile.revision.frag">
8674 &lt;xsl:param name="profile.revision"&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" xml:id="profile.revisionflag">
8696 <refmeta>
8697 <refentrytitle>profile.revisionflag</refentrytitle>
8698 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8699 </refmeta>
8700 <refnamediv>
8701 <refname>profile.revisionflag</refname>
8702 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
8703 attribute</refpurpose>
8704 </refnamediv>
8705
8706 <refsynopsisdiv>
8707 <programlisting xml:id="profile.revisionflag.frag">
8708 &lt;xsl:param name="profile.revisionflag"&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" xml:id="profile.role">
8730 <refmeta>
8731 <refentrytitle>profile.role</refentrytitle>
8732 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8733 </refmeta>
8734 <refnamediv>
8735 <refname>profile.role</refname>
8736 <refpurpose>Target profile for <tag class="attribute">role</tag>
8737 attribute</refpurpose>
8738 </refnamediv>
8739
8740 <refsynopsisdiv>
8741 <programlisting xml:id="profile.role.frag">
8742 &lt;xsl:param name="profile.role"&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 <warning>
8761 <para>Note that <tag class="attribute">role</tag> is often
8762 used for other purposes than profiling. For example it is commonly
8763 used to get emphasize in bold font:</para>
8764
8765 <programlisting>&lt;emphasis role="bold"&gt;very important&lt;/emphasis&gt;</programlisting>
8766
8767 <para>If you are using <tag class="attribute">role</tag> for
8768 these purposes do not forget to add values like <literal>bold</literal> to
8769 value of this parameter. If you forgot you will get document with
8770 small pieces missing which are very hard to track.</para>
8771
8772 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
8773 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>
8774 </warning>
8775
8776 </refsection>
8777 </refentry>
8778
8779 <refentry version="5.0" xml:id="profile.security">
8780 <refmeta>
8781 <refentrytitle>profile.security</refentrytitle>
8782 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8783 </refmeta>
8784 <refnamediv>
8785 <refname>profile.security</refname>
8786 <refpurpose>Target profile for <tag class="attribute">security</tag>
8787 attribute</refpurpose>
8788 </refnamediv>
8789
8790 <refsynopsisdiv>
8791 <programlisting xml:id="profile.security.frag">
8792 &lt;xsl:param name="profile.security"&gt;&lt;/xsl:param&gt;
8793 </programlisting>
8794 </refsynopsisdiv>
8795
8796 <refsection><info><title>Description</title></info>
8797
8798 <para>The value of this parameter specifies profiles which should be
8799 included in the output. You can specify multiple profiles by
8800 separating them by semicolon. You can change separator character by
8801 <parameter>profile.separator</parameter>
8802 parameter.</para>
8803
8804 <para>This parameter has effect only when you are using profiling
8805 stylesheets (<filename>profile-docbook.xsl</filename>,
8806 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8807 ones (<filename>docbook.xsl</filename>,
8808 <filename>chunk.xsl</filename>, &#8230;).</para>
8809
8810 </refsection>
8811 </refentry>
8812
8813 <refentry version="5.0" xml:id="profile.status">
8814 <refmeta>
8815 <refentrytitle>profile.status</refentrytitle>
8816 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8817 </refmeta>
8818 <refnamediv>
8819 <refname>profile.status</refname>
8820 <refpurpose>Target profile for <tag class="attribute">status</tag>
8821 attribute</refpurpose>
8822 </refnamediv>
8823
8824 <refsynopsisdiv>
8825 <programlisting xml:id="profile.status.frag">
8826 &lt;xsl:param name="profile.status"&gt;&lt;/xsl:param&gt;
8827 </programlisting>
8828 </refsynopsisdiv>
8829
8830 <refsection><info><title>Description</title></info>
8831
8832 <para>The value of this parameter specifies profiles which should be
8833 included in the output. You can specify multiple profiles by
8834 separating them by semicolon. You can change separator character by
8835 <parameter>profile.separator</parameter>
8836 parameter.</para>
8837
8838 <para>This parameter has effect only when you are using profiling
8839 stylesheets (<filename>profile-docbook.xsl</filename>,
8840 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8841 ones (<filename>docbook.xsl</filename>,
8842 <filename>chunk.xsl</filename>, &#8230;).</para>
8843
8844 </refsection>
8845 </refentry>
8846
8847 <refentry version="5.0" xml:id="profile.userlevel">
8848 <refmeta>
8849 <refentrytitle>profile.userlevel</refentrytitle>
8850 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8851 </refmeta>
8852 <refnamediv>
8853 <refname>profile.userlevel</refname>
8854 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
8855 attribute</refpurpose>
8856 </refnamediv>
8857
8858 <refsynopsisdiv>
8859 <programlisting xml:id="profile.userlevel.frag">
8860 &lt;xsl:param name="profile.userlevel"&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" xml:id="profile.vendor">
8882 <refmeta>
8883 <refentrytitle>profile.vendor</refentrytitle>
8884 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8885 </refmeta>
8886 <refnamediv>
8887 <refname>profile.vendor</refname>
8888 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
8889 attribute</refpurpose>
8890 </refnamediv>
8891
8892 <refsynopsisdiv>
8893 <programlisting xml:id="profile.vendor.frag">
8894 &lt;xsl:param name="profile.vendor"&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" xml:id="profile.wordsize">
8916 <refmeta>
8917 <refentrytitle>profile.wordsize</refentrytitle>
8918 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8919 </refmeta>
8920 <refnamediv>
8921 <refname>profile.wordsize</refname>
8922 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
8923 attribute</refpurpose>
8924 </refnamediv>
8925
8926 <refsynopsisdiv>
8927 <programlisting xml:id="profile.wordsize.frag">
8928 &lt;xsl:param name="profile.wordsize"&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" xml:id="profile.attribute">
8950 <refmeta>
8951 <refentrytitle>profile.attribute</refentrytitle>
8952 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8953 </refmeta>
8954 <refnamediv>
8955 <refname>profile.attribute</refname>
8956 <refpurpose>Name of user-specified profiling attribute</refpurpose>
8957 </refnamediv>
8958
8959 <refsynopsisdiv>
8960 <programlisting xml:id="profile.attribute.frag">
8961 &lt;xsl:param name="profile.attribute"&gt;&lt;/xsl:param&gt;
8962 </programlisting>
8963 </refsynopsisdiv>
8964
8965 <refsection><info><title>Description</title></info>
8966
8967 <para>This parameter is used in conjuction with
8968 <parameter>profile.value</parameter>.</para>
8969
8970 <para>This parameter has effect only when you are using profiling
8971 stylesheets (<filename>profile-docbook.xsl</filename>,
8972 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
8973 ones (<filename>docbook.xsl</filename>,
8974 <filename>chunk.xsl</filename>, &#8230;).</para>
8975
8976 </refsection>
8977 </refentry>
8978
8979 <refentry version="5.0" xml:id="profile.value">
8980 <refmeta>
8981 <refentrytitle>profile.value</refentrytitle>
8982 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8983 </refmeta>
8984 <refnamediv>
8985 <refname>profile.value</refname>
8986 <refpurpose>Target profile for user-specified attribute</refpurpose>
8987 </refnamediv>
8988
8989 <refsynopsisdiv>
8990 <programlisting xml:id="profile.value.frag">
8991 &lt;xsl:param name="profile.value"&gt;&lt;/xsl:param&gt;
8992 </programlisting>
8993 </refsynopsisdiv>
8994
8995 <refsection><info><title>Description</title></info>
8996
8997 <para>When you are using this parameter you must also specify name of
8998 profiling attribute with parameter
8999 <parameter>profile.attribute</parameter>.</para>
9000
9001 <para>The value of this parameter specifies profiles which should be
9002 included in the output. You can specify multiple profiles by
9003 separating them by semicolon. You can change separator character by
9004 <parameter>profile.separator</parameter>
9005 parameter.</para>
9006
9007 <para>This parameter has effect only when you are using profiling
9008 stylesheets (<filename>profile-docbook.xsl</filename>,
9009 <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
9010 ones (<filename>docbook.xsl</filename>,
9011 <filename>chunk.xsl</filename>, &#8230;).</para>
9012
9013 </refsection>
9014 </refentry>
9015
9016 <refentry version="5.0" xml:id="profile.separator">
9017 <refmeta>
9018 <refentrytitle>profile.separator</refentrytitle>
9019 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9020 </refmeta>
9021 <refnamediv>
9022 <refname>profile.separator</refname>
9023 <refpurpose>Separator character for compound profile values</refpurpose>
9024 </refnamediv>
9025
9026 <refsynopsisdiv>
9027 <programlisting xml:id="profile.separator.frag">
9028 &lt;xsl:param name="profile.separator"&gt;;&lt;/xsl:param&gt;
9029 </programlisting>
9030 </refsynopsisdiv>
9031
9032 <refsection><info><title>Description</title></info>
9033
9034 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
9035
9036 </refsection>
9037 </refentry>
9038
9039 </reference>
9040 <reference xml:id="htmlhelp"><title>HTML Help</title>
9041 <refentry version="5.0" xml:id="htmlhelp.encoding">
9042 <refmeta>
9043 <refentrytitle>htmlhelp.encoding</refentrytitle>
9044 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9045 </refmeta>
9046 <refnamediv>
9047 <refname>htmlhelp.encoding</refname>
9048 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
9049 </refnamediv>
9050
9051 <refsynopsisdiv>
9052 <programlisting xml:id="htmlhelp.encoding.frag">
9053 &lt;xsl:param name="htmlhelp.encoding"&gt;iso-8859-1&lt;/xsl:param&gt;
9054 </programlisting>
9055 </refsynopsisdiv>
9056
9057 <refsection><info><title>Description</title></info>
9058
9059 <para>HTML Help Compiler is not UTF-8 aware, so you should always use an
9060 appropriate single-byte encoding here. Use one from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">iana</link>, the  registered charset values.</para>
9061
9062 </refsection>
9063 </refentry>
9064
9065 <refentry version="5.0" xml:id="htmlhelp.autolabel">
9066 <refmeta>
9067 <refentrytitle>htmlhelp.autolabel</refentrytitle>
9068 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9069 </refmeta>
9070 <refnamediv>
9071 <refname>htmlhelp.autolabel</refname>
9072 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
9073 </refnamediv>
9074
9075 <refsynopsisdiv>
9076 <programlisting xml:id="htmlhelp.autolabel.frag">
9077 &lt;xsl:param name="htmlhelp.autolabel" select="0"&gt;&lt;/xsl:param&gt;
9078 </programlisting>
9079 </refsynopsisdiv>
9080
9081 <refsection><info><title>Description</title></info>
9082
9083 <para>Set this to non-zero to include chapter and section numbers into ToC
9084 in the left panel.</para>
9085
9086 </refsection>
9087 </refentry>
9088
9089 <refentry version="5.0" xml:id="htmlhelp.chm">
9090 <refmeta>
9091 <refentrytitle>htmlhelp.chm</refentrytitle>
9092 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9093 </refmeta>
9094 <refnamediv>
9095 <refname>htmlhelp.chm</refname>
9096 <refpurpose>Filename of output HTML Help file.</refpurpose>
9097 </refnamediv>
9098
9099 <refsynopsisdiv>
9100 <programlisting xml:id="htmlhelp.chm.frag">
9101 &lt;xsl:param name="htmlhelp.chm"&gt;htmlhelp.chm&lt;/xsl:param&gt;
9102 </programlisting>
9103 </refsynopsisdiv>
9104
9105 <refsection><info><title>Description</title></info>
9106
9107 <para>Set the  name of resulting CHM file</para>
9108
9109 </refsection>
9110 </refentry>
9111
9112 <refentry version="5.0" xml:id="htmlhelp.default.topic">
9113 <refmeta>
9114 <refentrytitle>htmlhelp.default.topic</refentrytitle>
9115 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9116 </refmeta>
9117 <refnamediv>
9118 <refname>htmlhelp.default.topic</refname>
9119 <refpurpose>Name of file with default topic</refpurpose>
9120 </refnamediv>
9121
9122 <refsynopsisdiv>
9123 <programlisting xml:id="htmlhelp.default.topic.frag">
9124 &lt;xsl:param name="htmlhelp.default.topic"&gt;&lt;/xsl:param&gt;
9125 </programlisting>
9126 </refsynopsisdiv>
9127
9128 <refsection><info><title>Description</title></info>
9129
9130 <para>Normally first chunk of document is displayed when you open HTML
9131 Help file. If you want to display another topic, simply set its
9132 filename by this parameter.</para>
9133
9134 <para>This is useful especially if you don't generate ToC in front of
9135 your document and you also hide root element in ToC. E.g.:</para>
9136
9137 <programlisting>&lt;xsl:param name="generate.book.toc" select="0"/&gt;
9138 &lt;xsl:param name="htmlhelp.hhc.show.root" select="0"/&gt;
9139 &lt;xsl:param name="htmlhelp.default.topic"&gt;pr01.html&lt;/xsl:param&gt;
9140 </programlisting>
9141
9142 </refsection>
9143 </refentry>
9144
9145 <refentry version="5.0" xml:id="htmlhelp.display.progress">
9146 <refmeta>
9147 <refentrytitle>htmlhelp.display.progress</refentrytitle>
9148 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9149 </refmeta>
9150 <refnamediv>
9151 <refname>htmlhelp.display.progress</refname>
9152 <refpurpose>Display compile progress?</refpurpose>
9153 </refnamediv>
9154
9155 <refsynopsisdiv>
9156 <programlisting xml:id="htmlhelp.display.progress.frag">
9157 &lt;xsl:param name="htmlhelp.display.progress" select="1"&gt;&lt;/xsl:param&gt;
9158 </programlisting>
9159 </refsynopsisdiv>
9160
9161 <refsection><info><title>Description</title></info>
9162
9163 <para>Set to non-zero to to display compile progress
9164 </para>
9165
9166 </refsection>
9167 </refentry>
9168
9169 <refentry version="5.0" xml:id="htmlhelp.hhp">
9170 <refmeta>
9171 <refentrytitle>htmlhelp.hhp</refentrytitle>
9172 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9173 </refmeta>
9174 <refnamediv>
9175 <refname>htmlhelp.hhp</refname>
9176 <refpurpose>Filename of project file.</refpurpose>
9177 </refnamediv>
9178
9179 <refsynopsisdiv>
9180 <programlisting xml:id="htmlhelp.hhp.frag">
9181 &lt;xsl:param name="htmlhelp.hhp"&gt;htmlhelp.hhp&lt;/xsl:param&gt;
9182 </programlisting>
9183 </refsynopsisdiv>
9184
9185 <refsection><info><title>Description</title></info>
9186
9187 <para>Change this parameter if you want different name of project
9188 file than htmlhelp.hhp.</para>
9189
9190 </refsection>
9191 </refentry>
9192
9193 <refentry version="5.0" xml:id="htmlhelp.hhc">
9194 <refmeta>
9195 <refentrytitle>htmlhelp.hhc</refentrytitle>
9196 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9197 </refmeta>
9198 <refnamediv>
9199 <refname>htmlhelp.hhc</refname>
9200 <refpurpose>Filename of TOC file.</refpurpose>
9201 </refnamediv>
9202
9203 <refsynopsisdiv>
9204 <programlisting xml:id="htmlhelp.hhc.frag">
9205 &lt;xsl:param name="htmlhelp.hhc"&gt;toc.hhc&lt;/xsl:param&gt;
9206 </programlisting>
9207 </refsynopsisdiv>
9208
9209 <refsection><info><title>Description</title></info>
9210
9211 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
9212
9213 </refsection>
9214 </refentry>
9215
9216 <refentry version="5.0" xml:id="htmlhelp.hhk">
9217 <refmeta>
9218 <refentrytitle>htmlhelp.hhk</refentrytitle>
9219 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9220 </refmeta>
9221 <refnamediv>
9222 <refname>htmlhelp.hhk</refname>
9223 <refpurpose>Filename of index file.</refpurpose>
9224 </refnamediv>
9225
9226 <refsynopsisdiv>
9227 <programlisting xml:id="htmlhelp.hhk.frag">
9228 &lt;xsl:param name="htmlhelp.hhk"&gt;index.hhk&lt;/xsl:param&gt;
9229 </programlisting>
9230 </refsynopsisdiv>
9231
9232 <refsection><info><title>Description</title></info>
9233
9234 <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
9235
9236 </refsection>
9237 </refentry>
9238
9239 <refentry version="5.0" xml:id="htmlhelp.hhp.tail">
9240 <refmeta>
9241 <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
9242 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9243 </refmeta>
9244 <refnamediv>
9245 <refname>htmlhelp.hhp.tail</refname>
9246 <refpurpose>Additional content for project file.</refpurpose>
9247 </refnamediv>
9248
9249 <refsynopsisdiv>
9250 <programlisting xml:id="htmlhelp.hhp.tail.frag">
9251 &lt;xsl:param name="htmlhelp.hhp.tail"&gt;&lt;/xsl:param&gt;
9252 </programlisting>
9253 </refsynopsisdiv>
9254
9255 <refsection><info><title>Description</title></info>
9256
9257 <para>If you want to include some additional parameters into project file,
9258 store appropriate part of project file into this parameter.</para>
9259
9260 </refsection>
9261 </refentry>
9262
9263 <refentry version="5.0" xml:id="htmlhelp.hhp.window">
9264 <refmeta>
9265 <refentrytitle>htmlhelp.hhp.window</refentrytitle>
9266 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9267 </refmeta>
9268 <refnamediv>
9269 <refname>htmlhelp.hhp.window</refname>
9270 <refpurpose>Name of default window.</refpurpose>
9271 </refnamediv>
9272
9273 <refsynopsisdiv>
9274 <programlisting xml:id="htmlhelp.hhp.window.frag">
9275 &lt;xsl:param name="htmlhelp.hhp.window"&gt;Main&lt;/xsl:param&gt;
9276 </programlisting>
9277 </refsynopsisdiv>
9278
9279 <refsection><info><title>Description</title></info>
9280
9281 <para>Name of default window. If empty no [WINDOWS] section will be
9282 added to project file.</para>
9283
9284 </refsection>
9285 </refentry>
9286
9287 <refentry version="5.0" xml:id="htmlhelp.hhp.windows">
9288 <refmeta>
9289 <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
9290 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9291 </refmeta>
9292 <refnamediv>
9293 <refname>htmlhelp.hhp.windows</refname>
9294 <refpurpose>Definition of additional windows</refpurpose>
9295 </refnamediv>
9296
9297 <refsynopsisdiv>
9298 <programlisting xml:id="htmlhelp.hhp.windows.frag">
9299 &lt;xsl:param name="htmlhelp.hhp.windows"&gt;&lt;/xsl:param&gt;
9300 </programlisting>
9301 </refsynopsisdiv>
9302
9303 <refsection><info><title>Description</title></info>
9304
9305 <para>Content of this parameter is placed at the end of [WINDOWS]
9306 section of project file. You can use it for defining your own
9307 addtional windows.</para>
9308
9309 </refsection>
9310 </refentry>
9311
9312 <refentry version="5.0" xml:id="htmlhelp.enhanced.decompilation">
9313 <refmeta>
9314 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
9315 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9316 </refmeta>
9317 <refnamediv>
9318 <refname>htmlhelp.enhanced.decompilation</refname>
9319 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
9320 </refnamediv>
9321
9322 <refsynopsisdiv>
9323 <programlisting xml:id="htmlhelp.enhanced.decompilation.frag">
9324 &lt;xsl:param name="htmlhelp.enhanced.decompilation" select="0"&gt;&lt;/xsl:param&gt;
9325 </programlisting>
9326 </refsynopsisdiv>
9327
9328 <refsection><info><title>Description</title></info>
9329
9330 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
9331
9332 </refsection>
9333 </refentry>
9334
9335 <refentry version="5.0" xml:id="htmlhelp.enumerate.images">
9336 <refmeta>
9337 <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
9338 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9339 </refmeta>
9340 <refnamediv>
9341 <refname>htmlhelp.enumerate.images</refname>
9342 <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
9343 </refnamediv>
9344
9345 <refsynopsisdiv>
9346 <programlisting xml:id="htmlhelp.enumerate.images.frag">
9347 &lt;xsl:param name="htmlhelp.enumerate.images" select="0"&gt;&lt;/xsl:param&gt;
9348 </programlisting>
9349 </refsynopsisdiv>
9350
9351 <refsection><info><title>Description</title></info>
9352
9353 <para>Set to non-zero if you insert images into your documents as
9354 external binary entities or if you are using absolute image paths.</para>
9355
9356 </refsection>
9357 </refentry>
9358
9359 <refentry version="5.0" xml:id="htmlhelp.force.map.and.alias">
9360 <refmeta>
9361 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
9362 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9363 </refmeta>
9364 <refnamediv>
9365 <refname>htmlhelp.force.map.and.alias</refname>
9366 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
9367 </refnamediv>
9368 <refsynopsisdiv>
9369 <programlisting xml:id="htmlhelp.force.map.and.alias.frag">
9370 &lt;xsl:param name="htmlhelp.force.map.and.alias" select="0"&gt;&lt;/xsl:param&gt;
9371 </programlisting>
9372 </refsynopsisdiv>
9373 <refsection><info><title>Description</title></info>
9374   <para>Set to non-zero if you have your own
9375     <literal>alias.h</literal> and <literal>context.h</literal>
9376     files and you want to include references to them in the project
9377     file.</para>
9378 </refsection>
9379 </refentry>
9380
9381 <refentry version="5.0" xml:id="htmlhelp.map.file">
9382 <refmeta>
9383 <refentrytitle>htmlhelp.map.file</refentrytitle>
9384 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9385 </refmeta>
9386 <refnamediv>
9387 <refname>htmlhelp.map.file</refname>
9388 <refpurpose>Filename of map file.</refpurpose>
9389 </refnamediv>
9390 <refsynopsisdiv>
9391 <programlisting xml:id="htmlhelp.map.file.frag">
9392 &lt;xsl:param name="htmlhelp.map.file"&gt;context.h&lt;/xsl:param&gt;
9393 </programlisting>
9394 </refsynopsisdiv>
9395 <refsection><info><title>Description</title></info>
9396 <para>Set the name of map file. The default is
9397   <filename>context.h</filename>. (used for context-sensitive
9398   help).</para>
9399 </refsection>
9400 </refentry>
9401
9402 <refentry version="5.0" xml:id="htmlhelp.alias.file">
9403 <refmeta>
9404 <refentrytitle>htmlhelp.alias.file</refentrytitle>
9405 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9406 </refmeta>
9407 <refnamediv>
9408 <refname>htmlhelp.alias.file</refname>
9409 <refpurpose>Filename of alias file.</refpurpose>
9410 </refnamediv>
9411
9412 <refsynopsisdiv>
9413 <programlisting xml:id="htmlhelp.alias.file.frag">
9414 &lt;xsl:param name="htmlhelp.alias.file"&gt;alias.h&lt;/xsl:param&gt;
9415 </programlisting>
9416 </refsynopsisdiv>
9417
9418 <refsection><info><title>Description</title></info>
9419
9420 <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
9421
9422 </refsection>
9423 </refentry>
9424
9425 <refentry version="5.0" xml:id="htmlhelp.hhc.section.depth">
9426 <refmeta>
9427 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
9428 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9429 </refmeta>
9430 <refnamediv>
9431 <refname>htmlhelp.hhc.section.depth</refname>
9432 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
9433 </refnamediv>
9434
9435 <refsynopsisdiv>
9436 <programlisting xml:id="htmlhelp.hhc.section.depth.frag">
9437 &lt;xsl:param name="htmlhelp.hhc.section.depth"&gt;5&lt;/xsl:param&gt;
9438 </programlisting>
9439 </refsynopsisdiv>
9440
9441 <refsection><info><title>Description</title></info>
9442
9443 <para>Set the section depth in the left pane of HTML Help viewer. </para>
9444
9445 </refsection>
9446 </refentry>
9447
9448 <refentry version="5.0" xml:id="htmlhelp.hhc.show.root">
9449 <refmeta>
9450 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
9451 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9452 </refmeta>
9453 <refnamediv>
9454 <refname>htmlhelp.hhc.show.root</refname>
9455 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
9456 </refnamediv>
9457
9458 <refsynopsisdiv>
9459 <programlisting xml:id="htmlhelp.hhc.show.root.frag">
9460 &lt;xsl:param name="htmlhelp.hhc.show.root" select="1"&gt;&lt;/xsl:param&gt;
9461 </programlisting>
9462 </refsynopsisdiv>
9463
9464 <refsection><info><title>Description</title></info>
9465
9466 <para>If set to zero, there will be no entry for the root element in the
9467 ToC. This is useful when you want to provide the user with an expanded
9468 ToC as a default.</para>
9469
9470 </refsection>
9471 </refentry>
9472
9473 <refentry version="5.0" xml:id="htmlhelp.hhc.folders.instead.books">
9474 <refmeta>
9475 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
9476 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9477 </refmeta>
9478 <refnamediv>
9479 <refname>htmlhelp.hhc.folders.instead.books</refname>
9480 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
9481 </refnamediv>
9482
9483 <refsynopsisdiv>
9484 <programlisting xml:id="htmlhelp.hhc.folders.instead.books.frag">
9485 &lt;xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"&gt;&lt;/xsl:param&gt;
9486 </programlisting>
9487 </refsynopsisdiv>
9488
9489 <refsection><info><title>Description</title></info>
9490
9491 <para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC.
9492 If you want to use folder-like icons, you must switch off the binary ToC using
9493 <parameter>htmlhelp.hhc.binary</parameter>.
9494
9495 </para>
9496
9497 </refsection>
9498 </refentry>
9499
9500 <refentry version="5.0" xml:id="htmlhelp.hhc.binary">
9501 <refmeta>
9502 <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
9503 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9504 </refmeta>
9505 <refnamediv>
9506 <refname>htmlhelp.hhc.binary</refname>
9507 <refpurpose>Generate binary ToC?</refpurpose>
9508 </refnamediv>
9509
9510 <refsynopsisdiv>
9511 <programlisting xml:id="htmlhelp.hhc.binary.frag">
9512 &lt;xsl:param name="htmlhelp.hhc.binary" select="1"&gt;&lt;/xsl:param&gt;
9513 </programlisting>
9514 </refsynopsisdiv>
9515
9516 <refsection><info><title>Description</title></info>
9517
9518 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
9519 if you want to add Prev/Next buttons to toolbar (which is default
9520 behaviour). Files with binary TOC can't be merged.</para>
9521
9522 </refsection>
9523 </refentry>
9524
9525 <refentry version="5.0" xml:id="htmlhelp.hhc.width">
9526 <refmeta>
9527 <refentrytitle>htmlhelp.hhc.width</refentrytitle>
9528 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9529 </refmeta>
9530 <refnamediv>
9531 <refname>htmlhelp.hhc.width</refname>
9532 <refpurpose>Width of navigation pane</refpurpose>
9533 </refnamediv>
9534
9535 <refsynopsisdiv>
9536 <programlisting xml:id="htmlhelp.hhc.width.frag">
9537 &lt;xsl:param name="htmlhelp.hhc.width"&gt;&lt;/xsl:param&gt;
9538 </programlisting>
9539 </refsynopsisdiv>
9540
9541 <refsection><info><title>Description</title></info>
9542
9543 <para>This parameter specifies the width of the navigation pane (containing TOC and
9544 other navigation tabs) in pixels.</para>
9545
9546 </refsection>
9547 </refentry>
9548
9549 <refentry version="5.0" xml:id="htmlhelp.title">
9550 <refmeta>
9551 <refentrytitle>htmlhelp.title</refentrytitle>
9552 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9553 </refmeta>
9554 <refnamediv>
9555 <refname>htmlhelp.title</refname>
9556 <refpurpose>Title of HTML Help</refpurpose>
9557 </refnamediv>
9558
9559 <refsynopsisdiv>
9560 <programlisting xml:id="htmlhelp.title.frag">
9561 &lt;xsl:param name="htmlhelp.title"&gt;&lt;/xsl:param&gt;
9562 </programlisting>
9563 </refsynopsisdiv>
9564
9565 <refsection><info><title>Description</title></info>
9566
9567 <para>Content of this parameter will be used as a title for generated
9568 HTML Help. If empty, title will be automatically taken from document.</para>
9569
9570 </refsection>
9571 </refentry>
9572
9573 <refentry version="5.0" xml:id="htmlhelp.show.menu">
9574 <refmeta>
9575 <refentrytitle>htmlhelp.show.menu</refentrytitle>
9576 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9577 </refmeta>
9578 <refnamediv>
9579 <refname>htmlhelp.show.menu</refname>
9580 <refpurpose>Should the menu bar be shown?</refpurpose>
9581 </refnamediv>
9582
9583 <refsynopsisdiv>
9584 <programlisting xml:id="htmlhelp.show.menu.frag">
9585 &lt;xsl:param name="htmlhelp.show.menu" select="0"&gt;&lt;/xsl:param&gt;
9586 </programlisting>
9587 </refsynopsisdiv>
9588
9589 <refsection><info><title>Description</title></info>
9590
9591 <para>Set to non-zero to have an application menu bar in your HTML Help window.
9592 </para>
9593
9594 </refsection>
9595 </refentry>
9596
9597 <refentry version="5.0" xml:id="htmlhelp.show.toolbar.text">
9598 <refmeta>
9599 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
9600 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9601 </refmeta>
9602 <refnamediv>
9603 <refname>htmlhelp.show.toolbar.text</refname>
9604 <refpurpose>Show text under toolbar buttons?</refpurpose>
9605 </refnamediv>
9606
9607 <refsynopsisdiv>
9608 <programlisting xml:id="htmlhelp.show.toolbar.text.frag">
9609 &lt;xsl:param name="htmlhelp.show.toolbar.text" select="1"&gt;&lt;/xsl:param&gt;
9610 </programlisting>
9611 </refsynopsisdiv>
9612
9613 <refsection><info><title>Description</title></info>
9614
9615 <para>Set to non-zero to display texts under toolbar buttons, zero to switch
9616 off displays.</para>
9617
9618 </refsection>
9619 </refentry>
9620
9621 <refentry version="5.0" xml:id="htmlhelp.show.advanced.search">
9622 <refmeta>
9623 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
9624 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9625 </refmeta>
9626 <refnamediv>
9627 <refname>htmlhelp.show.advanced.search</refname>
9628 <refpurpose>Should advanced search features be available?</refpurpose>
9629 </refnamediv>
9630
9631 <refsynopsisdiv>
9632 <programlisting xml:id="htmlhelp.show.advanced.search.frag">
9633 &lt;xsl:param name="htmlhelp.show.advanced.search" select="0"&gt;&lt;/xsl:param&gt;
9634 </programlisting>
9635 </refsynopsisdiv>
9636
9637 <refsection><info><title>Description</title></info>
9638
9639 <para>If you want advanced search features in your help, turn this
9640 parameter to 1.</para>
9641
9642 </refsection>
9643 </refentry>
9644
9645 <refentry version="5.0" xml:id="htmlhelp.show.favorities">
9646 <refmeta>
9647 <refentrytitle>htmlhelp.show.favorities</refentrytitle>
9648 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9649 </refmeta>
9650 <refnamediv>
9651 <refname>htmlhelp.show.favorities</refname>
9652 <refpurpose>Should the Favorites tab be shown?</refpurpose>
9653 </refnamediv>
9654
9655 <refsynopsisdiv>
9656 <programlisting xml:id="htmlhelp.show.favorities.frag">
9657 &lt;xsl:param name="htmlhelp.show.favorities" select="0"&gt;&lt;/xsl:param&gt;
9658 </programlisting>
9659 </refsynopsisdiv>
9660
9661 <refsection><info><title>Description</title></info>
9662
9663 <para>Set to non-zero to include a Favorites tab in the navigation pane
9664 of the help window.</para>
9665
9666 </refsection>
9667 </refentry>
9668
9669 <refentry version="5.0" xml:id="htmlhelp.button.hideshow">
9670 <refmeta>
9671 <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
9672 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9673 </refmeta>
9674 <refnamediv>
9675 <refname>htmlhelp.button.hideshow</refname>
9676 <refpurpose>Should the Hide/Show button be shown?</refpurpose>
9677 </refnamediv>
9678
9679 <refsynopsisdiv>
9680 <programlisting xml:id="htmlhelp.button.hideshow.frag">
9681 &lt;xsl:param name="htmlhelp.button.hideshow" select="1"&gt;&lt;/xsl:param&gt;
9682 </programlisting>
9683 </refsynopsisdiv>
9684
9685 <refsection><info><title>Description</title></info>
9686
9687 <para>Set to non-zero to include the  Hide/Show button shown on toolbar</para>
9688
9689 </refsection>
9690 </refentry>
9691
9692 <refentry version="5.0" xml:id="htmlhelp.button.back">
9693 <refmeta>
9694 <refentrytitle>htmlhelp.button.back</refentrytitle>
9695 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9696 </refmeta>
9697 <refnamediv>
9698 <refname>htmlhelp.button.back</refname>
9699 <refpurpose>Should the Back button be shown?</refpurpose>
9700 </refnamediv>
9701
9702 <refsynopsisdiv>
9703 <programlisting xml:id="htmlhelp.button.back.frag">
9704 &lt;xsl:param name="htmlhelp.button.back" select="1"&gt;&lt;/xsl:param&gt;
9705 </programlisting>
9706 </refsynopsisdiv>
9707
9708 <refsection><info><title>Description</title></info>
9709
9710 <para>Set to non-zero to include the  Hide/Show button shown on toolbar</para>
9711
9712 </refsection>
9713 </refentry>
9714
9715 <refentry version="5.0" xml:id="htmlhelp.button.forward">
9716 <refmeta>
9717 <refentrytitle>htmlhelp.button.forward</refentrytitle>
9718 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9719 </refmeta>
9720 <refnamediv>
9721 <refname>htmlhelp.button.forward</refname>
9722 <refpurpose>Should the Forward button be shown?</refpurpose>
9723 </refnamediv>
9724
9725 <refsynopsisdiv>
9726 <programlisting xml:id="htmlhelp.button.forward.frag">
9727 &lt;xsl:param name="htmlhelp.button.forward" select="0"&gt;&lt;/xsl:param&gt;
9728 </programlisting>
9729 </refsynopsisdiv>
9730
9731 <refsection><info><title>Description</title></info>
9732
9733 <para>Set to non-zero to include the  Forward button  on the toolbar.</para>
9734
9735 </refsection>
9736 </refentry>
9737
9738 <refentry version="5.0" xml:id="htmlhelp.button.stop">
9739 <refmeta>
9740 <refentrytitle>htmlhelp.button.stop</refentrytitle>
9741 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9742 </refmeta>
9743 <refnamediv>
9744 <refname>htmlhelp.button.stop</refname>
9745 <refpurpose>Should the Stop button be shown?</refpurpose>
9746 </refnamediv>
9747
9748 <refsynopsisdiv>
9749 <programlisting xml:id="htmlhelp.button.stop.frag">
9750 &lt;xsl:param name="htmlhelp.button.stop" select="0"&gt;&lt;/xsl:param&gt;
9751 </programlisting>
9752 </refsynopsisdiv>
9753
9754 <refsection><info><title>Description</title></info>
9755
9756 <para>If you want Stop button shown on toolbar, turn this
9757 parameter to 1.</para>
9758
9759 </refsection>
9760 </refentry>
9761
9762 <refentry version="5.0" xml:id="htmlhelp.button.refresh">
9763 <refmeta>
9764 <refentrytitle>htmlhelp.button.refresh</refentrytitle>
9765 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9766 </refmeta>
9767 <refnamediv>
9768 <refname>htmlhelp.button.refresh</refname>
9769 <refpurpose>Should the Refresh button be shown?</refpurpose>
9770 </refnamediv>
9771
9772 <refsynopsisdiv>
9773 <programlisting xml:id="htmlhelp.button.refresh.frag">
9774 &lt;xsl:param name="htmlhelp.button.refresh" select="0"&gt;&lt;/xsl:param&gt;
9775 </programlisting>
9776 </refsynopsisdiv>
9777
9778 <refsection><info><title>Description</title></info>
9779
9780 <para>Set to non-zero to include the Stop button  on the toolbar.</para>
9781
9782 </refsection>
9783 </refentry>
9784
9785 <refentry version="5.0" xml:id="htmlhelp.button.home">
9786 <refmeta>
9787 <refentrytitle>htmlhelp.button.home</refentrytitle>
9788 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9789 </refmeta>
9790 <refnamediv>
9791 <refname>htmlhelp.button.home</refname>
9792 <refpurpose>Should the Home button be shown?</refpurpose>
9793 </refnamediv>
9794
9795 <refsynopsisdiv>
9796 <programlisting xml:id="htmlhelp.button.home.frag">
9797 &lt;xsl:param name="htmlhelp.button.home" select="0"&gt;&lt;/xsl:param&gt;
9798 </programlisting>
9799 </refsynopsisdiv>
9800
9801 <refsection><info><title>Description</title></info>
9802
9803 <para>Set to non-zero to include the Home button  on the toolbar.</para>
9804
9805 </refsection>
9806 </refentry>
9807
9808 <refentry version="5.0" xml:id="htmlhelp.button.home.url">
9809 <refmeta>
9810 <refentrytitle>htmlhelp.button.home.url</refentrytitle>
9811 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9812 </refmeta>
9813 <refnamediv>
9814 <refname>htmlhelp.button.home.url</refname>
9815 <refpurpose>URL address of page accessible by Home button</refpurpose>
9816 </refnamediv>
9817
9818 <refsynopsisdiv>
9819 <programlisting xml:id="htmlhelp.button.home.url.frag">
9820 &lt;xsl:param name="htmlhelp.button.home.url"&gt;&lt;/xsl:param&gt;
9821 </programlisting>
9822 </refsynopsisdiv>
9823
9824 <refsection><info><title>Description</title></info>
9825
9826 <para>URL address of page accessible by Home button.</para>
9827
9828 </refsection>
9829 </refentry>
9830
9831 <refentry version="5.0" xml:id="htmlhelp.button.options">
9832 <refmeta>
9833 <refentrytitle>htmlhelp.button.options</refentrytitle>
9834 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9835 </refmeta>
9836 <refnamediv>
9837 <refname>htmlhelp.button.options</refname>
9838 <refpurpose>Should the Options button be shown?</refpurpose>
9839 </refnamediv>
9840
9841 <refsynopsisdiv>
9842 <programlisting xml:id="htmlhelp.button.options.frag">
9843 &lt;xsl:param name="htmlhelp.button.options" select="1"&gt;&lt;/xsl:param&gt;
9844 </programlisting>
9845 </refsynopsisdiv>
9846
9847 <refsection><info><title>Description</title></info>
9848
9849 <para>If you want Options button shown on toolbar, turn this
9850 parameter to 1.</para>
9851
9852 </refsection>
9853 </refentry>
9854
9855 <refentry version="5.0" xml:id="htmlhelp.button.print">
9856 <refmeta>
9857 <refentrytitle>htmlhelp.button.print</refentrytitle>
9858 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9859 </refmeta>
9860 <refnamediv>
9861 <refname>htmlhelp.button.print</refname>
9862 <refpurpose>Should the Print button be shown?</refpurpose>
9863 </refnamediv>
9864
9865 <refsynopsisdiv>
9866 <programlisting xml:id="htmlhelp.button.print.frag">
9867 &lt;xsl:param name="htmlhelp.button.print" select="1"&gt;&lt;/xsl:param&gt;
9868 </programlisting>
9869 </refsynopsisdiv>
9870
9871 <refsection><info><title>Description</title></info>
9872
9873 <para>Set to non-zero to include the Print button  on the toolbar.
9874 </para>
9875
9876 </refsection>
9877 </refentry>
9878
9879 <refentry version="5.0" xml:id="htmlhelp.button.locate">
9880 <refmeta>
9881 <refentrytitle>htmlhelp.button.locate</refentrytitle>
9882 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9883 </refmeta>
9884 <refnamediv>
9885 <refname>htmlhelp.button.locate</refname>
9886 <refpurpose>Should the Locate button be shown?</refpurpose>
9887 </refnamediv>
9888
9889 <refsynopsisdiv>
9890 <programlisting xml:id="htmlhelp.button.locate.frag">
9891 &lt;xsl:param name="htmlhelp.button.locate" select="0"&gt;&lt;/xsl:param&gt;
9892 </programlisting>
9893 </refsynopsisdiv>
9894
9895 <refsection><info><title>Description</title></info>
9896
9897 <para>If you want Locate button shown on toolbar, turn this
9898 parameter to 1.</para>
9899
9900 </refsection>
9901 </refentry>
9902
9903 <refentry version="5.0" xml:id="htmlhelp.button.jump1">
9904 <refmeta>
9905 <refentrytitle>htmlhelp.button.jump1</refentrytitle>
9906 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9907 </refmeta>
9908 <refnamediv>
9909 <refname>htmlhelp.button.jump1</refname>
9910 <refpurpose>Should the Jump1 button be shown?</refpurpose>
9911 </refnamediv>
9912 <refsynopsisdiv>
9913 <programlisting xml:id="htmlhelp.button.jump1.frag">
9914 &lt;xsl:param name="htmlhelp.button.jump1" select="0"&gt;&lt;/xsl:param&gt;
9915 </programlisting>
9916 </refsynopsisdiv>
9917 <refsection><info><title>Description</title></info>
9918   <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
9919 </refsection>
9920 </refentry>
9921
9922 <refentry version="5.0" xml:id="htmlhelp.button.jump1.url">
9923 <refmeta>
9924 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
9925 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9926 </refmeta>
9927 <refnamediv>
9928 <refname>htmlhelp.button.jump1.url</refname>
9929 <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
9930 </refnamediv>
9931
9932 <refsynopsisdiv>
9933 <programlisting xml:id="htmlhelp.button.jump1.url.frag">
9934 &lt;xsl:param name="htmlhelp.button.jump1.url"&gt;&lt;/xsl:param&gt;
9935 </programlisting>
9936 </refsynopsisdiv>
9937
9938 <refsection><info><title>Description</title></info>
9939
9940 <para>URL address of page accessible by Jump1 button.</para>
9941
9942 </refsection>
9943 </refentry>
9944
9945 <refentry version="5.0" xml:id="htmlhelp.button.jump1.title">
9946 <refmeta>
9947 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
9948 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9949 </refmeta>
9950 <refnamediv>
9951 <refname>htmlhelp.button.jump1.title</refname>
9952 <refpurpose>Title of Jump1 button</refpurpose>
9953 </refnamediv>
9954
9955 <refsynopsisdiv>
9956 <programlisting xml:id="htmlhelp.button.jump1.title.frag">
9957 &lt;xsl:param name="htmlhelp.button.jump1.title"&gt;User1&lt;/xsl:param&gt;
9958 </programlisting>
9959 </refsynopsisdiv>
9960
9961 <refsection><info><title>Description</title></info>
9962
9963 <para>Title of Jump1 button.</para>
9964
9965 </refsection>
9966 </refentry>
9967
9968 <refentry version="5.0" xml:id="htmlhelp.button.jump2">
9969 <refmeta>
9970 <refentrytitle>htmlhelp.button.jump2</refentrytitle>
9971 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9972 </refmeta>
9973 <refnamediv>
9974 <refname>htmlhelp.button.jump2</refname>
9975 <refpurpose>Should the Jump2 button be shown?</refpurpose>
9976 </refnamediv>
9977
9978 <refsynopsisdiv>
9979 <programlisting xml:id="htmlhelp.button.jump2.frag">
9980 &lt;xsl:param name="htmlhelp.button.jump2" select="0"&gt;&lt;/xsl:param&gt;
9981 </programlisting>
9982 </refsynopsisdiv>
9983
9984 <refsection><info><title>Description</title></info>
9985
9986 <para>Set to non-zero to include the Jump2 button  on the toolbar.</para>
9987
9988 </refsection>
9989 </refentry>
9990
9991 <refentry version="5.0" xml:id="htmlhelp.button.jump2.url">
9992 <refmeta>
9993 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
9994 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9995 </refmeta>
9996 <refnamediv>
9997 <refname>htmlhelp.button.jump2.url</refname>
9998 <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
9999 </refnamediv>
10000
10001 <refsynopsisdiv>
10002 <programlisting xml:id="htmlhelp.button.jump2.url.frag">
10003 &lt;xsl:param name="htmlhelp.button.jump2.url"&gt;&lt;/xsl:param&gt;
10004 </programlisting>
10005 </refsynopsisdiv>
10006
10007 <refsection><info><title>Description</title></info>
10008
10009 <para>URL address of page accessible by Jump2 button.</para>
10010
10011 </refsection>
10012 </refentry>
10013
10014 <refentry version="5.0" xml:id="htmlhelp.button.jump2.title">
10015 <refmeta>
10016 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
10017 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10018 </refmeta>
10019 <refnamediv>
10020 <refname>htmlhelp.button.jump2.title</refname>
10021 <refpurpose>Title of Jump2 button</refpurpose>
10022 </refnamediv>
10023
10024 <refsynopsisdiv>
10025 <programlisting xml:id="htmlhelp.button.jump2.title.frag">
10026 &lt;xsl:param name="htmlhelp.button.jump2.title"&gt;User2&lt;/xsl:param&gt;
10027 </programlisting>
10028 </refsynopsisdiv>
10029
10030 <refsection><info><title>Description</title></info>
10031
10032 <para>Title of Jump2 button.</para>
10033
10034 </refsection>
10035 </refentry>
10036
10037 <refentry version="5.0" xml:id="htmlhelp.button.next">
10038 <refmeta>
10039 <refentrytitle>htmlhelp.button.next</refentrytitle>
10040 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10041 </refmeta>
10042 <refnamediv>
10043 <refname>htmlhelp.button.next</refname>
10044 <refpurpose>Should the Next button be shown?</refpurpose>
10045 </refnamediv>
10046
10047 <refsynopsisdiv>
10048 <programlisting xml:id="htmlhelp.button.next.frag">
10049 &lt;xsl:param name="htmlhelp.button.next" select="1"&gt;&lt;/xsl:param&gt;
10050 </programlisting>
10051 </refsynopsisdiv>
10052
10053 <refsection><info><title>Description</title></info>
10054
10055 <para>Set to non-zero to include the Next button  on the toolbar.</para>
10056
10057 </refsection>
10058 </refentry>
10059
10060 <refentry version="5.0" xml:id="htmlhelp.button.prev">
10061 <refmeta>
10062 <refentrytitle>htmlhelp.button.prev</refentrytitle>
10063 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10064 </refmeta>
10065 <refnamediv>
10066 <refname>htmlhelp.button.prev</refname>
10067 <refpurpose>Should the Prev button be shown?</refpurpose>
10068 </refnamediv>
10069
10070 <refsynopsisdiv>
10071 <programlisting xml:id="htmlhelp.button.prev.frag">
10072 &lt;xsl:param name="htmlhelp.button.prev" select="1"&gt;&lt;/xsl:param&gt;
10073 </programlisting>
10074 </refsynopsisdiv>
10075
10076 <refsection><info><title>Description</title></info>
10077
10078 <para>Set to non-zero to include the Prev button  on the toolbar.
10079 </para>
10080
10081 </refsection>
10082 </refentry>
10083
10084 <refentry version="5.0" xml:id="htmlhelp.button.zoom">
10085 <refmeta>
10086 <refentrytitle>htmlhelp.button.zoom</refentrytitle>
10087 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10088 </refmeta>
10089 <refnamediv>
10090 <refname>htmlhelp.button.zoom</refname>
10091 <refpurpose>Should the Zoom button be shown?</refpurpose>
10092 </refnamediv>
10093
10094 <refsynopsisdiv>
10095 <programlisting xml:id="htmlhelp.button.zoom.frag">
10096 &lt;xsl:param name="htmlhelp.button.zoom" select="0"&gt;&lt;/xsl:param&gt;
10097 </programlisting>
10098 </refsynopsisdiv>
10099
10100 <refsection><info><title>Description</title></info>
10101
10102 <para>Set to non-zero to include the Zoom button  on the toolbar.
10103 </para>
10104
10105 </refsection>
10106 </refentry>
10107
10108 <refentry version="5.0" xml:id="htmlhelp.remember.window.position">
10109 <refmeta>
10110 <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
10111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10112 </refmeta>
10113 <refnamediv>
10114 <refname>htmlhelp.remember.window.position</refname>
10115 <refpurpose>Remember help window position?</refpurpose>
10116 </refnamediv>
10117
10118 <refsynopsisdiv>
10119 <programlisting xml:id="htmlhelp.remember.window.position.frag">
10120 &lt;xsl:param name="htmlhelp.remember.window.position" select="0"&gt;&lt;/xsl:param&gt;
10121 </programlisting>
10122 </refsynopsisdiv>
10123
10124 <refsection><info><title>Description</title></info>
10125
10126 <para>Set to non-zero to remember help window position between starts.</para>
10127
10128 </refsection>
10129 </refentry>
10130
10131 <refentry version="5.0" xml:id="htmlhelp.window.geometry">
10132 <refmeta>
10133 <refentrytitle>htmlhelp.window.geometry</refentrytitle>
10134 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10135 </refmeta>
10136 <refnamediv>
10137 <refname>htmlhelp.window.geometry</refname>
10138 <refpurpose>Set initial geometry of help window</refpurpose>
10139 </refnamediv>
10140
10141 <refsynopsisdiv>
10142 <programlisting xml:id="htmlhelp.window.geometry.frag">
10143 &lt;xsl:param name="htmlhelp.window.geometry"&gt;&lt;/xsl:param&gt;
10144 </programlisting>
10145 </refsynopsisdiv>
10146
10147 <refsection><info><title>Description</title></info>
10148
10149 <para>This parameter specifies initial position of help
10150 window. E.g.</para>
10151
10152 <programlisting>&lt;xsl:param name="htmlhelp.window.geometry"&gt;[160,64,992,704]&lt;/xsl:param&gt;</programlisting>
10153
10154 </refsection>
10155 </refentry>
10156
10157 <refentry version="5.0" xml:id="htmlhelp.use.hhk">
10158 <refmeta>
10159 <refentrytitle>htmlhelp.use.hhk</refentrytitle>
10160 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10161 </refmeta>
10162 <refnamediv>
10163 <refname>htmlhelp.use.hhk</refname>
10164 <refpurpose>Should the index be built using the HHK file?</refpurpose>
10165 </refnamediv>
10166
10167 <refsynopsisdiv>
10168 <programlisting xml:id="htmlhelp.use.hhk.frag">
10169 &lt;xsl:param name="htmlhelp.use.hhk" select="0"&gt;&lt;/xsl:param&gt;
10170 </programlisting>
10171 </refsynopsisdiv>
10172
10173 <refsection><info><title>Description</title></info>
10174
10175 <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
10176 elements in the HTML files). For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
10177 </refsection>
10178 </refentry>
10179
10180 <refentry version="5.0" xml:id="htmlhelp.only">
10181 <refmeta>
10182 <refentrytitle>htmlhelp.only</refentrytitle>
10183 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10184 </refmeta>
10185 <refnamediv>
10186 <refname>htmlhelp.only</refname>
10187 <refpurpose>Should only project files be generated?</refpurpose>
10188 </refnamediv>
10189
10190 <refsynopsisdiv>
10191 <programlisting xml:id="htmlhelp.only.frag">
10192 &lt;xsl:param name="htmlhelp.only" select="0"&gt;&lt;/xsl:param&gt;
10193 </programlisting>
10194 </refsynopsisdiv>
10195
10196 <refsection><info><title>Description</title></info>
10197
10198
10199 <para>Set to non-zero if you want to play with various HTML Help parameters
10200 and you don't need to regenerate all HTML files. This setting will not
10201 process whole document, only project files (hhp, hhc, hhk,...) will be
10202 generated.</para>
10203
10204
10205 </refsection>
10206 </refentry>
10207
10208 </reference>
10209 <reference xml:id="eclipse_help"><title>Eclipse Help Platform</title>
10210 <refentry version="5.0" xml:id="eclipse.autolabel">
10211 <refmeta>
10212 <refentrytitle>eclipse.autolabel</refentrytitle>
10213 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10214 </refmeta>
10215 <refnamediv>
10216 <refname>eclipse.autolabel</refname>
10217 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
10218 </refnamediv>
10219
10220 <refsynopsisdiv>
10221 <programlisting xml:id="eclipse.autolabel.frag">
10222 &lt;xsl:param name="eclipse.autolabel" select="0"&gt;&lt;/xsl:param&gt;
10223 </programlisting>
10224 </refsynopsisdiv>
10225
10226 <refsection><info><title>Description</title></info>
10227
10228 <para>If you want to include chapter and section numbers into ToC in
10229 the left panel, set this parameter to 1.</para>
10230
10231 </refsection>
10232 </refentry>
10233
10234 <refentry version="5.0" xml:id="eclipse.plugin.name">
10235 <refmeta>
10236 <refentrytitle>eclipse.plugin.name</refentrytitle>
10237 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10238 </refmeta>
10239 <refnamediv>
10240 <refname>eclipse.plugin.name</refname>
10241 <refpurpose>Eclipse Help plugin name</refpurpose>
10242 </refnamediv>
10243
10244 <refsynopsisdiv>
10245 <programlisting xml:id="eclipse.plugin.name.frag">
10246 &lt;xsl:param name="eclipse.plugin.name"&gt;DocBook Online Help Sample&lt;/xsl:param&gt;
10247 </programlisting>
10248 </refsynopsisdiv>
10249
10250 <refsection><info><title>Description</title></info>
10251
10252 <para>Eclipse Help plugin name.</para>
10253
10254 </refsection>
10255 </refentry>
10256
10257 <refentry version="5.0" xml:id="eclipse.plugin.id">
10258 <refmeta>
10259 <refentrytitle>eclipse.plugin.id</refentrytitle>
10260 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10261 </refmeta>
10262 <refnamediv>
10263 <refname>eclipse.plugin.id</refname>
10264 <refpurpose>Eclipse Help plugin id</refpurpose>
10265 </refnamediv>
10266
10267 <refsynopsisdiv>
10268 <programlisting xml:id="eclipse.plugin.id.frag">
10269 &lt;xsl:param name="eclipse.plugin.id"&gt;com.example.help&lt;/xsl:param&gt;
10270 </programlisting>
10271 </refsynopsisdiv>
10272
10273 <refsection><info><title>Description</title></info>
10274
10275 <para>Eclipse Help plugin id. You should change this id to something
10276 unique for each help.</para>
10277
10278 </refsection>
10279 </refentry>
10280
10281 <refentry version="5.0" xml:id="eclipse.plugin.provider">
10282 <refmeta>
10283 <refentrytitle>eclipse.plugin.provider</refentrytitle>
10284 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10285 </refmeta>
10286 <refnamediv>
10287 <refname>eclipse.plugin.provider</refname>
10288 <refpurpose>Eclipse Help plugin provider name</refpurpose>
10289 </refnamediv>
10290
10291 <refsynopsisdiv>
10292 <programlisting xml:id="eclipse.plugin.provider.frag">
10293 &lt;xsl:param name="eclipse.plugin.provider"&gt;Example provider&lt;/xsl:param&gt;
10294 </programlisting>
10295 </refsynopsisdiv>
10296
10297 <refsection><info><title>Description</title></info>
10298
10299 <para>Eclipse Help plugin provider name.</para>
10300
10301 </refsection>
10302 </refentry>
10303
10304 </reference>
10305 <reference xml:id="javahelp"><title>JavaHelp</title>
10306 <refentry version="5.0" xml:id="javahelp.encoding">
10307 <refmeta>
10308 <refentrytitle>javahelp.encoding</refentrytitle>
10309 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10310 </refmeta>
10311 <refnamediv>
10312 <refname>javahelp.encoding</refname>
10313 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
10314 </refnamediv>
10315
10316 <refsynopsisdiv>
10317 <programlisting xml:id="javahelp.encoding.frag">
10318 &lt;xsl:param name="javahelp.encoding"&gt;iso-8859-1&lt;/xsl:param&gt;
10319 </programlisting>
10320 </refsynopsisdiv>
10321
10322 <refsection><info><title>Description</title></info>
10323
10324 <para>JavaHelp crashes on some characters when written as character
10325 references. In that case you can use this parameter to select an appropriate encoding.</para>
10326
10327 </refsection>
10328 </refentry>
10329
10330
10331
10332
10333 </reference>
10334 <reference xml:id="l10n"><title>Localization</title>
10335 <refentry version="5.0" xml:id="l10n.gentext.language">
10336 <refmeta>
10337 <refentrytitle>l10n.gentext.language</refentrytitle>
10338 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10339 </refmeta>
10340 <refnamediv>
10341 <refname>l10n.gentext.language</refname>
10342 <refpurpose>Sets the gentext language</refpurpose>
10343 </refnamediv>
10344
10345 <refsynopsisdiv>
10346 <programlisting xml:id="l10n.gentext.language.frag">
10347 &lt;xsl:param name="l10n.gentext.language"&gt;&lt;/xsl:param&gt;
10348 </programlisting>
10349 </refsynopsisdiv>
10350
10351 <refsection><info><title>Description</title></info>
10352
10353 <para>If this parameter is set to any value other than the empty string, its
10354 value will be used as the value for the language when generating text. Setting
10355 <parameter>l10n.gentext.language</parameter> overrides any settings within the
10356 document being formatted.</para>
10357
10358 <para>It's much more likely that you might want to set the
10359 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
10360
10361 </refsection>
10362 </refentry>
10363
10364 <refentry version="5.0" xml:id="l10n.gentext.default.language">
10365   <refmeta>
10366     <refentrytitle>l10n.gentext.default.language</refentrytitle>
10367     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10368   </refmeta>
10369   <refnamediv>
10370     <refname>l10n.gentext.default.language</refname>
10371     <refpurpose>Sets the default language for generated text</refpurpose>
10372   </refnamediv>
10373
10374   <refsynopsisdiv>
10375 <programlisting xml:id="l10n.gentext.default.language.frag">
10376 &lt;xsl:param name="l10n.gentext.default.language"&gt;en&lt;/xsl:param&gt;
10377 </programlisting>
10378 </refsynopsisdiv>
10379
10380 <refsection><info><title>Description</title></info>
10381
10382 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
10383 parameter is used as the language for generated text if no setting is provided
10384 in the source document.</para>
10385
10386 </refsection>
10387 </refentry>
10388
10389 <refentry version="5.0" xml:id="l10n.gentext.use.xref.language">
10390 <refmeta>
10391 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
10392 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10393 </refmeta>
10394 <refnamediv>
10395 <refname>l10n.gentext.use.xref.language</refname>
10396 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
10397 </refnamediv>
10398
10399 <refsynopsisdiv>
10400 <programlisting xml:id="l10n.gentext.use.xref.language.frag">
10401 &lt;xsl:param name="l10n.gentext.use.xref.language" select="0"&gt;&lt;/xsl:param&gt;
10402 </programlisting>
10403 </refsynopsisdiv>
10404
10405 <refsection><info><title>Description</title></info>
10406
10407 <para>If non-zero, the language of the target will be used when
10408 generating cross reference text. Usually, the <quote>current</quote>
10409 language is used when generating text (that is, the language of the
10410 element that contains the cross-reference element). But setting this parameter
10411 allows the language of the element <emphasis>pointed to</emphasis> to control
10412 the generated text.</para>
10413
10414 <para>Consider the following example:</para>
10415
10416 <informalexample>
10417 <programlisting>&lt;para lang="en"&gt;See also &lt;xref linkend="chap3"/&gt;.&lt;/para&gt;
10418 </programlisting>
10419 </informalexample>
10420
10421 <para>Suppose that Chapter 3 happens to be written in German.
10422 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
10423 resulting text will be something like this:</para>
10424
10425 <blockquote>
10426 <para>See also Kapital 3.</para>
10427 </blockquote>
10428
10429 <para>Where the more traditional rendering would be:</para>
10430
10431 <blockquote>
10432 <para>See also Chapter 3.</para>
10433 </blockquote>
10434
10435 </refsection>
10436 </refentry>
10437
10438 <refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant">
10439 <refmeta>
10440 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
10441 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10442 </refmeta>
10443 <refnamediv>
10444 <refname>l10n.lang.value.rfc.compliant</refname>
10445 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
10446 </refnamediv>
10447
10448 <refsynopsisdiv>
10449 <programlisting xml:id="l10n.lang.value.rfc.compliant.frag">
10450 &lt;xsl:param name="l10n.lang.value.rfc.compliant" select="1"&gt;&lt;/xsl:param&gt;
10451 </programlisting>
10452 </refsynopsisdiv>
10453
10454 <refsection><info><title>Description</title></info>
10455
10456 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
10457 compliant<footnote><para>Section 8.1.1, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that:
10458
10459 <blockquote><para>[RFC1766] defines and explains the language codes
10460 that must be used in HTML documents.</para>
10461 <para>Briefly, language codes consist of a primary code and a possibly
10462 empty series of subcodes:
10463
10464 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
10465 </para>
10466 <para>And in RFC 1766, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
10467 of Languages</link>, the EBNF for "language tag" is given as:
10468
10469 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
10470 Primary-tag = 1*8ALPHA
10471 Subtag = 1*8ALPHA</literallayout>
10472 </para>
10473 </blockquote>
10474 </para></footnote>.
10475
10476 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
10477 replacing them with hyphen characters in output HTML files. For
10478 example, <literal>zh_CN</literal> in a source document becomes
10479 <literal>zh-CN</literal> in the HTML output form that source.
10480
10481 <note>
10482 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
10483 explicitly states that all "language tags" (as it calls them) "are
10484 to be treated as case insensitive".</para>
10485 </note>
10486 </para>
10487
10488 </refsection>
10489 </refentry>
10490
10491 <refentry version="5.0" xml:id="writing.mode">
10492 <refmeta>
10493 <refentrytitle>writing.mode</refentrytitle>
10494 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10495 </refmeta>
10496 <refnamediv>
10497 <refname>writing.mode</refname>
10498 <refpurpose>Direction of text flow based on locale</refpurpose>
10499 </refnamediv>
10500
10501 <refsynopsisdiv>
10502 <programlisting xml:id="writing.mode.frag">
10503 &lt;xsl:param name="writing.mode"&gt;
10504   &lt;xsl:call-template name="gentext"&gt;
10505     &lt;xsl:with-param name="key"&gt;writing-mode&lt;/xsl:with-param&gt;
10506     &lt;xsl:with-param name="lang"&gt;
10507       &lt;xsl:call-template name="l10n.language"&gt;
10508         &lt;xsl:with-param name="target" select="/*[1]"&gt;&lt;/xsl:with-param&gt;
10509       &lt;/xsl:call-template&gt;
10510     &lt;/xsl:with-param&gt;
10511   &lt;/xsl:call-template&gt;
10512 &lt;/xsl:param&gt;
10513 </programlisting>
10514 </refsynopsisdiv>
10515
10516 <refsection><info><title>Description</title></info>
10517
10518 <para>Sets direction of text flow and text alignment based on locale.
10519 The value is normally taken from the gentext file for the
10520 lang attribute of the document's root element, using the
10521 key name 'writing-mode' to look it up in the gentext file.
10522 But the param can also be
10523 set on the command line to override that gentext value.
10524 </para>
10525 <para>Accepted values are:
10526 <variablelist>
10527   <varlistentry>
10528     <term>lr-tb</term>
10529     <listitem>
10530       <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
10531     </listitem>
10532   </varlistentry>
10533   <varlistentry>
10534     <term>rl-tb</term>
10535     <listitem>
10536       <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
10537     </listitem>
10538   </varlistentry>
10539   <varlistentry>
10540     <term>tb-rl</term>
10541     <listitem>
10542       <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
10543       Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
10544     </listitem>
10545   </varlistentry>
10546   <varlistentry>
10547     <term>lr</term>
10548     <listitem>
10549       <para>Shorthand for lr-tb.</para>
10550     </listitem>
10551   </varlistentry>
10552   <varlistentry>
10553     <term>rl</term>
10554     <listitem>
10555       <para>Shorthand for rl-tb.</para>
10556     </listitem>
10557   </varlistentry>
10558   <varlistentry>
10559     <term>tb</term>
10560     <listitem>
10561       <para>Shorthand for tb-rl.</para>
10562     </listitem>
10563   </varlistentry>
10564 </variablelist>
10565 </para>
10566
10567 </refsection>
10568 </refentry>
10569
10570 </reference>
10571 <appendix xml:id="stylesheet"><title>The Stylesheet</title>
10572
10573 <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
10574 around all these parameters.</para>
10575
10576 <programlisting xml:id="top">
10577
10578 &lt;!-- This file is generated from param.xweb --&gt;
10579
10580 &lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;
10581
10582 &lt;!-- ********************************************************************
10583      $Id: param.xweb 8552 2009-12-07 17:45:26Z bobstayton $
10584      ********************************************************************
10585
10586      This file is part of the XSL DocBook Stylesheet distribution.
10587      See ../README or http://docbook.sf.net/release/xsl/current/ for
10588      copyright and other information.
10589
10590      ******************************************************************** --&gt;
10591
10592 &lt;src:fragref linkend="abstract.notitle.enabled.frag"&gt;&lt;/src:fragref&gt;
10593 &lt;src:fragref linkend="admon.graphics.extension.frag"&gt;&lt;/src:fragref&gt;
10594 &lt;src:fragref linkend="admon.graphics.frag"&gt;&lt;/src:fragref&gt;
10595 &lt;src:fragref linkend="admon.graphics.path.frag"&gt;&lt;/src:fragref&gt;
10596 &lt;src:fragref linkend="admon.style.frag"&gt;&lt;/src:fragref&gt;
10597 &lt;src:fragref linkend="admon.textlabel.frag"&gt;&lt;/src:fragref&gt;
10598 &lt;src:fragref linkend="annotate.toc.frag"&gt;&lt;/src:fragref&gt;
10599 &lt;src:fragref linkend="annotation.css.frag"&gt;&lt;/src:fragref&gt;
10600 &lt;src:fragref linkend="annotation.graphic.close.frag"&gt;&lt;/src:fragref&gt;
10601 &lt;src:fragref linkend="annotation.graphic.open.frag"&gt;&lt;/src:fragref&gt;
10602 &lt;src:fragref linkend="annotation.js.frag"&gt;&lt;/src:fragref&gt;
10603 &lt;src:fragref linkend="annotation.support.frag"&gt;&lt;/src:fragref&gt;
10604 &lt;src:fragref linkend="appendix.autolabel.frag"&gt;&lt;/src:fragref&gt;
10605 &lt;src:fragref linkend="author.othername.in.middle.frag"&gt;&lt;/src:fragref&gt;
10606 &lt;src:fragref linkend="autotoc.label.in.hyperlink.frag"&gt;&lt;/src:fragref&gt;
10607 &lt;src:fragref linkend="autotoc.label.separator.frag"&gt;&lt;/src:fragref&gt;
10608 &lt;src:fragref linkend="base.dir.frag"&gt;&lt;/src:fragref&gt;
10609 &lt;src:fragref linkend="biblioentry.item.separator.frag"&gt;&lt;/src:fragref&gt;
10610 &lt;src:fragref linkend="bibliography.collection.frag"&gt;&lt;/src:fragref&gt;
10611 &lt;src:fragref linkend="bibliography.numbered.frag"&gt;&lt;/src:fragref&gt;
10612 &lt;src:fragref linkend="bibliography.style.frag"&gt;&lt;/src:fragref&gt;
10613 &lt;src:fragref linkend="blurb.on.titlepage.enabled.frag"&gt;&lt;/src:fragref&gt;
10614 &lt;src:fragref linkend="bridgehead.in.toc.frag"&gt;&lt;/src:fragref&gt;
10615 &lt;src:fragref linkend="callout.defaultcolumn.frag"&gt;&lt;/src:fragref&gt;
10616 &lt;src:fragref linkend="callout.graphics.extension.frag"&gt;&lt;/src:fragref&gt;
10617 &lt;src:fragref linkend="callout.graphics.frag"&gt;&lt;/src:fragref&gt;
10618 &lt;src:fragref linkend="callout.graphics.number.limit.frag"&gt;&lt;/src:fragref&gt;
10619 &lt;src:fragref linkend="callout.graphics.path.frag"&gt;&lt;/src:fragref&gt;
10620 &lt;src:fragref linkend="callout.list.table.frag"&gt;&lt;/src:fragref&gt;
10621 &lt;src:fragref linkend="callout.unicode.frag"&gt;&lt;/src:fragref&gt;
10622 &lt;src:fragref linkend="callout.unicode.number.limit.frag"&gt;&lt;/src:fragref&gt;
10623 &lt;src:fragref linkend="callout.unicode.start.character.frag"&gt;&lt;/src:fragref&gt;
10624 &lt;src:fragref linkend="callouts.extension.frag"&gt;&lt;/src:fragref&gt;
10625 &lt;src:fragref linkend="chapter.autolabel.frag"&gt;&lt;/src:fragref&gt;
10626 &lt;src:fragref linkend="chunk.append.frag"&gt;&lt;/src:fragref&gt;
10627 &lt;src:fragref linkend="chunk.first.sections.frag"&gt;&lt;/src:fragref&gt;
10628 &lt;src:fragref linkend="chunk.quietly.frag"&gt;&lt;/src:fragref&gt;
10629 &lt;src:fragref linkend="chunk.section.depth.frag"&gt;&lt;/src:fragref&gt;
10630 &lt;src:fragref linkend="chunk.separate.lots.frag"&gt;&lt;/src:fragref&gt;
10631 &lt;src:fragref linkend="chunk.toc.frag"&gt;&lt;/src:fragref&gt;
10632 &lt;src:fragref linkend="chunk.tocs.and.lots.frag"&gt;&lt;/src:fragref&gt;
10633 &lt;src:fragref linkend="chunk.tocs.and.lots.has.title.frag"&gt;&lt;/src:fragref&gt;
10634 &lt;src:fragref linkend="citerefentry.link.frag"&gt;&lt;/src:fragref&gt;
10635 &lt;src:fragref linkend="collect.xref.targets.frag"&gt;&lt;/src:fragref&gt;
10636 &lt;src:fragref linkend="component.label.includes.part.label.frag"&gt;&lt;/src:fragref&gt;
10637 &lt;src:fragref linkend="contrib.inline.enabled.frag"&gt;&lt;/src:fragref&gt;
10638 &lt;src:fragref linkend="css.decoration.frag"&gt;&lt;/src:fragref&gt;
10639 &lt;src:fragref linkend="current.docid.frag"&gt;&lt;/src:fragref&gt;
10640 &lt;src:fragref linkend="custom.css.source.frag"&gt;&lt;/src:fragref&gt;
10641 &lt;src:fragref linkend="default.float.class.frag"&gt;&lt;/src:fragref&gt;
10642 &lt;src:fragref linkend="default.image.width.frag"&gt;&lt;/src:fragref&gt;
10643 &lt;src:fragref linkend="default.table.frame.frag"&gt;&lt;/src:fragref&gt;
10644 &lt;src:fragref linkend="default.table.width.frag"&gt;&lt;/src:fragref&gt;
10645 &lt;src:fragref linkend="docbook.css.link.frag"&gt;&lt;/src:fragref&gt;
10646 &lt;src:fragref linkend="docbook.css.source.frag"&gt;&lt;/src:fragref&gt;
10647 &lt;src:fragref linkend="draft.mode.frag"&gt;&lt;/src:fragref&gt;
10648 &lt;src:fragref linkend="draft.watermark.image.frag"&gt;&lt;/src:fragref&gt;
10649 &lt;src:fragref linkend="ebnf.assignment.frag"&gt;&lt;/src:fragref&gt;
10650 &lt;src:fragref linkend="ebnf.statement.terminator.frag"&gt;&lt;/src:fragref&gt;
10651 &lt;src:fragref linkend="ebnf.table.bgcolor.frag"&gt;&lt;/src:fragref&gt;
10652 &lt;src:fragref linkend="ebnf.table.border.frag"&gt;&lt;/src:fragref&gt;
10653 &lt;src:fragref linkend="eclipse.autolabel.frag"&gt;&lt;/src:fragref&gt;
10654 &lt;src:fragref linkend="eclipse.plugin.id.frag"&gt;&lt;/src:fragref&gt;
10655 &lt;src:fragref linkend="eclipse.plugin.name.frag"&gt;&lt;/src:fragref&gt;
10656 &lt;src:fragref linkend="eclipse.plugin.provider.frag"&gt;&lt;/src:fragref&gt;
10657 &lt;src:fragref linkend="editedby.enabled.frag"&gt;&lt;/src:fragref&gt;
10658 &lt;src:fragref linkend="email.delimiters.enabled.frag"&gt;&lt;/src:fragref&gt;
10659 &lt;src:fragref linkend="emphasis.propagates.style.frag"&gt;&lt;/src:fragref&gt;
10660 &lt;src:fragref linkend="entry.propagates.style.frag"&gt;&lt;/src:fragref&gt;
10661 &lt;src:fragref linkend="exsl.node.set.available.frag"&gt;&lt;/src:fragref&gt;
10662 &lt;src:fragref linkend="firstterm.only.link.frag"&gt;&lt;/src:fragref&gt;
10663 &lt;src:fragref linkend="footer.rule.frag"&gt;&lt;/src:fragref&gt;
10664 &lt;src:fragref linkend="footnote.number.format.frag"&gt;&lt;/src:fragref&gt;
10665 &lt;src:fragref linkend="footnote.number.symbols.frag"&gt;&lt;/src:fragref&gt;
10666 &lt;src:fragref linkend="formal.procedures.frag"&gt;&lt;/src:fragref&gt;
10667 &lt;src:fragref linkend="formal.title.placement.frag"&gt;&lt;/src:fragref&gt;
10668 &lt;src:fragref linkend="funcsynopsis.decoration.frag"&gt;&lt;/src:fragref&gt;
10669 &lt;src:fragref linkend="funcsynopsis.style.frag"&gt;&lt;/src:fragref&gt;
10670 &lt;src:fragref linkend="function.parens.frag"&gt;&lt;/src:fragref&gt;
10671 &lt;src:fragref linkend="generate.css.header.frag"&gt;&lt;/src:fragref&gt;
10672 &lt;src:fragref linkend="generate.id.attributes.frag"&gt;&lt;/src:fragref&gt;
10673 &lt;src:fragref linkend="generate.index.frag"&gt;&lt;/src:fragref&gt;
10674 &lt;src:fragref linkend="generate.legalnotice.link.frag"&gt;&lt;/src:fragref&gt;
10675 &lt;src:fragref linkend="generate.manifest.frag"&gt;&lt;/src:fragref&gt;
10676 &lt;src:fragref linkend="generate.meta.abstract.frag"&gt;&lt;/src:fragref&gt;
10677 &lt;src:fragref linkend="generate.revhistory.link.frag"&gt;&lt;/src:fragref&gt;
10678 &lt;src:fragref linkend="generate.section.toc.level.frag"&gt;&lt;/src:fragref&gt;
10679 &lt;src:fragref linkend="generate.toc.frag"&gt;&lt;/src:fragref&gt;
10680 &lt;src:fragref linkend="glossary.collection.frag"&gt;&lt;/src:fragref&gt;
10681 &lt;src:fragref linkend="glossary.sort.frag"&gt;&lt;/src:fragref&gt;
10682 &lt;src:fragref linkend="glossentry.show.acronym.frag"&gt;&lt;/src:fragref&gt;
10683 &lt;src:fragref linkend="glossterm.auto.link.frag"&gt;&lt;/src:fragref&gt;
10684 &lt;src:fragref linkend="graphic.default.extension.frag"&gt;&lt;/src:fragref&gt;
10685 &lt;src:fragref linkend="graphicsize.extension.frag"&gt;&lt;/src:fragref&gt;
10686 &lt;src:fragref linkend="graphicsize.use.img.src.path.frag"&gt;&lt;/src:fragref&gt;
10687 &lt;src:fragref linkend="header.rule.frag"&gt;&lt;/src:fragref&gt;
10688 &lt;src:fragref linkend="highlight.default.language.frag"&gt;&lt;/src:fragref&gt;
10689 &lt;src:fragref linkend="highlight.source.frag"&gt;&lt;/src:fragref&gt;
10690 &lt;src:fragref linkend="highlight.xslthl.config.frag"&gt;&lt;/src:fragref&gt;
10691 &lt;src:fragref linkend="html.append.frag"&gt;&lt;/src:fragref&gt;
10692 &lt;src:fragref linkend="html.base.frag"&gt;&lt;/src:fragref&gt;
10693 &lt;src:fragref linkend="html.cellpadding.frag"&gt;&lt;/src:fragref&gt;
10694 &lt;src:fragref linkend="html.cellspacing.frag"&gt;&lt;/src:fragref&gt;
10695 &lt;src:fragref linkend="html.cleanup.frag"&gt;&lt;/src:fragref&gt;
10696 &lt;src:fragref linkend="html.ext.frag"&gt;&lt;/src:fragref&gt;
10697 &lt;src:fragref linkend="html.extra.head.links.frag"&gt;&lt;/src:fragref&gt;
10698 &lt;src:fragref linkend="html.head.legalnotice.link.multiple.frag"&gt;&lt;/src:fragref&gt;
10699 &lt;src:fragref linkend="html.head.legalnotice.link.types.frag"&gt;&lt;/src:fragref&gt;
10700 &lt;src:fragref linkend="html.longdesc.frag"&gt;&lt;/src:fragref&gt;
10701 &lt;src:fragref linkend="html.longdesc.link.frag"&gt;&lt;/src:fragref&gt;
10702 &lt;src:fragref linkend="html.stylesheet.frag"&gt;&lt;/src:fragref&gt;
10703 &lt;src:fragref linkend="html.stylesheet.type.frag"&gt;&lt;/src:fragref&gt;
10704 &lt;src:fragref linkend="htmlhelp.alias.file.frag"&gt;&lt;/src:fragref&gt;
10705 &lt;src:fragref linkend="htmlhelp.autolabel.frag"&gt;&lt;/src:fragref&gt;
10706 &lt;src:fragref linkend="htmlhelp.button.back.frag"&gt;&lt;/src:fragref&gt;
10707 &lt;src:fragref linkend="htmlhelp.button.forward.frag"&gt;&lt;/src:fragref&gt;
10708 &lt;src:fragref linkend="htmlhelp.button.hideshow.frag"&gt;&lt;/src:fragref&gt;
10709 &lt;src:fragref linkend="htmlhelp.button.home.frag"&gt;&lt;/src:fragref&gt;
10710 &lt;src:fragref linkend="htmlhelp.button.home.url.frag"&gt;&lt;/src:fragref&gt;
10711 &lt;src:fragref linkend="htmlhelp.button.jump1.frag"&gt;&lt;/src:fragref&gt;
10712 &lt;src:fragref linkend="htmlhelp.button.jump1.title.frag"&gt;&lt;/src:fragref&gt;
10713 &lt;src:fragref linkend="htmlhelp.button.jump1.url.frag"&gt;&lt;/src:fragref&gt;
10714 &lt;src:fragref linkend="htmlhelp.button.jump2.frag"&gt;&lt;/src:fragref&gt;
10715 &lt;src:fragref linkend="htmlhelp.button.jump2.title.frag"&gt;&lt;/src:fragref&gt;
10716 &lt;src:fragref linkend="htmlhelp.button.jump2.url.frag"&gt;&lt;/src:fragref&gt;
10717 &lt;src:fragref linkend="htmlhelp.button.locate.frag"&gt;&lt;/src:fragref&gt;
10718 &lt;src:fragref linkend="htmlhelp.button.next.frag"&gt;&lt;/src:fragref&gt;
10719 &lt;src:fragref linkend="htmlhelp.button.options.frag"&gt;&lt;/src:fragref&gt;
10720 &lt;src:fragref linkend="htmlhelp.button.prev.frag"&gt;&lt;/src:fragref&gt;
10721 &lt;src:fragref linkend="htmlhelp.button.print.frag"&gt;&lt;/src:fragref&gt;
10722 &lt;src:fragref linkend="htmlhelp.button.refresh.frag"&gt;&lt;/src:fragref&gt;
10723 &lt;src:fragref linkend="htmlhelp.button.stop.frag"&gt;&lt;/src:fragref&gt;
10724 &lt;src:fragref linkend="htmlhelp.button.zoom.frag"&gt;&lt;/src:fragref&gt;
10725 &lt;src:fragref linkend="htmlhelp.chm.frag"&gt;&lt;/src:fragref&gt;
10726 &lt;src:fragref linkend="htmlhelp.default.topic.frag"&gt;&lt;/src:fragref&gt;
10727 &lt;src:fragref linkend="htmlhelp.display.progress.frag"&gt;&lt;/src:fragref&gt;
10728 &lt;src:fragref linkend="htmlhelp.encoding.frag"&gt;&lt;/src:fragref&gt;
10729 &lt;src:fragref linkend="htmlhelp.enhanced.decompilation.frag"&gt;&lt;/src:fragref&gt;
10730 &lt;src:fragref linkend="htmlhelp.enumerate.images.frag"&gt;&lt;/src:fragref&gt;
10731 &lt;src:fragref linkend="htmlhelp.force.map.and.alias.frag"&gt;&lt;/src:fragref&gt;
10732 &lt;src:fragref linkend="htmlhelp.hhc.binary.frag"&gt;&lt;/src:fragref&gt;
10733 &lt;src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"&gt;&lt;/src:fragref&gt;
10734 &lt;src:fragref linkend="htmlhelp.hhc.frag"&gt;&lt;/src:fragref&gt;
10735 &lt;src:fragref linkend="htmlhelp.hhc.section.depth.frag"&gt;&lt;/src:fragref&gt;
10736 &lt;src:fragref linkend="htmlhelp.hhc.show.root.frag"&gt;&lt;/src:fragref&gt;
10737 &lt;src:fragref linkend="htmlhelp.hhc.width.frag"&gt;&lt;/src:fragref&gt;
10738 &lt;src:fragref linkend="htmlhelp.hhk.frag"&gt;&lt;/src:fragref&gt;
10739 &lt;src:fragref linkend="htmlhelp.hhp.frag"&gt;&lt;/src:fragref&gt;
10740 &lt;src:fragref linkend="htmlhelp.hhp.tail.frag"&gt;&lt;/src:fragref&gt;
10741 &lt;src:fragref linkend="htmlhelp.hhp.window.frag"&gt;&lt;/src:fragref&gt;
10742 &lt;src:fragref linkend="htmlhelp.hhp.windows.frag"&gt;&lt;/src:fragref&gt;
10743 &lt;src:fragref linkend="htmlhelp.map.file.frag"&gt;&lt;/src:fragref&gt;
10744 &lt;src:fragref linkend="htmlhelp.only.frag"&gt;&lt;/src:fragref&gt;
10745 &lt;src:fragref linkend="htmlhelp.remember.window.position.frag"&gt;&lt;/src:fragref&gt;
10746 &lt;src:fragref linkend="htmlhelp.show.advanced.search.frag"&gt;&lt;/src:fragref&gt;
10747 &lt;src:fragref linkend="htmlhelp.show.favorities.frag"&gt;&lt;/src:fragref&gt;
10748 &lt;src:fragref linkend="htmlhelp.show.menu.frag"&gt;&lt;/src:fragref&gt;
10749 &lt;src:fragref linkend="htmlhelp.show.toolbar.text.frag"&gt;&lt;/src:fragref&gt;
10750 &lt;src:fragref linkend="htmlhelp.title.frag"&gt;&lt;/src:fragref&gt;
10751 &lt;src:fragref linkend="htmlhelp.use.hhk.frag"&gt;&lt;/src:fragref&gt;
10752 &lt;src:fragref linkend="htmlhelp.window.geometry.frag"&gt;&lt;/src:fragref&gt;
10753 &lt;src:fragref linkend="id.warnings.frag"&gt;&lt;/src:fragref&gt;
10754 &lt;src:fragref linkend="ignore.image.scaling.frag"&gt;&lt;/src:fragref&gt;
10755 &lt;src:fragref linkend="img.src.path.frag"&gt;&lt;/src:fragref&gt;
10756 &lt;src:fragref linkend="index.links.to.section.frag"&gt;&lt;/src:fragref&gt;
10757 &lt;src:fragref linkend="index.method.frag"&gt;&lt;/src:fragref&gt;
10758 &lt;src:fragref linkend="index.number.separator.frag"&gt;&lt;/src:fragref&gt;
10759 &lt;src:fragref linkend="index.on.role.frag"&gt;&lt;/src:fragref&gt;
10760 &lt;src:fragref linkend="index.on.type.frag"&gt;&lt;/src:fragref&gt;
10761 &lt;src:fragref linkend="index.prefer.titleabbrev.frag"&gt;&lt;/src:fragref&gt;
10762 &lt;src:fragref linkend="index.range.separator.frag"&gt;&lt;/src:fragref&gt;
10763 &lt;src:fragref linkend="index.term.separator.frag"&gt;&lt;/src:fragref&gt;
10764 &lt;src:fragref linkend="inherit.keywords.frag"&gt;&lt;/src:fragref&gt;
10765 &lt;src:fragref linkend="insert.olink.page.number.frag"&gt;&lt;/src:fragref&gt;
10766 &lt;src:fragref linkend="insert.olink.pdf.frag.frag"&gt;&lt;/src:fragref&gt;
10767 &lt;src:fragref linkend="insert.xref.page.number.frag"&gt;&lt;/src:fragref&gt;
10768 &lt;src:fragref linkend="javahelp.encoding.frag"&gt;&lt;/src:fragref&gt;
10769 &lt;src:fragref linkend="keep.relative.image.uris.frag"&gt;&lt;/src:fragref&gt;
10770 &lt;src:fragref linkend="l10n.gentext.default.language.frag"&gt;&lt;/src:fragref&gt;
10771 &lt;src:fragref linkend="l10n.gentext.language.frag"&gt;&lt;/src:fragref&gt;
10772 &lt;src:fragref linkend="l10n.gentext.use.xref.language.frag"&gt;&lt;/src:fragref&gt;
10773 &lt;src:fragref linkend="l10n.lang.value.rfc.compliant.frag"&gt;&lt;/src:fragref&gt;
10774 &lt;src:fragref linkend="label.from.part.frag"&gt;&lt;/src:fragref&gt;
10775 &lt;src:fragref linkend="linenumbering.everyNth.frag"&gt;&lt;/src:fragref&gt;
10776 &lt;src:fragref linkend="linenumbering.extension.frag"&gt;&lt;/src:fragref&gt;
10777 &lt;src:fragref linkend="linenumbering.separator.frag"&gt;&lt;/src:fragref&gt;
10778 &lt;src:fragref linkend="linenumbering.width.frag"&gt;&lt;/src:fragref&gt;
10779 &lt;src:fragref linkend="link.mailto.url.frag"&gt;&lt;/src:fragref&gt;
10780 &lt;src:fragref linkend="make.clean.html.frag"&gt;&lt;/src:fragref&gt;
10781 &lt;src:fragref linkend="make.graphic.viewport.frag"&gt;&lt;/src:fragref&gt;
10782 &lt;src:fragref linkend="make.single.year.ranges.frag"&gt;&lt;/src:fragref&gt;
10783 &lt;src:fragref linkend="make.valid.html.frag"&gt;&lt;/src:fragref&gt;
10784 &lt;src:fragref linkend="make.year.ranges.frag"&gt;&lt;/src:fragref&gt;
10785 &lt;src:fragref linkend="manifest.frag"&gt;&lt;/src:fragref&gt;
10786 &lt;src:fragref linkend="manifest.in.base.dir.frag"&gt;&lt;/src:fragref&gt;
10787 &lt;src:fragref linkend="manual.toc.frag"&gt;&lt;/src:fragref&gt;
10788 &lt;src:fragref linkend="menuchoice.menu.separator.frag"&gt;&lt;/src:fragref&gt;
10789 &lt;src:fragref linkend="menuchoice.separator.frag"&gt;&lt;/src:fragref&gt;
10790 &lt;src:fragref linkend="navig.graphics.extension.frag"&gt;&lt;/src:fragref&gt;
10791 &lt;src:fragref linkend="navig.graphics.frag"&gt;&lt;/src:fragref&gt;
10792 &lt;src:fragref linkend="navig.graphics.path.frag"&gt;&lt;/src:fragref&gt;
10793 &lt;src:fragref linkend="navig.showtitles.frag"&gt;&lt;/src:fragref&gt;
10794 &lt;src:fragref linkend="nominal.image.depth.frag"&gt;&lt;/src:fragref&gt;
10795 &lt;src:fragref linkend="nominal.image.width.frag"&gt;&lt;/src:fragref&gt;
10796 &lt;src:fragref linkend="nominal.table.width.frag"&gt;&lt;/src:fragref&gt;
10797 &lt;src:fragref linkend="olink.base.uri.frag"&gt;&lt;/src:fragref&gt;
10798 &lt;src:fragref linkend="olink.debug.frag"&gt;&lt;/src:fragref&gt;
10799 &lt;src:fragref linkend="olink.doctitle.frag"&gt;&lt;/src:fragref&gt;
10800 &lt;src:fragref linkend="olink.fragid.frag"&gt;&lt;/src:fragref&gt;
10801 &lt;src:fragref linkend="olink.lang.fallback.sequence.frag"&gt;&lt;/src:fragref&gt;
10802 &lt;src:fragref linkend="olink.outline.ext.frag"&gt;&lt;/src:fragref&gt;
10803 &lt;src:fragref linkend="olink.properties.frag"&gt;&lt;/src:fragref&gt;
10804 &lt;src:fragref linkend="olink.pubid.frag"&gt;&lt;/src:fragref&gt;
10805 &lt;src:fragref linkend="olink.resolver.frag"&gt;&lt;/src:fragref&gt;
10806 &lt;src:fragref linkend="olink.sysid.frag"&gt;&lt;/src:fragref&gt;
10807 &lt;src:fragref linkend="othercredit.like.author.enabled.frag"&gt;&lt;/src:fragref&gt;
10808 &lt;src:fragref linkend="para.propagates.style.frag"&gt;&lt;/src:fragref&gt;
10809 &lt;src:fragref linkend="part.autolabel.frag"&gt;&lt;/src:fragref&gt;
10810 &lt;src:fragref linkend="phrase.propagates.style.frag"&gt;&lt;/src:fragref&gt;
10811 &lt;src:fragref linkend="pixels.per.inch.frag"&gt;&lt;/src:fragref&gt;
10812 &lt;src:fragref linkend="points.per.em.frag"&gt;&lt;/src:fragref&gt;
10813 &lt;src:fragref linkend="preface.autolabel.frag"&gt;&lt;/src:fragref&gt;
10814 &lt;src:fragref linkend="prefer.internal.olink.frag"&gt;&lt;/src:fragref&gt;
10815 &lt;src:fragref linkend="preferred.mediaobject.role.frag"&gt;&lt;/src:fragref&gt;
10816 &lt;src:fragref linkend="process.empty.source.toc.frag"&gt;&lt;/src:fragref&gt;
10817 &lt;src:fragref linkend="process.source.toc.frag"&gt;&lt;/src:fragref&gt;
10818 &lt;src:fragref linkend="profile.arch.frag"&gt;&lt;/src:fragref&gt;
10819 &lt;src:fragref linkend="profile.attribute.frag"&gt;&lt;/src:fragref&gt;
10820 &lt;src:fragref linkend="profile.audience.frag"&gt;&lt;/src:fragref&gt;
10821 &lt;src:fragref linkend="profile.condition.frag"&gt;&lt;/src:fragref&gt;
10822 &lt;src:fragref linkend="profile.conformance.frag"&gt;&lt;/src:fragref&gt;
10823 &lt;src:fragref linkend="profile.lang.frag"&gt;&lt;/src:fragref&gt;
10824 &lt;src:fragref linkend="profile.os.frag"&gt;&lt;/src:fragref&gt;
10825 &lt;src:fragref linkend="profile.revision.frag"&gt;&lt;/src:fragref&gt;
10826 &lt;src:fragref linkend="profile.revisionflag.frag"&gt;&lt;/src:fragref&gt;
10827 &lt;src:fragref linkend="profile.role.frag"&gt;&lt;/src:fragref&gt;
10828 &lt;src:fragref linkend="profile.security.frag"&gt;&lt;/src:fragref&gt;
10829 &lt;src:fragref linkend="profile.separator.frag"&gt;&lt;/src:fragref&gt;
10830 &lt;src:fragref linkend="profile.status.frag"&gt;&lt;/src:fragref&gt;
10831 &lt;src:fragref linkend="profile.userlevel.frag"&gt;&lt;/src:fragref&gt;
10832 &lt;src:fragref linkend="profile.value.frag"&gt;&lt;/src:fragref&gt;
10833 &lt;src:fragref linkend="profile.vendor.frag"&gt;&lt;/src:fragref&gt;
10834 &lt;src:fragref linkend="profile.wordsize.frag"&gt;&lt;/src:fragref&gt;
10835 &lt;src:fragref linkend="punct.honorific.frag"&gt;&lt;/src:fragref&gt;
10836 &lt;src:fragref linkend="qanda.defaultlabel.frag"&gt;&lt;/src:fragref&gt;
10837 &lt;src:fragref linkend="qanda.in.toc.frag"&gt;&lt;/src:fragref&gt;
10838 &lt;src:fragref linkend="qanda.inherit.numeration.frag"&gt;&lt;/src:fragref&gt;
10839 &lt;src:fragref linkend="qanda.nested.in.toc.frag"&gt;&lt;/src:fragref&gt;
10840 &lt;src:fragref linkend="qandadiv.autolabel.frag"&gt;&lt;/src:fragref&gt;
10841 &lt;src:fragref linkend="refclass.suppress.frag"&gt;&lt;/src:fragref&gt;
10842 &lt;src:fragref linkend="refentry.generate.name.frag"&gt;&lt;/src:fragref&gt;
10843 &lt;src:fragref linkend="refentry.generate.title.frag"&gt;&lt;/src:fragref&gt;
10844 &lt;src:fragref linkend="refentry.separator.frag"&gt;&lt;/src:fragref&gt;
10845 &lt;src:fragref linkend="refentry.xref.manvolnum.frag"&gt;&lt;/src:fragref&gt;
10846 &lt;src:fragref linkend="reference.autolabel.frag"&gt;&lt;/src:fragref&gt;
10847 &lt;src:fragref linkend="root.filename.frag"&gt;&lt;/src:fragref&gt;
10848 &lt;src:fragref linkend="rootid.frag"&gt;&lt;/src:fragref&gt;
10849 &lt;src:fragref linkend="runinhead.default.title.end.punct.frag"&gt;&lt;/src:fragref&gt;
10850 &lt;src:fragref linkend="runinhead.title.end.punct.frag"&gt;&lt;/src:fragref&gt;
10851 &lt;src:fragref linkend="section.autolabel.frag"&gt;&lt;/src:fragref&gt;
10852 &lt;src:fragref linkend="section.autolabel.max.depth.frag"&gt;&lt;/src:fragref&gt;
10853 &lt;src:fragref linkend="section.label.includes.component.label.frag"&gt;&lt;/src:fragref&gt;
10854 &lt;src:fragref linkend="segmentedlist.as.table.frag"&gt;&lt;/src:fragref&gt;
10855 &lt;src:fragref linkend="shade.verbatim.frag"&gt;&lt;/src:fragref&gt;
10856 &lt;src:fragref linkend="shade.verbatim.style.frag"&gt;&lt;/src:fragref&gt;
10857 &lt;src:fragref linkend="show.comments.frag"&gt;&lt;/src:fragref&gt;
10858 &lt;src:fragref linkend="show.revisionflag.frag"&gt;&lt;/src:fragref&gt;
10859 &lt;src:fragref linkend="simplesect.in.toc.frag"&gt;&lt;/src:fragref&gt;
10860 &lt;src:fragref linkend="spacing.paras.frag"&gt;&lt;/src:fragref&gt;
10861 &lt;src:fragref linkend="suppress.footer.navigation.frag"&gt;&lt;/src:fragref&gt;
10862 &lt;src:fragref linkend="suppress.header.navigation.frag"&gt;&lt;/src:fragref&gt;
10863 &lt;src:fragref linkend="suppress.navigation.frag"&gt;&lt;/src:fragref&gt;
10864 &lt;src:fragref linkend="table.borders.with.css.frag"&gt;&lt;/src:fragref&gt;
10865 &lt;src:fragref linkend="table.cell.border.color.frag"&gt;&lt;/src:fragref&gt;
10866 &lt;src:fragref linkend="table.cell.border.style.frag"&gt;&lt;/src:fragref&gt;
10867 &lt;src:fragref linkend="table.cell.border.thickness.frag"&gt;&lt;/src:fragref&gt;
10868 &lt;src:fragref linkend="table.footnote.number.format.frag"&gt;&lt;/src:fragref&gt;
10869 &lt;src:fragref linkend="table.footnote.number.symbols.frag"&gt;&lt;/src:fragref&gt;
10870 &lt;src:fragref linkend="table.frame.border.color.frag"&gt;&lt;/src:fragref&gt;
10871 &lt;src:fragref linkend="table.frame.border.style.frag"&gt;&lt;/src:fragref&gt;
10872 &lt;src:fragref linkend="table.frame.border.thickness.frag"&gt;&lt;/src:fragref&gt;
10873 &lt;src:fragref linkend="tablecolumns.extension.frag"&gt;&lt;/src:fragref&gt;
10874 &lt;src:fragref linkend="target.database.document.frag"&gt;&lt;/src:fragref&gt;
10875 &lt;src:fragref linkend="targets.filename.frag"&gt;&lt;/src:fragref&gt;
10876 &lt;src:fragref linkend="tex.math.delims.frag"&gt;&lt;/src:fragref&gt;
10877 &lt;src:fragref linkend="tex.math.file.frag"&gt;&lt;/src:fragref&gt;
10878 &lt;src:fragref linkend="tex.math.in.alt.frag"&gt;&lt;/src:fragref&gt;
10879 &lt;src:fragref linkend="textdata.default.encoding.frag"&gt;&lt;/src:fragref&gt;
10880 &lt;src:fragref linkend="textinsert.extension.frag"&gt;&lt;/src:fragref&gt;
10881 &lt;src:fragref linkend="toc.list.type.frag"&gt;&lt;/src:fragref&gt;
10882 &lt;src:fragref linkend="toc.max.depth.frag"&gt;&lt;/src:fragref&gt;
10883 &lt;src:fragref linkend="toc.section.depth.frag"&gt;&lt;/src:fragref&gt;
10884 &lt;src:fragref linkend="ulink.target.frag"&gt;&lt;/src:fragref&gt;
10885 &lt;src:fragref linkend="use.embed.for.svg.frag"&gt;&lt;/src:fragref&gt;
10886 &lt;src:fragref linkend="use.extensions.frag"&gt;&lt;/src:fragref&gt;
10887 &lt;src:fragref linkend="use.id.as.filename.frag"&gt;&lt;/src:fragref&gt;
10888 &lt;src:fragref linkend="use.local.olink.style.frag"&gt;&lt;/src:fragref&gt;
10889 &lt;src:fragref linkend="use.role.as.xrefstyle.frag"&gt;&lt;/src:fragref&gt;
10890 &lt;src:fragref linkend="use.role.for.mediaobject.frag"&gt;&lt;/src:fragref&gt;
10891 &lt;src:fragref linkend="use.svg.frag"&gt;&lt;/src:fragref&gt;
10892 &lt;src:fragref linkend="variablelist.as.table.frag"&gt;&lt;/src:fragref&gt;
10893 &lt;src:fragref linkend="variablelist.term.break.after.frag"&gt;&lt;/src:fragref&gt;
10894 &lt;src:fragref linkend="variablelist.term.separator.frag"&gt;&lt;/src:fragref&gt;
10895 &lt;src:fragref linkend="writing.mode.frag"&gt;&lt;/src:fragref&gt;
10896 &lt;src:fragref linkend="xref.label-page.separator.frag"&gt;&lt;/src:fragref&gt;
10897 &lt;src:fragref linkend="xref.label-title.separator.frag"&gt;&lt;/src:fragref&gt;
10898 &lt;src:fragref linkend="xref.title-page.separator.frag"&gt;&lt;/src:fragref&gt;
10899 &lt;src:fragref linkend="xref.with.number.and.title.frag"&gt;&lt;/src:fragref&gt;
10900
10901 &lt;/xsl:stylesheet&gt;
10902 </programlisting>
10903
10904 </appendix>
10905 </book>