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