1<?xml version="1.0" encoding="utf-8"?> 2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" exclude-result-prefixes="src" version="1.0"> 3 4<!-- ******************************************************************** 5 $Id: param.xweb,v 1.103 2006/05/14 06:22:26 bobstayton Exp $ 6 ******************************************************************** 7 8 This file is part of the XSL DocBook Stylesheet distribution. 9 See ../README or http://nwalsh.com/docbook/xsl/ for copyright 10 and other information. 11 12 ******************************************************************** --> 13 14<doc:refentry><refmeta> 15<refentrytitle>admon.graphics.extension</refentrytitle> 16<refmiscinfo role="type">string</refmiscinfo> 17</refmeta><refnamediv> 18<refname>admon.graphics.extension</refname> 19<refpurpose>Extension for admonition graphics</refpurpose> 20</refnamediv><refsynopsisdiv> 21 22</refsynopsisdiv><refsect1><title>Description</title> 23 24<para>Sets the extension to use on admonition graphics.</para> 25 26</refsect1> 27</doc:refentry> 28<xsl:param name="admon.graphics.extension" select="'.png'"/> 29 30<doc:refentry><refmeta> 31<refentrytitle>admon.graphics.path</refentrytitle> 32<refmiscinfo role="type">string</refmiscinfo> 33</refmeta><refnamediv> 34<refname>admon.graphics.path</refname> 35<refpurpose>Path to admonition graphics</refpurpose> 36</refnamediv><refsynopsisdiv> 37 38</refsynopsisdiv><refsect1><title>Description</title> 39 40<para>Sets the path, probably relative to the directory where the HTML 41files are created, to the admonition graphics. 42</para> 43 44</refsect1> 45</doc:refentry> 46<xsl:param name="admon.graphics.path">images/</xsl:param> 47 48<doc:refentry><refmeta> 49<refentrytitle>admon.graphics</refentrytitle> 50<refmiscinfo role="type">boolean</refmiscinfo> 51</refmeta><refnamediv> 52<refname>admon.graphics</refname> 53<refpurpose>Use graphics in admonitions?</refpurpose> 54</refnamediv><refsynopsisdiv> 55 56</refsynopsisdiv><refsect1><title>Description</title> 57 58<para>If true (non-zero), admonitions are presented in an alternate style that uses 59a graphic. Default graphics are provided in the distribution. 60</para> 61 62</refsect1> 63</doc:refentry> 64<xsl:param name="admon.graphics" select="0"/> 65 66<doc:refentry><refmeta> 67<refentrytitle>admon.textlabel</refentrytitle> 68<refmiscinfo role="type">boolean</refmiscinfo> 69</refmeta><refnamediv> 70<refname>admon.textlabel</refname> 71<refpurpose>Use text label in admonitions?</refpurpose> 72</refnamediv><refsynopsisdiv> 73 74</refsynopsisdiv><refsect1><title>Description</title> 75 76<para>If true (non-zero), admonitions are presented with a generated 77text label such as Note or Warning in the appropriate language. 78If zero, such labels are turned off, but any title child 79of the admonition element are still output. 80The default value is 1. 81</para> 82 83</refsect1> 84</doc:refentry> 85<xsl:param name="admon.textlabel" select="1"/> 86 87<doc:refentry><refmeta> 88<refentrytitle>admon.style</refentrytitle> 89<refmiscinfo role="type">string</refmiscinfo> 90</refmeta><refnamediv> 91<refname>admon.style</refname> 92<refpurpose>CSS style attributes for admonitions</refpurpose> 93</refnamediv><refsynopsisdiv> 94 95</refsynopsisdiv><refsect1><title>Description</title> 96 97<para>Specifies the value of the <sgmltag class="attribute">STYLE</sgmltag> 98attribute that should be added to admonitions. 99</para> 100 101</refsect1> 102</doc:refentry> 103<xsl:param name="admon.style"> 104 <xsl:text>margin-left: 0.5in; margin-right: 0.5in;</xsl:text> 105</xsl:param> 106 107<doc:refentry><refmeta> 108<refentrytitle>callout.defaultcolumn</refentrytitle> 109<refmiscinfo role="type">integer</refmiscinfo> 110</refmeta><refnamediv> 111<refname>callout.defaultcolumn</refname> 112<refpurpose>Indicates what column callouts appear in by default</refpurpose> 113</refnamediv><refsynopsisdiv> 114 115</refsynopsisdiv><refsect1><title>Description</title> 116 117<para>If a callout does not identify a column (for example, if it uses 118the <literal>linerange</literal> <sgmltag class="attribute">unit</sgmltag>), 119it will appear in the default column. 120</para> 121 122</refsect1> 123</doc:refentry> 124<xsl:param name="callout.defaultcolumn" select="'60'"/> 125 126<doc:refentry><refmeta> 127<refentrytitle>callout.graphics.extension</refentrytitle> 128<refmiscinfo role="type">string</refmiscinfo> 129</refmeta><refnamediv> 130<refname>callout.graphics.extension</refname> 131<refpurpose>Extension for callout graphics</refpurpose> 132</refnamediv><refsynopsisdiv> 133 134</refsynopsisdiv><refsect1><title>Description</title> 135 136<para>Sets the extension to use on callout graphics.</para> 137 138</refsect1> 139</doc:refentry> 140<xsl:param name="callout.graphics.extension" select="'.png'"/> 141 142<doc:refentry><refmeta> 143<refentrytitle>callout.graphics.number.limit</refentrytitle> 144<refmiscinfo role="type">integer</refmiscinfo> 145</refmeta><refnamediv> 146<refname>callout.graphics.number.limit</refname> 147<refpurpose>Number of the largest callout graphic</refpurpose> 148</refnamediv><refsynopsisdiv> 149 150</refsynopsisdiv><refsect1><title>Description</title> 151 152<para>If <parameter>callout.graphics</parameter> 153is non-zero, graphics are used to represent 154callout numbers. The value of 155<parameter>callout.graphics.number.limit</parameter> 156is 157the largest number for which a graphic exists. If the callout number 158exceeds this limit, the default presentation "(nnn)" will always 159be used. 160</para> 161 162</refsect1> 163</doc:refentry> 164<xsl:param name="callout.graphics.number.limit" select="'15'"/> 165 166<doc:refentry><refmeta> 167<refentrytitle>callout.graphics.path</refentrytitle> 168<refmiscinfo role="type">string</refmiscinfo> 169</refmeta><refnamediv> 170<refname>callout.graphics.path</refname> 171<refpurpose>Path to callout graphics</refpurpose> 172</refnamediv><refsynopsisdiv> 173 174</refsynopsisdiv><refsect1><title>Description</title> 175 176<para>Sets the path, probably relative to the directory where the HTML 177files are created, to the callout graphics. 178</para> 179 180</refsect1> 181</doc:refentry> 182<xsl:param name="callout.graphics.path" select="'images/callouts/'"/> 183 184<doc:refentry><refmeta> 185<refentrytitle>callout.graphics</refentrytitle> 186<refmiscinfo role="type">boolean</refmiscinfo> 187</refmeta><refnamediv> 188<refname>callout.graphics</refname> 189<refpurpose>Use graphics for callouts?</refpurpose> 190</refnamediv><refsynopsisdiv> 191 192</refsynopsisdiv><refsect1><title>Description</title> 193 194<para>If non-zero, callouts are presented with graphics (e.g., reverse-video 195circled numbers instead of "(1)", "(2)", etc.). 196Default graphics are provided in the distribution. 197</para> 198 199</refsect1> 200</doc:refentry> 201<xsl:param name="callout.graphics" select="'1'"/> 202 203<doc:refentry><refmeta> 204<refentrytitle>callout.list.table</refentrytitle> 205<refmiscinfo role="type">boolean</refmiscinfo> 206</refmeta><refnamediv> 207<refname>callout.list.table</refname> 208<refpurpose>Present callout lists using a table?</refpurpose> 209</refnamediv><refsynopsisdiv> 210 211</refsynopsisdiv><refsect1><title>Description</title> 212 213<para>The default presentation of <sgmltag>CalloutList</sgmltag>s uses 214an HTML <sgmltag>DL</sgmltag>. Some browsers don't align DLs very well 215if <parameter>callout.graphics</parameter> are used. With this option 216turned on, <sgmltag>CalloutList</sgmltag>s are presented in an HTML 217<sgmltag>TABLE</sgmltag>, which usually results in better alignment 218of the callout number with the callout description.</para> 219 220</refsect1> 221</doc:refentry> 222<xsl:param name="callout.list.table" select="'1'"/> 223 224<doc:refentry><refmeta> 225<refentrytitle>callout.unicode.number.limit</refentrytitle> 226<refmiscinfo role="type">integer</refmiscinfo> 227</refmeta><refnamediv> 228<refname>callout.unicode.number.limit</refname> 229<refpurpose>Number of the largest callout graphic</refpurpose> 230</refnamediv><refsynopsisdiv> 231 232</refsynopsisdiv><refsect1><title>Description</title> 233 234<para>If <parameter>callout.unicode</parameter> 235is non-zero, unicode characters are used to represent 236callout numbers. The value of 237<parameter>callout.unicode.number.limit</parameter> 238is 239the largest number for which a unicode character exists. If the callout number 240exceeds this limit, the default presentation "(nnn)" will always 241be used. 242</para> 243 244</refsect1> 245</doc:refentry> 246<xsl:param name="callout.unicode.number.limit" select="'10'"/> 247 248<doc:refentry><refmeta> 249<refentrytitle>callout.unicode.start.character</refentrytitle> 250<refmiscinfo role="type">integer</refmiscinfo> 251</refmeta><refnamediv> 252<refname>callout.unicode.start.character</refname> 253<refpurpose>First Unicode character to use, decimal value.</refpurpose> 254</refnamediv><refsynopsisdiv> 255 256</refsynopsisdiv><refsect1><title>Description</title> 257 258<para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter> 259is non-zero, unicode characters are used to represent 260callout numbers. The value of 261<parameter>callout.unicode.start.character</parameter> 262is the decimal unicode value used for callout number one. Currently, 263only 10102 is supported in the stylesheets for this parameter. 264</para> 265 266</refsect1> 267</doc:refentry> 268<xsl:param name="callout.unicode.start.character" select="10102"/> 269 270<doc:refentry><refmeta> 271<refentrytitle>callout.unicode</refentrytitle> 272<refmiscinfo role="type">boolean</refmiscinfo> 273</refmeta><refnamediv> 274<refname>callout.unicode</refname> 275<refpurpose>Use Unicode characters rather than images for callouts.</refpurpose> 276</refnamediv><refsynopsisdiv> 277 278</refsynopsisdiv><refsect1><title>Description</title> 279 280<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. 281</para> 282 283</refsect1> 284</doc:refentry> 285<xsl:param name="callout.unicode" select="0"/> 286 287<doc:refentry><refmeta> 288<refentrytitle>callouts.extension</refentrytitle> 289<refmiscinfo role="type">boolean</refmiscinfo> 290</refmeta><refnamediv> 291<refname>callouts.extension</refname> 292<refpurpose>Enable the callout extension</refpurpose> 293</refnamediv><refsynopsisdiv> 294 295</refsynopsisdiv><refsect1><title>Description</title> 296 297<para>The callouts extension processes <sgmltag>areaset</sgmltag> 298elements in <sgmltag>ProgramListingCO</sgmltag> and other text-based 299callout elements. 300</para> 301 302</refsect1> 303</doc:refentry> 304<xsl:param name="callouts.extension" select="'1'"/> 305 306<doc:refentry><refmeta> 307<refentrytitle>ebnf.table.bgcolor</refentrytitle> 308<refmiscinfo role="type">string</refmiscinfo> 309</refmeta><refnamediv> 310<refname>ebnf.table.bgcolor</refname> 311<refpurpose>Background color for EBNF tables</refpurpose> 312</refnamediv><refsynopsisdiv> 313 314</refsynopsisdiv><refsect1><title>Description</title> 315 316<para>Sets the background color for EBNF tables. No <sgmltag>bgcolor</sgmltag> 317attribute is output if <varname>ebnf.table.bgcolor</varname> is set to 318the null string. The default value matches the value used in recent 319online versions of the W3C's XML Spec productions.</para> 320 321</refsect1> 322</doc:refentry> 323<xsl:param name="ebnf.table.bgcolor" select="'#F5DCB3'"/> 324 325<doc:refentry><refmeta> 326<refentrytitle>ebnf.table.border</refentrytitle> 327<refmiscinfo role="type"/> 328</refmeta><refnamediv> 329<refname>ebnf.table.border</refname> 330<refpurpose>Selects border on EBNF tables</refpurpose> 331</refnamediv><refsynopsisdiv> 332 333</refsynopsisdiv><refsect1><title>Description</title> 334 335<para>Selects the border on EBNF tables. If non-zero, the tables have 336borders, otherwise they don't.</para> 337 338</refsect1> 339</doc:refentry> 340<xsl:param name="ebnf.table.border" select="1"/> 341 342<doc:refentry><refmeta> 343<refentrytitle>ebnf.assignment</refentrytitle> 344<refmiscinfo role="type">rtf</refmiscinfo> 345</refmeta><refnamediv> 346<refname>ebnf.assignment</refname> 347<refpurpose>The EBNF production assignment operator</refpurpose> 348</refnamediv><refsynopsisdiv> 349 350</refsynopsisdiv><refsect1><title>Description</title> 351 352<para>The <parameter>ebnf.assignment</parameter> parameter determines what 353text is used to show <quote>assignment</quote> in <sgmltag>production</sgmltag>s 354in <sgmltag>productionset</sgmltag>s.</para> 355 356<para>While <quote><literal>::=</literal></quote> is common, so are several 357other operators.</para> 358 359</refsect1> 360</doc:refentry> 361<xsl:param name="ebnf.assignment"> 362<code>::=</code> 363</xsl:param> 364 365 366<doc:refentry><refmeta> 367<refentrytitle>ebnf.statement.terminator</refentrytitle> 368<refmiscinfo role="type">rtf</refmiscinfo> 369</refmeta><refnamediv> 370<refname>ebnf.statement.terminator</refname> 371<refpurpose>Punctuation that ends an EBNF statement.</refpurpose> 372</refnamediv><refsynopsisdiv> 373 374</refsynopsisdiv><refsect1><title>Description</title> 375 376<para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what 377text is used to terminate each <sgmltag>production</sgmltag> 378in <sgmltag>productionset</sgmltag>.</para> 379 380<para>Some notations end each statement with a period.</para> 381 382</refsect1> 383</doc:refentry> 384<xsl:param name="ebnf.statement.terminator"/> 385 386 387<doc:refentry><refmeta> 388<refentrytitle>annotate.toc</refentrytitle> 389<refmiscinfo role="type">boolean</refmiscinfo> 390</refmeta><refnamediv> 391<refname>annotate.toc</refname> 392<refpurpose>Annotate the Table of Contents?</refpurpose> 393</refnamediv><refsynopsisdiv> 394 395</refsynopsisdiv><refsect1><title>Description</title> 396 397<para>If true, TOCs will be annotated. At present, this just means 398that the <sgmltag>RefPurpose</sgmltag> of <sgmltag>RefEntry</sgmltag> 399TOC entries will be displayed. 400</para> 401 402</refsect1> 403</doc:refentry> 404<xsl:param name="annotate.toc" select="1"/> 405 406<doc:refentry><refmeta> 407<refentrytitle>autotoc.label.separator</refentrytitle> 408<refmiscinfo role="type">string</refmiscinfo> 409</refmeta><refnamediv> 410<refname>autotoc.label.separator</refname> 411<refpurpose>Separator between labels and titles in the ToC</refpurpose> 412</refnamediv><refsynopsisdiv> 413 414</refsynopsisdiv><refsect1><title>Description</title> 415 416<para>String to use to seperate labels and title in a table of contents.</para> 417 418</refsect1> 419</doc:refentry> 420<xsl:param name="autotoc.label.separator" select="'. '"/> 421 422<doc:refentry><refmeta> 423<refentrytitle>autotoc.label.in.hyperlink</refentrytitle> 424<refmiscinfo role="type">boolean</refmiscinfo> 425</refmeta><refnamediv> 426<refname>autotoc.label.in.hyperlink</refname> 427<refpurpose>Include lable in hyperlinked titles in TOC?</refpurpose> 428</refnamediv><refsynopsisdiv> 429 430</refsynopsisdiv><refsect1><title>Description</title> 431 432<para>If the value of 433<parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels 434are included in hyperlinked titles in the TOC. If it is instead zero, 435labels are still displayed prior to the hyperlinked titles, but 436are not hyperlinked along with the titles.</para> 437 438</refsect1> 439</doc:refentry> 440<xsl:param name="autotoc.label.in.hyperlink" select="1"/> 441 442<doc:refentry><refmeta> 443<refentrytitle>process.source.toc</refentrytitle> 444<refmiscinfo role="type">boolean</refmiscinfo> 445</refmeta><refnamediv> 446<refname>process.source.toc</refname> 447<refpurpose>Process a non-empty <sgmltag>toc</sgmltag> element if it occurs in a source document?</refpurpose> 448</refnamediv><refsynopsisdiv> 449 450</refsynopsisdiv><refsect1><title>Description</title> 451 452<para>Specifies that the contents of a non-empty "hard-coded" 453<sgmltag>toc</sgmltag> element in a source document are processed to 454generate a TOC in output. 455<note> 456 <para>This parameter has no effect on automated generation of 457 TOCs. An automated TOC may still be generated along with the 458 "hard-coded" TOC. To suppress automated TOC generation, adjust the 459 value of the <parameter>generate.toc</parameter> paramameter.</para> 460 461 <para>The <sgmltag>process.source.toc</sgmltag> parameter also has 462 no effect if the <sgmltag>toc</sgmltag> element is empty; handling 463 for empty <sgmltag>toc</sgmltag> is controlled by the 464 <parameter>process.empty.source.toc</parameter> parameter.</para> 465</note> 466</para> 467 468</refsect1> 469</doc:refentry> 470<xsl:param name="process.source.toc" select="0"/> 471 472<doc:refentry><refmeta> 473<refentrytitle>process.empty.source.toc</refentrytitle> 474<refmiscinfo role="type">boolean</refmiscinfo> 475</refmeta><refnamediv> 476<refname>process.empty.source.toc</refname> 477<refpurpose>Generate automated TOC if <sgmltag>toc</sgmltag> element occurs in a source document?</refpurpose> 478</refnamediv><refsynopsisdiv> 479 480</refsynopsisdiv><refsect1><title>Description</title> 481 482<para>Specifies that if an empty <sgmltag>toc</sgmltag> element is 483found in a source document, an automated TOC is generated. 484<note> 485 <para>Depending on what the value of the 486 <parameter>generate.toc</parameter> parameter is, setting this 487 parameter to <literal>1</literal> could result in generation of 488 duplicate automated TOCs. So the 489 <parameter>process.empty.source.toc</parameter> is primarily useful 490 as an "override": by placing an empty <sgmltag>toc</sgmltag> in your 491 document and setting this parameter to <literal>1</literal>, you can 492 force a TOC to be generated even if <sgmltag>generate.toc</sgmltag> 493 says not to.</para> 494</note> 495</para> 496 497</refsect1> 498</doc:refentry> 499<xsl:param name="process.empty.source.toc" select="0"/> 500 501<doc:refentry><refmeta> 502<refentrytitle>bridgehead.in.toc</refentrytitle> 503<refmiscinfo role="type">boolean</refmiscinfo> 504</refmeta><refnamediv> 505<refname>bridgehead.in.toc</refname> 506<refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> 507</refnamediv><refsynopsisdiv> 508 509</refsynopsisdiv><refsect1><title>Description</title> 510 511<para>If non-zero, bridgeheads appear in the TOC. Note that this option 512is not fully supported and may be removed in a future version of the 513stylesheets. 514</para> 515 516</refsect1> 517</doc:refentry> 518<xsl:param name="bridgehead.in.toc" select="0"/> 519 520<doc:refentry><refmeta> 521<refentrytitle>simplesect.in.toc</refentrytitle> 522<refmiscinfo role="type">boolean</refmiscinfo> 523</refmeta><refnamediv> 524<refname>simplesect.in.toc</refname> 525<refpurpose>Should <sgmltag>simplesect</sgmltag> elements appear in the TOC?</refpurpose> 526</refnamediv><refsynopsisdiv> 527 528</refsynopsisdiv><refsect1><title>Description</title> 529 530<para>If non-zero, <sgmltag>simplesect</sgmltag>s appear in the TOC. 531</para> 532 533</refsect1> 534</doc:refentry> 535<xsl:param name="simplesect.in.toc" select="0"/> 536 537<doc:refentry><refmeta> 538<refentrytitle>manual.toc</refentrytitle> 539<refmiscinfo role="type">string</refmiscinfo> 540</refmeta><refnamediv> 541<refname>manual.toc</refname> 542<refpurpose>An explicit TOC to be used for the TOC</refpurpose> 543</refnamediv><refsynopsisdiv> 544 545</refsynopsisdiv><refsect1><title>Description</title> 546 547<para>The <parameter>manual.toc</parameter> identifies an explicit TOC that 548will be used for building the printed TOC. 549</para> 550 551</refsect1> 552</doc:refentry> 553<xsl:param name="manual.toc" select="''"/> 554 555<doc:refentry><refmeta> 556<refentrytitle>toc.list.type</refentrytitle> 557<refmiscinfo role="type">list</refmiscinfo> 558<refmiscinfo role="value">dl</refmiscinfo> 559<refmiscinfo role="value">ul</refmiscinfo> 560<refmiscinfo role="value">ol</refmiscinfo> 561</refmeta><refnamediv> 562<refname>toc.list.type</refname> 563<refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> 564</refnamediv><refsynopsisdiv> 565 566</refsynopsisdiv><refsect1><title>Description</title> 567 568<para>When an automatically generated Table of Contents (or List of Titles) 569is produced, this HTML element will be used to make the list. 570</para> 571 572</refsect1> 573</doc:refentry> 574<xsl:param name="toc.list.type">dl</xsl:param> 575 576<doc:refentry><refmeta> 577<refentrytitle>toc.section.depth</refentrytitle> 578<refmiscinfo role="type">integer</refmiscinfo> 579</refmeta><refnamediv> 580<refname>toc.section.depth</refname> 581<refpurpose>How deep should recursive <sgmltag>section</sgmltag>s appear 582in the TOC?</refpurpose> 583</refnamediv><refsynopsisdiv> 584 585</refsynopsisdiv><refsect1><title>Description</title> 586 587<para>Specifies the depth to which recursive sections should appear in the 588TOC. 589</para> 590 591</refsect1> 592</doc:refentry> 593<xsl:param name="toc.section.depth">2</xsl:param> 594 595<doc:refentry><refmeta> 596<refentrytitle>toc.max.depth</refentrytitle> 597<refmiscinfo role="type">integer</refmiscinfo> 598</refmeta><refnamediv> 599<refname>toc.max.depth</refname> 600<refpurpose>How maximaly deep should be each TOC?</refpurpose> 601</refnamediv><refsynopsisdiv> 602 603</refsynopsisdiv><refsect1><title>Description</title> 604 605<para>Specifies the maximal depth of TOC on all levels.</para> 606 607</refsect1> 608</doc:refentry> 609<xsl:param name="toc.max.depth">8</xsl:param> 610 611<doc:refentry><refmeta> 612<refentrytitle>generate.toc</refentrytitle> 613<refmiscinfo role="type">table</refmiscinfo> 614</refmeta><refnamediv> 615<refname>generate.toc</refname> 616<refpurpose>Control generation of ToCs and LoTs</refpurpose> 617</refnamediv><refsynopsisdiv> 618 619</refsynopsisdiv><refsect1><title>Description</title> 620 621<para>This parameter has a structured value. It is a table of space-delimited 622path/value pairs. Each path identifies some element in the source document 623using a restricted subset of XPath (only the implicit child axis, no wildcards, 624no predicates). Paths can be either relative or absolute.</para> 625 626<para>When processing a particular element, the stylesheets consult this table to 627determine if a ToC (or LoT(s)) should be generated.</para> 628 629<para>For example, consider the entry:</para> 630 631<screen>book toc,figure</screen> 632 633<para>This indicates that whenever a <sgmltag>book</sgmltag> is formatted, a 634Table Of Contents and a List of Figures should be generated. Similarly,</para> 635 636<screen>/chapter toc</screen> 637 638<para>indicates that whenever a document <emphasis>that has a root 639of</emphasis> <sgmltag>chapter</sgmltag> is formatted, a Table of 640Contents should be generated. The entry <literal>chapter</literal> would match 641all chapters, but <literal>/chapter</literal> matches only <sgmltag>chapter</sgmltag> 642document elements.</para> 643 644<para>Generally, the longest match wins. So, for example, if you want to distinguish 645articles in books from articles in parts, you could use these two entries:</para> 646 647<screen>book/article toc,figure 648part/article toc</screen> 649 650<para>Note that an article in a part can never match a <literal>book/article</literal>, 651so if you want nothing to be generated for articles in parts, you can simply leave 652that rule out.</para> 653 654<para>If you want to leave the rule in, to make it explicit that you're turning 655something off, use the value <quote>nop</quote>. For example, the following 656entry disables ToCs and LoTs for articles:</para> 657 658<screen>article nop</screen> 659 660<para>Do not simply leave the word <quote>article</quote> in the file 661without a matching value. That'd be just begging the silly little 662path/value parser to get confused.</para> 663 664<para>Section ToCs are further controlled by the 665<parameter>generate.section.toc.level</parameter> parameter. 666For a given section level to have a ToC, it must have both an entry in 667<parameter>generate.toc</parameter> and be within the range enabled by 668<parameter>generate.section.toc.level</parameter>.</para> 669</refsect1> 670</doc:refentry> 671<xsl:param name="generate.toc"> 672appendix toc,title 673article/appendix nop 674article toc,title 675book toc,title,figure,table,example,equation 676chapter toc,title 677part toc,title 678preface toc,title 679qandadiv toc 680qandaset toc 681reference toc,title 682sect1 toc 683sect2 toc 684sect3 toc 685sect4 toc 686sect5 toc 687section toc 688set toc,title 689</xsl:param> 690 691 692<doc:refentry><refmeta> 693<refentrytitle>generate.section.toc.level</refentrytitle> 694<refmiscinfo role="type">integer</refmiscinfo> 695</refmeta><refnamediv> 696<refname>generate.section.toc.level</refname> 697<refpurpose>Control depth of TOC generation in sections</refpurpose> 698</refnamediv><refsynopsisdiv> 699 700</refsynopsisdiv><refsect1><title>Description</title> 701 702<para>The <parameter>generate.section.toc.level</parameter> parameter 703controls the depth of section in which TOCs will be generated. Note 704that this is related to, but not the same as 705<parameter>toc.section.depth</parameter>, which controls the depth to 706which TOC entries will be generated in a given TOC.</para> 707<para>If, for example, <parameter>generate.section.toc.level</parameter> 708is <literal>3</literal>, TOCs will be generated in first, second, and third 709level sections, but not in fourth level sections. 710</para> 711 712</refsect1> 713</doc:refentry> 714<xsl:param name="generate.section.toc.level" select="0"/> 715 716<doc:refentry><refmeta> 717<refentrytitle>generate.index</refentrytitle> 718<refmiscinfo role="type">boolean</refmiscinfo> 719</refmeta><refnamediv> 720<refname>generate.index</refname> 721<refpurpose>Do you want an index?</refpurpose> 722</refnamediv><refsynopsisdiv> 723 724</refsynopsisdiv><refsect1><title>Description</title> 725 726<para>Specify if an index should be generated. </para> 727 728</refsect1> 729</doc:refentry> 730<xsl:param name="generate.index" select="1"/> 731 732<doc:refentry><refmeta> 733<refentrytitle>index.method</refentrytitle> 734<refmiscinfo role="type">string</refmiscinfo> 735</refmeta><refnamediv> 736<refname>index.method</refname> 737<refpurpose>Select method used to group index entries in an index</refpurpose> 738</refnamediv><refsynopsisdiv> 739 740</refsynopsisdiv><refsect1><title>Description</title> 741 742<para>This parameter lets you select which method should be 743used to sort and group index entries in an index. 744Indexes in languages that have accented characters typically 745sort together accented words and unaccented words. 746So <quote>��</quote> (A acute) would sort together 747with <quote>A</quote>, so both would appear in the <quote>A</quote> 748section of the index. 749</para> 750 751<para>The default indexing method does not sort accented characters this way. 752Words that start with an accented character will instead appear in the 753<quote>Symbols</quote> section of the index. 754As such, the default method is only suitable for 755English and other unaccented languages. 756The other indexing methods require extensions of one type or 757another, which is why there are not used by default.</para> 758 759<para>The three choices for indexing method are:</para> 760<variablelist> 761<varlistentry> 762<term><literal>english</literal></term> 763<listitem> 764<para> 765(default) Sort and groups words based only on the Latin alphabet. 766Accented words and words in non-Latin alphabets will be 767put in the <quote>Symbols</quote> section of the index. 768</para> 769</listitem> 770</varlistentry> 771<varlistentry> 772<term><literal>kosek</literal></term> 773<listitem> 774<para> 775Sort and groups words based on letter groups configured in 776the DocBook locale file for the given language. 777For example, the French locale file is <filename>common/fr.xml</filename>. 778This method requires support for EXSLT extensions in 779the XSL processor. It also requires support for using 780user-defined functions in xsl:key (xsltproc does not). 781</para> 782<para>This method is suitable for any language for which you can 783list all the individual characters that should appear 784in each letter group in an index. 785It is probably not practical to use it for ideographic languages 786such as Chinese that have hundreds or thousands of characters. 787</para> 788<para>To use this method, your customization must set this 789parameter and import an additional stylesheet module:</para> 790<programlisting><xsl:import href="[path-to-stylesheets]/common/autoidx-ng.xsl"/> 791<xsl:param name="index.method">kosek</xsl:param> 792 793</programlisting> 794<para>The stylesheet module defines functions and adds an xsl:key 795used by the method. 796</para> 797</listitem> 798</varlistentry> 799<varlistentry> 800<term><literal>kimber</literal></term> 801<listitem> 802<para> 803This method uses extensions to the Saxon processor to implement 804sophisticated indexing processes. It uses its own 805configuration file, which can include information for any number of 806languages. Each language's configuration can group 807words using either an 808enumerated method similar to the kosek method, or it can 809designate the first character in each group when viewed in sort order. 810The latter configuration is useful for ideographic languages 811such as Chinese, Japanese, and Korean. 812You can also define your own collation algorithms and where you 813want Latin-alphabet words sorted.</para> 814<itemizedlist> 815<listitem> 816<para>For a whitepaper describing the extensions, see: 817<ulink url="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf"/>. 818</para> 819</listitem> 820<listitem> 821<para>To download the extension library, see 822<ulink url="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport"/>. 823</para> 824</listitem> 825</itemizedlist> 826 827<para>To use this method, you must:</para> 828 829<orderedlist> 830<listitem> 831<para>Use Saxon as your XSLT processor. 832</para> 833</listitem> 834<listitem> 835<para>Install and configure the Innodata Isogen library, using 836the documentation that comes with it. 837</para> 838</listitem> 839<listitem> 840<para>Set this parameter's value to <quote>kimber</quote>. 841</para> 842</listitem> 843<listitem> 844<para>Import the index extensions stylesheet module 845<filename>common/autoidx-ng.xsl</filename> into your 846customization. 847</para> 848</listitem> 849</orderedlist> 850 851</listitem> 852</varlistentry> 853</variablelist> 854 855</refsect1> 856</doc:refentry> 857<xsl:param name="index.method" select="'english'"/> 858 859<doc:refentry><refmeta> 860<refentrytitle>index.on.type</refentrytitle> 861<refmiscinfo role="type">boolean</refmiscinfo> 862</refmeta><refnamediv> 863<refname>index.on.type</refname> 864<refpurpose>Select indexterms based on <sgmltag>type</sgmltag> 865attribute value</refpurpose> 866</refnamediv><refsynopsisdiv> 867 868</refsynopsisdiv><refsect1><title>Description</title> 869 870<para> 871If non-zero, 872then an <sgmltag>index</sgmltag> element that has a 873<sgmltag>type</sgmltag> attribute 874value will contain only those <sgmltag>indexterm</sgmltag> 875elements with a matching <sgmltag>type</sgmltag> attribute value. 876If an <sgmltag>index</sgmltag> has no <sgmltag>type</sgmltag> 877attribute or it is blank, then the index will contain 878all <sgmltag>indexterm</sgmltag>s in the current scope. 879</para> 880 881<para> 882If <literal>index.on.type</literal> is zero, then the 883<sgmltag>type</sgmltag> attribute has no effect 884on selecting indexterms for an index. 885</para> 886 887<para>For those using DocBook version 4.2 or earlier, 888the <sgmltag>type</sgmltag> attribute is not available 889for index terms. However, you can achieve the same 890effect by using the <sgmltag>role</sgmltag> attribute 891in the same manner on <sgmltag>indexterm</sgmltag> 892and <sgmltag>index</sgmltag>, and setting the stylesheet parameter 893<parameter>index.on.role</parameter> to a nonzero value. 894</para> 895 896</refsect1> 897</doc:refentry> 898<xsl:param name="index.on.type" select="0"/> 899 900<doc:refentry><refmeta> 901<refentrytitle>index.on.role</refentrytitle> 902<refmiscinfo role="type">boolean</refmiscinfo> 903</refmeta><refnamediv> 904<refname>index.on.role</refname> 905<refpurpose>Select indexterms based on role value</refpurpose> 906</refnamediv><refsynopsisdiv> 907 908</refsynopsisdiv><refsect1><title>Description</title> 909 910<para> 911If non-zero, 912then an <sgmltag>index</sgmltag> element that has a 913<sgmltag>role</sgmltag> attribute 914value will contain only those <sgmltag>indexterm</sgmltag> 915elements with a matching role value. 916If an <sgmltag>index</sgmltag> has no <sgmltag>role</sgmltag> 917attribute or it is blank, then the index will contain 918all <sgmltag>indexterm</sgmltag>s in the current scope. 919</para> 920<para> 921If <literal>index.on.role</literal> is zero, then the 922<sgmltag>role</sgmltag> attribute has no effect 923on selecting indexterms for an index. 924</para> 925 926<para>If you are using DocBook version 4.3 or later, you should 927use the <sgmltag>type</sgmltag> attribute instead of <sgmltag>role</sgmltag> 928on <sgmltag>indexterm</sgmltag> and <sgmltag>index</sgmltag>, 929and set the <parameter>index.on.type</parameter> to a nonzero 930value. 931</para> 932 933</refsect1> 934</doc:refentry> 935<xsl:param name="index.on.role" select="0"/> 936 937<doc:refentry><refmeta> 938<refentrytitle>index.prefer.titleabbrev</refentrytitle> 939<refmiscinfo role="type">boolean</refmiscinfo> 940</refmeta><refnamediv> 941<refname>index.prefer.titleabbrev</refname> 942<refpurpose>Should be abbreviated titles used as back references</refpurpose> 943</refnamediv><refsynopsisdiv> 944 945</refsynopsisdiv><refsect1><title>Description</title> 946 947<para>FIXME: 948</para> 949 950</refsect1> 951</doc:refentry> 952<xsl:param name="index.prefer.titleabbrev" select="0"/> 953 954<doc:refentry><refmeta> 955<refentrytitle>index.term.separator</refentrytitle> 956<refmiscinfo role="type">string</refmiscinfo> 957</refmeta><refnamediv> 958<refname>index.term.separator</refname> 959<refpurpose>Override for punctuation separating an index term 960from its list of page references in an index</refpurpose> 961</refnamediv><refsynopsisdiv> 962 963</refsynopsisdiv><refsect1><title>Description</title> 964 965<para>This parameter permits you to override 966the text to insert between 967the end of an index term and its list of page references. 968Typically that might be a comma and a space. 969</para> 970 971<para>Because this text may be locale dependent, 972this parameter's value is normally taken from a gentext 973template named 'term-separator' in the 974context 'index' in the stylesheet 975locale file for the language 976of the current document. 977This parameter can be used to override the gentext string, 978and would typically be used on the command line. 979This parameter would apply to all languages. 980</para> 981 982<para>So this text string can be customized in two ways. 983You can reset the default gentext string using 984the <parameter>local.l10n.xml</parameter> parameter, or you can 985fill in the content for this normally empty 986override parameter. 987The content can be a simple string, or it can be 988something more complex such as a call-template. 989For fo output, it could be an <sgmltag>fo:leader</sgmltag> 990element to provide space of a specific length, or a dot leader. 991</para> 992 993</refsect1> 994</doc:refentry> 995<xsl:param name="index.term.separator" select="''"/> 996 997<doc:refentry><refmeta> 998<refentrytitle>index.number.separator</refentrytitle> 999<refmiscinfo role="type">string</refmiscinfo> 1000</refmeta><refnamediv> 1001<refname>index.number.separator</refname> 1002<refpurpose>Override for punctuation separating page numbers in index</refpurpose> 1003</refnamediv><refsynopsisdiv> 1004 1005</refsynopsisdiv><refsect1><title>Description</title> 1006 1007<para>This parameter permits you to override the text to insert between 1008page references in a formatted index entry. Typically 1009that would be a comma and a space. 1010</para> 1011 1012<para>Because this text may be locale dependent, 1013this parameter's value is normally taken from a gentext 1014template named 'number-separator' in the 1015context 'index' in the stylesheet 1016locale file for the language 1017of the current document. 1018This parameter can be used to override the gentext string, 1019and would typically be used on the command line. 1020This parameter would apply to all languages. 1021</para> 1022 1023<para>So this text string can be customized in two ways. 1024You can reset the default gentext string using 1025the <parameter>local.l10n.xml</parameter> parameter, or you can 1026override the gentext with the content of this parameter. 1027The content can be a simple string, or it can be 1028something more complex such as a call-template. 1029</para> 1030 1031<para>In HTML index output, section title references are used instead of 1032page number references. This punctuation appears between 1033such section titles in an HTML index. 1034</para> 1035 1036</refsect1> 1037</doc:refentry> 1038<xsl:param name="index.number.separator" select="''"/> 1039 1040<doc:refentry><refmeta> 1041<refentrytitle>index.range.separator</refentrytitle> 1042<refmiscinfo role="type">string</refmiscinfo> 1043</refmeta><refnamediv> 1044<refname>index.range.separator</refname> 1045<refpurpose>Override for punctuation separating the two numbers 1046in a page range in index</refpurpose> 1047</refnamediv><refsynopsisdiv> 1048 1049</refsynopsisdiv><refsect1><title>Description</title> 1050 1051<para>This parameter permits you 1052to override the text to insert between 1053the two numbers of a page range in an index. 1054This parameter is only used by those XSL-FO processors 1055that support an extension for generating such page ranges 1056(such as XEP).</para> 1057 1058<para>Because this text may be locale dependent, 1059this parameter's value is normally taken from a gentext 1060template named 'range-separator' in the 1061context 'index' in the stylesheet 1062locale file for the language 1063of the current document. 1064This parameter can be used to override the gentext string, 1065and would typically be used on the command line. 1066This parameter would apply to all languages. 1067</para> 1068 1069<para>So this text string can be customized in two ways. 1070You can reset the default gentext string using 1071the <parameter>local.l10n.xml</parameter> parameter, or you can 1072override the gentext with the content of this parameter. 1073The content can be a simple string, or it can be 1074something more complex such as a call-template. 1075</para> 1076 1077<para>In HTML index output, section title references are used instead of 1078page number references. So there are no page ranges 1079and this parameter has no effect. 1080</para> 1081 1082</refsect1> 1083</doc:refentry> 1084<xsl:param name="index.range.separator" select="''"/> 1085 1086<doc:refentry><refmeta> 1087<refentrytitle>linenumbering.everyNth</refentrytitle> 1088<refmiscinfo role="type">integer</refmiscinfo> 1089</refmeta><refnamediv> 1090<refname>linenumbering.everyNth</refname> 1091<refpurpose>Indicate which lines should be numbered</refpurpose> 1092</refnamediv><refsynopsisdiv> 1093 1094</refsynopsisdiv><refsect1><title>Description</title> 1095 1096<para>If line numbering is enabled, everyNth line will be numbered. 1097</para> 1098 1099</refsect1> 1100</doc:refentry> 1101<xsl:param name="linenumbering.everyNth" select="'5'"/> 1102 1103<doc:refentry><refmeta> 1104<refentrytitle>linenumbering.extension</refentrytitle> 1105<refmiscinfo role="type">boolean</refmiscinfo> 1106</refmeta><refnamediv> 1107<refname>linenumbering.extension</refname> 1108<refpurpose>Enable the line numbering extension</refpurpose> 1109</refnamediv><refsynopsisdiv> 1110 1111</refsynopsisdiv><refsect1><title>Description</title> 1112 1113<para>If true, verbatim environments (elements that have the 1114format='linespecific' notation attribute: address, literallayout, 1115programlisting, screen, synopsis) that specify line numbering will 1116have, surprise, line numbers. 1117</para> 1118 1119</refsect1> 1120</doc:refentry> 1121<xsl:param name="linenumbering.extension" select="'1'"/> 1122 1123<doc:refentry><refmeta> 1124<refentrytitle>linenumbering.separator</refentrytitle> 1125<refmiscinfo role="type">string</refmiscinfo> 1126</refmeta><refnamediv> 1127<refname>linenumbering.separator</refname> 1128<refpurpose>Specify a separator between line numbers and lines</refpurpose> 1129</refnamediv><refsynopsisdiv> 1130 1131</refsynopsisdiv><refsect1><title>Description</title> 1132 1133<para>The separator is inserted between line numbers and lines in 1134the verbatim environment. 1135</para> 1136 1137</refsect1> 1138</doc:refentry> 1139<xsl:param name="linenumbering.separator" select="' '"/> 1140 1141<doc:refentry><refmeta> 1142<refentrytitle>linenumbering.width</refentrytitle> 1143<refmiscinfo role="type">integer</refmiscinfo> 1144</refmeta><refnamediv> 1145<refname>linenumbering.width</refname> 1146<refpurpose>Indicates the width of line numbers</refpurpose> 1147</refnamediv><refsynopsisdiv> 1148 1149</refsynopsisdiv><refsect1><title>Description</title> 1150 1151<para>If line numbering is enabled, line numbers will appear right 1152justified in a field "width" characters wide. 1153</para> 1154 1155</refsect1> 1156</doc:refentry> 1157<xsl:param name="linenumbering.width" select="'3'"/> 1158 1159<doc:refentry><refmeta> 1160<refentrytitle>tablecolumns.extension</refentrytitle> 1161<refmiscinfo role="type">boolean</refmiscinfo> 1162</refmeta><refnamediv> 1163<refname>tablecolumns.extension</refname> 1164<refpurpose>Enable the table columns extension function</refpurpose> 1165</refnamediv><refsynopsisdiv> 1166 1167</refsynopsisdiv><refsect1><title>Description</title> 1168 1169<para>The table columns extension function adjusts the widths of table 1170columns in the HTML result to more accurately reflect the specifications 1171in the CALS table. 1172</para> 1173 1174</refsect1> 1175</doc:refentry> 1176<xsl:param name="tablecolumns.extension" select="'1'"/> 1177 1178<doc:refentry><refmeta> 1179<refentrytitle>textinsert.extension</refentrytitle> 1180<refmiscinfo role="type">boolean</refmiscinfo> 1181</refmeta><refnamediv> 1182<refname>textinsert.extension</refname> 1183<refpurpose>Enable the textinsert extension element</refpurpose> 1184</refnamediv><refsynopsisdiv> 1185 1186</refsynopsisdiv><refsect1><title>Description</title> 1187 1188<para>The textinsert extension element inserts the contents of a 1189a file into the result tree (as text). 1190</para> 1191 1192</refsect1> 1193</doc:refentry> 1194<xsl:param name="textinsert.extension" select="'1'"/> 1195 1196<doc:refentry><refmeta> 1197<refentrytitle>textdata.default.encoding</refentrytitle> 1198<refmiscinfo role="type">string</refmiscinfo> 1199</refmeta><refnamediv> 1200<refname>textdata.default.encoding</refname> 1201<refpurpose>Default encoding of external text files which are included 1202using textdata element</refpurpose> 1203</refnamediv><refsynopsisdiv> 1204 1205</refsynopsisdiv><refsect1><title>Description</title> 1206 1207<para>Default encoding of external text files which are included using 1208textdata element. This value is used only when you do not specify 1209encoding by appropriate attribute directly on textdata. Default 1210encoding (empty string) is interpreted as system default 1211encoding.</para> 1212 1213</refsect1> 1214</doc:refentry> 1215<xsl:param name="textdata.default.encoding" select="''"/> 1216 1217<doc:refentry><refmeta> 1218<refentrytitle>graphicsize.extension</refentrytitle> 1219<refmiscinfo role="type">boolean</refmiscinfo> 1220</refmeta><refnamediv> 1221<refname>graphicsize.extension</refname> 1222<refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose> 1223</refnamediv><refsynopsisdiv> 1224 1225</refsynopsisdiv><refsect1><title>Description</title> 1226 1227<para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero 1228and if you're using a processor that supports extension functions), the 1229<function>getWidth</function> and <function>getDepth</function> functions 1230will be used to extract image sizes from graphics.</para> 1231 1232</refsect1> 1233</doc:refentry> 1234<xsl:param name="graphicsize.extension" select="1"/> 1235 1236<doc:refentry><refmeta> 1237<refentrytitle>graphicsize.use.img.src.path</refentrytitle> 1238<refmiscinfo role="type">boolean</refmiscinfo> 1239</refmeta><refnamediv> 1240<refname>graphicsize.use.img.src.path</refname> 1241<refpurpose>Prepend <parameter>img.src.path</parameter> before 1242filenames passed to extension functions</refpurpose> 1243</refnamediv><refsynopsisdiv> 1244 1245</refsynopsisdiv><refsect1><title>Description</title> 1246 1247<para>If non-zero <parameter>img.src.path</parameter> parameter will 1248be appended before filenames passed to extension functions for 1249measuring image dimensions.</para> 1250 1251</refsect1> 1252</doc:refentry> 1253<xsl:param name="graphicsize.use.img.src.path" select="0"/> 1254 1255<doc:refentry><refmeta> 1256<refentrytitle>use.extensions</refentrytitle> 1257<refmiscinfo role="type">boolean</refmiscinfo> 1258</refmeta><refnamediv> 1259<refname>use.extensions</refname> 1260<refpurpose>Enable extensions</refpurpose> 1261</refnamediv><refsynopsisdiv> 1262 1263</refsynopsisdiv><refsect1><title>Description</title> 1264 1265<para>If non-zero, extensions may be used. Each extension is 1266further controlled by its own parameter. But if 1267<parameter>use.extensions</parameter> is zero, no extensions will 1268be used. 1269</para> 1270 1271</refsect1> 1272</doc:refentry> 1273<xsl:param name="use.extensions" select="'0'"/> 1274 1275<doc:refentry><refmeta> 1276<refentrytitle>chapter.autolabel</refentrytitle> 1277<refmiscinfo role="type">boolean</refmiscinfo> 1278</refmeta><refnamediv> 1279<refname>chapter.autolabel</refname> 1280<refpurpose>Specifies the labeling format for Chapter titles</refpurpose> 1281</refnamediv><refsynopsisdiv> 1282 1283</refsynopsisdiv><refsect1><title>Description</title> 1284 1285<para>If zero, then chapters will not be numbered. 1286Otherwise chapters will be numbered, using the parameter value 1287as the number format if the value matches one of the following: 1288</para> 1289 1290<variablelist> 1291 <varlistentry> 1292 <term>1 or arabic</term> 1293 <listitem> 1294 <para>Arabic numeration (1, 2, 3 ...).</para> 1295 </listitem> 1296 </varlistentry> 1297 <varlistentry> 1298 <term>A or upperalpha</term> 1299 <listitem> 1300 <para>Uppercase letter numeration (A, B, C ...).</para> 1301 </listitem> 1302 </varlistentry> 1303 <varlistentry> 1304 <term>a or loweralpha</term> 1305 <listitem> 1306 <para>Lowercase letter numeration (a, b, c ...).</para> 1307 </listitem> 1308 </varlistentry> 1309 <varlistentry> 1310 <term>I or upperroman</term> 1311 <listitem> 1312 <para>Uppercase roman numeration (I, II, III ...).</para> 1313 </listitem> 1314 </varlistentry> 1315 <varlistentry> 1316 <term>i or lowerroman</term> 1317 <listitem> 1318 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1319 </listitem> 1320 </varlistentry> 1321</variablelist> 1322 1323<para>Any nonzero value other than the above will generate 1324the default number format (arabic). 1325</para> 1326 1327</refsect1> 1328</doc:refentry> 1329<xsl:param name="chapter.autolabel" select="1"/> 1330 1331<doc:refentry><refmeta> 1332<refentrytitle>appendix.autolabel</refentrytitle> 1333<refmiscinfo role="type">boolean</refmiscinfo> 1334</refmeta><refnamediv> 1335<refname>appendix.autolabel</refname> 1336<refpurpose>Specifies the labeling format for Appendix titles</refpurpose> 1337</refnamediv><refsynopsisdiv> 1338 1339</refsynopsisdiv><refsect1><title>Description</title> 1340 1341<para>If zero, then appendices will not be numbered. 1342Otherwise appendices will be numbered, using the parameter value 1343as the number format if the value matches one of the following: 1344</para> 1345 1346<variablelist> 1347 <varlistentry> 1348 <term>1 or arabic</term> 1349 <listitem> 1350 <para>Arabic numeration (1, 2, 3 ...).</para> 1351 </listitem> 1352 </varlistentry> 1353 <varlistentry> 1354 <term>A or upperalpha</term> 1355 <listitem> 1356 <para>Uppercase letter numeration (A, B, C ...).</para> 1357 </listitem> 1358 </varlistentry> 1359 <varlistentry> 1360 <term>a or loweralpha</term> 1361 <listitem> 1362 <para>Lowercase letter numeration (a, b, c ...).</para> 1363 </listitem> 1364 </varlistentry> 1365 <varlistentry> 1366 <term>I or upperroman</term> 1367 <listitem> 1368 <para>Uppercase roman numeration (I, II, III ...).</para> 1369 </listitem> 1370 </varlistentry> 1371 <varlistentry> 1372 <term>i or lowerroman</term> 1373 <listitem> 1374 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1375 </listitem> 1376 </varlistentry> 1377</variablelist> 1378 1379<para>Any nonzero value other than the above will generate 1380the default number format (upperalpha). 1381</para> 1382 1383</refsect1> 1384</doc:refentry> 1385<xsl:param name="appendix.autolabel" select="'A'"/> 1386 1387<doc:refentry><refmeta> 1388<refentrytitle>part.autolabel</refentrytitle> 1389<refmiscinfo role="type">boolean</refmiscinfo> 1390</refmeta><refnamediv> 1391<refname>part.autolabel</refname> 1392<refpurpose>Specifies the labeling format for Part titles</refpurpose> 1393</refnamediv><refsynopsisdiv> 1394 1395</refsynopsisdiv><refsect1><title>Description</title> 1396 1397<para>If zero, then parts will not be numbered. 1398Otherwise parts will be numbered, using the parameter value 1399as the number format if the value matches one of the following: 1400</para> 1401 1402<variablelist> 1403 <varlistentry> 1404 <term>1 or arabic</term> 1405 <listitem> 1406 <para>Arabic numeration (1, 2, 3 ...).</para> 1407 </listitem> 1408 </varlistentry> 1409 <varlistentry> 1410 <term>A or upperalpha</term> 1411 <listitem> 1412 <para>Uppercase letter numeration (A, B, C ...).</para> 1413 </listitem> 1414 </varlistentry> 1415 <varlistentry> 1416 <term>a or loweralpha</term> 1417 <listitem> 1418 <para>Lowercase letter numeration (a, b, c ...).</para> 1419 </listitem> 1420 </varlistentry> 1421 <varlistentry> 1422 <term>I or upperroman</term> 1423 <listitem> 1424 <para>Uppercase roman numeration (I, II, III ...).</para> 1425 </listitem> 1426 </varlistentry> 1427 <varlistentry> 1428 <term>i or lowerroman</term> 1429 <listitem> 1430 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1431 </listitem> 1432 </varlistentry> 1433</variablelist> 1434 1435<para>Any nonzero value other than the above will generate 1436the default number format (upperroman). 1437</para> 1438 1439 1440</refsect1> 1441</doc:refentry> 1442<xsl:param name="part.autolabel" select="'I'"/> 1443 1444<doc:refentry><refmeta> 1445<refentrytitle>preface.autolabel</refentrytitle> 1446<refmiscinfo role="type">boolean</refmiscinfo> 1447</refmeta><refnamediv> 1448<refname>preface.autolabel</refname> 1449<refpurpose>Specifices the labeling format for Preface titles</refpurpose> 1450</refnamediv><refsynopsisdiv> 1451 1452</refsynopsisdiv><refsect1><title>Description</title> 1453 1454<para>If zero (default), then prefaces will not be numbered. 1455Otherwise prefaces will be numbered, using the parameter value 1456as the number format if the value matches one of the following: 1457</para> 1458 1459<variablelist> 1460 <varlistentry> 1461 <term>1 or arabic</term> 1462 <listitem> 1463 <para>Arabic numeration (1, 2, 3 ...).</para> 1464 </listitem> 1465 </varlistentry> 1466 <varlistentry> 1467 <term>A or upperalpha</term> 1468 <listitem> 1469 <para>Uppercase letter numeration (A, B, C ...).</para> 1470 </listitem> 1471 </varlistentry> 1472 <varlistentry> 1473 <term>a or loweralpha</term> 1474 <listitem> 1475 <para>Lowercase letter numeration (a, b, c ...).</para> 1476 </listitem> 1477 </varlistentry> 1478 <varlistentry> 1479 <term>I or upperroman</term> 1480 <listitem> 1481 <para>Uppercase roman numeration (I, II, III ...).</para> 1482 </listitem> 1483 </varlistentry> 1484 <varlistentry> 1485 <term>i or lowerroman</term> 1486 <listitem> 1487 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> 1488 </listitem> 1489 </varlistentry> 1490</variablelist> 1491 1492<para>Any nonzero value other than the above will generate 1493the default number format (arabic). 1494</para> 1495 1496 1497</refsect1> 1498</doc:refentry> 1499<xsl:param name="preface.autolabel" select="0"/> 1500 1501<doc:refentry><refmeta> 1502<refentrytitle>qandadiv.autolabel</refentrytitle> 1503<refmiscinfo role="type">boolean</refmiscinfo> 1504</refmeta><refnamediv> 1505<refname>qandadiv.autolabel</refname> 1506<refpurpose>Are divisions in QAndASets enumerated?</refpurpose> 1507</refnamediv><refsynopsisdiv> 1508 1509</refsynopsisdiv><refsect1><title>Description</title> 1510 1511<para>If true (non-zero), unlabeled qandadivs will be enumerated. 1512</para> 1513 1514</refsect1> 1515</doc:refentry> 1516<xsl:param name="qandadiv.autolabel" select="1"/> 1517 1518<doc:refentry><refmeta> 1519<refentrytitle>section.autolabel</refentrytitle> 1520<refmiscinfo role="type">boolean</refmiscinfo> 1521</refmeta><refnamediv> 1522<refname>section.autolabel</refname> 1523<refpurpose>Are sections enumerated?</refpurpose> 1524</refnamediv><refsynopsisdiv> 1525 1526</refsynopsisdiv><refsect1><title>Description</title> 1527 1528<para>If true (non-zero), unlabeled sections will be enumerated. 1529</para> 1530 1531</refsect1> 1532</doc:refentry> 1533<xsl:param name="section.autolabel" select="0"/> 1534 1535<doc:refentry><refmeta> 1536<refentrytitle>section.autolabel.max.depth</refentrytitle> 1537<refmiscinfo role="type">integer</refmiscinfo> 1538</refmeta><refnamediv> 1539<refname>section.autolabel.max.depth</refname> 1540<refpurpose>The deepest level of sections that are numbered.</refpurpose> 1541</refnamediv><refsynopsisdiv> 1542 1543</refsynopsisdiv><refsect1><title>Description</title> 1544 1545<para>When section numbering is turned on by the 1546<literal>section.autolabel</literal> parameter, 1547then this parameter controls the depth of section nesting 1548that is numbered. 1549Sections nested to a level deeper than this value will 1550not be numbered. 1551</para> 1552 1553</refsect1> 1554</doc:refentry> 1555<xsl:param name="section.autolabel.max.depth" select="8"/> 1556 1557<doc:refentry><refmeta> 1558<refentrytitle>section.label.includes.component.label</refentrytitle> 1559<refmiscinfo role="type">boolean</refmiscinfo> 1560</refmeta><refnamediv> 1561<refname>section.label.includes.component.label</refname> 1562<refpurpose>Do section labels include the component label?</refpurpose> 1563</refnamediv><refsynopsisdiv> 1564 1565</refsynopsisdiv><refsect1><title>Description</title> 1566 1567<para>If true (non-zero), section labels are prefixed with the label of the 1568component that contains them. 1569</para> 1570 1571</refsect1> 1572</doc:refentry> 1573<xsl:param name="section.label.includes.component.label" select="0"/> 1574 1575<doc:refentry><refmeta> 1576<refentrytitle>label.from.part</refentrytitle> 1577<refmiscinfo role="type">boolean</refmiscinfo> 1578</refmeta><refnamediv> 1579<refname>label.from.part</refname> 1580<refpurpose>Renumber chapters in each part?</refpurpose> 1581</refnamediv><refsynopsisdiv> 1582 1583</refsynopsisdiv><refsect1><title>Description</title> 1584 1585<para>If <parameter>label.from.part</parameter> is non-zero, components 1586(<sgmltag>chapter</sgmltag>s, <sgmltag>appendixe</sgmltag>s, etc.) 1587will be numbered from 1 in each <sgmltag>part</sgmltag>. Otherwise, 1588they will be numbered monotonically throughout each 1589<sgmltag>book</sgmltag>. 1590</para> 1591 1592</refsect1> 1593</doc:refentry> 1594<xsl:param name="label.from.part" select="'0'"/> 1595 1596<doc:refentry><refmeta> 1597<refentrytitle>component.label.includes.part.label</refentrytitle> 1598<refmiscinfo role="type">boolean</refmiscinfo> 1599</refmeta><refnamediv> 1600<refname>component.label.includes.part.label</refname> 1601<refpurpose>Do component labels include the part label?</refpurpose> 1602</refnamediv><refsynopsisdiv> 1603 1604</refsynopsisdiv><refsect1><title>Description</title> 1605 1606<para>If true (non-zero), number labels for chapters, appendices, and other component 1607elements are prefixed with the label of the 1608part element that contains them. 1609So you might see Chapter II.3 instead of Chapter 3. 1610Also, the labels for formal elements such as table and figure will 1611include the part label. 1612If there is no part element container, then no prefix is generated. 1613</para> 1614<para> 1615This feature is most useful when the 1616<literal>label.from.part</literal> parameter is turned on. 1617In that case, there would be more than one chapter 1618<quote>1</quote>, and the extra part label prefix will identify 1619each chapter unambiguously. 1620</para> 1621 1622</refsect1> 1623</doc:refentry> 1624<xsl:param name="component.label.includes.part.label" select="0"/> 1625 1626<doc:refentry><refmeta> 1627<refentrytitle>html.base</refentrytitle> 1628<refmiscinfo role="type">uri</refmiscinfo> 1629</refmeta><refnamediv> 1630<refname>html.base</refname> 1631<refpurpose>An HTML base URI</refpurpose> 1632</refnamediv><refsynopsisdiv> 1633 1634</refsynopsisdiv><refsect1><title>Description</title> 1635 1636<para>If html.base is set, it is used for the <sgmltag>BASE</sgmltag> 1637element in the <sgmltag>HEAD</sgmltag> of the HTML documents. 1638This is useful for dynamically served HTML where the base URI needs 1639to be shifted.</para> 1640 1641</refsect1> 1642</doc:refentry> 1643<xsl:param name="html.base"/> 1644 1645<doc:refentry><refmeta> 1646<refentrytitle>html.stylesheet.type</refentrytitle> 1647<refmiscinfo role="type">string</refmiscinfo> 1648</refmeta><refnamediv> 1649<refname>html.stylesheet.type</refname> 1650<refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> 1651</refnamediv><refsynopsisdiv> 1652 1653</refsynopsisdiv><refsect1><title>Description</title> 1654 1655<para>The type of the stylesheet to place in the HTML <sgmltag>link</sgmltag> tag. 1656</para> 1657 1658</refsect1> 1659</doc:refentry> 1660<xsl:param name="html.stylesheet.type">text/css</xsl:param> 1661 1662<doc:refentry><refmeta> 1663<refentrytitle>html.stylesheet</refentrytitle> 1664<refmiscinfo role="type">string</refmiscinfo> 1665</refmeta><refnamediv> 1666<refname>html.stylesheet</refname> 1667<refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose> 1668</refnamediv><refsynopsisdiv> 1669 1670</refsynopsisdiv><refsect1><title>Description</title> 1671 1672<para>The <parameter>html.stylesheet</parameter> parameter is either empty, 1673indicating that no stylesheet <sgmltag>LINK</sgmltag> tag should be generated 1674in the HTML output, or it is a list of one or more stylesheets.</para> 1675 1676<para>Multiple stylesheets are space-delimited. If you need to 1677reference a stylesheet URI that includes a space, encode it with 1678<literal>%20</literal>. A seprate HTML <sgmltag>LINK</sgmltag> element will 1679be generated for each stylesheet in the order they are listed in the 1680parameter.</para> 1681 1682</refsect1> 1683</doc:refentry> 1684<xsl:param name="html.stylesheet" select="''"/> 1685 1686<doc:refentry><refmeta> 1687<refentrytitle>css.decoration</refentrytitle> 1688<refmiscinfo role="type">boolean</refmiscinfo> 1689</refmeta><refnamediv> 1690<refname>css.decoration</refname> 1691<refpurpose>Enable CSS decoration of elements</refpurpose> 1692</refnamediv><refsynopsisdiv> 1693 1694</refsynopsisdiv><refsect1><title>Description</title> 1695 1696<para> 1697If <literal>css.decoration</literal> is turned on, then HTML elements 1698produced by the 1699stylesheet may be decorated with STYLE attributes. For example, the 1700LI tags produced for list items may include a fragment of CSS in the 1701STYLE attribute which sets the CSS property "list-style-type". 1702</para> 1703 1704</refsect1> 1705</doc:refentry> 1706<xsl:param name="css.decoration" select="1"/> 1707 1708<doc:refentry><refmeta> 1709<refentrytitle>spacing.paras</refentrytitle> 1710<refmiscinfo role="type">boolean</refmiscinfo> 1711</refmeta><refnamediv> 1712<refname>spacing.paras</refname> 1713<refpurpose>Insert additional <p> elements for spacing?</refpurpose> 1714</refnamediv><refsynopsisdiv> 1715 1716</refsynopsisdiv><refsect1><title>Description</title> 1717 1718<para>When non-zero, additional, empty paragraphs are inserted in 1719several contexts (for example, around informal figures), to create a 1720more pleasing visual appearance in many browsers. 1721</para> 1722 1723</refsect1> 1724</doc:refentry> 1725<xsl:param name="spacing.paras" select="'0'"/> 1726 1727<doc:refentry><refmeta> 1728<refentrytitle>emphasis.propagates.style</refentrytitle> 1729<refmiscinfo role="type">boolean</refmiscinfo> 1730</refmeta><refnamediv> 1731<refname>emphasis.propagates.style</refname> 1732<refpurpose>Pass emphasis role attribute through to HTML?</refpurpose> 1733</refnamediv><refsynopsisdiv> 1734 1735</refsynopsisdiv><refsect1><title>Description</title> 1736 1737<para>If true, the role attribute of <sgmltag>emphasis</sgmltag> elements 1738will be passed through to the HTML as a class attribute on a 1739<sgmltag>span</sgmltag> that surrounds the emphasis.</para> 1740 1741</refsect1> 1742</doc:refentry> 1743<xsl:param name="emphasis.propagates.style" select="1"/> 1744 1745<doc:refentry><refmeta> 1746<refentrytitle>para.propagates.style</refentrytitle> 1747<refmiscinfo role="type">boolean</refmiscinfo> 1748</refmeta><refnamediv> 1749<refname>para.propagates.style</refname> 1750<refpurpose>Pass para role attribute through to HTML?</refpurpose> 1751</refnamediv><refsynopsisdiv> 1752 1753</refsynopsisdiv><refsect1><title>Description</title> 1754 1755<para>If true, the role attribute of <sgmltag>para</sgmltag> elements 1756will be passed through to the HTML as a class attribute on the 1757<sgmltag>p</sgmltag> generated for the paragraph.</para> 1758 1759</refsect1> 1760</doc:refentry> 1761<xsl:param name="para.propagates.style" select="1"/> 1762 1763<doc:refentry><refmeta> 1764<refentrytitle>phrase.propagates.style</refentrytitle> 1765<refmiscinfo role="type">boolean</refmiscinfo> 1766</refmeta><refnamediv> 1767<refname>phrase.propagates.style</refname> 1768<refpurpose>Pass phrase role attribute through to HTML?</refpurpose> 1769</refnamediv><refsynopsisdiv> 1770 1771</refsynopsisdiv><refsect1><title>Description</title> 1772 1773<para>If true, the role attribute of <sgmltag>phrase</sgmltag> elements 1774will be passed through to the HTML as a class attribute on a 1775<sgmltag>span</sgmltag> that surrounds the phrase.</para> 1776 1777</refsect1> 1778</doc:refentry> 1779<xsl:param name="phrase.propagates.style" select="1"/> 1780 1781<doc:refentry><refmeta> 1782<refentrytitle>entry.propagates.style</refentrytitle> 1783<refmiscinfo role="type">boolean</refmiscinfo> 1784</refmeta><refnamediv> 1785<refname>entry.propagates.style</refname> 1786<refpurpose>Pass entry role attribute through to HTML?</refpurpose> 1787</refnamediv><refsynopsisdiv> 1788 1789</refsynopsisdiv><refsect1><title>Description</title> 1790 1791<para>If true, the role attribute of <sgmltag>entry</sgmltag> elements 1792will be passed through to the HTML as a class attribute on the 1793<sgmltag>td</sgmltag> or <sgmltag>th</sgmltag> generated for the table 1794cell.</para> 1795 1796</refsect1> 1797</doc:refentry> 1798<xsl:param name="entry.propagates.style" select="1"/> 1799 1800<doc:refentry><refmeta> 1801<refentrytitle>html.longdesc</refentrytitle> 1802<refmiscinfo role="type">boolean</refmiscinfo> 1803</refmeta><refnamediv> 1804<refname>html.longdesc</refname> 1805<refpurpose>Should longdesc URIs be created?</refpurpose> 1806</refnamediv><refsynopsisdiv> 1807 1808</refsynopsisdiv><refsect1><title>Description</title> 1809 1810<para>If non-zero, HTML files will be created for the 1811<sgmltag class="attribute">longdesc</sgmltag> attribute. These files 1812are created from the <sgmltag>textobject</sgmltag>s in 1813<sgmltag>mediaobject</sgmltag>s and 1814<sgmltag>inlinemediaobject</sgmltag>. 1815</para> 1816 1817</refsect1> 1818</doc:refentry> 1819<xsl:param name="html.longdesc" select="1"/> 1820 1821<doc:refentry><refmeta> 1822<refentrytitle>html.longdesc.link</refentrytitle> 1823<refmiscinfo role="type">boolean</refmiscinfo> 1824</refmeta><refnamediv> 1825<refname>html.longdesc.link</refname> 1826<refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose> 1827</refnamediv><refsynopsisdiv> 1828 1829</refsynopsisdiv><refsect1><title>Description</title> 1830 1831<para>If non-zero, links will be created to the 1832HTML files created for the 1833<sgmltag class="attribute">longdesc</sgmltag> attribute. It makes no 1834sense to turn enable this option without also enabling the 1835<parameter>$html.longdesc</parameter> parameter.</para> 1836 1837<para>The <literal>longdesc.link</literal> named template is called 1838to construct the link.</para> 1839 1840</refsect1> 1841</doc:refentry> 1842<xsl:param name="html.longdesc.link" select="$html.longdesc"/> 1843 1844<doc:refentry><refmeta> 1845<refentrytitle>make.valid.html</refentrytitle> 1846<refmiscinfo role="type">boolean</refmiscinfo> 1847</refmeta><refnamediv> 1848<refname>make.valid.html</refname> 1849<refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose> 1850</refnamediv><refsynopsisdiv> 1851 1852</refsynopsisdiv><refsect1><title>Description</title> 1853 1854<para>If <parameter>make.valid.html</parameter> is true, the stylesheets take 1855extra effort to ensure that the resulting HTML is valid. This may mean that some 1856<sgmltag>para</sgmltag> tags are translated into HTML <sgmltag>div</sgmltag>s or 1857that other substitutions occur.</para> 1858 1859<para>This parameter is different from <parameter>html.cleanup</parameter> 1860because it changes the resulting markup; it does not use extension functions 1861to manipulate result-tree-fragments and is therefore applicable to any 1862XSLT processor.</para> 1863 1864</refsect1> 1865</doc:refentry> 1866<xsl:param name="make.valid.html" select="0"/> 1867 1868<doc:refentry><refmeta> 1869<refentrytitle>html.cleanup</refentrytitle> 1870<refmiscinfo role="type">boolean</refmiscinfo> 1871</refmeta><refnamediv> 1872<refname>html.cleanup</refname> 1873<refpurpose>Attempt to clean up the resulting HTML?</refpurpose> 1874</refnamediv><refsynopsisdiv> 1875 1876</refsynopsisdiv><refsect1><title>Description</title> 1877 1878<para>If non-zero, and if the <ulink url="http://www.exslt.org/">EXSLT</ulink> 1879extensions are supported by your processor, the resulting HTML will be 1880<quote>cleaned up</quote>. This improves the chances that the 1881resulting HTML will be valid. It may also improve the formatting of 1882some elements.</para> 1883 1884<para>This parameter is different from <parameter>make.valid.html</parameter> 1885because it uses extension functions to manipulate result-tree-fragments.</para> 1886 1887</refsect1> 1888</doc:refentry> 1889<xsl:param name="html.cleanup" select="1"/> 1890 1891<doc:refentry><refmeta> 1892<refentrytitle>draft.mode</refentrytitle> 1893<refmiscinfo role="type">list</refmiscinfo> 1894</refmeta><refnamediv> 1895<refname>draft.mode</refname> 1896<refpurpose>Select draft mode</refpurpose> 1897</refnamediv><refsynopsisdiv> 1898 1899</refsynopsisdiv><refsect1><title>Description</title> 1900 1901<para>Selects draft mode. If <parameter>draft.mode</parameter> is 1902<quote><literal>yes</literal></quote>, the entire document will be treated 1903as a draft. If it is <quote><literal>no</literal></quote>, the entire document 1904will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>, 1905individual sections will be treated as draft or final independently, depending 1906on how their <sgmltag class="attribute">status</sgmltag> attribute is set. 1907</para> 1908 1909</refsect1> 1910</doc:refentry> 1911<xsl:param name="draft.mode" select="'maybe'"/> 1912 1913<doc:refentry><refmeta> 1914<refentrytitle>draft.watermark.image</refentrytitle> 1915<refmiscinfo role="type">uri</refmiscinfo> 1916</refmeta><refnamediv> 1917<refname>draft.watermark.image</refname> 1918<refpurpose>The URI of the image to be used for draft watermarks</refpurpose> 1919</refnamediv><refsynopsisdiv> 1920 1921</refsynopsisdiv><refsect1><title>Description</title> 1922 1923<para>The image to be used for draft watermarks.</para> 1924 1925</refsect1> 1926</doc:refentry> 1927<xsl:param name="draft.watermark.image" select="'http://docbook.sourceforge.net/release/images/draft.png'"/> 1928 1929<doc:refentry><refmeta> 1930<refentrytitle>generate.id.attributes</refentrytitle> 1931<refmiscinfo role="type"/> 1932</refmeta><refnamediv> 1933<refname>generate.id.attributes</refname> 1934<refpurpose/> 1935</refnamediv><refsynopsisdiv> 1936 1937</refsynopsisdiv><refsect1><title>Description</title> 1938 1939<para>If non-zero, the HTML stylesheet will generate ID attributes on 1940containers. For example, the markup:</para> 1941 1942<screen><section id="foo"><title>Some Title</title> 1943<para>Some para.</para> 1944</section></screen> 1945 1946<para>might produce:</para> 1947 1948<screen><div class="section" id="foo"> 1949<h2>Some Title</h2> 1950<p>Some para.</p> 1951</div></screen> 1952 1953<para>The alternative is to generate anchors:</para> 1954 1955<screen><div class="section"> 1956<h2><a name="foo"></a>Some Title</h2> 1957<p>Some para.</p> 1958</div></screen> 1959 1960<para>Because the <sgmltag class="attribute">name</sgmltag> attribute of 1961the <sgmltag>a</sgmltag> element and the <sgmltag class="attribute">id</sgmltag> 1962attribute of other tags are both of type <quote>ID</quote>, producing both 1963generates invalid documents.</para> 1964 1965<para>As of version 1.50, you can use this switch to control which type of 1966identifier is generated. For backwards-compatibility, generating 1967<sgmltag>a</sgmltag> anchors is preferred.</para> 1968 1969<para>Note: at present, this switch is incompletely implemented. 1970Disabling ID attributes will suppress them, but enabling ID attributes 1971will not suppress the anchors.</para> 1972 1973</refsect1> 1974</doc:refentry> 1975<xsl:param name="generate.id.attributes" select="0"/> 1976 1977<doc:refentry><refmeta> 1978<refentrytitle>generate.meta.abstract</refentrytitle> 1979<refmiscinfo role="type">boolean</refmiscinfo> 1980</refmeta><refnamediv> 1981<refname>generate.meta.abstract</refname> 1982<refpurpose>Generate HTML <sgmltag>META</sgmltag> element from <sgmltag>abstract</sgmltag>?</refpurpose> 1983</refnamediv><refsynopsisdiv> 1984 1985</refsynopsisdiv><refsect1><title>Description</title> 1986 1987<para>If non-zero, document abstracts will be reproduced in the HTML 1988<sgmltag>HEAD</sgmltag> with <sgmltag class="starttag">meta name="description" content="..."</sgmltag>.</para> 1989 1990</refsect1> 1991</doc:refentry> 1992<xsl:param name="generate.meta.abstract" select="1"/> 1993 1994<doc:refentry><refmeta> 1995<refentrytitle>rootid</refentrytitle> 1996<refmiscinfo role="type">string</refmiscinfo> 1997</refmeta><refnamediv> 1998<refname>rootid</refname> 1999<refpurpose>Specify the root element to format</refpurpose> 2000</refnamediv><refsynopsisdiv> 2001 2002</refsynopsisdiv><refsect1><title>Description</title> 2003 2004<para>If <parameter>rootid</parameter> is specified, it must be the 2005value of an ID that occurs in the document being formatted. The entire 2006document will be loaded and parsed, but formatting will begin at the 2007element identified, rather than at the root. For example, this allows 2008you to process only chapter 4 of a book.</para> 2009<para>Because the entire document is available to the processor, automatic 2010numbering, cross references, and other dependencies are correctly 2011resolved.</para> 2012 2013</refsect1> 2014</doc:refentry> 2015<xsl:param name="rootid" select="''"/> 2016 2017<doc:refentry><refmeta> 2018<refentrytitle>suppress.navigation</refentrytitle> 2019<refmiscinfo role="type">boolean</refmiscinfo> 2020</refmeta><refnamediv> 2021<refname>suppress.navigation</refname> 2022<refpurpose>Disable header and footer navigation</refpurpose> 2023</refnamediv><refsynopsisdiv> 2024 2025</refsynopsisdiv><refsect1><title>Description</title> 2026 2027<para> 2028If <literal>suppress.navigation</literal> is turned on, header and 2029footer navigation will be suppressed.</para> 2030 2031</refsect1> 2032</doc:refentry> 2033<xsl:param name="suppress.navigation">0</xsl:param> 2034 2035<doc:refentry><refmeta> 2036<refentrytitle>suppress.header.navigation</refentrytitle> 2037<refmiscinfo role="type">boolean</refmiscinfo> 2038</refmeta><refnamediv> 2039<refname>suppress.header.navigation</refname> 2040<refpurpose>Disable header navigation</refpurpose> 2041</refnamediv><refsynopsisdiv> 2042 2043</refsynopsisdiv><refsect1><title>Description</title> 2044 2045<para> 2046If <literal>suppress.header.navigation</literal> is turned on, header 2047navigation will be suppressed.</para> 2048 2049</refsect1> 2050</doc:refentry> 2051<xsl:param name="suppress.header.navigation">0</xsl:param> 2052 2053<doc:refentry><refmeta> 2054<refentrytitle>suppress.footer.navigation</refentrytitle> 2055<refmiscinfo role="type">boolean</refmiscinfo> 2056</refmeta><refnamediv> 2057<refname>suppress.footer.navigation</refname> 2058<refpurpose>Disable footer navigation</refpurpose> 2059</refnamediv><refsynopsisdiv> 2060 2061</refsynopsisdiv><refsect1><title>Description</title> 2062 2063<para> 2064If <literal>suppress.footer.navigation</literal> is turned on, footer 2065navigation will be suppressed.</para> 2066 2067</refsect1> 2068</doc:refentry> 2069<xsl:param name="suppress.footer.navigation">0</xsl:param> 2070 2071<doc:refentry><refmeta> 2072<refentrytitle>header.rule</refentrytitle> 2073<refmiscinfo role="type">boolean</refmiscinfo> 2074</refmeta><refnamediv> 2075<refname>header.rule</refname> 2076<refpurpose>Rule under headers?</refpurpose> 2077</refnamediv><refsynopsisdiv> 2078 2079</refsynopsisdiv><refsect1><title>Description</title> 2080 2081<para>If non-zero, a rule will be drawn below the page headers.</para> 2082 2083</refsect1> 2084</doc:refentry> 2085<xsl:param name="header.rule" select="1"/> 2086 2087<doc:refentry><refmeta> 2088<refentrytitle>footer.rule</refentrytitle> 2089<refmiscinfo role="type">boolean</refmiscinfo> 2090</refmeta><refnamediv> 2091<refname>footer.rule</refname> 2092<refpurpose>Rule over footers?</refpurpose> 2093</refnamediv><refsynopsisdiv> 2094 2095</refsynopsisdiv><refsect1><title>Description</title> 2096 2097<para>If non-zero, a rule will be drawn above the page footers.</para> 2098 2099</refsect1> 2100</doc:refentry> 2101<xsl:param name="footer.rule" select="1"/> 2102 2103<doc:refentry><refmeta> 2104<refentrytitle>id.warnings</refentrytitle> 2105<refmiscinfo role="type">boolean</refmiscinfo> 2106</refmeta><refnamediv> 2107<refname>id.warnings</refname> 2108<refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose> 2109</refnamediv><refsynopsisdiv> 2110 2111</refsynopsisdiv><refsect1><title>Description</title> 2112 2113<para>If non-zero, the stylesheet will issue a warning for 2114any element (other than the root element) which 2115has a title but does not have an ID.</para> 2116 2117</refsect1> 2118</doc:refentry> 2119<xsl:param name="id.warnings" select="1"/> 2120 2121<doc:refentry><refmeta> 2122<refentrytitle>inherit.keywords</refentrytitle> 2123<refmiscinfo role="type">boolean</refmiscinfo> 2124</refmeta><refnamediv> 2125<refname>inherit.keywords</refname> 2126<refpurpose>Inherit keywords from ancestor elements?</refpurpose> 2127</refnamediv><refsynopsisdiv> 2128 2129</refsynopsisdiv><refsect1><title>Description</title> 2130 2131<para>If <parameter>inherit.keywords</parameter> 2132is non-zero, the keyword <sgmltag>META</sgmltag> for each HTML 2133<sgmltag>HEAD</sgmltag> element will include all of the keywords from 2134ancestral elements. Otherwise, only the keywords from the current section 2135will be used. 2136</para> 2137 2138</refsect1> 2139</doc:refentry> 2140<xsl:param name="inherit.keywords" select="'1'"/> 2141 2142<doc:refentry><refmeta> 2143<refentrytitle>make.single.year.ranges</refentrytitle> 2144<refmiscinfo role="type">boolean</refmiscinfo> 2145</refmeta><refnamediv> 2146<refname>make.single.year.ranges</refname> 2147<refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose> 2148</refnamediv><refsynopsisdiv> 2149 2150</refsynopsisdiv><refsect1><title>Description</title> 2151 2152<para>If non-zero, year ranges that span a single year will be printed 2153in range notation (1998-1999) instead of discrete notation 2154(1998, 1999).</para> 2155 2156</refsect1> 2157</doc:refentry> 2158<xsl:param name="make.single.year.ranges" select="0"/> 2159 2160<doc:refentry><refmeta> 2161<refentrytitle>make.year.ranges</refentrytitle> 2162<refmiscinfo role="type">boolean</refmiscinfo> 2163</refmeta><refnamediv> 2164<refname>make.year.ranges</refname> 2165<refpurpose>Collate copyright years into ranges?</refpurpose> 2166</refnamediv><refsynopsisdiv> 2167 2168</refsynopsisdiv><refsect1><title>Description</title> 2169 2170<para>If non-zero, copyright years will be collated into ranges.</para> 2171 2172</refsect1> 2173</doc:refentry> 2174<xsl:param name="make.year.ranges" select="0"/> 2175 2176<doc:refentry><refmeta> 2177<refentrytitle>author.othername.in.middle</refentrytitle> 2178<refmiscinfo role="type">boolean</refmiscinfo> 2179</refmeta><refnamediv> 2180<refname>author.othername.in.middle</refname> 2181<refpurpose>Is <sgmltag>othername</sgmltag> in <sgmltag>author</sgmltag> a 2182middle name?</refpurpose> 2183</refnamediv><refsynopsisdiv> 2184 2185</refsynopsisdiv><refsect1><title>Description</title> 2186 2187<para>If true (non-zero), the <sgmltag>othername</sgmltag> of an <sgmltag>author</sgmltag> 2188appears between the <sgmltag>firstname</sgmltag> and 2189<sgmltag>surname</sgmltag>. Otherwise, <sgmltag>othername</sgmltag> 2190is suppressed. 2191</para> 2192 2193</refsect1> 2194</doc:refentry> 2195<xsl:param name="author.othername.in.middle" select="1"/> 2196 2197<doc:refentry><refmeta> 2198<refentrytitle>generate.legalnotice.link</refentrytitle> 2199<refmiscinfo role="type">boolean</refmiscinfo> 2200</refmeta><refnamediv> 2201<refname>generate.legalnotice.link</refname> 2202<refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose> 2203</refnamediv><refsynopsisdiv> 2204 2205</refsynopsisdiv><refsect1><title>Description</title> 2206 2207<para>If the value of <parameter>generate.legalnotice.link</parameter> 2208is non-zero, the stylesheet: 2209 2210<itemizedlist> 2211 <listitem> 2212 <para>writes the contents of <tag>legalnotice</tag> to a separate 2213 HTML file</para> 2214 </listitem> 2215 <listitem> 2216 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para> 2217 </listitem> 2218 <listitem> 2219 <para>adds (in the HTML <literal>head</literal>) either a single 2220 <literal>link</literal> or element or multiple 2221 <literal>link</literal> elements (depending on the value of the 2222 <parameter>html.head.legalnotice.link.multiple</parameter> 2223 parameter), with the value or values derived from the 2224 <parameter>html.head.legalnotice.link.types</parameter> 2225 parameter</para> 2226 </listitem> 2227 </itemizedlist> 2228 2229 Otherwise, if <parameter>generate.legalnotice.link</parameter> is 2230 zero, <tag>legalnotice</tag> contents are rendered on the title 2231 page.</para> 2232 2233</refsect1> 2234</doc:refentry> 2235<xsl:param name="generate.legalnotice.link" select="0"/> 2236 2237<doc:refentry><refmeta> 2238<refentrytitle>generate.revhistory.link</refentrytitle> 2239<refmiscinfo role="type">boolean</refmiscinfo> 2240</refmeta><refnamediv> 2241<refname>generate.revhistory.link</refname> 2242<refpurpose>Write revhistory to separate chunk and generate link?</refpurpose> 2243</refnamediv><refsynopsisdiv> 2244 2245</refsynopsisdiv><refsect1><title>Description</title> 2246 2247<para>If non-zero, the contents of <tag>revhistory</tag> are written 2248to a separate HTML file and a link to the file is 2249generated. Otherwise, <tag>revhistory</tag> contents are rendered on 2250the title page.</para> 2251 2252</refsect1> 2253</doc:refentry> 2254<xsl:param name="generate.revhistory.link" select="0"/> 2255 2256<doc:refentry><refmeta> 2257<refentrytitle>html.head.legalnotice.link.types</refentrytitle> 2258<refmiscinfo role="type">string</refmiscinfo> 2259</refmeta><refnamediv> 2260<refname>html.head.legalnotice.link.types</refname> 2261<refpurpose>Specifies link types for legalnotice link in html head</refpurpose> 2262</refnamediv><refsynopsisdiv> 2263 2264</refsynopsisdiv><refsect1><title>Description</title> 2265 2266<para>The value of 2267<parameter>html.head.legalnotice.link.types</parameter> is a 2268space-separated list of link types, as described in <ulink url="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12 2269of the HTML 4.01 specification</ulink>. If the value of the 2270<parameter>generate.legalnotice.link</parameter> parameter is 2271non-zero, then the stylesheet generates (in the 2272<literal>head</literal> section of the HTML source) either a single 2273HTML <literal>link</literal> element or, if the value of the 2274<parameter>html.head.legalnotice.link.multiple</parameter> is 2275non-zero, one <literal>link</literal> element for each link type 2276specified. Each <literal>link</literal> has the following attributes: 2277 2278<itemizedlist> 2279 <listitem> 2280 <para>a <sgmltag class="attribute">rel</sgmltag> attribute whose 2281 value is derived from the value of 2282 <parameter>html.head.legalnotice.link.types</parameter></para> 2283 </listitem> 2284 <listitem> 2285 <para>an <sgmltag class="attribute">href</sgmltag> attribute whose 2286 value is set to the URL of the file containing the 2287 <sgmltag>legalnotice</sgmltag></para> 2288 </listitem> 2289 <listitem> 2290 <para>a <sgmltag class="attribute">title</sgmltag> attribute whose 2291 value is set to the title of the corresponding 2292 <sgmltag>legalnotice</sgmltag> (or a title programatically 2293 determined by the stylesheet)</para> 2294 </listitem> 2295</itemizedlist> 2296 2297For example: 2298 2299<screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> 2300</para> 2301 2302<refsect2> 2303 <title>About the default value</title> 2304 <para>In an ideal world, the default value of 2305 <parameter>html.head.legalnotice.link.types</parameter> would 2306 probably be ���<literal>license</literal>���, since the content of the 2307 DocBook <sgmltag>legalnotice</sgmltag> is typically license 2308 information, not copyright information. However, the default value 2309 is ���<literal>copyright</literal>��� for pragmatic reasons: because 2310 that���s among the set of ���recognized link types��� listed in <ulink url="http://www.w3.org/TR/html401/types.html#type-links">Section 2311 6.12 of the HTML 4.01 specification</ulink>, and because certain 2312 browsers and browser extensions are preconfigured to recognize that 2313 value.</para> 2314</refsect2> 2315 2316</refsect1> 2317</doc:refentry> 2318<xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param> 2319 2320<doc:refentry><refmeta> 2321<refentrytitle>html.head.legalnotice.link.multiple</refentrytitle> 2322<refmiscinfo role="type">boolean</refmiscinfo> 2323</refmeta><refnamediv> 2324<refname>html.head.legalnotice.link.multiple</refname> 2325<refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose> 2326</refnamediv><refsynopsisdiv> 2327 2328</refsynopsisdiv><refsect1><title>Description</title> 2329 2330<para>If <parameter>html.head.legalnotice.link.multiple</parameter> is 2331non-zero and the value of 2332<parameter>html.head.legalnotice.link.types</parameter> contains 2333multiple link types, then the stylesheet generates (in the 2334<literal>head</literal> section of the HTML source) one 2335<literal>link</literal> element for each link type specified. For 2336example, if the value of 2337<parameter>html.head.legalnotice.link.types</parameter> is 2338���<literal>copyright license</literal>���: 2339 2340<screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice"> 2341 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> 2342 2343 Otherwise, the stylesheet generates generates a single 2344 <literal>link</literal> instance; for example: 2345 2346<screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen> 2347 2348</para> 2349</refsect1> 2350</doc:refentry> 2351<xsl:param name="html.head.legalnotice.link.multiple" select="1"/> 2352 2353<doc:refentry><refmeta> 2354<refentrytitle>funcsynopsis.decoration</refentrytitle> 2355<refmiscinfo role="type">boolean</refmiscinfo> 2356</refmeta><refnamediv> 2357<refname>funcsynopsis.decoration</refname> 2358<refpurpose>Decorate elements of a FuncSynopsis?</refpurpose> 2359</refnamediv><refsynopsisdiv> 2360 2361</refsynopsisdiv><refsect1><title>Description</title> 2362 2363<para>If true (non-zero), elements of the FuncSynopsis will be decorated (e.g. bold or 2364italic). The decoration is controlled by functions that can be redefined 2365in a customization layer. 2366</para> 2367 2368</refsect1> 2369</doc:refentry> 2370<xsl:param name="funcsynopsis.decoration" select="1"/> 2371 2372<doc:refentry><refmeta> 2373<refentrytitle>funcsynopsis.style</refentrytitle> 2374<refmiscinfo role="type">list</refmiscinfo> 2375<refmiscinfo role="value">ansi</refmiscinfo> 2376<refmiscinfo role="value">kr</refmiscinfo> 2377</refmeta><refnamediv> 2378<refname>funcsynopsis.style</refname> 2379<refpurpose>What style of 'FuncSynopsis' should be generated?</refpurpose> 2380</refnamediv><refsynopsisdiv> 2381 2382</refsynopsisdiv><refsect1><title>Description</title> 2383 2384<para>If <varname>funcsynopsis.style</varname> is <literal>ansi</literal>, 2385ANSI-style function synopses are generated for a 2386<sgmltag>funcsynopsis</sgmltag>, otherwise K&R-style 2387function synopses are generated. 2388</para> 2389 2390</refsect1> 2391</doc:refentry> 2392<xsl:param name="funcsynopsis.style">kr</xsl:param> 2393 2394<doc:refentry><refmeta> 2395<refentrytitle>funcsynopsis.tabular.threshold</refentrytitle> 2396<refmiscinfo role="type">integer</refmiscinfo> 2397</refmeta><refnamediv> 2398<refname>funcsynopsis.tabular.threshold</refname> 2399<refpurpose>Width beyond which a tabular presentation will be used</refpurpose> 2400</refnamediv><refsynopsisdiv> 2401 2402</refsynopsisdiv><refsect1><title>Description</title> 2403 2404<para>If <parameter>funcsynopsis.tabular.threshold</parameter> is greater than 2405zero then if a <sgmltag>funcprototype</sgmltag> is wider than the threshold 2406value, it will be presented in a table.</para> 2407 2408</refsect1> 2409</doc:refentry> 2410<xsl:param name="funcsynopsis.tabular.threshold" select="40"/> 2411 2412<doc:refentry><refmeta> 2413<refentrytitle>function.parens</refentrytitle> 2414<refmiscinfo role="type">boolean</refmiscinfo> 2415</refmeta><refnamediv> 2416<refname>function.parens</refname> 2417<refpurpose>Generate parens after a function?</refpurpose> 2418</refnamediv><refsynopsisdiv> 2419 2420</refsynopsisdiv><refsect1><title>Description</title> 2421 2422<para>If not 0, the formatting of 2423a <sgmltag class="starttag">function</sgmltag> element will include 2424generated parenthesis. 2425</para> 2426 2427</refsect1> 2428</doc:refentry> 2429<xsl:param name="function.parens">0</xsl:param> 2430 2431<doc:refentry><refmeta> 2432<refentrytitle>refentry.generate.name</refentrytitle> 2433<refmiscinfo role="type">boolean</refmiscinfo> 2434</refmeta><refnamediv> 2435<refname>refentry.generate.name</refname> 2436<refpurpose>Output NAME header before 'RefName'(s)?</refpurpose> 2437</refnamediv><refsynopsisdiv> 2438 2439</refsynopsisdiv><refsect1><title>Description</title> 2440 2441<para>If true (non-zero), a "NAME" section title is output before the list 2442of 'RefName's. This parameter and 2443<parameter>refentry.generate.title</parameter> are mutually 2444exclusive. This means that if you change this parameter to zero, you 2445should set <parameter>refentry.generate.title</parameter> to 1 unless 2446you want get quite strange output. 2447</para> 2448 2449</refsect1> 2450</doc:refentry> 2451<xsl:param name="refentry.generate.name" select="1"/> 2452 2453<doc:refentry><refmeta> 2454<refentrytitle>refentry.generate.title</refentrytitle> 2455<refmiscinfo role="type">boolean</refmiscinfo> 2456</refmeta><refnamediv> 2457<refname>refentry.generate.title</refname> 2458<refpurpose>Output title before 'RefName'(s)?</refpurpose> 2459</refnamediv><refsynopsisdiv> 2460 2461</refsynopsisdiv><refsect1><title>Description</title> 2462 2463<para>If true (non-zero), the reference page title or first name is 2464output before the list of 'RefName's. This parameter and 2465<parameter>refentry.generate.name</parameter> are mutually exclusive. 2466This means that if you change this parameter to 1, you 2467should set <parameter>refentry.generate.name</parameter> to 0 unless 2468you want get quite strange output.</para> 2469 2470 2471</refsect1> 2472</doc:refentry> 2473<xsl:param name="refentry.generate.title" select="0"/> 2474 2475<doc:refentry><refmeta> 2476<refentrytitle>refentry.xref.manvolnum</refentrytitle> 2477<refmiscinfo role="type">boolean</refmiscinfo> 2478</refmeta><refnamediv> 2479<refname>refentry.xref.manvolnum</refname> 2480<refpurpose>Output <sgmltag>manvolnum</sgmltag> as part of 2481<sgmltag>refentry</sgmltag> cross-reference?</refpurpose> 2482</refnamediv><refsynopsisdiv> 2483 2484</refsynopsisdiv><refsect1><title>Description</title> 2485 2486<para>if true (non-zero), the <sgmltag>manvolnum</sgmltag> is used when cross-referencing 2487<sgmltag>refentry</sgmltag>s, either with <sgmltag>xref</sgmltag> 2488or <sgmltag>citerefentry</sgmltag>. 2489</para> 2490 2491</refsect1> 2492</doc:refentry> 2493<xsl:param name="refentry.xref.manvolnum" select="1"/> 2494 2495<doc:refentry><refmeta> 2496<refentrytitle>citerefentry.link</refentrytitle> 2497<refmiscinfo role="type">boolean</refmiscinfo> 2498</refmeta><refnamediv> 2499<refname>citerefentry.link</refname> 2500<refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> 2501</refnamediv><refsynopsisdiv> 2502 2503</refsynopsisdiv><refsect1><title>Description</title> 2504 2505<para>If true, a web link will be generated, presumably 2506to an online man->HTML gateway. The text of the link is 2507generated by the generate.citerefentry.link template. 2508</para> 2509 2510</refsect1> 2511</doc:refentry> 2512<xsl:param name="citerefentry.link" select="'0'"/> 2513 2514<doc:refentry><refmeta> 2515<refentrytitle>refentry.separator</refentrytitle> 2516<refmiscinfo role="type">boolean</refmiscinfo> 2517</refmeta><refnamediv> 2518<refname>refentry.separator</refname> 2519<refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose> 2520</refnamediv><refsynopsisdiv> 2521 2522</refsynopsisdiv><refsect1><title>Description</title> 2523 2524<para>If true, a separator will be generated between consecutive 2525reference pages. 2526</para> 2527 2528</refsect1> 2529</doc:refentry> 2530<xsl:param name="refentry.separator" select="'1'"/> 2531 2532<doc:refentry><refmeta> 2533<refentrytitle>refclass.suppress</refentrytitle> 2534<refmiscinfo role="type">boolean</refmiscinfo> 2535</refmeta><refnamediv> 2536<refname>refclass.suppress</refname> 2537<refpurpose>Suppress display of refclass contents?</refpurpose> 2538</refnamediv><refsynopsisdiv> 2539 2540</refsynopsisdiv><refsect1><title>Description</title> 2541 2542<para>If the value of <parameter>refclass.suppress</parameter> is 2543non-zero, then display of <sgmltag>refclass</sgmltag> contents is 2544suppressed in output.</para> 2545 2546</refsect1> 2547</doc:refentry> 2548<xsl:param name="refclass.suppress" select="0"/> 2549 2550<doc:refentry><refmeta> 2551<refentrytitle>default.table.width</refentrytitle> 2552<refmiscinfo role="type">length</refmiscinfo> 2553</refmeta><refnamediv> 2554<refname>default.table.width</refname> 2555<refpurpose>The default width of tables</refpurpose> 2556</refnamediv><refsynopsisdiv> 2557 2558</refsynopsisdiv><refsect1><title>Description</title> 2559 2560<para>If specified, this value will be used for the WIDTH attribute on 2561tables that do not specify an alternate width (with the dbhtml processing 2562instruction).</para> 2563 2564</refsect1> 2565</doc:refentry> 2566<xsl:param name="default.table.width" select="''"/> 2567 2568<doc:refentry><refmeta> 2569<refentrytitle>nominal.table.width</refentrytitle> 2570<refmiscinfo role="type">length</refmiscinfo> 2571</refmeta><refnamediv> 2572<refname>nominal.table.width</refname> 2573<refpurpose>The (absolute) nominal width of tables</refpurpose> 2574</refnamediv><refsynopsisdiv> 2575 2576</refsynopsisdiv><refsect1><title>Description</title> 2577 2578<para>In order to convert CALS column widths into HTML column widths, it 2579is sometimes necessary to have an absolute table width to use for conversion 2580of mixed absolute and relative widths. This value must be an absolute 2581length (not a percentag).</para> 2582 2583</refsect1> 2584</doc:refentry> 2585<xsl:param name="nominal.table.width" select="'6in'"/> 2586 2587<doc:refentry><refmeta> 2588<refentrytitle>table.borders.with.css</refentrytitle> 2589<refmiscinfo role="type">boolean</refmiscinfo> 2590</refmeta><refnamediv> 2591<refname>table.borders.with.css</refname> 2592<refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose> 2593</refnamediv><refsynopsisdiv> 2594 2595</refsynopsisdiv><refsect1><title>Description</title> 2596 2597<para>If true (non-zero), CSS will be used to draw table borders. 2598</para> 2599 2600</refsect1> 2601</doc:refentry> 2602<xsl:param name="table.borders.with.css" select="0"/> 2603 2604<doc:refentry><refmeta> 2605<refentrytitle>table.cell.border.style</refentrytitle> 2606<refmiscinfo role="type"/> 2607</refmeta><refnamediv> 2608<refname>table.cell.border.style</refname> 2609<refpurpose/> 2610</refnamediv><refsynopsisdiv> 2611 2612</refsynopsisdiv><refsect1><title>Description</title> 2613 2614<para>FIXME:</para> 2615 2616</refsect1> 2617</doc:refentry> 2618<xsl:param name="table.cell.border.style" select="'solid'"/> 2619 2620<doc:refentry><refmeta> 2621<refentrytitle>table.cell.border.thickness</refentrytitle> 2622<refmiscinfo role="type"/> 2623</refmeta><refnamediv> 2624<refname>table.cell.border.thickness</refname> 2625<refpurpose/> 2626</refnamediv><refsynopsisdiv> 2627 2628</refsynopsisdiv><refsect1><title>Description</title> 2629 2630<para>FIXME:</para> 2631 2632</refsect1> 2633</doc:refentry> 2634<xsl:param name="table.cell.border.thickness" select="'0.5pt'"/> 2635 2636<doc:refentry><refmeta> 2637<refentrytitle>table.cell.border.color</refentrytitle> 2638<refmiscinfo role="type"/> 2639</refmeta><refnamediv> 2640<refname>table.cell.border.color</refname> 2641<refpurpose/> 2642</refnamediv><refsynopsisdiv> 2643 2644</refsynopsisdiv><refsect1><title>Description</title> 2645 2646<para>FIXME:</para> 2647 2648</refsect1> 2649</doc:refentry> 2650<xsl:param name="table.cell.border.color" select="''"/> 2651 2652 2653<doc:refentry><refmeta> 2654<refentrytitle>table.frame.border.style</refentrytitle> 2655<refmiscinfo role="type"/> 2656</refmeta><refnamediv> 2657<refname>table.frame.border.style</refname> 2658<refpurpose/> 2659</refnamediv><refsynopsisdiv> 2660 2661</refsynopsisdiv><refsect1><title>Description</title> 2662 2663<para>FIXME:</para> 2664 2665</refsect1> 2666</doc:refentry> 2667<xsl:param name="table.frame.border.style" select="'solid'"/> 2668 2669<doc:refentry><refmeta> 2670<refentrytitle>table.frame.border.thickness</refentrytitle> 2671<refmiscinfo role="type"/> 2672</refmeta><refnamediv> 2673<refname>table.frame.border.thickness</refname> 2674<refpurpose>Specifies the thickness of the frame border</refpurpose> 2675</refnamediv><refsynopsisdiv> 2676 2677</refsynopsisdiv><refsect1><title>Description</title> 2678 2679<para>Specifies the thickness of the border on the table's frame.</para> 2680 2681</refsect1> 2682</doc:refentry> 2683<xsl:param name="table.frame.border.thickness" select="'0.5pt'"/> 2684 2685<doc:refentry><refmeta> 2686<refentrytitle>table.frame.border.color</refentrytitle> 2687<refmiscinfo role="type"/> 2688</refmeta><refnamediv> 2689<refname>table.frame.border.color</refname> 2690<refpurpose/> 2691</refnamediv><refsynopsisdiv> 2692 2693</refsynopsisdiv><refsect1><title>Description</title> 2694 2695<para>FIXME:</para> 2696 2697</refsect1> 2698</doc:refentry> 2699<xsl:param name="table.frame.border.color" select="''"/> 2700 2701 2702<doc:refentry><refmeta> 2703<refentrytitle>default.table.frame</refentrytitle> 2704<refmiscinfo role="type">string</refmiscinfo> 2705</refmeta><refnamediv> 2706<refname>default.table.frame</refname> 2707<refpurpose>The default framing of tables</refpurpose> 2708</refnamediv><refsynopsisdiv> 2709 2710</refsynopsisdiv><refsect1><title>Description</title> 2711 2712<para>This value will be used when there is no frame attribute on the table.</para> 2713 2714</refsect1> 2715</doc:refentry> 2716<xsl:param name="default.table.frame" select="'all'"/> 2717 2718<doc:refentry><refmeta> 2719<refentrytitle>html.cellspacing</refentrytitle> 2720<refmiscinfo role="type">integer</refmiscinfo> 2721</refmeta><refnamediv> 2722<refname>html.cellspacing</refname> 2723<refpurpose>Default value for cellspacing in HTML tables</refpurpose> 2724</refnamediv><refsynopsisdiv> 2725 2726</refsynopsisdiv><refsect1><title>Description</title> 2727 2728<para>If specified, this value will be used as the default cellspacing value 2729in HTML tables.</para> 2730 2731</refsect1> 2732</doc:refentry> 2733<xsl:param name="html.cellspacing" select="''"/> 2734 2735<doc:refentry><refmeta> 2736<refentrytitle>html.cellpadding</refentrytitle> 2737<refmiscinfo role="type">integer</refmiscinfo> 2738</refmeta><refnamediv> 2739<refname>html.cellpadding</refname> 2740<refpurpose>Default value for cellpadding in HTML tables</refpurpose> 2741</refnamediv><refsynopsisdiv> 2742 2743</refsynopsisdiv><refsect1><title>Description</title> 2744 2745<para>If specified, this value will be used as the default cellpadding value 2746in HTML tables.</para> 2747 2748</refsect1> 2749</doc:refentry> 2750<xsl:param name="html.cellpadding" select="''"/> 2751 2752<doc:refentry><refmeta> 2753<refentrytitle>qanda.defaultlabel</refentrytitle> 2754<refmiscinfo role="type">boolean</refmiscinfo> 2755</refmeta><refnamediv> 2756<refname>qanda.defaultlabel</refname> 2757<refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> 2758</refnamediv><refsynopsisdiv> 2759 2760</refsynopsisdiv><refsect1><title>Description</title> 2761 2762<para>If no defaultlabel attribute is specified on a QandASet, this 2763value is used. It must be one of the legal values for the defaultlabel 2764attribute. 2765</para> 2766 2767</refsect1> 2768</doc:refentry> 2769<xsl:param name="qanda.defaultlabel">number</xsl:param> 2770 2771<doc:refentry><refmeta> 2772<refentrytitle>qanda.inherit.numeration</refentrytitle> 2773<refmiscinfo role="type">boolean</refmiscinfo> 2774</refmeta><refnamediv> 2775<refname>qanda.inherit.numeration</refname> 2776<refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose> 2777</refnamediv><refsynopsisdiv> 2778 2779</refsynopsisdiv><refsect1><title>Description</title> 2780 2781<para>If true (non-zero), numbered QandADiv elements and Questions and Answers inherit 2782the numeration of the ancestors of the QandASet. 2783</para> 2784 2785</refsect1> 2786</doc:refentry> 2787<xsl:param name="qanda.inherit.numeration" select="1"/> 2788 2789<doc:refentry><refmeta> 2790<refentrytitle>target.database.document</refentrytitle> 2791<refmiscinfo role="type">uri</refmiscinfo> 2792</refmeta><refnamediv> 2793<refname>target.database.document</refname> 2794<refpurpose>Name of master database file for resolving 2795olinks</refpurpose> 2796</refnamediv><refsynopsisdiv> 2797</refsynopsisdiv><refsect1> 2798<title>Description</title> 2799<para> 2800To resolve olinks between documents, the stylesheets use 2801a master database document that identifies the target datafiles for all the documents within the scope 2802of the olinks. This parameter value is the URI of 2803the master document to be read during processing to resolve olinks. 2804The default value is <filename>olinkdb.xml</filename>.</para> 2805<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>. 2806 2807</para> 2808</refsect1> 2809</doc:refentry> 2810<xsl:param name="target.database.document" select="''"/> 2811 2812<doc:refentry><refmeta> 2813<refentrytitle>targets.filename</refentrytitle> 2814<refmiscinfo role="type">string</refmiscinfo> 2815</refmeta><refnamediv> 2816<refname>targets.filename</refname> 2817<refpurpose>Name of cross reference targets data file</refpurpose> 2818</refnamediv><refsynopsisdiv> 2819</refsynopsisdiv><refsect1> 2820<title>Description</title> 2821<para> 2822In order to resolve olinks efficiently, the stylesheets can 2823generate an external data file containing information about 2824all potential cross reference endpoints in a document. 2825This parameter lets you change the name of the generated 2826file from the default name <filename>target.db</filename>. 2827The name must agree with that used in the target database 2828used to resolve olinks during processing. 2829See also <parameter>target.database.document</parameter>. 2830</para> 2831</refsect1> 2832</doc:refentry> 2833<xsl:param name="targets.filename" select="'target.db'"/> 2834 2835<doc:refentry><refmeta> 2836<refentrytitle>olink.base.uri</refentrytitle> 2837<refmiscinfo role="type">uri</refmiscinfo> 2838</refmeta><refnamediv> 2839<refname>olink.base.uri</refname> 2840<refpurpose>Base URI used in olink hrefs</refpurpose> 2841</refnamediv><refsynopsisdiv> 2842</refsynopsisdiv><refsect1> 2843<title>Description</title> 2844<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> 2845</refsect1> 2846</doc:refentry> 2847<xsl:param name="olink.base.uri" select="''"/> 2848 2849<doc:refentry><refmeta> 2850<refentrytitle>use.local.olink.style</refentrytitle> 2851<refmiscinfo role="type">boolean</refmiscinfo> 2852</refmeta><refnamediv> 2853<refname>use.local.olink.style</refname> 2854<refpurpose>Process olinks using xref style of current 2855document</refpurpose> 2856</refnamediv><refsynopsisdiv> 2857</refsynopsisdiv><refsect1> 2858<title>Description</title> 2859<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 2860reference string is formed again from the target title, number, and 2861element name, using the stylesheet processing the targeting document. 2862Then olinks will match the xref style in the targeting document 2863rather than in the target document. If both documents are processed 2864with the same stylesheet, then the results will be the same.</para> 2865</refsect1> 2866</doc:refentry> 2867<xsl:param name="use.local.olink.style" select="0"/> 2868 2869<doc:refentry><refmeta> 2870<refentrytitle>current.docid</refentrytitle> 2871<refmiscinfo role="type">string</refmiscinfo> 2872</refmeta><refnamediv> 2873<refname>current.docid</refname> 2874<refpurpose>targetdoc identifier for the document being 2875processed</refpurpose> 2876</refnamediv><refsynopsisdiv> 2877</refsynopsisdiv><refsect1> 2878<title>Description</title> 2879<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 2880the targetdoc identifier of the current document, since that 2881identifier does not appear in the document itself. </para> 2882<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> 2883</refsect1> 2884</doc:refentry> 2885<xsl:param name="current.docid" select="''"/> 2886 2887<doc:refentry><refmeta> 2888<refentrytitle>olink.doctitle</refentrytitle> 2889<refmiscinfo role="type">string</refmiscinfo> 2890</refmeta><refnamediv> 2891<refname>olink.doctitle</refname> 2892<refpurpose>show the document title for external olinks?</refpurpose> 2893 2894</refnamediv><refsynopsisdiv> 2895</refsynopsisdiv><refsect1> 2896<title>Description</title> 2897<para>When olinks between documents are resolved, the generated text 2898may not make it clear that the reference is to another document. 2899It is possible for the stylesheets to append the other document's 2900title to external olinks. For this to happen, two parameters must 2901be set.</para> 2902<itemizedlist> 2903<listitem> 2904<para>This <parameter>olink.doctitle</parameter> parameter 2905should be set to either <literal>yes</literal> or <literal>maybe</literal> 2906to enable this feature. 2907</para> 2908</listitem> 2909<listitem> 2910<para>And you should also set the <parameter>current.docid</parameter> 2911parameter to the document id for the document currently 2912being processed for output. 2913</para> 2914</listitem> 2915</itemizedlist> 2916 2917<para> 2918Then if an olink's <literal>targetdoc</literal> id differs from 2919the <literal>current.docid</literal> value, the stylesheet knows 2920that it is a reference to another document and can 2921append the target document's 2922title to the generated olink text. </para> 2923 2924<para>The text for the target document's title is copied from the 2925olink database from the <sgmltag>ttl</sgmltag> element 2926of the top-level <sgmltag>div</sgmltag> for that document. 2927If that <sgmltag>ttl</sgmltag> element is missing or empty, 2928no title is output. 2929</para> 2930 2931<para>The supported values for <parameter>olink.doctitle</parameter> are: 2932</para> 2933<variablelist> 2934<varlistentry> 2935<term><literal>yes</literal></term> 2936<listitem> 2937<para> 2938Always insert the title to the target document if it is not 2939the current document. 2940</para> 2941</listitem> 2942</varlistentry> 2943<varlistentry> 2944<term><literal>no</literal></term> 2945<listitem> 2946<para> 2947Never insert the title to the target document, even if requested 2948in an <sgmltag class="attribute">xrefstyle</sgmltag> attribute. 2949</para> 2950</listitem> 2951</varlistentry> 2952<varlistentry> 2953<term><literal>maybe</literal></term> 2954<listitem> 2955<para> 2956Only insert the title to the target document, if requested 2957in an <sgmltag class="attribute">xrefstyle</sgmltag> attribute. 2958</para> 2959</listitem> 2960</varlistentry> 2961</variablelist> 2962<para>An <sgmltag class="attribute">xrefstyle</sgmltag> attribute 2963may override the global setting for individual olinks. 2964The following values are supported in an 2965<sgmltag class="attribute">xrefstyle</sgmltag> 2966attribute using the <literal>select:</literal> syntax: 2967</para> 2968 2969<variablelist> 2970<varlistentry> 2971<term><literal>docname</literal></term> 2972<listitem> 2973<para> 2974Insert the target document name for this olink using the 2975<literal>docname</literal> gentext template, but only 2976if the value of <parameter>olink.doctitle</parameter> 2977is not <literal>no</literal>. 2978</para> 2979</listitem> 2980</varlistentry> 2981<varlistentry> 2982<term><literal>docnamelong</literal></term> 2983<listitem> 2984<para> 2985Insert the target document name for this olink using the 2986<literal>docnamelong</literal> gentext template, but only 2987if the value of <parameter>olink.doctitle</parameter> 2988is not <literal>no</literal>. 2989</para> 2990</listitem> 2991</varlistentry> 2992<varlistentry> 2993<term><literal>nodocname</literal></term> 2994<listitem> 2995<para> 2996Omit the target document name even if 2997the value of <parameter>olink.doctitle</parameter> 2998is <literal>yes</literal>. 2999</para> 3000</listitem> 3001</varlistentry> 3002</variablelist> 3003<para>Another way of inserting the target document name 3004for a single olink is to employ an 3005<sgmltag class="attribute">xrefstyle</sgmltag> 3006attribute using the <literal>template:</literal> syntax. 3007The <literal>%o</literal> placeholder (the letter o, not zero) 3008in such a template 3009will be filled in with the target document's title when it is processed. 3010This will occur regardless of 3011the value of <parameter>olink.doctitle</parameter>. 3012</para> 3013<para>Note that prior to version 1.66 of the XSL stylesheets, 3014the allowed values for this parameter were 0 and 1. Those 3015values are still supported and mapped to 'no' and 'yes', respectively. 3016</para> 3017</refsect1> 3018</doc:refentry> 3019<xsl:param name="olink.doctitle" select="'no'"/> 3020 3021<doc:refentry><refmeta> 3022<refentrytitle>olink.debug</refentrytitle> 3023<refmiscinfo role="type">boolean</refmiscinfo> 3024</refmeta><refnamediv> 3025<refname>olink.debug</refname> 3026<refpurpose>Turn on debugging messages for olinks</refpurpose> 3027</refnamediv><refsynopsisdiv> 3028 3029</refsynopsisdiv><refsect1><title>Description</title> 3030 3031<para>If non-zero, then each olink will generate several 3032messages about how it is being resolved during processing. 3033This is useful when an olink does not resolve properly 3034and the standard error messages are not sufficient to 3035find the problem. 3036</para> 3037 3038<para>You may need to read through the olink XSL templates 3039to understand the context for some of the debug messages. 3040</para> 3041 3042</refsect1> 3043</doc:refentry> 3044<xsl:param name="olink.debug" select="0"/> 3045 3046<doc:refentry><refnamediv> 3047<refname>olink.properties</refname> 3048<refpurpose>Properties associated with the cross-reference 3049text of an olink.</refpurpose> 3050</refnamediv><refsynopsisdiv> 3051 3052</refsynopsisdiv><refsect1><title>Description</title> 3053 3054<para>This attribute set is used on cross reference text 3055from an olink. It is not applied to the 3056optional page number or 3057optional title of the external document.</para> 3058 3059</refsect1> 3060</doc:refentry> 3061<xsl:attribute-set name="olink.properties"> 3062</xsl:attribute-set> 3063 3064<doc:refentry><refmeta> 3065<refentrytitle>olink.lang.fallback.sequence</refentrytitle> 3066<refmiscinfo role="type">string</refmiscinfo> 3067</refmeta><refnamediv> 3068<refname>olink.lang.fallback.sequence</refname> 3069<refpurpose>look up translated documents if olink not found?</refpurpose> 3070 3071</refnamediv><refsynopsisdiv> 3072</refsynopsisdiv><refsect1> 3073<title>Description</title> 3074 3075<para>This parameter defines a list of lang values 3076to search among to resolve olinks. 3077</para> 3078 3079<para>Normally an olink tries to resolve to a document in the same 3080language as the olink itself. The language of an olink 3081is determined by its nearest ancestor element with a 3082<sgmltag class="attribute">lang</sgmltag> attribute, otherwise the 3083value of the <parameter>l10n.gentext.default.lang</parameter> 3084parameter. 3085</para> 3086 3087<para>An olink database can contain target data for the same 3088document in multiple languages. Each set of data has the 3089same value for the <sgmltag>targetdoc</sgmltag> attribute in 3090the <sgmltag>document</sgmltag> element in the database, but with a 3091different <sgmltag>lang</sgmltag> attribute value. 3092</para> 3093 3094<para>When an olink is being resolved, the target is first 3095sought in the document with the same language as the olink. 3096If no match is found there, then this parameter is consulted 3097for additional languages to try.</para> 3098 3099<para>The <parameter>olink.lang.fallback.sequence</parameter> 3100must be a whitespace separated list of lang values to 3101try. The first one with a match in the olink database is used. 3102The default value is empty.</para> 3103 3104<para>For example, a document might be written in German 3105and contain an olink with 3106<literal>targetdoc="adminguide"</literal>. 3107When the document is processed, the processor 3108first looks for a target dataset in the 3109olink database starting with:</para> 3110 3111<literallayout><literal><document targetdoc="adminguide" lang="de"></literal>. 3112</literallayout> 3113 3114<para>If there is no such element, then the 3115<parameter>olink.lang.fallback.sequence</parameter> 3116parameter is consulted. 3117If its value is, for example, <quote>fr en</quote>, then the processor next 3118looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and 3119then for <literal>targetdoc="adminguide" lang="en"</literal>. 3120If there is still no match, it looks for 3121<literal>targetdoc="adminguide"</literal> with no 3122lang attribute. 3123</para> 3124 3125<para>This parameter is useful when a set of documents is only 3126partially translated, or is in the process of being translated. 3127If a target of an olink has not yet been translated, then this 3128parameter permits the processor to look for the document in 3129other languages. This assumes the reader would rather have 3130a link to a document in a different language than to have 3131a broken link. 3132</para> 3133 3134</refsect1> 3135</doc:refentry> 3136<xsl:param name="olink.lang.fallback.sequence" select="''"/> 3137 3138<doc:refentry><refmeta> 3139<refentrytitle>insert.olink.page.number</refentrytitle> 3140<refmiscinfo role="type">string</refmiscinfo> 3141</refmeta><refnamediv> 3142<refname>insert.olink.page.number</refname> 3143<refpurpose>Turns page numbers in olinks on and off</refpurpose> 3144</refnamediv><refsynopsisdiv> 3145 3146</refsynopsisdiv><refsect1><title>Description</title> 3147 3148<para>The value of this parameter determines if 3149cross references made between documents with 3150<sgmltag>olink</sgmltag> will 3151include page number citations. 3152In most cases this is only applicable to references in printed output. 3153</para> 3154<para>The parameter has three possible values. 3155</para> 3156<variablelist> 3157<varlistentry> 3158<term>no</term> 3159<listitem><para>No page number references will be generated for olinks. 3160</para></listitem> 3161</varlistentry> 3162<varlistentry> 3163<term>yes</term> 3164<listitem><para>Page number references will be generated 3165for all <sgmltag>olink</sgmltag> references. 3166The style of page reference may be changed 3167if an <sgmltag class="attribute">xrefstyle</sgmltag> 3168attribute is used. 3169</para></listitem> 3170</varlistentry> 3171<varlistentry> 3172<term>maybe</term> 3173<listitem><para>Page number references will not be generated 3174for an <sgmltag>olink</sgmltag> element unless 3175it has an 3176<sgmltag class="attribute">xrefstyle</sgmltag> 3177attribute whose value specifies a page reference. 3178</para></listitem> 3179</varlistentry> 3180</variablelist> 3181<para>Olinks that point to targets within the same document 3182are treated as <sgmltag>xref</sgmltag>s, and controlled by 3183the <parameter>insert.xref.page.number</parameter> parameter. 3184</para> 3185 3186<para>Page number references for olinks to 3187external documents can only be inserted if the 3188information exists in the olink database. 3189This means each olink target element 3190(<sgmltag>div</sgmltag> or <sgmltag>obj</sgmltag>) 3191must have a <sgmltag class="attribute">page</sgmltag> attribute 3192whose value is its page number in the target document. 3193The XSL stylesheets are not able to extract that information 3194during processing because pages have not yet been created in 3195XSLT transformation. Only the XSL-FO processor knows what 3196page each element is placed on. 3197Therefore some postprocessing must take place to populate 3198page numbers in the olink database. 3199</para> 3200 3201 3202 3203</refsect1> 3204</doc:refentry> 3205<xsl:param name="insert.olink.page.number">no</xsl:param> 3206 3207<doc:refentry><refmeta> 3208<refentrytitle>insert.olink.pdf.frag</refentrytitle> 3209<refmiscinfo role="type">boolean</refmiscinfo> 3210</refmeta><refnamediv> 3211<refname>insert.olink.pdf.frag</refname> 3212<refpurpose>Add fragment identifiers for links into PDF files</refpurpose> 3213</refnamediv><refsynopsisdiv> 3214 3215</refsynopsisdiv><refsect1><title>Description</title> 3216 3217<para>The value of this parameter determines whether 3218the cross reference URIs to PDF documents made with 3219<sgmltag>olink</sgmltag> will 3220include fragment identifiers. 3221</para> 3222 3223<para>When forming a URI to link to a PDF document, 3224a fragment identifier (typically a '#' followed by an 3225id value) appended to the PDF filename can be used by 3226the PDF viewer to open 3227the PDF file to a location within the document instead of 3228the first page. 3229However, not all PDF files have id 3230values embedded in them, and not all PDF viewers can 3231handle fragment identifiers. 3232</para> 3233 3234<para>If <parameter>insert.olink.pdf.frag</parameter> is set 3235to a non-zero value, then any olink targeting a 3236PDF file will have the fragment identifier appended to the URI. 3237The URI is formed by concatenating the value of the 3238<parameter>olink.base.uri</parameter> parameter, the 3239value of the <sgmltag class="attribute">baseuri</sgmltag> 3240attribute from the <sgmltag class="element">document</sgmltag> 3241element in the olink database with the matching 3242<sgmltag class="attribute">targetdoc</sgmltag> value, 3243and the value of the <sgmltag class="attribute">href</sgmltag> 3244attribute for the targeted element in the olink database. 3245The <sgmltag class="attribute">href</sgmltag> attribute 3246contains the fragment identifier. 3247</para> 3248 3249<para>If <parameter>insert.olink.pdf.frag</parameter> is set 3250to zero (the default value), then 3251the <sgmltag class="attribute">href</sgmltag> attribute 3252from the olink database 3253is not appended to PDF olinks, so the fragment identifier is left off. 3254A PDF olink is any olink for which the 3255<sgmltag class="attribute">baseuri</sgmltag> attribute 3256from the matching <sgmltag class="element">document</sgmltag> 3257element in the olink database ends with '.pdf'. 3258Any other olinks will still have the fragment identifier added. 3259</para> 3260</refsect1> 3261</doc:refentry> 3262<xsl:param name="insert.olink.pdf.frag" select="0"/> 3263 3264<doc:refentry><refmeta> 3265<refentrytitle>prefer.internal.olink</refentrytitle> 3266<refmiscinfo role="type">boolean</refmiscinfo> 3267</refmeta><refnamediv> 3268<refname>prefer.internal.olink</refname> 3269<refpurpose>Prefer a local olink reference to an external reference</refpurpose> 3270</refnamediv><refsynopsisdiv> 3271 3272</refsynopsisdiv><refsect1><title>Description</title> 3273 3274<para>If you are re-using XML content modules in multiple documents, 3275you may want to redirect some of your olinks. This parameter 3276permits you to redirect an olink to the current document. 3277</para> 3278 3279<para>For example: you are writing documentation for a product, 3280which includes 3 manuals: a little installation 3281booklet (booklet.xml), a user 3282guide (user.xml), and a reference manual (reference.xml). 3283All 3 documents begin with the same introduction section (intro.xml) that 3284contains a reference to the customization section (custom.xml) which is 3285included in both user.xml and reference.xml documents. 3286</para> 3287 3288<para>How do you write the link to custom.xml in intro.xml 3289so that it is interpreted correctly in all 3 documents?</para> 3290<itemizedlist> 3291<listitem><para>If you use xref, it will fail in user.xml.</para> 3292</listitem> 3293<listitem><para>If you use olink (pointing to reference.xml), 3294the reference in user.xml 3295will point to the customization section of the reference manual, while it is 3296actually available in user.xml.</para> 3297</listitem> 3298</itemizedlist> 3299 3300<para>If you set the <parameter>prefer.internal.olink</parameter> 3301parameter to a non-zero value, then the processor will 3302first look in the olink database 3303for the olink's <sgmltag>targetptr</sgmltag> attribute value 3304in document matching the <parameter>current.docid</parameter> 3305parameter value. If it isn't found there, then 3306it tries the document in the database 3307with the <sgmltag>targetdoc</sgmltag> 3308value that matches the olink's <sgmltag>targetdoc</sgmltag> 3309attribute. 3310</para> 3311 3312<para>This feature permits an olink reference to resolve to 3313the current document if there is an element 3314with an id matching the olink's <sgmltag>targetptr</sgmltag> 3315value. The current document's olink data must be 3316included in the target database for this to work.</para> 3317 3318<caution> 3319<para>There is a potential for incorrect links if 3320the same <sgmltag>id</sgmltag> attribute value is used for different 3321content in different documents. 3322Some of your olinks may be redirected to the current document 3323when they shouldn't be. It is not possible to control 3324individual olink instances.</para> 3325</caution> 3326 3327</refsect1> 3328</doc:refentry> 3329<xsl:param name="prefer.internal.olink" select="0"/> 3330 3331<doc:refentry><refmeta> 3332<refentrytitle>link.mailto.url</refentrytitle> 3333<refmiscinfo role="type">string</refmiscinfo> 3334</refmeta><refnamediv> 3335<refname>link.mailto.url</refname> 3336<refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> 3337</refnamediv><refsynopsisdiv> 3338 3339</refsynopsisdiv><refsect1><title>Description</title> 3340 3341<para>If not the empty string, this address will be used for the 3342REL=made <sgmltag>LINK</sgmltag> element in the HTML <sgmltag>HEAD</sgmltag>. 3343</para> 3344 3345</refsect1> 3346</doc:refentry> 3347<xsl:param name="link.mailto.url"/> 3348 3349<doc:refentry><refmeta> 3350<refentrytitle>ulink.target</refentrytitle> 3351<refmiscinfo role="type">string</refmiscinfo> 3352</refmeta><refnamediv> 3353<refname>ulink.target</refname> 3354<refpurpose>The HTML anchor target for ULinks</refpurpose> 3355</refnamediv><refsynopsisdiv> 3356 3357</refsynopsisdiv><refsect1><title>Description</title> 3358 3359<para>If <parameter>ulink.target</parameter> is set, its value will 3360be used for the <sgmltag class="attribute">target</sgmltag> attribute 3361on anchors generated for <sgmltag>ulink</sgmltag>s.</para> 3362 3363</refsect1> 3364</doc:refentry> 3365<xsl:param name="ulink.target" select="'_top'"/> 3366 3367<doc:refentry><refmeta> 3368<refentrytitle>olink.fragid</refentrytitle> 3369<refmiscinfo role="type">string</refmiscinfo> 3370</refmeta><refnamediv> 3371<refname>olink.fragid</refname> 3372<refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose> 3373</refnamediv><refsynopsisdiv> 3374 3375</refsynopsisdiv><refsect1><title>Description</title> 3376 3377<para>FIXME:</para> 3378 3379</refsect1> 3380</doc:refentry> 3381<xsl:param name="olink.fragid" select="'fragid='"/> 3382 3383<doc:refentry><refmeta> 3384<refentrytitle>olink.outline.ext</refentrytitle> 3385<refmiscinfo role="type">string</refmiscinfo> 3386</refmeta><refnamediv> 3387<refname>olink.outline.ext</refname> 3388<refpurpose>The extension of OLink outline files</refpurpose> 3389</refnamediv><refsynopsisdiv> 3390 3391</refsynopsisdiv><refsect1><title>Description</title> 3392 3393<para>FIXME:</para> 3394 3395</refsect1> 3396</doc:refentry> 3397<xsl:param name="olink.outline.ext" select="'.olink'"/> 3398 3399<doc:refentry><refmeta> 3400<refentrytitle>olink.pubid</refentrytitle> 3401<refmiscinfo role="type">string</refmiscinfo> 3402</refmeta><refnamediv> 3403<refname>olink.pubid</refname> 3404<refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose> 3405</refnamediv><refsynopsisdiv> 3406 3407</refsynopsisdiv><refsect1><title>Description</title> 3408 3409<para>FIXME:</para> 3410 3411</refsect1> 3412</doc:refentry> 3413<xsl:param name="olink.pubid" select="'pubid='"/> 3414 3415<doc:refentry><refmeta> 3416<refentrytitle>olink.sysid</refentrytitle> 3417<refmiscinfo role="type">string</refmiscinfo> 3418</refmeta><refnamediv> 3419<refname>olink.sysid</refname> 3420<refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose> 3421</refnamediv><refsynopsisdiv> 3422 3423</refsynopsisdiv><refsect1><title>Description</title> 3424 3425<para>FIXME:</para> 3426 3427</refsect1> 3428</doc:refentry> 3429<xsl:param name="olink.sysid" select="'sysid='"/> 3430 3431<doc:refentry><refmeta> 3432<refentrytitle>olink.resolver</refentrytitle> 3433<refmiscinfo role="type"/> 3434</refmeta><refnamediv> 3435<refname>olink.resolver</refname> 3436<refpurpose>The root name of the OLink resolver (usually a script)</refpurpose> 3437</refnamediv><refsynopsisdiv> 3438 3439</refsynopsisdiv><refsect1><title>Description</title> 3440 3441<para>FIXME:</para> 3442 3443</refsect1> 3444</doc:refentry> 3445<xsl:param name="olink.resolver" select="'/cgi-bin/olink'"/> 3446 3447<doc:refentry><refmeta> 3448<refentrytitle>collect.xref.targets</refentrytitle> 3449<refmiscinfo role="type">string</refmiscinfo> 3450</refmeta><refnamediv> 3451<refname>collect.xref.targets</refname> 3452<refpurpose>Controls whether cross reference data is 3453collected</refpurpose> 3454</refnamediv><refsynopsisdiv> 3455</refsynopsisdiv><refsect1> 3456<title>Description</title> 3457<para> 3458In order to resolve olinks efficiently, the stylesheets can 3459generate an external data file containing information about 3460all potential cross reference endpoints in a document. 3461This 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. 3462See also <parameter>targets.filename</parameter>. 3463</para> 3464</refsect1> 3465</doc:refentry> 3466<xsl:param name="collect.xref.targets" select="'no'"/> 3467 3468<doc:refentry><refmeta> 3469<refentrytitle>insert.xref.page.number</refentrytitle> 3470<refmiscinfo role="type">string</refmiscinfo> 3471</refmeta><refnamediv> 3472<refname>insert.xref.page.number</refname> 3473<refpurpose>Turns page numbers in xrefs on and off</refpurpose> 3474</refnamediv><refsynopsisdiv> 3475 3476</refsynopsisdiv><refsect1><title>Description</title> 3477 3478<para>The value of this parameter determines if 3479cross references (<sgmltag>xref</sgmltag>s) in 3480printed output will 3481include page number citations. 3482It has three possible values. 3483</para> 3484<variablelist> 3485<varlistentry> 3486<term>no</term> 3487<listitem><para>No page number references will be generated. 3488</para></listitem> 3489</varlistentry> 3490<varlistentry> 3491<term>yes</term> 3492<listitem><para>Page number references will be generated 3493for all <sgmltag>xref</sgmltag> elements. 3494The style of page reference may be changed 3495if an <sgmltag class="attribute">xrefstyle</sgmltag> 3496attribute is used. 3497</para></listitem> 3498</varlistentry> 3499<varlistentry> 3500<term>maybe</term> 3501<listitem><para>Page number references will not be generated 3502for an <sgmltag>xref</sgmltag> element unless 3503it has an 3504<sgmltag class="attribute">xrefstyle</sgmltag> 3505attribute whose value specifies a page reference. 3506</para></listitem> 3507</varlistentry> 3508</variablelist> 3509 3510</refsect1> 3511</doc:refentry> 3512<xsl:param name="insert.xref.page.number">no</xsl:param> 3513 3514<doc:refentry><refmeta> 3515<refentrytitle>use.role.as.xrefstyle</refentrytitle> 3516<refmiscinfo role="type">boolean</refmiscinfo> 3517</refmeta><refnamediv> 3518<refname>use.role.as.xrefstyle</refname> 3519<refpurpose>Use <sgmltag class="attribute">role</sgmltag> attribute for 3520<sgmltag class="attribute">xrefstyle</sgmltag> on <sgmltag>xref</sgmltag>?</refpurpose> 3521</refnamediv><refsynopsisdiv> 3522 3523</refsynopsisdiv><refsect1><title>Description</title> 3524 3525<para>If non-zero, the <sgmltag class="attribute">role</sgmltag> attribute on 3526<sgmltag>xref</sgmltag> will be used to select the cross reference style. 3527The <ulink url="http://www.oasis-open.org/docbook/">DocBook 3528Technical Committee</ulink> recently added an 3529<sgmltag class="attribute">xrefstyle</sgmltag> attribute for this purpose. 3530If the <sgmltag class="attribute">xrefstyle</sgmltag> attribute 3531is present, <sgmltag class="attribute">role</sgmltag> will be ignored, regardless 3532of this setting.</para> 3533 3534<para>Until an official DocBook release that includes the new 3535attribute, this flag allows <sgmltag class="attribute">role</sgmltag> 3536to serve that purpose.</para> 3537 3538</refsect1><refsect1><title>Example</title> 3539 3540<para>The following small stylesheet shows how to configure the stylesheets to make 3541use of the cross reference style:</para> 3542 3543<programlisting><?xml version="1.0"?> 3544<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 3545 version="1.0"> 3546 3547<xsl:import href="../xsl/html/docbook.xsl"/> 3548 3549<xsl:output method="html"/> 3550 3551<xsl:param name="local.l10n.xml" select="document('')"/> 3552<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> 3553 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"> 3554 <l:context name="xref"> 3555 <l:template name="chapter" style="title" text="Chapter %n, %t"/> 3556 <l:template name="chapter" text="Chapter %n"/> 3557 </l:context> 3558 </l:l10n> 3559</l:i18n> 3560 3561</xsl:stylesheet></programlisting> 3562 3563<para>With this stylesheet, the cross references in the following document:</para> 3564 3565<programlisting><?xml version="1.0" encoding="utf-8"?> 3566<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 3567 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 3568<book id="book"><title>Book</title> 3569 3570<preface> 3571<title>Preface</title> 3572 3573<para>Normal: <xref linkend="ch1"/>.</para> 3574<para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para> 3575 3576</preface> 3577 3578<chapter id="ch1"> 3579<title>First Chapter</title> 3580 3581<para>Irrelevant.</para> 3582 3583</chapter> 3584</book></programlisting> 3585 3586<para>will appear as:</para> 3587 3588<informalexample> 3589<para>Normal: Chapter 1.</para> 3590<para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para> 3591</informalexample> 3592</refsect1> 3593</doc:refentry> 3594<xsl:param name="use.role.as.xrefstyle" select="1"/> 3595 3596<doc:refentry><refmeta> 3597<refentrytitle>xref.with.number.and.title</refentrytitle> 3598<refmiscinfo role="type">boolean</refmiscinfo> 3599</refmeta><refnamediv> 3600<refname>xref.with.number.and.title</refname> 3601<refpurpose>Use number and title in cross references</refpurpose> 3602</refnamediv><refsynopsisdiv> 3603 3604</refsynopsisdiv><refsect1><title>Description</title> 3605 3606<para>FIXME:</para> 3607 3608</refsect1> 3609</doc:refentry> 3610<xsl:param name="xref.with.number.and.title" select="1"/> 3611 3612<doc:refentry><refmeta> 3613<refentrytitle>xref.label-page.separator</refentrytitle> 3614<refmiscinfo role="type">string</refmiscinfo> 3615</refmeta><refnamediv> 3616<refname>xref.label-page.separator</refname> 3617<refpurpose>Punctuation or space separating label from page number in xref</refpurpose> 3618</refnamediv><refsynopsisdiv> 3619 3620</refsynopsisdiv><refsect1><title>Description</title> 3621 3622<para> 3623This parameter allows you to control the punctuation of certain 3624types of generated cross reference text. 3625When cross reference text is generated for an 3626<sgmltag class="element">xref</sgmltag> or 3627<sgmltag class="element">olink</sgmltag> element 3628using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute 3629that makes use of the <literal>select:</literal> feature, 3630and the selected components include both label and page 3631but no title, 3632then the value of this parameter is inserted between 3633label and page number in the output. 3634If a title is included, then other separators are used. 3635</para> 3636 3637</refsect1> 3638</doc:refentry> 3639<xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param> 3640 3641<doc:refentry><refmeta> 3642<refentrytitle>xref.label-title.separator</refentrytitle> 3643<refmiscinfo role="type">string</refmiscinfo> 3644</refmeta><refnamediv> 3645<refname>xref.label-title.separator</refname> 3646<refpurpose>Punctuation or space separating label from title in xref</refpurpose> 3647</refnamediv><refsynopsisdiv> 3648 3649</refsynopsisdiv><refsect1><title>Description</title> 3650 3651<para> 3652This parameter allows you to control the punctuation of certain 3653types of generated cross reference text. 3654When cross reference text is generated for an 3655<sgmltag class="element">xref</sgmltag> or 3656<sgmltag class="element">olink</sgmltag> element 3657using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute 3658that makes use of the <literal>select:</literal> feature, 3659and the selected components include both label and title, 3660then the value of this parameter is inserted between 3661label and title in the output. 3662</para> 3663 3664</refsect1> 3665</doc:refentry> 3666<xsl:param name="xref.label-title.separator">: </xsl:param> 3667 3668<doc:refentry><refmeta> 3669<refentrytitle>xref.title-page.separator</refentrytitle> 3670<refmiscinfo role="type">string</refmiscinfo> 3671</refmeta><refnamediv> 3672<refname>xref.title-page.separator</refname> 3673<refpurpose>Punctuation or space separating title from page number in xref</refpurpose> 3674</refnamediv><refsynopsisdiv> 3675 3676</refsynopsisdiv><refsect1><title>Description</title> 3677 3678<para> 3679This parameter allows you to control the punctuation of certain 3680types of generated cross reference text. 3681When cross reference text is generated for an 3682<sgmltag class="element">xref</sgmltag> or 3683<sgmltag class="element">olink</sgmltag> element 3684using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute 3685that makes use of the <literal>select:</literal> feature, 3686and the selected components include both title and page number, 3687then the value of this parameter is inserted between 3688title and page number in the output. 3689</para> 3690 3691</refsect1> 3692</doc:refentry> 3693<xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param> 3694 3695<doc:refentry><refmeta> 3696<refentrytitle>segmentedlist.as.table</refentrytitle> 3697<refmiscinfo role="type">boolean</refmiscinfo> 3698</refmeta><refnamediv> 3699<refname>segmentedlist.as.table</refname> 3700<refpurpose>Format segmented lists as tables?</refpurpose> 3701</refnamediv><refsynopsisdiv> 3702 3703</refsynopsisdiv><refsect1><title>Description</title> 3704 3705<para>If non-zero, <sgmltag>segmentedlist</sgmltag>s will be formatted as 3706tables.</para> 3707 3708</refsect1> 3709</doc:refentry> 3710<xsl:param name="segmentedlist.as.table" select="0"/> 3711 3712<doc:refentry><refmeta> 3713<refentrytitle>variablelist.as.table</refentrytitle> 3714<refmiscinfo role="type">boolean</refmiscinfo> 3715</refmeta><refnamediv> 3716<refname>variablelist.as.table</refname> 3717<refpurpose>Format <sgmltag>variablelist</sgmltag>s as tables?</refpurpose> 3718</refnamediv><refsynopsisdiv> 3719 3720</refsynopsisdiv><refsect1><title>Description</title> 3721 3722<para>If non-zero, <sgmltag>variablelist</sgmltag>s will be formatted as 3723tables. A processing instruction exists to specify a particualar width for the 3724column containing the <sgmltag>term</sgmltag>s: 3725<sgmltag class="pi">dbhtml term-width=".25in"</sgmltag></para> 3726 3727<para>You can override this setting with a processing instruction as the 3728child of <sgmltag>variablelist</sgmltag>: <sgmltag class="pi">dbhtml 3729list-presentation="table"</sgmltag> or <sgmltag class="pi">dbhtml 3730list-presentation="list"</sgmltag>.</para> 3731 3732<para>This parameter only applys to the HTML transformations. In the 3733FO case, proper list markup is robust enough to handle the formatting. 3734But see also <parameter>variablelist.as.blocks</parameter>.</para> 3735 3736<programlisting> <variablelist> 3737 <?dbhtml list-presentation="table"?> 3738 <?dbhtml term-width="1.5in"?> 3739 <?dbfo list-presentation="list"?> 3740 <?dbfo term-width="1in"?> 3741 <varlistentry> 3742 <term>list</term> 3743 <listitem> 3744 <para> 3745 Formatted as a table even if variablelist.as.table is set to 0. 3746 </para> 3747 </listitem> 3748 </varlistentry> 3749 </variablelist></programlisting> 3750 3751</refsect1> 3752</doc:refentry> 3753<xsl:param name="variablelist.as.table" select="0"/> 3754 3755<doc:refentry><refmeta> 3756<refentrytitle>variablelist.term.separator</refentrytitle> 3757<refmiscinfo role="type">string</refmiscinfo> 3758</refmeta><refnamediv> 3759<refname>variablelist.term.separator</refname> 3760<refpurpose>Text to separate <tag>term</tag>s within a multi-term 3761<tag>varlistentry</tag></refpurpose> 3762</refnamediv><refsynopsisdiv> 3763 3764</refsynopsisdiv><refsect1><title>Description</title> 3765 3766<para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag> 3767elements, the string specified in the value of the 3768<parameter>variablelist.term.separator</parameter> parameter is placed 3769after each <tag>term</tag> except the last.</para> 3770 3771<note> 3772 <para>To generate a line break between multiple <tag>term</tag>s in 3773 a <tag>varlistentry</tag>, set a non-zero value for the 3774 <parameter>variablelist.term.break.after</parameter> parameter. If 3775 you do so, you may also want to set the value of the 3776 <parameter>variablelist.term.separator</parameter> parameter to an 3777 empty string (to suppress rendering of the default comma and space 3778 after each <tag>term</tag>).</para> 3779</note> 3780 3781</refsect1> 3782</doc:refentry> 3783<xsl:param name="variablelist.term.separator">, </xsl:param> 3784 3785<doc:refentry><refmeta> 3786<refentrytitle>variablelist.term.break.after</refentrytitle> 3787<refmiscinfo role="type">boolean</refmiscinfo> 3788</refmeta><refnamediv> 3789<refname>variablelist.term.break.after</refname> 3790<refpurpose>Generate line break after each <tag>term</tag> within a 3791multi-term <tag>varlistentry</tag>?</refpurpose> 3792</refnamediv><refsynopsisdiv> 3793 3794</refsynopsisdiv><refsect1><title>Description</title> 3795 3796<para>Set a non-zero value for the 3797<parameter>variablelist.term.break.after</parameter> parameter to 3798generate a line break between <tag>term</tag>s in a 3799multi-term <tag>varlistentry</tag>.</para> 3800 3801<note> 3802<para>If you set a non-zero value for 3803<parameter>variablelist.term.break.after</parameter>, you may also 3804want to set the value of the 3805<parameter>variablelist.term.separator</parameter> parameter to an 3806empty string (to suppress rendering of the default comma and space 3807after each <tag>term</tag>).</para> 3808</note> 3809 3810</refsect1> 3811</doc:refentry> 3812<xsl:param name="variablelist.term.break.after">0</xsl:param> 3813 3814<doc:refentry><refmeta> 3815<refentrytitle>biblioentry.item.separator</refentrytitle> 3816<refmiscinfo role="type">string</refmiscinfo> 3817</refmeta><refnamediv> 3818<refname>biblioentry.item.separator</refname> 3819<refpurpose>Text to separate bibliography entries</refpurpose> 3820</refnamediv><refsynopsisdiv> 3821 3822</refsynopsisdiv><refsect1><title>Description</title> 3823 3824<para>Text to separate bibliography entries 3825</para> 3826 3827</refsect1> 3828</doc:refentry> 3829<xsl:param name="biblioentry.item.separator">. </xsl:param> 3830 3831<doc:refentry><refmeta> 3832<refentrytitle>bibliography.collection</refentrytitle> 3833<refmiscinfo role="type">string</refmiscinfo> 3834</refmeta><refnamediv> 3835<refname>bibliography.collection</refname> 3836<refpurpose>Name of the bibliography collection file</refpurpose> 3837</refnamediv><refsynopsisdiv> 3838 3839</refsynopsisdiv><refsect1><title>Description</title> 3840 3841<para>Maintaining bibliography entries across a set of documents is tedious, time 3842consuming, and error prone. It makes much more sense, usually, to store all of 3843the bibliography entries in a single place and simply <quote>extract</quote> 3844the ones you need in each document.</para> 3845 3846<para>That's the purpose of the 3847<parameter>bibliography.collection</parameter> parameter. To setup a global 3848bibliography <quote>database</quote>, follow these steps:</para> 3849 3850<para>First, create a stand-alone bibliography document that contains all of 3851the documents that you wish to reference. Make sure that each bibliography 3852entry (whether you use <sgmltag>biblioentry</sgmltag> or <sgmltag>bibliomixed</sgmltag>) 3853has an ID.</para> 3854 3855<para>My global bibliography, <filename>~/bibliography.xml</filename> begins 3856like this:</para> 3857 3858<informalexample> 3859<programlisting><!DOCTYPE bibliography 3860 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 3861 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> 3862<bibliography><title>References</title> 3863 3864<bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray, 3865Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors. 3866<citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup 3867Language (XML) 1.0 Second Edition</ulink></citetitle>. 3868World Wide Web Consortium, 2000. 3869</bibliomixed> 3870 3871<bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray, 3872Dave Hollander, 3873and Andrew Layman, editors. 3874<citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in 3875XML</ulink></citetitle>. 3876World Wide Web Consortium, 1999. 3877</bibliomixed> 3878 3879<!-- ... --> 3880</bibliography> 3881</programlisting> 3882</informalexample> 3883 3884<para>When you create a bibliography in your document, simply 3885provide <emphasis>empty</emphasis> <sgmltag>bibliomixed</sgmltag> 3886entries for each document that you wish to cite. Make sure that these 3887elements have the same ID as the corresponding <quote>real</quote> 3888entry in your global bibliography.</para> 3889 3890<para>For example:</para> 3891 3892<informalexample> 3893<programlisting><bibliography><title>Bibliography</title> 3894 3895<bibliomixed id="xml-rec"/> 3896<bibliomixed id="xml-names"/> 3897<bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and 3898Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley, 38991986. ISBN 0-201-13437-3. 3900</bibliomixed> 3901<bibliomixed id="relaxng"/> 3902 3903</bibliography></programlisting> 3904</informalexample> 3905 3906<para>Note that it's perfectly acceptable to mix entries from your 3907global bibliography with <quote>normal</quote> entries. You can use 3908<sgmltag>xref</sgmltag> or other elements to cross-reference your 3909bibliography entries in exactly the same way you do now.</para> 3910 3911<para>Finally, when you are ready to format your document, simply set the 3912<parameter>bibliography.collection</parameter> parameter (in either a 3913customization layer or directly through your processor's interface) to 3914point to your global bibliography.</para> 3915 3916<para>The stylesheets will format the bibliography in your document as if 3917all of the entries referenced appeared there literally.</para> 3918 3919</refsect1> 3920</doc:refentry> 3921<xsl:param name="bibliography.collection" select="'http://docbook.sourceforge.net/release/bibliography/bibliography.xml'"/> 3922 3923<doc:refentry><refmeta> 3924<refentrytitle>bibliography.numbered</refentrytitle> 3925<refmiscinfo role="type">boolean</refmiscinfo> 3926</refmeta><refnamediv> 3927<refname>bibliography.numbered</refname> 3928<refpurpose>Should bibliography entries be numbered?</refpurpose> 3929</refnamediv><refsynopsisdiv> 3930 3931</refsynopsisdiv><refsect1><title>Description</title> 3932 3933<para>If non-zero bibliography entries will be numbered</para> 3934 3935</refsect1> 3936</doc:refentry> 3937<xsl:param name="bibliography.numbered" select="0"/> 3938 3939<doc:refentry><refmeta> 3940<refentrytitle>glossterm.auto.link</refentrytitle> 3941<refmiscinfo role="type">boolean</refmiscinfo> 3942</refmeta><refnamediv> 3943<refname>glossterm.auto.link</refname> 3944<refpurpose>Generate links from glossterm to glossentry automaticaly?</refpurpose> 3945</refnamediv><refsynopsisdiv> 3946 3947</refsynopsisdiv><refsect1><title>Description</title> 3948 3949<para>If true, a link will be automatically created from glossterm 3950to glossentry for that glossary term. This is usefull when your 3951glossterm names are consistent and you don't want to add links 3952manually.</para> 3953<para>If there is <sgmltag class="attribute">linkend</sgmltag> on 3954<sgmltag>glossterm</sgmltag> then is used instead of autogeneration of 3955link.</para> 3956 3957</refsect1> 3958</doc:refentry> 3959<xsl:param name="glossterm.auto.link" select="0"/> 3960 3961<doc:refentry><refmeta> 3962<refentrytitle>firstterm.only.link</refentrytitle> 3963<refmiscinfo role="type">boolean</refmiscinfo> 3964</refmeta><refnamediv> 3965<refname>firstterm.only.link</refname> 3966<refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose> 3967</refnamediv><refsynopsisdiv> 3968 3969</refsynopsisdiv><refsect1><title>Description</title> 3970 3971<para>If true, only <sgmltag>firstterm</sgmltag>s will be automatically linked 3972to the glossary. If glossary linking is not enabled, this parameter 3973has no effect.</para> 3974 3975</refsect1> 3976</doc:refentry> 3977<xsl:param name="firstterm.only.link" select="0"/> 3978 3979<doc:refentry><refmeta> 3980<refentrytitle>glossary.collection</refentrytitle> 3981<refmiscinfo role="type">string</refmiscinfo> 3982</refmeta><refnamediv> 3983<refname>glossary.collection</refname> 3984<refpurpose>Name of the glossary collection file</refpurpose> 3985</refnamediv><refsynopsisdiv> 3986 3987</refsynopsisdiv><refsect1><title>Description</title> 3988 3989<para>Glossaries maintained independently across a set of documents 3990are likely to become inconsistent unless considerable effort is 3991expended to keep them in sync. It makes much more sense, usually, to 3992store all of the glossary entries in a single place and simply 3993<quote>extract</quote> the ones you need in each document.</para> 3994 3995<para>That's the purpose of the 3996<parameter>glossary.collection</parameter> parameter. To setup a global 3997glossary <quote>database</quote>, follow these steps:</para> 3998 3999<refsect2><title>Setting Up the Glossary Database</title> 4000 4001<para>First, create a stand-alone glossary document that contains all of 4002the entries that you wish to reference. Make sure that each glossary 4003entry has an ID.</para> 4004 4005<para>Here's an example glossary:</para> 4006 4007<informalexample> 4008<programlisting> 4009<?xml version="1.0" encoding="utf-8"?> 4010<!DOCTYPE glossary 4011 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 4012 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> 4013<glossary> 4014<glossaryinfo> 4015<editor><firstname>Eric</firstname><surname>Raymond</surname></editor> 4016<title>Jargon File 4.2.3 (abridged)</title> 4017<releaseinfo>Just some test data</releaseinfo> 4018</glossaryinfo> 4019 4020<glossdiv><title>0</title> 4021 4022<glossentry> 4023<glossterm>0</glossterm> 4024<glossdef> 4025<para>Numeric zero, as opposed to the letter `O' (the 15th letter of 4026the English alphabet). In their unmodified forms they look a lot 4027alike, and various kluges invented to make them visually distinct have 4028compounded the confusion. If your zero is center-dotted and letter-O 4029is not, or if letter-O looks almost rectangular but zero looks more 4030like an American football stood on end (or the reverse), you're 4031probably looking at a modern character display (though the dotted zero 4032seems to have originated as an option on IBM 3270 controllers). If 4033your zero is slashed but letter-O is not, you're probably looking at 4034an old-style ASCII graphic set descended from the default typewheel on 4035the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter, 4036curse this arrangement). (Interestingly, the slashed zero long 4037predates computers; Florian Cajori's monumental "A History of 4038Mathematical Notations" notes that it was used in the twelfth and 4039thirteenth centuries.) If letter-O has a slash across it and the zero 4040does not, your display is tuned for a very old convention used at IBM 4041and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis> 4042arrangement even more, because it means two of their letters collide). 4043Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis> 4044slash. Old CDC computers rendered letter O as an unbroken oval and 0 4045as an oval broken at upper right and lower left. And yet another 4046convention common on early line printers left zero unornamented but 4047added a tail or hook to the letter-O so that it resembled an inverted 4048Q or cursive capital letter-O (this was endorsed by a draft ANSI 4049standard for how to draw ASCII characters, but the final standard 4050changed the distinguisher to a tick-mark in the upper-left corner). 4051Are we sufficiently confused yet?</para> 4052</glossdef> 4053</glossentry> 4054 4055<glossentry> 4056<glossterm>1TBS</glossterm> 4057<glossdef> 4058<para role="accidence"> 4059<phrase role="pronounce"></phrase> 4060<phrase role="partsofspeach">n</phrase> 4061</para> 4062<para>The "One True Brace Style"</para> 4063<glossseealso>indent style</glossseealso> 4064</glossdef> 4065</glossentry> 4066 4067<!-- ... --> 4068 4069</glossdiv> 4070 4071<!-- ... --> 4072 4073</glossary></programlisting> 4074</informalexample> 4075 4076</refsect2> 4077 4078<refsect2><title>Marking Up Glossary Terms</title> 4079 4080<para>That takes care of the glossary database, now you have to get the entries 4081into your document. Unlike bibliography entries, which can be empty, creating 4082<quote>placeholder</quote> glossary entries would be very tedious. So instead, 4083support for <parameter>glossary.collection</parameter> relies on implicit linking.</para> 4084 4085<para>In your source document, simply use <sgmltag>firstterm</sgmltag> and 4086<sgmltag>glossterm</sgmltag> to identify the terms you wish to have included 4087in the glossary. The stylesheets assume that you will either set the 4088<sgmltag class="attribute">baseform</sgmltag> attribute correctly, or that the 4089content of the element exactly matches a term in your glossary.</para> 4090 4091<para>If you're using a <parameter>glossary.collection</parameter>, don't 4092make explicit links on the terms in your document.</para> 4093 4094<para>So, in your document, you might write things like this:</para> 4095 4096<informalexample> 4097<programlisting><para>This is dummy text, without any real meaning. 4098The point is simply to reference glossary terms like <glossterm>0</glossterm> 4099and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>. 4100The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly 4101religious issue.</para></programlisting> 4102</informalexample> 4103 4104<para>If you set the <parameter>firstterm.only.link</parameter> parameter, 4105only the terms marked with <sgmltag>firstterm</sgmltag> will be links. 4106Otherwise, all the terms will be linked.</para> 4107 4108</refsect2> 4109 4110<refsect2><title>Marking Up the Glossary</title> 4111 4112<para>The glossary itself has to be identified for the stylesheets. For lack 4113of a better choice, the <sgmltag class="attribute">role</sgmltag> is used. 4114To identify the glossary as the target for automatic processing, set 4115the role to <quote><literal>auto</literal></quote>. The title of this 4116glossary (and any other information from the <sgmltag>glossaryinfo</sgmltag> 4117that's rendered by your stylesheet) will be displayed, but the entries will 4118come from the database. 4119</para> 4120 4121<para>Unfortunately, the glossary can't be empty, so you must put in 4122at least one <sgmltag>glossentry</sgmltag>. The content of this entry 4123is irrelevant, it will not be rendered:</para> 4124 4125<informalexample> 4126<programlisting><glossary role="auto"> 4127<glossentry> 4128<glossterm>Irrelevant</glossterm> 4129<glossdef> 4130<para>If you can see this, the document was processed incorrectly. Use 4131the <parameter>glossary.collection</parameter> parameter.</para> 4132</glossdef> 4133</glossentry> 4134</glossary></programlisting> 4135</informalexample> 4136 4137<para>What about glossary divisions? If your glossary database has glossary 4138divisions <emphasis>and</emphasis> your automatic glossary contains at least 4139one <sgmltag>glossdiv</sgmltag>, the automic glossary will have divisions. 4140If the <sgmltag>glossdiv</sgmltag> is missing from either location, no divisions 4141will be rendered.</para> 4142 4143<para>Glossary entries (and divisions, if appropriate) in the glossary will 4144occur in precisely the order they occur in your database.</para> 4145 4146</refsect2> 4147 4148<refsect2><title>Formatting the Document</title> 4149 4150<para>Finally, when you are ready to format your document, simply set the 4151<parameter>glossary.collection</parameter> parameter (in either a 4152customization layer or directly through your processor's interface) to 4153point to your global glossary.</para> 4154 4155<para>The stylesheets will format the glossary in your document as if 4156all of the entries implicilty referenced appeared there literally.</para> 4157</refsect2> 4158 4159<refsect2><title>Limitations</title> 4160 4161<para>Glossary cross-references <emphasis>within the glossary</emphasis> are 4162not supported. For example, this <emphasis>will not</emphasis> work:</para> 4163 4164<informalexample> 4165<programlisting><glossentry> 4166<glossterm>gloss-1</glossterm> 4167<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> 4168<glossseealso>gloss-2</glossseealso> 4169</glossdef> 4170</glossentry></programlisting> 4171</informalexample> 4172 4173<para>If you put glossary cross-references in your glossary that way, 4174you'll get the cryptic error: <computeroutput>Warning: 4175glossary.collection specified, but there are 0 automatic 4176glossaries</computeroutput>.</para> 4177 4178<para>Instead, you must do two things:</para> 4179 4180<orderedlist> 4181<listitem> 4182<para>Markup your glossary using <sgmltag>glossseealso</sgmltag>:</para> 4183 4184<informalexample> 4185<programlisting><glossentry> 4186<glossterm>gloss-1</glossterm> 4187<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> 4188<glossseealso>gloss-2</glossseealso> 4189</glossdef> 4190</glossentry></programlisting> 4191</informalexample> 4192</listitem> 4193 4194<listitem> 4195<para>Make sure there is at least one <sgmltag>glossterm</sgmltag> reference to 4196<glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The 4197easiest way to do that is probably within a <sgmltag>remark</sgmltag> in your 4198automatic glossary:</para> 4199 4200<informalexample> 4201<programlisting><glossary role="auto"> 4202<remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark> 4203<glossentry> 4204<glossterm>Irrelevant</glossterm> 4205<glossdef> 4206<para>If you can see this, the document was processed incorrectly. Use 4207the <parameter>glossary.collection</parameter> parameter.</para> 4208</glossdef> 4209</glossentry> 4210</glossary></programlisting> 4211</informalexample> 4212</listitem> 4213</orderedlist> 4214</refsect2> 4215 4216</refsect1> 4217</doc:refentry> 4218<xsl:param name="glossary.collection" select="''"/> 4219 4220<doc:refentry><refmeta> 4221<refentrytitle>glossentry.show.acronym</refentrytitle> 4222<refmiscinfo role="type">list</refmiscinfo> 4223</refmeta><refnamediv> 4224<refname>glossentry.show.acronym</refname> 4225<refpurpose>Display <sgmltag>glossentry</sgmltag> acronyms?</refpurpose> 4226</refnamediv><refsynopsisdiv> 4227 4228</refsynopsisdiv><refsect1><title>Description</title> 4229 4230<para>A setting of <quote>yes</quote> means they should be displayed; 4231<quote>no</quote> means they shouldn't. If <quote>primary</quote> is used, 4232then they are shown as the primary text for the entry.</para> 4233 4234<note> 4235<para>This setting controls both <sgmltag>acronym</sgmltag> and 4236<sgmltag>abbrev</sgmltag> elements in the <sgmltag>glossentry</sgmltag>.</para> 4237</note> 4238 4239</refsect1> 4240</doc:refentry> 4241<xsl:param name="glossentry.show.acronym" select="'no'"/> 4242 4243<doc:refentry><refmeta> 4244<refentrytitle>formal.procedures</refentrytitle> 4245<refmiscinfo role="type">boolean</refmiscinfo> 4246</refmeta><refnamediv> 4247<refname>formal.procedures</refname> 4248<refpurpose>Selects formal or informal procedures</refpurpose> 4249</refnamediv><refsynopsisdiv> 4250 4251</refsynopsisdiv><refsect1><title>Description</title> 4252 4253<para>Formal procedures are numbered and always have a title. 4254</para> 4255 4256</refsect1> 4257</doc:refentry> 4258<xsl:param name="formal.procedures" select="1"/> 4259 4260<doc:refentry><refmeta> 4261<refentrytitle>formal.title.placement</refentrytitle> 4262<refmiscinfo role="type"/> 4263</refmeta><refnamediv> 4264<refname>formal.title.placement</refname> 4265<refpurpose>Specifies where formal object titles should occur</refpurpose> 4266</refnamediv><refsynopsisdiv> 4267 4268</refsynopsisdiv><refsect1><title>Description</title> 4269 4270<para>Specifies where formal object titles should occur. For each formal object 4271type (<sgmltag>figure</sgmltag>, 4272<sgmltag>example</sgmltag>, 4273<sgmltag>equation</sgmltag>, 4274<sgmltag>table</sgmltag>, and <sgmltag>procedure</sgmltag>) 4275you can specify either the keyword 4276<quote><literal>before</literal></quote> or 4277<quote><literal>after</literal></quote>.</para> 4278 4279</refsect1> 4280</doc:refentry> 4281<xsl:param name="formal.title.placement"> 4282figure before 4283example before 4284equation before 4285table before 4286procedure before 4287task before 4288</xsl:param> 4289 4290<doc:refentry><refmeta> 4291<refentrytitle>runinhead.default.title.end.punct</refentrytitle> 4292<refmiscinfo role="type">string</refmiscinfo> 4293</refmeta><refnamediv> 4294<refname>runinhead.default.title.end.punct</refname> 4295<refpurpose>Default punctuation character on a run-in-head</refpurpose> 4296</refnamediv><refsynopsisdiv> 4297 4298</refsynopsisdiv><refsect1><title>Description</title> 4299 4300<para>FIXME: 4301</para> 4302 4303</refsect1> 4304</doc:refentry> 4305<xsl:param name="runinhead.default.title.end.punct" select="'.'"/> 4306 4307<doc:refentry><refmeta> 4308<refentrytitle>runinhead.title.end.punct</refentrytitle> 4309<refmiscinfo role="type">string</refmiscinfo> 4310</refmeta><refnamediv> 4311<refname>runinhead.title.end.punct</refname> 4312<refpurpose>Characters that count as punctuation on a run-in-head</refpurpose> 4313</refnamediv><refsynopsisdiv> 4314 4315</refsynopsisdiv><refsect1><title>Description</title> 4316 4317<para>FIXME: 4318</para> 4319 4320</refsect1> 4321</doc:refentry> 4322<xsl:param name="runinhead.title.end.punct" select="'.!?:'"/> 4323 4324<doc:refentry><refmeta> 4325<refentrytitle>show.comments</refentrytitle> 4326<refmiscinfo role="type">boolean</refmiscinfo> 4327</refmeta><refnamediv> 4328<refname>show.comments</refname> 4329<refpurpose>Display <sgmltag>comment</sgmltag> elements?</refpurpose> 4330</refnamediv><refsynopsisdiv> 4331 4332</refsynopsisdiv><refsect1><title>Description</title> 4333 4334<para>If true (non-zero), comments will be displayed, otherwise they are suppressed. 4335Comments here refers to the <sgmltag>comment</sgmltag> element, 4336which will be renamed <sgmltag>remark</sgmltag> in DocBook V4.0, 4337not XML comments (<-- like this -->) which are unavailable. 4338</para> 4339 4340</refsect1> 4341</doc:refentry> 4342<xsl:param name="show.comments">1</xsl:param> 4343 4344<doc:refentry><refmeta> 4345<refentrytitle>show.revisionflag</refentrytitle> 4346<refmiscinfo role="type">boolean</refmiscinfo> 4347</refmeta><refnamediv> 4348<refname>show.revisionflag</refname> 4349<refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> 4350</refnamediv><refsynopsisdiv> 4351 4352</refsynopsisdiv><refsect1><title>Description</title> 4353 4354<para> 4355If <literal>show.revisionflag</literal> is turned on, then the stylesheets 4356may produce additional markup designed to allow a CSS stylesheet to 4357highlight elements that have specific revisionflag settings.</para> 4358 4359<para>The markup inserted will be usually be either a <span> or <div> 4360with an appropriate <literal>class</literal> attribute. (The value of 4361the class attribute will be the same as the value of the revisionflag 4362attribute). In some contexts, for example tables, where extra markup 4363would be structurally illegal, the class attribute will be added to the 4364appropriate container element.</para> 4365 4366<para>In general, the stylesheets only test for revisionflag in contexts 4367where an importing stylesheet would have to redefine whole templates. 4368Most of the revisionflag processing is expected to be done by another 4369stylesheet, for example <filename>changebars.xsl</filename>.</para> 4370 4371</refsect1> 4372</doc:refentry> 4373<xsl:param name="show.revisionflag">0</xsl:param> 4374 4375<doc:refentry><refmeta> 4376<refentrytitle>shade.verbatim</refentrytitle> 4377<refmiscinfo role="type">boolean</refmiscinfo> 4378</refmeta><refnamediv> 4379<refname>shade.verbatim</refname> 4380<refpurpose>Should verbatim environments be shaded?</refpurpose> 4381</refnamediv><refsynopsisdiv> 4382 4383</refsynopsisdiv><refsect1><title>Description</title> 4384 4385<para>In the FO stylesheet, if this parameter is non-zero then the 4386<property>shade.verbatim.style</property> properties will be applied 4387to verbatim environments.</para> 4388 4389<para>In the HTML stylesheet, this parameter is now deprecated. Use 4390CSS instead.</para> 4391 4392</refsect1> 4393</doc:refentry> 4394<xsl:param name="shade.verbatim" select="0"/> 4395 4396<doc:refentry><refmeta> 4397<refentrytitle>shade.verbatim.style</refentrytitle> 4398<refmiscinfo role="type"/> 4399</refmeta><refnamediv> 4400<refname>shade.verbatim.style</refname> 4401<refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose> 4402</refnamediv><refsynopsisdiv> 4403 4404</refsynopsisdiv><refsect1><title>Description</title> 4405 4406<para>FIXME:</para> 4407 4408</refsect1> 4409</doc:refentry> 4410<xsl:attribute-set name="shade.verbatim.style"> 4411 <xsl:attribute name="border">0</xsl:attribute> 4412 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute> 4413</xsl:attribute-set> 4414 4415 4416<doc:refentry><refmeta> 4417<refentrytitle>punct.honorific</refentrytitle> 4418<refmiscinfo role="type">string</refmiscinfo> 4419</refmeta><refnamediv> 4420<refname>punct.honorific</refname> 4421<refpurpose>Punctuation after an honorific in a personal name.</refpurpose> 4422</refnamediv><refsynopsisdiv> 4423 4424</refsynopsisdiv><refsect1><title>Description</title> 4425 4426<para>This parameter specifies the punctuation that should be added after an 4427honorific in a personal name.</para> 4428 4429</refsect1> 4430</doc:refentry> 4431<xsl:param name="punct.honorific" select="'.'"/> 4432 4433<doc:refentry><refmeta> 4434<refentrytitle>tex.math.in.alt</refentrytitle> 4435<refmiscinfo role="type">string</refmiscinfo> 4436</refmeta><refnamediv> 4437<refname>tex.math.in.alt</refname> 4438<refpurpose>TeX notation used for equations</refpurpose> 4439</refnamediv><refsynopsisdiv> 4440 4441</refsynopsisdiv><refsect1><title>Description</title> 4442 4443<para>If you want type math directly in TeX notation in equations, 4444this parameter specifies notation used. Currently are supported two 4445values -- <literal>plain</literal> and <literal>latex</literal>. Empty 4446value means that you are not using TeX math at all.</para> 4447 4448<para>Preferred way for including TeX alternative of math is inside of 4449<sgmltag>textobject</sgmltag> element. Eg.:</para> 4450 4451<programlisting><inlineequation> 4452<inlinemediaobject> 4453<imageobject> 4454<imagedata fileref="eq1.gif"/> 4455</imageobject> 4456<textobject><phrase>E=mc squared</phrase></textobject> 4457<textobject role="tex"><phrase>E=mc^2</phrase></textobject> 4458</inlinemediaobject> 4459</inlineequation></programlisting> 4460 4461<para>If you are using <sgmltag>graphic</sgmltag> element, you can 4462store TeX inside <sgmltag>alt</sgmltag> element:</para> 4463 4464<programlisting><inlineequation> 4465<alt role="tex">a^2+b^2=c^2</alt> 4466<graphic fileref="a2b2c2.gif"/> 4467</inlineequation></programlisting> 4468 4469<para>If you want use this feature, you should process your FO with 4470PassiveTeX, which only supports TeX math notation. When calling 4471stylsheet, don't forget to specify also 4472passivetex.extensions=1.</para> 4473 4474<para>If you want equations in HTML, just process generated file 4475<filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run 4476dvi2bitmap program on result DVI file. You will get images for 4477equations in your document.</para> 4478 4479</refsect1> 4480</doc:refentry> 4481<xsl:param name="tex.math.in.alt" select="''"/> 4482 4483<doc:refentry><refmeta> 4484<refentrytitle>tex.math.file</refentrytitle> 4485<refmiscinfo role="type">string</refmiscinfo> 4486</refmeta><refnamediv> 4487<refname>tex.math.file</refname> 4488<refpurpose>Name of temporary file for generating images from equations</refpurpose> 4489</refnamediv><refsynopsisdiv> 4490 4491</refsynopsisdiv><refsect1><title>Description</title> 4492 4493<para>Name of auxiliary file for TeX equations. This file can be 4494processed by dvi2bitmap to get bitmap versions of equations for HTML 4495output.</para> 4496 4497</refsect1> 4498</doc:refentry> 4499<xsl:param name="tex.math.file" select="'tex-math-equations.tex'"/> 4500 4501<doc:refentry><refmeta> 4502<refentrytitle>tex.math.delims</refentrytitle> 4503<refmiscinfo role="type">boolean</refmiscinfo> 4504</refmeta><refnamediv> 4505<refname>tex.math.delims</refname> 4506<refpurpose>Should be equations outputed for processing by TeX 4507automatically surrounded by math mode delimiters</refpurpose> 4508</refnamediv><refsynopsisdiv> 4509 4510</refsynopsisdiv><refsect1><title>Description</title> 4511 4512<para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell 4513you should set this parameter to 0.</para> 4514 4515</refsect1> 4516</doc:refentry> 4517<xsl:param name="tex.math.delims" select="'1'"/> 4518 4519<doc:refentry><refmeta> 4520<refentrytitle>pixels.per.inch</refentrytitle> 4521<refmiscinfo role="type">integer</refmiscinfo> 4522</refmeta><refnamediv> 4523<refname>pixels.per.inch</refname> 4524<refpurpose>How many pixels are there per inch?</refpurpose> 4525</refnamediv><refsynopsisdiv> 4526 4527</refsynopsisdiv><refsect1><title>Description</title> 4528 4529<para>When lengths are converted to pixels, this value is used to 4530determine the size of a pixel. The default value is taken from the 4531<ulink url="http://www.w3.org/TR/xsl/slice5.html#pixels">XSL 4532Recommendation</ulink>. 4533</para> 4534 4535</refsect1> 4536</doc:refentry> 4537<xsl:param name="pixels.per.inch" select="90"/> 4538 4539<doc:refentry><refmeta> 4540<refentrytitle>points.per.em</refentrytitle> 4541<refmiscinfo role="type">number</refmiscinfo> 4542</refmeta><refnamediv> 4543<refname>points.per.em</refname> 4544<refpurpose>Specify the nominal size of an em-space in points</refpurpose> 4545</refnamediv><refsynopsisdiv> 4546 4547</refsynopsisdiv><refsect1><title>Description</title> 4548 4549<para>FIXME:</para> 4550 4551</refsect1> 4552</doc:refentry> 4553<xsl:param name="points.per.em" select="10"/> 4554 4555<doc:refentry><refmeta> 4556<refentrytitle>use.svg</refentrytitle> 4557<refmiscinfo role="type">boolean</refmiscinfo> 4558</refmeta><refnamediv> 4559<refname>use.svg</refname> 4560<refpurpose>Allow SVG in the result tree?</refpurpose> 4561</refnamediv><refsynopsisdiv> 4562 4563</refsynopsisdiv><refsect1><title>Description</title> 4564 4565<para>If non-zero, SVG will be considered an acceptable image format. SVG 4566is passed through to the result tree, so correct rendering of the resulting 4567diagram depends on the formatter (FO processor or web browser) that is used 4568to process the output from the stylesheet.</para> 4569 4570</refsect1> 4571</doc:refentry> 4572<xsl:param name="use.svg" select="1"/> 4573 4574<doc:refentry><refmeta> 4575<refentrytitle>menuchoice.separator</refentrytitle> 4576<refmiscinfo role="type"/> 4577</refmeta><refnamediv> 4578<refname>menuchoice.separator</refname> 4579<refpurpose>Separator between items of a <sgmltag>menuchoice</sgmltag> 4580other than <sgmltag>guimenuitem</sgmltag> and 4581<sgmltag>guisubmenu</sgmltag></refpurpose> 4582</refnamediv><refsynopsisdiv> 4583 4584</refsynopsisdiv><refsect1><title>Description</title> 4585 4586<para>Separator used to connect items of a <sgmltag>menuchoice</sgmltag> other 4587than <sgmltag>guimenuitem</sgmltag> and <sgmltag>guisubmenu</sgmltag>. The latter 4588elements are linked with <parameter>menuchoice.menu.separator</parameter>. 4589</para> 4590 4591</refsect1> 4592</doc:refentry> 4593<xsl:param name="menuchoice.separator" select="'+'"/> 4594 4595<doc:refentry><refmeta> 4596<refentrytitle>menuchoice.menu.separator</refentrytitle> 4597<refmiscinfo role="type"/> 4598</refmeta><refnamediv> 4599<refname>menuchoice.menu.separator</refname> 4600<refpurpose>Separator between items of a <sgmltag>menuchoice</sgmltag> 4601with <sgmltag>guimenuitem</sgmltag> or 4602<sgmltag>guisubmenu</sgmltag></refpurpose> 4603</refnamediv><refsynopsisdiv> 4604 4605</refsynopsisdiv><refsect1><title>Description</title> 4606 4607<para>Separator used to connect items of a <sgmltag>menuchoice</sgmltag> with 4608<sgmltag>guimenuitem</sgmltag> or <sgmltag>guisubmenu</sgmltag>. Other elements 4609are linked with <parameter>menuchoice.separator</parameter>. 4610</para> 4611<para>The default value is &#x2192;, which is the 4612&rarr; (right arrow) character entity. 4613The current FOP (0.20.5) requires setting the font-family 4614explicitly. 4615</para> 4616<para>The default value also includes spaces around the arrow, 4617which will allow a line to break. Replace the spaces with 4618&#xA0; (nonbreaking space) if you don't want those 4619spaces to break. 4620</para> 4621 4622</refsect1> 4623</doc:refentry> 4624<xsl:param name="menuchoice.menu.separator"> ��� </xsl:param> 4625 4626<doc:refentry><refmeta> 4627<refentrytitle>default.float.class</refentrytitle> 4628<refmiscinfo role="type">string</refmiscinfo> 4629</refmeta><refnamediv> 4630<refname>default.float.class</refname> 4631<refpurpose>Specifies the default float class</refpurpose> 4632</refnamediv><refsynopsisdiv> 4633 4634</refsynopsisdiv><refsect1><title>Description</title> 4635 4636<para>FIXME:</para> 4637 4638</refsect1> 4639</doc:refentry> 4640<xsl:param name="default.float.class"> 4641 <xsl:choose> 4642 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when> 4643 <xsl:otherwise>before</xsl:otherwise> 4644 </xsl:choose> 4645</xsl:param> 4646 4647<doc:refentry><refmeta> 4648<refentrytitle>footnote.number.format</refentrytitle> 4649<refmiscinfo role="type">string</refmiscinfo> 4650</refmeta><refnamediv> 4651<refname>footnote.number.format</refname> 4652<refpurpose>Identifies the format used for footnote numbers</refpurpose> 4653</refnamediv><refsynopsisdiv> 4654 4655</refsynopsisdiv><refsect1><title>Description</title> 4656 4657<para>The <parameter>footnote.number.format</parameter> specifies the format 4658to use for footnote numeration (1, i, I, a, or A).</para> 4659 4660</refsect1> 4661</doc:refentry> 4662<xsl:param name="footnote.number.format" select="'1'"/> 4663 4664<doc:refentry><refmeta> 4665<refentrytitle>table.footnote.number.format</refentrytitle> 4666<refmiscinfo role="type">string</refmiscinfo> 4667</refmeta><refnamediv> 4668<refname>table.footnote.number.format</refname> 4669<refpurpose>Identifies the format used for footnote numbers in tables</refpurpose> 4670</refnamediv><refsynopsisdiv> 4671 4672</refsynopsisdiv><refsect1><title>Description</title> 4673 4674<para>The <parameter>table.footnote.number.format</parameter> specifies the format 4675to use for footnote numeration (1, i, I, a, or A) in tables.</para> 4676 4677</refsect1> 4678</doc:refentry> 4679<xsl:param name="table.footnote.number.format" select="'a'"/> 4680 4681<doc:refentry><refmeta> 4682<refentrytitle>footnote.number.symbols</refentrytitle> 4683<refmiscinfo role="type"/> 4684</refmeta><refnamediv> 4685<refname>footnote.number.symbols</refname> 4686<refpurpose>Special characters to use as footnote markers</refpurpose> 4687</refnamediv><refsynopsisdiv> 4688 4689</refsynopsisdiv><refsect1><title>Description</title> 4690 4691<para>If <parameter>footnote.number.symbols</parameter> is not the empty string, 4692footnotes will use the characters it contains as footnote symbols. For example, 4693<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify 4694footnotes with <quote>*</quote>, <quote>���</quote>, <quote>���</quote>, 4695<quote>���</quote>, and <quote>���</quote>. If there are more footnotes 4696than symbols, the stylesheets will fall back to numbered footnotes using 4697<parameter>footnote.number.format</parameter>.</para> 4698 4699<para>The use of symbols for footnotes depends on the ability of your 4700processor (or browser) to render the symbols you select. Not all systems are 4701capable of displaying the full range of Unicode characters. If the quoted characters 4702in the preceding paragraph are not displayed properly, that's a good indicator 4703that you may have trouble using those symbols for footnotes.</para> 4704 4705</refsect1> 4706</doc:refentry> 4707<xsl:param name="footnote.number.symbols" select="''"/> 4708 4709<doc:refentry><refmeta> 4710<refentrytitle>table.footnote.number.symbols</refentrytitle> 4711<refmiscinfo role="type"/> 4712</refmeta><refnamediv> 4713<refname>table.footnote.number.symbols</refname> 4714<refpurpose>Special characters to use a footnote markers in tables</refpurpose> 4715</refnamediv><refsynopsisdiv> 4716 4717</refsynopsisdiv><refsect1><title>Description</title> 4718 4719<para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string, 4720table footnotes will use the characters it contains as footnote symbols. For example, 4721<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify 4722footnotes with <quote>*</quote>, <quote>���</quote>, <quote>���</quote>, 4723<quote>���</quote>, and <quote>���</quote>. If there are more footnotes 4724than symbols, the stylesheets will fall back to numbered footnotes using 4725<parameter>table.footnote.number.format</parameter>.</para> 4726 4727<para>The use of symbols for footnotes depends on the ability of your 4728processor (or browser) to render the symbols you select. Not all systems are 4729capable of displaying the full range of Unicode characters. If the quoted characters 4730in the preceding paragraph are not displayed properly, that's a good indicator 4731that you may have trouble using those symbols for footnotes.</para> 4732 4733</refsect1> 4734</doc:refentry> 4735<xsl:param name="table.footnote.number.symbols" select="''"/> 4736 4737<doc:refentry><refmeta> 4738<refentrytitle>annotation.support</refentrytitle> 4739<refmiscinfo role="type">boolean</refmiscinfo> 4740</refmeta><refnamediv> 4741<refname>annotation.support</refname> 4742<refpurpose>Enable annotations?</refpurpose> 4743</refnamediv><refsynopsisdiv> 4744 4745</refsynopsisdiv><refsect1><title>Description</title> 4746 4747<para>If non-zero, the stylesheets will attempt to support annotation 4748elements in HTML by including some JavaScript (see 4749<parameter>annotation.js</parameter>).</para> 4750 4751</refsect1> 4752</doc:refentry> 4753<xsl:param name="annotation.support" select="0"/> 4754 4755<doc:refentry><refmeta> 4756<refentrytitle>annotation.js</refentrytitle> 4757<refmiscinfo role="type">boolean</refmiscinfo> 4758</refmeta><refnamediv> 4759<refname>annotation.js</refname> 4760<refpurpose>Enable annotations?</refpurpose> 4761</refnamediv><refsynopsisdiv> 4762 4763</refsynopsisdiv><refsect1><title>Description</title> 4764 4765<para>If <property>annotation.support</property> is enabled and the 4766document contains <sgmltag>annotation</sgmltag>s, then the URIs listed 4767in this parameter will be included. These JavaScript files are required 4768for popup annotation support.</para> 4769 4770</refsect1> 4771</doc:refentry> 4772<xsl:param name="annotation.js" select="'http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js'"/> 4773 4774<doc:refentry><refmeta> 4775<refentrytitle>annotation.css</refentrytitle> 4776<refmiscinfo role="type">boolean</refmiscinfo> 4777</refmeta><refnamediv> 4778<refname>annotation.css</refname> 4779<refpurpose>Enable annotations?</refpurpose> 4780</refnamediv><refsynopsisdiv> 4781 4782</refsynopsisdiv><refsect1><title>Description</title> 4783 4784<para>If <property>annotation.support</property> is enabled and the 4785document contains <sgmltag>annotation</sgmltag>s, then the CSS in this 4786parameter will be included in the document.</para> 4787 4788</refsect1> 4789</doc:refentry> 4790<xsl:param name="annotation.css"> 4791/* ====================================================================== 4792 Annotations 4793*/ 4794 4795div.annotation-list { visibility: hidden; 4796 } 4797 4798div.annotation-nocss { position: absolute; 4799 visibility: hidden; 4800 } 4801 4802div.annotation-popup { position: absolute; 4803 z-index: 4; 4804 visibility: hidden; 4805 padding: 0px; 4806 margin: 2px; 4807 border-style: solid; 4808 border-width: 1px; 4809 width: 200px; 4810 background-color: white; 4811 } 4812 4813div.annotation-title { padding: 1px; 4814 font-weight: bold; 4815 border-bottom-style: solid; 4816 border-bottom-width: 1px; 4817 color: white; 4818 background-color: black; 4819 } 4820 4821div.annotation-body { padding: 2px; 4822 } 4823 4824div.annotation-body p { margin-top: 0px; 4825 padding-top: 0px; 4826 } 4827 4828div.annotation-close { position: absolute; 4829 top: 2px; 4830 right: 2px; 4831 } 4832</xsl:param> 4833 4834<doc:refentry><refmeta> 4835<refentrytitle>annotation.graphic.open</refentrytitle> 4836<refmiscinfo role="type">boolean</refmiscinfo> 4837</refmeta><refnamediv> 4838<refname>annotation.graphic.open</refname> 4839<refpurpose>Enable annotations?</refpurpose> 4840</refnamediv><refsynopsisdiv> 4841 4842</refsynopsisdiv><refsect1><title>Description</title> 4843 4844<para>This image is used inline to identify the location of 4845annotations.</para> 4846 4847</refsect1> 4848</doc:refentry> 4849<xsl:param name="annotation.graphic.open" select="'http://docbook.sourceforge.net/release/images/annot-open.png'"/> 4850 4851<doc:refentry><refmeta> 4852<refentrytitle>annotation.graphic.close</refentrytitle> 4853<refmiscinfo role="type">boolean</refmiscinfo> 4854</refmeta><refnamediv> 4855<refname>annotation.graphic.close</refname> 4856<refpurpose>Enable annotations?</refpurpose> 4857</refnamediv><refsynopsisdiv> 4858 4859</refsynopsisdiv><refsect1><title>Description</title> 4860 4861<para>This image is used on popup annotations as the ���x��� that the 4862user can click to dismiss the popup.</para> 4863 4864</refsect1> 4865</doc:refentry> 4866<xsl:param name="annotation.graphic.close" select="'http://docbook.sourceforge.net/release/images/annot-close.png'"/> 4867 4868<doc:refentry><refmeta> 4869<refentrytitle>img.src.path</refentrytitle> 4870<refmiscinfo role="type">string</refmiscinfo> 4871</refmeta><refnamediv> 4872<refname>img.src.path</refname> 4873<refpurpose>Path to HTML image files</refpurpose> 4874</refnamediv><refsynopsisdiv> 4875 4876</refsynopsisdiv><refsect1><title>Description</title> 4877 4878<para>Add a path prefix to each HTML 4879<sgmltag class="element">img</sgmltag> or FO 4880<sgmltag class="element">fo:external-graphics</sgmltag> element's 4881<sgmltag class="attribute">src</sgmltag> attribute. 4882This path could relative to the directory where the HTML/FO 4883files are created, or it could be an absolute URI. 4884The default value is empty. 4885Be sure to include a trailing slash if needed. 4886</para> 4887<para>This prefix is not applied to any filerefs that start 4888with "/" or contain "//:". 4889</para> 4890 4891</refsect1> 4892</doc:refentry> 4893<xsl:param name="img.src.path"/> 4894 4895<doc:refentry><refmeta> 4896<refentrytitle>keep.relative.image.uris</refentrytitle> 4897<refmiscinfo role="type">boolean</refmiscinfo> 4898</refmeta><refnamediv> 4899<refname>keep.relative.image.uris</refname> 4900<refpurpose>Should image URIs be resolved against xml:base?</refpurpose> 4901</refnamediv><refsynopsisdiv> 4902 4903</refsynopsisdiv><refsect1><title>Description</title> 4904 4905<para>If non-zeor, relative URIs (in, for example fileref attributes) will 4906be used in the generated output. Otherwise, the URIs will be made absolute 4907with respect to the base URI.</para> 4908 4909<para>Note that the stylesheets calculate (and use) the absolute form 4910for some purposes, this only applies to the resulting output.</para> 4911 4912</refsect1> 4913</doc:refentry> 4914<xsl:param name="keep.relative.image.uris" select="1"/> 4915 4916 4917<doc:refentry><refmeta> 4918<refentrytitle>graphic.default.extension</refentrytitle> 4919<refmiscinfo role="type">string</refmiscinfo> 4920</refmeta><refnamediv> 4921<refname>graphic.default.extension</refname> 4922<refpurpose>Default extension for graphic filenames</refpurpose> 4923</refnamediv><refsynopsisdiv> 4924 4925</refsynopsisdiv><refsect1><title>Description</title> 4926 4927<para>If a <sgmltag>graphic</sgmltag> or <sgmltag>mediaobject</sgmltag> 4928includes a reference to a filename that does not include an extension, 4929and the <sgmltag class="attribute">format</sgmltag> attribute is 4930<emphasis>unspecified</emphasis>, the default extension will be used. 4931</para> 4932 4933</refsect1> 4934</doc:refentry> 4935<xsl:param name="graphic.default.extension"/> 4936 4937<doc:refentry><refmeta> 4938<refentrytitle>default.image.width</refentrytitle> 4939<refmiscinfo role="type">length</refmiscinfo> 4940</refmeta><refnamediv> 4941<refname>default.image.width</refname> 4942<refpurpose>The default width of images</refpurpose> 4943</refnamediv><refsynopsisdiv> 4944 4945</refsynopsisdiv><refsect1><title>Description</title> 4946 4947<para>If specified, this value will be used for the 4948<sgmltag class="attribute">width</sgmltag> attribute on 4949images that do not specify any 4950<ulink url="http://docbook.org/tdg/en/html/imagedata.html#viewport.area">viewport 4951dimensions</ulink>.</para> 4952 4953</refsect1> 4954</doc:refentry> 4955<xsl:param name="default.image.width" select="''"/> 4956 4957<doc:refentry><refmeta> 4958<refentrytitle>nominal.image.width</refentrytitle> 4959<refmiscinfo role="type">length</refmiscinfo> 4960</refmeta><refnamediv> 4961<refname>nominal.image.width</refname> 4962<refpurpose>The nominal image width</refpurpose> 4963</refnamediv><refsynopsisdiv> 4964 4965</refsynopsisdiv><refsect1><title>Description</title> 4966 4967<para>Graphic widths expressed as a percentage are problematic. In the 4968following discussion, we speak of width and contentwidth, but 4969the same issues apply to depth and contentdepth.</para> 4970 4971<para>A width of 50% means "half of the available space for the image." 4972That's fine. But note that in HTML, this is a dynamic property and 4973the image size will vary if the browser window is resized.</para> 4974 4975<para>A contentwidth of 50% means "half of the actual image width". 4976But what does that mean if the stylesheets cannot assess the image's 4977actual size? Treating this as a width of 50% is one possibility, but 4978it produces behavior (dynamic scaling) that seems entirely out of 4979character with the meaning.</para> 4980 4981<para>Instead, the stylesheets define a 4982<parameter>nominal.image.width</parameter> and convert percentages to 4983actual values based on that nominal size.</para> 4984 4985</refsect1> 4986</doc:refentry> 4987<xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"/> 4988 4989<doc:refentry><refmeta> 4990<refentrytitle>nominal.image.depth</refentrytitle> 4991<refmiscinfo role="type">length</refmiscinfo> 4992</refmeta><refnamediv> 4993<refname>nominal.image.depth</refname> 4994<refpurpose>Nominal image depth</refpurpose> 4995</refnamediv><refsynopsisdiv> 4996 4997</refsynopsisdiv><refsect1><title>Description</title> 4998 4999<para>See <parameter>nominal.image.width</parameter>.</para> 5000 5001</refsect1> 5002</doc:refentry> 5003<xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"/> 5004 5005<doc:refentry><refmeta> 5006<refentrytitle>use.embed.for.svg</refentrytitle> 5007<refmiscinfo role="type">boolean</refmiscinfo> 5008</refmeta><refnamediv> 5009<refname>use.embed.for.svg</refname> 5010<refpurpose>Use HTML <sgmltag>embed</sgmltag> for SVG?</refpurpose> 5011</refnamediv><refsynopsisdiv> 5012 5013</refsynopsisdiv><refsect1><title>Description</title> 5014 5015<para>If non-zero, an <sgmltag>embed</sgmltag> element will be created for 5016SVG figures. An <sgmltag>object</sgmltag> is <emphasis>always</emphasis> created, 5017this parameter merely controls whether or not an additional <sgmltag>embed</sgmltag> 5018is generated inside the <sgmltag>object</sgmltag>.</para> 5019 5020<para>On the plus side, this may be more portable among browsers and plug-ins. 5021On the minus side, it isn't valid HTML.</para> 5022 5023</refsect1> 5024</doc:refentry> 5025<xsl:param name="use.embed.for.svg" select="0"/> 5026 5027<doc:refentry><refmeta> 5028<refentrytitle>make.graphic.viewport</refentrytitle> 5029<refmiscinfo role="type">boolean</refmiscinfo> 5030</refmeta><refnamediv> 5031<refname>make.graphic.viewport</refname> 5032<refpurpose>Use tables in HTML to make viewports for graphics</refpurpose> 5033</refnamediv><refsynopsisdiv> 5034 5035</refsynopsisdiv><refsect1><title>Description</title> 5036 5037<para>The HTML <sgmltag>img</sgmltag> element only supports the notion 5038of content-area scaling; it doesn't support the distinction between a 5039content-area and a viewport-area, so we have to make some compromises.</para> 5040 5041<para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table 5042will be used to frame the image. This creates an effective viewport-area. 5043</para> 5044 5045<para>Tables and alignment don't work together, so this parameter is ignored 5046if alignment is specified on an image.</para> 5047</refsect1> 5048</doc:refentry> 5049<xsl:param name="make.graphic.viewport" select="1"/> 5050 5051<doc:refentry><refmeta> 5052<refentrytitle>preferred.mediaobject.role</refentrytitle> 5053</refmeta><refnamediv> 5054<refname>preferred.mediaobject.role</refname> 5055<refpurpose>Select which mediaobject to use based on 5056this value of an object's <sgmltag class="attribute">role</sgmltag> attribute. 5057</refpurpose> 5058</refnamediv><refsynopsisdiv> 5059 5060</refsynopsisdiv><refsect1><title>Description</title> 5061 5062<para>A mediaobject may contain several objects such as imageobjects. 5063If the parameter <parameter>use.role.for.mediaobject</parameter> 5064is non-zero, then the <sgmltag class="attribute">role</sgmltag> attribute on 5065<sgmltag>imageobject</sgmltag>s and other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be 5066used. If one of the objects has a role value that matches the 5067preferred.mediaobject.role parameter, then it has first 5068priority for selection. If more than one has such a 5069role value, the first one is used. 5070</para> 5071<para> 5072See the <parameter>use.role.for.mediaobject</parameter> parameter 5073for the sequence of selection.</para> 5074</refsect1> 5075</doc:refentry> 5076<xsl:param name="preferred.mediaobject.role"/> 5077 5078<doc:refentry><refmeta> 5079<refentrytitle>use.role.for.mediaobject</refentrytitle> 5080<refmiscinfo role="type">boolean</refmiscinfo> 5081</refmeta><refnamediv> 5082<refname>use.role.for.mediaobject</refname> 5083<refpurpose>Use <sgmltag class="attribute">role</sgmltag> attribute 5084value for selecting which of several objects within a mediaobject to use. 5085</refpurpose> 5086</refnamediv><refsynopsisdiv> 5087 5088</refsynopsisdiv><refsect1><title>Description</title> 5089 5090<para>If non-zero, the <sgmltag class="attribute">role</sgmltag> attribute on 5091<sgmltag>imageobject</sgmltag>s or other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be 5092used. 5093</para> 5094<para> 5095The order of selection when then parameter is non-zero is: 5096</para> 5097<orderedlist> 5098<listitem> 5099 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para> 5100</listitem> 5101<listitem> 5102<para>Else if an object's role attribute has a value of 5103<literal>html</literal> for HTML processing or 5104<literal>fo</literal> for FO output, then the first 5105of such objects is selected. 5106</para> 5107</listitem> 5108<listitem> 5109<para>Else the first suitable object is selected.</para> 5110</listitem> 5111</orderedlist> 5112<para> 5113If the value of 5114<parameter>use.role.for.mediaobject</parameter> 5115is zero, then role attributes are not considered 5116and the first suitable object 5117with or without a role value is used. 5118</para> 5119</refsect1> 5120</doc:refentry> 5121<xsl:param name="use.role.for.mediaobject" select="1"/> 5122 5123<doc:refentry><refmeta> 5124<refentrytitle>ignore.image.scaling</refentrytitle> 5125<refmiscinfo role="type">boolean</refmiscinfo> 5126</refmeta><refnamediv> 5127<refname>ignore.image.scaling</refname> 5128<refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose> 5129</refnamediv><refsynopsisdiv> 5130 5131</refsynopsisdiv><refsect1><title>Description</title> 5132 5133<para>If non-zero, the scaling attributes on graphics and media objects are 5134ignored.</para> 5135 5136</refsect1> 5137</doc:refentry> 5138<xsl:param name="ignore.image.scaling" select="0"/> 5139 5140<doc:refentry><refmeta> 5141<refentrytitle>chunker.output.cdata-section-elements</refentrytitle> 5142<refmiscinfo role="type">string</refmiscinfo> 5143</refmeta><refnamediv> 5144<refname>chunker.output.cdata-section-elements</refname> 5145<refpurpose>List of elements to escape with CDATA sections</refpurpose> 5146</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.cdata-section-elements" select="''"/> 5147</refsynopsisdiv><refsect1><title>Description</title> 5148 5149<para>This parameter specifies the list of elements that should be escaped 5150as CDATA sections by the chunking stylesheet. Not all processors support 5151specification of this parameter. 5152</para> 5153 5154<note> 5155<para>This parameter is documented here, but the declaration is actually 5156in the <filename>chunker.xsl</filename> stylesheet module.</para> 5157</note> 5158 5159</refsect1> 5160</doc:refentry> 5161 5162 5163<doc:refentry><refmeta> 5164<refentrytitle>chunker.output.doctype-public</refentrytitle> 5165<refmiscinfo role="type">string</refmiscinfo> 5166</refmeta><refnamediv> 5167<refname>chunker.output.doctype-public</refname> 5168<refpurpose>Public identifer to use in the document type of generated pages</refpurpose> 5169</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.doctype-public" select="''"/> 5170</refsynopsisdiv><refsect1><title>Description</title> 5171 5172<para>This parameter specifies the public identifier that should be used by 5173the chunking stylesheet in the document type declaration of chunked pages. 5174Not all processors support specification of 5175this parameter. 5176</para> 5177 5178<note> 5179<para>This parameter is documented here, but the declaration is actually 5180in the <filename>chunker.xsl</filename> stylesheet module.</para> 5181</note> 5182 5183</refsect1> 5184</doc:refentry> 5185 5186 5187<doc:refentry><refmeta> 5188<refentrytitle>chunker.output.doctype-system</refentrytitle> 5189<refmiscinfo role="type">uri</refmiscinfo> 5190</refmeta><refnamediv> 5191<refname>chunker.output.doctype-system</refname> 5192<refpurpose>System identifier to use for the document type in generated pages</refpurpose> 5193</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.doctype-system" select="''"/> 5194</refsynopsisdiv><refsect1><title>Description</title> 5195 5196<para>This parameter specifies the system identifier that should be used by 5197the chunking stylesheet in the document type declaration of chunked pages. 5198Not all processors support specification of 5199this parameter. 5200</para> 5201 5202<note> 5203<para>This parameter is documented here, but the declaration is actually 5204in the <filename>chunker.xsl</filename> stylesheet module.</para> 5205</note> 5206 5207</refsect1> 5208</doc:refentry> 5209 5210 5211<doc:refentry><refmeta> 5212<refentrytitle>chunker.output.encoding</refentrytitle> 5213<refmiscinfo role="type">string</refmiscinfo> 5214</refmeta><refnamediv> 5215<refname>chunker.output.encoding</refname> 5216<refpurpose>Encoding used in generated pages</refpurpose> 5217</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.encoding" select="'ISO-8859-1'"/> 5218</refsynopsisdiv><refsect1><title>Description</title> 5219 5220<para>This parameter specifies the encoding to be used in files 5221generated by the chunking stylesheet. Not all processors support 5222specification of this parameter. 5223</para> 5224 5225<para>This parameter used to be named <literal>default.encoding</literal>.</para> 5226 5227<note> 5228<para>This parameter is documented here, but the declaration is actually 5229in the <filename>chunker.xsl</filename> stylesheet module.</para> 5230</note> 5231 5232</refsect1> 5233</doc:refentry> 5234 5235 5236<doc:refentry><refmeta> 5237<refentrytitle>chunker.output.indent</refentrytitle> 5238<refmiscinfo role="type">string</refmiscinfo> 5239</refmeta><refnamediv> 5240<refname>chunker.output.indent</refname> 5241<refpurpose>Specification of indentation on generated pages</refpurpose> 5242</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.indent" select="'no'"/> 5243</refsynopsisdiv><refsect1><title>Description</title> 5244 5245<para>This parameter specifies the value of the indent 5246specification for generated pages. Not all processors support 5247specification of this parameter. 5248</para> 5249 5250<note> 5251<para>This parameter is documented here, but the declaration is actually 5252in the <filename>chunker.xsl</filename> stylesheet module.</para> 5253</note> 5254 5255</refsect1> 5256</doc:refentry> 5257 5258 5259<doc:refentry><refmeta> 5260<refentrytitle>chunker.output.media-type</refentrytitle> 5261<refmiscinfo role="type">string</refmiscinfo> 5262</refmeta><refnamediv> 5263<refname>chunker.output.media-type</refname> 5264<refpurpose>Media type to use in generated pages</refpurpose> 5265</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.media-type" select="''"/> 5266</refsynopsisdiv><refsect1><title>Description</title> 5267 5268<para>This parameter specifies the media type that should be used by 5269the chunking stylesheet. Not all processors support specification of 5270this parameter. 5271</para> 5272 5273<note> 5274<para>This parameter is documented here, but the declaration is actually 5275in the <filename>chunker.xsl</filename> stylesheet module.</para> 5276</note> 5277 5278</refsect1> 5279</doc:refentry> 5280 5281 5282<doc:refentry><refmeta> 5283<refentrytitle>chunker.output.method</refentrytitle> 5284<refmiscinfo role="type">list</refmiscinfo> 5285<refmiscinfo role="value">html</refmiscinfo> 5286<refmiscinfo role="value">xml</refmiscinfo> 5287</refmeta><refnamediv> 5288<refname>chunker.output.method</refname> 5289<refpurpose>Method used in generated pages</refpurpose> 5290</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.method" select="'html'"/> 5291</refsynopsisdiv><refsect1><title>Description</title> 5292 5293<para>This parameter specifies the output method to be used in files 5294generated by the chunking stylesheet. 5295</para> 5296 5297<para>This parameter used to be named <literal>output.method</literal>.</para> 5298 5299<note> 5300<para>This parameter is documented here, but the declaration is actually 5301in the <filename>chunker.xsl</filename> stylesheet module.</para> 5302</note> 5303 5304</refsect1> 5305</doc:refentry> 5306 5307 5308<doc:refentry><refmeta> 5309<refentrytitle>chunker.output.omit-xml-declaration</refentrytitle> 5310<refmiscinfo role="type"/> 5311</refmeta><refnamediv> 5312<refname>chunker.output.omit-xml-declaration</refname> 5313<refpurpose>Omit-xml-declaration for generated pages</refpurpose> 5314</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.omit-xml-declaration" select="'no'"/> 5315</refsynopsisdiv><refsect1><title>Description</title> 5316 5317<para>This parameter specifies the value of the omit-xml-declaration 5318specification for generated pages. Not all processors support 5319specification of this parameter. 5320</para> 5321 5322<note> 5323<para>This parameter is documented here, but the declaration is actually 5324in the <filename>chunker.xsl</filename> stylesheet module.</para> 5325</note> 5326 5327</refsect1> 5328</doc:refentry> 5329 5330 5331<doc:refentry><refmeta> 5332<refentrytitle>chunker.output.standalone</refentrytitle> 5333<refmiscinfo role="type">string</refmiscinfo> 5334</refmeta><refnamediv> 5335<refname>chunker.output.standalone</refname> 5336<refpurpose>Standalone declaration for generated pages</refpurpose> 5337</refnamediv><refsynopsisdiv><xsl:param name="chunker.output.standalone" select="'no'"/> 5338</refsynopsisdiv><refsect1><title>Description</title> 5339 5340<para>This parameter specifies the value of the standalone 5341specification for generated pages. Not all processors support 5342specification of this parameter. 5343</para> 5344 5345<note> 5346<para>This parameter is documented here, but the declaration is actually 5347in the <filename>chunker.xsl</filename> stylesheet module.</para> 5348</note> 5349 5350</refsect1> 5351</doc:refentry> 5352 5353 5354<doc:refentry><refmeta> 5355<refentrytitle>saxon.character.representation</refentrytitle> 5356<refmiscinfo role="type">string</refmiscinfo> 5357</refmeta><refnamediv> 5358<refname>saxon.character.representation</refname> 5359<refpurpose>Saxon character representation used in generated HTML pages</refpurpose> 5360</refnamediv><refsynopsisdiv><xsl:param name="saxon.character.representation" select="'entity;decimal'"/> 5361</refsynopsisdiv><refsect1><title>Description</title> 5362 5363<para>This character representation is used in files generated by chunking stylesheet. If 5364you want to suppress entity references for characters with direct representation 5365in default.encoding, set this parameter to value <literal>native</literal>. 5366</para> 5367 5368<note> 5369<para>This parameter is documented here, but the declaration is actually 5370in the <filename>chunker.xsl</filename> stylesheet module.</para> 5371</note> 5372 5373</refsect1> 5374</doc:refentry> 5375 5376 5377<doc:refentry><refmeta> 5378<refentrytitle>html.ext</refentrytitle> 5379 5380</refmeta><refnamediv> 5381<refname>html.ext</refname> 5382<refpurpose>Identifies the extension of generated HTML files</refpurpose> 5383</refnamediv><refsynopsisdiv> 5384 5385</refsynopsisdiv><refsect1><title>Description</title> 5386 5387<para>The extension identified by <parameter>html.ext</parameter> will 5388be used as the filename extension for chunks created by this stylesheet. 5389</para> 5390 5391</refsect1> 5392</doc:refentry> 5393<xsl:param name="html.ext" select="'.html'"/> 5394 5395<doc:refentry><refmeta> 5396<refentrytitle>use.id.as.filename</refentrytitle> 5397<refmiscinfo role="type">boolean</refmiscinfo> 5398</refmeta><refnamediv> 5399<refname>use.id.as.filename</refname> 5400<refpurpose>Use ID value of chunk elements as the filename?</refpurpose> 5401</refnamediv><refsynopsisdiv> 5402 5403</refsynopsisdiv><refsect1><title>Description</title> 5404 5405<para>If <parameter>use.id.as.filename</parameter> 5406is non-zero, the filename of chunk elements that have IDs will be 5407derived from the ID value. 5408</para> 5409 5410</refsect1> 5411</doc:refentry> 5412<xsl:param name="use.id.as.filename" select="'0'"/> 5413 5414<doc:refentry><refmeta> 5415<refentrytitle>html.extra.head.links</refentrytitle> 5416<refmiscinfo role="type">boolean</refmiscinfo> 5417</refmeta><refnamediv> 5418<refname>html.extra.head.links</refname> 5419<refpurpose>Toggle extra HTML head link information</refpurpose> 5420</refnamediv><refsynopsisdiv> 5421 5422</refsynopsisdiv><refsect1><title>Description</title> 5423 5424<para>If non-zero, extra <sgmltag>link</sgmltag> elements will be 5425generated in the <sgmltag>head</sgmltag> of chunked HTML files. These 5426extra links point to chapters, appendixes, sections, etc. as supported 5427by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least). 5428</para> 5429 5430</refsect1> 5431</doc:refentry> 5432<xsl:param name="html.extra.head.links" select="0"/> 5433 5434<doc:refentry><refmeta> 5435<refentrytitle>root.filename</refentrytitle> 5436 5437</refmeta><refnamediv> 5438<refname>root.filename</refname> 5439<refpurpose>Identifies the name of the root HTML file when chunking</refpurpose> 5440</refnamediv><refsynopsisdiv> 5441 5442</refsynopsisdiv><refsect1><title>Description</title> 5443 5444<para>The <parameter>root.filename</parameter> is the base filename for 5445the chunk created for the root of each document processed. 5446</para> 5447 5448</refsect1> 5449</doc:refentry> 5450<xsl:param name="root.filename" select="'index'"/> 5451 5452<doc:refentry><refmeta> 5453<refentrytitle>base.dir</refentrytitle> 5454 5455</refmeta><refnamediv> 5456<refname>base.dir</refname> 5457<refpurpose>The base directory of chunks</refpurpose> 5458</refnamediv><refsynopsisdiv> 5459 5460</refsynopsisdiv><refsect1><title>Description</title> 5461 5462<para>If specified, the <literal>base.dir</literal> identifies 5463the output directory for chunks. (If not specified, the output directory 5464is system dependent.)</para> 5465 5466</refsect1> 5467</doc:refentry> 5468<xsl:param name="base.dir" select="''"/> 5469 5470<doc:refentry><refmeta> 5471 <refentrytitle>generate.manifest</refentrytitle> 5472 <refmiscinfo role="type">boolean</refmiscinfo> 5473 </refmeta><refnamediv> 5474 <refname>generate.manifest</refname> 5475 <refpurpose>Generate a manifest file?</refpurpose> 5476 </refnamediv><refsynopsisdiv> 5477 5478 </refsynopsisdiv><refsect1><title>Description</title> 5479 5480 <para>If non-zero, a list of HTML files generated by the 5481 stylesheet transformation is written to the file named by 5482 the <parameter>manifest</parameter> parameter.</para> 5483 5484 </refsect1> 5485</doc:refentry> 5486<xsl:param name="generate.manifest" select="0"/> 5487 5488<doc:refentry><refmeta> 5489 <refentrytitle>manifest</refentrytitle> 5490 <refmiscinfo role="type">string</refmiscinfo> 5491 </refmeta><refnamediv> 5492 <refname>manifest</refname> 5493 <refpurpose>Name of manifest file</refpurpose> 5494 </refnamediv><refsynopsisdiv> 5495 5496 </refsynopsisdiv><refsect1><title>Description</title> 5497 5498 <para>The name of the file to which a manifest is written (if the 5499 value of the <parameter>generate.manifest</parameter> parameter 5500 is non-zero).</para> 5501 5502 </refsect1> 5503</doc:refentry> 5504<xsl:param name="manifest" select="'HTML.manifest'"/> 5505 5506<doc:refentry><refmeta> 5507<refentrytitle>manifest.in.base.dir</refentrytitle> 5508<refmiscinfo role="type">boolean</refmiscinfo> 5509</refmeta><refnamediv> 5510<refname>manifest.in.base.dir</refname> 5511<refpurpose>Should be manifest file written in $base.dir?</refpurpose> 5512</refnamediv><refsynopsisdiv> 5513 5514</refsynopsisdiv><refsect1><title>Description</title> 5515 5516<para>If non-zero manifest file and project files for HTML Help and 5517Eclipse Help are written into <parameter>base.dir</parameter> instead 5518of current directory.</para> 5519 5520</refsect1> 5521</doc:refentry> 5522<xsl:param name="manifest.in.base.dir" select="0"/> 5523 5524<doc:refentry><refmeta> 5525<refentrytitle>chunk.toc</refentrytitle> 5526<refmiscinfo role="type">string</refmiscinfo> 5527</refmeta><refnamediv> 5528<refname>chunk.toc</refname> 5529<refpurpose>An explicit TOC to be used for chunking</refpurpose> 5530</refnamediv><refsynopsisdiv> 5531 5532</refsynopsisdiv><refsect1><title>Description</title> 5533 5534<para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that 5535will be used for chunking. This parameter is only used by the 5536<filename>chunktoc.xsl</filename> stylesheet (and customization layers built 5537from it).</para> 5538 5539</refsect1> 5540</doc:refentry> 5541<xsl:param name="chunk.toc" select="''"/> 5542 5543<doc:refentry><refmeta> 5544<refentrytitle>chunk.tocs.and.lots</refentrytitle> 5545<refmiscinfo role="type">boolean</refmiscinfo> 5546</refmeta><refnamediv> 5547<refname>chunk.tocs.and.lots</refname> 5548<refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose> 5549</refnamediv><refsynopsisdiv> 5550 5551</refsynopsisdiv><refsect1><title>Description</title> 5552 5553<para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.) 5554will be put in a separate chunk. At the moment, this chunk is not in the 5555normal forward/backward navigation list. Instead, a new link is added to the 5556navigation footer.</para> 5557 5558<para>This feature is still somewhat experimental. Feedback welcome.</para> 5559 5560</refsect1> 5561</doc:refentry> 5562<xsl:param name="chunk.tocs.and.lots" select="0"/> 5563 5564<doc:refentry><refmeta> 5565<refentrytitle>chunk.separate.lots</refentrytitle> 5566<refmiscinfo role="type">boolean</refmiscinfo> 5567</refmeta><refnamediv> 5568<refname>chunk.separate.lots</refname> 5569<refpurpose>Should each LoT be in its own separate chunk?</refpurpose> 5570</refnamediv><refsynopsisdiv> 5571 5572</refsynopsisdiv><refsect1><title>Description</title> 5573 5574<para>If non-zero, each of the ToC and LoTs 5575(List of Examples, List of Figures, etc.) 5576will be put in its own separate chunk. 5577The title page includes generated links to each of the separate files. 5578</para> 5579<para> 5580This feature depends on the 5581<literal>chunk.tocs.and.lots</literal> 5582parameter also being non-zero. 5583</para> 5584 5585</refsect1> 5586</doc:refentry> 5587<xsl:param name="chunk.separate.lots" select="0"/> 5588 5589<doc:refentry><refmeta> 5590<refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle> 5591<refmiscinfo role="type">boolean</refmiscinfo> 5592</refmeta><refnamediv> 5593<refname>chunk.tocs.and.lots.has.title</refname> 5594<refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose> 5595</refnamediv><refsynopsisdiv> 5596 5597</refsynopsisdiv><refsect1><title>Description</title> 5598 5599<para>If non-zero title of document is shown before ToC/LoT in 5600separate chunk.</para> 5601 5602</refsect1> 5603</doc:refentry> 5604<xsl:param name="chunk.tocs.and.lots.has.title" select="1"/> 5605 5606<doc:refentry><refmeta> 5607<refentrytitle>chunk.section.depth</refentrytitle> 5608<refmiscinfo role="type">integer</refmiscinfo> 5609</refmeta><refnamediv> 5610<refname>chunk.section.depth</refname> 5611<refpurpose>Depth to which sections should be chunked</refpurpose> 5612</refnamediv><refsynopsisdiv> 5613 5614</refsynopsisdiv><refsect1><title>Description</title> 5615 5616<para>This parameter sets the depth of section chunking.</para> 5617 5618</refsect1> 5619</doc:refentry> 5620<xsl:param name="chunk.section.depth" select="1"/> 5621 5622<doc:refentry><refmeta> 5623<refentrytitle>chunk.first.sections</refentrytitle> 5624 5625</refmeta><refnamediv> 5626<refname>chunk.first.sections</refname> 5627<refpurpose>Chunk the first top-level section?</refpurpose> 5628</refnamediv><refsynopsisdiv> 5629 5630</refsynopsisdiv><refsect1><title>Description</title> 5631 5632<para>If non-zero, a chunk will be created for the first top-level 5633<sgmltag>sect1</sgmltag> or <sgmltag>section</sgmltag> elements in 5634each component. Otherwise, that section will be part of the chunk for 5635its parent. 5636</para> 5637 5638</refsect1> 5639</doc:refentry> 5640<xsl:param name="chunk.first.sections" select="0"/> 5641 5642<doc:refentry><refmeta> 5643<refentrytitle>chunk.quietly</refentrytitle> 5644 5645</refmeta><refnamediv> 5646<refname>chunk.quietly</refname> 5647<refpurpose>Omit the chunked filename messages.</refpurpose> 5648</refnamediv><refsynopsisdiv> 5649 5650</refsynopsisdiv><refsect1><title>Description</title> 5651 5652<para>If zero (the default), the XSL processor emits a message naming 5653each separate chunk filename as it is being output. 5654If nonzero, then the messages are suppressed. 5655</para> 5656 5657</refsect1> 5658</doc:refentry> 5659<xsl:param name="chunk.quietly" select="0"/> 5660 5661<doc:refentry><refmeta> 5662<refentrytitle>navig.graphics</refentrytitle> 5663<refmiscinfo role="type">boolean</refmiscinfo> 5664</refmeta><refnamediv> 5665<refname>navig.graphics</refname> 5666<refpurpose>Use graphics in navigational headers and footers?</refpurpose> 5667</refnamediv><refsynopsisdiv> 5668 5669</refsynopsisdiv><refsect1><title>Description</title> 5670 5671<para>If true (non-zero), the navigational headers and footers in chunked 5672HTML are presented in an alternate style that uses 5673graphical icons for Next, Previous, Up, and Home. 5674Default graphics are provided in the distribution. 5675</para> 5676 5677</refsect1> 5678</doc:refentry> 5679<xsl:param name="navig.graphics" select="0"/> 5680 5681<doc:refentry><refmeta> 5682<refentrytitle>navig.graphics.extension</refentrytitle> 5683<refmiscinfo role="type">string</refmiscinfo> 5684</refmeta><refnamediv> 5685<refname>navig.graphics.extension</refname> 5686<refpurpose>Extension for navigational graphics</refpurpose> 5687</refnamediv><refsynopsisdiv> 5688 5689</refsynopsisdiv><refsect1><title>Description</title> 5690 5691<para>Sets the filename extension to use on navigational graphics used 5692in the headers and footers of chunked HTML.</para> 5693 5694</refsect1> 5695</doc:refentry> 5696<xsl:param name="navig.graphics.extension" select="'.gif'"/> 5697 5698<doc:refentry><refmeta> 5699<refentrytitle>navig.graphics.path</refentrytitle> 5700<refmiscinfo role="type">string</refmiscinfo> 5701</refmeta><refnamediv> 5702<refname>navig.graphics.path</refname> 5703<refpurpose>Path to navigational graphics</refpurpose> 5704</refnamediv><refsynopsisdiv> 5705 5706</refsynopsisdiv><refsect1><title>Description</title> 5707 5708<para>Sets the path, probably relative to the directory where the HTML 5709files are created, to the navigational graphics used in the 5710headers and footers of chunked HTML. 5711</para> 5712 5713</refsect1> 5714</doc:refentry> 5715<xsl:param name="navig.graphics.path">images/</xsl:param> 5716 5717<doc:refentry><refmeta> 5718<refentrytitle>navig.showtitles</refentrytitle> 5719<refmiscinfo role="type">boolean</refmiscinfo> 5720</refmeta><refnamediv> 5721<refname>navig.showtitles</refname> 5722<refpurpose>Display titles in HTML headers and footers?</refpurpose> 5723</refnamediv><refsynopsisdiv> 5724 5725</refsynopsisdiv><refsect1><title>Description</title> 5726 5727<para>If true (non-zero), 5728the headers and footers of chunked HTML 5729display the titles of the next and previous chunks, 5730along with the words 'Next' and 'Previous' (or the 5731equivalent graphical icons if navig.graphics is true). 5732If false (zero), then only the words 'Next' and 'Previous' 5733(or the icons) are displayed. 5734</para> 5735 5736</refsect1> 5737</doc:refentry> 5738<xsl:param name="navig.showtitles">1</xsl:param> 5739 5740<doc:refentry><refmeta> 5741<refentrytitle>profile.arch</refentrytitle> 5742<refmiscinfo role="type">string</refmiscinfo> 5743</refmeta><refnamediv> 5744<refname>profile.arch</refname> 5745<refpurpose>Target profile for <sgmltag class="attribute">arch</sgmltag> 5746attribute</refpurpose> 5747</refnamediv><refsynopsisdiv> 5748 5749</refsynopsisdiv><refsect1><title>Description</title> 5750 5751<para>Value of this parameter specifies profiles which should be 5752included in the output. You can specify multiple profiles by 5753separating them by semicolon. You can change separator character by 5754<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5755parameter.</para> 5756 5757<para>This parameter has effect only when you are using profiling 5758stylesheets (<filename>profile-docbook.xsl</filename>, 5759<filename>profile-chunk.xsl</filename>, ���) instead of normal 5760ones (<filename>docbook.xsl</filename>, 5761<filename>chunk.xsl</filename>, ���).</para> 5762 5763</refsect1> 5764</doc:refentry> 5765<xsl:param name="profile.arch" select="''"/> 5766 5767<doc:refentry><refmeta> 5768<refentrytitle>profile.condition</refentrytitle> 5769<refmiscinfo role="type">string</refmiscinfo> 5770</refmeta><refnamediv> 5771<refname>profile.condition</refname> 5772<refpurpose>Target profile for <sgmltag class="attribute">condition</sgmltag> 5773attribute</refpurpose> 5774</refnamediv><refsynopsisdiv> 5775 5776</refsynopsisdiv><refsect1><title>Description</title> 5777 5778<para>Value of this parameter specifies profiles which should be 5779included in the output. You can specify multiple profiles by 5780separating them by semicolon. You can change separator character by 5781<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5782parameter.</para> 5783 5784<para>This parameter has effect only when you are using profiling 5785stylesheets (<filename>profile-docbook.xsl</filename>, 5786<filename>profile-chunk.xsl</filename>, ���) instead of normal 5787ones (<filename>docbook.xsl</filename>, 5788<filename>chunk.xsl</filename>, ���).</para> 5789 5790</refsect1> 5791</doc:refentry> 5792<xsl:param name="profile.condition" select="''"/> 5793 5794<doc:refentry><refmeta> 5795<refentrytitle>profile.conformance</refentrytitle> 5796<refmiscinfo role="type">string</refmiscinfo> 5797</refmeta><refnamediv> 5798<refname>profile.conformance</refname> 5799<refpurpose>Target profile for <sgmltag class="attribute">conformance</sgmltag> 5800attribute</refpurpose> 5801</refnamediv><refsynopsisdiv> 5802 5803</refsynopsisdiv><refsect1><title>Description</title> 5804 5805<para>Value of this parameter specifies profiles which should be 5806included in the output. You can specify multiple profiles by 5807separating them by semicolon. You can change separator character by 5808<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5809parameter.</para> 5810 5811<para>This parameter has effect only when you are using profiling 5812stylesheets (<filename>profile-docbook.xsl</filename>, 5813<filename>profile-chunk.xsl</filename>, ���) instead of normal 5814ones (<filename>docbook.xsl</filename>, 5815<filename>chunk.xsl</filename>, ���).</para> 5816 5817</refsect1> 5818</doc:refentry> 5819<xsl:param name="profile.conformance" select="''"/> 5820 5821<doc:refentry><refmeta> 5822<refentrytitle>profile.lang</refentrytitle> 5823<refmiscinfo role="type">string</refmiscinfo> 5824</refmeta><refnamediv> 5825<refname>profile.lang</refname> 5826<refpurpose>Target profile for <sgmltag class="attribute">lang</sgmltag> 5827attribute</refpurpose> 5828</refnamediv><refsynopsisdiv> 5829 5830</refsynopsisdiv><refsect1><title>Description</title> 5831 5832<para>Value of this parameter specifies profiles which should be 5833included in the output. You can specify multiple profiles by 5834separating them by semicolon. You can change separator character by 5835<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5836parameter.</para> 5837 5838<para>This parameter has effect only when you are using profiling 5839stylesheets (<filename>profile-docbook.xsl</filename>, 5840<filename>profile-chunk.xsl</filename>, ���) instead of normal 5841ones (<filename>docbook.xsl</filename>, 5842<filename>chunk.xsl</filename>, ���).</para> 5843 5844</refsect1> 5845</doc:refentry> 5846<xsl:param name="profile.lang" select="''"/> 5847 5848<doc:refentry><refmeta> 5849<refentrytitle>profile.os</refentrytitle> 5850<refmiscinfo role="type">string</refmiscinfo> 5851</refmeta><refnamediv> 5852<refname>profile.os</refname> 5853<refpurpose>Target profile for <sgmltag class="attribute">os</sgmltag> 5854attribute</refpurpose> 5855</refnamediv><refsynopsisdiv> 5856 5857</refsynopsisdiv><refsect1><title>Description</title> 5858 5859<para>Value of this parameter specifies profiles which should be 5860included in the output. You can specify multiple profiles by 5861separating them by semicolon. You can change separator character by 5862<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5863parameter.</para> 5864 5865<para>This parameter has effect only when you are using profiling 5866stylesheets (<filename>profile-docbook.xsl</filename>, 5867<filename>profile-chunk.xsl</filename>, ���) instead of normal 5868ones (<filename>docbook.xsl</filename>, 5869<filename>chunk.xsl</filename>, ���).</para> 5870 5871</refsect1> 5872</doc:refentry> 5873<xsl:param name="profile.os" select="''"/> 5874 5875<doc:refentry><refmeta> 5876<refentrytitle>profile.revision</refentrytitle> 5877<refmiscinfo role="type">string</refmiscinfo> 5878</refmeta><refnamediv> 5879<refname>profile.revision</refname> 5880<refpurpose>Target profile for <sgmltag class="attribute">revision</sgmltag> 5881attribute</refpurpose> 5882</refnamediv><refsynopsisdiv> 5883 5884</refsynopsisdiv><refsect1><title>Description</title> 5885 5886<para>Value of this parameter specifies profiles which should be 5887included in the output. You can specify multiple profiles by 5888separating them by semicolon. You can change separator character by 5889<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5890parameter.</para> 5891 5892<para>This parameter has effect only when you are using profiling 5893stylesheets (<filename>profile-docbook.xsl</filename>, 5894<filename>profile-chunk.xsl</filename>, ���) instead of normal 5895ones (<filename>docbook.xsl</filename>, 5896<filename>chunk.xsl</filename>, ���).</para> 5897 5898</refsect1> 5899</doc:refentry> 5900<xsl:param name="profile.revision" select="''"/> 5901 5902<doc:refentry><refmeta> 5903<refentrytitle>profile.revisionflag</refentrytitle> 5904<refmiscinfo role="type">string</refmiscinfo> 5905</refmeta><refnamediv> 5906<refname>profile.revisionflag</refname> 5907<refpurpose>Target profile for <sgmltag class="attribute">revisionflag</sgmltag> 5908attribute</refpurpose> 5909</refnamediv><refsynopsisdiv> 5910 5911</refsynopsisdiv><refsect1><title>Description</title> 5912 5913<para>Value of this parameter specifies profiles which should be 5914included in the output. You can specify multiple profiles by 5915separating them by semicolon. You can change separator character by 5916<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5917parameter.</para> 5918 5919<para>This parameter has effect only when you are using profiling 5920stylesheets (<filename>profile-docbook.xsl</filename>, 5921<filename>profile-chunk.xsl</filename>, ���) instead of normal 5922ones (<filename>docbook.xsl</filename>, 5923<filename>chunk.xsl</filename>, ���).</para> 5924 5925</refsect1> 5926</doc:refentry> 5927<xsl:param name="profile.revisionflag" select="''"/> 5928 5929<doc:refentry><refmeta> 5930<refentrytitle>profile.role</refentrytitle> 5931<refmiscinfo role="type">string</refmiscinfo> 5932</refmeta><refnamediv> 5933<refname>profile.role</refname> 5934<refpurpose>Target profile for <sgmltag class="attribute">role</sgmltag> 5935attribute</refpurpose> 5936</refnamediv><refsynopsisdiv> 5937 5938</refsynopsisdiv><refsect1><title>Description</title> 5939 5940<para>Value of this parameter specifies profiles which should be 5941included in the output. You can specify multiple profiles by 5942separating them by semicolon. You can change separator character by 5943<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5944parameter.</para> 5945 5946<para>This parameter has effect only when you are using profiling 5947stylesheets (<filename>profile-docbook.xsl</filename>, 5948<filename>profile-chunk.xsl</filename>, ���) instead of normal 5949ones (<filename>docbook.xsl</filename>, 5950<filename>chunk.xsl</filename>, ���).</para> 5951 5952<warning> 5953<para>Note that <sgmltag class="attribute">role</sgmltag> is often 5954used for other purposes than profiling. For example it is commonly 5955used to get emphasize in bold font:</para> 5956 5957<programlisting><emphasis role="bold">very important</emphasis></programlisting> 5958 5959<para>If you are using <sgmltag class="attribute">role</sgmltag> for 5960these purposes do not forget to add values like <literal>bold</literal> to 5961value of this parameter. If you forgot you will get document with 5962small pieces missing which are very hard to track.</para> 5963 5964<para>For this reason it is not recommended to use <sgmltag class="attribute">role</sgmltag> attribute for profiling. You should 5965rather 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> 5966</warning> 5967 5968</refsect1> 5969</doc:refentry> 5970<xsl:param name="profile.role" select="''"/> 5971 5972<doc:refentry><refmeta> 5973<refentrytitle>profile.security</refentrytitle> 5974<refmiscinfo role="type">string</refmiscinfo> 5975</refmeta><refnamediv> 5976<refname>profile.security</refname> 5977<refpurpose>Target profile for <sgmltag class="attribute">security</sgmltag> 5978attribute</refpurpose> 5979</refnamediv><refsynopsisdiv> 5980 5981</refsynopsisdiv><refsect1><title>Description</title> 5982 5983<para>Value of this parameter specifies profiles which should be 5984included in the output. You can specify multiple profiles by 5985separating them by semicolon. You can change separator character by 5986<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 5987parameter.</para> 5988 5989<para>This parameter has effect only when you are using profiling 5990stylesheets (<filename>profile-docbook.xsl</filename>, 5991<filename>profile-chunk.xsl</filename>, ���) instead of normal 5992ones (<filename>docbook.xsl</filename>, 5993<filename>chunk.xsl</filename>, ���).</para> 5994 5995</refsect1> 5996</doc:refentry> 5997<xsl:param name="profile.security" select="''"/> 5998 5999<doc:refentry><refmeta> 6000<refentrytitle>profile.userlevel</refentrytitle> 6001<refmiscinfo role="type">string</refmiscinfo> 6002</refmeta><refnamediv> 6003<refname>profile.userlevel</refname> 6004<refpurpose>Target profile for <sgmltag class="attribute">userlevel</sgmltag> 6005attribute</refpurpose> 6006</refnamediv><refsynopsisdiv> 6007 6008</refsynopsisdiv><refsect1><title>Description</title> 6009 6010<para>Value of this parameter specifies profiles which should be 6011included in the output. You can specify multiple profiles by 6012separating them by semicolon. You can change separator character by 6013<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 6014parameter.</para> 6015 6016<para>This parameter has effect only when you are using profiling 6017stylesheets (<filename>profile-docbook.xsl</filename>, 6018<filename>profile-chunk.xsl</filename>, ���) instead of normal 6019ones (<filename>docbook.xsl</filename>, 6020<filename>chunk.xsl</filename>, ���).</para> 6021 6022</refsect1> 6023</doc:refentry> 6024<xsl:param name="profile.userlevel" select="''"/> 6025 6026<doc:refentry><refmeta> 6027<refentrytitle>profile.vendor</refentrytitle> 6028<refmiscinfo role="type">string</refmiscinfo> 6029</refmeta><refnamediv> 6030<refname>profile.vendor</refname> 6031<refpurpose>Target profile for <sgmltag class="attribute">vendor</sgmltag> 6032attribute</refpurpose> 6033</refnamediv><refsynopsisdiv> 6034 6035</refsynopsisdiv><refsect1><title>Description</title> 6036 6037<para>Value of this parameter specifies profiles which should be 6038included in the output. You can specify multiple profiles by 6039separating them by semicolon. You can change separator character by 6040<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 6041parameter.</para> 6042 6043<para>This parameter has effect only when you are using profiling 6044stylesheets (<filename>profile-docbook.xsl</filename>, 6045<filename>profile-chunk.xsl</filename>, ���) instead of normal 6046ones (<filename>docbook.xsl</filename>, 6047<filename>chunk.xsl</filename>, ���).</para> 6048 6049</refsect1> 6050</doc:refentry> 6051<xsl:param name="profile.vendor" select="''"/> 6052 6053<doc:refentry><refmeta> 6054<refentrytitle>profile.attribute</refentrytitle> 6055<refmiscinfo role="type">string</refmiscinfo> 6056</refmeta><refnamediv> 6057<refname>profile.attribute</refname> 6058<refpurpose>Name of user-specified profiling attribute</refpurpose> 6059</refnamediv><refsynopsisdiv> 6060 6061</refsynopsisdiv><refsect1><title>Description</title> 6062 6063<para>This parameter is used in conjuction with <link linkend="profile.value"><parameter>profile.value</parameter></link>.</para> 6064 6065<para>This parameter has effect only when you are using profiling 6066stylesheets (<filename>profile-docbook.xsl</filename>, 6067<filename>profile-chunk.xsl</filename>, ���) instead of normal 6068ones (<filename>docbook.xsl</filename>, 6069<filename>chunk.xsl</filename>, ���).</para> 6070 6071</refsect1> 6072</doc:refentry> 6073<xsl:param name="profile.attribute" select="''"/> 6074 6075<doc:refentry><refmeta> 6076<refentrytitle>profile.value</refentrytitle> 6077<refmiscinfo role="type">string</refmiscinfo> 6078</refmeta><refnamediv> 6079<refname>profile.value</refname> 6080<refpurpose>Target profile for user-specified attribute</refpurpose> 6081</refnamediv><refsynopsisdiv> 6082 6083</refsynopsisdiv><refsect1><title>Description</title> 6084 6085<para>When you are using this parameter you must also specify name of 6086profiling attribute with parameter <link linkend="profile.attribute"><parameter>profile.attribute</parameter></link>.</para> 6087 6088<para>Value of this parameter specifies profiles which should be 6089included in the output. You can specify multiple profiles by 6090separating them by semicolon. You can change separator character by 6091<link linkend="profile.separator"><parameter>profile.separator</parameter></link> 6092parameter.</para> 6093 6094<para>This parameter has effect only when you are using profiling 6095stylesheets (<filename>profile-docbook.xsl</filename>, 6096<filename>profile-chunk.xsl</filename>, ���) instead of normal 6097ones (<filename>docbook.xsl</filename>, 6098<filename>chunk.xsl</filename>, ���).</para> 6099 6100</refsect1> 6101</doc:refentry> 6102<xsl:param name="profile.value" select="''"/> 6103 6104<doc:refentry><refmeta> 6105<refentrytitle>profile.separator</refentrytitle> 6106<refmiscinfo role="type">string</refmiscinfo> 6107</refmeta><refnamediv> 6108<refname>profile.separator</refname> 6109<refpurpose>Separator character for compound profile values</refpurpose> 6110</refnamediv><refsynopsisdiv> 6111 6112</refsynopsisdiv><refsect1><title>Description</title> 6113 6114<para>Separator character for compound profile values.</para> 6115 6116</refsect1> 6117</doc:refentry> 6118<xsl:param name="profile.separator" select="';'"/> 6119 6120<doc:refentry><refmeta> 6121<refentrytitle>htmlhelp.encoding</refentrytitle> 6122<refmiscinfo role="type">string</refmiscinfo> 6123</refmeta><refnamediv> 6124<refname>htmlhelp.encoding</refname> 6125<refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose> 6126</refnamediv><refsynopsisdiv> 6127 6128</refsynopsisdiv><refsect1><title>Description</title> 6129 6130<para>HTML Help Compiler is not UTF-8 aware, so you should always use 6131apropriate single-byte encoding here.</para> 6132 6133</refsect1> 6134</doc:refentry> 6135<xsl:param name="htmlhelp.encoding" select="'iso-8859-1'"/> 6136 6137<doc:refentry><refmeta> 6138<refentrytitle>htmlhelp.autolabel</refentrytitle> 6139<refmiscinfo role="type">boolean</refmiscinfo> 6140</refmeta><refnamediv> 6141<refname>htmlhelp.autolabel</refname> 6142<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> 6143</refnamediv><refsynopsisdiv> 6144 6145</refsynopsisdiv><refsect1><title>Description</title> 6146 6147<para>If you want to include chapter and section numbers into ToC in 6148the left panel, set this parameter to 1.</para> 6149 6150</refsect1> 6151</doc:refentry> 6152<xsl:param name="htmlhelp.autolabel" select="0"/> 6153 6154<doc:refentry><refmeta> 6155<refentrytitle>htmlhelp.chm</refentrytitle> 6156<refmiscinfo role="type">string</refmiscinfo> 6157</refmeta><refnamediv> 6158<refname>htmlhelp.chm</refname> 6159<refpurpose>Filename of output HTML Help file.</refpurpose> 6160</refnamediv><refsynopsisdiv> 6161 6162</refsynopsisdiv><refsect1><title>Description</title> 6163 6164<para>Change this parameter if you want different name of result 6165CHM file than htmlhelp.chm.</para> 6166 6167</refsect1> 6168</doc:refentry> 6169<xsl:param name="htmlhelp.chm" select="'htmlhelp.chm'"/> 6170 6171<doc:refentry><refmeta> 6172<refentrytitle>htmlhelp.default.topic</refentrytitle> 6173<refmiscinfo role="type">string</refmiscinfo> 6174</refmeta><refnamediv> 6175<refname>htmlhelp.default.topic</refname> 6176<refpurpose>Name of file with default topic</refpurpose> 6177</refnamediv><refsynopsisdiv> 6178 6179</refsynopsisdiv><refsect1><title>Description</title> 6180 6181<para>Normally first chunk of document is displayed when you open HTML 6182Help file. If you want to display another topic, simply set its 6183filename by this parameter.</para> 6184 6185<para>This is useful especially if you don't generate ToC in front of 6186your document and you also hide root element in ToC. E.g.:</para> 6187 6188<programlisting><xsl:param name="generate.book.toc" select="0"/> 6189<xsl:param name="htmlhelp.hhc.show.root" select="0"/> 6190<xsl:param name="htmlhelp.default.topic" select="'pr01.html'"/></programlisting> 6191 6192</refsect1> 6193</doc:refentry> 6194<xsl:param name="htmlhelp.default.topic" select="''"/> 6195 6196<doc:refentry><refmeta> 6197<refentrytitle>htmlhelp.display.progress</refentrytitle> 6198<refmiscinfo role="type">boolean</refmiscinfo> 6199</refmeta><refnamediv> 6200<refname>htmlhelp.display.progress</refname> 6201<refpurpose>Display compile progress?</refpurpose> 6202</refnamediv><refsynopsisdiv> 6203 6204</refsynopsisdiv><refsect1><title>Description</title> 6205 6206<para>You can swith off display of compile progress by setting this 6207parameter to 0.</para> 6208 6209</refsect1> 6210</doc:refentry> 6211<xsl:param name="htmlhelp.display.progress" select="1"/> 6212 6213<doc:refentry><refmeta> 6214<refentrytitle>htmlhelp.hhp</refentrytitle> 6215<refmiscinfo role="type">string</refmiscinfo> 6216</refmeta><refnamediv> 6217<refname>htmlhelp.hhp</refname> 6218<refpurpose>Filename of project file.</refpurpose> 6219</refnamediv><refsynopsisdiv> 6220 6221</refsynopsisdiv><refsect1><title>Description</title> 6222 6223<para>Change this parameter if you want different name of project 6224file than htmlhelp.hhp.</para> 6225 6226</refsect1> 6227</doc:refentry> 6228<xsl:param name="htmlhelp.hhp" select="'htmlhelp.hhp'"/> 6229 6230<doc:refentry><refmeta> 6231<refentrytitle>htmlhelp.hhc</refentrytitle> 6232<refmiscinfo role="type">string</refmiscinfo> 6233</refmeta><refnamediv> 6234<refname>htmlhelp.hhc</refname> 6235<refpurpose>Filename of TOC file.</refpurpose> 6236</refnamediv><refsynopsisdiv> 6237 6238</refsynopsisdiv><refsect1><title>Description</title> 6239 6240<para>Change this parameter if you want different name of TOC file 6241than toc.hhc.</para> 6242 6243</refsect1> 6244</doc:refentry> 6245<xsl:param name="htmlhelp.hhc" select="'toc.hhc'"/> 6246 6247<doc:refentry><refmeta> 6248<refentrytitle>htmlhelp.hhk</refentrytitle> 6249<refmiscinfo role="type">string</refmiscinfo> 6250</refmeta><refnamediv> 6251<refname>htmlhelp.hhk</refname> 6252<refpurpose>Filename of index file.</refpurpose> 6253</refnamediv><refsynopsisdiv> 6254 6255</refsynopsisdiv><refsect1><title>Description</title> 6256 6257<para>Change this parameter if you want different name of index file 6258than index.hhk.</para> 6259 6260</refsect1> 6261</doc:refentry> 6262<xsl:param name="htmlhelp.hhk" select="'index.hhk'"/> 6263 6264<doc:refentry><refmeta> 6265<refentrytitle>htmlhelp.hhp.tail</refentrytitle> 6266<refmiscinfo role="type">string</refmiscinfo> 6267</refmeta><refnamediv> 6268<refname>htmlhelp.hhp.tail</refname> 6269<refpurpose>Additional content for project file.</refpurpose> 6270</refnamediv><refsynopsisdiv> 6271 6272</refsynopsisdiv><refsect1><title>Description</title> 6273 6274<para>If you want to include some additional parameters into project file, 6275store appropriate part of project file into this parameter.</para> 6276 6277</refsect1> 6278</doc:refentry> 6279<xsl:param name="htmlhelp.hhp.tail"/> 6280 6281<doc:refentry><refmeta> 6282<refentrytitle>htmlhelp.hhp.window</refentrytitle> 6283<refmiscinfo role="type">string</refmiscinfo> 6284</refmeta><refnamediv> 6285<refname>htmlhelp.hhp.window</refname> 6286<refpurpose>Name of default window.</refpurpose> 6287</refnamediv><refsynopsisdiv> 6288 6289</refsynopsisdiv><refsect1><title>Description</title> 6290 6291<para>Name of default window. If empty no [WINDOWS] section will be 6292added to project file.</para> 6293 6294</refsect1> 6295</doc:refentry> 6296<xsl:param name="htmlhelp.hhp.window" select="'Main'"/> 6297 6298<doc:refentry><refmeta> 6299<refentrytitle>htmlhelp.hhp.windows</refentrytitle> 6300<refmiscinfo role="type">string</refmiscinfo> 6301</refmeta><refnamediv> 6302<refname>htmlhelp.hhp.windows</refname> 6303<refpurpose>Definition of additional windows</refpurpose> 6304</refnamediv><refsynopsisdiv> 6305 6306</refsynopsisdiv><refsect1><title>Description</title> 6307 6308<para>Content of this parameter is placed at the end of [WINDOWS] 6309section of project file. You can use it for defining your own 6310addtional windows.</para> 6311 6312</refsect1> 6313</doc:refentry> 6314<xsl:param name="htmlhelp.hhp.windows"/> 6315 6316<doc:refentry><refmeta> 6317<refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle> 6318<refmiscinfo role="type">boolean</refmiscinfo> 6319</refmeta><refnamediv> 6320<refname>htmlhelp.enhanced.decompilation</refname> 6321<refpurpose>Allow enhanced decompilation of CHM?</refpurpose> 6322</refnamediv><refsynopsisdiv> 6323 6324</refsynopsisdiv><refsect1><title>Description</title> 6325 6326<para>When set to 1 this parameter enables enhanced decompilation of CHM.</para> 6327 6328</refsect1> 6329</doc:refentry> 6330<xsl:param name="htmlhelp.enhanced.decompilation" select="0"/> 6331 6332<doc:refentry><refmeta> 6333<refentrytitle>htmlhelp.enumerate.images</refentrytitle> 6334<refmiscinfo role="type">boolean</refmiscinfo> 6335</refmeta><refnamediv> 6336<refname>htmlhelp.enumerate.images</refname> 6337<refpurpose>Should be paths to all used images added to project file?</refpurpose> 6338</refnamediv><refsynopsisdiv> 6339 6340</refsynopsisdiv><refsect1><title>Description</title> 6341 6342<para>You should turn on this flag, if you insert images into your documents 6343as external binary entities or if you are using absolute path in image names.</para> 6344 6345</refsect1> 6346</doc:refentry> 6347<xsl:param name="htmlhelp.enumerate.images" select="0"/> 6348 6349<doc:refentry><refmeta> 6350<refentrytitle>htmlhelp.force.map.and.alias</refentrytitle> 6351<refmiscinfo role="type">boolean</refmiscinfo> 6352</refmeta><refnamediv> 6353<refname>htmlhelp.force.map.and.alias</refname> 6354<refpurpose>Should be [MAP] and [ALIAS] section added to project file unconditionaly?</refpurpose> 6355</refnamediv><refsynopsisdiv> 6356 6357</refsynopsisdiv><refsect1><title>Description</title> 6358 6359<para>You should turn on this flag, if you have your own 6360<filename>alias.h</filename> and <filename>contex.h</filename> files 6361and you want include reference to them in project file.</para> 6362 6363</refsect1> 6364</doc:refentry> 6365<xsl:param name="htmlhelp.force.map.and.alias" select="0"/> 6366 6367<doc:refentry><refmeta> 6368<refentrytitle>htmlhelp.map.file</refentrytitle> 6369<refmiscinfo role="type">string</refmiscinfo> 6370</refmeta><refnamediv> 6371<refname>htmlhelp.map.file</refname> 6372<refpurpose>Filename of map file.</refpurpose> 6373</refnamediv><refsynopsisdiv> 6374 6375</refsynopsisdiv><refsect1><title>Description</title> 6376 6377<para>Change this parameter if you want different name of map file 6378than <filename>context.h</filename>.</para> 6379 6380</refsect1> 6381</doc:refentry> 6382<xsl:param name="htmlhelp.map.file" select="'context.h'"/> 6383 6384<doc:refentry><refmeta> 6385<refentrytitle>htmlhelp.alias.file</refentrytitle> 6386<refmiscinfo role="type">string</refmiscinfo> 6387</refmeta><refnamediv> 6388<refname>htmlhelp.alias.file</refname> 6389<refpurpose>Filename of map file.</refpurpose> 6390</refnamediv><refsynopsisdiv> 6391 6392</refsynopsisdiv><refsect1><title>Description</title> 6393 6394<para>Change this parameter if you want different name of map file 6395than <filename>alias.h</filename>.</para> 6396 6397</refsect1> 6398</doc:refentry> 6399<xsl:param name="htmlhelp.alias.file" select="'alias.h'"/> 6400 6401<doc:refentry><refmeta> 6402<refentrytitle>htmlhelp.hhc.section.depth</refentrytitle> 6403<refmiscinfo role="type">integer</refmiscinfo> 6404</refmeta><refnamediv> 6405<refname>htmlhelp.hhc.section.depth</refname> 6406<refpurpose>Depth of TOC for sections in a left pane.</refpurpose> 6407</refnamediv><refsynopsisdiv> 6408 6409</refsynopsisdiv><refsect1><title>Description</title> 6410 6411<para>Change this parameter if you want shallower ToC in a left pane 6412of HTML Help viewer.</para> 6413 6414</refsect1> 6415</doc:refentry> 6416<xsl:param name="htmlhelp.hhc.section.depth" select="5"/> 6417 6418<doc:refentry><refmeta> 6419<refentrytitle>htmlhelp.hhc.show.root</refentrytitle> 6420<refmiscinfo role="type">boolean</refmiscinfo> 6421</refmeta><refnamediv> 6422<refname>htmlhelp.hhc.show.root</refname> 6423<refpurpose>Should be entry for root element shown in ToC?</refpurpose> 6424</refnamediv><refsynopsisdiv> 6425 6426</refsynopsisdiv><refsect1><title>Description</title> 6427 6428<para>If set to 0, there will be no entry for root element in 6429ToC. This is useful when you want provide user with expanded ToC as 6430a default.</para> 6431 6432</refsect1> 6433</doc:refentry> 6434<xsl:param name="htmlhelp.hhc.show.root" select="1"/> 6435 6436<doc:refentry><refmeta> 6437<refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle> 6438<refmiscinfo role="type"/> 6439</refmeta><refnamediv> 6440<refname>htmlhelp.hhc.folders.instead.books</refname> 6441<refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose> 6442</refnamediv><refsynopsisdiv> 6443 6444</refsynopsisdiv><refsect1><title>Description</title> 6445 6446<para>This parameter controls whether there should be folder-like 6447icons (1) or book-like icons (0) in ToC. If you want to use 6448folder-like icons you must swith off binary ToC using 6449<parameter>htmlhelp.hhc.binary</parameter>.</para> 6450 6451</refsect1> 6452</doc:refentry> 6453<xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"/> 6454 6455<doc:refentry><refmeta> 6456<refentrytitle>htmlhelp.hhc.binary</refentrytitle> 6457<refmiscinfo role="type"/> 6458</refmeta><refnamediv> 6459<refname>htmlhelp.hhc.binary</refname> 6460<refpurpose>Generate binary ToC?</refpurpose> 6461</refnamediv><refsynopsisdiv> 6462 6463</refsynopsisdiv><refsect1><title>Description</title> 6464 6465<para>This parametr controls whether binary TOC will be generated. You 6466must create binary TOC if you want to add Prev/Next buttons to toolbar 6467(which is default behaviour). Files with binary TOC can't be merged.</para> 6468 6469</refsect1> 6470</doc:refentry> 6471<xsl:param name="htmlhelp.hhc.binary" select="1"/> 6472 6473<doc:refentry><refmeta> 6474<refentrytitle>htmlhelp.hhc.width</refentrytitle> 6475<refmiscinfo role="type">integer</refmiscinfo> 6476</refmeta><refnamediv> 6477<refname>htmlhelp.hhc.width</refname> 6478<refpurpose>Width of navigation (ToC) pane</refpurpose> 6479</refnamediv><refsynopsisdiv> 6480 6481</refsynopsisdiv><refsect1><title>Description</title> 6482 6483<para>This parameter specifies width of ToC pane in pixels.</para> 6484 6485</refsect1> 6486</doc:refentry> 6487<xsl:param name="htmlhelp.hhc.width"/> 6488 6489<doc:refentry><refmeta> 6490<refentrytitle>htmlhelp.title</refentrytitle> 6491<refmiscinfo role="type">string</refmiscinfo> 6492</refmeta><refnamediv> 6493<refname>htmlhelp.title</refname> 6494<refpurpose>Title of HTML Help</refpurpose> 6495</refnamediv><refsynopsisdiv> 6496 6497</refsynopsisdiv><refsect1><title>Description</title> 6498 6499<para>Content of this parameter will be used as a title for generated 6500HTML Help. If empty, title will be automatically taken from document.</para> 6501 6502</refsect1> 6503</doc:refentry> 6504<xsl:param name="htmlhelp.title" select="''"/> 6505 6506<doc:refentry><refmeta> 6507<refentrytitle>htmlhelp.show.menu</refentrytitle> 6508<refmiscinfo role="type">boolean</refmiscinfo> 6509</refmeta><refnamediv> 6510<refname>htmlhelp.show.menu</refname> 6511<refpurpose>Should be menu shown?</refpurpose> 6512</refnamediv><refsynopsisdiv> 6513 6514</refsynopsisdiv><refsect1><title>Description</title> 6515 6516<para>If you want application menu in your HTML Help file, turn this 6517parameter to 1.</para> 6518 6519</refsect1> 6520</doc:refentry> 6521<xsl:param name="htmlhelp.show.menu" select="0"/> 6522 6523<doc:refentry><refmeta> 6524<refentrytitle>htmlhelp.show.toolbar.text</refentrytitle> 6525<refmiscinfo role="type">boolean</refmiscinfo> 6526</refmeta><refnamediv> 6527<refname>htmlhelp.show.toolbar.text</refname> 6528<refpurpose>Show text under toolbar buttons?</refpurpose> 6529</refnamediv><refsynopsisdiv> 6530 6531</refsynopsisdiv><refsect1><title>Description</title> 6532 6533<para>You can switch off display of texts under toolbar buttons by 6534setting this parameter to 0.</para> 6535 6536</refsect1> 6537</doc:refentry> 6538<xsl:param name="htmlhelp.show.toolbar.text" select="1"/> 6539 6540<doc:refentry><refmeta> 6541<refentrytitle>htmlhelp.show.advanced.search</refentrytitle> 6542<refmiscinfo role="type">boolean</refmiscinfo> 6543</refmeta><refnamediv> 6544<refname>htmlhelp.show.advanced.search</refname> 6545<refpurpose>Should be advanced search available?</refpurpose> 6546</refnamediv><refsynopsisdiv> 6547 6548</refsynopsisdiv><refsect1><title>Description</title> 6549 6550<para>If you want advanced search features in your help, turn this 6551parameter to 1.</para> 6552 6553</refsect1> 6554</doc:refentry> 6555<xsl:param name="htmlhelp.show.advanced.search" select="0"/> 6556 6557<doc:refentry><refmeta> 6558<refentrytitle>htmlhelp.show.favorities</refentrytitle> 6559<refmiscinfo role="type">boolean</refmiscinfo> 6560</refmeta><refnamediv> 6561<refname>htmlhelp.show.favorities</refname> 6562<refpurpose>Should be favorities tab shown?</refpurpose> 6563</refnamediv><refsynopsisdiv> 6564 6565</refsynopsisdiv><refsect1><title>Description</title> 6566 6567<para>If you want favorities tab shown in your help, turn this 6568parameter to 1.</para> 6569 6570</refsect1> 6571</doc:refentry> 6572<xsl:param name="htmlhelp.show.favorities" select="0"/> 6573 6574<doc:refentry><refmeta> 6575<refentrytitle>htmlhelp.button.hideshow</refentrytitle> 6576<refmiscinfo role="type">boolean</refmiscinfo> 6577</refmeta><refnamediv> 6578<refname>htmlhelp.button.hideshow</refname> 6579<refpurpose>Should be Hide/Show button shown?</refpurpose> 6580</refnamediv><refsynopsisdiv> 6581 6582</refsynopsisdiv><refsect1><title>Description</title> 6583 6584<para>If you want Hide/Show button shown on toolbar, turn this 6585parameter to 1.</para> 6586 6587</refsect1> 6588</doc:refentry> 6589<xsl:param name="htmlhelp.button.hideshow" select="1"/> 6590 6591<doc:refentry><refmeta> 6592<refentrytitle>htmlhelp.button.back</refentrytitle> 6593<refmiscinfo role="type">boolean</refmiscinfo> 6594</refmeta><refnamediv> 6595<refname>htmlhelp.button.back</refname> 6596<refpurpose>Should be Back button shown?</refpurpose> 6597</refnamediv><refsynopsisdiv> 6598 6599</refsynopsisdiv><refsect1><title>Description</title> 6600 6601<para>If you want Back button shown on toolbar, turn this 6602parameter to 1.</para> 6603 6604</refsect1> 6605</doc:refentry> 6606<xsl:param name="htmlhelp.button.back" select="1"/> 6607 6608<doc:refentry><refmeta> 6609<refentrytitle>htmlhelp.button.forward</refentrytitle> 6610<refmiscinfo role="type">boolean</refmiscinfo> 6611</refmeta><refnamediv> 6612<refname>htmlhelp.button.forward</refname> 6613<refpurpose>Should be Forward button shown?</refpurpose> 6614</refnamediv><refsynopsisdiv> 6615 6616</refsynopsisdiv><refsect1><title>Description</title> 6617 6618<para>If you want Forward button shown on toolbar, turn this 6619parameter to 1.</para> 6620 6621</refsect1> 6622</doc:refentry> 6623<xsl:param name="htmlhelp.button.forward" select="0"/> 6624 6625<doc:refentry><refmeta> 6626<refentrytitle>htmlhelp.button.stop</refentrytitle> 6627<refmiscinfo role="type">boolean</refmiscinfo> 6628</refmeta><refnamediv> 6629<refname>htmlhelp.button.stop</refname> 6630<refpurpose>Should be Stop button shown?</refpurpose> 6631</refnamediv><refsynopsisdiv> 6632 6633</refsynopsisdiv><refsect1><title>Description</title> 6634 6635<para>If you want Stop button shown on toolbar, turn this 6636parameter to 1.</para> 6637 6638</refsect1> 6639</doc:refentry> 6640<xsl:param name="htmlhelp.button.stop" select="0"/> 6641 6642<doc:refentry><refmeta> 6643<refentrytitle>htmlhelp.button.refresh</refentrytitle> 6644<refmiscinfo role="type">boolean</refmiscinfo> 6645</refmeta><refnamediv> 6646<refname>htmlhelp.button.refresh</refname> 6647<refpurpose>Should be Refresh button shown?</refpurpose> 6648</refnamediv><refsynopsisdiv> 6649 6650</refsynopsisdiv><refsect1><title>Description</title> 6651 6652<para>If you want Refresh button shown on toolbar, turn this 6653parameter to 1.</para> 6654 6655</refsect1> 6656</doc:refentry> 6657<xsl:param name="htmlhelp.button.refresh" select="0"/> 6658 6659<doc:refentry><refmeta> 6660<refentrytitle>htmlhelp.button.home</refentrytitle> 6661<refmiscinfo role="type">boolean</refmiscinfo> 6662</refmeta><refnamediv> 6663<refname>htmlhelp.button.home</refname> 6664<refpurpose>Should be Home button shown?</refpurpose> 6665</refnamediv><refsynopsisdiv> 6666 6667</refsynopsisdiv><refsect1><title>Description</title> 6668 6669<para>If you want Home button shown on toolbar, turn this 6670parameter to 1.</para> 6671 6672</refsect1> 6673</doc:refentry> 6674<xsl:param name="htmlhelp.button.home" select="0"/> 6675 6676<doc:refentry><refmeta> 6677<refentrytitle>htmlhelp.button.home.url</refentrytitle> 6678<refmiscinfo role="type">string</refmiscinfo> 6679</refmeta><refnamediv> 6680<refname>htmlhelp.button.home.url</refname> 6681<refpurpose>URL address of page accessible by Home button</refpurpose> 6682</refnamediv><refsynopsisdiv> 6683 6684</refsynopsisdiv><refsect1><title>Description</title> 6685 6686<para>URL address of page accessible by Home button.</para> 6687 6688</refsect1> 6689</doc:refentry> 6690<xsl:param name="htmlhelp.button.home.url"/> 6691 6692<doc:refentry><refmeta> 6693<refentrytitle>htmlhelp.button.options</refentrytitle> 6694<refmiscinfo role="type">boolean</refmiscinfo> 6695</refmeta><refnamediv> 6696<refname>htmlhelp.button.options</refname> 6697<refpurpose>Should be Options button shown?</refpurpose> 6698</refnamediv><refsynopsisdiv> 6699 6700</refsynopsisdiv><refsect1><title>Description</title> 6701 6702<para>If you want Options button shown on toolbar, turn this 6703parameter to 1.</para> 6704 6705</refsect1> 6706</doc:refentry> 6707<xsl:param name="htmlhelp.button.options" select="1"/> 6708 6709<doc:refentry><refmeta> 6710<refentrytitle>htmlhelp.button.print</refentrytitle> 6711<refmiscinfo role="type">boolean</refmiscinfo> 6712</refmeta><refnamediv> 6713<refname>htmlhelp.button.print</refname> 6714<refpurpose>Should be Print button shown?</refpurpose> 6715</refnamediv><refsynopsisdiv> 6716 6717</refsynopsisdiv><refsect1><title>Description</title> 6718 6719<para>If you want Print button shown on toolbar, turn this 6720parameter to 1.</para> 6721 6722</refsect1> 6723</doc:refentry> 6724<xsl:param name="htmlhelp.button.print" select="1"/> 6725 6726<doc:refentry><refmeta> 6727<refentrytitle>htmlhelp.button.locate</refentrytitle> 6728<refmiscinfo role="type">boolean</refmiscinfo> 6729</refmeta><refnamediv> 6730<refname>htmlhelp.button.locate</refname> 6731<refpurpose>Should be Locate button shown?</refpurpose> 6732</refnamediv><refsynopsisdiv> 6733 6734</refsynopsisdiv><refsect1><title>Description</title> 6735 6736<para>If you want Locate button shown on toolbar, turn this 6737parameter to 1.</para> 6738 6739</refsect1> 6740</doc:refentry> 6741<xsl:param name="htmlhelp.button.locate" select="0"/> 6742 6743<doc:refentry><refmeta> 6744<refentrytitle>htmlhelp.button.jump1</refentrytitle> 6745<refmiscinfo role="type">boolean</refmiscinfo> 6746</refmeta><refnamediv> 6747<refname>htmlhelp.button.jump1</refname> 6748<refpurpose>Should be Jump1 button shown?</refpurpose> 6749</refnamediv><refsynopsisdiv> 6750 6751</refsynopsisdiv><refsect1><title>Description</title> 6752 6753<para>If you want Jump1 button shown on toolbar, turn this 6754parameter to 1.</para> 6755 6756</refsect1> 6757</doc:refentry> 6758<xsl:param name="htmlhelp.button.jump1" select="0"/> 6759 6760<doc:refentry><refmeta> 6761<refentrytitle>htmlhelp.button.jump1.url</refentrytitle> 6762<refmiscinfo role="type">string</refmiscinfo> 6763</refmeta><refnamediv> 6764<refname>htmlhelp.button.jump1.url</refname> 6765<refpurpose>URL address of page accessible by Jump1 button</refpurpose> 6766</refnamediv><refsynopsisdiv> 6767 6768</refsynopsisdiv><refsect1><title>Description</title> 6769 6770<para>URL address of page accessible by Jump1 button.</para> 6771 6772</refsect1> 6773</doc:refentry> 6774<xsl:param name="htmlhelp.button.jump1.url"/> 6775 6776<doc:refentry><refmeta> 6777<refentrytitle>htmlhelp.button.jump1.title</refentrytitle> 6778<refmiscinfo role="type">string</refmiscinfo> 6779</refmeta><refnamediv> 6780<refname>htmlhelp.button.jump1.title</refname> 6781<refpurpose>Title of Jump1 button</refpurpose> 6782</refnamediv><refsynopsisdiv> 6783 6784</refsynopsisdiv><refsect1><title>Description</title> 6785 6786<para>Title of Jump1 button.</para> 6787 6788</refsect1> 6789</doc:refentry> 6790<xsl:param name="htmlhelp.button.jump1.title" select="'User1'"/> 6791 6792<doc:refentry><refmeta> 6793<refentrytitle>htmlhelp.button.jump2</refentrytitle> 6794<refmiscinfo role="type">boolean</refmiscinfo> 6795</refmeta><refnamediv> 6796<refname>htmlhelp.button.jump2</refname> 6797<refpurpose>Should be Jump2 button shown?</refpurpose> 6798</refnamediv><refsynopsisdiv> 6799 6800</refsynopsisdiv><refsect1><title>Description</title> 6801 6802<para>If you want Jump2 button shown on toolbar, turn this 6803parameter to 1.</para> 6804 6805</refsect1> 6806</doc:refentry> 6807<xsl:param name="htmlhelp.button.jump2" select="0"/> 6808 6809<doc:refentry><refmeta> 6810<refentrytitle>htmlhelp.button.jump2.url</refentrytitle> 6811<refmiscinfo role="type">string</refmiscinfo> 6812</refmeta><refnamediv> 6813<refname>htmlhelp.button.jump2.url</refname> 6814<refpurpose>URL address of page accessible by Jump2 button</refpurpose> 6815</refnamediv><refsynopsisdiv> 6816 6817</refsynopsisdiv><refsect1><title>Description</title> 6818 6819<para>URL address of page accessible by Jump2 button.</para> 6820 6821</refsect1> 6822</doc:refentry> 6823<xsl:param name="htmlhelp.button.jump2.url"/> 6824 6825<doc:refentry><refmeta> 6826<refentrytitle>htmlhelp.button.jump2.title</refentrytitle> 6827<refmiscinfo role="type">string</refmiscinfo> 6828</refmeta><refnamediv> 6829<refname>htmlhelp.button.jump2.title</refname> 6830<refpurpose>Title of Jump2 button</refpurpose> 6831</refnamediv><refsynopsisdiv> 6832 6833</refsynopsisdiv><refsect1><title>Description</title> 6834 6835<para>Title of Jump2 button.</para> 6836 6837</refsect1> 6838</doc:refentry> 6839<xsl:param name="htmlhelp.button.jump2.title" select="'User2'"/> 6840 6841<doc:refentry><refmeta> 6842<refentrytitle>htmlhelp.button.next</refentrytitle> 6843<refmiscinfo role="type">boolean</refmiscinfo> 6844</refmeta><refnamediv> 6845<refname>htmlhelp.button.next</refname> 6846<refpurpose>Should be Next button shown?</refpurpose> 6847</refnamediv><refsynopsisdiv> 6848 6849</refsynopsisdiv><refsect1><title>Description</title> 6850 6851<para>If you want Next button shown on toolbar, turn this 6852parameter to 1.</para> 6853 6854</refsect1> 6855</doc:refentry> 6856<xsl:param name="htmlhelp.button.next" select="1"/> 6857 6858<doc:refentry><refmeta> 6859<refentrytitle>htmlhelp.button.prev</refentrytitle> 6860<refmiscinfo role="type">boolean</refmiscinfo> 6861</refmeta><refnamediv> 6862<refname>htmlhelp.button.prev</refname> 6863<refpurpose>Should be Prev button shown?</refpurpose> 6864</refnamediv><refsynopsisdiv> 6865 6866</refsynopsisdiv><refsect1><title>Description</title> 6867 6868<para>If you want Prev button shown on toolbar, turn this 6869parameter to 1.</para> 6870 6871</refsect1> 6872</doc:refentry> 6873<xsl:param name="htmlhelp.button.prev" select="1"/> 6874 6875<doc:refentry><refmeta> 6876<refentrytitle>htmlhelp.button.zoom</refentrytitle> 6877<refmiscinfo role="type">boolean</refmiscinfo> 6878</refmeta><refnamediv> 6879<refname>htmlhelp.button.zoom</refname> 6880<refpurpose>Should be Zoom button shown?</refpurpose> 6881</refnamediv><refsynopsisdiv> 6882 6883</refsynopsisdiv><refsect1><title>Description</title> 6884 6885<para>If you want Zoom button shown on toolbar, turn this 6886parameter to 1.</para> 6887 6888</refsect1> 6889</doc:refentry> 6890<xsl:param name="htmlhelp.button.zoom" select="0"/> 6891 6892<doc:refentry><refmeta> 6893<refentrytitle>htmlhelp.remember.window.position</refentrytitle> 6894<refmiscinfo role="type">boolean</refmiscinfo> 6895</refmeta><refnamediv> 6896<refname>htmlhelp.remember.window.position</refname> 6897<refpurpose>Remember help window position?</refpurpose> 6898</refnamediv><refsynopsisdiv> 6899 6900</refsynopsisdiv><refsect1><title>Description</title> 6901 6902<para>To remember help window position between starts set this 6903parameter to 1.</para> 6904 6905</refsect1> 6906</doc:refentry> 6907<xsl:param name="htmlhelp.remember.window.position" select="0"/> 6908 6909<doc:refentry><refmeta> 6910<refentrytitle>htmlhelp.window.geometry</refentrytitle> 6911<refmiscinfo role="type">string</refmiscinfo> 6912</refmeta><refnamediv> 6913<refname>htmlhelp.window.geometry</refname> 6914<refpurpose>Set initial geometry of help window</refpurpose> 6915</refnamediv><refsynopsisdiv> 6916 6917</refsynopsisdiv><refsect1><title>Description</title> 6918 6919<para>This parameter specifies initial position of help 6920window. E.g.</para> 6921 6922<programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting> 6923 6924</refsect1> 6925</doc:refentry> 6926<xsl:param name="htmlhelp.window.geometry"/> 6927 6928<doc:refentry><refmeta> 6929<refentrytitle>htmlhelp.use.hhk</refentrytitle> 6930<refmiscinfo role="type">boolean</refmiscinfo> 6931</refmeta><refnamediv> 6932<refname>htmlhelp.use.hhk</refname> 6933<refpurpose>Should be index built using HHK file?</refpurpose> 6934</refnamediv><refsynopsisdiv> 6935 6936</refsynopsisdiv><refsect1><title>Description</title> 6937 6938<para>If non-zero, index is created using HHK file. This provides some 6939new features.</para> 6940 6941</refsect1> 6942</doc:refentry> 6943<xsl:param name="htmlhelp.use.hhk" select="0"/> 6944 6945<doc:refentry><refmeta> 6946<refentrytitle>htmlhelp.only</refentrytitle> 6947<refmiscinfo role="type">boolean</refmiscinfo> 6948</refmeta><refnamediv> 6949<refname>htmlhelp.only</refname> 6950<refpurpose>Should be only project files generated?</refpurpose> 6951</refnamediv><refsynopsisdiv> 6952 6953</refsynopsisdiv><refsect1><title>Description</title> 6954 6955<para>If you want to play with various HTML Help parameters and you 6956don't need to regenerate all HTML files, you can set this parameter to 69571. This setting will not process whole document, only project files 6958(hhp, hhc, hhk,...) will be generated.</para> 6959 6960</refsect1> 6961</doc:refentry> 6962<xsl:param name="htmlhelp.only" select="0"/> 6963 6964<doc:refentry><refmeta> 6965<refentrytitle>eclipse.autolabel</refentrytitle> 6966<refmiscinfo role="type">boolean</refmiscinfo> 6967</refmeta><refnamediv> 6968<refname>eclipse.autolabel</refname> 6969<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> 6970</refnamediv><refsynopsisdiv> 6971 6972</refsynopsisdiv><refsect1><title>Description</title> 6973 6974<para>If you want to include chapter and section numbers into ToC in 6975the left panel, set this parameter to 1.</para> 6976 6977</refsect1> 6978</doc:refentry> 6979<xsl:param name="eclipse.autolabel" select="0"/> 6980 6981<doc:refentry><refmeta> 6982<refentrytitle>eclipse.plugin.name</refentrytitle> 6983<refmiscinfo role="type">string</refmiscinfo> 6984</refmeta><refnamediv> 6985<refname>eclipse.plugin.name</refname> 6986<refpurpose>Eclipse Help plugin name</refpurpose> 6987</refnamediv><refsynopsisdiv> 6988 6989</refsynopsisdiv><refsect1><title>Description</title> 6990 6991<para>Eclipse Help plugin name.</para> 6992 6993</refsect1> 6994</doc:refentry> 6995<xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param> 6996 6997<doc:refentry><refmeta> 6998<refentrytitle>eclipse.plugin.id</refentrytitle> 6999<refmiscinfo role="type">string</refmiscinfo> 7000</refmeta><refnamediv> 7001<refname>eclipse.plugin.id</refname> 7002<refpurpose>Eclipse Help plugin id</refpurpose> 7003</refnamediv><refsynopsisdiv> 7004 7005</refsynopsisdiv><refsect1><title>Description</title> 7006 7007<para>Eclipse Help plugin id. You should change this id to something 7008unique for each help.</para> 7009 7010</refsect1> 7011</doc:refentry> 7012<xsl:param name="eclipse.plugin.id">com.example.help</xsl:param> 7013 7014<doc:refentry><refmeta> 7015<refentrytitle>eclipse.plugin.provider</refentrytitle> 7016<refmiscinfo role="type">string</refmiscinfo> 7017</refmeta><refnamediv> 7018<refname>eclipse.plugin.provider</refname> 7019<refpurpose>Eclipse Help plugin provider name</refpurpose> 7020</refnamediv><refsynopsisdiv> 7021 7022</refsynopsisdiv><refsect1><title>Description</title> 7023 7024<para>Eclipse Help plugin provider name.</para> 7025 7026</refsect1> 7027</doc:refentry> 7028<xsl:param name="eclipse.plugin.provider">Example provider</xsl:param> 7029 7030<doc:refentry><refmeta> 7031<refentrytitle>l10n.gentext.language</refentrytitle> 7032<refmiscinfo role="type">string</refmiscinfo> 7033</refmeta><refnamediv> 7034<refname>l10n.gentext.language</refname> 7035<refpurpose>Sets the gentext language</refpurpose> 7036</refnamediv><refsynopsisdiv> 7037 7038</refsynopsisdiv><refsect1><title>Description</title> 7039 7040<para>If this parameter is set to any value other than the empty string, its 7041value will be used as the value for the language when generating text. Setting 7042<parameter>l10n.gentext.language</parameter> overrides any settings within the 7043document being formatted.</para> 7044 7045<para>It's much more likely that you might want to set the 7046<parameter>l10n.gentext.default.language</parameter> parameter.</para> 7047 7048</refsect1> 7049</doc:refentry> 7050<xsl:param name="l10n.gentext.language" select="''"/> 7051 7052<doc:refentry><refmeta> 7053<refentrytitle>l10n.gentext.default.language</refentrytitle> 7054<refmiscinfo role="type">string</refmiscinfo> 7055</refmeta><refnamediv> 7056<refname>l10n.gentext.default.language</refname> 7057<refpurpose>Sets the default language for generated text</refpurpose> 7058</refnamediv><refsynopsisdiv> 7059 7060</refsynopsisdiv><refsect1><title>Description</title> 7061 7062<para>The value of the <parameter>l10n.gentext.default.language</parameter> 7063parameter is used as the language for generated text if no setting is provided 7064in the source document.</para> 7065 7066</refsect1> 7067</doc:refentry> 7068<xsl:param name="l10n.gentext.default.language" select="'en'"/> 7069 7070<doc:refentry><refmeta> 7071<refentrytitle>l10n.gentext.use.xref.language</refentrytitle> 7072<refmiscinfo role="type">boolean</refmiscinfo> 7073</refmeta><refnamediv> 7074<refname>l10n.gentext.use.xref.language</refname> 7075<refpurpose>Use the language of target when generating cross-reference text?</refpurpose> 7076</refnamediv><refsynopsisdiv> 7077 7078</refsynopsisdiv><refsect1><title>Description</title> 7079 7080<para>If non-zero, the language of the target will be used when 7081generating cross reference text. Usually, the <quote>current</quote> 7082language is used when generating text (that is, the language of the 7083element that contains the cross-reference element). But setting this parameter 7084allows the language of the element <emphasis>pointed to</emphasis> to control 7085the generated text.</para> 7086 7087<para>Consider the following example:</para> 7088 7089<informalexample> 7090<programlisting><para lang="en">See also <xref linkend="chap3"/>.</para> 7091</programlisting> 7092</informalexample> 7093 7094<para>Suppose that Chapter 3 happens to be written in German. 7095If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the 7096resulting text will be something like this:</para> 7097 7098<blockquote> 7099<para>See also Kapital 3.</para> 7100</blockquote> 7101 7102<para>Where the more traditional rendering would be:</para> 7103 7104<blockquote> 7105<para>See also Chapter 3.</para> 7106</blockquote> 7107 7108</refsect1> 7109</doc:refentry> 7110<xsl:param name="l10n.gentext.use.xref.language" select="0"/> 7111 7112<doc:refentry><refmeta> 7113<refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle> 7114<refmiscinfo role="type">boolean</refmiscinfo> 7115</refmeta><refnamediv> 7116<refname>l10n.lang.value.rfc.compliant</refname> 7117<refpurpose>Make value of lang attribute RFC compliant?</refpurpose> 7118</refnamediv><refsynopsisdiv> 7119 7120</refsynopsisdiv><refsect1><title>Description</title> 7121 7122<para>If non-zero, ensure that the values for all <sgmltag class="attribute">lang</sgmltag> attributes in HTML output are RFC 7123compliant<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: 7124 7125<blockquote><para>[RFC1766] defines and explains the language codes 7126that must be used in HTML documents.</para> 7127<para>Briefly, language codes consist of a primary code and a possibly 7128empty series of subcodes: 7129 7130<literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout> 7131</para> 7132<para>And in RFC 1766, <ulink url="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification 7133of Languages</ulink>, the EBNF for "language tag" is given as: 7134 7135<literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag ) 7136Primary-tag = 1*8ALPHA 7137Subtag = 1*8ALPHA</literallayout> 7138</para> 7139</blockquote> 7140</para></footnote>. 7141 7142by taking any underscore characters in any <sgmltag class="attribute">lang</sgmltag> values found in source documents, and 7143replacing them with hyphen characters in output HTML files. For 7144example, <literal>zh_CN</literal> in a source document becomes 7145<literal>zh-CN</literal> in the HTML output form that source. 7146 7147<note> 7148<para>This parameter does not cause any case change in <sgmltag class="attribute">lang</sgmltag> values, because RFC 1766 7149explicitly states that all "language tags" (as it calls them) "are 7150to be treated as case insensitive".</para> 7151</note> 7152</para> 7153 7154</refsect1> 7155</doc:refentry> 7156<xsl:param name="l10n.lang.value.rfc.compliant" select="1"/> 7157</xsl:stylesheet>
