1<?xml version="1.0" encoding="utf-8"?> 2<!DOCTYPE book 3 PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 4<book> 5<bookinfo> 6<title>HTML Parameter Reference</title> 7<releaseinfo role="meta"> 8$Id: param.xweb,v 1.103 2006/05/14 06:22:26 bobstayton Exp $ 9</releaseinfo> 10<author> 11 <surname>Walsh</surname> 12 <firstname>Norman</firstname> 13</author> 14<copyright> 15 <year>1999</year> 16 <year>2000</year> 17 <year>2001</year> 18 <holder>Norman Walsh</holder> 19</copyright> 20</bookinfo> 21 22<preface><title>Introduction</title> 23 24<para>This is reference documentation for all user-configurable 25parameters in the DocBook XSL HTML stylesheets (for generating 26HTML output).</para> 27 28<para>This reference describes each of the HTML Stylesheet parameters. 29These are the <quote>easily customizable</quote> parts of the stylesheet. 30If you want to specify an alternate value for one or more of these 31parameters, you can do so in a <quote>driver</quote> stylesheet.</para> 32 33<para>For example, if you want to change the <literal>html.stylesheet</literal> 34to <filename>reference.css</filename>, you might create a driver 35stylesheet like this:</para> 36 37<programlisting><xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 38 version='1.0'> 39 40 <xsl:import href="http://docbook.sourceforge.net/release/xsl/snapshot/html/docbook.xsl"/> 41 42 <xsl:param name="html.stylesheet">reference.css</xsl:param> 43 44</xsl:stylesheet></programlisting> 45 46<para>Naturally, you have to change the 47<sgmltag class="attribute">href</sgmltag> attribute on 48<literal><xsl:import></literal> to point to 49<filename>docbook.xsl</filename> on your system. (Or 50<filename>chunk.xsl</filename>, if you're using chunking.)</para> 51</preface> 52 53<reference id="admons"><title>Admonitions</title> 54<refentry id="admon.graphics.extension"> 55<refmeta> 56<refentrytitle>admon.graphics.extension</refentrytitle> 57<refmiscinfo role="type">string</refmiscinfo> 58</refmeta> 59<refnamediv> 60<refname>admon.graphics.extension</refname> 61<refpurpose>Extension for admonition graphics</refpurpose> 62</refnamediv> 63 64<refsynopsisdiv> 65<programlisting id="admon.graphics.extension.frag"><xsl:param name="admon.graphics.extension" select="'.png'"></xsl:param></programlisting> 66</refsynopsisdiv> 67 68<refsect1><title>Description</title> 69 70<para>Sets the extension to use on admonition graphics.</para> 71 72</refsect1> 73</refentry> 74 75<refentry id="admon.graphics.path"> 76<refmeta> 77<refentrytitle>admon.graphics.path</refentrytitle> 78<refmiscinfo role="type">string</refmiscinfo> 79</refmeta> 80<refnamediv> 81<refname>admon.graphics.path</refname> 82<refpurpose>Path to admonition graphics</refpurpose> 83</refnamediv> 84 85<refsynopsisdiv> 86<programlisting id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting> 87</refsynopsisdiv> 88 89<refsect1><title>Description</title> 90 91<para>Sets the path, probably relative to the directory where the HTML 92files are created, to the admonition graphics. 93</para> 94 95</refsect1> 96</refentry> 97 98<refentry id="admon.graphics"> 99<refmeta> 100<refentrytitle>admon.graphics</refentrytitle> 101<refmiscinfo role="type">boolean</refmiscinfo> 102</refmeta> 103<refnamediv> 104<refname>admon.graphics</refname> 105<refpurpose>Use graphics in admonitions?</refpurpose> 106</refnamediv> 107 108<refsynopsisdiv> 109<programlisting id="admon.graphics.frag"> 110<xsl:param name="admon.graphics" select="0"></xsl:param> 111</programlisting> 112</refsynopsisdiv> 113 114<refsect1><title>Description</title> 115 116<para>If true (non-zero), admonitions are presented in an alternate style that uses 117a graphic. Default graphics are provided in the distribution. 118</para> 119 120</refsect1> 121</refentry> 122 123<refentry id="admon.textlabel"> 124<refmeta> 125<refentrytitle>admon.textlabel</refentrytitle> 126<refmiscinfo role="type">boolean</refmiscinfo> 127</refmeta> 128<refnamediv> 129<refname>admon.textlabel</refname> 130<refpurpose>Use text label in admonitions?</refpurpose> 131</refnamediv> 132 133<refsynopsisdiv> 134<programlisting id="admon.textlabel.frag"> 135<xsl:param name="admon.textlabel" select="1"></xsl:param> 136</programlisting> 137</refsynopsisdiv> 138 139<refsect1><title>Description</title> 140 141<para>If true (non-zero), admonitions are presented with a generated 142text label such as Note or Warning in the appropriate language. 143If zero, such labels are turned off, but any title child 144of the admonition element are still output. 145The default value is 1. 146</para> 147 148</refsect1> 149</refentry> 150 151 152<refentry id="admon.style"> 153<refmeta> 154<refentrytitle>admon.style</refentrytitle> 155<refmiscinfo role="type">string</refmiscinfo> 156</refmeta> 157<refnamediv> 158<refname>admon.style</refname> 159<refpurpose>CSS style attributes for admonitions</refpurpose> 160</refnamediv> 161 162<refsynopsisdiv> 163<programlisting id="admon.style.frag"><xsl:param name="admon.style"> 164 <xsl:text>margin-left: 0.5in; margin-right: 0.5in;</xsl:text> 165</xsl:param></programlisting> 166</refsynopsisdiv> 167 168<refsect1><title>Description</title> 169 170<para>Specifies the value of the <sgmltag class="attribute">STYLE</sgmltag> 171attribute that should be added to admonitions. 172</para> 173 174</refsect1> 175</refentry> 176 177</reference> 178 179<reference id="callouts"><title>Callouts</title> 180<refentry id="callout.defaultcolumn"> 181<refmeta> 182<refentrytitle>callout.defaultcolumn</refentrytitle> 183<refmiscinfo role="type">integer</refmiscinfo> 184</refmeta> 185<refnamediv> 186<refname>callout.defaultcolumn</refname> 187<refpurpose>Indicates what column callouts appear in by default</refpurpose> 188</refnamediv> 189 190<refsynopsisdiv> 191<programlisting id="callout.defaultcolumn.frag"><xsl:param name="callout.defaultcolumn" select="'60'"></xsl:param></programlisting> 192</refsynopsisdiv> 193 194<refsect1><title>Description</title> 195 196<para>If a callout does not identify a column (for example, if it uses 197the <literal>linerange</literal> <sgmltag class="attribute">unit</sgmltag>), 198it will appear in the default column. 199</para> 200 201</refsect1> 202</refentry> 203 204<refentry id="callout.graphics.extension"> 205<refmeta> 206<refentrytitle>callout.graphics.extension</refentrytitle> 207<refmiscinfo role="type">string</refmiscinfo> 208</refmeta> 209<refnamediv> 210<refname>callout.graphics.extension</refname> 211<refpurpose>Extension for callout graphics</refpurpose> 212</refnamediv> 213 214<refsynopsisdiv> 215<programlisting id="callout.graphics.extension.frag"><xsl:param name="callout.graphics.extension" select="'.png'"></xsl:param></programlisting> 216</refsynopsisdiv> 217 218<refsect1><title>Description</title> 219 220<para>Sets the extension to use on callout graphics.</para> 221 222</refsect1> 223</refentry> 224 225<refentry id="callout.graphics.number.limit"> 226<refmeta> 227<refentrytitle>callout.graphics.number.limit</refentrytitle> 228<refmiscinfo role="type">integer</refmiscinfo> 229</refmeta> 230<refnamediv> 231<refname>callout.graphics.number.limit</refname> 232<refpurpose>Number of the largest callout graphic</refpurpose> 233</refnamediv> 234 235<refsynopsisdiv> 236<programlisting id="callout.graphics.number.limit.frag"><xsl:param name="callout.graphics.number.limit" select="'15'"></xsl:param></programlisting> 237</refsynopsisdiv> 238 239<refsect1><title>Description</title> 240 241<para>If <parameter>callout.graphics</parameter> 242is non-zero, graphics are used to represent 243callout numbers. The value of 244<parameter>callout.graphics.number.limit</parameter> 245is 246the largest number for which a graphic exists. If the callout number 247exceeds this limit, the default presentation "(nnn)" will always 248be used. 249</para> 250 251</refsect1> 252</refentry> 253 254<refentry id="callout.graphics.path"> 255<refmeta> 256<refentrytitle>callout.graphics.path</refentrytitle> 257<refmiscinfo role="type">string</refmiscinfo> 258</refmeta> 259<refnamediv> 260<refname>callout.graphics.path</refname> 261<refpurpose>Path to callout graphics</refpurpose> 262</refnamediv> 263 264<refsynopsisdiv> 265<programlisting id="callout.graphics.path.frag"> 266<xsl:param name="callout.graphics.path" select="'images/callouts/'"></xsl:param> 267</programlisting> 268</refsynopsisdiv> 269 270<refsect1><title>Description</title> 271 272<para>Sets the path, probably relative to the directory where the HTML 273files are created, to the callout graphics. 274</para> 275 276</refsect1> 277</refentry> 278 279<refentry id="callout.graphics"> 280<refmeta> 281<refentrytitle>callout.graphics</refentrytitle> 282<refmiscinfo role="type">boolean</refmiscinfo> 283</refmeta> 284<refnamediv> 285<refname>callout.graphics</refname> 286<refpurpose>Use graphics for callouts?</refpurpose> 287</refnamediv> 288 289<refsynopsisdiv> 290<programlisting id="callout.graphics.frag"> 291<xsl:param name="callout.graphics" select="'1'"></xsl:param> 292</programlisting> 293</refsynopsisdiv> 294 295<refsect1><title>Description</title> 296 297<para>If non-zero, callouts are presented with graphics (e.g., reverse-video 298circled numbers instead of "(1)", "(2)", etc.). 299Default graphics are provided in the distribution. 300</para> 301 302</refsect1> 303</refentry> 304 305<refentry id="callout.list.table"> 306<refmeta> 307<refentrytitle>callout.list.table</refentrytitle> 308<refmiscinfo role="type">boolean</refmiscinfo> 309</refmeta> 310<refnamediv> 311<refname>callout.list.table</refname> 312<refpurpose>Present callout lists using a table?</refpurpose> 313</refnamediv> 314 315<refsynopsisdiv> 316<programlisting id="callout.list.table.frag"><xsl:param name="callout.list.table" select="'1'"></xsl:param></programlisting> 317</refsynopsisdiv> 318 319<refsect1><title>Description</title> 320 321<para>The default presentation of <sgmltag>CalloutList</sgmltag>s uses 322an HTML <sgmltag>DL</sgmltag>. Some browsers don't align DLs very well 323if <parameter>callout.graphics</parameter> are used. With this option 324turned on, <sgmltag>CalloutList</sgmltag>s are presented in an HTML 325<sgmltag>TABLE</sgmltag>, which usually results in better alignment 326of the callout number with the callout description.</para> 327 328</refsect1> 329</refentry> 330 331<refentry id="callout.unicode.number.limit"> 332<refmeta> 333<refentrytitle>callout.unicode.number.limit</refentrytitle> 334<refmiscinfo role="type">integer</refmiscinfo> 335</refmeta> 336<refnamediv> 337<refname>callout.unicode.number.limit</refname> 338<refpurpose>Number of the largest callout graphic</refpurpose> 339</refnamediv> 340 341<refsynopsisdiv> 342<programlisting id="callout.unicode.number.limit.frag"><xsl:param name="callout.unicode.number.limit" select="'10'"></xsl:param></programlisting> 343</refsynopsisdiv> 344 345<refsect1><title>Description</title> 346 347<para>If <parameter>callout.unicode</parameter> 348is non-zero, unicode characters are used to represent 349callout numbers. The value of 350<parameter>callout.unicode.number.limit</parameter> 351is 352the largest number for which a unicode character exists. If the callout number 353exceeds this limit, the default presentation "(nnn)" will always 354be used. 355</para> 356 357</refsect1> 358</refentry> 359 360<refentry id="callout.unicode.start.character"> 361<refmeta> 362<refentrytitle>callout.unicode.start.character</refentrytitle> 363<refmiscinfo role="type">integer</refmiscinfo> 364</refmeta> 365<refnamediv> 366<refname>callout.unicode.start.character</refname> 367<refpurpose>First Unicode character to use, decimal value.</refpurpose> 368</refnamediv> 369 370<refsynopsisdiv> 371<programlisting id="callout.unicode.start.character.frag"><xsl:param name="callout.unicode.start.character" select="10102"></xsl:param></programlisting> 372</refsynopsisdiv> 373 374<refsect1><title>Description</title> 375 376<para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter> 377is non-zero, unicode characters are used to represent 378callout numbers. The value of 379<parameter>callout.unicode.start.character</parameter> 380is the decimal unicode value used for callout number one. Currently, 381only 10102 is supported in the stylesheets for this parameter. 382</para> 383 384</refsect1> 385</refentry> 386 387<refentry id="callout.unicode"> 388<refmeta> 389<refentrytitle>callout.unicode</refentrytitle> 390<refmiscinfo role="type">boolean</refmiscinfo> 391</refmeta> 392<refnamediv> 393<refname>callout.unicode</refname> 394<refpurpose>Use Unicode characters rather than images for callouts.</refpurpose> 395</refnamediv> 396 397<refsynopsisdiv> 398<programlisting id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting> 399</refsynopsisdiv> 400 401<refsect1><title>Description</title> 402 403<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. 404</para> 405 406</refsect1> 407</refentry> 408 409<refentry id="callouts.extension"> 410<refmeta> 411<refentrytitle>callouts.extension</refentrytitle> 412<refmiscinfo role="type">boolean</refmiscinfo> 413</refmeta> 414<refnamediv> 415<refname>callouts.extension</refname> 416<refpurpose>Enable the callout extension</refpurpose> 417</refnamediv> 418 419<refsynopsisdiv> 420<programlisting id="callouts.extension.frag"><xsl:param name="callouts.extension" select="'1'"></xsl:param></programlisting> 421</refsynopsisdiv> 422 423<refsect1><title>Description</title> 424 425<para>The callouts extension processes <sgmltag>areaset</sgmltag> 426elements in <sgmltag>ProgramListingCO</sgmltag> and other text-based 427callout elements. 428</para> 429 430</refsect1> 431</refentry> 432 433</reference> 434 435<reference id="ebnf"><title>EBNF</title> 436<refentry id="ebnf.table.bgcolor"> 437<refmeta> 438<refentrytitle>ebnf.table.bgcolor</refentrytitle> 439<refmiscinfo role="type">string</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 id="ebnf.table.bgcolor.frag"><xsl:param name="ebnf.table.bgcolor" select="'#F5DCB3'"></xsl:param></programlisting> 448</refsynopsisdiv> 449 450<refsect1><title>Description</title> 451 452<para>Sets the background color for EBNF tables. No <sgmltag>bgcolor</sgmltag> 453attribute is output if <varname>ebnf.table.bgcolor</varname> is set to 454the null string. The default value matches the value used in recent 455online versions of the W3C's XML Spec productions.</para> 456 457</refsect1> 458</refentry> 459 460<refentry id="ebnf.table.border"> 461<refmeta> 462<refentrytitle>ebnf.table.border</refentrytitle> 463<refmiscinfo role="type"/> 464</refmeta> 465<refnamediv> 466<refname>ebnf.table.border</refname> 467<refpurpose>Selects border on EBNF tables</refpurpose> 468</refnamediv> 469 470<refsynopsisdiv> 471<programlisting id="ebnf.table.border.frag"><xsl:param name="ebnf.table.border" select="1"></xsl:param></programlisting> 472</refsynopsisdiv> 473 474<refsect1><title>Description</title> 475 476<para>Selects the border on EBNF tables. If non-zero, the tables have 477borders, otherwise they don't.</para> 478 479</refsect1> 480</refentry> 481 482<refentry id="ebnf.assignment"> 483<refmeta> 484<refentrytitle>ebnf.assignment</refentrytitle> 485<refmiscinfo role="type">rtf</refmiscinfo> 486</refmeta> 487<refnamediv> 488<refname>ebnf.assignment</refname> 489<refpurpose>The EBNF production assignment operator</refpurpose> 490</refnamediv> 491 492<refsynopsisdiv> 493<programlisting id="ebnf.assignment.frag"> 494<xsl:param name="ebnf.assignment"> 495<code>::=</code> 496</xsl:param> 497 498</programlisting> 499</refsynopsisdiv> 500 501<refsect1><title>Description</title> 502 503<para>The <parameter>ebnf.assignment</parameter> parameter determines what 504text is used to show <quote>assignment</quote> in <sgmltag>production</sgmltag>s 505in <sgmltag>productionset</sgmltag>s.</para> 506 507<para>While <quote><literal>::=</literal></quote> is common, so are several 508other operators.</para> 509 510</refsect1> 511</refentry> 512 513<refentry id="ebnf.statement.terminator"> 514<refmeta> 515<refentrytitle>ebnf.statement.terminator</refentrytitle> 516<refmiscinfo role="type">rtf</refmiscinfo> 517</refmeta> 518<refnamediv> 519<refname>ebnf.statement.terminator</refname> 520<refpurpose>Punctuation that ends an EBNF statement.</refpurpose> 521</refnamediv> 522 523<refsynopsisdiv> 524<programlisting id="ebnf.statement.terminator.frag"> 525<xsl:param name="ebnf.statement.terminator"></xsl:param> 526 527</programlisting> 528</refsynopsisdiv> 529 530<refsect1><title>Description</title> 531 532<para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what 533text is used to terminate each <sgmltag>production</sgmltag> 534in <sgmltag>productionset</sgmltag>.</para> 535 536<para>Some notations end each statement with a period.</para> 537 538</refsect1> 539</refentry> 540 541</reference> 542 543<reference id="toc_index"><title>ToC/LoT/Index Generation</title> 544<refentry id="annotate.toc"> 545<refmeta> 546<refentrytitle>annotate.toc</refentrytitle> 547<refmiscinfo role="type">boolean</refmiscinfo> 548</refmeta> 549<refnamediv> 550<refname>annotate.toc</refname> 551<refpurpose>Annotate the Table of Contents?</refpurpose> 552</refnamediv> 553 554<refsynopsisdiv> 555<programlisting id="annotate.toc.frag"><xsl:param name="annotate.toc" select="1"></xsl:param></programlisting> 556</refsynopsisdiv> 557 558<refsect1><title>Description</title> 559 560<para>If true, TOCs will be annotated. At present, this just means 561that the <sgmltag>RefPurpose</sgmltag> of <sgmltag>RefEntry</sgmltag> 562TOC entries will be displayed. 563</para> 564 565</refsect1> 566</refentry> 567 568<refentry id="autotoc.label.separator"> 569<refmeta> 570<refentrytitle>autotoc.label.separator</refentrytitle> 571<refmiscinfo role="type">string</refmiscinfo> 572</refmeta> 573<refnamediv> 574<refname>autotoc.label.separator</refname> 575<refpurpose>Separator between labels and titles in the ToC</refpurpose> 576</refnamediv> 577 578<refsynopsisdiv> 579<programlisting id="autotoc.label.separator.frag"><xsl:param name="autotoc.label.separator" select="'. '"></xsl:param></programlisting> 580</refsynopsisdiv> 581 582<refsect1><title>Description</title> 583 584<para>String to use to seperate labels and title in a table of contents.</para> 585 586</refsect1> 587</refentry> 588 589<refentry id="autotoc.label.in.hyperlink"> 590<refmeta> 591<refentrytitle>autotoc.label.in.hyperlink</refentrytitle> 592<refmiscinfo role="type">boolean</refmiscinfo> 593</refmeta> 594<refnamediv> 595<refname>autotoc.label.in.hyperlink</refname> 596<refpurpose>Include lable in hyperlinked titles in TOC?</refpurpose> 597</refnamediv> 598 599<refsynopsisdiv> 600<programlisting id="autotoc.label.in.hyperlink.frag"><xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param></programlisting> 601</refsynopsisdiv> 602 603<refsect1><title>Description</title> 604 605<para>If the value of 606<parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels 607are included in hyperlinked titles in the TOC. If it is instead zero, 608labels are still displayed prior to the hyperlinked titles, but 609are not hyperlinked along with the titles.</para> 610 611</refsect1> 612</refentry> 613 614<refentry id="process.source.toc"> 615<refmeta> 616<refentrytitle>process.source.toc</refentrytitle> 617<refmiscinfo role="type">boolean</refmiscinfo> 618</refmeta> 619<refnamediv> 620<refname>process.source.toc</refname> 621<refpurpose>Process a non-empty <sgmltag>toc</sgmltag> element if it occurs in a source document?</refpurpose> 622</refnamediv> 623 624<refsynopsisdiv> 625<programlisting id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting> 626</refsynopsisdiv> 627 628<refsect1><title>Description</title> 629 630<para>Specifies that the contents of a non-empty "hard-coded" 631<sgmltag>toc</sgmltag> element in a source document are processed to 632generate a TOC in output. 633<note> 634 <para>This parameter has no effect on automated generation of 635 TOCs. An automated TOC may still be generated along with the 636 "hard-coded" TOC. To suppress automated TOC generation, adjust the 637 value of the <parameter>generate.toc</parameter> paramameter.</para> 638 639 <para>The <sgmltag>process.source.toc</sgmltag> parameter also has 640 no effect if the <sgmltag>toc</sgmltag> element is empty; handling 641 for empty <sgmltag>toc</sgmltag> is controlled by the 642 <parameter>process.empty.source.toc</parameter> parameter.</para> 643</note> 644</para> 645 646</refsect1> 647</refentry> 648 649<refentry id="process.empty.source.toc"> 650<refmeta> 651<refentrytitle>process.empty.source.toc</refentrytitle> 652<refmiscinfo role="type">boolean</refmiscinfo> 653</refmeta> 654<refnamediv> 655<refname>process.empty.source.toc</refname> 656<refpurpose>Generate automated TOC if <sgmltag>toc</sgmltag> element occurs in a source document?</refpurpose> 657</refnamediv> 658 659<refsynopsisdiv> 660<programlisting id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting> 661</refsynopsisdiv> 662 663<refsect1><title>Description</title> 664 665<para>Specifies that if an empty <sgmltag>toc</sgmltag> element is 666found in a source document, an automated TOC is generated. 667<note> 668 <para>Depending on what the value of the 669 <parameter>generate.toc</parameter> parameter is, setting this 670 parameter to <literal>1</literal> could result in generation of 671 duplicate automated TOCs. So the 672 <parameter>process.empty.source.toc</parameter> is primarily useful 673 as an "override": by placing an empty <sgmltag>toc</sgmltag> in your 674 document and setting this parameter to <literal>1</literal>, you can 675 force a TOC to be generated even if <sgmltag>generate.toc</sgmltag> 676 says not to.</para> 677</note> 678</para> 679 680</refsect1> 681</refentry> 682 683<refentry id="bridgehead.in.toc"> 684<refmeta> 685<refentrytitle>bridgehead.in.toc</refentrytitle> 686<refmiscinfo role="type">boolean</refmiscinfo> 687</refmeta> 688<refnamediv> 689<refname>bridgehead.in.toc</refname> 690<refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> 691</refnamediv> 692 693<refsynopsisdiv> 694<programlisting id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting> 695</refsynopsisdiv> 696 697<refsect1><title>Description</title> 698 699<para>If non-zero, bridgeheads appear in the TOC. Note that this option 700is not fully supported and may be removed in a future version of the 701stylesheets. 702</para> 703 704</refsect1> 705</refentry> 706 707<refentry id="simplesect.in.toc"> 708<refmeta> 709<refentrytitle>simplesect.in.toc</refentrytitle> 710<refmiscinfo role="type">boolean</refmiscinfo> 711</refmeta> 712<refnamediv> 713<refname>simplesect.in.toc</refname> 714<refpurpose>Should <sgmltag>simplesect</sgmltag> elements appear in the TOC?</refpurpose> 715</refnamediv> 716 717<refsynopsisdiv> 718<programlisting id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting> 719</refsynopsisdiv> 720 721<refsect1><title>Description</title> 722 723<para>If non-zero, <sgmltag>simplesect</sgmltag>s appear in the TOC. 724</para> 725 726</refsect1> 727</refentry> 728 729<refentry id="manual.toc"> 730<refmeta> 731<refentrytitle>manual.toc</refentrytitle> 732<refmiscinfo role="type">string</refmiscinfo> 733</refmeta> 734<refnamediv> 735<refname>manual.toc</refname> 736<refpurpose>An explicit TOC to be used for the TOC</refpurpose> 737</refnamediv> 738 739<refsynopsisdiv> 740<programlisting id="manual.toc.frag"> 741<xsl:param name="manual.toc" select="''"></xsl:param> 742</programlisting> 743</refsynopsisdiv> 744 745<refsect1><title>Description</title> 746 747<para>The <parameter>manual.toc</parameter> identifies an explicit TOC that 748will be used for building the printed TOC. 749</para> 750 751</refsect1> 752</refentry> 753 754<refentry id="toc.list.type"> 755<refmeta> 756<refentrytitle>toc.list.type</refentrytitle> 757<refmiscinfo role="type">list</refmiscinfo> 758<refmiscinfo role="value">dl</refmiscinfo> 759<refmiscinfo role="value">ul</refmiscinfo> 760<refmiscinfo role="value">ol</refmiscinfo> 761</refmeta> 762<refnamediv> 763<refname>toc.list.type</refname> 764<refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> 765</refnamediv> 766 767<refsynopsisdiv> 768<programlisting id="toc.list.type.frag"><xsl:param name="toc.list.type">dl</xsl:param></programlisting> 769</refsynopsisdiv> 770 771<refsect1><title>Description</title> 772 773<para>When an automatically generated Table of Contents (or List of Titles) 774is produced, this HTML element will be used to make the list. 775</para> 776 777</refsect1> 778</refentry> 779 780<refentry id="toc.section.depth"> 781<refmeta> 782<refentrytitle>toc.section.depth</refentrytitle> 783<refmiscinfo role="type">integer</refmiscinfo> 784</refmeta> 785<refnamediv> 786<refname>toc.section.depth</refname> 787<refpurpose>How deep should recursive <sgmltag>section</sgmltag>s appear 788in the TOC?</refpurpose> 789</refnamediv> 790 791<refsynopsisdiv> 792<programlisting id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting> 793</refsynopsisdiv> 794 795<refsect1><title>Description</title> 796 797<para>Specifies the depth to which recursive sections should appear in the 798TOC. 799</para> 800 801</refsect1> 802</refentry> 803 804<refentry id="toc.max.depth"> 805<refmeta> 806<refentrytitle>toc.max.depth</refentrytitle> 807<refmiscinfo role="type">integer</refmiscinfo> 808</refmeta> 809<refnamediv> 810<refname>toc.max.depth</refname> 811<refpurpose>How maximaly deep should be each TOC?</refpurpose> 812</refnamediv> 813 814<refsynopsisdiv> 815<programlisting id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting> 816</refsynopsisdiv> 817 818<refsect1><title>Description</title> 819 820<para>Specifies the maximal depth of TOC on all levels.</para> 821 822</refsect1> 823</refentry> 824 825<refentry id="generate.toc"> 826<refmeta> 827<refentrytitle>generate.toc</refentrytitle> 828<refmiscinfo role="type">table</refmiscinfo> 829</refmeta> 830<refnamediv> 831<refname>generate.toc</refname> 832<refpurpose>Control generation of ToCs and LoTs</refpurpose> 833</refnamediv> 834 835<refsynopsisdiv> 836<programlisting id="generate.toc.frag"> 837<xsl:param name="generate.toc"> 838appendix toc,title 839article/appendix nop 840article toc,title 841book toc,title,figure,table,example,equation 842chapter toc,title 843part toc,title 844preface toc,title 845qandadiv toc 846qandaset toc 847reference toc,title 848sect1 toc 849sect2 toc 850sect3 toc 851sect4 toc 852sect5 toc 853section toc 854set toc,title 855</xsl:param> 856 857</programlisting> 858</refsynopsisdiv> 859 860<refsect1><title>Description</title> 861 862<para>This parameter has a structured value. It is a table of space-delimited 863path/value pairs. Each path identifies some element in the source document 864using a restricted subset of XPath (only the implicit child axis, no wildcards, 865no predicates). Paths can be either relative or absolute.</para> 866 867<para>When processing a particular element, the stylesheets consult this table to 868determine if a ToC (or LoT(s)) should be generated.</para> 869 870<para>For example, consider the entry:</para> 871 872<screen>book toc,figure</screen> 873 874<para>This indicates that whenever a <sgmltag>book</sgmltag> is formatted, a 875Table Of Contents and a List of Figures should be generated. Similarly,</para> 876 877<screen>/chapter toc</screen> 878 879<para>indicates that whenever a document <emphasis>that has a root 880of</emphasis> <sgmltag>chapter</sgmltag> is formatted, a Table of 881Contents should be generated. The entry <literal>chapter</literal> would match 882all chapters, but <literal>/chapter</literal> matches only <sgmltag>chapter</sgmltag> 883document elements.</para> 884 885<para>Generally, the longest match wins. So, for example, if you want to distinguish 886articles in books from articles in parts, you could use these two entries:</para> 887 888<screen>book/article toc,figure 889part/article toc</screen> 890 891<para>Note that an article in a part can never match a <literal>book/article</literal>, 892so if you want nothing to be generated for articles in parts, you can simply leave 893that rule out.</para> 894 895<para>If you want to leave the rule in, to make it explicit that you're turning 896something off, use the value <quote>nop</quote>. For example, the following 897entry disables ToCs and LoTs for articles:</para> 898 899<screen>article nop</screen> 900 901<para>Do not simply leave the word <quote>article</quote> in the file 902without a matching value. That'd be just begging the silly little 903path/value parser to get confused.</para> 904 905<para>Section ToCs are further controlled by the 906<parameter>generate.section.toc.level</parameter> parameter. 907For a given section level to have a ToC, it must have both an entry in 908<parameter>generate.toc</parameter> and be within the range enabled by 909<parameter>generate.section.toc.level</parameter>.</para> 910</refsect1> 911</refentry> 912 913<refentry id="generate.section.toc.level"> 914<refmeta> 915<refentrytitle>generate.section.toc.level</refentrytitle> 916<refmiscinfo role="type">integer</refmiscinfo> 917</refmeta> 918<refnamediv> 919<refname>generate.section.toc.level</refname> 920<refpurpose>Control depth of TOC generation in sections</refpurpose> 921</refnamediv> 922 923<refsynopsisdiv> 924<programlisting id="generate.section.toc.level.frag"> 925<xsl:param name="generate.section.toc.level" select="0"></xsl:param> 926</programlisting> 927</refsynopsisdiv> 928 929<refsect1><title>Description</title> 930 931<para>The <parameter>generate.section.toc.level</parameter> parameter 932controls the depth of section in which TOCs will be generated. Note 933that this is related to, but not the same as 934<parameter>toc.section.depth</parameter>, which controls the depth to 935which TOC entries will be generated in a given TOC.</para> 936<para>If, for example, <parameter>generate.section.toc.level</parameter> 937is <literal>3</literal>, TOCs will be generated in first, second, and third 938level sections, but not in fourth level sections. 939</para> 940 941</refsect1> 942</refentry> 943 944<refentry id="generate.index"> 945<refmeta> 946<refentrytitle>generate.index</refentrytitle> 947<refmiscinfo role="type">boolean</refmiscinfo> 948</refmeta> 949<refnamediv> 950<refname>generate.index</refname> 951<refpurpose>Do you want an index?</refpurpose> 952</refnamediv> 953 954<refsynopsisdiv> 955<programlisting id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting> 956</refsynopsisdiv> 957 958<refsect1><title>Description</title> 959 960<para>Specify if an index should be generated. </para> 961 962</refsect1> 963</refentry> 964 965<refentry id="index.method"> 966<refmeta> 967<refentrytitle>index.method</refentrytitle> 968<refmiscinfo role="type">string</refmiscinfo> 969</refmeta> 970<refnamediv> 971<refname>index.method</refname> 972<refpurpose>Select method used to group index entries in an index</refpurpose> 973</refnamediv> 974 975<refsynopsisdiv> 976<programlisting id="index.method.frag"> 977<xsl:param name="index.method" select="'english'"></xsl:param> 978</programlisting> 979</refsynopsisdiv> 980 981<refsect1><title>Description</title> 982 983<para>This parameter lets you select which method should be 984used to sort and group index entries in an index. 985Indexes in languages that have accented characters typically 986sort together accented words and unaccented words. 987So <quote>��</quote> (A acute) would sort together 988with <quote>A</quote>, so both would appear in the <quote>A</quote> 989section of the index. 990</para> 991 992<para>The default indexing method does not sort accented characters this way. 993Words that start with an accented character will instead appear in the 994<quote>Symbols</quote> section of the index. 995As such, the default method is only suitable for 996English and other unaccented languages. 997The other indexing methods require extensions of one type or 998another, which is why there are not used by default.</para> 999 1000<para>The three choices for indexing method are:</para> 1001<variablelist> 1002<varlistentry> 1003<term><literal>english</literal></term> 1004<listitem> 1005<para> 1006(default) Sort and groups words based only on the Latin alphabet. 1007Accented words and words in non-Latin alphabets will be 1008put in the <quote>Symbols</quote> section of the index. 1009</para> 1010</listitem> 1011</varlistentry> 1012<varlistentry> 1013<term><literal>kosek</literal></term> 1014<listitem> 1015<para> 1016Sort and groups words based on letter groups configured in 1017the DocBook locale file for the given language. 1018For example, the French locale file is <filename>common/fr.xml</filename>. 1019This method requires support for EXSLT extensions in 1020the XSL processor. It also requires support for using 1021user-defined functions in xsl:key (xsltproc does not). 1022</para> 1023<para>This method is suitable for any language for which you can 1024list all the individual characters that should appear 1025in each letter group in an index. 1026It is probably not practical to use it for ideographic languages 1027such as Chinese that have hundreds or thousands of characters. 1028</para> 1029<para>To use this method, your customization must set this 1030parameter and import an additional stylesheet module:</para> 1031<programlisting><xsl:import href="[path-to-stylesheets]/common/autoidx-ng.xsl"/> 1032<xsl:param name="index.method">kosek</xsl:param> 1033 1034</programlisting> 1035<para>The stylesheet module defines functions and adds an xsl:key 1036used by the method. 1037</para> 1038</listitem> 1039</varlistentry> 1040<varlistentry> 1041<term><literal>kimber</literal></term> 1042<listitem> 1043<para> 1044This method uses extensions to the Saxon processor to implement 1045sophisticated indexing processes. It uses its own 1046configuration file, which can include information for any number of 1047languages. Each language's configuration can group 1048words using either an 1049enumerated method similar to the kosek method, or it can 1050designate the first character in each group when viewed in sort order. 1051The latter configuration is useful for ideographic languages 1052such as Chinese, Japanese, and Korean. 1053You can also define your own collation algorithms and where you 1054want Latin-alphabet words sorted.</para> 1055<itemizedlist> 1056<listitem> 1057<para>For a whitepaper describing the extensions, see: 1058<ulink url="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf"/>. 1059</para> 1060</listitem> 1061<listitem> 1062<para>To download the extension library, see 1063<ulink url="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport"/>. 1064</para> 1065</listitem> 1066</itemizedlist> 1067 1068<para>To use this method, you must:</para> 1069 1070<orderedlist> 1071<listitem> 1072<para>Use Saxon as your XSLT processor. 1073</para> 1074</listitem> 1075<listitem> 1076<para>Install and configure the Innodata Isogen library, using 1077the documentation that comes with it. 1078</para> 1079</listitem> 1080<listitem> 1081<para>Set this parameter's value to <quote>kimber</quote>. 1082</para> 1083</listitem> 1084<listitem> 1085<para>Import the index extensions stylesheet module 1086<filename>common/autoidx-ng.xsl</filename> into your 1087customization. 1088</para> 1089</listitem> 1090</orderedlist> 1091 1092</listitem> 1093</varlistentry> 1094</variablelist> 1095 1096</refsect1> 1097</refentry> 1098 1099<refentry id="index.on.type"> 1100<refmeta> 1101<refentrytitle>index.on.type</refentrytitle> 1102<refmiscinfo role="type">boolean</refmiscinfo> 1103</refmeta> 1104<refnamediv> 1105<refname>index.on.type</refname> 1106<refpurpose>Select indexterms based on <sgmltag>type</sgmltag> 1107attribute value</refpurpose> 1108</refnamediv> 1109 1110<refsynopsisdiv> 1111<programlisting id="index.on.type.frag"> 1112<xsl:param name="index.on.type" select="0"></xsl:param> 1113</programlisting> 1114</refsynopsisdiv> 1115 1116<refsect1><title>Description</title> 1117 1118<para> 1119If non-zero, 1120then an <sgmltag>index</sgmltag> element that has a 1121<sgmltag>type</sgmltag> attribute 1122value will contain only those <sgmltag>indexterm</sgmltag> 1123elements with a matching <sgmltag>type</sgmltag> attribute value. 1124If an <sgmltag>index</sgmltag> has no <sgmltag>type</sgmltag> 1125attribute or it is blank, then the index will contain 1126all <sgmltag>indexterm</sgmltag>s in the current scope. 1127</para> 1128 1129<para> 1130If <literal>index.on.type</literal> is zero, then the 1131<sgmltag>type</sgmltag> attribute has no effect 1132on selecting indexterms for an index. 1133</para> 1134 1135<para>For those using DocBook version 4.2 or earlier, 1136the <sgmltag>type</sgmltag> attribute is not available 1137for index terms. However, you can achieve the same 1138effect by using the <sgmltag>role</sgmltag> attribute 1139in the same manner on <sgmltag>indexterm</sgmltag> 1140and <sgmltag>index</sgmltag>, and setting the stylesheet parameter 1141<parameter>index.on.role</parameter> to a nonzero value. 1142</para> 1143 1144</refsect1> 1145</refentry> 1146 1147<refentry id="index.on.role"> 1148<refmeta> 1149<refentrytitle>index.on.role</refentrytitle> 1150<refmiscinfo role="type">boolean</refmiscinfo> 1151</refmeta> 1152<refnamediv> 1153<refname>index.on.role</refname> 1154<refpurpose>Select indexterms based on role value</refpurpose> 1155</refnamediv> 1156 1157<refsynopsisdiv> 1158<programlisting id="index.on.role.frag"> 1159<xsl:param name="index.on.role" select="0"></xsl:param> 1160</programlisting> 1161</refsynopsisdiv> 1162 1163<refsect1><title>Description</title> 1164 1165<para> 1166If non-zero, 1167then an <sgmltag>index</sgmltag> element that has a 1168<sgmltag>role</sgmltag> attribute 1169value will contain only those <sgmltag>indexterm</sgmltag> 1170elements with a matching role value. 1171If an <sgmltag>index</sgmltag> has no <sgmltag>role</sgmltag> 1172attribute or it is blank, then the index will contain 1173all <sgmltag>indexterm</sgmltag>s in the current scope. 1174</para> 1175<para> 1176If <literal>index.on.role</literal> is zero, then the 1177<sgmltag>role</sgmltag> attribute has no effect 1178on selecting indexterms for an index. 1179</para> 1180 1181<para>If you are using DocBook version 4.3 or later, you should 1182use the <sgmltag>type</sgmltag> attribute instead of <sgmltag>role</sgmltag> 1183on <sgmltag>indexterm</sgmltag> and <sgmltag>index</sgmltag>, 1184and set the <parameter>index.on.type</parameter> to a nonzero 1185value. 1186</para> 1187 1188</refsect1> 1189</refentry> 1190 1191<refentry id="index.prefer.titleabbrev"> 1192<refmeta> 1193<refentrytitle>index.prefer.titleabbrev</refentrytitle> 1194<refmiscinfo role="type">boolean</refmiscinfo> 1195</refmeta> 1196<refnamediv> 1197<refname>index.prefer.titleabbrev</refname> 1198<refpurpose>Should be abbreviated titles used as back references</refpurpose> 1199</refnamediv> 1200 1201<refsynopsisdiv> 1202<programlisting id="index.prefer.titleabbrev.frag"> 1203<xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param> 1204</programlisting> 1205</refsynopsisdiv> 1206 1207<refsect1><title>Description</title> 1208 1209<para>FIXME: 1210</para> 1211 1212</refsect1> 1213</refentry> 1214 1215<refentry id="index.term.separator"> 1216<refmeta> 1217<refentrytitle>index.term.separator</refentrytitle> 1218<refmiscinfo role="type">string</refmiscinfo> 1219</refmeta> 1220<refnamediv> 1221<refname>index.term.separator</refname> 1222<refpurpose>Override for punctuation separating an index term 1223from its list of page references in an index</refpurpose> 1224</refnamediv> 1225 1226<refsynopsisdiv> 1227<programlisting id="index.term.separator.frag"> 1228<xsl:param name="index.term.separator" select="''"></xsl:param> 1229</programlisting> 1230</refsynopsisdiv> 1231 1232<refsect1><title>Description</title> 1233 1234<para>This parameter permits you to override 1235the text to insert between 1236the end of an index term and its list of page references. 1237Typically that might be a comma and a space. 1238</para> 1239 1240<para>Because this text may be locale dependent, 1241this parameter's value is normally taken from a gentext 1242template named 'term-separator' in the 1243context 'index' in the stylesheet 1244locale file for the language 1245of the current document. 1246This parameter can be used to override the gentext string, 1247and would typically be used on the command line. 1248This parameter would apply to all languages. 1249</para> 1250 1251<para>So this text string can be customized in two ways. 1252You can reset the default gentext string using 1253the <parameter>local.l10n.xml</parameter> parameter, or you can 1254fill in the content for this normally empty 1255override parameter. 1256The content can be a simple string, or it can be 1257something more complex such as a call-template. 1258For fo output, it could be an <sgmltag>fo:leader</sgmltag> 1259element to provide space of a specific length, or a dot leader. 1260</para> 1261 1262</refsect1> 1263</refentry> 1264 1265<refentry id="index.number.separator"> 1266<refmeta> 1267<refentrytitle>index.number.separator</refentrytitle> 1268<refmiscinfo role="type">string</refmiscinfo> 1269</refmeta> 1270<refnamediv> 1271<refname>index.number.separator</refname> 1272<refpurpose>Override for punctuation separating page numbers in index</refpurpose> 1273</refnamediv> 1274 1275<refsynopsisdiv> 1276<programlisting id="index.number.separator.frag"> 1277<xsl:param name="index.number.separator" select="''"></xsl:param> 1278</programlisting> 1279</refsynopsisdiv> 1280 1281<refsect1><title>Description</title> 1282 1283<para>This parameter permits you to override the text to insert between 1284page references in a formatted index entry. Typically 1285that would be a comma and a space. 1286</para> 1287 1288<para>Because this text may be locale dependent, 1289this parameter's value is normally taken from a gentext 1290template named 'number-separator' in the 1291context 'index' in the stylesheet 1292locale file for the language 1293of the current document. 1294This parameter can be used to override the gentext string, 1295and would typically be used on the command line. 1296This parameter would apply to all languages. 1297</para> 1298 1299<para>So this text string can be customized in two ways. 1300You can reset the default gentext string using 1301the <parameter>local.l10n.xml</parameter> parameter, or you can 1302override the gentext with the content of this parameter. 1303The content can be a simple string, or it can be 1304something more complex such as a call-template. 1305</para> 1306 1307<para>In HTML index output, section title references are used instead of 1308page number references. This punctuation appears between 1309such section titles in an HTML index. 1310</para> 1311 1312</refsect1> 1313</refentry> 1314 1315<refentry id="index.range.separator"> 1316<refmeta> 1317<refentrytitle>index.range.separator</refentrytitle> 1318<refmiscinfo role="type">string</refmiscinfo> 1319</refmeta> 1320<refnamediv> 1321<refname>index.range.separator</refname> 1322<refpurpose>Override for punctuation separating the two numbers 1323in a page range in index</refpurpose> 1324</refnamediv> 1325 1326<refsynopsisdiv> 1327<programlisting id="index.range.separator.frag"> 1328<xsl:param name="index.range.separator" select="''"></xsl:param> 1329</programlisting> 1330</refsynopsisdiv> 1331 1332<refsect1><title>Description</title> 1333 1334<para>This parameter permits you 1335to override the text to insert between 1336the two numbers of a page range in an index. 1337This parameter is only used by those XSL-FO processors 1338that support an extension for generating such page ranges 1339(such as XEP).</para> 1340 1341<para>Because this text may be locale dependent, 1342this parameter's value is normally taken from a gentext 1343template named 'range-separator' in the 1344context 'index' in the stylesheet 1345locale file for the language 1346of the current document. 1347This parameter can be used to override the gentext string, 1348and would typically be used on the command line. 1349This parameter would apply to all languages. 1350</para> 1351 1352<para>So this text string can be customized in two ways. 1353You can reset the default gentext string using 1354the <parameter>local.l10n.xml</parameter> parameter, or you can 1355override the gentext with the content of this parameter. 1356The content can be a simple string, or it can be 1357something more complex such as a call-template. 1358</para> 1359 1360<para>In HTML index output, section title references are used instead of 1361page number references. So there are no page ranges 1362and this parameter has no effect. 1363</para> 1364 1365</refsect1> 1366</refentry> 1367 1368</reference> 1369 1370<reference id="dbk_ext"><title>Stylesheet Extensions</title> 1371<refentry id="linenumbering.everyNth"> 1372<refmeta> 1373<refentrytitle>linenumbering.everyNth</refentrytitle> 1374<refmiscinfo role="type">integer</refmiscinfo> 1375</refmeta> 1376<refnamediv> 1377<refname>linenumbering.everyNth</refname> 1378<refpurpose>Indicate which lines should be numbered</refpurpose> 1379</refnamediv> 1380 1381<refsynopsisdiv> 1382<programlisting id="linenumbering.everyNth.frag"><xsl:param name="linenumbering.everyNth" select="'5'"></xsl:param></programlisting> 1383</refsynopsisdiv> 1384 1385<refsect1><title>Description</title> 1386 1387<para>If line numbering is enabled, everyNth line will be numbered. 1388</para> 1389 1390</refsect1> 1391</refentry> 1392 1393<refentry id="linenumbering.extension"> 1394<refmeta> 1395<refentrytitle>linenumbering.extension</refentrytitle> 1396<refmiscinfo role="type">boolean</refmiscinfo> 1397</refmeta> 1398<refnamediv> 1399<refname>linenumbering.extension</refname> 1400<refpurpose>Enable the line numbering extension</refpurpose> 1401</refnamediv> 1402 1403<refsynopsisdiv> 1404<programlisting id="linenumbering.extension.frag"><xsl:param name="linenumbering.extension" select="'1'"></xsl:param></programlisting> 1405</refsynopsisdiv> 1406 1407<refsect1><title>Description</title> 1408 1409<para>If true, verbatim environments (elements that have the 1410format='linespecific' notation attribute: address, literallayout, 1411programlisting, screen, synopsis) that specify line numbering will 1412have, surprise, line numbers. 1413</para> 1414 1415</refsect1> 1416</refentry> 1417 1418<refentry id="linenumbering.separator"> 1419<refmeta> 1420<refentrytitle>linenumbering.separator</refentrytitle> 1421<refmiscinfo role="type">string</refmiscinfo> 1422</refmeta> 1423<refnamediv> 1424<refname>linenumbering.separator</refname> 1425<refpurpose>Specify a separator between line numbers and lines</refpurpose> 1426</refnamediv> 1427 1428<refsynopsisdiv> 1429<programlisting id="linenumbering.separator.frag"><xsl:param name="linenumbering.separator" select="' '"></xsl:param></programlisting> 1430</refsynopsisdiv> 1431 1432<refsect1><title>Description</title> 1433 1434<para>The separator is inserted between line numbers and lines in 1435the verbatim environment. 1436</para> 1437 1438</refsect1> 1439</refentry> 1440 1441<refentry id="linenumbering.width"> 1442<refmeta> 1443<refentrytitle>linenumbering.width</refentrytitle> 1444<refmiscinfo role="type">integer</refmiscinfo> 1445</refmeta> 1446<refnamediv> 1447<refname>linenumbering.width</refname> 1448<refpurpose>Indicates the width of line numbers</refpurpose> 1449</refnamediv> 1450 1451<refsynopsisdiv> 1452<programlisting id="linenumbering.width.frag"><xsl:param name="linenumbering.width" select="'3'"></xsl:param></programlisting> 1453</refsynopsisdiv> 1454 1455<refsect1><title>Description</title> 1456 1457<para>If line numbering is enabled, line numbers will appear right 1458justified in a field "width" characters wide. 1459</para> 1460 1461</refsect1> 1462</refentry> 1463 1464<refentry id="tablecolumns.extension"> 1465<refmeta> 1466<refentrytitle>tablecolumns.extension</refentrytitle> 1467<refmiscinfo role="type">boolean</refmiscinfo> 1468</refmeta> 1469<refnamediv> 1470<refname>tablecolumns.extension</refname> 1471<refpurpose>Enable the table columns extension function</refpurpose> 1472</refnamediv> 1473 1474<refsynopsisdiv> 1475<programlisting id="tablecolumns.extension.frag"><xsl:param name="tablecolumns.extension" select="'1'"></xsl:param></programlisting> 1476</refsynopsisdiv> 1477 1478<refsect1><title>Description</title> 1479 1480<para>The table columns extension function adjusts the widths of table 1481columns in the HTML result to more accurately reflect the specifications 1482in the CALS table. 1483</para> 1484 1485</refsect1> 1486</refentry> 1487 1488<refentry id="textinsert.extension"> 1489<refmeta> 1490<refentrytitle>textinsert.extension</refentrytitle> 1491<refmiscinfo role="type">boolean</refmiscinfo> 1492</refmeta> 1493<refnamediv> 1494<refname>textinsert.extension</refname> 1495<refpurpose>Enable the textinsert extension element</refpurpose> 1496</refnamediv> 1497 1498<refsynopsisdiv> 1499<programlisting id="textinsert.extension.frag"><xsl:param name="textinsert.extension" select="'1'"></xsl:param></programlisting> 1500</refsynopsisdiv> 1501 1502<refsect1><title>Description</title> 1503 1504<para>The textinsert extension element inserts the contents of a 1505a file into the result tree (as text). 1506</para> 1507 1508</refsect1> 1509</refentry> 1510 1511<refentry id="textdata.default.encoding"> 1512<refmeta> 1513<refentrytitle>textdata.default.encoding</refentrytitle> 1514<refmiscinfo role="type">string</refmiscinfo> 1515</refmeta> 1516<refnamediv> 1517<refname>textdata.default.encoding</refname> 1518<refpurpose>Default encoding of external text files which are included 1519using textdata element</refpurpose> 1520</refnamediv> 1521 1522<refsynopsisdiv> 1523<programlisting id="textdata.default.encoding.frag"> 1524<xsl:param name="textdata.default.encoding" select="''"></xsl:param> 1525</programlisting> 1526</refsynopsisdiv> 1527 1528<refsect1><title>Description</title> 1529 1530<para>Default encoding of external text files which are included using 1531textdata element. This value is used only when you do not specify 1532encoding by appropriate attribute directly on textdata. Default 1533encoding (empty string) is interpreted as system default 1534encoding.</para> 1535 1536</refsect1> 1537</refentry> 1538 1539 1540<refentry id="graphicsize.extension"> 1541<refmeta> 1542<refentrytitle>graphicsize.extension</refentrytitle> 1543<refmiscinfo role="type">boolean</refmiscinfo> 1544</refmeta> 1545<refnamediv> 1546<refname>graphicsize.extension</refname> 1547<refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose> 1548</refnamediv> 1549 1550<refsynopsisdiv> 1551<programlisting id="graphicsize.extension.frag"> 1552<xsl:param name="graphicsize.extension" select="1"></xsl:param> 1553</programlisting> 1554</refsynopsisdiv> 1555 1556<refsect1><title>Description</title> 1557 1558<para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero 1559and if you're using a processor that supports extension functions), the 1560<function>getWidth</function> and <function>getDepth</function> functions 1561will be used to extract image sizes from graphics.</para> 1562 1563</refsect1> 1564</refentry> 1565 1566<refentry id="graphicsize.use.img.src.path"> 1567<refmeta> 1568<refentrytitle>graphicsize.use.img.src.path</refentrytitle> 1569<refmiscinfo role="type">boolean</refmiscinfo> 1570</refmeta> 1571<refnamediv> 1572<refname>graphicsize.use.img.src.path</refname> 1573<refpurpose>Prepend <parameter>img.src.path</parameter> before 1574filenames passed to extension functions</refpurpose> 1575</refnamediv> 1576 1577<refsynopsisdiv> 1578<programlisting id="graphicsize.use.img.src.path.frag"> 1579<xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param> 1580</programlisting> 1581</refsynopsisdiv> 1582 1583<refsect1><title>Description</title> 1584 1585<para>If non-zero <parameter>img.src.path</parameter> parameter will 1586be appended before filenames passed to extension functions for 1587measuring image dimensions.</para> 1588 1589</refsect1> 1590</refentry> 1591 1592<refentry id="use.extensions"> 1593<refmeta> 1594<refentrytitle>use.extensions</refentrytitle> 1595<refmiscinfo role="type">boolean</refmiscinfo> 1596</refmeta> 1597<refnamediv> 1598<refname>use.extensions</refname> 1599<refpurpose>Enable extensions</refpurpose> 1600</refnamediv> 1601 1602<refsynopsisdiv> 1603<programlisting id="use.extensions.frag"><xsl:param name="use.extensions" select="'0'"></xsl:param></programlisting> 1604</refsynopsisdiv> 1605 1606<refsect1><title>Description</title> 1607 1608<para>If non-zero, extensions may be used. Each extension is 1609further controlled by its own parameter. But if 1610<parameter>use.extensions</parameter> is zero, no extensions will 1611be used. 1612</para> 1613 1614</refsect1> 1615</refentry> 1616 1617</reference> 1618 1619<reference id="labels"><title>Automatic labelling</title> 1620<refentry id="chapter.autolabel"> 1621<refmeta> 1622<refentrytitle>chapter.autolabel</refentrytitle> 1623<refmiscinfo role="type">boolean</refmiscinfo> 1624</refmeta> 1625<refnamediv> 1626<refname>chapter.autolabel</refname> 1627<refpurpose>Specifies the labeling format for Chapter titles</refpurpose> 1628</refnamediv> 1629 1630<refsynopsisdiv> 1631<programlisting id="chapter.autolabel.frag"><xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting> 1632</refsynopsisdiv> 1633 1634<refsect1><title>Description</title> 1635 1636<para>If zero, then chapters will not be numbered. 1637Otherwise chapters will be numbered, using the parameter value 1638as the number format if the value matches one of the following: 1639</para> 1640 1641<variablelist> 1642 <varlistentry> 1643 <term>1 or arabic</term> 1644 <listitem> 1645 <para>Arabic numeration (1, 2, 3 ...).</para> 1646 </listitem> 1647 </varlistentry> 1648 <varlistentry> 1649 <term>A or upperalpha</term> 1650 <listitem> 1651 <para>Uppercase letter numeration (A, B, C ...).</para> 1652 </listitem> 1653 </varlistentry> 1654 <varlistentry> 1655 <term>a or loweralpha</term> 1656 <listitem> 1657 <para>Lowercase letter numeration (a, b, c ...).</para> 1658 </listitem> 1659 </varlistentry> 1660 <varlistentry> 1661 <term>I or upperroman</term> 1662 <listitem> 1663 <para>Uppercase roman numeration (I, II, III ...).</para> 1664 </listitem> 1665 </varlistentry> 1666 <varlistentry> 1667 <term>i or lowerroman</term> 1668 <listitem> 1669 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1670 </listitem> 1671 </varlistentry> 1672</variablelist> 1673 1674<para>Any nonzero value other than the above will generate 1675the default number format (arabic). 1676</para> 1677 1678</refsect1> 1679</refentry> 1680 1681<refentry id="appendix.autolabel"> 1682<refmeta> 1683<refentrytitle>appendix.autolabel</refentrytitle> 1684<refmiscinfo role="type">boolean</refmiscinfo> 1685</refmeta> 1686<refnamediv> 1687<refname>appendix.autolabel</refname> 1688<refpurpose>Specifies the labeling format for Appendix titles</refpurpose> 1689</refnamediv> 1690 1691<refsynopsisdiv> 1692<programlisting id="appendix.autolabel.frag"> 1693<xsl:param name="appendix.autolabel" select="'A'"></xsl:param> 1694</programlisting> 1695</refsynopsisdiv> 1696 1697<refsect1><title>Description</title> 1698 1699<para>If zero, then appendices will not be numbered. 1700Otherwise appendices will be numbered, using the parameter value 1701as the number format if the value matches one of the following: 1702</para> 1703 1704<variablelist> 1705 <varlistentry> 1706 <term>1 or arabic</term> 1707 <listitem> 1708 <para>Arabic numeration (1, 2, 3 ...).</para> 1709 </listitem> 1710 </varlistentry> 1711 <varlistentry> 1712 <term>A or upperalpha</term> 1713 <listitem> 1714 <para>Uppercase letter numeration (A, B, C ...).</para> 1715 </listitem> 1716 </varlistentry> 1717 <varlistentry> 1718 <term>a or loweralpha</term> 1719 <listitem> 1720 <para>Lowercase letter numeration (a, b, c ...).</para> 1721 </listitem> 1722 </varlistentry> 1723 <varlistentry> 1724 <term>I or upperroman</term> 1725 <listitem> 1726 <para>Uppercase roman numeration (I, II, III ...).</para> 1727 </listitem> 1728 </varlistentry> 1729 <varlistentry> 1730 <term>i or lowerroman</term> 1731 <listitem> 1732 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1733 </listitem> 1734 </varlistentry> 1735</variablelist> 1736 1737<para>Any nonzero value other than the above will generate 1738the default number format (upperalpha). 1739</para> 1740 1741</refsect1> 1742</refentry> 1743 1744<refentry id="part.autolabel"> 1745<refmeta> 1746<refentrytitle>part.autolabel</refentrytitle> 1747<refmiscinfo role="type">boolean</refmiscinfo> 1748</refmeta> 1749<refnamediv> 1750<refname>part.autolabel</refname> 1751<refpurpose>Specifies the labeling format for Part titles</refpurpose> 1752</refnamediv> 1753 1754<refsynopsisdiv> 1755<programlisting id="part.autolabel.frag"><xsl:param name="part.autolabel" select="'I'"></xsl:param></programlisting> 1756</refsynopsisdiv> 1757 1758<refsect1><title>Description</title> 1759 1760<para>If zero, then parts will not be numbered. 1761Otherwise parts will be numbered, using the parameter value 1762as the number format if the value matches one of the following: 1763</para> 1764 1765<variablelist> 1766 <varlistentry> 1767 <term>1 or arabic</term> 1768 <listitem> 1769 <para>Arabic numeration (1, 2, 3 ...).</para> 1770 </listitem> 1771 </varlistentry> 1772 <varlistentry> 1773 <term>A or upperalpha</term> 1774 <listitem> 1775 <para>Uppercase letter numeration (A, B, C ...).</para> 1776 </listitem> 1777 </varlistentry> 1778 <varlistentry> 1779 <term>a or loweralpha</term> 1780 <listitem> 1781 <para>Lowercase letter numeration (a, b, c ...).</para> 1782 </listitem> 1783 </varlistentry> 1784 <varlistentry> 1785 <term>I or upperroman</term> 1786 <listitem> 1787 <para>Uppercase roman numeration (I, II, III ...).</para> 1788 </listitem> 1789 </varlistentry> 1790 <varlistentry> 1791 <term>i or lowerroman</term> 1792 <listitem> 1793 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1794 </listitem> 1795 </varlistentry> 1796</variablelist> 1797 1798<para>Any nonzero value other than the above will generate 1799the default number format (upperroman). 1800</para> 1801 1802 1803</refsect1> 1804</refentry> 1805 1806<refentry id="preface.autolabel"> 1807<refmeta> 1808<refentrytitle>preface.autolabel</refentrytitle> 1809<refmiscinfo role="type">boolean</refmiscinfo> 1810</refmeta> 1811<refnamediv> 1812<refname>preface.autolabel</refname> 1813<refpurpose>Specifices the labeling format for Preface titles</refpurpose> 1814</refnamediv> 1815 1816<refsynopsisdiv> 1817<programlisting id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting> 1818</refsynopsisdiv> 1819 1820<refsect1><title>Description</title> 1821 1822<para>If zero (default), then prefaces will not be numbered. 1823Otherwise prefaces will be numbered, using the parameter value 1824as the number format if the value matches one of the following: 1825</para> 1826 1827<variablelist> 1828 <varlistentry> 1829 <term>1 or arabic</term> 1830 <listitem> 1831 <para>Arabic numeration (1, 2, 3 ...).</para> 1832 </listitem> 1833 </varlistentry> 1834 <varlistentry> 1835 <term>A or upperalpha</term> 1836 <listitem> 1837 <para>Uppercase letter numeration (A, B, C ...).</para> 1838 </listitem> 1839 </varlistentry> 1840 <varlistentry> 1841 <term>a or loweralpha</term> 1842 <listitem> 1843 <para>Lowercase letter numeration (a, b, c ...).</para> 1844 </listitem> 1845 </varlistentry> 1846 <varlistentry> 1847 <term>I or upperroman</term> 1848 <listitem> 1849 <para>Uppercase roman numeration (I, II, III ...).</para> 1850 </listitem> 1851 </varlistentry> 1852 <varlistentry> 1853 <term>i or lowerroman</term> 1854 <listitem> 1855 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1856 </listitem> 1857 </varlistentry> 1858</variablelist> 1859 1860<para>Any nonzero value other than the above will generate 1861the default number format (arabic). 1862</para> 1863 1864 1865</refsect1> 1866</refentry> 1867 1868<refentry id="qandadiv.autolabel"> 1869<refmeta> 1870<refentrytitle>qandadiv.autolabel</refentrytitle> 1871<refmiscinfo role="type">boolean</refmiscinfo> 1872</refmeta> 1873<refnamediv> 1874<refname>qandadiv.autolabel</refname> 1875<refpurpose>Are divisions in QAndASets enumerated?</refpurpose> 1876</refnamediv> 1877 1878<refsynopsisdiv> 1879<programlisting id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting> 1880</refsynopsisdiv> 1881 1882<refsect1><title>Description</title> 1883 1884<para>If true (non-zero), unlabeled qandadivs will be enumerated. 1885</para> 1886 1887</refsect1> 1888</refentry> 1889 1890<refentry id="section.autolabel"> 1891<refmeta> 1892<refentrytitle>section.autolabel</refentrytitle> 1893<refmiscinfo role="type">boolean</refmiscinfo> 1894</refmeta> 1895<refnamediv> 1896<refname>section.autolabel</refname> 1897<refpurpose>Are sections enumerated?</refpurpose> 1898</refnamediv> 1899 1900<refsynopsisdiv> 1901<programlisting id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting> 1902</refsynopsisdiv> 1903 1904<refsect1><title>Description</title> 1905 1906<para>If true (non-zero), unlabeled sections will be enumerated. 1907</para> 1908 1909</refsect1> 1910</refentry> 1911 1912<refentry id="section.autolabel.max.depth"> 1913<refmeta> 1914<refentrytitle>section.autolabel.max.depth</refentrytitle> 1915<refmiscinfo role="type">integer</refmiscinfo> 1916</refmeta> 1917<refnamediv> 1918<refname>section.autolabel.max.depth</refname> 1919<refpurpose>The deepest level of sections that are numbered.</refpurpose> 1920</refnamediv> 1921 1922<refsynopsisdiv> 1923<programlisting id="section.autolabel.max.depth.frag"><xsl:param name="section.autolabel.max.depth" select="8"></xsl:param></programlisting> 1924</refsynopsisdiv> 1925 1926<refsect1><title>Description</title> 1927 1928<para>When section numbering is turned on by the 1929<literal>section.autolabel</literal> parameter, 1930then this parameter controls the depth of section nesting 1931that is numbered. 1932Sections nested to a level deeper than this value will 1933not be numbered. 1934</para> 1935 1936</refsect1> 1937</refentry> 1938 1939<refentry id="section.label.includes.component.label"> 1940<refmeta> 1941<refentrytitle>section.label.includes.component.label</refentrytitle> 1942<refmiscinfo role="type">boolean</refmiscinfo> 1943</refmeta> 1944<refnamediv> 1945<refname>section.label.includes.component.label</refname> 1946<refpurpose>Do section labels include the component label?</refpurpose> 1947</refnamediv> 1948 1949<refsynopsisdiv> 1950<programlisting id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting> 1951</refsynopsisdiv> 1952 1953<refsect1><title>Description</title> 1954 1955<para>If true (non-zero), section labels are prefixed with the label of the 1956component that contains them. 1957</para> 1958 1959</refsect1> 1960</refentry> 1961 1962<refentry id="label.from.part"> 1963<refmeta> 1964<refentrytitle>label.from.part</refentrytitle> 1965<refmiscinfo role="type">boolean</refmiscinfo> 1966</refmeta> 1967<refnamediv> 1968<refname>label.from.part</refname> 1969<refpurpose>Renumber chapters in each part?</refpurpose> 1970</refnamediv> 1971 1972<refsynopsisdiv> 1973<programlisting id="label.from.part.frag"><xsl:param name="label.from.part" select="'0'"></xsl:param></programlisting> 1974</refsynopsisdiv> 1975 1976<refsect1><title>Description</title> 1977 1978<para>If <parameter>label.from.part</parameter> is non-zero, components 1979(<sgmltag>chapter</sgmltag>s, <sgmltag>appendixe</sgmltag>s, etc.) 1980will be numbered from 1 in each <sgmltag>part</sgmltag>. Otherwise, 1981they will be numbered monotonically throughout each 1982<sgmltag>book</sgmltag>. 1983</para> 1984 1985</refsect1> 1986</refentry> 1987 1988<refentry id="component.label.includes.part.label"> 1989<refmeta> 1990<refentrytitle>component.label.includes.part.label</refentrytitle> 1991<refmiscinfo role="type">boolean</refmiscinfo> 1992</refmeta> 1993<refnamediv> 1994<refname>component.label.includes.part.label</refname> 1995<refpurpose>Do component labels include the part label?</refpurpose> 1996</refnamediv> 1997 1998<refsynopsisdiv> 1999<programlisting id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting> 2000</refsynopsisdiv> 2001 2002<refsect1><title>Description</title> 2003 2004<para>If true (non-zero), number labels for chapters, appendices, and other component 2005elements are prefixed with the label of the 2006part element that contains them. 2007So you might see Chapter II.3 instead of Chapter 3. 2008Also, the labels for formal elements such as table and figure will 2009include the part label. 2010If there is no part element container, then no prefix is generated. 2011</para> 2012<para> 2013This feature is most useful when the 2014<literal>label.from.part</literal> parameter is turned on. 2015In that case, there would be more than one chapter 2016<quote>1</quote>, and the extra part label prefix will identify 2017each chapter unambiguously. 2018</para> 2019 2020</refsect1> 2021</refentry> 2022 2023</reference> 2024 2025 2026 2027<reference id="html"><title>HTML</title> 2028<refentry id="html.base"> 2029<refmeta> 2030<refentrytitle>html.base</refentrytitle> 2031<refmiscinfo role="type">uri</refmiscinfo> 2032</refmeta> 2033<refnamediv> 2034<refname>html.base</refname> 2035<refpurpose>An HTML base URI</refpurpose> 2036</refnamediv> 2037 2038<refsynopsisdiv> 2039<programlisting id="html.base.frag"><xsl:param name="html.base"></xsl:param></programlisting> 2040</refsynopsisdiv> 2041 2042<refsect1><title>Description</title> 2043 2044<para>If html.base is set, it is used for the <sgmltag>BASE</sgmltag> 2045element in the <sgmltag>HEAD</sgmltag> of the HTML documents. 2046This is useful for dynamically served HTML where the base URI needs 2047to be shifted.</para> 2048 2049</refsect1> 2050</refentry> 2051 2052<refentry id="html.stylesheet.type"> 2053<refmeta> 2054<refentrytitle>html.stylesheet.type</refentrytitle> 2055<refmiscinfo role="type">string</refmiscinfo> 2056</refmeta> 2057<refnamediv> 2058<refname>html.stylesheet.type</refname> 2059<refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> 2060</refnamediv> 2061 2062<refsynopsisdiv> 2063<programlisting id="html.stylesheet.type.frag"><xsl:param name="html.stylesheet.type">text/css</xsl:param></programlisting> 2064</refsynopsisdiv> 2065 2066<refsect1><title>Description</title> 2067 2068<para>The type of the stylesheet to place in the HTML <sgmltag>link</sgmltag> tag. 2069</para> 2070 2071</refsect1> 2072</refentry> 2073 2074<refentry id="html.stylesheet"> 2075<refmeta> 2076<refentrytitle>html.stylesheet</refentrytitle> 2077<refmiscinfo role="type">string</refmiscinfo> 2078</refmeta> 2079<refnamediv> 2080<refname>html.stylesheet</refname> 2081<refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose> 2082</refnamediv> 2083 2084<refsynopsisdiv> 2085<programlisting id="html.stylesheet.frag"> 2086<xsl:param name="html.stylesheet" select="''"></xsl:param> 2087</programlisting> 2088</refsynopsisdiv> 2089 2090<refsect1><title>Description</title> 2091 2092<para>The <parameter>html.stylesheet</parameter> parameter is either empty, 2093indicating that no stylesheet <sgmltag>LINK</sgmltag> tag should be generated 2094in the HTML output, or it is a list of one or more stylesheets.</para> 2095 2096<para>Multiple stylesheets are space-delimited. If you need to 2097reference a stylesheet URI that includes a space, encode it with 2098<literal>%20</literal>. A seprate HTML <sgmltag>LINK</sgmltag> element will 2099be generated for each stylesheet in the order they are listed in the 2100parameter.</para> 2101 2102</refsect1> 2103</refentry> 2104 2105<refentry id="css.decoration"> 2106<refmeta> 2107<refentrytitle>css.decoration</refentrytitle> 2108<refmiscinfo role="type">boolean</refmiscinfo> 2109</refmeta> 2110<refnamediv> 2111<refname>css.decoration</refname> 2112<refpurpose>Enable CSS decoration of elements</refpurpose> 2113</refnamediv> 2114 2115<refsynopsisdiv> 2116<programlisting id="css.decoration.frag"> 2117<xsl:param name="css.decoration" select="1"></xsl:param> 2118</programlisting> 2119</refsynopsisdiv> 2120 2121<refsect1><title>Description</title> 2122 2123<para> 2124If <literal>css.decoration</literal> is turned on, then HTML elements 2125produced by the 2126stylesheet may be decorated with STYLE attributes. For example, the 2127LI tags produced for list items may include a fragment of CSS in the 2128STYLE attribute which sets the CSS property "list-style-type". 2129</para> 2130 2131</refsect1> 2132</refentry> 2133 2134<refentry id="spacing.paras"> 2135<refmeta> 2136<refentrytitle>spacing.paras</refentrytitle> 2137<refmiscinfo role="type">boolean</refmiscinfo> 2138</refmeta> 2139<refnamediv> 2140<refname>spacing.paras</refname> 2141<refpurpose>Insert additional <p> elements for spacing?</refpurpose> 2142</refnamediv> 2143 2144<refsynopsisdiv> 2145<programlisting id="spacing.paras.frag"><xsl:param name="spacing.paras" select="'0'"></xsl:param></programlisting> 2146</refsynopsisdiv> 2147 2148<refsect1><title>Description</title> 2149 2150<para>When non-zero, additional, empty paragraphs are inserted in 2151several contexts (for example, around informal figures), to create a 2152more pleasing visual appearance in many browsers. 2153</para> 2154 2155</refsect1> 2156</refentry> 2157 2158<refentry id="emphasis.propagates.style"> 2159<refmeta> 2160<refentrytitle>emphasis.propagates.style</refentrytitle> 2161<refmiscinfo role="type">boolean</refmiscinfo> 2162</refmeta> 2163<refnamediv> 2164<refname>emphasis.propagates.style</refname> 2165<refpurpose>Pass emphasis role attribute through to HTML?</refpurpose> 2166</refnamediv> 2167 2168<refsynopsisdiv> 2169<programlisting id="emphasis.propagates.style.frag"> 2170<xsl:param name="emphasis.propagates.style" select="1"></xsl:param> 2171</programlisting> 2172</refsynopsisdiv> 2173 2174<refsect1><title>Description</title> 2175 2176<para>If true, the role attribute of <sgmltag>emphasis</sgmltag> elements 2177will be passed through to the HTML as a class attribute on a 2178<sgmltag>span</sgmltag> that surrounds the emphasis.</para> 2179 2180</refsect1> 2181</refentry> 2182 2183<refentry id="para.propagates.style"> 2184<refmeta> 2185<refentrytitle>para.propagates.style</refentrytitle> 2186<refmiscinfo role="type">boolean</refmiscinfo> 2187</refmeta> 2188<refnamediv> 2189<refname>para.propagates.style</refname> 2190<refpurpose>Pass para role attribute through to HTML?</refpurpose> 2191</refnamediv> 2192 2193<refsynopsisdiv> 2194<programlisting id="para.propagates.style.frag"> 2195<xsl:param name="para.propagates.style" select="1"></xsl:param> 2196</programlisting> 2197</refsynopsisdiv> 2198 2199<refsect1><title>Description</title> 2200 2201<para>If true, the role attribute of <sgmltag>para</sgmltag> elements 2202will be passed through to the HTML as a class attribute on the 2203<sgmltag>p</sgmltag> generated for the paragraph.</para> 2204 2205</refsect1> 2206</refentry> 2207 2208<refentry id="phrase.propagates.style"> 2209<refmeta> 2210<refentrytitle>phrase.propagates.style</refentrytitle> 2211<refmiscinfo role="type">boolean</refmiscinfo> 2212</refmeta> 2213<refnamediv> 2214<refname>phrase.propagates.style</refname> 2215<refpurpose>Pass phrase role attribute through to HTML?</refpurpose> 2216</refnamediv> 2217 2218<refsynopsisdiv> 2219<programlisting id="phrase.propagates.style.frag"><xsl:param name="phrase.propagates.style" select="1"></xsl:param></programlisting> 2220</refsynopsisdiv> 2221 2222<refsect1><title>Description</title> 2223 2224<para>If true, the role attribute of <sgmltag>phrase</sgmltag> elements 2225will be passed through to the HTML as a class attribute on a 2226<sgmltag>span</sgmltag> that surrounds the phrase.</para> 2227 2228</refsect1> 2229</refentry> 2230 2231<refentry id="entry.propagates.style"> 2232<refmeta> 2233<refentrytitle>entry.propagates.style</refentrytitle> 2234<refmiscinfo role="type">boolean</refmiscinfo> 2235</refmeta> 2236<refnamediv> 2237<refname>entry.propagates.style</refname> 2238<refpurpose>Pass entry role attribute through to HTML?</refpurpose> 2239</refnamediv> 2240 2241<refsynopsisdiv> 2242<programlisting id="entry.propagates.style.frag"> 2243<xsl:param name="entry.propagates.style" select="1"></xsl:param> 2244</programlisting> 2245</refsynopsisdiv> 2246 2247<refsect1><title>Description</title> 2248 2249<para>If true, the role attribute of <sgmltag>entry</sgmltag> elements 2250will be passed through to the HTML as a class attribute on the 2251<sgmltag>td</sgmltag> or <sgmltag>th</sgmltag> generated for the table 2252cell.</para> 2253 2254</refsect1> 2255</refentry> 2256 2257<refentry id="html.longdesc"> 2258<refmeta> 2259<refentrytitle>html.longdesc</refentrytitle> 2260<refmiscinfo role="type">boolean</refmiscinfo> 2261</refmeta> 2262<refnamediv> 2263<refname>html.longdesc</refname> 2264<refpurpose>Should longdesc URIs be created?</refpurpose> 2265</refnamediv> 2266 2267<refsynopsisdiv> 2268<programlisting id="html.longdesc.frag"> 2269<xsl:param name="html.longdesc" select="1"></xsl:param> 2270</programlisting> 2271</refsynopsisdiv> 2272 2273<refsect1><title>Description</title> 2274 2275<para>If non-zero, HTML files will be created for the 2276<sgmltag class="attribute">longdesc</sgmltag> attribute. These files 2277are created from the <sgmltag>textobject</sgmltag>s in 2278<sgmltag>mediaobject</sgmltag>s and 2279<sgmltag>inlinemediaobject</sgmltag>. 2280</para> 2281 2282</refsect1> 2283</refentry> 2284 2285<refentry id="html.longdesc.link"> 2286<refmeta> 2287<refentrytitle>html.longdesc.link</refentrytitle> 2288<refmiscinfo role="type">boolean</refmiscinfo> 2289</refmeta> 2290<refnamediv> 2291<refname>html.longdesc.link</refname> 2292<refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose> 2293</refnamediv> 2294 2295<refsynopsisdiv> 2296<programlisting id="html.longdesc.link.frag"> 2297<xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:param> 2298</programlisting> 2299</refsynopsisdiv> 2300 2301<refsect1><title>Description</title> 2302 2303<para>If non-zero, links will be created to the 2304HTML files created for the 2305<sgmltag class="attribute">longdesc</sgmltag> attribute. It makes no 2306sense to turn enable this option without also enabling the 2307<parameter>$html.longdesc</parameter> parameter.</para> 2308 2309<para>The <literal>longdesc.link</literal> named template is called 2310to construct the link.</para> 2311 2312</refsect1> 2313</refentry> 2314 2315<refentry id="make.valid.html"> 2316<refmeta> 2317<refentrytitle>make.valid.html</refentrytitle> 2318<refmiscinfo role="type">boolean</refmiscinfo> 2319</refmeta> 2320<refnamediv> 2321<refname>make.valid.html</refname> 2322<refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose> 2323</refnamediv> 2324 2325<refsynopsisdiv> 2326<programlisting id="make.valid.html.frag"> 2327<xsl:param name="make.valid.html" select="0"></xsl:param> 2328</programlisting> 2329</refsynopsisdiv> 2330 2331<refsect1><title>Description</title> 2332 2333<para>If <parameter>make.valid.html</parameter> is true, the stylesheets take 2334extra effort to ensure that the resulting HTML is valid. This may mean that some 2335<sgmltag>para</sgmltag> tags are translated into HTML <sgmltag>div</sgmltag>s or 2336that other substitutions occur.</para> 2337 2338<para>This parameter is different from <parameter>html.cleanup</parameter> 2339because it changes the resulting markup; it does not use extension functions 2340to manipulate result-tree-fragments and is therefore applicable to any 2341XSLT processor.</para> 2342 2343</refsect1> 2344</refentry> 2345 2346<refentry id="html.cleanup"> 2347<refmeta> 2348<refentrytitle>html.cleanup</refentrytitle> 2349<refmiscinfo role="type">boolean</refmiscinfo> 2350</refmeta> 2351<refnamediv> 2352<refname>html.cleanup</refname> 2353<refpurpose>Attempt to clean up the resulting HTML?</refpurpose> 2354</refnamediv> 2355 2356<refsynopsisdiv> 2357<programlisting id="html.cleanup.frag"> 2358<xsl:param name="html.cleanup" select="1"></xsl:param> 2359</programlisting> 2360</refsynopsisdiv> 2361 2362<refsect1><title>Description</title> 2363 2364<para>If non-zero, and if the <ulink url="http://www.exslt.org/">EXSLT</ulink> 2365extensions are supported by your processor, the resulting HTML will be 2366<quote>cleaned up</quote>. This improves the chances that the 2367resulting HTML will be valid. It may also improve the formatting of 2368some elements.</para> 2369 2370<para>This parameter is different from <parameter>make.valid.html</parameter> 2371because it uses extension functions to manipulate result-tree-fragments.</para> 2372 2373</refsect1> 2374</refentry> 2375 2376<refentry id="draft.mode"> 2377<refmeta> 2378<refentrytitle>draft.mode</refentrytitle> 2379<refmiscinfo role="type">list</refmiscinfo> 2380</refmeta> 2381<refnamediv> 2382<refname>draft.mode</refname> 2383<refpurpose>Select draft mode</refpurpose> 2384</refnamediv> 2385 2386<refsynopsisdiv> 2387<programlisting id="draft.mode.frag"> 2388<xsl:param name="draft.mode" select="'maybe'"></xsl:param> 2389</programlisting> 2390</refsynopsisdiv> 2391 2392<refsect1><title>Description</title> 2393 2394<para>Selects draft mode. If <parameter>draft.mode</parameter> is 2395<quote><literal>yes</literal></quote>, the entire document will be treated 2396as a draft. If it is <quote><literal>no</literal></quote>, the entire document 2397will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>, 2398individual sections will be treated as draft or final independently, depending 2399on how their <sgmltag class="attribute">status</sgmltag> attribute is set. 2400</para> 2401 2402</refsect1> 2403</refentry> 2404 2405<refentry id="draft.watermark.image"> 2406<refmeta> 2407<refentrytitle>draft.watermark.image</refentrytitle> 2408<refmiscinfo role="type">uri</refmiscinfo> 2409</refmeta> 2410<refnamediv> 2411<refname>draft.watermark.image</refname> 2412<refpurpose>The URI of the image to be used for draft watermarks</refpurpose> 2413</refnamediv> 2414 2415<refsynopsisdiv> 2416<programlisting id="draft.watermark.image.frag"> 2417<xsl:param name="draft.watermark.image" select="'http://docbook.sourceforge.net/release/images/draft.png'"></xsl:param> 2418</programlisting> 2419</refsynopsisdiv> 2420 2421<refsect1><title>Description</title> 2422 2423<para>The image to be used for draft watermarks.</para> 2424 2425</refsect1> 2426</refentry> 2427 2428<refentry id="generate.id.attributes"> 2429<refmeta> 2430<refentrytitle>generate.id.attributes</refentrytitle> 2431<refmiscinfo role="type"/> 2432</refmeta> 2433<refnamediv> 2434<refname>generate.id.attributes</refname> 2435<refpurpose/> 2436</refnamediv> 2437 2438<refsynopsisdiv> 2439<programlisting id="generate.id.attributes.frag"> 2440<xsl:param name="generate.id.attributes" select="0"></xsl:param> 2441</programlisting> 2442</refsynopsisdiv> 2443 2444<refsect1><title>Description</title> 2445 2446<para>If non-zero, the HTML stylesheet will generate ID attributes on 2447containers. For example, the markup:</para> 2448 2449<screen><section id="foo"><title>Some Title</title> 2450<para>Some para.</para> 2451</section></screen> 2452 2453<para>might produce:</para> 2454 2455<screen><div class="section" id="foo"> 2456<h2>Some Title</h2> 2457<p>Some para.</p> 2458</div></screen> 2459 2460<para>The alternative is to generate anchors:</para> 2461 2462<screen><div class="section"> 2463<h2><a name="foo"></a>Some Title</h2> 2464<p>Some para.</p> 2465</div></screen> 2466 2467<para>Because the <sgmltag class="attribute">name</sgmltag> attribute of 2468the <sgmltag>a</sgmltag> element and the <sgmltag class="attribute">id</sgmltag> 2469attribute of other tags are both of type <quote>ID</quote>, producing both 2470generates invalid documents.</para> 2471 2472<para>As of version 1.50, you can use this switch to control which type of 2473identifier is generated. For backwards-compatibility, generating 2474<sgmltag>a</sgmltag> anchors is preferred.</para> 2475 2476<para>Note: at present, this switch is incompletely implemented. 2477Disabling ID attributes will suppress them, but enabling ID attributes 2478will not suppress the anchors.</para> 2479 2480</refsect1> 2481</refentry> 2482 2483<refentry id="generate.meta.abstract"> 2484<refmeta> 2485<refentrytitle>generate.meta.abstract</refentrytitle> 2486<refmiscinfo role="type">boolean</refmiscinfo> 2487</refmeta> 2488<refnamediv> 2489<refname>generate.meta.abstract</refname> 2490<refpurpose>Generate HTML <sgmltag>META</sgmltag> element from <sgmltag>abstract</sgmltag>?</refpurpose> 2491</refnamediv> 2492 2493<refsynopsisdiv> 2494<programlisting id="generate.meta.abstract.frag"> 2495<xsl:param name="generate.meta.abstract" select="1"></xsl:param> 2496</programlisting> 2497</refsynopsisdiv> 2498 2499<refsect1><title>Description</title> 2500 2501<para>If non-zero, document abstracts will be reproduced in the HTML 2502<sgmltag>HEAD</sgmltag> with <sgmltag class="starttag">meta name="description" content="..."</sgmltag>.</para> 2503 2504</refsect1> 2505</refentry> 2506 2507</reference> 2508 2509<reference id="xslt"><title>XSLT Processing</title> 2510<refentry id="rootid"> 2511<refmeta> 2512<refentrytitle>rootid</refentrytitle> 2513<refmiscinfo role="type">string</refmiscinfo> 2514</refmeta> 2515<refnamediv> 2516<refname>rootid</refname> 2517<refpurpose>Specify the root element to format</refpurpose> 2518</refnamediv> 2519 2520<refsynopsisdiv> 2521<programlisting id="rootid.frag"><xsl:param name="rootid" select="''"></xsl:param></programlisting> 2522</refsynopsisdiv> 2523 2524<refsect1><title>Description</title> 2525 2526<para>If <parameter>rootid</parameter> is specified, it must be the 2527value of an ID that occurs in the document being formatted. The entire 2528document will be loaded and parsed, but formatting will begin at the 2529element identified, rather than at the root. For example, this allows 2530you to process only chapter 4 of a book.</para> 2531<para>Because the entire document is available to the processor, automatic 2532numbering, cross references, and other dependencies are correctly 2533resolved.</para> 2534 2535</refsect1> 2536</refentry> 2537 2538<refentry id="suppress.navigation"> 2539<refmeta> 2540<refentrytitle>suppress.navigation</refentrytitle> 2541<refmiscinfo role="type">boolean</refmiscinfo> 2542</refmeta> 2543<refnamediv> 2544<refname>suppress.navigation</refname> 2545<refpurpose>Disable header and footer navigation</refpurpose> 2546</refnamediv> 2547 2548<refsynopsisdiv> 2549<programlisting id="suppress.navigation.frag"><xsl:param name="suppress.navigation">0</xsl:param></programlisting> 2550</refsynopsisdiv> 2551 2552<refsect1><title>Description</title> 2553 2554<para> 2555If <literal>suppress.navigation</literal> is turned on, header and 2556footer navigation will be suppressed.</para> 2557 2558</refsect1> 2559</refentry> 2560 2561<refentry id="suppress.header.navigation"> 2562<refmeta> 2563<refentrytitle>suppress.header.navigation</refentrytitle> 2564<refmiscinfo role="type">boolean</refmiscinfo> 2565</refmeta> 2566<refnamediv> 2567<refname>suppress.header.navigation</refname> 2568<refpurpose>Disable header navigation</refpurpose> 2569</refnamediv> 2570 2571<refsynopsisdiv> 2572<programlisting id="suppress.header.navigation.frag"><xsl:param name="suppress.header.navigation">0</xsl:param></programlisting> 2573</refsynopsisdiv> 2574 2575<refsect1><title>Description</title> 2576 2577<para> 2578If <literal>suppress.header.navigation</literal> is turned on, header 2579navigation will be suppressed.</para> 2580 2581</refsect1> 2582</refentry> 2583 2584<refentry id="suppress.footer.navigation"> 2585<refmeta> 2586<refentrytitle>suppress.footer.navigation</refentrytitle> 2587<refmiscinfo role="type">boolean</refmiscinfo> 2588</refmeta> 2589<refnamediv> 2590<refname>suppress.footer.navigation</refname> 2591<refpurpose>Disable footer navigation</refpurpose> 2592</refnamediv> 2593 2594<refsynopsisdiv> 2595<programlisting id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></programlisting> 2596</refsynopsisdiv> 2597 2598<refsect1><title>Description</title> 2599 2600<para> 2601If <literal>suppress.footer.navigation</literal> is turned on, footer 2602navigation will be suppressed.</para> 2603 2604</refsect1> 2605</refentry> 2606 2607<refentry id="header.rule"> 2608<refmeta> 2609<refentrytitle>header.rule</refentrytitle> 2610<refmiscinfo role="type">boolean</refmiscinfo> 2611</refmeta> 2612<refnamediv> 2613<refname>header.rule</refname> 2614<refpurpose>Rule under headers?</refpurpose> 2615</refnamediv> 2616 2617<refsynopsisdiv> 2618<programlisting id="header.rule.frag"> 2619<xsl:param name="header.rule" select="1"></xsl:param> 2620</programlisting> 2621</refsynopsisdiv> 2622 2623<refsect1><title>Description</title> 2624 2625<para>If non-zero, a rule will be drawn below the page headers.</para> 2626 2627</refsect1> 2628</refentry> 2629 2630<refentry id="footer.rule"> 2631<refmeta> 2632<refentrytitle>footer.rule</refentrytitle> 2633<refmiscinfo role="type">boolean</refmiscinfo> 2634</refmeta> 2635<refnamediv> 2636<refname>footer.rule</refname> 2637<refpurpose>Rule over footers?</refpurpose> 2638</refnamediv> 2639 2640<refsynopsisdiv> 2641<programlisting id="footer.rule.frag"> 2642<xsl:param name="footer.rule" select="1"></xsl:param> 2643</programlisting> 2644</refsynopsisdiv> 2645 2646<refsect1><title>Description</title> 2647 2648<para>If non-zero, a rule will be drawn above the page footers.</para> 2649 2650</refsect1> 2651</refentry> 2652 2653<refentry id="id.warnings"> 2654<refmeta> 2655<refentrytitle>id.warnings</refentrytitle> 2656<refmiscinfo role="type">boolean</refmiscinfo> 2657</refmeta> 2658<refnamediv> 2659<refname>id.warnings</refname> 2660<refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose> 2661</refnamediv> 2662 2663<refsynopsisdiv> 2664<programlisting id="id.warnings.frag"> 2665<xsl:param name="id.warnings" select="1"></xsl:param> 2666</programlisting> 2667</refsynopsisdiv> 2668 2669<refsect1><title>Description</title> 2670 2671<para>If non-zero, the stylesheet will issue a warning for 2672any element (other than the root element) which 2673has a title but does not have an ID.</para> 2674 2675</refsect1> 2676</refentry> 2677 2678</reference> 2679 2680<reference id="meta"><title>Meta/*Info</title> 2681<refentry id="inherit.keywords"> 2682<refmeta> 2683<refentrytitle>inherit.keywords</refentrytitle> 2684<refmiscinfo role="type">boolean</refmiscinfo> 2685</refmeta> 2686<refnamediv> 2687<refname>inherit.keywords</refname> 2688<refpurpose>Inherit keywords from ancestor elements?</refpurpose> 2689</refnamediv> 2690 2691<refsynopsisdiv> 2692<programlisting id="inherit.keywords.frag"><xsl:param name="inherit.keywords" select="'1'"></xsl:param></programlisting> 2693</refsynopsisdiv> 2694 2695<refsect1><title>Description</title> 2696 2697<para>If <parameter>inherit.keywords</parameter> 2698is non-zero, the keyword <sgmltag>META</sgmltag> for each HTML 2699<sgmltag>HEAD</sgmltag> element will include all of the keywords from 2700ancestral elements. Otherwise, only the keywords from the current section 2701will be used. 2702</para> 2703 2704</refsect1> 2705</refentry> 2706 2707<refentry id="make.single.year.ranges"> 2708<refmeta> 2709<refentrytitle>make.single.year.ranges</refentrytitle> 2710<refmiscinfo role="type">boolean</refmiscinfo> 2711</refmeta> 2712<refnamediv> 2713<refname>make.single.year.ranges</refname> 2714<refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose> 2715</refnamediv> 2716 2717<refsynopsisdiv> 2718<programlisting id="make.single.year.ranges.frag"><xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting> 2719</refsynopsisdiv> 2720 2721<refsect1><title>Description</title> 2722 2723<para>If non-zero, year ranges that span a single year will be printed 2724in range notation (1998-1999) instead of discrete notation 2725(1998, 1999).</para> 2726 2727</refsect1> 2728</refentry> 2729 2730<refentry id="make.year.ranges"> 2731<refmeta> 2732<refentrytitle>make.year.ranges</refentrytitle> 2733<refmiscinfo role="type">boolean</refmiscinfo> 2734</refmeta> 2735<refnamediv> 2736<refname>make.year.ranges</refname> 2737<refpurpose>Collate copyright years into ranges?</refpurpose> 2738</refnamediv> 2739 2740<refsynopsisdiv> 2741<programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting> 2742</refsynopsisdiv> 2743 2744<refsect1><title>Description</title> 2745 2746<para>If non-zero, copyright years will be collated into ranges.</para> 2747 2748</refsect1> 2749</refentry> 2750 2751<refentry id="author.othername.in.middle"> 2752<refmeta> 2753<refentrytitle>author.othername.in.middle</refentrytitle> 2754<refmiscinfo role="type">boolean</refmiscinfo> 2755</refmeta> 2756<refnamediv> 2757<refname>author.othername.in.middle</refname> 2758<refpurpose>Is <sgmltag>othername</sgmltag> in <sgmltag>author</sgmltag> a 2759middle name?</refpurpose> 2760</refnamediv> 2761 2762<refsynopsisdiv> 2763<programlisting id="author.othername.in.middle.frag"><xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting> 2764</refsynopsisdiv> 2765 2766<refsect1><title>Description</title> 2767 2768<para>If true (non-zero), the <sgmltag>othername</sgmltag> of an <sgmltag>author</sgmltag> 2769appears between the <sgmltag>firstname</sgmltag> and 2770<sgmltag>surname</sgmltag>. Otherwise, <sgmltag>othername</sgmltag> 2771is suppressed. 2772</para> 2773 2774</refsect1> 2775</refentry> 2776 2777<refentry id="generate.legalnotice.link"> 2778<refmeta> 2779<refentrytitle>generate.legalnotice.link</refentrytitle> 2780<refmiscinfo role="type">boolean</refmiscinfo> 2781</refmeta> 2782<refnamediv> 2783<refname>generate.legalnotice.link</refname> 2784<refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose> 2785</refnamediv> 2786 2787<refsynopsisdiv> 2788<programlisting id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"></xsl:param></programlisting> 2789</refsynopsisdiv> 2790 2791<refsect1><title>Description</title> 2792 2793<para>If the value of <parameter>generate.legalnotice.link</parameter> 2794is non-zero, the stylesheet: 2795 2796<itemizedlist> 2797 <listitem> 2798 <para>writes the contents of <tag>legalnotice</tag> to a separate 2799 HTML file</para> 2800 </listitem> 2801 <listitem> 2802 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para> 2803 </listitem> 2804 <listitem> 2805 <para>adds (in the HTML <literal>head</literal>) either a single 2806 <literal>link</literal> or element or multiple 2807 <literal>link</literal> elements (depending on the value of the 2808 <parameter>html.head.legalnotice.link.multiple</parameter> 2809 parameter), with the value or values derived from the 2810 <parameter>html.head.legalnotice.link.types</parameter> 2811 parameter</para> 2812 </listitem> 2813 </itemizedlist> 2814 2815 Otherwise, if <parameter>generate.legalnotice.link</parameter> is 2816 zero, <tag>legalnotice</tag> contents are rendered on the title 2817 page.</para> 2818 2819</refsect1> 2820</refentry> 2821 2822<refentry id="generate.revhistory.link"> 2823<refmeta> 2824<refentrytitle>generate.revhistory.link</refentrytitle> 2825<refmiscinfo role="type">boolean</refmiscinfo> 2826</refmeta> 2827<refnamediv> 2828<refname>generate.revhistory.link</refname> 2829<refpurpose>Write revhistory to separate chunk and generate link?</refpurpose> 2830</refnamediv> 2831 2832<refsynopsisdiv> 2833<programlisting id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"></xsl:param></programlisting> 2834</refsynopsisdiv> 2835 2836<refsect1><title>Description</title> 2837 2838<para>If non-zero, the contents of <tag>revhistory</tag> are written 2839to a separate HTML file and a link to the file is 2840generated. Otherwise, <tag>revhistory</tag> contents are rendered on 2841the title page.</para> 2842 2843</refsect1> 2844</refentry> 2845 2846<refentry id="html.head.legalnotice.link.types"> 2847<refmeta> 2848<refentrytitle>html.head.legalnotice.link.types</refentrytitle> 2849<refmiscinfo role="type">string</refmiscinfo> 2850</refmeta> 2851<refnamediv> 2852<refname>html.head.legalnotice.link.types</refname> 2853<refpurpose>Specifies link types for legalnotice link in html head</refpurpose> 2854</refnamediv> 2855 2856<refsynopsisdiv> 2857<programlisting id="html.head.legalnotice.link.types.frag"> 2858<xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param> 2859</programlisting> 2860</refsynopsisdiv> 2861 2862<refsect1><title>Description</title> 2863 2864<para>The value of 2865<parameter>html.head.legalnotice.link.types</parameter> is a 2866space-separated list of link types, as described in <ulink url="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12 2867of the HTML 4.01 specification</ulink>. If the value of the 2868<parameter>generate.legalnotice.link</parameter> parameter is 2869non-zero, then the stylesheet generates (in the 2870<literal>head</literal> section of the HTML source) either a single 2871HTML <literal>link</literal> element or, if the value of the 2872<parameter>html.head.legalnotice.link.multiple</parameter> is 2873non-zero, one <literal>link</literal> element for each link type 2874specified. Each <literal>link</literal> has the following attributes: 2875 2876<itemizedlist> 2877 <listitem> 2878 <para>a <sgmltag class="attribute">rel</sgmltag> attribute whose 2879 value is derived from the value of 2880 <parameter>html.head.legalnotice.link.types</parameter></para> 2881 </listitem> 2882 <listitem> 2883 <para>an <sgmltag class="attribute">href</sgmltag> attribute whose 2884 value is set to the URL of the file containing the 2885 <sgmltag>legalnotice</sgmltag></para> 2886 </listitem> 2887 <listitem> 2888 <para>a <sgmltag class="attribute">title</sgmltag> attribute whose 2889 value is set to the title of the corresponding 2890 <sgmltag>legalnotice</sgmltag> (or a title programatically 2891 determined by the stylesheet)</para> 2892 </listitem> 2893</itemizedlist> 2894 2895For example: 2896 2897<screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> 2898</para> 2899 2900<refsect2> 2901 <title>About the default value</title> 2902 <para>In an ideal world, the default value of 2903 <parameter>html.head.legalnotice.link.types</parameter> would 2904 probably be ���<literal>license</literal>���, since the content of the 2905 DocBook <sgmltag>legalnotice</sgmltag> is typically license 2906 information, not copyright information. However, the default value 2907 is ���<literal>copyright</literal>��� for pragmatic reasons: because 2908 that���s among the set of ���recognized link types��� listed in <ulink url="http://www.w3.org/TR/html401/types.html#type-links">Section 2909 6.12 of the HTML 4.01 specification</ulink>, and because certain 2910 browsers and browser extensions are preconfigured to recognize that 2911 value.</para> 2912</refsect2> 2913 2914</refsect1> 2915</refentry> 2916 2917<refentry id="html.head.legalnotice.link.multiple"> 2918<refmeta> 2919<refentrytitle>html.head.legalnotice.link.multiple</refentrytitle> 2920<refmiscinfo role="type">boolean</refmiscinfo> 2921</refmeta> 2922<refnamediv> 2923<refname>html.head.legalnotice.link.multiple</refname> 2924<refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose> 2925</refnamediv> 2926 2927<refsynopsisdiv> 2928<programlisting id="html.head.legalnotice.link.multiple.frag"><xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param></programlisting> 2929</refsynopsisdiv> 2930 2931<refsect1><title>Description</title> 2932 2933<para>If <parameter>html.head.legalnotice.link.multiple</parameter> is 2934non-zero and the value of 2935<parameter>html.head.legalnotice.link.types</parameter> contains 2936multiple link types, then the stylesheet generates (in the 2937<literal>head</literal> section of the HTML source) one 2938<literal>link</literal> element for each link type specified. For 2939example, if the value of 2940<parameter>html.head.legalnotice.link.types</parameter> is 2941���<literal>copyright license</literal>���: 2942 2943<screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice"> 2944 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> 2945 2946 Otherwise, the stylesheet generates generates a single 2947 <literal>link</literal> instance; for example: 2948 2949<screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen> 2950 2951</para> 2952</refsect1> 2953</refentry> 2954 2955</reference> 2956 2957<reference id="refentry"><title>Reference Pages</title> 2958<refentry id="funcsynopsis.decoration"> 2959<refmeta> 2960<refentrytitle>funcsynopsis.decoration</refentrytitle> 2961<refmiscinfo role="type">boolean</refmiscinfo> 2962</refmeta> 2963<refnamediv> 2964<refname>funcsynopsis.decoration</refname> 2965<refpurpose>Decorate elements of a FuncSynopsis?</refpurpose> 2966</refnamediv> 2967 2968<refsynopsisdiv> 2969<programlisting id="funcsynopsis.decoration.frag"><xsl:param name="funcsynopsis.decoration" select="1"></xsl:param></programlisting> 2970</refsynopsisdiv> 2971 2972<refsect1><title>Description</title> 2973 2974<para>If true (non-zero), elements of the FuncSynopsis will be decorated (e.g. bold or 2975italic). The decoration is controlled by functions that can be redefined 2976in a customization layer. 2977</para> 2978 2979</refsect1> 2980</refentry> 2981 2982<refentry id="funcsynopsis.style"> 2983<refmeta> 2984<refentrytitle>funcsynopsis.style</refentrytitle> 2985<refmiscinfo role="type">list</refmiscinfo> 2986<refmiscinfo role="value">ansi</refmiscinfo> 2987<refmiscinfo role="value">kr</refmiscinfo> 2988</refmeta> 2989<refnamediv> 2990<refname>funcsynopsis.style</refname> 2991<refpurpose>What style of 'FuncSynopsis' should be generated?</refpurpose> 2992</refnamediv> 2993 2994<refsynopsisdiv> 2995<programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting> 2996</refsynopsisdiv> 2997 2998<refsect1><title>Description</title> 2999 3000<para>If <varname>funcsynopsis.style</varname> is <literal>ansi</literal>, 3001ANSI-style function synopses are generated for a 3002<sgmltag>funcsynopsis</sgmltag>, otherwise K&R-style 3003function synopses are generated. 3004</para> 3005 3006</refsect1> 3007</refentry> 3008 3009<refentry id="funcsynopsis.tabular.threshold"> 3010<refmeta> 3011<refentrytitle>funcsynopsis.tabular.threshold</refentrytitle> 3012<refmiscinfo role="type">integer</refmiscinfo> 3013</refmeta> 3014<refnamediv> 3015<refname>funcsynopsis.tabular.threshold</refname> 3016<refpurpose>Width beyond which a tabular presentation will be used</refpurpose> 3017</refnamediv> 3018 3019<refsynopsisdiv> 3020<programlisting id="funcsynopsis.tabular.threshold.frag"> 3021<xsl:param name="funcsynopsis.tabular.threshold" select="40"></xsl:param> 3022</programlisting> 3023</refsynopsisdiv> 3024 3025<refsect1><title>Description</title> 3026 3027<para>If <parameter>funcsynopsis.tabular.threshold</parameter> is greater than 3028zero then if a <sgmltag>funcprototype</sgmltag> is wider than the threshold 3029value, it will be presented in a table.</para> 3030 3031</refsect1> 3032</refentry> 3033 3034<refentry id="function.parens"> 3035<refmeta> 3036<refentrytitle>function.parens</refentrytitle> 3037<refmiscinfo role="type">boolean</refmiscinfo> 3038</refmeta> 3039<refnamediv> 3040<refname>function.parens</refname> 3041<refpurpose>Generate parens after a function?</refpurpose> 3042</refnamediv> 3043 3044<refsynopsisdiv> 3045<programlisting id="function.parens.frag"><xsl:param name="function.parens">0</xsl:param></programlisting> 3046</refsynopsisdiv> 3047 3048<refsect1><title>Description</title> 3049 3050<para>If not 0, the formatting of 3051a <sgmltag class="starttag">function</sgmltag> element will include 3052generated parenthesis. 3053</para> 3054 3055</refsect1> 3056</refentry> 3057 3058<refentry id="refentry.generate.name"> 3059<refmeta> 3060<refentrytitle>refentry.generate.name</refentrytitle> 3061<refmiscinfo role="type">boolean</refmiscinfo> 3062</refmeta> 3063<refnamediv> 3064<refname>refentry.generate.name</refname> 3065<refpurpose>Output NAME header before 'RefName'(s)?</refpurpose> 3066</refnamediv> 3067 3068<refsynopsisdiv> 3069<programlisting id="refentry.generate.name.frag"><xsl:param name="refentry.generate.name" select="1"></xsl:param></programlisting> 3070</refsynopsisdiv> 3071 3072<refsect1><title>Description</title> 3073 3074<para>If true (non-zero), a "NAME" section title is output before the list 3075of 'RefName's. This parameter and 3076<parameter>refentry.generate.title</parameter> are mutually 3077exclusive. This means that if you change this parameter to zero, you 3078should set <parameter>refentry.generate.title</parameter> to 1 unless 3079you want get quite strange output. 3080</para> 3081 3082</refsect1> 3083</refentry> 3084 3085<refentry id="refentry.generate.title"> 3086<refmeta> 3087<refentrytitle>refentry.generate.title</refentrytitle> 3088<refmiscinfo role="type">boolean</refmiscinfo> 3089</refmeta> 3090<refnamediv> 3091<refname>refentry.generate.title</refname> 3092<refpurpose>Output title before 'RefName'(s)?</refpurpose> 3093</refnamediv> 3094 3095<refsynopsisdiv> 3096<programlisting id="refentry.generate.title.frag"> 3097<xsl:param name="refentry.generate.title" select="0"></xsl:param> 3098</programlisting> 3099</refsynopsisdiv> 3100 3101<refsect1><title>Description</title> 3102 3103<para>If true (non-zero), the reference page title or first name is 3104output before the list of 'RefName's. This parameter and 3105<parameter>refentry.generate.name</parameter> are mutually exclusive. 3106This means that if you change this parameter to 1, you 3107should set <parameter>refentry.generate.name</parameter> to 0 unless 3108you want get quite strange output.</para> 3109 3110 3111</refsect1> 3112</refentry> 3113 3114<refentry id="refentry.xref.manvolnum"> 3115<refmeta> 3116<refentrytitle>refentry.xref.manvolnum</refentrytitle> 3117<refmiscinfo role="type">boolean</refmiscinfo> 3118</refmeta> 3119<refnamediv> 3120<refname>refentry.xref.manvolnum</refname> 3121<refpurpose>Output <sgmltag>manvolnum</sgmltag> as part of 3122<sgmltag>refentry</sgmltag> cross-reference?</refpurpose> 3123</refnamediv> 3124 3125<refsynopsisdiv> 3126<programlisting id="refentry.xref.manvolnum.frag"><xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param></programlisting> 3127</refsynopsisdiv> 3128 3129<refsect1><title>Description</title> 3130 3131<para>if true (non-zero), the <sgmltag>manvolnum</sgmltag> is used when cross-referencing 3132<sgmltag>refentry</sgmltag>s, either with <sgmltag>xref</sgmltag> 3133or <sgmltag>citerefentry</sgmltag>. 3134</para> 3135 3136</refsect1> 3137</refentry> 3138 3139<refentry id="citerefentry.link"> 3140<refmeta> 3141<refentrytitle>citerefentry.link</refentrytitle> 3142<refmiscinfo role="type">boolean</refmiscinfo> 3143</refmeta> 3144<refnamediv> 3145<refname>citerefentry.link</refname> 3146<refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> 3147</refnamediv> 3148 3149<refsynopsisdiv> 3150<programlisting id="citerefentry.link.frag"><xsl:param name="citerefentry.link" select="'0'"></xsl:param></programlisting> 3151</refsynopsisdiv> 3152 3153<refsect1><title>Description</title> 3154 3155<para>If true, a web link will be generated, presumably 3156to an online man->HTML gateway. The text of the link is 3157generated by the generate.citerefentry.link template. 3158</para> 3159 3160</refsect1> 3161</refentry> 3162 3163<refentry id="refentry.separator"> 3164<refmeta> 3165<refentrytitle>refentry.separator</refentrytitle> 3166<refmiscinfo role="type">boolean</refmiscinfo> 3167</refmeta> 3168<refnamediv> 3169<refname>refentry.separator</refname> 3170<refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose> 3171</refnamediv> 3172 3173<refsynopsisdiv> 3174<programlisting id="refentry.separator.frag"><xsl:param name="refentry.separator" select="'1'"></xsl:param></programlisting> 3175</refsynopsisdiv> 3176 3177<refsect1><title>Description</title> 3178 3179<para>If true, a separator will be generated between consecutive 3180reference pages. 3181</para> 3182 3183</refsect1> 3184</refentry> 3185 3186<refentry id="refclass.suppress"> 3187<refmeta> 3188<refentrytitle>refclass.suppress</refentrytitle> 3189<refmiscinfo role="type">boolean</refmiscinfo> 3190</refmeta> 3191<refnamediv> 3192<refname>refclass.suppress</refname> 3193<refpurpose>Suppress display of refclass contents?</refpurpose> 3194</refnamediv> 3195 3196<refsynopsisdiv> 3197<programlisting id="refclass.suppress.frag"> 3198<xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting> 3199</refsynopsisdiv> 3200 3201<refsect1><title>Description</title> 3202 3203<para>If the value of <parameter>refclass.suppress</parameter> is 3204non-zero, then display of <sgmltag>refclass</sgmltag> contents is 3205suppressed in output.</para> 3206 3207</refsect1> 3208</refentry> 3209 3210</reference> 3211 3212<reference id="tables"><title>Tables</title> 3213<refentry id="default.table.width"> 3214<refmeta> 3215<refentrytitle>default.table.width</refentrytitle> 3216<refmiscinfo role="type">length</refmiscinfo> 3217</refmeta> 3218<refnamediv> 3219<refname>default.table.width</refname> 3220<refpurpose>The default width of tables</refpurpose> 3221</refnamediv> 3222 3223<refsynopsisdiv> 3224<programlisting id="default.table.width.frag"><xsl:param name="default.table.width" select="''"></xsl:param></programlisting> 3225</refsynopsisdiv> 3226 3227<refsect1><title>Description</title> 3228 3229<para>If specified, this value will be used for the WIDTH attribute on 3230tables that do not specify an alternate width (with the dbhtml processing 3231instruction).</para> 3232 3233</refsect1> 3234</refentry> 3235 3236<refentry id="nominal.table.width"> 3237<refmeta> 3238<refentrytitle>nominal.table.width</refentrytitle> 3239<refmiscinfo role="type">length</refmiscinfo> 3240</refmeta> 3241<refnamediv> 3242<refname>nominal.table.width</refname> 3243<refpurpose>The (absolute) nominal width of tables</refpurpose> 3244</refnamediv> 3245 3246<refsynopsisdiv> 3247<programlisting id="nominal.table.width.frag"><xsl:param name="nominal.table.width" select="'6in'"></xsl:param></programlisting> 3248</refsynopsisdiv> 3249 3250<refsect1><title>Description</title> 3251 3252<para>In order to convert CALS column widths into HTML column widths, it 3253is sometimes necessary to have an absolute table width to use for conversion 3254of mixed absolute and relative widths. This value must be an absolute 3255length (not a percentag).</para> 3256 3257</refsect1> 3258</refentry> 3259 3260<refentry id="table.borders.with.css"> 3261<refmeta> 3262<refentrytitle>table.borders.with.css</refentrytitle> 3263<refmiscinfo role="type">boolean</refmiscinfo> 3264</refmeta> 3265<refnamediv> 3266<refname>table.borders.with.css</refname> 3267<refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose> 3268</refnamediv> 3269 3270<refsynopsisdiv> 3271<programlisting id="table.borders.with.css.frag"> 3272<xsl:param name="table.borders.with.css" select="0"></xsl:param> 3273</programlisting> 3274</refsynopsisdiv> 3275 3276<refsect1><title>Description</title> 3277 3278<para>If true (non-zero), CSS will be used to draw table borders. 3279</para> 3280 3281</refsect1> 3282</refentry> 3283 3284<refentry id="table.cell.border.style"> 3285<refmeta> 3286<refentrytitle>table.cell.border.style</refentrytitle> 3287<refmiscinfo role="type"/> 3288</refmeta> 3289<refnamediv> 3290<refname>table.cell.border.style</refname> 3291<refpurpose/> 3292</refnamediv> 3293 3294<refsynopsisdiv> 3295<programlisting id="table.cell.border.style.frag"> 3296<xsl:param name="table.cell.border.style" select="'solid'"></xsl:param> 3297</programlisting> 3298</refsynopsisdiv> 3299 3300<refsect1><title>Description</title> 3301 3302<para>FIXME:</para> 3303 3304</refsect1> 3305</refentry> 3306 3307<refentry id="table.cell.border.thickness"> 3308<refmeta> 3309<refentrytitle>table.cell.border.thickness</refentrytitle> 3310<refmiscinfo role="type"/> 3311</refmeta> 3312<refnamediv> 3313<refname>table.cell.border.thickness</refname> 3314<refpurpose/> 3315</refnamediv> 3316 3317<refsynopsisdiv> 3318<programlisting id="table.cell.border.thickness.frag"> 3319<xsl:param name="table.cell.border.thickness" select="'0.5pt'"></xsl:param> 3320</programlisting> 3321</refsynopsisdiv> 3322 3323<refsect1><title>Description</title> 3324 3325<para>FIXME:</para> 3326 3327</refsect1> 3328</refentry> 3329 3330<refentry id="table.cell.border.color"> 3331<refmeta> 3332<refentrytitle>table.cell.border.color</refentrytitle> 3333<refmiscinfo role="type"/> 3334</refmeta> 3335<refnamediv> 3336<refname>table.cell.border.color</refname> 3337<refpurpose/> 3338</refnamediv> 3339 3340<refsynopsisdiv> 3341<programlisting id="table.cell.border.color.frag"> 3342<xsl:param name="table.cell.border.color" select="''"></xsl:param> 3343 3344</programlisting> 3345</refsynopsisdiv> 3346 3347<refsect1><title>Description</title> 3348 3349<para>FIXME:</para> 3350 3351</refsect1> 3352</refentry> 3353 3354<refentry id="table.frame.border.style"> 3355<refmeta> 3356<refentrytitle>table.frame.border.style</refentrytitle> 3357<refmiscinfo role="type"/> 3358</refmeta> 3359<refnamediv> 3360<refname>table.frame.border.style</refname> 3361<refpurpose/> 3362</refnamediv> 3363 3364<refsynopsisdiv> 3365<programlisting id="table.frame.border.style.frag"> 3366<xsl:param name="table.frame.border.style" select="'solid'"></xsl:param> 3367</programlisting> 3368</refsynopsisdiv> 3369 3370<refsect1><title>Description</title> 3371 3372<para>FIXME:</para> 3373 3374</refsect1> 3375</refentry> 3376 3377<refentry id="table.frame.border.thickness"> 3378<refmeta> 3379<refentrytitle>table.frame.border.thickness</refentrytitle> 3380<refmiscinfo role="type"/> 3381</refmeta> 3382<refnamediv> 3383<refname>table.frame.border.thickness</refname> 3384<refpurpose>Specifies the thickness of the frame border</refpurpose> 3385</refnamediv> 3386 3387<refsynopsisdiv> 3388<programlisting id="table.frame.border.thickness.frag"> 3389<xsl:param name="table.frame.border.thickness" select="'0.5pt'"></xsl:param> 3390</programlisting> 3391</refsynopsisdiv> 3392 3393<refsect1><title>Description</title> 3394 3395<para>Specifies the thickness of the border on the table's frame.</para> 3396 3397</refsect1> 3398</refentry> 3399 3400<refentry id="table.frame.border.color"> 3401<refmeta> 3402<refentrytitle>table.frame.border.color</refentrytitle> 3403<refmiscinfo role="type"/> 3404</refmeta> 3405<refnamediv> 3406<refname>table.frame.border.color</refname> 3407<refpurpose/> 3408</refnamediv> 3409 3410<refsynopsisdiv> 3411<programlisting id="table.frame.border.color.frag"> 3412<xsl:param name="table.frame.border.color" select="''"></xsl:param> 3413 3414</programlisting> 3415</refsynopsisdiv> 3416 3417<refsect1><title>Description</title> 3418 3419<para>FIXME:</para> 3420 3421</refsect1> 3422</refentry> 3423 3424<refentry id="default.table.frame"> 3425<refmeta> 3426<refentrytitle>default.table.frame</refentrytitle> 3427<refmiscinfo role="type">string</refmiscinfo> 3428</refmeta> 3429<refnamediv> 3430<refname>default.table.frame</refname> 3431<refpurpose>The default framing of tables</refpurpose> 3432</refnamediv> 3433 3434<refsynopsisdiv> 3435<programlisting id="default.table.frame.frag"><xsl:param name="default.table.frame" select="'all'"></xsl:param></programlisting> 3436</refsynopsisdiv> 3437 3438<refsect1><title>Description</title> 3439 3440<para>This value will be used when there is no frame attribute on the table.</para> 3441 3442</refsect1> 3443</refentry> 3444 3445<refentry id="html.cellspacing"> 3446<refmeta> 3447<refentrytitle>html.cellspacing</refentrytitle> 3448<refmiscinfo role="type">integer</refmiscinfo> 3449</refmeta> 3450<refnamediv> 3451<refname>html.cellspacing</refname> 3452<refpurpose>Default value for cellspacing in HTML tables</refpurpose> 3453</refnamediv> 3454 3455<refsynopsisdiv> 3456<programlisting id="html.cellspacing.frag"> 3457<xsl:param name="html.cellspacing" select="''"></xsl:param> 3458</programlisting> 3459</refsynopsisdiv> 3460 3461<refsect1><title>Description</title> 3462 3463<para>If specified, this value will be used as the default cellspacing value 3464in HTML tables.</para> 3465 3466</refsect1> 3467</refentry> 3468 3469<refentry id="html.cellpadding"> 3470<refmeta> 3471<refentrytitle>html.cellpadding</refentrytitle> 3472<refmiscinfo role="type">integer</refmiscinfo> 3473</refmeta> 3474<refnamediv> 3475<refname>html.cellpadding</refname> 3476<refpurpose>Default value for cellpadding in HTML tables</refpurpose> 3477</refnamediv> 3478 3479<refsynopsisdiv> 3480<programlisting id="html.cellpadding.frag"> 3481<xsl:param name="html.cellpadding" select="''"></xsl:param> 3482</programlisting> 3483</refsynopsisdiv> 3484 3485<refsect1><title>Description</title> 3486 3487<para>If specified, this value will be used as the default cellpadding value 3488in HTML tables.</para> 3489 3490</refsect1> 3491</refentry> 3492 3493</reference> 3494 3495<reference id="qa"><title>QAndASet</title> 3496<refentry id="qanda.defaultlabel"> 3497<refmeta> 3498<refentrytitle>qanda.defaultlabel</refentrytitle> 3499<refmiscinfo role="type">boolean</refmiscinfo> 3500</refmeta> 3501<refnamediv> 3502<refname>qanda.defaultlabel</refname> 3503<refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> 3504</refnamediv> 3505 3506<refsynopsisdiv> 3507<programlisting id="qanda.defaultlabel.frag"><xsl:param name="qanda.defaultlabel">number</xsl:param></programlisting> 3508</refsynopsisdiv> 3509 3510<refsect1><title>Description</title> 3511 3512<para>If no defaultlabel attribute is specified on a QandASet, this 3513value is used. It must be one of the legal values for the defaultlabel 3514attribute. 3515</para> 3516 3517</refsect1> 3518</refentry> 3519 3520<refentry id="qanda.inherit.numeration"> 3521<refmeta> 3522<refentrytitle>qanda.inherit.numeration</refentrytitle> 3523<refmiscinfo role="type">boolean</refmiscinfo> 3524</refmeta> 3525<refnamediv> 3526<refname>qanda.inherit.numeration</refname> 3527<refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose> 3528</refnamediv> 3529 3530<refsynopsisdiv> 3531<programlisting id="qanda.inherit.numeration.frag"><xsl:param name="qanda.inherit.numeration" select="1"></xsl:param></programlisting> 3532</refsynopsisdiv> 3533 3534<refsect1><title>Description</title> 3535 3536<para>If true (non-zero), numbered QandADiv elements and Questions and Answers inherit 3537the numeration of the ancestors of the QandASet. 3538</para> 3539 3540</refsect1> 3541</refentry> 3542 3543</reference> 3544 3545<reference id="links"><title>Linking</title> 3546<refentry id="target.database.document"> 3547<refmeta> 3548<refentrytitle>target.database.document</refentrytitle> 3549<refmiscinfo role="type">uri</refmiscinfo> 3550</refmeta> 3551<refnamediv> 3552<refname>target.database.document</refname> 3553<refpurpose>Name of master database file for resolving 3554olinks</refpurpose> 3555</refnamediv> 3556<refsynopsisdiv> <programlisting id="target.database.document.frag"> 3557<xsl:param name="target.database.document" select="''"></xsl:param> 3558</programlisting> 3559</refsynopsisdiv> 3560<refsect1> 3561<title>Description</title> 3562<para> 3563To resolve olinks between documents, the stylesheets use 3564a master database document that identifies the target datafiles for all the documents within the scope 3565of the olinks. This parameter value is the URI of 3566the master document to be read during processing to resolve olinks. 3567The default value is <filename>olinkdb.xml</filename>.</para> 3568<para>The data structure of the file is defined in the <filename>targetdatabase.dtd</filename> DTD. The database file provides the high level elements to record the identifiers, locations, and relationships of documents. The cross reference data for individual documents is generally pulled into the database using system entity references or XIncludes. See also <parameter>targets.filename</parameter>. 3569 3570</para> 3571</refsect1> 3572</refentry> 3573 3574<refentry id="targets.filename"> 3575<refmeta> 3576<refentrytitle>targets.filename</refentrytitle> 3577<refmiscinfo role="type">string</refmiscinfo> 3578</refmeta> 3579<refnamediv> 3580<refname>targets.filename</refname> 3581<refpurpose>Name of cross reference targets data file</refpurpose> 3582</refnamediv> 3583<refsynopsisdiv> <programlisting id="targets.filename.frag"> 3584<xsl:param name="targets.filename" select="'target.db'"></xsl:param> 3585</programlisting> 3586</refsynopsisdiv> 3587<refsect1> 3588<title>Description</title> 3589<para> 3590In order to resolve olinks efficiently, the stylesheets can 3591generate an external data file containing information about 3592all potential cross reference endpoints in a document. 3593This parameter lets you change the name of the generated 3594file from the default name <filename>target.db</filename>. 3595The name must agree with that used in the target database 3596used to resolve olinks during processing. 3597See also <parameter>target.database.document</parameter>. 3598</para> 3599</refsect1> 3600</refentry> 3601 3602<refentry id="olink.base.uri"> 3603<refmeta> 3604<refentrytitle>olink.base.uri</refentrytitle> 3605<refmiscinfo role="type">uri</refmiscinfo> 3606</refmeta> 3607<refnamediv> 3608<refname>olink.base.uri</refname> 3609<refpurpose>Base URI used in olink hrefs</refpurpose> 3610</refnamediv> 3611<refsynopsisdiv> <programlisting id="olink.base.uri.frag"> 3612<xsl:param name="olink.base.uri" select="''"></xsl:param> </programlisting> 3613</refsynopsisdiv> 3614<refsect1> 3615<title>Description</title> 3616<para>When cross reference data is collected for resolving olinks, it may be necessary to prepend a base URI to each target's href. This parameter lets you set that base URI when cross reference data is collected. This feature is needed when you want to link to a document that is processed without chunking. The output filename for such a document is not known to the XSL stylesheet; the only target information consists of fragment identifiers such as <literal>#idref</literal>. To enable the resolution of olinks between documents, you should pass the name of the HTML output file as the value of this parameter. Then the hrefs recorded in the cross reference data collection look like <literal>outfile.html#idref</literal>, which can be reached as links from other documents.</para> 3617</refsect1> 3618</refentry> 3619 3620<refentry id="use.local.olink.style"> 3621<refmeta> 3622<refentrytitle>use.local.olink.style</refentrytitle> 3623<refmiscinfo role="type">boolean</refmiscinfo> 3624</refmeta> 3625<refnamediv> 3626<refname>use.local.olink.style</refname> 3627<refpurpose>Process olinks using xref style of current 3628document</refpurpose> 3629</refnamediv> 3630<refsynopsisdiv> <programlisting id="use.local.olink.style.frag"> 3631<xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting> 3632</refsynopsisdiv> 3633<refsect1> 3634<title>Description</title> 3635<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 3636reference string is formed again from the target title, number, and 3637element name, using the stylesheet processing the targeting document. 3638Then olinks will match the xref style in the targeting document 3639rather than in the target document. If both documents are processed 3640with the same stylesheet, then the results will be the same.</para> 3641</refsect1> 3642</refentry> 3643 3644<refentry id="current.docid"> 3645<refmeta> 3646<refentrytitle>current.docid</refentrytitle> 3647<refmiscinfo role="type">string</refmiscinfo> 3648</refmeta> 3649<refnamediv> 3650<refname>current.docid</refname> 3651<refpurpose>targetdoc identifier for the document being 3652processed</refpurpose> 3653</refnamediv> 3654<refsynopsisdiv> <programlisting id="current.docid.frag"> 3655<xsl:param name="current.docid" select="''"></xsl:param> </programlisting> 3656</refsynopsisdiv> 3657<refsect1> 3658<title>Description</title> 3659<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 3660the targetdoc identifier of the current document, since that 3661identifier does not appear in the document itself. </para> 3662<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> 3663</refsect1> 3664</refentry> 3665 3666<refentry id="olink.doctitle"> 3667<refmeta> 3668<refentrytitle>olink.doctitle</refentrytitle> 3669<refmiscinfo role="type">string</refmiscinfo> 3670</refmeta> 3671<refnamediv> 3672<refname>olink.doctitle</refname> 3673<refpurpose>show the document title for external olinks?</refpurpose> 3674 3675</refnamediv> 3676<refsynopsisdiv> <programlisting id="olink.doctitle.frag"> 3677<xsl:param name="olink.doctitle" select="'no'"></xsl:param> </programlisting> 3678</refsynopsisdiv> 3679<refsect1> 3680<title>Description</title> 3681<para>When olinks between documents are resolved, the generated text 3682may not make it clear that the reference is to another document. 3683It is possible for the stylesheets to append the other document's 3684title to external olinks. For this to happen, two parameters must 3685be set.</para> 3686<itemizedlist> 3687<listitem> 3688<para>This <parameter>olink.doctitle</parameter> parameter 3689should be set to either <literal>yes</literal> or <literal>maybe</literal> 3690to enable this feature. 3691</para> 3692</listitem> 3693<listitem> 3694<para>And you should also set the <parameter>current.docid</parameter> 3695parameter to the document id for the document currently 3696being processed for output. 3697</para> 3698</listitem> 3699</itemizedlist> 3700 3701<para> 3702Then if an olink's <literal>targetdoc</literal> id differs from 3703the <literal>current.docid</literal> value, the stylesheet knows 3704that it is a reference to another document and can 3705append the target document's 3706title to the generated olink text. </para> 3707 3708<para>The text for the target document's title is copied from the 3709olink database from the <sgmltag>ttl</sgmltag> element 3710of the top-level <sgmltag>div</sgmltag> for that document. 3711If that <sgmltag>ttl</sgmltag> element is missing or empty, 3712no title is output. 3713</para> 3714 3715<para>The supported values for <parameter>olink.doctitle</parameter> are: 3716</para> 3717<variablelist> 3718<varlistentry> 3719<term><literal>yes</literal></term> 3720<listitem> 3721<para> 3722Always insert the title to the target document if it is not 3723the current document. 3724</para> 3725</listitem> 3726</varlistentry> 3727<varlistentry> 3728<term><literal>no</literal></term> 3729<listitem> 3730<para> 3731Never insert the title to the target document, even if requested 3732in an <sgmltag class="attribute">xrefstyle</sgmltag> attribute. 3733</para> 3734</listitem> 3735</varlistentry> 3736<varlistentry> 3737<term><literal>maybe</literal></term> 3738<listitem> 3739<para> 3740Only insert the title to the target document, if requested 3741in an <sgmltag class="attribute">xrefstyle</sgmltag> attribute. 3742</para> 3743</listitem> 3744</varlistentry> 3745</variablelist> 3746<para>An <sgmltag class="attribute">xrefstyle</sgmltag> attribute 3747may override the global setting for individual olinks. 3748The following values are supported in an 3749<sgmltag class="attribute">xrefstyle</sgmltag> 3750attribute using the <literal>select:</literal> syntax: 3751</para> 3752 3753<variablelist> 3754<varlistentry> 3755<term><literal>docname</literal></term> 3756<listitem> 3757<para> 3758Insert the target document name for this olink using the 3759<literal>docname</literal> gentext template, but only 3760if the value of <parameter>olink.doctitle</parameter> 3761is not <literal>no</literal>. 3762</para> 3763</listitem> 3764</varlistentry> 3765<varlistentry> 3766<term><literal>docnamelong</literal></term> 3767<listitem> 3768<para> 3769Insert the target document name for this olink using the 3770<literal>docnamelong</literal> gentext template, but only 3771if the value of <parameter>olink.doctitle</parameter> 3772is not <literal>no</literal>. 3773</para> 3774</listitem> 3775</varlistentry> 3776<varlistentry> 3777<term><literal>nodocname</literal></term> 3778<listitem> 3779<para> 3780Omit the target document name even if 3781the value of <parameter>olink.doctitle</parameter> 3782is <literal>yes</literal>. 3783</para> 3784</listitem> 3785</varlistentry> 3786</variablelist> 3787<para>Another way of inserting the target document name 3788for a single olink is to employ an 3789<sgmltag class="attribute">xrefstyle</sgmltag> 3790attribute using the <literal>template:</literal> syntax. 3791The <literal>%o</literal> placeholder (the letter o, not zero) 3792in such a template 3793will be filled in with the target document's title when it is processed. 3794This will occur regardless of 3795the value of <parameter>olink.doctitle</parameter>. 3796</para> 3797<para>Note that prior to version 1.66 of the XSL stylesheets, 3798the allowed values for this parameter were 0 and 1. Those 3799values are still supported and mapped to 'no' and 'yes', respectively. 3800</para> 3801</refsect1> 3802</refentry> 3803 3804<refentry id="olink.debug"> 3805<refmeta> 3806<refentrytitle>olink.debug</refentrytitle> 3807<refmiscinfo role="type">boolean</refmiscinfo> 3808</refmeta> 3809<refnamediv> 3810<refname>olink.debug</refname> 3811<refpurpose>Turn on debugging messages for olinks</refpurpose> 3812</refnamediv> 3813 3814<refsynopsisdiv> 3815<programlisting id="olink.debug.frag"> 3816<xsl:param name="olink.debug" select="0"></xsl:param> 3817</programlisting> 3818</refsynopsisdiv> 3819 3820<refsect1><title>Description</title> 3821 3822<para>If non-zero, then each olink will generate several 3823messages about how it is being resolved during processing. 3824This is useful when an olink does not resolve properly 3825and the standard error messages are not sufficient to 3826find the problem. 3827</para> 3828 3829<para>You may need to read through the olink XSL templates 3830to understand the context for some of the debug messages. 3831</para> 3832 3833</refsect1> 3834</refentry> 3835 3836<refentry id="olink.properties"> 3837<refnamediv> 3838<refname>olink.properties</refname> 3839<refpurpose>Properties associated with the cross-reference 3840text of an olink.</refpurpose> 3841</refnamediv> 3842 3843<refsynopsisdiv> 3844<programlisting id="olink.properties.frag"> 3845<xsl:attribute-set name="olink.properties"> 3846</xsl:attribute-set> 3847</programlisting> 3848</refsynopsisdiv> 3849 3850<refsect1><title>Description</title> 3851 3852<para>This attribute set is used on cross reference text 3853from an olink. It is not applied to the 3854optional page number or 3855optional title of the external document.</para> 3856 3857</refsect1> 3858</refentry> 3859 3860<refentry id="olink.lang.fallback.sequence"> 3861<refmeta> 3862<refentrytitle>olink.lang.fallback.sequence</refentrytitle> 3863<refmiscinfo role="type">string</refmiscinfo> 3864</refmeta> 3865<refnamediv> 3866<refname>olink.lang.fallback.sequence</refname> 3867<refpurpose>look up translated documents if olink not found?</refpurpose> 3868 3869</refnamediv> 3870<refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag"> 3871<xsl:param name="olink.lang.fallback.sequence" select="''"></xsl:param> </programlisting> 3872</refsynopsisdiv> 3873<refsect1> 3874<title>Description</title> 3875 3876<para>This parameter defines a list of lang values 3877to search among to resolve olinks. 3878</para> 3879 3880<para>Normally an olink tries to resolve to a document in the same 3881language as the olink itself. The language of an olink 3882is determined by its nearest ancestor element with a 3883<sgmltag class="attribute">lang</sgmltag> attribute, otherwise the 3884value of the <parameter>l10n.gentext.default.lang</parameter> 3885parameter. 3886</para> 3887 3888<para>An olink database can contain target data for the same 3889document in multiple languages. Each set of data has the 3890same value for the <sgmltag>targetdoc</sgmltag> attribute in 3891the <sgmltag>document</sgmltag> element in the database, but with a 3892different <sgmltag>lang</sgmltag> attribute value. 3893</para> 3894 3895<para>When an olink is being resolved, the target is first 3896sought in the document with the same language as the olink. 3897If no match is found there, then this parameter is consulted 3898for additional languages to try.</para> 3899 3900<para>The <parameter>olink.lang.fallback.sequence</parameter> 3901must be a whitespace separated list of lang values to 3902try. The first one with a match in the olink database is used. 3903The default value is empty.</para> 3904 3905<para>For example, a document might be written in German 3906and contain an olink with 3907<literal>targetdoc="adminguide"</literal>. 3908When the document is processed, the processor 3909first looks for a target dataset in the 3910olink database starting with:</para> 3911 3912<literallayout><literal><document targetdoc="adminguide" lang="de"></literal>. 3913</literallayout> 3914 3915<para>If there is no such element, then the 3916<parameter>olink.lang.fallback.sequence</parameter> 3917parameter is consulted. 3918If its value is, for example, <quote>fr en</quote>, then the processor next 3919looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and 3920then for <literal>targetdoc="adminguide" lang="en"</literal>. 3921If there is still no match, it looks for 3922<literal>targetdoc="adminguide"</literal> with no 3923lang attribute. 3924</para> 3925 3926<para>This parameter is useful when a set of documents is only 3927partially translated, or is in the process of being translated. 3928If a target of an olink has not yet been translated, then this 3929parameter permits the processor to look for the document in 3930other languages. This assumes the reader would rather have 3931a link to a document in a different language than to have 3932a broken link. 3933</para> 3934 3935</refsect1> 3936</refentry> 3937 3938<refentry id="insert.olink.page.number"> 3939<refmeta> 3940<refentrytitle>insert.olink.page.number</refentrytitle> 3941<refmiscinfo role="type">string</refmiscinfo> 3942</refmeta> 3943<refnamediv> 3944<refname>insert.olink.page.number</refname> 3945<refpurpose>Turns page numbers in olinks on and off</refpurpose> 3946</refnamediv> 3947 3948<refsynopsisdiv> 3949<programlisting id="insert.olink.page.number.frag"> 3950<xsl:param name="insert.olink.page.number">no</xsl:param> 3951</programlisting> 3952</refsynopsisdiv> 3953 3954<refsect1><title>Description</title> 3955 3956<para>The value of this parameter determines if 3957cross references made between documents with 3958<sgmltag>olink</sgmltag> will 3959include page number citations. 3960In most cases this is only applicable to references in printed output. 3961</para> 3962<para>The parameter has three possible values. 3963</para> 3964<variablelist> 3965<varlistentry> 3966<term>no</term> 3967<listitem><para>No page number references will be generated for olinks. 3968</para></listitem> 3969</varlistentry> 3970<varlistentry> 3971<term>yes</term> 3972<listitem><para>Page number references will be generated 3973for all <sgmltag>olink</sgmltag> references. 3974The style of page reference may be changed 3975if an <sgmltag class="attribute">xrefstyle</sgmltag> 3976attribute is used. 3977</para></listitem> 3978</varlistentry> 3979<varlistentry> 3980<term>maybe</term> 3981<listitem><para>Page number references will not be generated 3982for an <sgmltag>olink</sgmltag> element unless 3983it has an 3984<sgmltag class="attribute">xrefstyle</sgmltag> 3985attribute whose value specifies a page reference. 3986</para></listitem> 3987</varlistentry> 3988</variablelist> 3989<para>Olinks that point to targets within the same document 3990are treated as <sgmltag>xref</sgmltag>s, and controlled by 3991the <parameter>insert.xref.page.number</parameter> parameter. 3992</para> 3993 3994<para>Page number references for olinks to 3995external documents can only be inserted if the 3996information exists in the olink database. 3997This means each olink target element 3998(<sgmltag>div</sgmltag> or <sgmltag>obj</sgmltag>) 3999must have a <sgmltag class="attribute">page</sgmltag> attribute 4000whose value is its page number in the target document. 4001The XSL stylesheets are not able to extract that information 4002during processing because pages have not yet been created in 4003XSLT transformation. Only the XSL-FO processor knows what 4004page each element is placed on. 4005Therefore some postprocessing must take place to populate 4006page numbers in the olink database. 4007</para> 4008 4009 4010 4011</refsect1> 4012</refentry> 4013 4014<refentry id="insert.olink.pdf.frag"> 4015<refmeta> 4016<refentrytitle>insert.olink.pdf.frag</refentrytitle> 4017<refmiscinfo role="type">boolean</refmiscinfo> 4018</refmeta> 4019<refnamediv> 4020<refname>insert.olink.pdf.frag</refname> 4021<refpurpose>Add fragment identifiers for links into PDF files</refpurpose> 4022</refnamediv> 4023 4024<refsynopsisdiv> 4025<programlisting id="insert.olink.pdf.frag.frag"> 4026<xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param> 4027</programlisting> 4028</refsynopsisdiv> 4029 4030<refsect1><title>Description</title> 4031 4032<para>The value of this parameter determines whether 4033the cross reference URIs to PDF documents made with 4034<sgmltag>olink</sgmltag> will 4035include fragment identifiers. 4036</para> 4037 4038<para>When forming a URI to link to a PDF document, 4039a fragment identifier (typically a '#' followed by an 4040id value) appended to the PDF filename can be used by 4041the PDF viewer to open 4042the PDF file to a location within the document instead of 4043the first page. 4044However, not all PDF files have id 4045values embedded in them, and not all PDF viewers can 4046handle fragment identifiers. 4047</para> 4048 4049<para>If <parameter>insert.olink.pdf.frag</parameter> is set 4050to a non-zero value, then any olink targeting a 4051PDF file will have the fragment identifier appended to the URI. 4052The URI is formed by concatenating the value of the 4053<parameter>olink.base.uri</parameter> parameter, the 4054value of the <sgmltag class="attribute">baseuri</sgmltag> 4055attribute from the <sgmltag class="element">document</sgmltag> 4056element in the olink database with the matching 4057<sgmltag class="attribute">targetdoc</sgmltag> value, 4058and the value of the <sgmltag class="attribute">href</sgmltag> 4059attribute for the targeted element in the olink database. 4060The <sgmltag class="attribute">href</sgmltag> attribute 4061contains the fragment identifier. 4062</para> 4063 4064<para>If <parameter>insert.olink.pdf.frag</parameter> is set 4065to zero (the default value), then 4066the <sgmltag class="attribute">href</sgmltag> attribute 4067from the olink database 4068is not appended to PDF olinks, so the fragment identifier is left off. 4069A PDF olink is any olink for which the 4070<sgmltag class="attribute">baseuri</sgmltag> attribute 4071from the matching <sgmltag class="element">document</sgmltag> 4072element in the olink database ends with '.pdf'. 4073Any other olinks will still have the fragment identifier added. 4074</para> 4075</refsect1> 4076</refentry> 4077 4078<refentry id="prefer.internal.olink"> 4079<refmeta> 4080<refentrytitle>prefer.internal.olink</refentrytitle> 4081<refmiscinfo role="type">boolean</refmiscinfo> 4082</refmeta> 4083<refnamediv> 4084<refname>prefer.internal.olink</refname> 4085<refpurpose>Prefer a local olink reference to an external reference</refpurpose> 4086</refnamediv> 4087 4088<refsynopsisdiv> 4089<programlisting id="prefer.internal.olink.frag"> 4090<xsl:param name="prefer.internal.olink" select="0"></xsl:param> 4091</programlisting> 4092</refsynopsisdiv> 4093 4094<refsect1><title>Description</title> 4095 4096<para>If you are re-using XML content modules in multiple documents, 4097you may want to redirect some of your olinks. This parameter 4098permits you to redirect an olink to the current document. 4099</para> 4100 4101<para>For example: you are writing documentation for a product, 4102which includes 3 manuals: a little installation 4103booklet (booklet.xml), a user 4104guide (user.xml), and a reference manual (reference.xml). 4105All 3 documents begin with the same introduction section (intro.xml) that 4106contains a reference to the customization section (custom.xml) which is 4107included in both user.xml and reference.xml documents. 4108</para> 4109 4110<para>How do you write the link to custom.xml in intro.xml 4111so that it is interpreted correctly in all 3 documents?</para> 4112<itemizedlist> 4113<listitem><para>If you use xref, it will fail in user.xml.</para> 4114</listitem> 4115<listitem><para>If you use olink (pointing to reference.xml), 4116the reference in user.xml 4117will point to the customization section of the reference manual, while it is 4118actually available in user.xml.</para> 4119</listitem> 4120</itemizedlist> 4121 4122<para>If you set the <parameter>prefer.internal.olink</parameter> 4123parameter to a non-zero value, then the processor will 4124first look in the olink database 4125for the olink's <sgmltag>targetptr</sgmltag> attribute value 4126in document matching the <parameter>current.docid</parameter> 4127parameter value. If it isn't found there, then 4128it tries the document in the database 4129with the <sgmltag>targetdoc</sgmltag> 4130value that matches the olink's <sgmltag>targetdoc</sgmltag> 4131attribute. 4132</para> 4133 4134<para>This feature permits an olink reference to resolve to 4135the current document if there is an element 4136with an id matching the olink's <sgmltag>targetptr</sgmltag> 4137value. The current document's olink data must be 4138included in the target database for this to work.</para> 4139 4140<caution> 4141<para>There is a potential for incorrect links if 4142the same <sgmltag>id</sgmltag> attribute value is used for different 4143content in different documents. 4144Some of your olinks may be redirected to the current document 4145when they shouldn't be. It is not possible to control 4146individual olink instances.</para> 4147</caution> 4148 4149</refsect1> 4150</refentry> 4151 4152<refentry id="link.mailto.url"> 4153<refmeta> 4154<refentrytitle>link.mailto.url</refentrytitle> 4155<refmiscinfo role="type">string</refmiscinfo> 4156</refmeta> 4157<refnamediv> 4158<refname>link.mailto.url</refname> 4159<refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> 4160</refnamediv> 4161 4162<refsynopsisdiv> 4163<programlisting id="link.mailto.url.frag"><xsl:param name="link.mailto.url"></xsl:param></programlisting> 4164</refsynopsisdiv> 4165 4166<refsect1><title>Description</title> 4167 4168<para>If not the empty string, this address will be used for the 4169REL=made <sgmltag>LINK</sgmltag> element in the HTML <sgmltag>HEAD</sgmltag>. 4170</para> 4171 4172</refsect1> 4173</refentry> 4174 4175<refentry id="ulink.target"> 4176<refmeta> 4177<refentrytitle>ulink.target</refentrytitle> 4178<refmiscinfo role="type">string</refmiscinfo> 4179</refmeta> 4180<refnamediv> 4181<refname>ulink.target</refname> 4182<refpurpose>The HTML anchor target for ULinks</refpurpose> 4183</refnamediv> 4184 4185<refsynopsisdiv> 4186<programlisting id="ulink.target.frag"><xsl:param name="ulink.target" select="'_top'"></xsl:param></programlisting> 4187</refsynopsisdiv> 4188 4189<refsect1><title>Description</title> 4190 4191<para>If <parameter>ulink.target</parameter> is set, its value will 4192be used for the <sgmltag class="attribute">target</sgmltag> attribute 4193on anchors generated for <sgmltag>ulink</sgmltag>s.</para> 4194 4195</refsect1> 4196</refentry> 4197 4198<refentry id="olink.fragid"> 4199<refmeta> 4200<refentrytitle>olink.fragid</refentrytitle> 4201<refmiscinfo role="type">string</refmiscinfo> 4202</refmeta> 4203<refnamediv> 4204<refname>olink.fragid</refname> 4205<refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose> 4206</refnamediv> 4207 4208<refsynopsisdiv> 4209<programlisting id="olink.fragid.frag"><xsl:param name="olink.fragid" select="'fragid='"></xsl:param></programlisting> 4210</refsynopsisdiv> 4211 4212<refsect1><title>Description</title> 4213 4214<para>FIXME:</para> 4215 4216</refsect1> 4217</refentry> 4218 4219<refentry id="olink.outline.ext"> 4220<refmeta> 4221<refentrytitle>olink.outline.ext</refentrytitle> 4222<refmiscinfo role="type">string</refmiscinfo> 4223</refmeta> 4224<refnamediv> 4225<refname>olink.outline.ext</refname> 4226<refpurpose>The extension of OLink outline files</refpurpose> 4227</refnamediv> 4228 4229<refsynopsisdiv> 4230<programlisting id="olink.outline.ext.frag"><xsl:param name="olink.outline.ext" select="'.olink'"></xsl:param></programlisting> 4231</refsynopsisdiv> 4232 4233<refsect1><title>Description</title> 4234 4235<para>FIXME:</para> 4236 4237</refsect1> 4238</refentry> 4239 4240<refentry id="olink.pubid"> 4241<refmeta> 4242<refentrytitle>olink.pubid</refentrytitle> 4243<refmiscinfo role="type">string</refmiscinfo> 4244</refmeta> 4245<refnamediv> 4246<refname>olink.pubid</refname> 4247<refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose> 4248</refnamediv> 4249 4250<refsynopsisdiv> 4251<programlisting id="olink.pubid.frag"><xsl:param name="olink.pubid" select="'pubid='"></xsl:param></programlisting> 4252</refsynopsisdiv> 4253 4254<refsect1><title>Description</title> 4255 4256<para>FIXME:</para> 4257 4258</refsect1> 4259</refentry> 4260 4261<refentry id="olink.sysid"> 4262<refmeta> 4263<refentrytitle>olink.sysid</refentrytitle> 4264<refmiscinfo role="type">string</refmiscinfo> 4265</refmeta> 4266<refnamediv> 4267<refname>olink.sysid</refname> 4268<refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose> 4269</refnamediv> 4270 4271<refsynopsisdiv> 4272<programlisting id="olink.sysid.frag"><xsl:param name="olink.sysid" select="'sysid='"></xsl:param></programlisting> 4273</refsynopsisdiv> 4274 4275<refsect1><title>Description</title> 4276 4277<para>FIXME:</para> 4278 4279</refsect1> 4280</refentry> 4281 4282<refentry id="olink.resolver"> 4283<refmeta> 4284<refentrytitle>olink.resolver</refentrytitle> 4285<refmiscinfo role="type"/> 4286</refmeta> 4287<refnamediv> 4288<refname>olink.resolver</refname> 4289<refpurpose>The root name of the OLink resolver (usually a script)</refpurpose> 4290</refnamediv> 4291 4292<refsynopsisdiv> 4293<programlisting id="olink.resolver.frag"><xsl:param name="olink.resolver" select="'/cgi-bin/olink'"></xsl:param></programlisting> 4294</refsynopsisdiv> 4295 4296<refsect1><title>Description</title> 4297 4298<para>FIXME:</para> 4299 4300</refsect1> 4301</refentry> 4302 4303</reference> 4304 4305<reference id="xrefs"><title>Cross References</title> 4306<refentry id="collect.xref.targets"> 4307<refmeta> 4308<refentrytitle>collect.xref.targets</refentrytitle> 4309<refmiscinfo role="type">string</refmiscinfo> 4310</refmeta> 4311<refnamediv> 4312<refname>collect.xref.targets</refname> 4313<refpurpose>Controls whether cross reference data is 4314collected</refpurpose> 4315</refnamediv> 4316<refsynopsisdiv> <programlisting id="collect.xref.targets.frag"> 4317<xsl:param name="collect.xref.targets" select="'no'"></xsl:param> 4318</programlisting> 4319</refsynopsisdiv> 4320<refsect1> 4321<title>Description</title> 4322<para> 4323In order to resolve olinks efficiently, the stylesheets can 4324generate an external data file containing information about 4325all potential cross reference endpoints in a document. 4326This 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. 4327See also <parameter>targets.filename</parameter>. 4328</para> 4329</refsect1> 4330</refentry> 4331 4332<refentry id="insert.xref.page.number"> 4333<refmeta> 4334<refentrytitle>insert.xref.page.number</refentrytitle> 4335<refmiscinfo role="type">string</refmiscinfo> 4336</refmeta> 4337<refnamediv> 4338<refname>insert.xref.page.number</refname> 4339<refpurpose>Turns page numbers in xrefs on and off</refpurpose> 4340</refnamediv> 4341 4342<refsynopsisdiv> 4343<programlisting id="insert.xref.page.number.frag"> 4344<xsl:param name="insert.xref.page.number">no</xsl:param> 4345</programlisting> 4346</refsynopsisdiv> 4347 4348<refsect1><title>Description</title> 4349 4350<para>The value of this parameter determines if 4351cross references (<sgmltag>xref</sgmltag>s) in 4352printed output will 4353include page number citations. 4354It has three possible values. 4355</para> 4356<variablelist> 4357<varlistentry> 4358<term>no</term> 4359<listitem><para>No page number references will be generated. 4360</para></listitem> 4361</varlistentry> 4362<varlistentry> 4363<term>yes</term> 4364<listitem><para>Page number references will be generated 4365for all <sgmltag>xref</sgmltag> elements. 4366The style of page reference may be changed 4367if an <sgmltag class="attribute">xrefstyle</sgmltag> 4368attribute is used. 4369</para></listitem> 4370</varlistentry> 4371<varlistentry> 4372<term>maybe</term> 4373<listitem><para>Page number references will not be generated 4374for an <sgmltag>xref</sgmltag> element unless 4375it has an 4376<sgmltag class="attribute">xrefstyle</sgmltag> 4377attribute whose value specifies a page reference. 4378</para></listitem> 4379</varlistentry> 4380</variablelist> 4381 4382</refsect1> 4383</refentry> 4384 4385<refentry id="use.role.as.xrefstyle"> 4386<refmeta> 4387<refentrytitle>use.role.as.xrefstyle</refentrytitle> 4388<refmiscinfo role="type">boolean</refmiscinfo> 4389</refmeta> 4390<refnamediv> 4391<refname>use.role.as.xrefstyle</refname> 4392<refpurpose>Use <sgmltag class="attribute">role</sgmltag> attribute for 4393<sgmltag class="attribute">xrefstyle</sgmltag> on <sgmltag>xref</sgmltag>?</refpurpose> 4394</refnamediv> 4395 4396<refsynopsisdiv> 4397<programlisting id="use.role.as.xrefstyle.frag"> 4398<xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param> 4399</programlisting> 4400</refsynopsisdiv> 4401 4402<refsect1><title>Description</title> 4403 4404<para>If non-zero, the <sgmltag class="attribute">role</sgmltag> attribute on 4405<sgmltag>xref</sgmltag> will be used to select the cross reference style. 4406The <ulink url="http://www.oasis-open.org/docbook/">DocBook 4407Technical Committee</ulink> recently added an 4408<sgmltag class="attribute">xrefstyle</sgmltag> attribute for this purpose. 4409If the <sgmltag class="attribute">xrefstyle</sgmltag> attribute 4410is present, <sgmltag class="attribute">role</sgmltag> will be ignored, regardless 4411of this setting.</para> 4412 4413<para>Until an official DocBook release that includes the new 4414attribute, this flag allows <sgmltag class="attribute">role</sgmltag> 4415to serve that purpose.</para> 4416 4417</refsect1> 4418 4419<refsect1><title>Example</title> 4420 4421<para>The following small stylesheet shows how to configure the stylesheets to make 4422use of the cross reference style:</para> 4423 4424<programlisting><?xml version="1.0"?> 4425<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 4426 version="1.0"> 4427 4428<xsl:import href="../xsl/html/docbook.xsl"/> 4429 4430<xsl:output method="html"/> 4431 4432<xsl:param name="local.l10n.xml" select="document('')"/> 4433<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> 4434 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"> 4435 <l:context name="xref"> 4436 <l:template name="chapter" style="title" text="Chapter %n, %t"/> 4437 <l:template name="chapter" text="Chapter %n"/> 4438 </l:context> 4439 </l:l10n> 4440</l:i18n> 4441 4442</xsl:stylesheet></programlisting> 4443 4444<para>With this stylesheet, the cross references in the following document:</para> 4445 4446<programlisting><?xml version="1.0" encoding="utf-8"?> 4447<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 4448 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 4449<book id="book"><title>Book</title> 4450 4451<preface> 4452<title>Preface</title> 4453 4454<para>Normal: <xref linkend="ch1"/>.</para> 4455<para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para> 4456 4457</preface> 4458 4459<chapter id="ch1"> 4460<title>First Chapter</title> 4461 4462<para>Irrelevant.</para> 4463 4464</chapter> 4465</book></programlisting> 4466 4467<para>will appear as:</para> 4468 4469<informalexample> 4470<para>Normal: Chapter 1.</para> 4471<para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para> 4472</informalexample> 4473</refsect1> 4474 4475</refentry> 4476 4477<refentry id="xref.with.number.and.title"> 4478<refmeta> 4479<refentrytitle>xref.with.number.and.title</refentrytitle> 4480<refmiscinfo role="type">boolean</refmiscinfo> 4481</refmeta> 4482<refnamediv> 4483<refname>xref.with.number.and.title</refname> 4484<refpurpose>Use number and title in cross references</refpurpose> 4485</refnamediv> 4486 4487<refsynopsisdiv> 4488<programlisting id="xref.with.number.and.title.frag"> 4489<xsl:param name="xref.with.number.and.title" select="1"></xsl:param> 4490</programlisting> 4491</refsynopsisdiv> 4492 4493<refsect1><title>Description</title> 4494 4495<para>FIXME:</para> 4496 4497</refsect1> 4498</refentry> 4499 4500<refentry id="xref.label-page.separator"> 4501<refmeta> 4502<refentrytitle>xref.label-page.separator</refentrytitle> 4503<refmiscinfo role="type">string</refmiscinfo> 4504</refmeta> 4505<refnamediv> 4506<refname>xref.label-page.separator</refname> 4507<refpurpose>Punctuation or space separating label from page number in xref</refpurpose> 4508</refnamediv> 4509 4510<refsynopsisdiv> 4511<programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting> 4512</refsynopsisdiv> 4513 4514<refsect1><title>Description</title> 4515 4516<para> 4517This parameter allows you to control the punctuation of certain 4518types of generated cross reference text. 4519When cross reference text is generated for an 4520<sgmltag class="element">xref</sgmltag> or 4521<sgmltag class="element">olink</sgmltag> element 4522using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute 4523that makes use of the <literal>select:</literal> feature, 4524and the selected components include both label and page 4525but no title, 4526then the value of this parameter is inserted between 4527label and page number in the output. 4528If a title is included, then other separators are used. 4529</para> 4530 4531</refsect1> 4532</refentry> 4533 4534<refentry id="xref.label-title.separator"> 4535<refmeta> 4536<refentrytitle>xref.label-title.separator</refentrytitle> 4537<refmiscinfo role="type">string</refmiscinfo> 4538</refmeta> 4539<refnamediv> 4540<refname>xref.label-title.separator</refname> 4541<refpurpose>Punctuation or space separating label from title in xref</refpurpose> 4542</refnamediv> 4543 4544<refsynopsisdiv> 4545<programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting> 4546</refsynopsisdiv> 4547 4548<refsect1><title>Description</title> 4549 4550<para> 4551This parameter allows you to control the punctuation of certain 4552types of generated cross reference text. 4553When cross reference text is generated for an 4554<sgmltag class="element">xref</sgmltag> or 4555<sgmltag class="element">olink</sgmltag> element 4556using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute 4557that makes use of the <literal>select:</literal> feature, 4558and the selected components include both label and title, 4559then the value of this parameter is inserted between 4560label and title in the output. 4561</para> 4562 4563</refsect1> 4564</refentry> 4565 4566<refentry id="xref.title-page.separator"> 4567<refmeta> 4568<refentrytitle>xref.title-page.separator</refentrytitle> 4569<refmiscinfo role="type">string</refmiscinfo> 4570</refmeta> 4571<refnamediv> 4572<refname>xref.title-page.separator</refname> 4573<refpurpose>Punctuation or space separating title from page number in xref</refpurpose> 4574</refnamediv> 4575 4576<refsynopsisdiv> 4577<programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting> 4578</refsynopsisdiv> 4579 4580<refsect1><title>Description</title> 4581 4582<para> 4583This parameter allows you to control the punctuation of certain 4584types of generated cross reference text. 4585When cross reference text is generated for an 4586<sgmltag class="element">xref</sgmltag> or 4587<sgmltag class="element">olink</sgmltag> element 4588using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute 4589that makes use of the <literal>select:</literal> feature, 4590and the selected components include both title and page number, 4591then the value of this parameter is inserted between 4592title and page number in the output. 4593</para> 4594 4595</refsect1> 4596</refentry> 4597 4598</reference> 4599 4600<reference id="lists"><title>Lists</title> 4601<refentry id="segmentedlist.as.table"> 4602<refmeta> 4603<refentrytitle>segmentedlist.as.table</refentrytitle> 4604<refmiscinfo role="type">boolean</refmiscinfo> 4605</refmeta> 4606<refnamediv> 4607<refname>segmentedlist.as.table</refname> 4608<refpurpose>Format segmented lists as tables?</refpurpose> 4609</refnamediv> 4610 4611<refsynopsisdiv> 4612<programlisting id="segmentedlist.as.table.frag"> 4613<xsl:param name="segmentedlist.as.table" select="0"></xsl:param> 4614</programlisting> 4615</refsynopsisdiv> 4616 4617<refsect1><title>Description</title> 4618 4619<para>If non-zero, <sgmltag>segmentedlist</sgmltag>s will be formatted as 4620tables.</para> 4621 4622</refsect1> 4623</refentry> 4624 4625<refentry id="variablelist.as.table"> 4626<refmeta> 4627<refentrytitle>variablelist.as.table</refentrytitle> 4628<refmiscinfo role="type">boolean</refmiscinfo> 4629</refmeta> 4630<refnamediv> 4631<refname>variablelist.as.table</refname> 4632<refpurpose>Format <sgmltag>variablelist</sgmltag>s as tables?</refpurpose> 4633</refnamediv> 4634 4635<refsynopsisdiv> 4636<programlisting id="variablelist.as.table.frag"> 4637<xsl:param name="variablelist.as.table" select="0"></xsl:param> 4638</programlisting> 4639</refsynopsisdiv> 4640 4641<refsect1><title>Description</title> 4642 4643<para>If non-zero, <sgmltag>variablelist</sgmltag>s will be formatted as 4644tables. A processing instruction exists to specify a particualar width for the 4645column containing the <sgmltag>term</sgmltag>s: 4646<sgmltag class="pi">dbhtml term-width=".25in"</sgmltag></para> 4647 4648<para>You can override this setting with a processing instruction as the 4649child of <sgmltag>variablelist</sgmltag>: <sgmltag class="pi">dbhtml 4650list-presentation="table"</sgmltag> or <sgmltag class="pi">dbhtml 4651list-presentation="list"</sgmltag>.</para> 4652 4653<para>This parameter only applys to the HTML transformations. In the 4654FO case, proper list markup is robust enough to handle the formatting. 4655But see also <parameter>variablelist.as.blocks</parameter>.</para> 4656 4657<programlisting> <variablelist> 4658 <?dbhtml list-presentation="table"?> 4659 <?dbhtml term-width="1.5in"?> 4660 <?dbfo list-presentation="list"?> 4661 <?dbfo term-width="1in"?> 4662 <varlistentry> 4663 <term>list</term> 4664 <listitem> 4665 <para> 4666 Formatted as a table even if variablelist.as.table is set to 0. 4667 </para> 4668 </listitem> 4669 </varlistentry> 4670 </variablelist></programlisting> 4671 4672</refsect1> 4673</refentry> 4674 4675<refentry id="variablelist.term.separator"> 4676<refmeta> 4677<refentrytitle>variablelist.term.separator</refentrytitle> 4678<refmiscinfo role="type">string</refmiscinfo> 4679</refmeta> 4680<refnamediv> 4681<refname>variablelist.term.separator</refname> 4682<refpurpose>Text to separate <tag>term</tag>s within a multi-term 4683<tag>varlistentry</tag></refpurpose> 4684</refnamediv> 4685 4686<refsynopsisdiv> 4687<programlisting id="variablelist.term.separator.frag"> 4688<xsl:param name="variablelist.term.separator">, </xsl:param></programlisting> 4689</refsynopsisdiv> 4690 4691<refsect1><title>Description</title> 4692 4693<para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag> 4694elements, the string specified in the value of the 4695<parameter>variablelist.term.separator</parameter> parameter is placed 4696after each <tag>term</tag> except the last.</para> 4697 4698<note> 4699 <para>To generate a line break between multiple <tag>term</tag>s in 4700 a <tag>varlistentry</tag>, set a non-zero value for the 4701 <parameter>variablelist.term.break.after</parameter> parameter. If 4702 you do so, you may also want to set the value of the 4703 <parameter>variablelist.term.separator</parameter> parameter to an 4704 empty string (to suppress rendering of the default comma and space 4705 after each <tag>term</tag>).</para> 4706</note> 4707 4708</refsect1> 4709</refentry> 4710 4711<refentry id="variablelist.term.break.after"> 4712<refmeta> 4713<refentrytitle>variablelist.term.break.after</refentrytitle> 4714<refmiscinfo role="type">boolean</refmiscinfo> 4715</refmeta> 4716<refnamediv> 4717<refname>variablelist.term.break.after</refname> 4718<refpurpose>Generate line break after each <tag>term</tag> within a 4719multi-term <tag>varlistentry</tag>?</refpurpose> 4720</refnamediv> 4721 4722<refsynopsisdiv> 4723<programlisting id="variablelist.term.break.after.frag"> 4724<xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting> 4725</refsynopsisdiv> 4726 4727<refsect1><title>Description</title> 4728 4729<para>Set a non-zero value for the 4730<parameter>variablelist.term.break.after</parameter> parameter to 4731generate a line break between <tag>term</tag>s in a 4732multi-term <tag>varlistentry</tag>.</para> 4733 4734<note> 4735<para>If you set a non-zero value for 4736<parameter>variablelist.term.break.after</parameter>, you may also 4737want to set the value of the 4738<parameter>variablelist.term.separator</parameter> parameter to an 4739empty string (to suppress rendering of the default comma and space 4740after each <tag>term</tag>).</para> 4741</note> 4742 4743</refsect1> 4744</refentry> 4745 4746</reference> 4747 4748<reference id="biblio"><title>Bibliography</title> 4749<refentry id="biblioentry.item.separator"> 4750<refmeta> 4751<refentrytitle>biblioentry.item.separator</refentrytitle> 4752<refmiscinfo role="type">string</refmiscinfo> 4753</refmeta> 4754<refnamediv> 4755<refname>biblioentry.item.separator</refname> 4756<refpurpose>Text to separate bibliography entries</refpurpose> 4757</refnamediv> 4758 4759<refsynopsisdiv> 4760<programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting> 4761</refsynopsisdiv> 4762 4763<refsect1><title>Description</title> 4764 4765<para>Text to separate bibliography entries 4766</para> 4767 4768</refsect1> 4769</refentry> 4770 4771<refentry id="bibliography.collection"> 4772<refmeta> 4773<refentrytitle>bibliography.collection</refentrytitle> 4774<refmiscinfo role="type">string</refmiscinfo> 4775</refmeta> 4776<refnamediv> 4777<refname>bibliography.collection</refname> 4778<refpurpose>Name of the bibliography collection file</refpurpose> 4779</refnamediv> 4780 4781<refsynopsisdiv> 4782<programlisting id="bibliography.collection.frag"><xsl:param name="bibliography.collection" select="'http://docbook.sourceforge.net/release/bibliography/bibliography.xml'"></xsl:param></programlisting> 4783</refsynopsisdiv> 4784 4785<refsect1><title>Description</title> 4786 4787<para>Maintaining bibliography entries across a set of documents is tedious, time 4788consuming, and error prone. It makes much more sense, usually, to store all of 4789the bibliography entries in a single place and simply <quote>extract</quote> 4790the ones you need in each document.</para> 4791 4792<para>That's the purpose of the 4793<parameter>bibliography.collection</parameter> parameter. To setup a global 4794bibliography <quote>database</quote>, follow these steps:</para> 4795 4796<para>First, create a stand-alone bibliography document that contains all of 4797the documents that you wish to reference. Make sure that each bibliography 4798entry (whether you use <sgmltag>biblioentry</sgmltag> or <sgmltag>bibliomixed</sgmltag>) 4799has an ID.</para> 4800 4801<para>My global bibliography, <filename>~/bibliography.xml</filename> begins 4802like this:</para> 4803 4804<informalexample> 4805<programlisting><!DOCTYPE bibliography 4806 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 4807 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> 4808<bibliography><title>References</title> 4809 4810<bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray, 4811Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors. 4812<citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup 4813Language (XML) 1.0 Second Edition</ulink></citetitle>. 4814World Wide Web Consortium, 2000. 4815</bibliomixed> 4816 4817<bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray, 4818Dave Hollander, 4819and Andrew Layman, editors. 4820<citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in 4821XML</ulink></citetitle>. 4822World Wide Web Consortium, 1999. 4823</bibliomixed> 4824 4825<!-- ... --> 4826</bibliography> 4827</programlisting> 4828</informalexample> 4829 4830<para>When you create a bibliography in your document, simply 4831provide <emphasis>empty</emphasis> <sgmltag>bibliomixed</sgmltag> 4832entries for each document that you wish to cite. Make sure that these 4833elements have the same ID as the corresponding <quote>real</quote> 4834entry in your global bibliography.</para> 4835 4836<para>For example:</para> 4837 4838<informalexample> 4839<programlisting><bibliography><title>Bibliography</title> 4840 4841<bibliomixed id="xml-rec"/> 4842<bibliomixed id="xml-names"/> 4843<bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and 4844Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley, 48451986. ISBN 0-201-13437-3. 4846</bibliomixed> 4847<bibliomixed id="relaxng"/> 4848 4849</bibliography></programlisting> 4850</informalexample> 4851 4852<para>Note that it's perfectly acceptable to mix entries from your 4853global bibliography with <quote>normal</quote> entries. You can use 4854<sgmltag>xref</sgmltag> or other elements to cross-reference your 4855bibliography entries in exactly the same way you do now.</para> 4856 4857<para>Finally, when you are ready to format your document, simply set the 4858<parameter>bibliography.collection</parameter> parameter (in either a 4859customization layer or directly through your processor's interface) to 4860point to your global bibliography.</para> 4861 4862<para>The stylesheets will format the bibliography in your document as if 4863all of the entries referenced appeared there literally.</para> 4864 4865</refsect1> 4866</refentry> 4867 4868<refentry id="bibliography.numbered"> 4869<refmeta> 4870<refentrytitle>bibliography.numbered</refentrytitle> 4871<refmiscinfo role="type">boolean</refmiscinfo> 4872</refmeta> 4873<refnamediv> 4874<refname>bibliography.numbered</refname> 4875<refpurpose>Should bibliography entries be numbered?</refpurpose> 4876</refnamediv> 4877 4878<refsynopsisdiv> 4879<programlisting id="bibliography.numbered.frag"> 4880<xsl:param name="bibliography.numbered" select="0"></xsl:param> 4881</programlisting> 4882</refsynopsisdiv> 4883 4884<refsect1><title>Description</title> 4885 4886<para>If non-zero bibliography entries will be numbered</para> 4887 4888</refsect1> 4889</refentry> 4890 4891</reference> 4892 4893<reference id="glossary"><title>Glossary</title> 4894<refentry id="glossterm.auto.link"> 4895<refmeta> 4896<refentrytitle>glossterm.auto.link</refentrytitle> 4897<refmiscinfo role="type">boolean</refmiscinfo> 4898</refmeta> 4899<refnamediv> 4900<refname>glossterm.auto.link</refname> 4901<refpurpose>Generate links from glossterm to glossentry automaticaly?</refpurpose> 4902</refnamediv> 4903 4904<refsynopsisdiv> 4905<programlisting id="glossterm.auto.link.frag"> 4906<xsl:param name="glossterm.auto.link" select="0"></xsl:param> 4907</programlisting> 4908</refsynopsisdiv> 4909 4910<refsect1><title>Description</title> 4911 4912<para>If true, a link will be automatically created from glossterm 4913to glossentry for that glossary term. This is usefull when your 4914glossterm names are consistent and you don't want to add links 4915manually.</para> 4916<para>If there is <sgmltag class="attribute">linkend</sgmltag> on 4917<sgmltag>glossterm</sgmltag> then is used instead of autogeneration of 4918link.</para> 4919 4920</refsect1> 4921</refentry> 4922 4923<refentry id="firstterm.only.link"> 4924<refmeta> 4925<refentrytitle>firstterm.only.link</refentrytitle> 4926<refmiscinfo role="type">boolean</refmiscinfo> 4927</refmeta> 4928<refnamediv> 4929<refname>firstterm.only.link</refname> 4930<refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose> 4931</refnamediv> 4932 4933<refsynopsisdiv> 4934<programlisting id="firstterm.only.link.frag"> 4935<xsl:param name="firstterm.only.link" select="0"></xsl:param> 4936</programlisting> 4937</refsynopsisdiv> 4938 4939<refsect1><title>Description</title> 4940 4941<para>If true, only <sgmltag>firstterm</sgmltag>s will be automatically linked 4942to the glossary. If glossary linking is not enabled, this parameter 4943has no effect.</para> 4944 4945</refsect1> 4946</refentry> 4947 4948<refentry id="glossary.collection"> 4949<refmeta> 4950<refentrytitle>glossary.collection</refentrytitle> 4951<refmiscinfo role="type">string</refmiscinfo> 4952</refmeta> 4953<refnamediv> 4954<refname>glossary.collection</refname> 4955<refpurpose>Name of the glossary collection file</refpurpose> 4956</refnamediv> 4957 4958<refsynopsisdiv> 4959<programlisting id="glossary.collection.frag"> 4960<xsl:param name="glossary.collection" select="''"></xsl:param> 4961</programlisting> 4962</refsynopsisdiv> 4963 4964<refsect1><title>Description</title> 4965 4966<para>Glossaries maintained independently across a set of documents 4967are likely to become inconsistent unless considerable effort is 4968expended to keep them in sync. It makes much more sense, usually, to 4969store all of the glossary entries in a single place and simply 4970<quote>extract</quote> the ones you need in each document.</para> 4971 4972<para>That's the purpose of the 4973<parameter>glossary.collection</parameter> parameter. To setup a global 4974glossary <quote>database</quote>, follow these steps:</para> 4975 4976<refsect2><title>Setting Up the Glossary Database</title> 4977 4978<para>First, create a stand-alone glossary document that contains all of 4979the entries that you wish to reference. Make sure that each glossary 4980entry has an ID.</para> 4981 4982<para>Here's an example glossary:</para> 4983 4984<informalexample> 4985<programlisting> 4986<?xml version="1.0" encoding="utf-8"?> 4987<!DOCTYPE glossary 4988 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 4989 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> 4990<glossary> 4991<glossaryinfo> 4992<editor><firstname>Eric</firstname><surname>Raymond</surname></editor> 4993<title>Jargon File 4.2.3 (abridged)</title> 4994<releaseinfo>Just some test data</releaseinfo> 4995</glossaryinfo> 4996 4997<glossdiv><title>0</title> 4998 4999<glossentry> 5000<glossterm>0</glossterm> 5001<glossdef> 5002<para>Numeric zero, as opposed to the letter `O' (the 15th letter of 5003the English alphabet). In their unmodified forms they look a lot 5004alike, and various kluges invented to make them visually distinct have 5005compounded the confusion. If your zero is center-dotted and letter-O 5006is not, or if letter-O looks almost rectangular but zero looks more 5007like an American football stood on end (or the reverse), you're 5008probably looking at a modern character display (though the dotted zero 5009seems to have originated as an option on IBM 3270 controllers). If 5010your zero is slashed but letter-O is not, you're probably looking at 5011an old-style ASCII graphic set descended from the default typewheel on 5012the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter, 5013curse this arrangement). (Interestingly, the slashed zero long 5014predates computers; Florian Cajori's monumental "A History of 5015Mathematical Notations" notes that it was used in the twelfth and 5016thirteenth centuries.) If letter-O has a slash across it and the zero 5017does not, your display is tuned for a very old convention used at IBM 5018and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis> 5019arrangement even more, because it means two of their letters collide). 5020Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis> 5021slash. Old CDC computers rendered letter O as an unbroken oval and 0 5022as an oval broken at upper right and lower left. And yet another 5023convention common on early line printers left zero unornamented but 5024added a tail or hook to the letter-O so that it resembled an inverted 5025Q or cursive capital letter-O (this was endorsed by a draft ANSI 5026standard for how to draw ASCII characters, but the final standard 5027changed the distinguisher to a tick-mark in the upper-left corner). 5028Are we sufficiently confused yet?</para> 5029</glossdef> 5030</glossentry> 5031 5032<glossentry> 5033<glossterm>1TBS</glossterm> 5034<glossdef> 5035<para role="accidence"> 5036<phrase role="pronounce"></phrase> 5037<phrase role="partsofspeach">n</phrase> 5038</para> 5039<para>The "One True Brace Style"</para> 5040<glossseealso>indent style</glossseealso> 5041</glossdef> 5042</glossentry> 5043 5044<!-- ... --> 5045 5046</glossdiv> 5047 5048<!-- ... --> 5049 5050</glossary></programlisting> 5051</informalexample> 5052 5053</refsect2> 5054 5055<refsect2><title>Marking Up Glossary Terms</title> 5056 5057<para>That takes care of the glossary database, now you have to get the entries 5058into your document. Unlike bibliography entries, which can be empty, creating 5059<quote>placeholder</quote> glossary entries would be very tedious. So instead, 5060support for <parameter>glossary.collection</parameter> relies on implicit linking.</para> 5061 5062<para>In your source document, simply use <sgmltag>firstterm</sgmltag> and 5063<sgmltag>glossterm</sgmltag> to identify the terms you wish to have included 5064in the glossary. The stylesheets assume that you will either set the 5065<sgmltag class="attribute">baseform</sgmltag> attribute correctly, or that the 5066content of the element exactly matches a term in your glossary.</para> 5067 5068<para>If you're using a <parameter>glossary.collection</parameter>, don't 5069make explicit links on the terms in your document.</para> 5070 5071<para>So, in your document, you might write things like this:</para> 5072 5073<informalexample> 5074<programlisting><para>This is dummy text, without any real meaning. 5075The point is simply to reference glossary terms like <glossterm>0</glossterm> 5076and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>. 5077The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly 5078religious issue.</para></programlisting> 5079</informalexample> 5080 5081<para>If you set the <parameter>firstterm.only.link</parameter> parameter, 5082only the terms marked with <sgmltag>firstterm</sgmltag> will be links. 5083Otherwise, all the terms will be linked.</para> 5084 5085</refsect2> 5086 5087<refsect2><title>Marking Up the Glossary</title> 5088 5089<para>The glossary itself has to be identified for the stylesheets. For lack 5090of a better choice, the <sgmltag class="attribute">role</sgmltag> is used. 5091To identify the glossary as the target for automatic processing, set 5092the role to <quote><literal>auto</literal></quote>. The title of this 5093glossary (and any other information from the <sgmltag>glossaryinfo</sgmltag> 5094that's rendered by your stylesheet) will be displayed, but the entries will 5095come from the database. 5096</para> 5097 5098<para>Unfortunately, the glossary can't be empty, so you must put in 5099at least one <sgmltag>glossentry</sgmltag>. The content of this entry 5100is irrelevant, it will not be rendered:</para> 5101 5102<informalexample> 5103<programlisting><glossary role="auto"> 5104<glossentry> 5105<glossterm>Irrelevant</glossterm> 5106<glossdef> 5107<para>If you can see this, the document was processed incorrectly. Use 5108the <parameter>glossary.collection</parameter> parameter.</para> 5109</glossdef> 5110</glossentry> 5111</glossary></programlisting> 5112</informalexample> 5113 5114<para>What about glossary divisions? If your glossary database has glossary 5115divisions <emphasis>and</emphasis> your automatic glossary contains at least 5116one <sgmltag>glossdiv</sgmltag>, the automic glossary will have divisions. 5117If the <sgmltag>glossdiv</sgmltag> is missing from either location, no divisions 5118will be rendered.</para> 5119 5120<para>Glossary entries (and divisions, if appropriate) in the glossary will 5121occur in precisely the order they occur in your database.</para> 5122 5123</refsect2> 5124 5125<refsect2><title>Formatting the Document</title> 5126 5127<para>Finally, when you are ready to format your document, simply set the 5128<parameter>glossary.collection</parameter> parameter (in either a 5129customization layer or directly through your processor's interface) to 5130point to your global glossary.</para> 5131 5132<para>The stylesheets will format the glossary in your document as if 5133all of the entries implicilty referenced appeared there literally.</para> 5134</refsect2> 5135 5136<refsect2><title>Limitations</title> 5137 5138<para>Glossary cross-references <emphasis>within the glossary</emphasis> are 5139not supported. For example, this <emphasis>will not</emphasis> work:</para> 5140 5141<informalexample> 5142<programlisting><glossentry> 5143<glossterm>gloss-1</glossterm> 5144<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> 5145<glossseealso>gloss-2</glossseealso> 5146</glossdef> 5147</glossentry></programlisting> 5148</informalexample> 5149 5150<para>If you put glossary cross-references in your glossary that way, 5151you'll get the cryptic error: <computeroutput>Warning: 5152glossary.collection specified, but there are 0 automatic 5153glossaries</computeroutput>.</para> 5154 5155<para>Instead, you must do two things:</para> 5156 5157<orderedlist> 5158<listitem> 5159<para>Markup your glossary using <sgmltag>glossseealso</sgmltag>:</para> 5160 5161<informalexample> 5162<programlisting><glossentry> 5163<glossterm>gloss-1</glossterm> 5164<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> 5165<glossseealso>gloss-2</glossseealso> 5166</glossdef> 5167</glossentry></programlisting> 5168</informalexample> 5169</listitem> 5170 5171<listitem> 5172<para>Make sure there is at least one <sgmltag>glossterm</sgmltag> reference to 5173<glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The 5174easiest way to do that is probably within a <sgmltag>remark</sgmltag> in your 5175automatic glossary:</para> 5176 5177<informalexample> 5178<programlisting><glossary role="auto"> 5179<remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark> 5180<glossentry> 5181<glossterm>Irrelevant</glossterm> 5182<glossdef> 5183<para>If you can see this, the document was processed incorrectly. Use 5184the <parameter>glossary.collection</parameter> parameter.</para> 5185</glossdef> 5186</glossentry> 5187</glossary></programlisting> 5188</informalexample> 5189</listitem> 5190</orderedlist> 5191</refsect2> 5192 5193</refsect1> 5194</refentry> 5195 5196<refentry id="glossentry.show.acronym"> 5197<refmeta> 5198<refentrytitle>glossentry.show.acronym</refentrytitle> 5199<refmiscinfo role="type">list</refmiscinfo> 5200</refmeta> 5201<refnamediv> 5202<refname>glossentry.show.acronym</refname> 5203<refpurpose>Display <sgmltag>glossentry</sgmltag> acronyms?</refpurpose> 5204</refnamediv> 5205 5206<refsynopsisdiv> 5207<programlisting id="glossentry.show.acronym.frag"> 5208<xsl:param name="glossentry.show.acronym" select="'no'"></xsl:param> 5209</programlisting> 5210</refsynopsisdiv> 5211 5212<refsect1><title>Description</title> 5213 5214<para>A setting of <quote>yes</quote> means they should be displayed; 5215<quote>no</quote> means they shouldn't. If <quote>primary</quote> is used, 5216then they are shown as the primary text for the entry.</para> 5217 5218<note> 5219<para>This setting controls both <sgmltag>acronym</sgmltag> and 5220<sgmltag>abbrev</sgmltag> elements in the <sgmltag>glossentry</sgmltag>.</para> 5221</note> 5222 5223</refsect1> 5224</refentry> 5225 5226</reference> 5227 5228<reference id="misc"><title>Miscellaneous</title> 5229<refentry id="formal.procedures"> 5230<refmeta> 5231<refentrytitle>formal.procedures</refentrytitle> 5232<refmiscinfo role="type">boolean</refmiscinfo> 5233</refmeta> 5234<refnamediv> 5235<refname>formal.procedures</refname> 5236<refpurpose>Selects formal or informal procedures</refpurpose> 5237</refnamediv> 5238 5239<refsynopsisdiv> 5240<programlisting id="formal.procedures.frag"> 5241<xsl:param name="formal.procedures" select="1"></xsl:param> 5242</programlisting> 5243</refsynopsisdiv> 5244 5245<refsect1><title>Description</title> 5246 5247<para>Formal procedures are numbered and always have a title. 5248</para> 5249 5250</refsect1> 5251</refentry> 5252 5253<refentry id="formal.title.placement"> 5254<refmeta> 5255<refentrytitle>formal.title.placement</refentrytitle> 5256<refmiscinfo role="type"/> 5257</refmeta> 5258<refnamediv> 5259<refname>formal.title.placement</refname> 5260<refpurpose>Specifies where formal object titles should occur</refpurpose> 5261</refnamediv> 5262 5263<refsynopsisdiv> 5264<programlisting id="formal.title.placement.frag"> 5265<xsl:param name="formal.title.placement"> 5266figure before 5267example before 5268equation before 5269table before 5270procedure before 5271task before 5272</xsl:param> 5273</programlisting> 5274</refsynopsisdiv> 5275 5276<refsect1><title>Description</title> 5277 5278<para>Specifies where formal object titles should occur. For each formal object 5279type (<sgmltag>figure</sgmltag>, 5280<sgmltag>example</sgmltag>, 5281<sgmltag>equation</sgmltag>, 5282<sgmltag>table</sgmltag>, and <sgmltag>procedure</sgmltag>) 5283you can specify either the keyword 5284<quote><literal>before</literal></quote> or 5285<quote><literal>after</literal></quote>.</para> 5286 5287</refsect1> 5288</refentry> 5289 5290<refentry id="runinhead.default.title.end.punct"> 5291<refmeta> 5292<refentrytitle>runinhead.default.title.end.punct</refentrytitle> 5293<refmiscinfo role="type">string</refmiscinfo> 5294</refmeta> 5295<refnamediv> 5296<refname>runinhead.default.title.end.punct</refname> 5297<refpurpose>Default punctuation character on a run-in-head</refpurpose> 5298</refnamediv> 5299 5300<refsynopsisdiv> 5301<programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct" select="'.'"></xsl:param></programlisting> 5302</refsynopsisdiv> 5303 5304<refsect1><title>Description</title> 5305 5306<para>FIXME: 5307</para> 5308 5309</refsect1> 5310</refentry> 5311 5312<refentry id="runinhead.title.end.punct"> 5313<refmeta> 5314<refentrytitle>runinhead.title.end.punct</refentrytitle> 5315<refmiscinfo role="type">string</refmiscinfo> 5316</refmeta> 5317<refnamediv> 5318<refname>runinhead.title.end.punct</refname> 5319<refpurpose>Characters that count as punctuation on a run-in-head</refpurpose> 5320</refnamediv> 5321 5322<refsynopsisdiv> 5323<programlisting id="runinhead.title.end.punct.frag"><xsl:param name="runinhead.title.end.punct" select="'.!?:'"></xsl:param></programlisting> 5324</refsynopsisdiv> 5325 5326<refsect1><title>Description</title> 5327 5328<para>FIXME: 5329</para> 5330 5331</refsect1> 5332</refentry> 5333 5334<refentry id="show.comments"> 5335<refmeta> 5336<refentrytitle>show.comments</refentrytitle> 5337<refmiscinfo role="type">boolean</refmiscinfo> 5338</refmeta> 5339<refnamediv> 5340<refname>show.comments</refname> 5341<refpurpose>Display <sgmltag>comment</sgmltag> elements?</refpurpose> 5342</refnamediv> 5343 5344<refsynopsisdiv> 5345<programlisting id="show.comments.frag"><xsl:param name="show.comments">1</xsl:param></programlisting> 5346</refsynopsisdiv> 5347 5348<refsect1><title>Description</title> 5349 5350<para>If true (non-zero), comments will be displayed, otherwise they are suppressed. 5351Comments here refers to the <sgmltag>comment</sgmltag> element, 5352which will be renamed <sgmltag>remark</sgmltag> in DocBook V4.0, 5353not XML comments (<-- like this -->) which are unavailable. 5354</para> 5355 5356</refsect1> 5357</refentry> 5358 5359<refentry id="show.revisionflag"> 5360<refmeta> 5361<refentrytitle>show.revisionflag</refentrytitle> 5362<refmiscinfo role="type">boolean</refmiscinfo> 5363</refmeta> 5364<refnamediv> 5365<refname>show.revisionflag</refname> 5366<refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> 5367</refnamediv> 5368 5369<refsynopsisdiv> 5370<programlisting id="show.revisionflag.frag"><xsl:param name="show.revisionflag">0</xsl:param></programlisting> 5371</refsynopsisdiv> 5372 5373<refsect1><title>Description</title> 5374 5375<para> 5376If <literal>show.revisionflag</literal> is turned on, then the stylesheets 5377may produce additional markup designed to allow a CSS stylesheet to 5378highlight elements that have specific revisionflag settings.</para> 5379 5380<para>The markup inserted will be usually be either a <span> or <div> 5381with an appropriate <literal>class</literal> attribute. (The value of 5382the class attribute will be the same as the value of the revisionflag 5383attribute). In some contexts, for example tables, where extra markup 5384would be structurally illegal, the class attribute will be added to the 5385appropriate container element.</para> 5386 5387<para>In general, the stylesheets only test for revisionflag in contexts 5388where an importing stylesheet would have to redefine whole templates. 5389Most of the revisionflag processing is expected to be done by another 5390stylesheet, for example <filename>changebars.xsl</filename>.</para> 5391 5392</refsect1> 5393</refentry> 5394 5395<refentry id="shade.verbatim"> 5396<refmeta> 5397<refentrytitle>shade.verbatim</refentrytitle> 5398<refmiscinfo role="type">boolean</refmiscinfo> 5399</refmeta> 5400<refnamediv> 5401<refname>shade.verbatim</refname> 5402<refpurpose>Should verbatim environments be shaded?</refpurpose> 5403</refnamediv> 5404 5405<refsynopsisdiv> 5406<programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting> 5407</refsynopsisdiv> 5408 5409<refsect1><title>Description</title> 5410 5411<para>In the FO stylesheet, if this parameter is non-zero then the 5412<property>shade.verbatim.style</property> properties will be applied 5413to verbatim environments.</para> 5414 5415<para>In the HTML stylesheet, this parameter is now deprecated. Use 5416CSS instead.</para> 5417 5418</refsect1> 5419</refentry> 5420 5421<refentry id="shade.verbatim.style"> 5422<refmeta> 5423<refentrytitle>shade.verbatim.style</refentrytitle> 5424<refmiscinfo role="type"/> 5425</refmeta> 5426<refnamediv> 5427<refname>shade.verbatim.style</refname> 5428<refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose> 5429</refnamediv> 5430 5431<refsynopsisdiv> 5432<programlisting id="shade.verbatim.style.frag"> 5433<xsl:attribute-set name="shade.verbatim.style"> 5434 <xsl:attribute name="border">0</xsl:attribute> 5435 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute> 5436</xsl:attribute-set> 5437 5438</programlisting> 5439</refsynopsisdiv> 5440 5441<refsect1><title>Description</title> 5442 5443<para>FIXME:</para> 5444 5445</refsect1> 5446</refentry> 5447 5448<refentry id="punct.honorific"> 5449<refmeta> 5450<refentrytitle>punct.honorific</refentrytitle> 5451<refmiscinfo role="type">string</refmiscinfo> 5452</refmeta> 5453<refnamediv> 5454<refname>punct.honorific</refname> 5455<refpurpose>Punctuation after an honorific in a personal name.</refpurpose> 5456</refnamediv> 5457 5458<refsynopsisdiv> 5459<programlisting id="punct.honorific.frag"> 5460<xsl:param name="punct.honorific" select="'.'"></xsl:param> 5461</programlisting> 5462</refsynopsisdiv> 5463 5464<refsect1><title>Description</title> 5465 5466<para>This parameter specifies the punctuation that should be added after an 5467honorific in a personal name.</para> 5468 5469</refsect1> 5470</refentry> 5471 5472<refentry id="tex.math.in.alt"> 5473<refmeta> 5474<refentrytitle>tex.math.in.alt</refentrytitle> 5475<refmiscinfo role="type">string</refmiscinfo> 5476</refmeta> 5477<refnamediv> 5478<refname>tex.math.in.alt</refname> 5479<refpurpose>TeX notation used for equations</refpurpose> 5480</refnamediv> 5481 5482<refsynopsisdiv> 5483<programlisting id="tex.math.in.alt.frag"> 5484<xsl:param name="tex.math.in.alt" select="''"></xsl:param> 5485</programlisting> 5486</refsynopsisdiv> 5487 5488<refsect1><title>Description</title> 5489 5490<para>If you want type math directly in TeX notation in equations, 5491this parameter specifies notation used. Currently are supported two 5492values -- <literal>plain</literal> and <literal>latex</literal>. Empty 5493value means that you are not using TeX math at all.</para> 5494 5495<para>Preferred way for including TeX alternative of math is inside of 5496<sgmltag>textobject</sgmltag> element. Eg.:</para> 5497 5498<programlisting><inlineequation> 5499<inlinemediaobject> 5500<imageobject> 5501<imagedata fileref="eq1.gif"/> 5502</imageobject> 5503<textobject><phrase>E=mc squared</phrase></textobject> 5504<textobject role="tex"><phrase>E=mc^2</phrase></textobject> 5505</inlinemediaobject> 5506</inlineequation></programlisting> 5507 5508<para>If you are using <sgmltag>graphic</sgmltag> element, you can 5509store TeX inside <sgmltag>alt</sgmltag> element:</para> 5510 5511<programlisting><inlineequation> 5512<alt role="tex">a^2+b^2=c^2</alt> 5513<graphic fileref="a2b2c2.gif"/> 5514</inlineequation></programlisting> 5515 5516<para>If you want use this feature, you should process your FO with 5517PassiveTeX, which only supports TeX math notation. When calling 5518stylsheet, don't forget to specify also 5519passivetex.extensions=1.</para> 5520 5521<para>If you want equations in HTML, just process generated file 5522<filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run 5523dvi2bitmap program on result DVI file. You will get images for 5524equations in your document.</para> 5525 5526</refsect1> 5527</refentry> 5528 5529<refentry id="tex.math.file"> 5530<refmeta> 5531<refentrytitle>tex.math.file</refentrytitle> 5532<refmiscinfo role="type">string</refmiscinfo> 5533</refmeta> 5534<refnamediv> 5535<refname>tex.math.file</refname> 5536<refpurpose>Name of temporary file for generating images from equations</refpurpose> 5537</refnamediv> 5538 5539<refsynopsisdiv> 5540<programlisting id="tex.math.file.frag"> 5541<xsl:param name="tex.math.file" select="'tex-math-equations.tex'"></xsl:param> 5542</programlisting> 5543</refsynopsisdiv> 5544 5545<refsect1><title>Description</title> 5546 5547<para>Name of auxiliary file for TeX equations. This file can be 5548processed by dvi2bitmap to get bitmap versions of equations for HTML 5549output.</para> 5550 5551</refsect1> 5552</refentry> 5553 5554<refentry id="tex.math.delims"> 5555<refmeta> 5556<refentrytitle>tex.math.delims</refentrytitle> 5557<refmiscinfo role="type">boolean</refmiscinfo> 5558</refmeta> 5559<refnamediv> 5560<refname>tex.math.delims</refname> 5561<refpurpose>Should be equations outputed for processing by TeX 5562automatically surrounded by math mode delimiters</refpurpose> 5563</refnamediv> 5564 5565<refsynopsisdiv> 5566<programlisting id="tex.math.delims.frag"> 5567<xsl:param name="tex.math.delims" select="'1'"></xsl:param> 5568</programlisting> 5569</refsynopsisdiv> 5570 5571<refsect1><title>Description</title> 5572 5573<para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell 5574you should set this parameter to 0.</para> 5575 5576</refsect1> 5577</refentry> 5578 5579<refentry id="pixels.per.inch"> 5580<refmeta> 5581<refentrytitle>pixels.per.inch</refentrytitle> 5582<refmiscinfo role="type">integer</refmiscinfo> 5583</refmeta> 5584<refnamediv> 5585<refname>pixels.per.inch</refname> 5586<refpurpose>How many pixels are there per inch?</refpurpose> 5587</refnamediv> 5588 5589<refsynopsisdiv> 5590<programlisting id="pixels.per.inch.frag"> 5591<xsl:param name="pixels.per.inch" select="90"></xsl:param> 5592</programlisting> 5593</refsynopsisdiv> 5594 5595<refsect1><title>Description</title> 5596 5597<para>When lengths are converted to pixels, this value is used to 5598determine the size of a pixel. The default value is taken from the 5599<ulink url="http://www.w3.org/TR/xsl/slice5.html#pixels">XSL 5600Recommendation</ulink>. 5601</para> 5602 5603</refsect1> 5604</refentry> 5605 5606<refentry id="points.per.em"> 5607<refmeta> 5608<refentrytitle>points.per.em</refentrytitle> 5609<refmiscinfo role="type">number</refmiscinfo> 5610</refmeta> 5611<refnamediv> 5612<refname>points.per.em</refname> 5613<refpurpose>Specify the nominal size of an em-space in points</refpurpose> 5614</refnamediv> 5615 5616<refsynopsisdiv> 5617<programlisting id="points.per.em.frag"> 5618<xsl:param name="points.per.em" select="10"></xsl:param> 5619</programlisting> 5620</refsynopsisdiv> 5621 5622<refsect1><title>Description</title> 5623 5624<para>FIXME:</para> 5625 5626</refsect1> 5627</refentry> 5628 5629<refentry id="use.svg"> 5630<refmeta> 5631<refentrytitle>use.svg</refentrytitle> 5632<refmiscinfo role="type">boolean</refmiscinfo> 5633</refmeta> 5634<refnamediv> 5635<refname>use.svg</refname> 5636<refpurpose>Allow SVG in the result tree?</refpurpose> 5637</refnamediv> 5638 5639<refsynopsisdiv> 5640<programlisting id="use.svg.frag"> 5641<xsl:param name="use.svg" select="1"></xsl:param> 5642</programlisting> 5643</refsynopsisdiv> 5644 5645<refsect1><title>Description</title> 5646 5647<para>If non-zero, SVG will be considered an acceptable image format. SVG 5648is passed through to the result tree, so correct rendering of the resulting 5649diagram depends on the formatter (FO processor or web browser) that is used 5650to process the output from the stylesheet.</para> 5651 5652</refsect1> 5653</refentry> 5654 5655<refentry id="menuchoice.separator"> 5656<refmeta> 5657<refentrytitle>menuchoice.separator</refentrytitle> 5658<refmiscinfo role="type"/> 5659</refmeta> 5660<refnamediv> 5661<refname>menuchoice.separator</refname> 5662<refpurpose>Separator between items of a <sgmltag>menuchoice</sgmltag> 5663other than <sgmltag>guimenuitem</sgmltag> and 5664<sgmltag>guisubmenu</sgmltag></refpurpose> 5665</refnamediv> 5666 5667<refsynopsisdiv> 5668<programlisting id="menuchoice.separator.frag"> 5669<xsl:param name="menuchoice.separator" select="'+'"></xsl:param> 5670</programlisting> 5671</refsynopsisdiv> 5672 5673<refsect1><title>Description</title> 5674 5675<para>Separator used to connect items of a <sgmltag>menuchoice</sgmltag> other 5676than <sgmltag>guimenuitem</sgmltag> and <sgmltag>guisubmenu</sgmltag>. The latter 5677elements are linked with <parameter>menuchoice.menu.separator</parameter>. 5678</para> 5679 5680</refsect1> 5681</refentry> 5682 5683<refentry id="menuchoice.menu.separator"> 5684<refmeta> 5685<refentrytitle>menuchoice.menu.separator</refentrytitle> 5686<refmiscinfo role="type"/> 5687</refmeta> 5688<refnamediv> 5689<refname>menuchoice.menu.separator</refname> 5690<refpurpose>Separator between items of a <sgmltag>menuchoice</sgmltag> 5691with <sgmltag>guimenuitem</sgmltag> or 5692<sgmltag>guisubmenu</sgmltag></refpurpose> 5693</refnamediv> 5694 5695<refsynopsisdiv> 5696<programlisting id="menuchoice.menu.separator.frag"> 5697<xsl:param name="menuchoice.menu.separator"> ��� </xsl:param> 5698</programlisting> 5699</refsynopsisdiv> 5700 5701<refsect1><title>Description</title> 5702 5703<para>Separator used to connect items of a <sgmltag>menuchoice</sgmltag> with 5704<sgmltag>guimenuitem</sgmltag> or <sgmltag>guisubmenu</sgmltag>. Other elements 5705are linked with <parameter>menuchoice.separator</parameter>. 5706</para> 5707<para>The default value is &#x2192;, which is the 5708&rarr; (right arrow) character entity. 5709The current FOP (0.20.5) requires setting the font-family 5710explicitly. 5711</para> 5712<para>The default value also includes spaces around the arrow, 5713which will allow a line to break. Replace the spaces with 5714&#xA0; (nonbreaking space) if you don't want those 5715spaces to break. 5716</para> 5717 5718</refsect1> 5719</refentry> 5720 5721<refentry id="default.float.class"> 5722<refmeta> 5723<refentrytitle>default.float.class</refentrytitle> 5724<refmiscinfo role="type">string</refmiscinfo> 5725</refmeta> 5726<refnamediv> 5727<refname>default.float.class</refname> 5728<refpurpose>Specifies the default float class</refpurpose> 5729</refnamediv> 5730 5731<refsynopsisdiv> 5732<programlisting id="default.float.class.frag"> 5733<xsl:param name="default.float.class"> 5734 <xsl:choose> 5735 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when> 5736 <xsl:otherwise>before</xsl:otherwise> 5737 </xsl:choose> 5738</xsl:param> 5739</programlisting> 5740</refsynopsisdiv> 5741 5742<refsect1><title>Description</title> 5743 5744<para>FIXME:</para> 5745 5746</refsect1> 5747</refentry> 5748 5749<refentry id="footnote.number.format"> 5750<refmeta> 5751<refentrytitle>footnote.number.format</refentrytitle> 5752<refmiscinfo role="type">string</refmiscinfo> 5753</refmeta> 5754<refnamediv> 5755<refname>footnote.number.format</refname> 5756<refpurpose>Identifies the format used for footnote numbers</refpurpose> 5757</refnamediv> 5758 5759<refsynopsisdiv> 5760<programlisting id="footnote.number.format.frag"> 5761<xsl:param name="footnote.number.format" select="'1'"></xsl:param> 5762</programlisting> 5763</refsynopsisdiv> 5764 5765<refsect1><title>Description</title> 5766 5767<para>The <parameter>footnote.number.format</parameter> specifies the format 5768to use for footnote numeration (1, i, I, a, or A).</para> 5769 5770</refsect1> 5771</refentry> 5772 5773<refentry id="table.footnote.number.format"> 5774<refmeta> 5775<refentrytitle>table.footnote.number.format</refentrytitle> 5776<refmiscinfo role="type">string</refmiscinfo> 5777</refmeta> 5778<refnamediv> 5779<refname>table.footnote.number.format</refname> 5780<refpurpose>Identifies the format used for footnote numbers in tables</refpurpose> 5781</refnamediv> 5782 5783<refsynopsisdiv> 5784<programlisting id="table.footnote.number.format.frag"> 5785<xsl:param name="table.footnote.number.format" select="'a'"></xsl:param> 5786</programlisting> 5787</refsynopsisdiv> 5788 5789<refsect1><title>Description</title> 5790 5791<para>The <parameter>table.footnote.number.format</parameter> specifies the format 5792to use for footnote numeration (1, i, I, a, or A) in tables.</para> 5793 5794</refsect1> 5795</refentry> 5796 5797<refentry id="footnote.number.symbols"> 5798<refmeta> 5799<refentrytitle>footnote.number.symbols</refentrytitle> 5800<refmiscinfo role="type"/> 5801</refmeta> 5802<refnamediv> 5803<refname>footnote.number.symbols</refname> 5804<refpurpose>Special characters to use as footnote markers</refpurpose> 5805</refnamediv> 5806 5807<refsynopsisdiv> 5808<programlisting id="footnote.number.symbols.frag"> 5809<xsl:param name="footnote.number.symbols" select="''"></xsl:param> 5810</programlisting> 5811</refsynopsisdiv> 5812 5813<refsect1><title>Description</title> 5814 5815<para>If <parameter>footnote.number.symbols</parameter> is not the empty string, 5816footnotes will use the characters it contains as footnote symbols. For example, 5817<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify 5818footnotes with <quote>*</quote>, <quote>���</quote>, <quote>���</quote>, 5819<quote>���</quote>, and <quote>���</quote>. If there are more footnotes 5820than symbols, the stylesheets will fall back to numbered footnotes using 5821<parameter>footnote.number.format</parameter>.</para> 5822 5823<para>The use of symbols for footnotes depends on the ability of your 5824processor (or browser) to render the symbols you select. Not all systems are 5825capable of displaying the full range of Unicode characters. If the quoted characters 5826in the preceding paragraph are not displayed properly, that's a good indicator 5827that you may have trouble using those symbols for footnotes.</para> 5828 5829</refsect1> 5830</refentry> 5831 5832<refentry id="table.footnote.number.symbols"> 5833<refmeta> 5834<refentrytitle>table.footnote.number.symbols</refentrytitle> 5835<refmiscinfo role="type"/> 5836</refmeta> 5837<refnamediv> 5838<refname>table.footnote.number.symbols</refname> 5839<refpurpose>Special characters to use a footnote markers in tables</refpurpose> 5840</refnamediv> 5841 5842<refsynopsisdiv> 5843<programlisting id="table.footnote.number.symbols.frag"> 5844<xsl:param name="table.footnote.number.symbols" select="''"></xsl:param> 5845</programlisting> 5846</refsynopsisdiv> 5847 5848<refsect1><title>Description</title> 5849 5850<para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string, 5851table footnotes will use the characters it contains as footnote symbols. For example, 5852<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify 5853footnotes with <quote>*</quote>, <quote>���</quote>, <quote>���</quote>, 5854<quote>���</quote>, and <quote>���</quote>. If there are more footnotes 5855than symbols, the stylesheets will fall back to numbered footnotes using 5856<parameter>table.footnote.number.format</parameter>.</para> 5857 5858<para>The use of symbols for footnotes depends on the ability of your 5859processor (or browser) to render the symbols you select. Not all systems are 5860capable of displaying the full range of Unicode characters. If the quoted characters 5861in the preceding paragraph are not displayed properly, that's a good indicator 5862that you may have trouble using those symbols for footnotes.</para> 5863 5864</refsect1> 5865</refentry> 5866 5867</reference> 5868 5869<reference id="annos"><title>Annotations</title> 5870<refentry id="annotation.support"> 5871<refmeta> 5872<refentrytitle>annotation.support</refentrytitle> 5873<refmiscinfo role="type">boolean</refmiscinfo> 5874</refmeta> 5875<refnamediv> 5876<refname>annotation.support</refname> 5877<refpurpose>Enable annotations?</refpurpose> 5878</refnamediv> 5879 5880<refsynopsisdiv> 5881<programlisting id="annotation.support.frag"> 5882<xsl:param name="annotation.support" select="0"></xsl:param> 5883</programlisting> 5884</refsynopsisdiv> 5885 5886<refsect1><title>Description</title> 5887 5888<para>If non-zero, the stylesheets will attempt to support annotation 5889elements in HTML by including some JavaScript (see 5890<parameter>annotation.js</parameter>).</para> 5891 5892</refsect1> 5893</refentry> 5894 5895<refentry id="annotation.js"> 5896<refmeta> 5897<refentrytitle>annotation.js</refentrytitle> 5898<refmiscinfo role="type">boolean</refmiscinfo> 5899</refmeta> 5900<refnamediv> 5901<refname>annotation.js</refname> 5902<refpurpose>Enable annotations?</refpurpose> 5903</refnamediv> 5904 5905<refsynopsisdiv> 5906<programlisting id="annotation.js.frag"> 5907<xsl:param name="annotation.js" select="'http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js'"></xsl:param> 5908</programlisting> 5909</refsynopsisdiv> 5910 5911<refsect1><title>Description</title> 5912 5913<para>If <property>annotation.support</property> is enabled and the 5914document contains <sgmltag>annotation</sgmltag>s, then the URIs listed 5915in this parameter will be included. These JavaScript files are required 5916for popup annotation support.</para> 5917 5918</refsect1> 5919</refentry> 5920 5921<refentry id="annotation.css"> 5922<refmeta> 5923<refentrytitle>annotation.css</refentrytitle> 5924<refmiscinfo role="type">boolean</refmiscinfo> 5925</refmeta> 5926<refnamediv> 5927<refname>annotation.css</refname> 5928<refpurpose>Enable annotations?</refpurpose> 5929</refnamediv> 5930 5931<refsynopsisdiv> 5932<programlisting id="annotation.css.frag"> 5933<xsl:param name="annotation.css"> 5934/* ====================================================================== 5935 Annotations 5936*/ 5937 5938div.annotation-list { visibility: hidden; 5939 } 5940 5941div.annotation-nocss { position: absolute; 5942 visibility: hidden; 5943 } 5944 5945div.annotation-popup { position: absolute; 5946 z-index: 4; 5947 visibility: hidden; 5948 padding: 0px; 5949 margin: 2px; 5950 border-style: solid; 5951 border-width: 1px; 5952 width: 200px; 5953 background-color: white; 5954 } 5955 5956div.annotation-title { padding: 1px; 5957 font-weight: bold; 5958 border-bottom-style: solid; 5959 border-bottom-width: 1px; 5960 color: white; 5961 background-color: black; 5962 } 5963 5964div.annotation-body { padding: 2px; 5965 } 5966 5967div.annotation-body p { margin-top: 0px; 5968 padding-top: 0px; 5969 } 5970 5971div.annotation-close { position: absolute; 5972 top: 2px; 5973 right: 2px; 5974 } 5975</xsl:param> 5976</programlisting> 5977</refsynopsisdiv> 5978 5979<refsect1><title>Description</title> 5980 5981<para>If <property>annotation.support</property> is enabled and the 5982document contains <sgmltag>annotation</sgmltag>s, then the CSS in this 5983parameter will be included in the document.</para> 5984 5985</refsect1> 5986</refentry> 5987 5988<refentry id="annotation.graphic.open"> 5989<refmeta> 5990<refentrytitle>annotation.graphic.open</refentrytitle> 5991<refmiscinfo role="type">boolean</refmiscinfo> 5992</refmeta> 5993<refnamediv> 5994<refname>annotation.graphic.open</refname> 5995<refpurpose>Enable annotations?</refpurpose> 5996</refnamediv> 5997 5998<refsynopsisdiv> 5999<programlisting id="annotation.graphic.open.frag"> 6000<xsl:param name="annotation.graphic.open" select="'http://docbook.sourceforge.net/release/images/annot-open.png'"></xsl:param> 6001</programlisting> 6002</refsynopsisdiv> 6003 6004<refsect1><title>Description</title> 6005 6006<para>This image is used inline to identify the location of 6007annotations.</para> 6008 6009</refsect1> 6010</refentry> 6011 6012<refentry id="annotation.graphic.close"> 6013<refmeta> 6014<refentrytitle>annotation.graphic.close</refentrytitle> 6015<refmiscinfo role="type">boolean</refmiscinfo> 6016</refmeta> 6017<refnamediv> 6018<refname>annotation.graphic.close</refname> 6019<refpurpose>Enable annotations?</refpurpose> 6020</refnamediv> 6021 6022<refsynopsisdiv> 6023<programlisting id="annotation.graphic.close.frag"> 6024<xsl:param name="annotation.graphic.close" select="'http://docbook.sourceforge.net/release/images/annot-close.png'"></xsl:param> 6025</programlisting> 6026</refsynopsisdiv> 6027 6028<refsect1><title>Description</title> 6029 6030<para>This image is used on popup annotations as the ���x��� that the 6031user can click to dismiss the popup.</para> 6032 6033</refsect1> 6034</refentry> 6035 6036</reference> 6037 6038<reference id="graphics"><title>Graphics</title> 6039<refentry id="img.src.path"> 6040<refmeta> 6041<refentrytitle>img.src.path</refentrytitle> 6042<refmiscinfo role="type">string</refmiscinfo> 6043</refmeta> 6044<refnamediv> 6045<refname>img.src.path</refname> 6046<refpurpose>Path to HTML image files</refpurpose> 6047</refnamediv> 6048 6049<refsynopsisdiv> 6050<programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting> 6051</refsynopsisdiv> 6052 6053<refsect1><title>Description</title> 6054 6055<para>Add a path prefix to each HTML 6056<sgmltag class="element">img</sgmltag> or FO 6057<sgmltag class="element">fo:external-graphics</sgmltag> element's 6058<sgmltag class="attribute">src</sgmltag> attribute. 6059This path could relative to the directory where the HTML/FO 6060files are created, or it could be an absolute URI. 6061The default value is empty. 6062Be sure to include a trailing slash if needed. 6063</para> 6064<para>This prefix is not applied to any filerefs that start 6065with "/" or contain "//:". 6066</para> 6067 6068</refsect1> 6069</refentry> 6070 6071<refentry id="keep.relative.image.uris"> 6072<refmeta> 6073<refentrytitle>keep.relative.image.uris</refentrytitle> 6074<refmiscinfo role="type">boolean</refmiscinfo> 6075</refmeta> 6076<refnamediv> 6077<refname>keep.relative.image.uris</refname> 6078<refpurpose>Should image URIs be resolved against xml:base?</refpurpose> 6079</refnamediv> 6080 6081<refsynopsisdiv> 6082<programlisting id="keep.relative.image.uris.frag"> 6083<xsl:param name="keep.relative.image.uris" select="1"></xsl:param> 6084 6085</programlisting> 6086</refsynopsisdiv> 6087 6088<refsect1><title>Description</title> 6089 6090<para>If non-zeor, relative URIs (in, for example fileref attributes) will 6091be used in the generated output. Otherwise, the URIs will be made absolute 6092with respect to the base URI.</para> 6093 6094<para>Note that the stylesheets calculate (and use) the absolute form 6095for some purposes, this only applies to the resulting output.</para> 6096 6097</refsect1> 6098</refentry> 6099 6100<refentry id="graphic.default.extension"> 6101<refmeta> 6102<refentrytitle>graphic.default.extension</refentrytitle> 6103<refmiscinfo role="type">string</refmiscinfo> 6104</refmeta> 6105<refnamediv> 6106<refname>graphic.default.extension</refname> 6107<refpurpose>Default extension for graphic filenames</refpurpose> 6108</refnamediv> 6109 6110<refsynopsisdiv> 6111<programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting> 6112</refsynopsisdiv> 6113 6114<refsect1><title>Description</title> 6115 6116<para>If a <sgmltag>graphic</sgmltag> or <sgmltag>mediaobject</sgmltag> 6117includes a reference to a filename that does not include an extension, 6118and the <sgmltag class="attribute">format</sgmltag> attribute is 6119<emphasis>unspecified</emphasis>, the default extension will be used. 6120</para> 6121 6122</refsect1> 6123</refentry> 6124 6125<refentry id="default.image.width"> 6126<refmeta> 6127<refentrytitle>default.image.width</refentrytitle> 6128<refmiscinfo role="type">length</refmiscinfo> 6129</refmeta> 6130<refnamediv> 6131<refname>default.image.width</refname> 6132<refpurpose>The default width of images</refpurpose> 6133</refnamediv> 6134 6135<refsynopsisdiv> 6136<programlisting id="default.image.width.frag"> 6137<xsl:param name="default.image.width" select="''"></xsl:param> 6138</programlisting> 6139</refsynopsisdiv> 6140 6141<refsect1><title>Description</title> 6142 6143<para>If specified, this value will be used for the 6144<sgmltag class="attribute">width</sgmltag> attribute on 6145images that do not specify any 6146<ulink url="http://docbook.org/tdg/en/html/imagedata.html#viewport.area">viewport 6147dimensions</ulink>.</para> 6148 6149</refsect1> 6150</refentry> 6151 6152<refentry id="nominal.image.width"> 6153<refmeta> 6154<refentrytitle>nominal.image.width</refentrytitle> 6155<refmiscinfo role="type">length</refmiscinfo> 6156</refmeta> 6157<refnamediv> 6158<refname>nominal.image.width</refname> 6159<refpurpose>The nominal image width</refpurpose> 6160</refnamediv> 6161 6162<refsynopsisdiv> 6163<programlisting id="nominal.image.width.frag"> 6164<xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></xsl:param> 6165</programlisting> 6166</refsynopsisdiv> 6167 6168<refsect1><title>Description</title> 6169 6170<para>Graphic widths expressed as a percentage are problematic. In the 6171following discussion, we speak of width and contentwidth, but 6172the same issues apply to depth and contentdepth.</para> 6173 6174<para>A width of 50% means "half of the available space for the image." 6175That's fine. But note that in HTML, this is a dynamic property and 6176the image size will vary if the browser window is resized.</para> 6177 6178<para>A contentwidth of 50% means "half of the actual image width". 6179But what does that mean if the stylesheets cannot assess the image's 6180actual size? Treating this as a width of 50% is one possibility, but 6181it produces behavior (dynamic scaling) that seems entirely out of 6182character with the meaning.</para> 6183 6184<para>Instead, the stylesheets define a 6185<parameter>nominal.image.width</parameter> and convert percentages to 6186actual values based on that nominal size.</para> 6187 6188</refsect1> 6189</refentry> 6190 6191<refentry id="nominal.image.depth"> 6192<refmeta> 6193<refentrytitle>nominal.image.depth</refentrytitle> 6194<refmiscinfo role="type">length</refmiscinfo> 6195</refmeta> 6196<refnamediv> 6197<refname>nominal.image.depth</refname> 6198<refpurpose>Nominal image depth</refpurpose> 6199</refnamediv> 6200 6201<refsynopsisdiv> 6202<programlisting id="nominal.image.depth.frag"> 6203<xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></xsl:param> 6204</programlisting> 6205</refsynopsisdiv> 6206 6207<refsect1><title>Description</title> 6208 6209<para>See <parameter>nominal.image.width</parameter>.</para> 6210 6211</refsect1> 6212</refentry> 6213 6214<refentry id="use.embed.for.svg"> 6215<refmeta> 6216<refentrytitle>use.embed.for.svg</refentrytitle> 6217<refmiscinfo role="type">boolean</refmiscinfo> 6218</refmeta> 6219<refnamediv> 6220<refname>use.embed.for.svg</refname> 6221<refpurpose>Use HTML <sgmltag>embed</sgmltag> for SVG?</refpurpose> 6222</refnamediv> 6223 6224<refsynopsisdiv> 6225<programlisting id="use.embed.for.svg.frag"> 6226<xsl:param name="use.embed.for.svg" select="0"></xsl:param> 6227</programlisting> 6228</refsynopsisdiv> 6229 6230<refsect1><title>Description</title> 6231 6232<para>If non-zero, an <sgmltag>embed</sgmltag> element will be created for 6233SVG figures. An <sgmltag>object</sgmltag> is <emphasis>always</emphasis> created, 6234this parameter merely controls whether or not an additional <sgmltag>embed</sgmltag> 6235is generated inside the <sgmltag>object</sgmltag>.</para> 6236 6237<para>On the plus side, this may be more portable among browsers and plug-ins. 6238On the minus side, it isn't valid HTML.</para> 6239 6240</refsect1> 6241</refentry> 6242 6243<refentry id="make.graphic.viewport"> 6244<refmeta> 6245<refentrytitle>make.graphic.viewport</refentrytitle> 6246<refmiscinfo role="type">boolean</refmiscinfo> 6247</refmeta> 6248<refnamediv> 6249<refname>make.graphic.viewport</refname> 6250<refpurpose>Use tables in HTML to make viewports for graphics</refpurpose> 6251</refnamediv> 6252 6253<refsynopsisdiv> 6254<programlisting id="make.graphic.viewport.frag"> 6255<xsl:param name="make.graphic.viewport" select="1"></xsl:param> 6256</programlisting> 6257</refsynopsisdiv> 6258 6259<refsect1><title>Description</title> 6260 6261<para>The HTML <sgmltag>img</sgmltag> element only supports the notion 6262of content-area scaling; it doesn't support the distinction between a 6263content-area and a viewport-area, so we have to make some compromises.</para> 6264 6265<para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table 6266will be used to frame the image. This creates an effective viewport-area. 6267</para> 6268 6269<para>Tables and alignment don't work together, so this parameter is ignored 6270if alignment is specified on an image.</para> 6271</refsect1> 6272</refentry> 6273 6274<refentry id="preferred.mediaobject.role"> 6275<refmeta> 6276<refentrytitle>preferred.mediaobject.role</refentrytitle> 6277</refmeta> 6278<refnamediv> 6279<refname>preferred.mediaobject.role</refname> 6280<refpurpose>Select which mediaobject to use based on 6281this value of an object's <sgmltag class="attribute">role</sgmltag> attribute. 6282</refpurpose> 6283</refnamediv> 6284 6285<refsynopsisdiv> 6286<programlisting id="preferred.mediaobject.role.frag"> 6287<xsl:param name="preferred.mediaobject.role"></xsl:param> 6288</programlisting> 6289</refsynopsisdiv> 6290 6291<refsect1><title>Description</title> 6292 6293<para>A mediaobject may contain several objects such as imageobjects. 6294If the parameter <parameter>use.role.for.mediaobject</parameter> 6295is non-zero, then the <sgmltag class="attribute">role</sgmltag> attribute on 6296<sgmltag>imageobject</sgmltag>s and other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be 6297used. If one of the objects has a role value that matches the 6298preferred.mediaobject.role parameter, then it has first 6299priority for selection. If more than one has such a 6300role value, the first one is used. 6301</para> 6302<para> 6303See the <parameter>use.role.for.mediaobject</parameter> parameter 6304for the sequence of selection.</para> 6305</refsect1> 6306</refentry> 6307 6308<refentry id="use.role.for.mediaobject"> 6309<refmeta> 6310<refentrytitle>use.role.for.mediaobject</refentrytitle> 6311<refmiscinfo role="type">boolean</refmiscinfo> 6312</refmeta> 6313<refnamediv> 6314<refname>use.role.for.mediaobject</refname> 6315<refpurpose>Use <sgmltag class="attribute">role</sgmltag> attribute 6316value for selecting which of several objects within a mediaobject to use. 6317</refpurpose> 6318</refnamediv> 6319 6320<refsynopsisdiv> 6321<programlisting id="use.role.for.mediaobject.frag"> 6322<xsl:param name="use.role.for.mediaobject" select="1"></xsl:param> 6323</programlisting> 6324</refsynopsisdiv> 6325 6326<refsect1><title>Description</title> 6327 6328<para>If non-zero, the <sgmltag class="attribute">role</sgmltag> attribute on 6329<sgmltag>imageobject</sgmltag>s or other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be 6330used. 6331</para> 6332<para> 6333The order of selection when then parameter is non-zero is: 6334</para> 6335<orderedlist> 6336<listitem> 6337 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para> 6338</listitem> 6339<listitem> 6340<para>Else if an object's role attribute has a value of 6341<literal>html</literal> for HTML processing or 6342<literal>fo</literal> for FO output, then the first 6343of such objects is selected. 6344</para> 6345</listitem> 6346<listitem> 6347<para>Else the first suitable object is selected.</para> 6348</listitem> 6349</orderedlist> 6350<para> 6351If the value of 6352<parameter>use.role.for.mediaobject</parameter> 6353is zero, then role attributes are not considered 6354and the first suitable object 6355with or without a role value is used. 6356</para> 6357</refsect1> 6358</refentry> 6359 6360<refentry id="ignore.image.scaling"> 6361<refmeta> 6362<refentrytitle>ignore.image.scaling</refentrytitle> 6363<refmiscinfo role="type">boolean</refmiscinfo> 6364</refmeta> 6365<refnamediv> 6366<refname>ignore.image.scaling</refname> 6367<refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose> 6368</refnamediv> 6369 6370<refsynopsisdiv> 6371<programlisting id="ignore.image.scaling.frag"> 6372<xsl:param name="ignore.image.scaling" select="0"></xsl:param> 6373</programlisting> 6374</refsynopsisdiv> 6375 6376<refsect1><title>Description</title> 6377 6378<para>If non-zero, the scaling attributes on graphics and media objects are 6379ignored.</para> 6380 6381</refsect1> 6382</refentry> 6383 6384</reference> 6385 6386<reference id="chunking"><title>Chunking</title> 6387<refentry id="chunker.output.cdata-section-elements"> 6388<refmeta> 6389<refentrytitle>chunker.output.cdata-section-elements</refentrytitle> 6390<refmiscinfo role="type">string</refmiscinfo> 6391</refmeta> 6392<refnamediv> 6393<refname>chunker.output.cdata-section-elements</refname> 6394<refpurpose>List of elements to escape with CDATA sections</refpurpose> 6395</refnamediv> 6396 6397<refsynopsisdiv><xsl:param name="chunker.output.cdata-section-elements" select="''"/> 6398</refsynopsisdiv> 6399 6400<refsect1><title>Description</title> 6401 6402<para>This parameter specifies the list of elements that should be escaped 6403as CDATA sections by the chunking stylesheet. Not all processors support 6404specification of this parameter. 6405</para> 6406 6407<note> 6408<para>This parameter is documented here, but the declaration is actually 6409in the <filename>chunker.xsl</filename> stylesheet module.</para> 6410</note> 6411 6412</refsect1> 6413</refentry> 6414 6415<refentry id="chunker.output.doctype-public"> 6416<refmeta> 6417<refentrytitle>chunker.output.doctype-public</refentrytitle> 6418<refmiscinfo role="type">string</refmiscinfo> 6419</refmeta> 6420<refnamediv> 6421<refname>chunker.output.doctype-public</refname> 6422<refpurpose>Public identifer to use in the document type of generated pages</refpurpose> 6423</refnamediv> 6424 6425<refsynopsisdiv><xsl:param name="chunker.output.doctype-public" select="''"/> 6426</refsynopsisdiv> 6427 6428<refsect1><title>Description</title> 6429 6430<para>This parameter specifies the public identifier that should be used by 6431the chunking stylesheet in the document type declaration of chunked pages. 6432Not all processors support specification of 6433this parameter. 6434</para> 6435 6436<note> 6437<para>This parameter is documented here, but the declaration is actually 6438in the <filename>chunker.xsl</filename> stylesheet module.</para> 6439</note> 6440 6441</refsect1> 6442</refentry> 6443 6444<refentry id="chunker.output.doctype-system"> 6445<refmeta> 6446<refentrytitle>chunker.output.doctype-system</refentrytitle> 6447<refmiscinfo role="type">uri</refmiscinfo> 6448</refmeta> 6449<refnamediv> 6450<refname>chunker.output.doctype-system</refname> 6451<refpurpose>System identifier to use for the document type in generated pages</refpurpose> 6452</refnamediv> 6453 6454<refsynopsisdiv><xsl:param name="chunker.output.doctype-system" select="''"/> 6455</refsynopsisdiv> 6456 6457<refsect1><title>Description</title> 6458 6459<para>This parameter specifies the system identifier that should be used by 6460the chunking stylesheet in the document type declaration of chunked pages. 6461Not all processors support specification of 6462this parameter. 6463</para> 6464 6465<note> 6466<para>This parameter is documented here, but the declaration is actually 6467in the <filename>chunker.xsl</filename> stylesheet module.</para> 6468</note> 6469 6470</refsect1> 6471</refentry> 6472 6473<refentry id="chunker.output.encoding"> 6474<refmeta> 6475<refentrytitle>chunker.output.encoding</refentrytitle> 6476<refmiscinfo role="type">string</refmiscinfo> 6477</refmeta> 6478<refnamediv> 6479<refname>chunker.output.encoding</refname> 6480<refpurpose>Encoding used in generated pages</refpurpose> 6481</refnamediv> 6482 6483<refsynopsisdiv><xsl:param name="chunker.output.encoding" select="'ISO-8859-1'"/> 6484</refsynopsisdiv> 6485 6486<refsect1><title>Description</title> 6487 6488<para>This parameter specifies the encoding to be used in files 6489generated by the chunking stylesheet. Not all processors support 6490specification of this parameter. 6491</para> 6492 6493<para>This parameter used to be named <literal>default.encoding</literal>.</para> 6494 6495<note> 6496<para>This parameter is documented here, but the declaration is actually 6497in the <filename>chunker.xsl</filename> stylesheet module.</para> 6498</note> 6499 6500</refsect1> 6501</refentry> 6502 6503<refentry id="chunker.output.indent"> 6504<refmeta> 6505<refentrytitle>chunker.output.indent</refentrytitle> 6506<refmiscinfo role="type">string</refmiscinfo> 6507</refmeta> 6508<refnamediv> 6509<refname>chunker.output.indent</refname> 6510<refpurpose>Specification of indentation on generated pages</refpurpose> 6511</refnamediv> 6512 6513<refsynopsisdiv><xsl:param name="chunker.output.indent" select="'no'"/> 6514</refsynopsisdiv> 6515 6516<refsect1><title>Description</title> 6517 6518<para>This parameter specifies the value of the indent 6519specification for generated pages. Not all processors support 6520specification of this parameter. 6521</para> 6522 6523<note> 6524<para>This parameter is documented here, but the declaration is actually 6525in the <filename>chunker.xsl</filename> stylesheet module.</para> 6526</note> 6527 6528</refsect1> 6529</refentry> 6530 6531<refentry id="chunker.output.media-type"> 6532<refmeta> 6533<refentrytitle>chunker.output.media-type</refentrytitle> 6534<refmiscinfo role="type">string</refmiscinfo> 6535</refmeta> 6536<refnamediv> 6537<refname>chunker.output.media-type</refname> 6538<refpurpose>Media type to use in generated pages</refpurpose> 6539</refnamediv> 6540 6541<refsynopsisdiv><xsl:param name="chunker.output.media-type" select="''"/> 6542</refsynopsisdiv> 6543 6544<refsect1><title>Description</title> 6545 6546<para>This parameter specifies the media type that should be used by 6547the chunking stylesheet. Not all processors support specification of 6548this parameter. 6549</para> 6550 6551<note> 6552<para>This parameter is documented here, but the declaration is actually 6553in the <filename>chunker.xsl</filename> stylesheet module.</para> 6554</note> 6555 6556</refsect1> 6557</refentry> 6558 6559<refentry id="chunker.output.method"> 6560<refmeta> 6561<refentrytitle>chunker.output.method</refentrytitle> 6562<refmiscinfo role="type">list</refmiscinfo> 6563<refmiscinfo role="value">html</refmiscinfo> 6564<refmiscinfo role="value">xml</refmiscinfo> 6565</refmeta> 6566<refnamediv> 6567<refname>chunker.output.method</refname> 6568<refpurpose>Method used in generated pages</refpurpose> 6569</refnamediv> 6570 6571<refsynopsisdiv><xsl:param name="chunker.output.method" select="'html'"/> 6572</refsynopsisdiv> 6573 6574<refsect1><title>Description</title> 6575 6576<para>This parameter specifies the output method to be used in files 6577generated by the chunking stylesheet. 6578</para> 6579 6580<para>This parameter used to be named <literal>output.method</literal>.</para> 6581 6582<note> 6583<para>This parameter is documented here, but the declaration is actually 6584in the <filename>chunker.xsl</filename> stylesheet module.</para> 6585</note> 6586 6587</refsect1> 6588</refentry> 6589 6590<refentry id="chunker.output.omit-xml-declaration"> 6591<refmeta> 6592<refentrytitle>chunker.output.omit-xml-declaration</refentrytitle> 6593<refmiscinfo role="type"/> 6594</refmeta> 6595<refnamediv> 6596<refname>chunker.output.omit-xml-declaration</refname> 6597<refpurpose>Omit-xml-declaration for generated pages</refpurpose> 6598</refnamediv> 6599 6600<refsynopsisdiv><xsl:param name="chunker.output.omit-xml-declaration" select="'no'"/> 6601</refsynopsisdiv> 6602 6603<refsect1><title>Description</title> 6604 6605<para>This parameter specifies the value of the omit-xml-declaration 6606specification for generated pages. Not all processors support 6607specification of this parameter. 6608</para> 6609 6610<note> 6611<para>This parameter is documented here, but the declaration is actually 6612in the <filename>chunker.xsl</filename> stylesheet module.</para> 6613</note> 6614 6615</refsect1> 6616</refentry> 6617 6618<refentry id="chunker.output.standalone"> 6619<refmeta> 6620<refentrytitle>chunker.output.standalone</refentrytitle> 6621<refmiscinfo role="type">string</refmiscinfo> 6622</refmeta> 6623<refnamediv> 6624<refname>chunker.output.standalone</refname> 6625<refpurpose>Standalone declaration for generated pages</refpurpose> 6626</refnamediv> 6627 6628<refsynopsisdiv><xsl:param name="chunker.output.standalone" select="'no'"/> 6629</refsynopsisdiv> 6630 6631<refsect1><title>Description</title> 6632 6633<para>This parameter specifies the value of the standalone 6634specification for generated pages. Not all processors support 6635specification of this parameter. 6636</para> 6637 6638<note> 6639<para>This parameter is documented here, but the declaration is actually 6640in the <filename>chunker.xsl</filename> stylesheet module.</para> 6641</note> 6642 6643</refsect1> 6644</refentry> 6645 6646<refentry id="saxon.character.representation"> 6647<refmeta> 6648<refentrytitle>saxon.character.representation</refentrytitle> 6649<refmiscinfo role="type">string</refmiscinfo> 6650</refmeta> 6651<refnamediv> 6652<refname>saxon.character.representation</refname> 6653<refpurpose>Saxon character representation used in generated HTML pages</refpurpose> 6654</refnamediv> 6655 6656<refsynopsisdiv><xsl:param name="saxon.character.representation" select="'entity;decimal'"/> 6657</refsynopsisdiv> 6658 6659<refsect1><title>Description</title> 6660 6661<para>This character representation is used in files generated by chunking stylesheet. If 6662you want to suppress entity references for characters with direct representation 6663in default.encoding, set this parameter to value <literal>native</literal>. 6664</para> 6665 6666<note> 6667<para>This parameter is documented here, but the declaration is actually 6668in the <filename>chunker.xsl</filename> stylesheet module.</para> 6669</note> 6670 6671</refsect1> 6672</refentry> 6673 6674<refentry id="html.ext"> 6675<refmeta> 6676<refentrytitle>html.ext</refentrytitle> 6677 6678</refmeta> 6679<refnamediv> 6680<refname>html.ext</refname> 6681<refpurpose>Identifies the extension of generated HTML files</refpurpose> 6682</refnamediv> 6683 6684<refsynopsisdiv> 6685<programlisting id="html.ext.frag"> 6686<xsl:param name="html.ext" select="'.html'"></xsl:param> 6687</programlisting> 6688</refsynopsisdiv> 6689 6690<refsect1><title>Description</title> 6691 6692<para>The extension identified by <parameter>html.ext</parameter> will 6693be used as the filename extension for chunks created by this stylesheet. 6694</para> 6695 6696</refsect1> 6697</refentry> 6698 6699<refentry id="use.id.as.filename"> 6700<refmeta> 6701<refentrytitle>use.id.as.filename</refentrytitle> 6702<refmiscinfo role="type">boolean</refmiscinfo> 6703</refmeta> 6704<refnamediv> 6705<refname>use.id.as.filename</refname> 6706<refpurpose>Use ID value of chunk elements as the filename?</refpurpose> 6707</refnamediv> 6708 6709<refsynopsisdiv> 6710<programlisting id="use.id.as.filename.frag"><xsl:param name="use.id.as.filename" select="'0'"></xsl:param></programlisting> 6711</refsynopsisdiv> 6712 6713<refsect1><title>Description</title> 6714 6715<para>If <parameter>use.id.as.filename</parameter> 6716is non-zero, the filename of chunk elements that have IDs will be 6717derived from the ID value. 6718</para> 6719 6720</refsect1> 6721</refentry> 6722 6723<refentry id="html.extra.head.links"> 6724<refmeta> 6725<refentrytitle>html.extra.head.links</refentrytitle> 6726<refmiscinfo role="type">boolean</refmiscinfo> 6727</refmeta> 6728<refnamediv> 6729<refname>html.extra.head.links</refname> 6730<refpurpose>Toggle extra HTML head link information</refpurpose> 6731</refnamediv> 6732 6733<refsynopsisdiv> 6734<programlisting id="html.extra.head.links.frag"> 6735<xsl:param name="html.extra.head.links" select="0"></xsl:param> 6736</programlisting> 6737</refsynopsisdiv> 6738 6739<refsect1><title>Description</title> 6740 6741<para>If non-zero, extra <sgmltag>link</sgmltag> elements will be 6742generated in the <sgmltag>head</sgmltag> of chunked HTML files. These 6743extra links point to chapters, appendixes, sections, etc. as supported 6744by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least). 6745</para> 6746 6747</refsect1> 6748</refentry> 6749 6750<refentry id="root.filename"> 6751<refmeta> 6752<refentrytitle>root.filename</refentrytitle> 6753 6754</refmeta> 6755<refnamediv> 6756<refname>root.filename</refname> 6757<refpurpose>Identifies the name of the root HTML file when chunking</refpurpose> 6758</refnamediv> 6759 6760<refsynopsisdiv> 6761<programlisting id="root.filename.frag"><xsl:param name="root.filename" select="'index'"></xsl:param></programlisting> 6762</refsynopsisdiv> 6763 6764<refsect1><title>Description</title> 6765 6766<para>The <parameter>root.filename</parameter> is the base filename for 6767the chunk created for the root of each document processed. 6768</para> 6769 6770</refsect1> 6771</refentry> 6772 6773<refentry id="base.dir"> 6774<refmeta> 6775<refentrytitle>base.dir</refentrytitle> 6776 6777</refmeta> 6778<refnamediv> 6779<refname>base.dir</refname> 6780<refpurpose>The base directory of chunks</refpurpose> 6781</refnamediv> 6782 6783<refsynopsisdiv> 6784<programlisting id="base.dir.frag"><xsl:param name="base.dir" select="''"></xsl:param></programlisting> 6785</refsynopsisdiv> 6786 6787<refsect1><title>Description</title> 6788 6789<para>If specified, the <literal>base.dir</literal> identifies 6790the output directory for chunks. (If not specified, the output directory 6791is system dependent.)</para> 6792 6793</refsect1> 6794</refentry> 6795 6796<refentry id="generate.manifest"> 6797 <refmeta> 6798 <refentrytitle>generate.manifest</refentrytitle> 6799 <refmiscinfo role="type">boolean</refmiscinfo> 6800 </refmeta> 6801 <refnamediv> 6802 <refname>generate.manifest</refname> 6803 <refpurpose>Generate a manifest file?</refpurpose> 6804 </refnamediv> 6805 6806 <refsynopsisdiv> 6807 <programlisting id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"></xsl:param></programlisting> 6808 </refsynopsisdiv> 6809 6810 <refsect1><title>Description</title> 6811 6812 <para>If non-zero, a list of HTML files generated by the 6813 stylesheet transformation is written to the file named by 6814 the <parameter>manifest</parameter> parameter.</para> 6815 6816 </refsect1> 6817</refentry> 6818 6819<refentry id="manifest"> 6820 <refmeta> 6821 <refentrytitle>manifest</refentrytitle> 6822 <refmiscinfo role="type">string</refmiscinfo> 6823 </refmeta> 6824 <refnamediv> 6825 <refname>manifest</refname> 6826 <refpurpose>Name of manifest file</refpurpose> 6827 </refnamediv> 6828 6829 <refsynopsisdiv> 6830 <programlisting id="manifest.frag"><xsl:param name="manifest" select="'HTML.manifest'"></xsl:param></programlisting> 6831 </refsynopsisdiv> 6832 6833 <refsect1><title>Description</title> 6834 6835 <para>The name of the file to which a manifest is written (if the 6836 value of the <parameter>generate.manifest</parameter> parameter 6837 is non-zero).</para> 6838 6839 </refsect1> 6840</refentry> 6841 6842<refentry id="manifest.in.base.dir"> 6843<refmeta> 6844<refentrytitle>manifest.in.base.dir</refentrytitle> 6845<refmiscinfo role="type">boolean</refmiscinfo> 6846</refmeta> 6847<refnamediv> 6848<refname>manifest.in.base.dir</refname> 6849<refpurpose>Should be manifest file written in $base.dir?</refpurpose> 6850</refnamediv> 6851 6852<refsynopsisdiv> 6853<programlisting id="manifest.in.base.dir.frag"> 6854<xsl:param name="manifest.in.base.dir" select="0"></xsl:param> 6855</programlisting> 6856</refsynopsisdiv> 6857 6858<refsect1><title>Description</title> 6859 6860<para>If non-zero manifest file and project files for HTML Help and 6861Eclipse Help are written into <parameter>base.dir</parameter> instead 6862of current directory.</para> 6863 6864</refsect1> 6865</refentry> 6866 6867 6868<refentry id="chunk.toc"> 6869<refmeta> 6870<refentrytitle>chunk.toc</refentrytitle> 6871<refmiscinfo role="type">string</refmiscinfo> 6872</refmeta> 6873<refnamediv> 6874<refname>chunk.toc</refname> 6875<refpurpose>An explicit TOC to be used for chunking</refpurpose> 6876</refnamediv> 6877 6878<refsynopsisdiv> 6879<programlisting id="chunk.toc.frag"> 6880<xsl:param name="chunk.toc" select="''"></xsl:param> 6881</programlisting> 6882</refsynopsisdiv> 6883 6884<refsect1><title>Description</title> 6885 6886<para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that 6887will be used for chunking. This parameter is only used by the 6888<filename>chunktoc.xsl</filename> stylesheet (and customization layers built 6889from it).</para> 6890 6891</refsect1> 6892</refentry> 6893 6894<refentry id="chunk.tocs.and.lots"> 6895<refmeta> 6896<refentrytitle>chunk.tocs.and.lots</refentrytitle> 6897<refmiscinfo role="type">boolean</refmiscinfo> 6898</refmeta> 6899<refnamediv> 6900<refname>chunk.tocs.and.lots</refname> 6901<refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose> 6902</refnamediv> 6903 6904<refsynopsisdiv> 6905<programlisting id="chunk.tocs.and.lots.frag"> 6906<xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param> 6907</programlisting> 6908</refsynopsisdiv> 6909 6910<refsect1><title>Description</title> 6911 6912<para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.) 6913will be put in a separate chunk. At the moment, this chunk is not in the 6914normal forward/backward navigation list. Instead, a new link is added to the 6915navigation footer.</para> 6916 6917<para>This feature is still somewhat experimental. Feedback welcome.</para> 6918 6919</refsect1> 6920</refentry> 6921 6922<refentry id="chunk.separate.lots"> 6923<refmeta> 6924<refentrytitle>chunk.separate.lots</refentrytitle> 6925<refmiscinfo role="type">boolean</refmiscinfo> 6926</refmeta> 6927<refnamediv> 6928<refname>chunk.separate.lots</refname> 6929<refpurpose>Should each LoT be in its own separate chunk?</refpurpose> 6930</refnamediv> 6931 6932<refsynopsisdiv> 6933<programlisting id="chunk.separate.lots.frag"> 6934<xsl:param name="chunk.separate.lots" select="0"></xsl:param> 6935</programlisting> 6936</refsynopsisdiv> 6937 6938<refsect1><title>Description</title> 6939 6940<para>If non-zero, each of the ToC and LoTs 6941(List of Examples, List of Figures, etc.) 6942will be put in its own separate chunk. 6943The title page includes generated links to each of the separate files. 6944</para> 6945<para> 6946This feature depends on the 6947<literal>chunk.tocs.and.lots</literal> 6948parameter also being non-zero. 6949</para> 6950 6951</refsect1> 6952</refentry> 6953 6954<refentry id="chunk.tocs.and.lots.has.title"> 6955<refmeta> 6956<refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle> 6957<refmiscinfo role="type">boolean</refmiscinfo> 6958</refmeta> 6959<refnamediv> 6960<refname>chunk.tocs.and.lots.has.title</refname> 6961<refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose> 6962</refnamediv> 6963 6964<refsynopsisdiv> 6965<programlisting id="chunk.tocs.and.lots.has.title.frag"> 6966<xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param> 6967</programlisting> 6968</refsynopsisdiv> 6969 6970<refsect1><title>Description</title> 6971 6972<para>If non-zero title of document is shown before ToC/LoT in 6973separate chunk.</para> 6974 6975</refsect1> 6976</refentry> 6977 6978<refentry id="chunk.section.depth"> 6979<refmeta> 6980<refentrytitle>chunk.section.depth</refentrytitle> 6981<refmiscinfo role="type">integer</refmiscinfo> 6982</refmeta> 6983<refnamediv> 6984<refname>chunk.section.depth</refname> 6985<refpurpose>Depth to which sections should be chunked</refpurpose> 6986</refnamediv> 6987 6988<refsynopsisdiv> 6989<programlisting id="chunk.section.depth.frag"> 6990<xsl:param name="chunk.section.depth" select="1"></xsl:param> 6991</programlisting> 6992</refsynopsisdiv> 6993 6994<refsect1><title>Description</title> 6995 6996<para>This parameter sets the depth of section chunking.</para> 6997 6998</refsect1> 6999</refentry> 7000 7001<refentry id="chunk.first.sections"> 7002<refmeta> 7003<refentrytitle>chunk.first.sections</refentrytitle> 7004 7005</refmeta> 7006<refnamediv> 7007<refname>chunk.first.sections</refname> 7008<refpurpose>Chunk the first top-level section?</refpurpose> 7009</refnamediv> 7010 7011<refsynopsisdiv> 7012<programlisting id="chunk.first.sections.frag"> 7013<xsl:param name="chunk.first.sections" select="0"></xsl:param> 7014</programlisting> 7015</refsynopsisdiv> 7016 7017<refsect1><title>Description</title> 7018 7019<para>If non-zero, a chunk will be created for the first top-level 7020<sgmltag>sect1</sgmltag> or <sgmltag>section</sgmltag> elements in 7021each component. Otherwise, that section will be part of the chunk for 7022its parent. 7023</para> 7024 7025</refsect1> 7026</refentry> 7027 7028<refentry id="chunk.quietly"> 7029<refmeta> 7030<refentrytitle>chunk.quietly</refentrytitle> 7031 7032</refmeta> 7033<refnamediv> 7034<refname>chunk.quietly</refname> 7035<refpurpose>Omit the chunked filename messages.</refpurpose> 7036</refnamediv> 7037 7038<refsynopsisdiv> 7039<programlisting id="chunk.quietly.frag"> 7040<xsl:param name="chunk.quietly" select="0"></xsl:param> 7041</programlisting> 7042</refsynopsisdiv> 7043 7044<refsect1><title>Description</title> 7045 7046<para>If zero (the default), the XSL processor emits a message naming 7047each separate chunk filename as it is being output. 7048If nonzero, then the messages are suppressed. 7049</para> 7050 7051</refsect1> 7052</refentry> 7053 7054<refentry id="navig.graphics"> 7055<refmeta> 7056<refentrytitle>navig.graphics</refentrytitle> 7057<refmiscinfo role="type">boolean</refmiscinfo> 7058</refmeta> 7059<refnamediv> 7060<refname>navig.graphics</refname> 7061<refpurpose>Use graphics in navigational headers and footers?</refpurpose> 7062</refnamediv> 7063 7064<refsynopsisdiv> 7065<programlisting id="navig.graphics.frag"><xsl:param name="navig.graphics" select="0"></xsl:param></programlisting> 7066</refsynopsisdiv> 7067 7068<refsect1><title>Description</title> 7069 7070<para>If true (non-zero), the navigational headers and footers in chunked 7071HTML are presented in an alternate style that uses 7072graphical icons for Next, Previous, Up, and Home. 7073Default graphics are provided in the distribution. 7074</para> 7075 7076</refsect1> 7077</refentry> 7078 7079<refentry id="navig.graphics.extension"> 7080<refmeta> 7081<refentrytitle>navig.graphics.extension</refentrytitle> 7082<refmiscinfo role="type">string</refmiscinfo> 7083</refmeta> 7084<refnamediv> 7085<refname>navig.graphics.extension</refname> 7086<refpurpose>Extension for navigational graphics</refpurpose> 7087</refnamediv> 7088 7089<refsynopsisdiv> 7090<programlisting id="navig.graphics.extension.frag"><xsl:param name="navig.graphics.extension" select="'.gif'"></xsl:param></programlisting> 7091</refsynopsisdiv> 7092 7093<refsect1><title>Description</title> 7094 7095<para>Sets the filename extension to use on navigational graphics used 7096in the headers and footers of chunked HTML.</para> 7097 7098</refsect1> 7099</refentry> 7100 7101<refentry id="navig.graphics.path"> 7102<refmeta> 7103<refentrytitle>navig.graphics.path</refentrytitle> 7104<refmiscinfo role="type">string</refmiscinfo> 7105</refmeta> 7106<refnamediv> 7107<refname>navig.graphics.path</refname> 7108<refpurpose>Path to navigational graphics</refpurpose> 7109</refnamediv> 7110 7111<refsynopsisdiv> 7112<programlisting id="navig.graphics.path.frag"><xsl:param name="navig.graphics.path">images/</xsl:param></programlisting> 7113</refsynopsisdiv> 7114 7115<refsect1><title>Description</title> 7116 7117<para>Sets the path, probably relative to the directory where the HTML 7118files are created, to the navigational graphics used in the 7119headers and footers of chunked HTML. 7120</para> 7121 7122</refsect1> 7123</refentry> 7124 7125<refentry id="navig.showtitles"> 7126<refmeta> 7127<refentrytitle>navig.showtitles</refentrytitle> 7128<refmiscinfo role="type">boolean</refmiscinfo> 7129</refmeta> 7130<refnamediv> 7131<refname>navig.showtitles</refname> 7132<refpurpose>Display titles in HTML headers and footers?</refpurpose> 7133</refnamediv> 7134 7135<refsynopsisdiv> 7136<programlisting id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></programlisting> 7137</refsynopsisdiv> 7138 7139<refsect1><title>Description</title> 7140 7141<para>If true (non-zero), 7142the headers and footers of chunked HTML 7143display the titles of the next and previous chunks, 7144along with the words 'Next' and 'Previous' (or the 7145equivalent graphical icons if navig.graphics is true). 7146If false (zero), then only the words 'Next' and 'Previous' 7147(or the icons) are displayed. 7148</para> 7149 7150</refsect1> 7151</refentry> 7152 7153</reference> 7154 7155<reference id="profiling"><title>Profiling</title> 7156<partintro> 7157<para>Following parameters can be used for attribute value based 7158profiling of your document. For more info about profiling look at 7159<ulink url="http://docbook.sourceforge.net/projects/xsl/doc/tools/profiling.html">http://docbook.sourceforge.net/projects/xsl/doc/tools/profiling.html</ulink>.</para> 7160</partintro> 7161<refentry id="profile.arch"> 7162<refmeta> 7163<refentrytitle>profile.arch</refentrytitle> 7164<refmiscinfo role="type">string</refmiscinfo> 7165</refmeta> 7166<refnamediv> 7167<refname>profile.arch</refname> 7168<refpurpose>Target profile for <sgmltag class="attribute">arch</sgmltag> 7169attribute</refpurpose> 7170</refnamediv> 7171 7172<refsynopsisdiv> 7173<programlisting id="profile.arch.frag"> 7174<xsl:param name="profile.arch" select="''"></xsl:param> 7175</programlisting> 7176</refsynopsisdiv> 7177 7178<refsect1><title>Description</title> 7179 7180<para>Value of this parameter specifies profiles which should be 7181included in the output. You can specify multiple profiles by 7182separating them by semicolon. You can change separator character by 7183<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7184parameter.</para> 7185 7186<para>This parameter has effect only when you are using profiling 7187stylesheets (<filename>profile-docbook.xsl</filename>, 7188<filename>profile-chunk.xsl</filename>, ���) instead of normal 7189ones (<filename>docbook.xsl</filename>, 7190<filename>chunk.xsl</filename>, ���).</para> 7191 7192</refsect1> 7193</refentry> 7194 7195<refentry id="profile.condition"> 7196<refmeta> 7197<refentrytitle>profile.condition</refentrytitle> 7198<refmiscinfo role="type">string</refmiscinfo> 7199</refmeta> 7200<refnamediv> 7201<refname>profile.condition</refname> 7202<refpurpose>Target profile for <sgmltag class="attribute">condition</sgmltag> 7203attribute</refpurpose> 7204</refnamediv> 7205 7206<refsynopsisdiv> 7207<programlisting id="profile.condition.frag"> 7208<xsl:param name="profile.condition" select="''"></xsl:param> 7209</programlisting> 7210</refsynopsisdiv> 7211 7212<refsect1><title>Description</title> 7213 7214<para>Value of this parameter specifies profiles which should be 7215included in the output. You can specify multiple profiles by 7216separating them by semicolon. You can change separator character by 7217<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7218parameter.</para> 7219 7220<para>This parameter has effect only when you are using profiling 7221stylesheets (<filename>profile-docbook.xsl</filename>, 7222<filename>profile-chunk.xsl</filename>, ���) instead of normal 7223ones (<filename>docbook.xsl</filename>, 7224<filename>chunk.xsl</filename>, ���).</para> 7225 7226</refsect1> 7227</refentry> 7228 7229<refentry id="profile.conformance"> 7230<refmeta> 7231<refentrytitle>profile.conformance</refentrytitle> 7232<refmiscinfo role="type">string</refmiscinfo> 7233</refmeta> 7234<refnamediv> 7235<refname>profile.conformance</refname> 7236<refpurpose>Target profile for <sgmltag class="attribute">conformance</sgmltag> 7237attribute</refpurpose> 7238</refnamediv> 7239 7240<refsynopsisdiv> 7241<programlisting id="profile.conformance.frag"> 7242<xsl:param name="profile.conformance" select="''"></xsl:param> 7243</programlisting> 7244</refsynopsisdiv> 7245 7246<refsect1><title>Description</title> 7247 7248<para>Value of this parameter specifies profiles which should be 7249included in the output. You can specify multiple profiles by 7250separating them by semicolon. You can change separator character by 7251<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7252parameter.</para> 7253 7254<para>This parameter has effect only when you are using profiling 7255stylesheets (<filename>profile-docbook.xsl</filename>, 7256<filename>profile-chunk.xsl</filename>, ���) instead of normal 7257ones (<filename>docbook.xsl</filename>, 7258<filename>chunk.xsl</filename>, ���).</para> 7259 7260</refsect1> 7261</refentry> 7262 7263<refentry id="profile.lang"> 7264<refmeta> 7265<refentrytitle>profile.lang</refentrytitle> 7266<refmiscinfo role="type">string</refmiscinfo> 7267</refmeta> 7268<refnamediv> 7269<refname>profile.lang</refname> 7270<refpurpose>Target profile for <sgmltag class="attribute">lang</sgmltag> 7271attribute</refpurpose> 7272</refnamediv> 7273 7274<refsynopsisdiv> 7275<programlisting id="profile.lang.frag"> 7276<xsl:param name="profile.lang" select="''"></xsl:param> 7277</programlisting> 7278</refsynopsisdiv> 7279 7280<refsect1><title>Description</title> 7281 7282<para>Value of this parameter specifies profiles which should be 7283included in the output. You can specify multiple profiles by 7284separating them by semicolon. You can change separator character by 7285<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7286parameter.</para> 7287 7288<para>This parameter has effect only when you are using profiling 7289stylesheets (<filename>profile-docbook.xsl</filename>, 7290<filename>profile-chunk.xsl</filename>, ���) instead of normal 7291ones (<filename>docbook.xsl</filename>, 7292<filename>chunk.xsl</filename>, ���).</para> 7293 7294</refsect1> 7295</refentry> 7296 7297<refentry id="profile.os"> 7298<refmeta> 7299<refentrytitle>profile.os</refentrytitle> 7300<refmiscinfo role="type">string</refmiscinfo> 7301</refmeta> 7302<refnamediv> 7303<refname>profile.os</refname> 7304<refpurpose>Target profile for <sgmltag class="attribute">os</sgmltag> 7305attribute</refpurpose> 7306</refnamediv> 7307 7308<refsynopsisdiv> 7309<programlisting id="profile.os.frag"> 7310<xsl:param name="profile.os" select="''"></xsl:param> 7311</programlisting> 7312</refsynopsisdiv> 7313 7314<refsect1><title>Description</title> 7315 7316<para>Value of this parameter specifies profiles which should be 7317included in the output. You can specify multiple profiles by 7318separating them by semicolon. You can change separator character by 7319<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7320parameter.</para> 7321 7322<para>This parameter has effect only when you are using profiling 7323stylesheets (<filename>profile-docbook.xsl</filename>, 7324<filename>profile-chunk.xsl</filename>, ���) instead of normal 7325ones (<filename>docbook.xsl</filename>, 7326<filename>chunk.xsl</filename>, ���).</para> 7327 7328</refsect1> 7329</refentry> 7330 7331<refentry id="profile.revision"> 7332<refmeta> 7333<refentrytitle>profile.revision</refentrytitle> 7334<refmiscinfo role="type">string</refmiscinfo> 7335</refmeta> 7336<refnamediv> 7337<refname>profile.revision</refname> 7338<refpurpose>Target profile for <sgmltag class="attribute">revision</sgmltag> 7339attribute</refpurpose> 7340</refnamediv> 7341 7342<refsynopsisdiv> 7343<programlisting id="profile.revision.frag"> 7344<xsl:param name="profile.revision" select="''"></xsl:param> 7345</programlisting> 7346</refsynopsisdiv> 7347 7348<refsect1><title>Description</title> 7349 7350<para>Value of this parameter specifies profiles which should be 7351included in the output. You can specify multiple profiles by 7352separating them by semicolon. You can change separator character by 7353<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7354parameter.</para> 7355 7356<para>This parameter has effect only when you are using profiling 7357stylesheets (<filename>profile-docbook.xsl</filename>, 7358<filename>profile-chunk.xsl</filename>, ���) instead of normal 7359ones (<filename>docbook.xsl</filename>, 7360<filename>chunk.xsl</filename>, ���).</para> 7361 7362</refsect1> 7363</refentry> 7364 7365<refentry id="profile.revisionflag"> 7366<refmeta> 7367<refentrytitle>profile.revisionflag</refentrytitle> 7368<refmiscinfo role="type">string</refmiscinfo> 7369</refmeta> 7370<refnamediv> 7371<refname>profile.revisionflag</refname> 7372<refpurpose>Target profile for <sgmltag class="attribute">revisionflag</sgmltag> 7373attribute</refpurpose> 7374</refnamediv> 7375 7376<refsynopsisdiv> 7377<programlisting id="profile.revisionflag.frag"> 7378<xsl:param name="profile.revisionflag" select="''"></xsl:param> 7379</programlisting> 7380</refsynopsisdiv> 7381 7382<refsect1><title>Description</title> 7383 7384<para>Value of this parameter specifies profiles which should be 7385included in the output. You can specify multiple profiles by 7386separating them by semicolon. You can change separator character by 7387<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7388parameter.</para> 7389 7390<para>This parameter has effect only when you are using profiling 7391stylesheets (<filename>profile-docbook.xsl</filename>, 7392<filename>profile-chunk.xsl</filename>, ���) instead of normal 7393ones (<filename>docbook.xsl</filename>, 7394<filename>chunk.xsl</filename>, ���).</para> 7395 7396</refsect1> 7397</refentry> 7398 7399<refentry id="profile.role"> 7400<refmeta> 7401<refentrytitle>profile.role</refentrytitle> 7402<refmiscinfo role="type">string</refmiscinfo> 7403</refmeta> 7404<refnamediv> 7405<refname>profile.role</refname> 7406<refpurpose>Target profile for <sgmltag class="attribute">role</sgmltag> 7407attribute</refpurpose> 7408</refnamediv> 7409 7410<refsynopsisdiv> 7411<programlisting id="profile.role.frag"> 7412<xsl:param name="profile.role" select="''"></xsl:param> 7413</programlisting> 7414</refsynopsisdiv> 7415 7416<refsect1><title>Description</title> 7417 7418<para>Value of this parameter specifies profiles which should be 7419included in the output. You can specify multiple profiles by 7420separating them by semicolon. You can change separator character by 7421<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7422parameter.</para> 7423 7424<para>This parameter has effect only when you are using profiling 7425stylesheets (<filename>profile-docbook.xsl</filename>, 7426<filename>profile-chunk.xsl</filename>, ���) instead of normal 7427ones (<filename>docbook.xsl</filename>, 7428<filename>chunk.xsl</filename>, ���).</para> 7429 7430<warning> 7431<para>Note that <sgmltag class="attribute">role</sgmltag> is often 7432used for other purposes than profiling. For example it is commonly 7433used to get emphasize in bold font:</para> 7434 7435<programlisting><emphasis role="bold">very important</emphasis></programlisting> 7436 7437<para>If you are using <sgmltag class="attribute">role</sgmltag> for 7438these purposes do not forget to add values like <literal>bold</literal> to 7439value of this parameter. If you forgot you will get document with 7440small pieces missing which are very hard to track.</para> 7441 7442<para>For this reason it is not recommended to use <sgmltag class="attribute">role</sgmltag> attribute for profiling. You should 7443rather use profiling specific attributes like <sgmltag class="attribute">userlevel</sgmltag>, <sgmltag class="attribute">os</sgmltag>, <sgmltag class="attribute">arch</sgmltag>, <sgmltag class="attribute">condition</sgmltag>, etc.</para> 7444</warning> 7445 7446</refsect1> 7447</refentry> 7448 7449<refentry id="profile.security"> 7450<refmeta> 7451<refentrytitle>profile.security</refentrytitle> 7452<refmiscinfo role="type">string</refmiscinfo> 7453</refmeta> 7454<refnamediv> 7455<refname>profile.security</refname> 7456<refpurpose>Target profile for <sgmltag class="attribute">security</sgmltag> 7457attribute</refpurpose> 7458</refnamediv> 7459 7460<refsynopsisdiv> 7461<programlisting id="profile.security.frag"> 7462<xsl:param name="profile.security" select="''"></xsl:param> 7463</programlisting> 7464</refsynopsisdiv> 7465 7466<refsect1><title>Description</title> 7467 7468<para>Value of this parameter specifies profiles which should be 7469included in the output. You can specify multiple profiles by 7470separating them by semicolon. You can change separator character by 7471<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7472parameter.</para> 7473 7474<para>This parameter has effect only when you are using profiling 7475stylesheets (<filename>profile-docbook.xsl</filename>, 7476<filename>profile-chunk.xsl</filename>, ���) instead of normal 7477ones (<filename>docbook.xsl</filename>, 7478<filename>chunk.xsl</filename>, ���).</para> 7479 7480</refsect1> 7481</refentry> 7482 7483<refentry id="profile.userlevel"> 7484<refmeta> 7485<refentrytitle>profile.userlevel</refentrytitle> 7486<refmiscinfo role="type">string</refmiscinfo> 7487</refmeta> 7488<refnamediv> 7489<refname>profile.userlevel</refname> 7490<refpurpose>Target profile for <sgmltag class="attribute">userlevel</sgmltag> 7491attribute</refpurpose> 7492</refnamediv> 7493 7494<refsynopsisdiv> 7495<programlisting id="profile.userlevel.frag"> 7496<xsl:param name="profile.userlevel" select="''"></xsl:param> 7497</programlisting> 7498</refsynopsisdiv> 7499 7500<refsect1><title>Description</title> 7501 7502<para>Value of this parameter specifies profiles which should be 7503included in the output. You can specify multiple profiles by 7504separating them by semicolon. You can change separator character by 7505<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7506parameter.</para> 7507 7508<para>This parameter has effect only when you are using profiling 7509stylesheets (<filename>profile-docbook.xsl</filename>, 7510<filename>profile-chunk.xsl</filename>, ���) instead of normal 7511ones (<filename>docbook.xsl</filename>, 7512<filename>chunk.xsl</filename>, ���).</para> 7513 7514</refsect1> 7515</refentry> 7516 7517<refentry id="profile.vendor"> 7518<refmeta> 7519<refentrytitle>profile.vendor</refentrytitle> 7520<refmiscinfo role="type">string</refmiscinfo> 7521</refmeta> 7522<refnamediv> 7523<refname>profile.vendor</refname> 7524<refpurpose>Target profile for <sgmltag class="attribute">vendor</sgmltag> 7525attribute</refpurpose> 7526</refnamediv> 7527 7528<refsynopsisdiv> 7529<programlisting id="profile.vendor.frag"> 7530<xsl:param name="profile.vendor" select="''"></xsl:param> 7531</programlisting> 7532</refsynopsisdiv> 7533 7534<refsect1><title>Description</title> 7535 7536<para>Value of this parameter specifies profiles which should be 7537included in the output. You can specify multiple profiles by 7538separating them by semicolon. You can change separator character by 7539<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7540parameter.</para> 7541 7542<para>This parameter has effect only when you are using profiling 7543stylesheets (<filename>profile-docbook.xsl</filename>, 7544<filename>profile-chunk.xsl</filename>, ���) instead of normal 7545ones (<filename>docbook.xsl</filename>, 7546<filename>chunk.xsl</filename>, ���).</para> 7547 7548</refsect1> 7549</refentry> 7550 7551<refentry id="profile.attribute"> 7552<refmeta> 7553<refentrytitle>profile.attribute</refentrytitle> 7554<refmiscinfo role="type">string</refmiscinfo> 7555</refmeta> 7556<refnamediv> 7557<refname>profile.attribute</refname> 7558<refpurpose>Name of user-specified profiling attribute</refpurpose> 7559</refnamediv> 7560 7561<refsynopsisdiv> 7562<programlisting id="profile.attribute.frag"> 7563<xsl:param name="profile.attribute" select="''"></xsl:param> 7564</programlisting> 7565</refsynopsisdiv> 7566 7567<refsect1><title>Description</title> 7568 7569<para>This parameter is used in conjuction with <link linkend="profile.value"><parameter>profile.value</parameter></link>.</para> 7570 7571<para>This parameter has effect only when you are using profiling 7572stylesheets (<filename>profile-docbook.xsl</filename>, 7573<filename>profile-chunk.xsl</filename>, ���) instead of normal 7574ones (<filename>docbook.xsl</filename>, 7575<filename>chunk.xsl</filename>, ���).</para> 7576 7577</refsect1> 7578</refentry> 7579 7580<refentry id="profile.value"> 7581<refmeta> 7582<refentrytitle>profile.value</refentrytitle> 7583<refmiscinfo role="type">string</refmiscinfo> 7584</refmeta> 7585<refnamediv> 7586<refname>profile.value</refname> 7587<refpurpose>Target profile for user-specified attribute</refpurpose> 7588</refnamediv> 7589 7590<refsynopsisdiv> 7591<programlisting id="profile.value.frag"> 7592<xsl:param name="profile.value" select="''"></xsl:param> 7593</programlisting> 7594</refsynopsisdiv> 7595 7596<refsect1><title>Description</title> 7597 7598<para>When you are using this parameter you must also specify name of 7599profiling attribute with parameter <link linkend="profile.attribute"><parameter>profile.attribute</parameter></link>.</para> 7600 7601<para>Value of this parameter specifies profiles which should be 7602included in the output. You can specify multiple profiles by 7603separating them by semicolon. You can change separator character by 7604<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 7605parameter.</para> 7606 7607<para>This parameter has effect only when you are using profiling 7608stylesheets (<filename>profile-docbook.xsl</filename>, 7609<filename>profile-chunk.xsl</filename>, ���) instead of normal 7610ones (<filename>docbook.xsl</filename>, 7611<filename>chunk.xsl</filename>, ���).</para> 7612 7613</refsect1> 7614</refentry> 7615 7616<refentry id="profile.separator"> 7617<refmeta> 7618<refentrytitle>profile.separator</refentrytitle> 7619<refmiscinfo role="type">string</refmiscinfo> 7620</refmeta> 7621<refnamediv> 7622<refname>profile.separator</refname> 7623<refpurpose>Separator character for compound profile values</refpurpose> 7624</refnamediv> 7625 7626<refsynopsisdiv> 7627<programlisting id="profile.separator.frag"> 7628<xsl:param name="profile.separator" select="';'"></xsl:param> 7629</programlisting> 7630</refsynopsisdiv> 7631 7632<refsect1><title>Description</title> 7633 7634<para>Separator character for compound profile values.</para> 7635 7636</refsect1> 7637</refentry> 7638 7639</reference> 7640 7641<reference id="htmlhelp"><title>HTML Help</title> 7642<refentry id="htmlhelp.encoding"> 7643<refmeta> 7644<refentrytitle>htmlhelp.encoding</refentrytitle> 7645<refmiscinfo role="type">string</refmiscinfo> 7646</refmeta> 7647<refnamediv> 7648<refname>htmlhelp.encoding</refname> 7649<refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose> 7650</refnamediv> 7651 7652<refsynopsisdiv> 7653<programlisting id="htmlhelp.encoding.frag"> 7654<xsl:param name="htmlhelp.encoding" select="'iso-8859-1'"></xsl:param> 7655</programlisting> 7656</refsynopsisdiv> 7657 7658<refsect1><title>Description</title> 7659 7660<para>HTML Help Compiler is not UTF-8 aware, so you should always use 7661apropriate single-byte encoding here.</para> 7662 7663</refsect1> 7664</refentry> 7665 7666<refentry id="htmlhelp.autolabel"> 7667<refmeta> 7668<refentrytitle>htmlhelp.autolabel</refentrytitle> 7669<refmiscinfo role="type">boolean</refmiscinfo> 7670</refmeta> 7671<refnamediv> 7672<refname>htmlhelp.autolabel</refname> 7673<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> 7674</refnamediv> 7675 7676<refsynopsisdiv> 7677<programlisting id="htmlhelp.autolabel.frag"> 7678<xsl:param name="htmlhelp.autolabel" select="0"></xsl:param> 7679</programlisting> 7680</refsynopsisdiv> 7681 7682<refsect1><title>Description</title> 7683 7684<para>If you want to include chapter and section numbers into ToC in 7685the left panel, set this parameter to 1.</para> 7686 7687</refsect1> 7688</refentry> 7689 7690<refentry id="htmlhelp.chm"> 7691<refmeta> 7692<refentrytitle>htmlhelp.chm</refentrytitle> 7693<refmiscinfo role="type">string</refmiscinfo> 7694</refmeta> 7695<refnamediv> 7696<refname>htmlhelp.chm</refname> 7697<refpurpose>Filename of output HTML Help file.</refpurpose> 7698</refnamediv> 7699 7700<refsynopsisdiv> 7701<programlisting id="htmlhelp.chm.frag"> 7702<xsl:param name="htmlhelp.chm" select="'htmlhelp.chm'"></xsl:param> 7703</programlisting> 7704</refsynopsisdiv> 7705 7706<refsect1><title>Description</title> 7707 7708<para>Change this parameter if you want different name of result 7709CHM file than htmlhelp.chm.</para> 7710 7711</refsect1> 7712</refentry> 7713 7714<refentry id="htmlhelp.default.topic"> 7715<refmeta> 7716<refentrytitle>htmlhelp.default.topic</refentrytitle> 7717<refmiscinfo role="type">string</refmiscinfo> 7718</refmeta> 7719<refnamediv> 7720<refname>htmlhelp.default.topic</refname> 7721<refpurpose>Name of file with default topic</refpurpose> 7722</refnamediv> 7723 7724<refsynopsisdiv> 7725<programlisting id="htmlhelp.default.topic.frag"> 7726<xsl:param name="htmlhelp.default.topic" select="''"></xsl:param> 7727</programlisting> 7728</refsynopsisdiv> 7729 7730<refsect1><title>Description</title> 7731 7732<para>Normally first chunk of document is displayed when you open HTML 7733Help file. If you want to display another topic, simply set its 7734filename by this parameter.</para> 7735 7736<para>This is useful especially if you don't generate ToC in front of 7737your document and you also hide root element in ToC. E.g.:</para> 7738 7739<programlisting><xsl:param name="generate.book.toc" select="0"/> 7740<xsl:param name="htmlhelp.hhc.show.root" select="0"/> 7741<xsl:param name="htmlhelp.default.topic" select="'pr01.html'"/></programlisting> 7742 7743</refsect1> 7744</refentry> 7745 7746<refentry id="htmlhelp.display.progress"> 7747<refmeta> 7748<refentrytitle>htmlhelp.display.progress</refentrytitle> 7749<refmiscinfo role="type">boolean</refmiscinfo> 7750</refmeta> 7751<refnamediv> 7752<refname>htmlhelp.display.progress</refname> 7753<refpurpose>Display compile progress?</refpurpose> 7754</refnamediv> 7755 7756<refsynopsisdiv> 7757<programlisting id="htmlhelp.display.progress.frag"> 7758<xsl:param name="htmlhelp.display.progress" select="1"></xsl:param> 7759</programlisting> 7760</refsynopsisdiv> 7761 7762<refsect1><title>Description</title> 7763 7764<para>You can swith off display of compile progress by setting this 7765parameter to 0.</para> 7766 7767</refsect1> 7768</refentry> 7769 7770 7771<refentry id="htmlhelp.hhp"> 7772<refmeta> 7773<refentrytitle>htmlhelp.hhp</refentrytitle> 7774<refmiscinfo role="type">string</refmiscinfo> 7775</refmeta> 7776<refnamediv> 7777<refname>htmlhelp.hhp</refname> 7778<refpurpose>Filename of project file.</refpurpose> 7779</refnamediv> 7780 7781<refsynopsisdiv> 7782<programlisting id="htmlhelp.hhp.frag"> 7783<xsl:param name="htmlhelp.hhp" select="'htmlhelp.hhp'"></xsl:param> 7784</programlisting> 7785</refsynopsisdiv> 7786 7787<refsect1><title>Description</title> 7788 7789<para>Change this parameter if you want different name of project 7790file than htmlhelp.hhp.</para> 7791 7792</refsect1> 7793</refentry> 7794 7795<refentry id="htmlhelp.hhc"> 7796<refmeta> 7797<refentrytitle>htmlhelp.hhc</refentrytitle> 7798<refmiscinfo role="type">string</refmiscinfo> 7799</refmeta> 7800<refnamediv> 7801<refname>htmlhelp.hhc</refname> 7802<refpurpose>Filename of TOC file.</refpurpose> 7803</refnamediv> 7804 7805<refsynopsisdiv> 7806<programlisting id="htmlhelp.hhc.frag"> 7807<xsl:param name="htmlhelp.hhc" select="'toc.hhc'"></xsl:param> 7808</programlisting> 7809</refsynopsisdiv> 7810 7811<refsect1><title>Description</title> 7812 7813<para>Change this parameter if you want different name of TOC file 7814than toc.hhc.</para> 7815 7816</refsect1> 7817</refentry> 7818 7819<refentry id="htmlhelp.hhk"> 7820<refmeta> 7821<refentrytitle>htmlhelp.hhk</refentrytitle> 7822<refmiscinfo role="type">string</refmiscinfo> 7823</refmeta> 7824<refnamediv> 7825<refname>htmlhelp.hhk</refname> 7826<refpurpose>Filename of index file.</refpurpose> 7827</refnamediv> 7828 7829<refsynopsisdiv> 7830<programlisting id="htmlhelp.hhk.frag"> 7831<xsl:param name="htmlhelp.hhk" select="'index.hhk'"></xsl:param> 7832</programlisting> 7833</refsynopsisdiv> 7834 7835<refsect1><title>Description</title> 7836 7837<para>Change this parameter if you want different name of index file 7838than index.hhk.</para> 7839 7840</refsect1> 7841</refentry> 7842 7843<refentry id="htmlhelp.hhp.tail"> 7844<refmeta> 7845<refentrytitle>htmlhelp.hhp.tail</refentrytitle> 7846<refmiscinfo role="type">string</refmiscinfo> 7847</refmeta> 7848<refnamediv> 7849<refname>htmlhelp.hhp.tail</refname> 7850<refpurpose>Additional content for project file.</refpurpose> 7851</refnamediv> 7852 7853<refsynopsisdiv> 7854<programlisting id="htmlhelp.hhp.tail.frag"> 7855<xsl:param name="htmlhelp.hhp.tail"></xsl:param> 7856</programlisting> 7857</refsynopsisdiv> 7858 7859<refsect1><title>Description</title> 7860 7861<para>If you want to include some additional parameters into project file, 7862store appropriate part of project file into this parameter.</para> 7863 7864</refsect1> 7865</refentry> 7866 7867<refentry id="htmlhelp.hhp.window"> 7868<refmeta> 7869<refentrytitle>htmlhelp.hhp.window</refentrytitle> 7870<refmiscinfo role="type">string</refmiscinfo> 7871</refmeta> 7872<refnamediv> 7873<refname>htmlhelp.hhp.window</refname> 7874<refpurpose>Name of default window.</refpurpose> 7875</refnamediv> 7876 7877<refsynopsisdiv> 7878<programlisting id="htmlhelp.hhp.window.frag"> 7879<xsl:param name="htmlhelp.hhp.window" select="'Main'"></xsl:param> 7880</programlisting> 7881</refsynopsisdiv> 7882 7883<refsect1><title>Description</title> 7884 7885<para>Name of default window. If empty no [WINDOWS] section will be 7886added to project file.</para> 7887 7888</refsect1> 7889</refentry> 7890 7891<refentry id="htmlhelp.hhp.windows"> 7892<refmeta> 7893<refentrytitle>htmlhelp.hhp.windows</refentrytitle> 7894<refmiscinfo role="type">string</refmiscinfo> 7895</refmeta> 7896<refnamediv> 7897<refname>htmlhelp.hhp.windows</refname> 7898<refpurpose>Definition of additional windows</refpurpose> 7899</refnamediv> 7900 7901<refsynopsisdiv> 7902<programlisting id="htmlhelp.hhp.windows.frag"> 7903<xsl:param name="htmlhelp.hhp.windows"></xsl:param> 7904</programlisting> 7905</refsynopsisdiv> 7906 7907<refsect1><title>Description</title> 7908 7909<para>Content of this parameter is placed at the end of [WINDOWS] 7910section of project file. You can use it for defining your own 7911addtional windows.</para> 7912 7913</refsect1> 7914</refentry> 7915 7916 7917<refentry id="htmlhelp.enhanced.decompilation"> 7918<refmeta> 7919<refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle> 7920<refmiscinfo role="type">boolean</refmiscinfo> 7921</refmeta> 7922<refnamediv> 7923<refname>htmlhelp.enhanced.decompilation</refname> 7924<refpurpose>Allow enhanced decompilation of CHM?</refpurpose> 7925</refnamediv> 7926 7927<refsynopsisdiv> 7928<programlisting id="htmlhelp.enhanced.decompilation.frag"> 7929<xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:param> 7930</programlisting> 7931</refsynopsisdiv> 7932 7933<refsect1><title>Description</title> 7934 7935<para>When set to 1 this parameter enables enhanced decompilation of CHM.</para> 7936 7937</refsect1> 7938</refentry> 7939 7940 7941<refentry id="htmlhelp.enumerate.images"> 7942<refmeta> 7943<refentrytitle>htmlhelp.enumerate.images</refentrytitle> 7944<refmiscinfo role="type">boolean</refmiscinfo> 7945</refmeta> 7946<refnamediv> 7947<refname>htmlhelp.enumerate.images</refname> 7948<refpurpose>Should be paths to all used images added to project file?</refpurpose> 7949</refnamediv> 7950 7951<refsynopsisdiv> 7952<programlisting id="htmlhelp.enumerate.images.frag"> 7953<xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param> 7954</programlisting> 7955</refsynopsisdiv> 7956 7957<refsect1><title>Description</title> 7958 7959<para>You should turn on this flag, if you insert images into your documents 7960as external binary entities or if you are using absolute path in image names.</para> 7961 7962</refsect1> 7963</refentry> 7964 7965<refentry id="htmlhelp.force.map.and.alias"> 7966<refmeta> 7967<refentrytitle>htmlhelp.force.map.and.alias</refentrytitle> 7968<refmiscinfo role="type">boolean</refmiscinfo> 7969</refmeta> 7970<refnamediv> 7971<refname>htmlhelp.force.map.and.alias</refname> 7972<refpurpose>Should be [MAP] and [ALIAS] section added to project file unconditionaly?</refpurpose> 7973</refnamediv> 7974 7975<refsynopsisdiv> 7976<programlisting id="htmlhelp.force.map.and.alias.frag"> 7977<xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param> 7978</programlisting> 7979</refsynopsisdiv> 7980 7981<refsect1><title>Description</title> 7982 7983<para>You should turn on this flag, if you have your own 7984<filename>alias.h</filename> and <filename>contex.h</filename> files 7985and you want include reference to them in project file.</para> 7986 7987</refsect1> 7988</refentry> 7989 7990<refentry id="htmlhelp.map.file"> 7991<refmeta> 7992<refentrytitle>htmlhelp.map.file</refentrytitle> 7993<refmiscinfo role="type">string</refmiscinfo> 7994</refmeta> 7995<refnamediv> 7996<refname>htmlhelp.map.file</refname> 7997<refpurpose>Filename of map file.</refpurpose> 7998</refnamediv> 7999 8000<refsynopsisdiv> 8001<programlisting id="htmlhelp.map.file.frag"> 8002<xsl:param name="htmlhelp.map.file" select="'context.h'"></xsl:param> 8003</programlisting> 8004</refsynopsisdiv> 8005 8006<refsect1><title>Description</title> 8007 8008<para>Change this parameter if you want different name of map file 8009than <filename>context.h</filename>.</para> 8010 8011</refsect1> 8012</refentry> 8013 8014<refentry id="htmlhelp.alias.file"> 8015<refmeta> 8016<refentrytitle>htmlhelp.alias.file</refentrytitle> 8017<refmiscinfo role="type">string</refmiscinfo> 8018</refmeta> 8019<refnamediv> 8020<refname>htmlhelp.alias.file</refname> 8021<refpurpose>Filename of map file.</refpurpose> 8022</refnamediv> 8023 8024<refsynopsisdiv> 8025<programlisting id="htmlhelp.alias.file.frag"> 8026<xsl:param name="htmlhelp.alias.file" select="'alias.h'"></xsl:param> 8027</programlisting> 8028</refsynopsisdiv> 8029 8030<refsect1><title>Description</title> 8031 8032<para>Change this parameter if you want different name of map file 8033than <filename>alias.h</filename>.</para> 8034 8035</refsect1> 8036</refentry> 8037 8038<refentry id="htmlhelp.hhc.section.depth"> 8039<refmeta> 8040<refentrytitle>htmlhelp.hhc.section.depth</refentrytitle> 8041<refmiscinfo role="type">integer</refmiscinfo> 8042</refmeta> 8043<refnamediv> 8044<refname>htmlhelp.hhc.section.depth</refname> 8045<refpurpose>Depth of TOC for sections in a left pane.</refpurpose> 8046</refnamediv> 8047 8048<refsynopsisdiv> 8049<programlisting id="htmlhelp.hhc.section.depth.frag"> 8050<xsl:param name="htmlhelp.hhc.section.depth" select="5"></xsl:param> 8051</programlisting> 8052</refsynopsisdiv> 8053 8054<refsect1><title>Description</title> 8055 8056<para>Change this parameter if you want shallower ToC in a left pane 8057of HTML Help viewer.</para> 8058 8059</refsect1> 8060</refentry> 8061 8062<refentry id="htmlhelp.hhc.show.root"> 8063<refmeta> 8064<refentrytitle>htmlhelp.hhc.show.root</refentrytitle> 8065<refmiscinfo role="type">boolean</refmiscinfo> 8066</refmeta> 8067<refnamediv> 8068<refname>htmlhelp.hhc.show.root</refname> 8069<refpurpose>Should be entry for root element shown in ToC?</refpurpose> 8070</refnamediv> 8071 8072<refsynopsisdiv> 8073<programlisting id="htmlhelp.hhc.show.root.frag"> 8074<xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param> 8075</programlisting> 8076</refsynopsisdiv> 8077 8078<refsect1><title>Description</title> 8079 8080<para>If set to 0, there will be no entry for root element in 8081ToC. This is useful when you want provide user with expanded ToC as 8082a default.</para> 8083 8084</refsect1> 8085</refentry> 8086 8087<refentry id="htmlhelp.hhc.folders.instead.books"> 8088<refmeta> 8089<refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle> 8090<refmiscinfo role="type"/> 8091</refmeta> 8092<refnamediv> 8093<refname>htmlhelp.hhc.folders.instead.books</refname> 8094<refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose> 8095</refnamediv> 8096 8097<refsynopsisdiv> 8098<programlisting id="htmlhelp.hhc.folders.instead.books.frag"> 8099<xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:param> 8100</programlisting> 8101</refsynopsisdiv> 8102 8103<refsect1><title>Description</title> 8104 8105<para>This parameter controls whether there should be folder-like 8106icons (1) or book-like icons (0) in ToC. If you want to use 8107folder-like icons you must swith off binary ToC using 8108<parameter>htmlhelp.hhc.binary</parameter>.</para> 8109 8110</refsect1> 8111</refentry> 8112 8113<refentry id="htmlhelp.hhc.binary"> 8114<refmeta> 8115<refentrytitle>htmlhelp.hhc.binary</refentrytitle> 8116<refmiscinfo role="type"/> 8117</refmeta> 8118<refnamediv> 8119<refname>htmlhelp.hhc.binary</refname> 8120<refpurpose>Generate binary ToC?</refpurpose> 8121</refnamediv> 8122 8123<refsynopsisdiv> 8124<programlisting id="htmlhelp.hhc.binary.frag"> 8125<xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param> 8126</programlisting> 8127</refsynopsisdiv> 8128 8129<refsect1><title>Description</title> 8130 8131<para>This parametr controls whether binary TOC will be generated. You 8132must create binary TOC if you want to add Prev/Next buttons to toolbar 8133(which is default behaviour). Files with binary TOC can't be merged.</para> 8134 8135</refsect1> 8136</refentry> 8137 8138<refentry id="htmlhelp.hhc.width"> 8139<refmeta> 8140<refentrytitle>htmlhelp.hhc.width</refentrytitle> 8141<refmiscinfo role="type">integer</refmiscinfo> 8142</refmeta> 8143<refnamediv> 8144<refname>htmlhelp.hhc.width</refname> 8145<refpurpose>Width of navigation (ToC) pane</refpurpose> 8146</refnamediv> 8147 8148<refsynopsisdiv> 8149<programlisting id="htmlhelp.hhc.width.frag"> 8150<xsl:param name="htmlhelp.hhc.width"></xsl:param> 8151</programlisting> 8152</refsynopsisdiv> 8153 8154<refsect1><title>Description</title> 8155 8156<para>This parameter specifies width of ToC pane in pixels.</para> 8157 8158</refsect1> 8159</refentry> 8160 8161 8162<refentry id="htmlhelp.title"> 8163<refmeta> 8164<refentrytitle>htmlhelp.title</refentrytitle> 8165<refmiscinfo role="type">string</refmiscinfo> 8166</refmeta> 8167<refnamediv> 8168<refname>htmlhelp.title</refname> 8169<refpurpose>Title of HTML Help</refpurpose> 8170</refnamediv> 8171 8172<refsynopsisdiv> 8173<programlisting id="htmlhelp.title.frag"> 8174<xsl:param name="htmlhelp.title" select="''"></xsl:param> 8175</programlisting> 8176</refsynopsisdiv> 8177 8178<refsect1><title>Description</title> 8179 8180<para>Content of this parameter will be used as a title for generated 8181HTML Help. If empty, title will be automatically taken from document.</para> 8182 8183</refsect1> 8184</refentry> 8185 8186<refentry id="htmlhelp.show.menu"> 8187<refmeta> 8188<refentrytitle>htmlhelp.show.menu</refentrytitle> 8189<refmiscinfo role="type">boolean</refmiscinfo> 8190</refmeta> 8191<refnamediv> 8192<refname>htmlhelp.show.menu</refname> 8193<refpurpose>Should be menu shown?</refpurpose> 8194</refnamediv> 8195 8196<refsynopsisdiv> 8197<programlisting id="htmlhelp.show.menu.frag"> 8198<xsl:param name="htmlhelp.show.menu" select="0"></xsl:param> 8199</programlisting> 8200</refsynopsisdiv> 8201 8202<refsect1><title>Description</title> 8203 8204<para>If you want application menu in your HTML Help file, turn this 8205parameter to 1.</para> 8206 8207</refsect1> 8208</refentry> 8209 8210<refentry id="htmlhelp.show.toolbar.text"> 8211<refmeta> 8212<refentrytitle>htmlhelp.show.toolbar.text</refentrytitle> 8213<refmiscinfo role="type">boolean</refmiscinfo> 8214</refmeta> 8215<refnamediv> 8216<refname>htmlhelp.show.toolbar.text</refname> 8217<refpurpose>Show text under toolbar buttons?</refpurpose> 8218</refnamediv> 8219 8220<refsynopsisdiv> 8221<programlisting id="htmlhelp.show.toolbar.text.frag"> 8222<xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param> 8223</programlisting> 8224</refsynopsisdiv> 8225 8226<refsect1><title>Description</title> 8227 8228<para>You can switch off display of texts under toolbar buttons by 8229setting this parameter to 0.</para> 8230 8231</refsect1> 8232</refentry> 8233 8234 8235<refentry id="htmlhelp.show.advanced.search"> 8236<refmeta> 8237<refentrytitle>htmlhelp.show.advanced.search</refentrytitle> 8238<refmiscinfo role="type">boolean</refmiscinfo> 8239</refmeta> 8240<refnamediv> 8241<refname>htmlhelp.show.advanced.search</refname> 8242<refpurpose>Should be advanced search available?</refpurpose> 8243</refnamediv> 8244 8245<refsynopsisdiv> 8246<programlisting id="htmlhelp.show.advanced.search.frag"> 8247<xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param> 8248</programlisting> 8249</refsynopsisdiv> 8250 8251<refsect1><title>Description</title> 8252 8253<para>If you want advanced search features in your help, turn this 8254parameter to 1.</para> 8255 8256</refsect1> 8257</refentry> 8258 8259<refentry id="htmlhelp.show.favorities"> 8260<refmeta> 8261<refentrytitle>htmlhelp.show.favorities</refentrytitle> 8262<refmiscinfo role="type">boolean</refmiscinfo> 8263</refmeta> 8264<refnamediv> 8265<refname>htmlhelp.show.favorities</refname> 8266<refpurpose>Should be favorities tab shown?</refpurpose> 8267</refnamediv> 8268 8269<refsynopsisdiv> 8270<programlisting id="htmlhelp.show.favorities.frag"> 8271<xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param> 8272</programlisting> 8273</refsynopsisdiv> 8274 8275<refsect1><title>Description</title> 8276 8277<para>If you want favorities tab shown in your help, turn this 8278parameter to 1.</para> 8279 8280</refsect1> 8281</refentry> 8282 8283<refentry id="htmlhelp.button.hideshow"> 8284<refmeta> 8285<refentrytitle>htmlhelp.button.hideshow</refentrytitle> 8286<refmiscinfo role="type">boolean</refmiscinfo> 8287</refmeta> 8288<refnamediv> 8289<refname>htmlhelp.button.hideshow</refname> 8290<refpurpose>Should be Hide/Show button shown?</refpurpose> 8291</refnamediv> 8292 8293<refsynopsisdiv> 8294<programlisting id="htmlhelp.button.hideshow.frag"> 8295<xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param> 8296</programlisting> 8297</refsynopsisdiv> 8298 8299<refsect1><title>Description</title> 8300 8301<para>If you want Hide/Show button shown on toolbar, turn this 8302parameter to 1.</para> 8303 8304</refsect1> 8305</refentry> 8306 8307<refentry id="htmlhelp.button.back"> 8308<refmeta> 8309<refentrytitle>htmlhelp.button.back</refentrytitle> 8310<refmiscinfo role="type">boolean</refmiscinfo> 8311</refmeta> 8312<refnamediv> 8313<refname>htmlhelp.button.back</refname> 8314<refpurpose>Should be Back button shown?</refpurpose> 8315</refnamediv> 8316 8317<refsynopsisdiv> 8318<programlisting id="htmlhelp.button.back.frag"> 8319<xsl:param name="htmlhelp.button.back" select="1"></xsl:param> 8320</programlisting> 8321</refsynopsisdiv> 8322 8323<refsect1><title>Description</title> 8324 8325<para>If you want Back button shown on toolbar, turn this 8326parameter to 1.</para> 8327 8328</refsect1> 8329</refentry> 8330 8331<refentry id="htmlhelp.button.forward"> 8332<refmeta> 8333<refentrytitle>htmlhelp.button.forward</refentrytitle> 8334<refmiscinfo role="type">boolean</refmiscinfo> 8335</refmeta> 8336<refnamediv> 8337<refname>htmlhelp.button.forward</refname> 8338<refpurpose>Should be Forward button shown?</refpurpose> 8339</refnamediv> 8340 8341<refsynopsisdiv> 8342<programlisting id="htmlhelp.button.forward.frag"> 8343<xsl:param name="htmlhelp.button.forward" select="0"></xsl:param> 8344</programlisting> 8345</refsynopsisdiv> 8346 8347<refsect1><title>Description</title> 8348 8349<para>If you want Forward button shown on toolbar, turn this 8350parameter to 1.</para> 8351 8352</refsect1> 8353</refentry> 8354 8355<refentry id="htmlhelp.button.stop"> 8356<refmeta> 8357<refentrytitle>htmlhelp.button.stop</refentrytitle> 8358<refmiscinfo role="type">boolean</refmiscinfo> 8359</refmeta> 8360<refnamediv> 8361<refname>htmlhelp.button.stop</refname> 8362<refpurpose>Should be Stop button shown?</refpurpose> 8363</refnamediv> 8364 8365<refsynopsisdiv> 8366<programlisting id="htmlhelp.button.stop.frag"> 8367<xsl:param name="htmlhelp.button.stop" select="0"></xsl:param> 8368</programlisting> 8369</refsynopsisdiv> 8370 8371<refsect1><title>Description</title> 8372 8373<para>If you want Stop button shown on toolbar, turn this 8374parameter to 1.</para> 8375 8376</refsect1> 8377</refentry> 8378 8379<refentry id="htmlhelp.button.refresh"> 8380<refmeta> 8381<refentrytitle>htmlhelp.button.refresh</refentrytitle> 8382<refmiscinfo role="type">boolean</refmiscinfo> 8383</refmeta> 8384<refnamediv> 8385<refname>htmlhelp.button.refresh</refname> 8386<refpurpose>Should be Refresh button shown?</refpurpose> 8387</refnamediv> 8388 8389<refsynopsisdiv> 8390<programlisting id="htmlhelp.button.refresh.frag"> 8391<xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param> 8392</programlisting> 8393</refsynopsisdiv> 8394 8395<refsect1><title>Description</title> 8396 8397<para>If you want Refresh button shown on toolbar, turn this 8398parameter to 1.</para> 8399 8400</refsect1> 8401</refentry> 8402 8403<refentry id="htmlhelp.button.home"> 8404<refmeta> 8405<refentrytitle>htmlhelp.button.home</refentrytitle> 8406<refmiscinfo role="type">boolean</refmiscinfo> 8407</refmeta> 8408<refnamediv> 8409<refname>htmlhelp.button.home</refname> 8410<refpurpose>Should be Home button shown?</refpurpose> 8411</refnamediv> 8412 8413<refsynopsisdiv> 8414<programlisting id="htmlhelp.button.home.frag"> 8415<xsl:param name="htmlhelp.button.home" select="0"></xsl:param> 8416</programlisting> 8417</refsynopsisdiv> 8418 8419<refsect1><title>Description</title> 8420 8421<para>If you want Home button shown on toolbar, turn this 8422parameter to 1.</para> 8423 8424</refsect1> 8425</refentry> 8426 8427<refentry id="htmlhelp.button.home.url"> 8428<refmeta> 8429<refentrytitle>htmlhelp.button.home.url</refentrytitle> 8430<refmiscinfo role="type">string</refmiscinfo> 8431</refmeta> 8432<refnamediv> 8433<refname>htmlhelp.button.home.url</refname> 8434<refpurpose>URL address of page accessible by Home button</refpurpose> 8435</refnamediv> 8436 8437<refsynopsisdiv> 8438<programlisting id="htmlhelp.button.home.url.frag"> 8439<xsl:param name="htmlhelp.button.home.url"></xsl:param> 8440</programlisting> 8441</refsynopsisdiv> 8442 8443<refsect1><title>Description</title> 8444 8445<para>URL address of page accessible by Home button.</para> 8446 8447</refsect1> 8448</refentry> 8449 8450<refentry id="htmlhelp.button.options"> 8451<refmeta> 8452<refentrytitle>htmlhelp.button.options</refentrytitle> 8453<refmiscinfo role="type">boolean</refmiscinfo> 8454</refmeta> 8455<refnamediv> 8456<refname>htmlhelp.button.options</refname> 8457<refpurpose>Should be Options button shown?</refpurpose> 8458</refnamediv> 8459 8460<refsynopsisdiv> 8461<programlisting id="htmlhelp.button.options.frag"> 8462<xsl:param name="htmlhelp.button.options" select="1"></xsl:param> 8463</programlisting> 8464</refsynopsisdiv> 8465 8466<refsect1><title>Description</title> 8467 8468<para>If you want Options button shown on toolbar, turn this 8469parameter to 1.</para> 8470 8471</refsect1> 8472</refentry> 8473 8474<refentry id="htmlhelp.button.print"> 8475<refmeta> 8476<refentrytitle>htmlhelp.button.print</refentrytitle> 8477<refmiscinfo role="type">boolean</refmiscinfo> 8478</refmeta> 8479<refnamediv> 8480<refname>htmlhelp.button.print</refname> 8481<refpurpose>Should be Print button shown?</refpurpose> 8482</refnamediv> 8483 8484<refsynopsisdiv> 8485<programlisting id="htmlhelp.button.print.frag"> 8486<xsl:param name="htmlhelp.button.print" select="1"></xsl:param> 8487</programlisting> 8488</refsynopsisdiv> 8489 8490<refsect1><title>Description</title> 8491 8492<para>If you want Print button shown on toolbar, turn this 8493parameter to 1.</para> 8494 8495</refsect1> 8496</refentry> 8497 8498<refentry id="htmlhelp.button.locate"> 8499<refmeta> 8500<refentrytitle>htmlhelp.button.locate</refentrytitle> 8501<refmiscinfo role="type">boolean</refmiscinfo> 8502</refmeta> 8503<refnamediv> 8504<refname>htmlhelp.button.locate</refname> 8505<refpurpose>Should be Locate button shown?</refpurpose> 8506</refnamediv> 8507 8508<refsynopsisdiv> 8509<programlisting id="htmlhelp.button.locate.frag"> 8510<xsl:param name="htmlhelp.button.locate" select="0"></xsl:param> 8511</programlisting> 8512</refsynopsisdiv> 8513 8514<refsect1><title>Description</title> 8515 8516<para>If you want Locate button shown on toolbar, turn this 8517parameter to 1.</para> 8518 8519</refsect1> 8520</refentry> 8521 8522<refentry id="htmlhelp.button.jump1"> 8523<refmeta> 8524<refentrytitle>htmlhelp.button.jump1</refentrytitle> 8525<refmiscinfo role="type">boolean</refmiscinfo> 8526</refmeta> 8527<refnamediv> 8528<refname>htmlhelp.button.jump1</refname> 8529<refpurpose>Should be Jump1 button shown?</refpurpose> 8530</refnamediv> 8531 8532<refsynopsisdiv> 8533<programlisting id="htmlhelp.button.jump1.frag"> 8534<xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param> 8535</programlisting> 8536</refsynopsisdiv> 8537 8538<refsect1><title>Description</title> 8539 8540<para>If you want Jump1 button shown on toolbar, turn this 8541parameter to 1.</para> 8542 8543</refsect1> 8544</refentry> 8545 8546<refentry id="htmlhelp.button.jump1.url"> 8547<refmeta> 8548<refentrytitle>htmlhelp.button.jump1.url</refentrytitle> 8549<refmiscinfo role="type">string</refmiscinfo> 8550</refmeta> 8551<refnamediv> 8552<refname>htmlhelp.button.jump1.url</refname> 8553<refpurpose>URL address of page accessible by Jump1 button</refpurpose> 8554</refnamediv> 8555 8556<refsynopsisdiv> 8557<programlisting id="htmlhelp.button.jump1.url.frag"> 8558<xsl:param name="htmlhelp.button.jump1.url"></xsl:param> 8559</programlisting> 8560</refsynopsisdiv> 8561 8562<refsect1><title>Description</title> 8563 8564<para>URL address of page accessible by Jump1 button.</para> 8565 8566</refsect1> 8567</refentry> 8568 8569<refentry id="htmlhelp.button.jump1.title"> 8570<refmeta> 8571<refentrytitle>htmlhelp.button.jump1.title</refentrytitle> 8572<refmiscinfo role="type">string</refmiscinfo> 8573</refmeta> 8574<refnamediv> 8575<refname>htmlhelp.button.jump1.title</refname> 8576<refpurpose>Title of Jump1 button</refpurpose> 8577</refnamediv> 8578 8579<refsynopsisdiv> 8580<programlisting id="htmlhelp.button.jump1.title.frag"> 8581<xsl:param name="htmlhelp.button.jump1.title" select="'User1'"></xsl:param> 8582</programlisting> 8583</refsynopsisdiv> 8584 8585<refsect1><title>Description</title> 8586 8587<para>Title of Jump1 button.</para> 8588 8589</refsect1> 8590</refentry> 8591 8592<refentry id="htmlhelp.button.jump2"> 8593<refmeta> 8594<refentrytitle>htmlhelp.button.jump2</refentrytitle> 8595<refmiscinfo role="type">boolean</refmiscinfo> 8596</refmeta> 8597<refnamediv> 8598<refname>htmlhelp.button.jump2</refname> 8599<refpurpose>Should be Jump2 button shown?</refpurpose> 8600</refnamediv> 8601 8602<refsynopsisdiv> 8603<programlisting id="htmlhelp.button.jump2.frag"> 8604<xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param> 8605</programlisting> 8606</refsynopsisdiv> 8607 8608<refsect1><title>Description</title> 8609 8610<para>If you want Jump2 button shown on toolbar, turn this 8611parameter to 1.</para> 8612 8613</refsect1> 8614</refentry> 8615 8616<refentry id="htmlhelp.button.jump2.url"> 8617<refmeta> 8618<refentrytitle>htmlhelp.button.jump2.url</refentrytitle> 8619<refmiscinfo role="type">string</refmiscinfo> 8620</refmeta> 8621<refnamediv> 8622<refname>htmlhelp.button.jump2.url</refname> 8623<refpurpose>URL address of page accessible by Jump2 button</refpurpose> 8624</refnamediv> 8625 8626<refsynopsisdiv> 8627<programlisting id="htmlhelp.button.jump2.url.frag"> 8628<xsl:param name="htmlhelp.button.jump2.url"></xsl:param> 8629</programlisting> 8630</refsynopsisdiv> 8631 8632<refsect1><title>Description</title> 8633 8634<para>URL address of page accessible by Jump2 button.</para> 8635 8636</refsect1> 8637</refentry> 8638 8639<refentry id="htmlhelp.button.jump2.title"> 8640<refmeta> 8641<refentrytitle>htmlhelp.button.jump2.title</refentrytitle> 8642<refmiscinfo role="type">string</refmiscinfo> 8643</refmeta> 8644<refnamediv> 8645<refname>htmlhelp.button.jump2.title</refname> 8646<refpurpose>Title of Jump2 button</refpurpose> 8647</refnamediv> 8648 8649<refsynopsisdiv> 8650<programlisting id="htmlhelp.button.jump2.title.frag"> 8651<xsl:param name="htmlhelp.button.jump2.title" select="'User2'"></xsl:param> 8652</programlisting> 8653</refsynopsisdiv> 8654 8655<refsect1><title>Description</title> 8656 8657<para>Title of Jump2 button.</para> 8658 8659</refsect1> 8660</refentry> 8661 8662<refentry id="htmlhelp.button.next"> 8663<refmeta> 8664<refentrytitle>htmlhelp.button.next</refentrytitle> 8665<refmiscinfo role="type">boolean</refmiscinfo> 8666</refmeta> 8667<refnamediv> 8668<refname>htmlhelp.button.next</refname> 8669<refpurpose>Should be Next button shown?</refpurpose> 8670</refnamediv> 8671 8672<refsynopsisdiv> 8673<programlisting id="htmlhelp.button.next.frag"> 8674<xsl:param name="htmlhelp.button.next" select="1"></xsl:param> 8675</programlisting> 8676</refsynopsisdiv> 8677 8678<refsect1><title>Description</title> 8679 8680<para>If you want Next button shown on toolbar, turn this 8681parameter to 1.</para> 8682 8683</refsect1> 8684</refentry> 8685 8686<refentry id="htmlhelp.button.prev"> 8687<refmeta> 8688<refentrytitle>htmlhelp.button.prev</refentrytitle> 8689<refmiscinfo role="type">boolean</refmiscinfo> 8690</refmeta> 8691<refnamediv> 8692<refname>htmlhelp.button.prev</refname> 8693<refpurpose>Should be Prev button shown?</refpurpose> 8694</refnamediv> 8695 8696<refsynopsisdiv> 8697<programlisting id="htmlhelp.button.prev.frag"> 8698<xsl:param name="htmlhelp.button.prev" select="1"></xsl:param> 8699</programlisting> 8700</refsynopsisdiv> 8701 8702<refsect1><title>Description</title> 8703 8704<para>If you want Prev button shown on toolbar, turn this 8705parameter to 1.</para> 8706 8707</refsect1> 8708</refentry> 8709 8710<refentry id="htmlhelp.button.zoom"> 8711<refmeta> 8712<refentrytitle>htmlhelp.button.zoom</refentrytitle> 8713<refmiscinfo role="type">boolean</refmiscinfo> 8714</refmeta> 8715<refnamediv> 8716<refname>htmlhelp.button.zoom</refname> 8717<refpurpose>Should be Zoom button shown?</refpurpose> 8718</refnamediv> 8719 8720<refsynopsisdiv> 8721<programlisting id="htmlhelp.button.zoom.frag"> 8722<xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param> 8723</programlisting> 8724</refsynopsisdiv> 8725 8726<refsect1><title>Description</title> 8727 8728<para>If you want Zoom button shown on toolbar, turn this 8729parameter to 1.</para> 8730 8731</refsect1> 8732</refentry> 8733 8734<refentry id="htmlhelp.remember.window.position"> 8735<refmeta> 8736<refentrytitle>htmlhelp.remember.window.position</refentrytitle> 8737<refmiscinfo role="type">boolean</refmiscinfo> 8738</refmeta> 8739<refnamediv> 8740<refname>htmlhelp.remember.window.position</refname> 8741<refpurpose>Remember help window position?</refpurpose> 8742</refnamediv> 8743 8744<refsynopsisdiv> 8745<programlisting id="htmlhelp.remember.window.position.frag"> 8746<xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:param> 8747</programlisting> 8748</refsynopsisdiv> 8749 8750<refsect1><title>Description</title> 8751 8752<para>To remember help window position between starts set this 8753parameter to 1.</para> 8754 8755</refsect1> 8756</refentry> 8757 8758 8759<refentry id="htmlhelp.window.geometry"> 8760<refmeta> 8761<refentrytitle>htmlhelp.window.geometry</refentrytitle> 8762<refmiscinfo role="type">string</refmiscinfo> 8763</refmeta> 8764<refnamediv> 8765<refname>htmlhelp.window.geometry</refname> 8766<refpurpose>Set initial geometry of help window</refpurpose> 8767</refnamediv> 8768 8769<refsynopsisdiv> 8770<programlisting id="htmlhelp.window.geometry.frag"> 8771<xsl:param name="htmlhelp.window.geometry"></xsl:param> 8772</programlisting> 8773</refsynopsisdiv> 8774 8775<refsect1><title>Description</title> 8776 8777<para>This parameter specifies initial position of help 8778window. E.g.</para> 8779 8780<programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting> 8781 8782</refsect1> 8783</refentry> 8784 8785 8786<refentry id="htmlhelp.use.hhk"> 8787<refmeta> 8788<refentrytitle>htmlhelp.use.hhk</refentrytitle> 8789<refmiscinfo role="type">boolean</refmiscinfo> 8790</refmeta> 8791<refnamediv> 8792<refname>htmlhelp.use.hhk</refname> 8793<refpurpose>Should be index built using HHK file?</refpurpose> 8794</refnamediv> 8795 8796<refsynopsisdiv> 8797<programlisting id="htmlhelp.use.hhk.frag"> 8798<xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param> 8799</programlisting> 8800</refsynopsisdiv> 8801 8802<refsect1><title>Description</title> 8803 8804<para>If non-zero, index is created using HHK file. This provides some 8805new features.</para> 8806 8807</refsect1> 8808</refentry> 8809 8810<refentry id="htmlhelp.only"> 8811<refmeta> 8812<refentrytitle>htmlhelp.only</refentrytitle> 8813<refmiscinfo role="type">boolean</refmiscinfo> 8814</refmeta> 8815<refnamediv> 8816<refname>htmlhelp.only</refname> 8817<refpurpose>Should be only project files generated?</refpurpose> 8818</refnamediv> 8819 8820<refsynopsisdiv> 8821<programlisting id="htmlhelp.only.frag"> 8822<xsl:param name="htmlhelp.only" select="0"></xsl:param> 8823</programlisting> 8824</refsynopsisdiv> 8825 8826<refsect1><title>Description</title> 8827 8828<para>If you want to play with various HTML Help parameters and you 8829don't need to regenerate all HTML files, you can set this parameter to 88301. This setting will not process whole document, only project files 8831(hhp, hhc, hhk,...) will be generated.</para> 8832 8833</refsect1> 8834</refentry> 8835 8836</reference> 8837 8838<reference id="eclipse_help"><title>Eclipse Help Platform</title> 8839<refentry id="eclipse.autolabel"> 8840<refmeta> 8841<refentrytitle>eclipse.autolabel</refentrytitle> 8842<refmiscinfo role="type">boolean</refmiscinfo> 8843</refmeta> 8844<refnamediv> 8845<refname>eclipse.autolabel</refname> 8846<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> 8847</refnamediv> 8848 8849<refsynopsisdiv> 8850<programlisting id="eclipse.autolabel.frag"> 8851<xsl:param name="eclipse.autolabel" select="0"></xsl:param> 8852</programlisting> 8853</refsynopsisdiv> 8854 8855<refsect1><title>Description</title> 8856 8857<para>If you want to include chapter and section numbers into ToC in 8858the left panel, set this parameter to 1.</para> 8859 8860</refsect1> 8861</refentry> 8862 8863<refentry id="eclipse.plugin.name"> 8864<refmeta> 8865<refentrytitle>eclipse.plugin.name</refentrytitle> 8866<refmiscinfo role="type">string</refmiscinfo> 8867</refmeta> 8868<refnamediv> 8869<refname>eclipse.plugin.name</refname> 8870<refpurpose>Eclipse Help plugin name</refpurpose> 8871</refnamediv> 8872 8873<refsynopsisdiv> 8874<programlisting id="eclipse.plugin.name.frag"> 8875<xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param> 8876</programlisting> 8877</refsynopsisdiv> 8878 8879<refsect1><title>Description</title> 8880 8881<para>Eclipse Help plugin name.</para> 8882 8883</refsect1> 8884</refentry> 8885 8886<refentry id="eclipse.plugin.id"> 8887<refmeta> 8888<refentrytitle>eclipse.plugin.id</refentrytitle> 8889<refmiscinfo role="type">string</refmiscinfo> 8890</refmeta> 8891<refnamediv> 8892<refname>eclipse.plugin.id</refname> 8893<refpurpose>Eclipse Help plugin id</refpurpose> 8894</refnamediv> 8895 8896<refsynopsisdiv> 8897<programlisting id="eclipse.plugin.id.frag"> 8898<xsl:param name="eclipse.plugin.id">com.example.help</xsl:param> 8899</programlisting> 8900</refsynopsisdiv> 8901 8902<refsect1><title>Description</title> 8903 8904<para>Eclipse Help plugin id. You should change this id to something 8905unique for each help.</para> 8906 8907</refsect1> 8908</refentry> 8909 8910<refentry id="eclipse.plugin.provider"> 8911<refmeta> 8912<refentrytitle>eclipse.plugin.provider</refentrytitle> 8913<refmiscinfo role="type">string</refmiscinfo> 8914</refmeta> 8915<refnamediv> 8916<refname>eclipse.plugin.provider</refname> 8917<refpurpose>Eclipse Help plugin provider name</refpurpose> 8918</refnamediv> 8919 8920<refsynopsisdiv> 8921<programlisting id="eclipse.plugin.provider.frag"> 8922<xsl:param name="eclipse.plugin.provider">Example provider</xsl:param> 8923</programlisting> 8924</refsynopsisdiv> 8925 8926<refsect1><title>Description</title> 8927 8928<para>Eclipse Help plugin provider name.</para> 8929 8930</refsect1> 8931</refentry> 8932 8933</reference> 8934 8935<reference id="l10n"><title>Localization</title> 8936<refentry id="l10n.gentext.language"> 8937<refmeta> 8938<refentrytitle>l10n.gentext.language</refentrytitle> 8939<refmiscinfo role="type">string</refmiscinfo> 8940</refmeta> 8941<refnamediv> 8942<refname>l10n.gentext.language</refname> 8943<refpurpose>Sets the gentext language</refpurpose> 8944</refnamediv> 8945 8946<refsynopsisdiv> 8947<programlisting id="l10n.gentext.language.frag"> 8948<xsl:param name="l10n.gentext.language" select="''"></xsl:param> 8949</programlisting> 8950</refsynopsisdiv> 8951 8952<refsect1><title>Description</title> 8953 8954<para>If this parameter is set to any value other than the empty string, its 8955value will be used as the value for the language when generating text. Setting 8956<parameter>l10n.gentext.language</parameter> overrides any settings within the 8957document being formatted.</para> 8958 8959<para>It's much more likely that you might want to set the 8960<parameter>l10n.gentext.default.language</parameter> parameter.</para> 8961 8962</refsect1> 8963</refentry> 8964 8965<refentry id="l10n.gentext.default.language"> 8966<refmeta> 8967<refentrytitle>l10n.gentext.default.language</refentrytitle> 8968<refmiscinfo role="type">string</refmiscinfo> 8969</refmeta> 8970<refnamediv> 8971<refname>l10n.gentext.default.language</refname> 8972<refpurpose>Sets the default language for generated text</refpurpose> 8973</refnamediv> 8974 8975<refsynopsisdiv> 8976<programlisting id="l10n.gentext.default.language.frag"> 8977<xsl:param name="l10n.gentext.default.language" select="'en'"></xsl:param> 8978</programlisting> 8979</refsynopsisdiv> 8980 8981<refsect1><title>Description</title> 8982 8983<para>The value of the <parameter>l10n.gentext.default.language</parameter> 8984parameter is used as the language for generated text if no setting is provided 8985in the source document.</para> 8986 8987</refsect1> 8988</refentry> 8989 8990<refentry id="l10n.gentext.use.xref.language"> 8991<refmeta> 8992<refentrytitle>l10n.gentext.use.xref.language</refentrytitle> 8993<refmiscinfo role="type">boolean</refmiscinfo> 8994</refmeta> 8995<refnamediv> 8996<refname>l10n.gentext.use.xref.language</refname> 8997<refpurpose>Use the language of target when generating cross-reference text?</refpurpose> 8998</refnamediv> 8999 9000<refsynopsisdiv> 9001<programlisting id="l10n.gentext.use.xref.language.frag"> 9002<xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param> 9003</programlisting> 9004</refsynopsisdiv> 9005 9006<refsect1><title>Description</title> 9007 9008<para>If non-zero, the language of the target will be used when 9009generating cross reference text. Usually, the <quote>current</quote> 9010language is used when generating text (that is, the language of the 9011element that contains the cross-reference element). But setting this parameter 9012allows the language of the element <emphasis>pointed to</emphasis> to control 9013the generated text.</para> 9014 9015<para>Consider the following example:</para> 9016 9017<informalexample> 9018<programlisting><para lang="en">See also <xref linkend="chap3"/>.</para> 9019</programlisting> 9020</informalexample> 9021 9022<para>Suppose that Chapter 3 happens to be written in German. 9023If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the 9024resulting text will be something like this:</para> 9025 9026<blockquote> 9027<para>See also Kapital 3.</para> 9028</blockquote> 9029 9030<para>Where the more traditional rendering would be:</para> 9031 9032<blockquote> 9033<para>See also Chapter 3.</para> 9034</blockquote> 9035 9036</refsect1> 9037</refentry> 9038 9039<refentry id="l10n.lang.value.rfc.compliant"> 9040<refmeta> 9041<refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle> 9042<refmiscinfo role="type">boolean</refmiscinfo> 9043</refmeta> 9044<refnamediv> 9045<refname>l10n.lang.value.rfc.compliant</refname> 9046<refpurpose>Make value of lang attribute RFC compliant?</refpurpose> 9047</refnamediv> 9048 9049<refsynopsisdiv> 9050<programlisting id="l10n.lang.value.rfc.compliant.frag"> 9051<xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param> 9052</programlisting> 9053</refsynopsisdiv> 9054 9055<refsect1><title>Description</title> 9056 9057<para>If non-zero, ensure that the values for all <sgmltag class="attribute">lang</sgmltag> attributes in HTML output are RFC 9058compliant<footnote><para>Section 8.1.1, <ulink url="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</ulink>, in the HTML 4.0 Recommendation states that: 9059 9060<blockquote><para>[RFC1766] defines and explains the language codes 9061that must be used in HTML documents.</para> 9062<para>Briefly, language codes consist of a primary code and a possibly 9063empty series of subcodes: 9064 9065<literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout> 9066</para> 9067<para>And in RFC 1766, <ulink url="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification 9068of Languages</ulink>, the EBNF for "language tag" is given as: 9069 9070<literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag ) 9071Primary-tag = 1*8ALPHA 9072Subtag = 1*8ALPHA</literallayout> 9073</para> 9074</blockquote> 9075</para></footnote>. 9076 9077by taking any underscore characters in any <sgmltag class="attribute">lang</sgmltag> values found in source documents, and 9078replacing them with hyphen characters in output HTML files. For 9079example, <literal>zh_CN</literal> in a source document becomes 9080<literal>zh-CN</literal> in the HTML output form that source. 9081 9082<note> 9083<para>This parameter does not cause any case change in <sgmltag class="attribute">lang</sgmltag> values, because RFC 1766 9084explicitly states that all "language tags" (as it calls them) "are 9085to be treated as case insensitive".</para> 9086</note> 9087</para> 9088 9089</refsect1> 9090</refentry> 9091 9092</reference> 9093 9094<appendix><title>The Stylesheet</title> 9095 9096<para>The <filename>param.xsl</filename> stylesheet is just a wrapper 9097around all these parameters.</para> 9098 9099<programlisting id="top"> 9100 9101<!-- This file is generated from param.xweb; do not edit this file! --> 9102 9103<xsl:stylesheet exclude-result-prefixes="src" version="1.0"> 9104 9105<!-- ******************************************************************** 9106 $Id: param.xweb,v 1.103 2006/05/14 06:22:26 bobstayton Exp $ 9107 ******************************************************************** 9108 9109 This file is part of the XSL DocBook Stylesheet distribution. 9110 See ../README or http://nwalsh.com/docbook/xsl/ for copyright 9111 and other information. 9112 9113 ******************************************************************** --> 9114 9115<src:fragref linkend="admon.graphics.extension.frag"></src:fragref> 9116<src:fragref linkend="admon.graphics.frag"></src:fragref> 9117<src:fragref linkend="admon.graphics.path.frag"></src:fragref> 9118<src:fragref linkend="admon.style.frag"></src:fragref> 9119<src:fragref linkend="admon.textlabel.frag"></src:fragref> 9120<src:fragref linkend="annotate.toc.frag"></src:fragref> 9121<src:fragref linkend="annotation.css.frag"></src:fragref> 9122<src:fragref linkend="annotation.js.frag"></src:fragref> 9123<src:fragref linkend="annotation.graphic.open.frag"></src:fragref> 9124<src:fragref linkend="annotation.graphic.close.frag"></src:fragref> 9125<src:fragref linkend="annotation.support.frag"></src:fragref> 9126<src:fragref linkend="appendix.autolabel.frag"></src:fragref> 9127<src:fragref linkend="author.othername.in.middle.frag"></src:fragref> 9128<src:fragref linkend="autotoc.label.separator.frag"></src:fragref> 9129<src:fragref linkend="autotoc.label.in.hyperlink.frag"></src:fragref> 9130<src:fragref linkend="base.dir.frag"></src:fragref> 9131<src:fragref linkend="biblioentry.item.separator.frag"></src:fragref> 9132<src:fragref linkend="bibliography.collection.frag"></src:fragref> 9133<src:fragref linkend="bibliography.numbered.frag"></src:fragref> 9134<src:fragref linkend="bridgehead.in.toc.frag"></src:fragref> 9135<src:fragref linkend="callout.defaultcolumn.frag"></src:fragref> 9136<src:fragref linkend="callout.graphics.extension.frag"></src:fragref> 9137<src:fragref linkend="callout.graphics.frag"></src:fragref> 9138<src:fragref linkend="callout.graphics.number.limit.frag"></src:fragref> 9139<src:fragref linkend="callout.graphics.path.frag"></src:fragref> 9140<src:fragref linkend="callout.list.table.frag"></src:fragref> 9141<src:fragref linkend="callout.unicode.frag"></src:fragref> 9142<src:fragref linkend="callout.unicode.number.limit.frag"></src:fragref> 9143<src:fragref linkend="callout.unicode.start.character.frag"></src:fragref> 9144<src:fragref linkend="callouts.extension.frag"></src:fragref> 9145<src:fragref linkend="chapter.autolabel.frag"></src:fragref> 9146<src:fragref linkend="chunk.first.sections.frag"></src:fragref> 9147<src:fragref linkend="chunk.quietly.frag"></src:fragref> 9148<src:fragref linkend="chunk.section.depth.frag"></src:fragref> 9149<src:fragref linkend="chunk.toc.frag"></src:fragref> 9150<src:fragref linkend="chunk.tocs.and.lots.frag"></src:fragref> 9151<src:fragref linkend="chunk.tocs.and.lots.has.title.frag"></src:fragref> 9152<src:fragref linkend="chunk.separate.lots.frag"></src:fragref> 9153<src:fragref linkend="citerefentry.link.frag"></src:fragref> 9154<src:fragref linkend="collect.xref.targets.frag"></src:fragref> 9155<src:fragref linkend="component.label.includes.part.label.frag"></src:fragref> 9156<src:fragref linkend="css.decoration.frag"></src:fragref> 9157<src:fragref linkend="current.docid.frag"></src:fragref> 9158<src:fragref linkend="default.float.class.frag"></src:fragref> 9159<src:fragref linkend="default.image.width.frag"></src:fragref> 9160<src:fragref linkend="default.table.width.frag"></src:fragref> 9161<src:fragref linkend="default.table.frame.frag"></src:fragref> 9162<src:fragref linkend="draft.mode.frag"></src:fragref> 9163<src:fragref linkend="draft.watermark.image.frag"></src:fragref> 9164<src:fragref linkend="ebnf.table.bgcolor.frag"></src:fragref> 9165<src:fragref linkend="ebnf.table.border.frag"></src:fragref> 9166<src:fragref linkend="ebnf.assignment.frag"></src:fragref> 9167<src:fragref linkend="ebnf.statement.terminator.frag"></src:fragref> 9168<src:fragref linkend="eclipse.autolabel.frag"></src:fragref> 9169<src:fragref linkend="eclipse.plugin.name.frag"></src:fragref> 9170<src:fragref linkend="eclipse.plugin.id.frag"></src:fragref> 9171<src:fragref linkend="eclipse.plugin.provider.frag"></src:fragref> 9172<src:fragref linkend="emphasis.propagates.style.frag"></src:fragref> 9173<src:fragref linkend="entry.propagates.style.frag"></src:fragref> 9174<src:fragref linkend="firstterm.only.link.frag"></src:fragref> 9175<src:fragref linkend="footer.rule.frag"></src:fragref> 9176<src:fragref linkend="footnote.number.format.frag"></src:fragref> 9177<src:fragref linkend="footnote.number.symbols.frag"></src:fragref> 9178<src:fragref linkend="formal.procedures.frag"></src:fragref> 9179<src:fragref linkend="formal.title.placement.frag"></src:fragref> 9180<src:fragref linkend="funcsynopsis.decoration.frag"></src:fragref> 9181<src:fragref linkend="funcsynopsis.style.frag"></src:fragref> 9182<src:fragref linkend="funcsynopsis.tabular.threshold.frag"></src:fragref> 9183<src:fragref linkend="function.parens.frag"></src:fragref> 9184<src:fragref linkend="generate.id.attributes.frag"></src:fragref> 9185<src:fragref linkend="generate.index.frag"></src:fragref> 9186<src:fragref linkend="generate.legalnotice.link.frag"></src:fragref> 9187<src:fragref linkend="generate.revhistory.link.frag"></src:fragref> 9188<src:fragref linkend="generate.manifest.frag"></src:fragref> 9189<src:fragref linkend="generate.meta.abstract.frag"></src:fragref> 9190<src:fragref linkend="generate.section.toc.level.frag"></src:fragref> 9191<src:fragref linkend="generate.toc.frag"></src:fragref> 9192<src:fragref linkend="glossary.collection.frag"></src:fragref> 9193<src:fragref linkend="glossentry.show.acronym.frag"></src:fragref> 9194<src:fragref linkend="glossterm.auto.link.frag"></src:fragref> 9195<src:fragref linkend="graphic.default.extension.frag"></src:fragref> 9196<src:fragref linkend="graphicsize.extension.frag"></src:fragref> 9197<src:fragref linkend="graphicsize.use.img.src.path.frag"></src:fragref> 9198<src:fragref linkend="header.rule.frag"></src:fragref> 9199<src:fragref linkend="html.base.frag"></src:fragref> 9200<src:fragref linkend="html.cellpadding.frag"></src:fragref> 9201<src:fragref linkend="html.cellspacing.frag"></src:fragref> 9202<src:fragref linkend="html.cleanup.frag"></src:fragref> 9203<src:fragref linkend="html.ext.frag"></src:fragref> 9204<src:fragref linkend="html.extra.head.links.frag"></src:fragref> 9205<src:fragref linkend="html.head.legalnotice.link.types.frag"></src:fragref> 9206<src:fragref linkend="html.head.legalnotice.link.multiple.frag"></src:fragref> 9207<src:fragref linkend="html.longdesc.frag"></src:fragref> 9208<src:fragref linkend="html.longdesc.link.frag"></src:fragref> 9209<src:fragref linkend="html.stylesheet.frag"></src:fragref> 9210<src:fragref linkend="html.stylesheet.type.frag"></src:fragref> 9211<src:fragref linkend="htmlhelp.alias.file.frag"></src:fragref> 9212<src:fragref linkend="htmlhelp.autolabel.frag"></src:fragref> 9213<src:fragref linkend="htmlhelp.button.back.frag"></src:fragref> 9214<src:fragref linkend="htmlhelp.button.forward.frag"></src:fragref> 9215<src:fragref linkend="htmlhelp.button.hideshow.frag"></src:fragref> 9216<src:fragref linkend="htmlhelp.button.home.frag"></src:fragref> 9217<src:fragref linkend="htmlhelp.button.home.url.frag"></src:fragref> 9218<src:fragref linkend="htmlhelp.button.jump1.frag"></src:fragref> 9219<src:fragref linkend="htmlhelp.button.jump1.title.frag"></src:fragref> 9220<src:fragref linkend="htmlhelp.button.jump1.url.frag"></src:fragref> 9221<src:fragref linkend="htmlhelp.button.jump2.frag"></src:fragref> 9222<src:fragref linkend="htmlhelp.button.jump2.title.frag"></src:fragref> 9223<src:fragref linkend="htmlhelp.button.jump2.url.frag"></src:fragref> 9224<src:fragref linkend="htmlhelp.button.locate.frag"></src:fragref> 9225<src:fragref linkend="htmlhelp.button.next.frag"></src:fragref> 9226<src:fragref linkend="htmlhelp.button.options.frag"></src:fragref> 9227<src:fragref linkend="htmlhelp.button.prev.frag"></src:fragref> 9228<src:fragref linkend="htmlhelp.button.print.frag"></src:fragref> 9229<src:fragref linkend="htmlhelp.button.refresh.frag"></src:fragref> 9230<src:fragref linkend="htmlhelp.button.stop.frag"></src:fragref> 9231<src:fragref linkend="htmlhelp.button.zoom.frag"></src:fragref> 9232<src:fragref linkend="htmlhelp.chm.frag"></src:fragref> 9233<src:fragref linkend="htmlhelp.default.topic.frag"></src:fragref> 9234<src:fragref linkend="htmlhelp.display.progress.frag"></src:fragref> 9235<src:fragref linkend="htmlhelp.encoding.frag"></src:fragref> 9236<src:fragref linkend="htmlhelp.enhanced.decompilation.frag"></src:fragref> 9237<src:fragref linkend="htmlhelp.enumerate.images.frag"></src:fragref> 9238<src:fragref linkend="htmlhelp.force.map.and.alias.frag"></src:fragref> 9239<src:fragref linkend="htmlhelp.hhc.binary.frag"></src:fragref> 9240<src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"></src:fragref> 9241<src:fragref linkend="htmlhelp.hhc.frag"></src:fragref> 9242<src:fragref linkend="htmlhelp.hhc.section.depth.frag"></src:fragref> 9243<src:fragref linkend="htmlhelp.hhc.show.root.frag"></src:fragref> 9244<src:fragref linkend="htmlhelp.hhc.width.frag"></src:fragref> 9245<src:fragref linkend="htmlhelp.hhk.frag"></src:fragref> 9246<src:fragref linkend="htmlhelp.hhp.frag"></src:fragref> 9247<src:fragref linkend="htmlhelp.hhp.tail.frag"></src:fragref> 9248<src:fragref linkend="htmlhelp.hhp.window.frag"></src:fragref> 9249<src:fragref linkend="htmlhelp.hhp.windows.frag"></src:fragref> 9250<src:fragref linkend="htmlhelp.map.file.frag"></src:fragref> 9251<src:fragref linkend="htmlhelp.only.frag"></src:fragref> 9252<src:fragref linkend="htmlhelp.remember.window.position.frag"></src:fragref> 9253<src:fragref linkend="htmlhelp.show.advanced.search.frag"></src:fragref> 9254<src:fragref linkend="htmlhelp.show.favorities.frag"></src:fragref> 9255<src:fragref linkend="htmlhelp.show.menu.frag"></src:fragref> 9256<src:fragref linkend="htmlhelp.show.toolbar.text.frag"></src:fragref> 9257<src:fragref linkend="htmlhelp.title.frag"></src:fragref> 9258<src:fragref linkend="htmlhelp.use.hhk.frag"></src:fragref> 9259<src:fragref linkend="htmlhelp.window.geometry.frag"></src:fragref> 9260<src:fragref linkend="img.src.path.frag"></src:fragref> 9261<src:fragref linkend="id.warnings.frag"></src:fragref> 9262<src:fragref linkend="index.method.frag"></src:fragref> 9263<src:fragref linkend="index.on.role.frag"></src:fragref> 9264<src:fragref linkend="index.on.type.frag"></src:fragref> 9265<src:fragref linkend="index.number.separator.frag"></src:fragref> 9266<src:fragref linkend="index.term.separator.frag"></src:fragref> 9267<src:fragref linkend="index.range.separator.frag"></src:fragref> 9268<src:fragref linkend="index.prefer.titleabbrev.frag"></src:fragref> 9269<src:fragref linkend="ignore.image.scaling.frag"></src:fragref> 9270<src:fragref linkend="inherit.keywords.frag"></src:fragref> 9271<src:fragref linkend="keep.relative.image.uris.frag"></src:fragref> 9272<src:fragref linkend="l10n.gentext.default.language.frag"></src:fragref> 9273<src:fragref linkend="l10n.gentext.language.frag"></src:fragref> 9274<src:fragref linkend="l10n.gentext.use.xref.language.frag"></src:fragref> 9275<src:fragref linkend="l10n.lang.value.rfc.compliant.frag"></src:fragref> 9276<src:fragref linkend="label.from.part.frag"></src:fragref> 9277<src:fragref linkend="linenumbering.everyNth.frag"></src:fragref> 9278<src:fragref linkend="linenumbering.extension.frag"></src:fragref> 9279<src:fragref linkend="linenumbering.separator.frag"></src:fragref> 9280<src:fragref linkend="linenumbering.width.frag"></src:fragref> 9281<src:fragref linkend="link.mailto.url.frag"></src:fragref> 9282<src:fragref linkend="make.graphic.viewport.frag"></src:fragref> 9283<src:fragref linkend="make.single.year.ranges.frag"></src:fragref> 9284<src:fragref linkend="make.valid.html.frag"></src:fragref> 9285<src:fragref linkend="make.year.ranges.frag"></src:fragref> 9286<src:fragref linkend="manifest.frag"></src:fragref> 9287<src:fragref linkend="manifest.in.base.dir.frag"></src:fragref> 9288<src:fragref linkend="manual.toc.frag"></src:fragref> 9289<src:fragref linkend="menuchoice.menu.separator.frag"></src:fragref> 9290<src:fragref linkend="menuchoice.separator.frag"></src:fragref> 9291<src:fragref linkend="navig.graphics.extension.frag"></src:fragref> 9292<src:fragref linkend="navig.graphics.frag"></src:fragref> 9293<src:fragref linkend="navig.graphics.path.frag"></src:fragref> 9294<src:fragref linkend="navig.showtitles.frag"></src:fragref> 9295<src:fragref linkend="nominal.image.depth.frag"></src:fragref> 9296<src:fragref linkend="nominal.image.width.frag"></src:fragref> 9297<src:fragref linkend="nominal.table.width.frag"></src:fragref> 9298<src:fragref linkend="olink.base.uri.frag"></src:fragref> 9299<src:fragref linkend="olink.debug.frag"></src:fragref> 9300<src:fragref linkend="olink.properties.frag"></src:fragref> 9301<src:fragref linkend="insert.olink.page.number.frag"></src:fragref> 9302<src:fragref linkend="insert.olink.pdf.frag.frag"></src:fragref> 9303<src:fragref linkend="prefer.internal.olink.frag"></src:fragref> 9304<src:fragref linkend="olink.lang.fallback.sequence.frag"></src:fragref> 9305<src:fragref linkend="olink.doctitle.frag"></src:fragref> 9306<src:fragref linkend="olink.fragid.frag"></src:fragref> 9307<src:fragref linkend="olink.outline.ext.frag"></src:fragref> 9308<src:fragref linkend="olink.pubid.frag"></src:fragref> 9309<src:fragref linkend="olink.resolver.frag"></src:fragref> 9310<src:fragref linkend="olink.sysid.frag"></src:fragref> 9311<src:fragref linkend="para.propagates.style.frag"></src:fragref> 9312<src:fragref linkend="part.autolabel.frag"></src:fragref> 9313<src:fragref linkend="phrase.propagates.style.frag"></src:fragref> 9314<src:fragref linkend="pixels.per.inch.frag"></src:fragref> 9315<src:fragref linkend="points.per.em.frag"></src:fragref> 9316<src:fragref linkend="preface.autolabel.frag"></src:fragref> 9317<src:fragref linkend="preferred.mediaobject.role.frag"></src:fragref> 9318<src:fragref linkend="process.empty.source.toc.frag"></src:fragref> 9319<src:fragref linkend="process.source.toc.frag"></src:fragref> 9320<src:fragref linkend="profile.arch.frag"></src:fragref> 9321<src:fragref linkend="profile.attribute.frag"></src:fragref> 9322<src:fragref linkend="profile.condition.frag"></src:fragref> 9323<src:fragref linkend="profile.conformance.frag"></src:fragref> 9324<src:fragref linkend="profile.lang.frag"></src:fragref> 9325<src:fragref linkend="profile.os.frag"></src:fragref> 9326<src:fragref linkend="profile.revision.frag"></src:fragref> 9327<src:fragref linkend="profile.revisionflag.frag"></src:fragref> 9328<src:fragref linkend="profile.role.frag"></src:fragref> 9329<src:fragref linkend="profile.security.frag"></src:fragref> 9330<src:fragref linkend="profile.separator.frag"></src:fragref> 9331<src:fragref linkend="profile.userlevel.frag"></src:fragref> 9332<src:fragref linkend="profile.value.frag"></src:fragref> 9333<src:fragref linkend="profile.vendor.frag"></src:fragref> 9334<src:fragref linkend="punct.honorific.frag"></src:fragref> 9335<src:fragref linkend="qanda.defaultlabel.frag"></src:fragref> 9336<src:fragref linkend="qanda.inherit.numeration.frag"></src:fragref> 9337<src:fragref linkend="qandadiv.autolabel.frag"></src:fragref> 9338<src:fragref linkend="refentry.generate.name.frag"></src:fragref> 9339<src:fragref linkend="refentry.generate.title.frag"></src:fragref> 9340<src:fragref linkend="refentry.separator.frag"></src:fragref> 9341<src:fragref linkend="refentry.xref.manvolnum.frag"></src:fragref> 9342<src:fragref linkend="refclass.suppress.frag"></src:fragref> 9343<src:fragref linkend="root.filename.frag"></src:fragref> 9344<src:fragref linkend="rootid.frag"></src:fragref> 9345<src:fragref linkend="runinhead.default.title.end.punct.frag"></src:fragref> 9346<src:fragref linkend="runinhead.title.end.punct.frag"></src:fragref> 9347<src:fragref linkend="section.autolabel.frag"></src:fragref> 9348<src:fragref linkend="section.autolabel.max.depth.frag"></src:fragref> 9349<src:fragref linkend="section.label.includes.component.label.frag"></src:fragref> 9350<src:fragref linkend="segmentedlist.as.table.frag"></src:fragref> 9351<src:fragref linkend="shade.verbatim.frag"></src:fragref> 9352<src:fragref linkend="shade.verbatim.style.frag"></src:fragref> 9353<src:fragref linkend="show.comments.frag"></src:fragref> 9354<src:fragref linkend="show.revisionflag.frag"></src:fragref> 9355<src:fragref linkend="simplesect.in.toc.frag"></src:fragref> 9356<src:fragref linkend="spacing.paras.frag"></src:fragref> 9357<src:fragref linkend="suppress.footer.navigation.frag"></src:fragref> 9358<src:fragref linkend="suppress.header.navigation.frag"></src:fragref> 9359<src:fragref linkend="suppress.navigation.frag"></src:fragref> 9360<src:fragref linkend="table.borders.with.css.frag"></src:fragref> 9361<src:fragref linkend="table.cell.border.color.frag"></src:fragref> 9362<src:fragref linkend="table.cell.border.style.frag"></src:fragref> 9363<src:fragref linkend="table.cell.border.thickness.frag"></src:fragref> 9364<src:fragref linkend="table.footnote.number.format.frag"></src:fragref> 9365<src:fragref linkend="table.footnote.number.symbols.frag"></src:fragref> 9366<src:fragref linkend="table.frame.border.color.frag"></src:fragref> 9367<src:fragref linkend="table.frame.border.style.frag"></src:fragref> 9368<src:fragref linkend="table.frame.border.thickness.frag"></src:fragref> 9369<src:fragref linkend="tablecolumns.extension.frag"></src:fragref> 9370<src:fragref linkend="target.database.document.frag"></src:fragref> 9371<src:fragref linkend="targets.filename.frag"></src:fragref> 9372<src:fragref linkend="textdata.default.encoding.frag"></src:fragref> 9373<src:fragref linkend="tex.math.delims.frag"></src:fragref> 9374<src:fragref linkend="tex.math.file.frag"></src:fragref> 9375<src:fragref linkend="tex.math.in.alt.frag"></src:fragref> 9376<src:fragref linkend="textinsert.extension.frag"></src:fragref> 9377<src:fragref linkend="toc.list.type.frag"></src:fragref> 9378<src:fragref linkend="toc.section.depth.frag"></src:fragref> 9379<src:fragref linkend="toc.max.depth.frag"></src:fragref> 9380<src:fragref linkend="ulink.target.frag"></src:fragref> 9381<src:fragref linkend="use.embed.for.svg.frag"></src:fragref> 9382<src:fragref linkend="use.extensions.frag"></src:fragref> 9383<src:fragref linkend="use.id.as.filename.frag"></src:fragref> 9384<src:fragref linkend="use.local.olink.style.frag"></src:fragref> 9385<src:fragref linkend="use.role.as.xrefstyle.frag"></src:fragref> 9386<src:fragref linkend="use.role.for.mediaobject.frag"></src:fragref> 9387<src:fragref linkend="use.svg.frag"></src:fragref> 9388<src:fragref linkend="variablelist.as.table.frag"></src:fragref> 9389<src:fragref linkend="variablelist.term.separator.frag"></src:fragref> 9390<src:fragref linkend="variablelist.term.break.after.frag"></src:fragref> 9391<src:fragref linkend="xref.with.number.and.title.frag"></src:fragref> 9392<src:fragref linkend="xref.label-title.separator.frag"></src:fragref> 9393<src:fragref linkend="xref.label-page.separator.frag"></src:fragref> 9394<src:fragref linkend="xref.title-page.separator.frag"></src:fragref> 9395<src:fragref linkend="insert.xref.page.number.frag"></src:fragref> 9396 9397</xsl:stylesheet> 9398</programlisting> 9399 9400</appendix> 9401 9402</book>
