1<?xml version='1.0'?> 2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 3 xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" 4 exclude-result-prefixes="doc" 5 version='1.0'> 6 7<!-- ******************************************************************** 8 $Id$ 9 ******************************************************************** 10 11 This file is part of the XSL DocBook Stylesheet distribution. 12 See /README or http://nwalsh.com/docbook/xsl/ for copyright 13 and other information. 14 15 ******************************************************************** --> 16 17<doc:reference xmlns=""> 18<referenceinfo> 19<releaseinfo role="meta"> 20$Id$ 21</releaseinfo> 22<author><surname>Walsh</surname> 23<firstname>Norman</firstname></author> 24<copyright><year>1999</year><year>2000</year> 25<holder>Norman Walsh</holder> 26</copyright> 27</referenceinfo> 28<title>HTML Parameter Reference</title> 29 30<partintro> 31<section><title>Introduction</title> 32 33<para>This is technical reference documentation for the DocBook XSL 34Stylesheets; it documents (some of) the parameters, templates, and 35other elements of the stylesheets.</para> 36 37<para>This reference describes each of the HTML Stylesheet parameters. 38These are the <quote>easily customizable</quote> parts of the stylesheet. 39If you want to specify an alternate value for one or more of these 40parameters, you can do so in a <quote>driver</quote> stylesheet.</para> 41 42<para>For example, if you want to change the <literal>html.stylesheet</literal> 43to <filename>reference.css</filename>, you might create a driver 44stylesheet like this:</para> 45 46<programlisting><![CDATA[<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 47 version='1.0'> 48 49 <xsl:import href="/path/to/html/docbook.xsl"/> 50 51 <xsl:param name="html.stylesheet">reference.css</xsl:param> 52 53</xsl:stylesheet>]]></programlisting> 54 55<para>Naturally, you have to change the 56<sgmltag class='attribute'>href</sgmltag> attribute on 57<literal><xsl:import></literal> 58to point to <filename>docbook.xsl</filename> 59on your system. (Or <filename>chunk.xsl</filename>, if you're using 60chunking.)</para> 61 62<para>This is not intended to be <quote>user</quote> documentation. 63It is provided for developers writing customization layers for the 64stylesheets, and for anyone who's interested in <quote>how it 65works</quote>.</para> 66 67<para>Although I am trying to be thorough, this documentation is known 68to be incomplete. Don't forget to read the source, too :-)</para> 69</section> 70</partintro> 71</doc:reference> 72 73<!-- ==================================================================== --> 74<xsl:param name="author.othername.in.middle" select="1" doc:type='boolean'/> 75 76<doc:param name="author.othername.in.middle" xmlns=""> 77<refpurpose>Is <sgmltag>othername</sgmltag> in <sgmltag>author</sgmltag> a 78middle name?</refpurpose> 79<refdescription> 80<para>If true (non-zero), the <sgmltag>othername</sgmltag> of an <sgmltag>author</sgmltag> 81appears between the <sgmltag>firstname</sgmltag> and 82<sgmltag>surname</sgmltag>. Otherwise, <sgmltag>othername</sgmltag> 83is suppressed. 84</para> 85</refdescription> 86</doc:param> 87 88<!-- ==================================================================== --> 89<xsl:param name="html.stylesheet" select="''" doc:type='string'/> 90 91<doc:param name="html.stylesheet" xmlns=""> 92<refpurpose>Name of the stylesheet to use in the generated HTML</refpurpose> 93<refdescription> 94<para>The name of the stylesheet to place in the HTML <sgmltag>LINK</sgmltag> 95tag, or the empty string to suppress the stylesheet <sgmltag>LINK</sgmltag>. 96</para> 97</refdescription> 98</doc:param> 99 100<!-- ==================================================================== --> 101<xsl:param name="html.stylesheet.type" doc:type='string'>text/css</xsl:param> 102 103<doc:param name="html.stylesheet.type" xmlns=""> 104<refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> 105<refdescription> 106<para>The type of the stylesheet to place in the HTML <sgmltag>link</sgmltag> tag. 107</para> 108</refdescription> 109</doc:param> 110 111<!-- ==================================================================== --> 112<xsl:param name="html.base" doc:type='uri'></xsl:param> 113 114<doc:param name="html.base" xmlns=""> 115<refpurpose>An HTML base URI</refpurpose> 116<refdescription> 117<para>If html.base is set, it is used for the <sgmltag>BASE</sgmltag> 118element in the <sgmltag>HEAD</sgmltag> of the HTML documents. 119This is useful for dynamically served HTML where the base URI needs 120to be shifted.</para> 121</refdescription> 122</doc:param> 123 124<!-- ==================================================================== --> 125<xsl:param name="ulink.target" select="'_top'" doc:type='string'/> 126 127<doc:param name="ulink.target" xmlns=""> 128<refpurpose>The HTML anchor target for ULinks</refpurpose> 129<refdescription> 130<para>If <parameter>ulink.target</parameter> is set, its value will 131be used for the <sgmltag class='attribute'>target</sgmltag> attribute 132on anchors generated for <sgmltag>ulink</sgmltag>s.</para> 133</refdescription> 134</doc:param> 135 136<!-- ==================================================================== --> 137<xsl:param name="refentry.xref.manvolnum" select="1" doc:type='boolean'/> 138 139<doc:param name="refentry.xref.manvolnum" xmlns=""> 140<refpurpose>Output <sgmltag>manvolnum</sgmltag> as part of 141<sgmltag>refentry</sgmltag> cross-reference?</refpurpose> 142<refdescription> 143<para>if true (non-zero), the <sgmltag>manvolnum</sgmltag> is used when cross-referencing 144<sgmltag>refentry</sgmltag>s, either with <sgmltag>xref</sgmltag> 145or <sgmltag>citerefentry</sgmltag>. 146</para> 147</refdescription> 148</doc:param> 149 150<!-- ==================================================================== --> 151<xsl:param name="show.comments" doc:type='boolean'>1</xsl:param> 152 153<doc:param name="show.comments" xmlns=""> 154<refpurpose>Display <sgmltag>comment</sgmltag> elements?</refpurpose> 155<refdescription> 156<para>If true (non-zero), comments will be displayed, otherwise they are suppressed. 157Comments here refers to the <sgmltag>comment</sgmltag> element, 158which will be renamed <sgmltag>remark</sgmltag> in DocBook V4.0, 159not XML comments (<-- like this -->) which are unavailable. 160</para> 161</refdescription> 162</doc:param> 163 164<!-- ==================================================================== --> 165<xsl:param name="funcsynopsis.style" 166 doc:type='list' 167 doc:list='ansi kr'>kr</xsl:param> 168 169<doc:param name="funcsynopsis.style" xmlns=""> 170<refpurpose>What style of 'FuncSynopsis' should be generated?</refpurpose> 171<refdescription> 172<para>If <varname>funcsynopsis.style</varname> is <literal>ansi</literal>, 173ANSI-style function synopses are generated for a 174<sgmltag>funcsynopsis</sgmltag>, otherwise K&R-style 175function synopses are generated. 176</para> 177</refdescription> 178</doc:param> 179 180<!-- ==================================================================== --> 181<xsl:param name="funcsynopsis.decoration" select="1" doc:type='boolean'/> 182 183<doc:param name="funcsynopsis.decoration" xmlns=""> 184<refpurpose>Decorate elements of a FuncSynopsis?</refpurpose> 185<refdescription> 186<para>If true (non-zero), elements of the FuncSynopsis will be decorated (e.g. bold or 187italic). The decoration is controlled by functions that can be redefined 188in a customization layer. 189</para> 190</refdescription> 191</doc:param> 192 193<!-- ==================================================================== --> 194<xsl:param name="function.parens" doc:type='boolean'>0</xsl:param> 195 196<doc:param name="function.parens" xmlns=""> 197<refpurpose>Generate parens after a function?</refpurpose> 198<refdescription> 199<para>If not 0, the formatting of 200a <sgmltag class="starttag">function</sgmltag> element will include 201generated parenthesis. 202</para> 203</refdescription> 204</doc:param> 205 206<!-- ==================================================================== --> 207<xsl:param name="refentry.generate.name" select="1" doc:type='boolean'/> 208 209<doc:param name="refentry.generate.name" xmlns=""> 210<refpurpose>Output NAME header before 'RefName'(s)?</refpurpose> 211<refdescription> 212<para>If true (non-zero), a "NAME" section title is output before the list 213of 'RefName's. 214</para> 215</refdescription> 216</doc:param> 217 218<!-- ==================================================================== --> 219<xsl:param name="admon.graphics" select="0" doc:type='boolean'/> 220 221<doc:param name="admon.graphics" xmlns=""> 222<refpurpose>Use graphics in admonitions?</refpurpose> 223<refdescription> 224<para>If true (non-zero), admonitions are presented in an alternate style that uses 225a graphic. Default graphics are provided in the distribution. 226</para> 227</refdescription> 228</doc:param> 229 230<!-- ==================================================================== --> 231<xsl:param name="admon.graphics.path" doc:type='string'>/images/</xsl:param> 232 233<doc:param name="admon.graphics.path" xmlns=""> 234<refpurpose>Path to admonition graphics</refpurpose> 235<refdescription> 236<para>Sets the path, probably relative to the directory where the HTML 237files are created, to the admonition graphics. 238</para> 239</refdescription> 240</doc:param> 241 242<!-- ==================================================================== --> 243<xsl:param name="admon.graphics.extension" select="'.png'" doc:type='string'/> 244 245<doc:param name="admon.graphics.extension" xmlns=""> 246<refpurpose>Extension for admonition graphics</refpurpose> 247<refdescription> 248<para>Sets the extension to use on admonition graphics.</para> 249</refdescription> 250</doc:param> 251 252<!-- ==================================================================== --> 253<xsl:param name="admon.style" doc:type='string'> 254 <xsl:text>margin-left: 0.5in; margin-right: 0.5in;</xsl:text> 255</xsl:param> 256 257<doc:param name="admon.style" xmlns=""> 258<refpurpose>CSS style attributes for admonitions</refpurpose> 259<refdescription> 260<para>Specifies the value of the <sgmltag class="attribute">STYLE</sgmltag> 261attribute that should be added to admonitions. 262</para> 263</refdescription> 264</doc:param> 265 266<!-- ==================================================================== --> 267<xsl:param name="section.autolabel" select="0" doc:type='boolean'/> 268 269<doc:param name="section.autolabel" xmlns=""> 270<refpurpose>Are sections enumerated?</refpurpose> 271<refdescription> 272<para>If true (non-zero), unlabeled sections will be enumerated. 273</para> 274</refdescription> 275</doc:param> 276 277<!-- ==================================================================== --> 278<xsl:param name="section.label.includes.component.label" select="0" 279 doc:type='boolean'/> 280 281<doc:param name="section.label.includes.component.label" xmlns=""> 282<refpurpose>Do section labels include the component label?</refpurpose> 283<refdescription> 284<para>If true (non-zero), section labels are prefixed with the label of the 285component that contains them. 286</para> 287</refdescription> 288</doc:param> 289 290<!-- ==================================================================== --> 291<xsl:param name="chapter.autolabel" select="1" doc:type='boolean'/> 292<xsl:param name="appendix.autolabel" select="1" doc:type='boolean'/> 293 294<doc:param name="chapter.autolabel" xmlns=""> 295<refpurpose>Are chapters and appendixes enumerated?</refpurpose> 296<refdescription> 297<para>If true (non-zero), unlabeled chapters and appendixes will be enumerated. 298</para> 299</refdescription> 300</doc:param> 301 302<!-- ==================================================================== --> 303<xsl:param name="preface.autolabel" select="0" doc:type='boolean'/> 304 305<doc:param name="preface.autolabel" xmlns=""> 306<refpurpose>Are prefaces enumerated?</refpurpose> 307<refdescription> 308<para>If true (non-zero), unlabeled prefaces will be enumerated. 309</para> 310</refdescription> 311</doc:param> 312 313<!-- ==================================================================== --> 314<xsl:param name="part.autolabel" select="1" doc:type='boolean'/> 315 316<doc:param name="part.autolabel" xmlns=""> 317<refpurpose>Are parts and references enumerated?</refpurpose> 318<refdescription> 319<para>If true (non-zero), unlabeled parts and references will be enumerated. 320</para> 321</refdescription> 322</doc:param> 323 324<!-- ==================================================================== --> 325<xsl:param name="qandadiv.autolabel" select="1" doc:type='boolean'/> 326 327<doc:param name="qandadiv.autolabel" xmlns=""> 328<refpurpose>Are divisions in QAndASets enumerated?</refpurpose> 329<refdescription> 330<para>If true (non-zero), unlabeled qandadivs will be enumerated. 331</para> 332</refdescription> 333</doc:param> 334 335<!-- ==================================================================== --> 336<xsl:param name="qanda.inherit.numeration" select="1" doc:type='boolean'/> 337 338<doc:param name="qanda.inherit.numeration" xmlns=""> 339<refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose> 340<refdescription> 341<para>If true (non-zero), numbered QandADiv elements and Questions and Answers inherit 342the numeration of the ancestors of the QandASet. 343</para> 344</refdescription> 345</doc:param> 346 347<!-- ==================================================================== --> 348<xsl:param name="qanda.defaultlabel" 349 doc:type='boolean' 350 doc:list='qanda number none'>number</xsl:param> 351 352<doc:param name="qanda.defaultlabel" xmlns=""> 353<refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> 354<refdescription> 355<para>If no defaultlabel attribute is specified on a QandASet, this 356value is used. It must be one of the legal values for the defaultlabel 357attribute. 358</para> 359</refdescription> 360</doc:param> 361 362<!-- ==================================================================== --> 363<xsl:param name="generate.qandaset.toc" doc:type='boolean'>1</xsl:param> 364 365<doc:param name="generate.qandaset.toc" xmlns=""> 366<refpurpose>Is a Table of Contents created for QandASets?</refpurpose> 367<refdescription> 368<para>If true (non-zero), a ToC is constructed for QandASets. 369</para> 370</refdescription> 371</doc:param> 372 373<!-- ==================================================================== --> 374<xsl:param name="generate.qandadiv.toc" doc:type='boolean'>0</xsl:param> 375 376<doc:param name="generate.qandadiv.toc" xmlns=""> 377<refpurpose>Is a Table of Contents created for QandADivs?</refpurpose> 378<refdescription> 379<para>If true (non-zero), a ToC is constructed for QandADivs. 380</para> 381</refdescription> 382</doc:param> 383 384<!-- ==================================================================== --> 385<xsl:param name="biblioentry.item.separator" doc:type='string'>. </xsl:param> 386 387<doc:param name="biblioentry.item.separator" xmlns=""> 388<refpurpose>Text to separate bibliography entries</refpurpose> 389<refdescription> 390<para>Text to separate bibliography entries 391</para> 392</refdescription> 393</doc:param> 394 395<!-- ==================================================================== --> 396<xsl:param name="toc.section.depth" 397 doc:type='integer' 398 doc:min='1' 399 doc:max='10'>2</xsl:param> 400 401<doc:param name="toc.section.depth" xmlns=""> 402<refpurpose>How deep should recursive <sgmltag>section</sgmltag>s appear 403in the TOC?</refpurpose> 404<refdescription> 405<para>Specifies the depth to which recursive sections should appear in the 406TOC. 407</para> 408</refdescription> 409</doc:param> 410 411<!-- ==================================================================== --> 412<xsl:param name="using.chunker" select="0" doc:type='boolean'/> 413 414<doc:param name="using.chunker" xmlns=""> 415<refpurpose>Will the output be chunked?</refpurpose> 416<refdescription> 417<para>In addition to providing chunking, the chunker can cleanup a 418number of XML to HTML issues. If the chunker is not being used, the 419stylesheets try to avoid producing results that will not appear properly 420in browsers. 421</para> 422</refdescription> 423</doc:param> 424 425<!-- ==================================================================== --> 426<xsl:param name="generate.component.toc" select="1" doc:type='boolean'/> 427 428<doc:param name="generate.component.toc" xmlns=""> 429<refpurpose>Should TOCs be genereated in components (Chapters, Appendixes, etc.)?</refpurpose> 430<refdescription> 431<para>If true (non-zero), they are. 432</para> 433</refdescription> 434</doc:param> 435<!-- ==================================================================== --> 436<xsl:param name="generate.division.toc" select="1" doc:type='boolean'/> 437 438<doc:param name="generate.division.toc" xmlns=""> 439<refpurpose>Should TOCs be genereated in divisions (Books, Parts, etc.)?</refpurpose> 440<refdescription> 441<para>If true (non-zero), they are. 442</para> 443</refdescription> 444</doc:param> 445 446<!-- ==================================================================== --> 447<xsl:param name="link.mailto.url" doc:type='string'></xsl:param> 448 449<doc:param name="link.mailto.url" xmlns=""> 450<refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> 451<refdescription> 452<para>If not the empty string, this address will be used for the 453REL=made <sgmltag>LINK</sgmltag> element in the HTML <sgmltag>HEAD</sgmltag>. 454</para> 455</refdescription> 456</doc:param> 457 458<!-- ==================================================================== --> 459<xsl:param name="graphic.default.extension" doc:type='string'></xsl:param> 460 461<doc:param name="graphic.default.extension" xmlns=""> 462<refpurpose>Default extension for graphic filenames</refpurpose> 463<refdescription> 464<para>If a <sgmltag>graphic</sgmltag> or <sgmltag>mediaobject</sgmltag> 465includes a reference to a filename that does not include an extension, 466and the <sgmltag class="attribute">format</sgmltag> attribute is 467<emphasis>unspecified</emphasis>, the default extension will be used. 468</para> 469</refdescription> 470</doc:param> 471 472<!-- ==================================================================== --> 473<xsl:param name="toc.list.type" 474 doc:type='list' 475 doc:list='dl ul ol'>dl</xsl:param> 476 477<doc:param name="toc.list.type" xmlns=""> 478<refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> 479<refdescription> 480<para>When an automatically generated Table of Contents (or List of Titles) 481is produced, this HTML element will be used to make the list. 482</para> 483</refdescription> 484</doc:param> 485 486<!-- ==================================================================== --> 487<xsl:param name="check.idref" doc:type='boolean'>1</xsl:param> 488 489<doc:param name="check.idref" xmlns=""> 490<refpurpose>Test the target of IDREF attributes?</refpurpose> 491<refdescription> 492<para>If 1, the target of IDREF attributes are tested for presence 493(and uniqueness). This can be very expensive in large documents. 494</para> 495</refdescription> 496</doc:param> 497 498<!-- ==================================================================== --> 499<xsl:param name="use.id.function" doc:type='boolean' select="'1'"/> 500 501<doc:param name="use.id.function" xmlns=""> 502<refpurpose>Use the XPath id() function to find link targets?</refpurpose> 503<refdescription> 504<para>If 1, the stylesheets use the <function>id()</function> function 505to find the targets of cross reference elements. This is more 506efficient, but only works if your XSLT processor implements the 507<function>id()</function> function, naturally.</para> 508<para>THIS PARAMETER IS NOT SUPPORTED. IT IS ALWAYS ASSUMED TO BE 1. 509SEE xref.xsl IF YOU NEED TO TURN IT OFF.</para> 510</refdescription> 511</doc:param> 512 513<!-- ==================================================================== --> 514<xsl:param name="spacing.paras" doc:type='boolean' select="'0'"/> 515 516<doc:param name="spacing.paras" xmlns=""> 517<refpurpose>Insert additional <p> elements for spacing?</refpurpose> 518<refdescription> 519<para>When non-zero, additional, empty paragraphs are inserted in 520several contexts (for example, around informal figures), to create a 521more pleasing visual appearance in many browsers. 522</para> 523</refdescription> 524</doc:param> 525 526<!-- ==================================================================== --> 527<xsl:attribute-set name="body.attrs"> 528 <xsl:attribute name="bgcolor">white</xsl:attribute> 529 <xsl:attribute name="text">black</xsl:attribute> 530 <xsl:attribute name="link">#0000FF</xsl:attribute> 531 <xsl:attribute name="vlink">#840084</xsl:attribute> 532 <xsl:attribute name="alink">#0000FF</xsl:attribute> 533</xsl:attribute-set> 534 535<doc:attribute-set name="body.attrs" xmlns=""> 536<refpurpose>Additional attributes for the HTML body tag</refpurpose> 537<refdescription> 538<para>The attributes defined by this attribute set are added to the 539HTML <body> tag. 540</para> 541</refdescription> 542</doc:attribute-set> 543 544<!-- ==================================================================== --> 545<xsl:param name="css.decoration" doc:type='boolean'>1</xsl:param> 546 547<doc:param name="css.decoration" xmlns=""> 548<refpurpose>Enable CSS decoration of elements</refpurpose> 549<refdescription> 550<para> 551If <literal>css.decoration</literal> is turned on, then HTML elements 552produced by the 553stylesheet may be decorated with STYLE attributes. For example, the 554LI tags produced for list items may include a fragment of CSS in the 555STYLE attribute which sets the CSS property "list-style-type". 556</para> 557</refdescription> 558</doc:param> 559 560<!-- ==================================================================== --> 561<xsl:param name="show.revisionflag" doc:type='boolean'>0</xsl:param> 562 563<doc:param name="show.revisionflag" xmlns=""> 564<refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> 565<refdescription> 566<para> 567If <literal>show.revisionflag</literal> is turned on, then the stylesheets 568may produce additional markup designed to allow a CSS stylesheet to 569highlight elements that have specific revisionflag settings.</para> 570 571<para>The markup inserted will be usually be either a <span> or <div> 572with an appropriate <literal>class</literal> attribute. (The value of 573the class attribute will be the same as the value of the revisionflag 574attribute). In some contexts, for example tables, where extra markup 575would be structurally illegal, the class attribute will be added to the 576appropriate container element.</para> 577 578<para>In general, the stylesheets only test for revisionflag in contexts 579where an importing stylesheet would have to redefine whole templates. 580Most of the revisionflag processing is expected to be done by another 581stylesheet, for example <filename>changebars.xsl</filename>.</para> 582</refdescription> 583</doc:param> 584 585<!-- ==================================================================== --> 586<xsl:param name="suppress.navigation" doc:type='boolean'>0</xsl:param> 587 588<doc:param name="suppress.navigation" xmlns=""> 589<refpurpose>Disable header and footer navigation</refpurpose> 590<refdescription> 591<para> 592If <literal>suppress.navigation</literal> is turned on, header and 593footer navigation will be suppressed.</para> 594</refdescription> 595</doc:param> 596 597<!-- ==================================================================== --> 598<xsl:param name="rootid" select="''" doc:type='string'/> 599 600<doc:param name="rootid" xmlns=""> 601<refpurpose>Specify the root element to format</refpurpose> 602<refdescription> 603<para>If <parameter>rootid</parameter> is specified, it must be the 604value of an ID that occurs in the document being formatted. The entire 605document will be loaded and parsed, but formatting will begin at the 606element identified, rather than at the root. For example, this allows 607you to process only chapter 4 of a book.</para> 608<para>Because the entire document is available to the processor, automatic 609numbering, cross references, and other dependencies are correctly 610resolved.</para> 611</refdescription> 612</doc:param> 613 614<!-- ==================================================================== --> 615<xsl:param name="callout.list.table" select="'1'" doc:type='boolean'/> 616 617<doc:param name="callout.list.table" xmlns=""> 618<refpurpose>Present callout lists using a table?</refpurpose> 619<refdescription> 620<para>The default presentation of <sgmltag>CalloutList</sgmltag>s uses 621an HTML <sgmltag>DL</sgmltag>. Some browsers don't align DLs very well 622if <parameter>callout.graphics</parameter> are used. With this option 623turned on, <sgmltag>CalloutList</sgmltag>s are presented in an HTML 624<sgmltag>TABLE</sgmltag>, which usually results in better alignment 625of the callout number with the callout description.</para> 626</refdescription> 627</doc:param> 628 629<!-- ==================================================================== --> 630<xsl:param name="callout.graphics" select="'1'" doc:type='boolean'/> 631 632<doc:param name="callout.graphics" xmlns=""> 633<refpurpose>Use graphics for callouts?</refpurpose> 634<refdescription> 635<para>If non-zero, callouts are presented with graphics (e.g., reverse-video 636circled numbers instead of "(1)", "(2)", etc.). 637Default graphics are provided in the distribution. 638</para> 639</refdescription> 640</doc:param> 641 642<!-- ==================================================================== --> 643<xsl:param name="callout.graphics.extension" select="'.png'" doc:type='string'/> 644 645<doc:param name="callout.graphics.extension" xmlns=""> 646<refpurpose>Extension for callout graphics</refpurpose> 647<refdescription> 648<para>Sets the extension to use on callout graphics.</para> 649</refdescription> 650</doc:param> 651 652<!-- ==================================================================== --> 653<xsl:param name="callout.graphics.path" select="'/images/callouts/'" doc:type='string'/> 654 655<doc:param name="callout.graphics.path" xmlns=""> 656<refpurpose>Path to callout graphics</refpurpose> 657<refdescription> 658<para>Sets the path, probably relative to the directory where the HTML 659files are created, to the callout graphics. 660</para> 661</refdescription> 662</doc:param> 663 664<!-- ==================================================================== --> 665<xsl:param name="callout.graphics.number.limit" select="'10'" 666 doc:type='integer'/> 667 668<doc:param name="callout.graphics.number.limit" xmlns=""> 669<refpurpose>Number of the largest callout graphic</refpurpose> 670<refdescription> 671<para>If <parameter>callout.graphics</parameter> 672is non-zero, graphics are used to represent 673callout numbers. The value of 674<parameter>callout.graphics.number.limit</parameter> 675is 676the largest number for which a graphic exists. If the callout number 677exceeds this limit, the default presentation "(nnn)" will always 678be used. 679</para> 680</refdescription> 681</doc:param> 682 683<!-- ==================================================================== --> 684<xsl:param name="use.extensions" select="'0'" doc:type='boolean'/> 685 686<doc:param name="use.extensions" xmlns=""> 687<refpurpose>Enable extensions</refpurpose> 688<refdescription> 689<para>If non-zero, extensions may be used. Each extension is 690further controlled by its own parameter. But if 691<parameter>use.extensions</parameter> is zero, no extensions will 692be used. 693</para> 694</refdescription> 695</doc:param> 696 697<!-- ==================================================================== --> 698<xsl:param name="textinsert.extension" select="'1'" doc:type='boolean'/> 699 700<doc:param name="textinsert.extension" xmlns=""> 701<refpurpose>Enable the textinsert extension element</refpurpose> 702<refdescription> 703<para>The textinsert extension element inserts the contents of a 704a file into the result tree (as text). 705</para> 706</refdescription> 707</doc:param> 708 709<!-- ==================================================================== --> 710<xsl:param name="saxon.linenumbering" select="'1'" doc:type='boolean'/> 711 712<doc:param name="saxon.linenumbering" xmlns=""> 713<refpurpose>Enable the line numbering extension</refpurpose> 714<refdescription> 715<para>If true, verbatim environments (elements that have the 716format='linespecific' notation attribute: address, literallayout, 717programlisting, screen, synopsis) that specify line numbering will 718have, surprise, line numbers. 719</para> 720</refdescription> 721</doc:param> 722 723<!-- ==================================================================== --> 724<xsl:param name="linenumbering.extension" select="'1'" doc:type='boolean'/> 725 726<doc:param name="linenumbering.extension" xmlns=""> 727<refpurpose>Enable the line numbering extension</refpurpose> 728<refdescription> 729<para>If true, verbatim environments (elements that have the 730format='linespecific' notation attribute: address, literallayout, 731programlisting, screen, synopsis) that specify line numbering will 732have, surprise, line numbers. 733</para> 734</refdescription> 735</doc:param> 736 737<!-- ==================================================================== --> 738<xsl:param name="linenumbering.everyNth" select="'5'" doc:type='integer'/> 739 740<doc:param name="linenumbering.everyNth" xmlns=""> 741<refpurpose>Indicate which lines should be numbered</refpurpose> 742<refdescription> 743<para>If line numbering is enabled, everyNth line will be numbered. 744</para> 745</refdescription> 746</doc:param> 747 748<!-- ==================================================================== --> 749<xsl:param name="linenumbering.width" select="'3'" doc:type='integer'/> 750 751<doc:param name="linenumbering.width" xmlns=""> 752<refpurpose>Indicates the width of line numbers</refpurpose> 753<refdescription> 754<para>If line numbering is enabled, line numbers will appear right 755justified in a field "width" characters wide. 756</para> 757</refdescription> 758</doc:param> 759 760<!-- ==================================================================== --> 761<xsl:param name="linenumbering.separator" select="' '" doc:type='string'/> 762 763<doc:param name="linenumbering.separator" xmlns=""> 764<refpurpose>Specify a separator between line numbers and lines</refpurpose> 765<refdescription> 766<para>The separator is inserted between line numbers and lines in 767the verbatim environment. 768</para> 769</refdescription> 770</doc:param> 771 772<!-- ==================================================================== --> 773<xsl:param name="saxon.callouts" select="'1'" doc:type='boolean'/> 774 775<doc:param name="saxon.callouts" xmlns=""> 776<refpurpose>Enable the callout extension</refpurpose> 777<refdescription> 778<para>The callouts extension processes <sgmltag>areaset</sgmltag> 779elements in <sgmltag>ProgramListingCO</sgmltag> and other text-based 780callout elements. 781</para> 782</refdescription> 783</doc:param> 784 785<!-- ==================================================================== --> 786<xsl:param name="callouts.extension" select="'1'" doc:type='boolean'/> 787 788<doc:param name="callouts.extension" xmlns=""> 789<refpurpose>Enable the callout extension</refpurpose> 790<refdescription> 791<para>The callouts extension processes <sgmltag>areaset</sgmltag> 792elements in <sgmltag>ProgramListingCO</sgmltag> and other text-based 793callout elements. 794</para> 795</refdescription> 796</doc:param> 797 798<!-- ==================================================================== --> 799<xsl:param name="callout.defaultcolumn" select="'60'" doc:type='integer'/> 800 801<doc:param name="callout.defaultcolumn" xmlns=""> 802<refpurpose>Indicates what column callouts appear in by default</refpurpose> 803<refdescription> 804<para>If a callout does not identify a column (for example, if it uses 805the <literal>linerange</literal> <sgmltag class="attribute">unit</sgmltag>), 806it will appear in the default column. 807</para> 808</refdescription> 809</doc:param> 810 811<!-- ==================================================================== --> 812<xsl:param name="stylesheet.result.type" select="'html'" 813 doc:type='list' 814 doc:list='html fo'/> 815 816<doc:param name="stylesheet.result.type" xmlns=""> 817<refpurpose>Identifies the output format of this stylesheet</refpurpose> 818<refdescription> 819<para>The Saxon extension functions need to know if the output format 820is HTML ('html') or XSL Formatting Objects ('fo'). This variable answers 821that question. Valid settings are 'html' or 'fo'.</para> 822</refdescription> 823</doc:param> 824 825<!-- ==================================================================== --> 826<xsl:param name="nominal.table.width" select="'6in'" doc:type='length'/> 827 828<doc:param name="nominal.table.width" xmlns=""> 829<refpurpose>The (absolute) nominal width of tables</refpurpose> 830<refdescription> 831<para>In order to convert CALS column widths into HTML column widths, it 832is sometimes necessary to have an absolute table width to use for conversion 833of mixed absolute and relative widths. This value must be an absolute 834length (not a percentag).</para> 835</refdescription> 836</doc:param> 837 838<!-- ==================================================================== --> 839<xsl:param name="default.table.width" select="''" doc:type='length'/> 840 841<doc:param name="default.table.width" xmlns=""> 842<refpurpose>The default width of tables</refpurpose> 843<refdescription> 844<para>If specified, this value will be used for the WIDTH attribute on 845tables that do not specify an alternate width (with the dbhtml processing 846instruction).</para> 847</refdescription> 848</doc:param> 849 850<!-- ==================================================================== --> 851<xsl:param name="saxon.tablecolumns" select="'1'" doc:type='boolean'/> 852 853<doc:param name="saxon.tablecolumns" xmlns=""> 854<refpurpose>Enable the table columns extension function</refpurpose> 855<refdescription> 856<para>The table columns extension function adjusts the widths of table 857columns in the HTML result to more accurately reflect the specifications 858in the CALS table. 859</para> 860</refdescription> 861</doc:param> 862 863<!-- ==================================================================== --> 864<xsl:param name="tablecolumns.extension" select="'1'" doc:type='boolean'/> 865 866<doc:param name="tablecolumns.extension" xmlns=""> 867<refpurpose>Enable the table columns extension function</refpurpose> 868<refdescription> 869<para>The table columns extension function adjusts the widths of table 870columns in the HTML result to more accurately reflect the specifications 871in the CALS table. 872</para> 873</refdescription> 874</doc:param> 875 876<!-- ==================================================================== --> 877<xsl:param name="generate.set.toc" select='1' doc:type='boolean'/> 878 879<doc:param name="generate.set.toc" xmlns=""> 880<refpurpose>FIXME:</refpurpose> 881<refdescription> 882<para>FIXME: 883</para> 884</refdescription> 885</doc:param> 886 887<!-- ==================================================================== --> 888<xsl:param name="generate.book.toc" select='1' doc:type='boolean'/> 889 890<doc:param name="generate.book.toc" xmlns=""> 891<refpurpose>FIXME:</refpurpose> 892<refdescription> 893<para>FIXME: 894</para> 895</refdescription> 896</doc:param> 897 898<!-- ==================================================================== --> 899<xsl:param name="generate.part.toc" select='1' doc:type='boolean'/> 900 901<doc:param name="generate.part.toc" xmlns=""> 902<refpurpose>FIXME:</refpurpose> 903<refdescription> 904<para>FIXME: 905</para> 906</refdescription> 907</doc:param> 908 909<!-- ==================================================================== --> 910<xsl:param name="generate.reference.toc" select='1' doc:type='boolean'/> 911 912<doc:param name="generate.reference.toc" xmlns=""> 913<refpurpose>FIXME:</refpurpose> 914<refdescription> 915<para>FIXME: 916</para> 917</refdescription> 918</doc:param> 919 920<!-- ==================================================================== --> 921<xsl:param name="generate.preface.toc" select='1' doc:type='boolean'/> 922 923<doc:param name="generate.preface.toc" xmlns=""> 924<refpurpose>FIXME:</refpurpose> 925<refdescription> 926<para>FIXME: 927</para> 928</refdescription> 929</doc:param> 930 931<!-- ==================================================================== --> 932<xsl:param name="generate.chapter.toc" select='1' doc:type='boolean'/> 933 934<doc:param name="generate.chapter.toc" xmlns=""> 935<refpurpose>FIXME:</refpurpose> 936<refdescription> 937<para>FIXME: 938</para> 939</refdescription> 940</doc:param> 941 942<!-- ==================================================================== --> 943<xsl:param name="generate.appendix.toc" select='1' doc:type='boolean'/> 944 945<doc:param name="generate.appendix.toc" xmlns=""> 946<refpurpose>FIXME:</refpurpose> 947<refdescription> 948<para>FIXME: 949</para> 950</refdescription> 951</doc:param> 952 953<!-- ==================================================================== --> 954<xsl:param name="generate.article.toc" select='1' doc:type='boolean'/> 955 956<doc:param name="generate.article.toc" xmlns=""> 957<refpurpose>FIXME:</refpurpose> 958<refdescription> 959<para>FIXME: 960</para> 961</refdescription> 962</doc:param> 963 964<!-- ==================================================================== --> 965<xsl:param name="generate.section.toc" select='0' doc:type='boolean'/> 966 967<doc:param name="generate.section.toc" xmlns=""> 968<refpurpose>FIXME:</refpurpose> 969<refdescription> 970<para>FIXME: 971</para> 972</refdescription> 973</doc:param> 974 975<!-- ==================================================================== --> 976<xsl:param name="process.source.toc" select='0' doc:type='boolean'/> 977 978<doc:param name="process.source.toc" xmlns=""> 979<refpurpose>FIXME:</refpurpose> 980<refdescription> 981<para>FIXME: 982</para> 983</refdescription> 984</doc:param> 985 986<!-- ==================================================================== --> 987<xsl:param name="process.empty.source.toc" select='0' doc:type='boolean'/> 988 989<doc:param name="process.empty.source.toc" xmlns=""> 990<refpurpose>FIXME:</refpurpose> 991<refdescription> 992<para>FIXME: 993</para> 994</refdescription> 995</doc:param> 996 997<!-- ==================================================================== --> 998<xsl:param name="bridgehead.in.toc" select='0' doc:type='boolean'/> 999 1000<doc:param name="bridgehead.in.toc" xmlns=""> 1001<refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> 1002<refdescription> 1003<para>If non-zero, bridgeheads appear in the TOC. Note that this option 1004is not fully supported and may be removed in a future version of the 1005stylesheets. 1006</para> 1007</refdescription> 1008</doc:param> 1009 1010<!-- ==================================================================== --> 1011<xsl:param name="generate.index" select='1' doc:type='boolean'/> 1012 1013<doc:param name="generate.index" xmlns=""> 1014<refpurpose>FIXME:</refpurpose> 1015<refdescription> 1016<para>FIXME: 1017</para> 1018</refdescription> 1019</doc:param> 1020 1021<!-- ==================================================================== --> 1022<xsl:param name="callout.unicode" select="0" doc:type='boolean'/> 1023 1024<doc:param name="callout.unicode" xmlns=""> 1025<refpurpose>FIXME:</refpurpose> 1026<refdescription> 1027<para>FIXME: 1028</para> 1029</refdescription> 1030</doc:param> 1031 1032<!-- ==================================================================== --> 1033<xsl:param name="callout.unicode.start.character" select="10102" 1034 doc:type='integer'/> 1035 1036<doc:param name="callout.unicode.start.character" xmlns=""> 1037<refpurpose>Number of the largest callout graphic</refpurpose> 1038<refdescription> 1039<para>If <parameter>callout.graphics</parameter> 1040is non-zero, graphics are used to represent 1041callout numbers. The value of 1042<parameter>callout.graphics.number.limit</parameter> 1043is 1044the largest number for which a graphic exists. If the callout number 1045exceeds this limit, the default presentation "(nnn)" will always 1046be used. 1047</para> 1048</refdescription> 1049</doc:param> 1050 1051<!-- ==================================================================== --> 1052<xsl:param name="callout.unicode.number.limit" select="'10'" 1053 doc:type='integer'/> 1054 1055<doc:param name="callout.unicode.number.limit" xmlns=""> 1056<refpurpose>Number of the largest callout graphic</refpurpose> 1057<refdescription> 1058<para>If <parameter>callout.graphics</parameter> 1059is non-zero, graphics are used to represent 1060callout numbers. The value of 1061<parameter>callout.graphics.number.limit</parameter> 1062is 1063the largest number for which a graphic exists. If the callout number 1064exceeds this limit, the default presentation "(nnn)" will always 1065be used. 1066</para> 1067</refdescription> 1068</doc:param> 1069 1070<!-- ==================================================================== --> 1071<xsl:param name="use.id.as.filename" select="'0'" doc:type='boolean'/> 1072 1073<doc:param name="use.id.as.filename" xmlns=""> 1074<refpurpose>Use ID value of chunk elements as the filename?</refpurpose> 1075<refdescription> 1076<para>If <parameter>use.id.as.filename</parameter> 1077is non-zero, the filename of chunk elements that have IDs will be 1078derived from the ID value. 1079</para> 1080</refdescription> 1081</doc:param> 1082 1083<!-- ==================================================================== --> 1084<xsl:param name="inherit.keywords" select="'1'" doc:type='boolean'/> 1085 1086<doc:param name="inherit.keywords" xmlns=""> 1087<refpurpose>Inherit keywords from ancestor elements?</refpurpose> 1088<refdescription> 1089<para>If <parameter>inherit.keywords</parameter> 1090is non-zero, the keyword <sgmltag>META</sgmltag> for each HTML 1091<sgmltag>HEAD</sgmltag> element will include all of the keywords from 1092ancestral elements. Otherwise, only the keywords from the current section 1093will be used. 1094</para> 1095</refdescription> 1096</doc:param> 1097 1098<!-- ==================================================================== --> 1099<xsl:param name="label.from.part" select="'0'" doc:type='boolean'/> 1100 1101<doc:param name="label.from.part" xmlns=""> 1102<refpurpose>Renumber chapters in each part?</refpurpose> 1103<refdescription> 1104<para>If <parameter>label.from.part</parameter> is non-zero, components 1105(<sgmltag>chapter</sgmltag>s, <sgmltag>appendixe</sgmltag>s, etc.) 1106will be numbered from 1 in each <sgmltag>part</sgmltag>. Otherwise, 1107they will be numbered monotonically throughout each 1108<sgmltag>book</sgmltag>. 1109</para> 1110</refdescription> 1111</doc:param> 1112 1113<!-- ==================================================================== --> 1114<xsl:param name="citerefentry.link" select="'0'" doc:type='boolean'/> 1115 1116<doc:param name="citerefentry.link" xmlns=""> 1117<refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> 1118<refdescription> 1119<para>If true, a web link will be generated, presumably 1120to an online man->HTML gateway. The text of the link is 1121generated by the generate.citerefentry.link template. 1122</para> 1123</refdescription> 1124</doc:param> 1125 1126<!-- ==================================================================== --> 1127<xsl:param name="default.encoding" select="'ISO-8859-1'" doc:type='string'/> 1128 1129<doc:param name="default.encoding" xmlns=""> 1130<refpurpose>Encoding used in generated HTML pages</refpurpose> 1131<refdescription> 1132<para>This encoding is used in files generated by chunking stylesheet. Currently 1133only Saxon is able to change output encoding. 1134</para> 1135</refdescription> 1136</doc:param> 1137 1138<!-- ==================================================================== --> 1139<xsl:param name="saxon.character.representation" select="'entity;decimal'" doc:type='string'/> 1140 1141<doc:param name="saxon.character.representation" xmlns=""> 1142<refpurpose>Saxon character representation used in generated HTML pages</refpurpose> 1143<refdescription> 1144<para>This character representation is used in files generated by chunking stylesheet. If 1145you want to suppress entity references for characters with direct representation 1146in default.encoding, set this parameter to value <literal>native</literal>. 1147</para> 1148</refdescription> 1149</doc:param> 1150 1151 1152</xsl:stylesheet> 1153