docs/docbook/xslt/db2latex/vars.mod.xsl

   1 <?xml version='1.0'?>
   2 <!--#############################################################################
   3 |- #############################################################################
   4 |
   5 |   PURPOSE: User and stylesheets XSL variables
   6 + ############################################################################## -->
   7
   8 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   9     xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
  10     exclude-result-prefixes="doc" version='1.0'>
  11
  12
  13     <doc:reference id="vars" xmlns="">
  14         <referenceinfo>
  15             <releaseinfo role="meta">
  16             </releaseinfo>
  17             <authorgroup>
  18                 <author><surname>Casellas</surname><firstname>Ramon</firstname></author>
  19                 <author><surname>Devenish</surname><firstname>James</firstname></author>
  20             </authorgroup>
  21             <copyright>
  22                 <year>2000</year><year>2001</year><year>2002</year><year>2003</year>
  23                 <holder>Ramon Casellas</holder>
  24             </copyright>
  25         </referenceinfo>
  26
  27         <title>XSL Variables and Parameters</title>
  28
  29         <partintro>
  30             <section><title>Introduction</title>
  31
  32                 <para>This is technical reference documentation for the DocBook XSL
  33                     Stylesheets. It documents (some of) the parameters, templates, and
  34                     other elements of the stylesheets.</para>
  35             </section>
  36         </partintro>
  37     </doc:reference>
  38
  39
  40     <!--#############################################################################
  41     |  COMMON VARIABLES
  42     |- #############################################################################
  43     |
  44     + ############################################################################## -->
  45     <xsl:variable name="default-classsynopsis-language">java</xsl:variable>
  46
  47     <xsl:variable name="author.othername.in.middle" select="1"/>
  48     <xsl:variable name="refentry.xref.manvolnum" select="1"/>
  49     <xsl:variable name="funcsynopsis.style">kr</xsl:variable>
  50     <xsl:variable name="funcsynopsis.decoration" select="1"/>
  51     <xsl:variable name="function.parens">0</xsl:variable>
  52     <xsl:variable name="refentry.generate.name" select="1"/>
  53
  54         <doc:param name="show.comments" xmlns="">
  55         <refpurpose> Display <sgmltag class="element">comment</sgmltag> elements? </refpurpose>
  56         <refdescription>
  57                 <para>Control the display of <sgmltag class="element">comment</sgmltag>s and <sgmltag class="element">remark</sgmltag>s.</para>
  58         </refdescription>
  59         </doc:param>
  60         <xsl:param name="show.comments" select="1"/>
  61
  62     <xsl:variable name="section.autolabel" select="1"/>
  63     <xsl:variable name="section.label.includes.component.label" select="0"/>
  64     <xsl:variable name="chapter.autolabel" select="1"/>
  65     <xsl:variable name="preface.autolabel" select="0"/>
  66     <xsl:variable name="part.autolabel" select="1"/>
  67     <xsl:variable name="qandadiv.autolabel" select="1"/>
  68     <xsl:variable name="autotoc.label.separator" select="'. '"/>
  69     <xsl:variable name="qanda.inherit.numeration" select="1"/>
  70     <xsl:variable name="qanda.defaultlabel">number</xsl:variable>
  71     <xsl:param name="biblioentry.item.separator">, </xsl:param>
  72         <doc:param name="toc.section.depth" xmlns="">
  73         <refpurpose> Cull table-of-contents entries that are deeply nested </refpurpose>
  74         <refdescription>
  75                 <para>Specifies the maximum depth before sections are omitted from the table of contents.</para>
  76         </refdescription>
  77         </doc:param>
  78         <xsl:param name="toc.section.depth">4</xsl:param>
  79
  80         <doc:param name="section.depth" xmlns="">
  81         <refpurpose> Control the automatic numbering of section, parts, and chapters </refpurpose>
  82         <refdescription>
  83                 <para>
  84                 Specifies the maximum depth before sections cease to be uniquely numbered.
  85                 This is passed to LaTeX using the <literal>secnumdepth</literal> counter.
  86                 Therefore, it is possible to use a value of <quote>0</quote> (zero) to disable section numbering.
  87                 A value of <quote>-1</quote> will disable the numbering of parts and chapters, too.
  88                 </para>
  89         </refdescription>
  90         </doc:param>
  91     <xsl:param name="section.depth">4</xsl:param>
  92     <xsl:variable name="graphic.default.extension"></xsl:variable>
  93     <xsl:variable name="check.idref">1</xsl:variable>
  94     <!--
  95     <xsl:variable name="link.mailto.url"></xsl:variable>
  96     <xsl:variable name="toc.list.type">dl</xsl:variable>
  97     -->
  98
  99         <doc:param name="use.role.for.mediaobject" xmlns="">
 100         <refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose>
 101         <refdescription>
 102                 <para>This controls how DB2LaTeX behaves when a <sgmltag class="element">figure</sgmltag> contains
 103                 multiple <sgmltag class="element">mediaobject</sgmltag>s. When enabled, DB2LaTeX will choose
 104                 the mediaobject with the "LaTeX" or "TeX" role, if present. Otherwise, the first mediaobject
 105                 is chosen.</para>
 106         </refdescription>
 107         </doc:param>
 108         <xsl:param name="use.role.for.mediaobject">1</xsl:param>
 109
 110         <doc:param name="preferred.mediaobject.role" xmlns="">
 111         <refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose>
 112         <refdescription>
 113                 <para>When <xref linkend="param.use.role.for.mediaobject"/> is enabled, this variable
 114                 can be used to specify the mediaobject role that your document uses for LaTeX output.
 115                 DB2LaTeX will try to use this role before using the "LaTeX" or "TeX" roles.
 116                 For example, some authors may choose to set this to "PDF".</para>
 117         </refdescription>
 118         </doc:param>
 119         <xsl:param name="preferred.mediaobject.role"></xsl:param>
 120
 121         <doc:param name="formal.title.placement" xmlns="">
 122         <refpurpose> Specifies where formal object titles should occur </refpurpose>
 123         <refdescription>
 124                 <para>
 125                         Titles for the formal object types (figure, example, quation, table, and procedure)
 126                         can be placed before or after those objects. The keyword <quote>before</quote>
 127                         is recognised. All other strings qualify as <quote>after</quote>.
 128                 </para>
 129         </refdescription>
 130         </doc:param>
 131         <xsl:param name="formal.title.placement">
 132                 figure not_before
 133                 example before
 134                 equation not_before
 135                 table before
 136                 procedure before
 137         </xsl:param>
 138
 139         <doc:param name="insert.xref.page.number" xmlns="">
 140         <refpurpose> Control the appearance of page numbers in cross references </refpurpose>
 141         <refdescription>
 142                 <para>
 143                         When enabled, <sgmltag class="element">xref</sgmltag>s will include page
 144                         numbers after their generated cross-reference text.
 145                 </para>
 146         </refdescription>
 147         </doc:param>
 148         <xsl:param name="insert.xref.page.number">0</xsl:param>
 149
 150         <doc:param name="ulink.show" xmlns="">
 151         <refpurpose> Control the display of URLs after ulinks </refpurpose>
 152         <refdescription>
 153                 <para>
 154                 When this option is enabled, and a ulink has a URL that is different
 155                 from the displayed content, the URL will be typeset after the content.
 156                 If the URL and content are identical, only one of them will appear.
 157                 Otherwise, the URL is hyperlinked and the content is not.
 158                 </para>
 159         </refdescription>
 160         </doc:param>
 161         <xsl:param name="ulink.show">0</xsl:param>
 162
 163         <doc:param name="ulink.footnotes" xmlns="">
 164         <refpurpose> Control the generation of footnotes for ulinks </refpurpose>
 165         <refdescription>
 166                 <para>
 167                 When this option is enabled, a ulink that has content different to its
 168                 URL will have an associated footnote. The contents of the footnote
 169                 will be the URL. If the ulink is within a footnote, the URL is shown
 170                 after the content.
 171                 </para>
 172         </refdescription>
 173         </doc:param>
 174         <xsl:param name="ulink.footnotes">0</xsl:param>
 175
 176     <!--#############################################################################
 177     |   LaTeX VARIABLES
 178     |- #############################################################################
 179     |
 180     |   PURPOSE: User and stylesheets XSL variables
 181     + ############################################################################## -->
 182
 183         <doc:param name="latex.override" xmlns="">
 184         <refpurpose> Override DB2LaTeX's preamble with a custom preamble. </refpurpose>
 185         <refdescription>
 186                 <para>
 187                 When this variable is set, the entire DB2LaTeX premable will be superseded.
 188                 <emphasis>You should not normally need or want to use this.</emphasis>
 189                 It may cause LaTeX typesetting problems. This is a last resort or
 190                 <quote>expert</quote> feature.
 191                 </para>
 192         </refdescription>
 193         </doc:param>
 194         <xsl:param name="latex.override"></xsl:param>
 195
 196         <doc:param name="latex.entities" xmlns="">
 197         <refpurpose> Control Unicode character handling. </refpurpose>
 198         <refdescription>
 199                 <para>
 200                 Normally, XSLT processors will convert SGML character entities into
 201                 Unicode characters and DB2LaTeX doesn't have much chance to do anything
 202                 toward converting them to LaTeX equivalents. We do not yet know how we
 203                 can solve this problem best.
 204                 </para>
 205                 <para>
 206                 Proposed values: 'catcode', 'unicode', 'extension'.
 207                 Currently only 'catcode' is supported. All other values will
 208                 cause no special handling except for certain mappings in MathML.
 209                 In future, perhaps the 'unicode' LaTeX package could be of assistance.
 210                 'Extension' could be an XSLT extension that handles the characters
 211                 using a mapping table.
 212                 </para>
 213         </refdescription>
 214         </doc:param>
 215         <xsl:param name="latex.entities"></xsl:param>
 216
 217         <doc:param name="latex.alt.is.latex" xmlns="">
 218         <refpurpose> Control the escaping of <sgmltag class="element">alt</sgmltag> text </refpurpose>
 219         <refdescription>
 220                 <para>
 221                 Text within <sgmltag class="element">alt</sgmltag> elements is assumed to
 222                 be valid LaTeX and is passed through unescaped by default. If this is not
 223                 appropriate for your document, set this variable to something other than
 224                 '1'.
 225                 </para>
 226         </refdescription>
 227         </doc:param>
 228         <xsl:param name="latex.alt.is.latex">1</xsl:param>
 229
 230         <doc:param name="latex.alt.is.preferred" xmlns="">
 231         <refpurpose> Control the use of <sgmltag class="element">alt</sgmltag> text </refpurpose>
 232         <refdescription>
 233                 <para>
 234                 By default, DB2LaTeX assumes that <sgmltag class="element">alt</sgmltag>
 235                 text should be typeset in preference to any
 236                 <sgmltag class="element">mediaobject</sgmltag>s.
 237                 </para>
 238         </refdescription>
 239         </doc:param>
 240         <xsl:param name="latex.alt.is.preferred">1</xsl:param>
 241
 242         <!--
 243         <doc:variable name="latex.figure.position" xmlns="">
 244         <refpurpose> How to place floats. </refpurpose>
 245         <refdescription>
 246                 <para>
 247                 This variable is used as the positioning argument for floats.
 248                 In future, this may be replaced by a dynamic mechanism that can
 249                 honour DocBook placement attributes.
 250                 </para>
 251         </refdescription>
 252         </doc:variable>
 253     <xsl:variable name="latex.figure.position">[hbt]</xsl:variable>
 254         -->
 255
 256         <doc:param name="latex.apply.title.templates" xmlns="">
 257         <refpurpose> Whether to apply templates for section titles. </refpurpose>
 258         <refdescription>
 259                 <para>
 260                 Controls whether section titles will be generated by
 261                 applying templates or by conversion to string values.
 262                 When enabled, templates will be applied. This enables template
 263                 expression in titles but may have problematic side-effects such
 264                 as nested links.
 265                 </para>
 266                 <note>
 267                         <para>
 268                                 This variable does not influence all <sgmltag class="element">title</sgmltag>
 269                                 elements. Some may have their own variables or not be configurable.
 270                         </para>
 271                 </note>
 272         </refdescription>
 273         </doc:param>
 274         <xsl:param name="latex.apply.title.templates">1</xsl:param>
 275
 276
 277
 278
 279
 280         <doc:param name="latex.apply.title.templates.admonitions" xmlns="">
 281         <refpurpose> Whether to apply templates for admonition titles. </refpurpose>
 282         <refdescription>
 283                 <para>
 284                 Controls whether admonition titles will be generated by
 285                 applying templates or by conversion to string values.
 286                 When enabled, templates will be applied.
 287                 </para>
 288         </refdescription>
 289         </doc:param>
 290         <xsl:param name="latex.apply.title.templates.admonitions">1</xsl:param>
 291
 292
 293
 294
 295
 296
 297         <doc:param name="latex.graphics.formats" xmlns="">
 298         <refpurpose> Control <sgmltag class="element">imagedata</sgmltag> selection. </refpurpose>
 299         <refdescription>
 300                 <para>This controls how DB2LaTeX behaves when a <sgmltag class="element">mediaobject</sgmltag> contains
 301                 multiple <sgmltag class="element">imagedata</sgmltag>. When non-empty, DB2LaTeX will exclude
 302                 imagedata that have a format no listed within this variable.</para>
 303         </refdescription>
 304         </doc:param>
 305         <xsl:param name="latex.graphics.formats"></xsl:param>
 306
 307
 308
 309
 310
 311
 312         <doc:param name="latex.caption.swapskip" xmlns="">
 313         <refpurpose> Improved typesetting of captions  </refpurpose>
 314         <refdescription>
 315                 <para>
 316                 DB2LaTeX supports <link linkend="param.formal.title.placement">$formal.title.placement</link>
 317                 as a mechanism for choosing whether captions will appear above or below the objects they describe.
 318                 <!--
 319                 ($formal.title.placement is described in the <ulink
 320                 url="http://docbook.sourceforge.net/release/xsl/current/doc/html/formal.title.placement.html">DocBook
 321                 XSL Stylesheet HTML Parameter Reference</ulink>.)
 322                 -->
 323                 However, LaTeX will often produce an ugly result when captions occur
 324                 above their corresponding content. This usually arises because of
 325                 unsuitable \abovecaptionskip and \belowcaptionskip.
 326                 </para>
 327                 <para>
 328                 This variable, when set to '1', authorises DB2LaTeX to swap the caption
 329                 'skip' lengths when a caption is placed <emphasis>above</emphasis> its
 330                 corresponding content. This is enabled by default.
 331                 </para>
 332         </refdescription>
 333         </doc:param>
 334         <xsl:param name="latex.caption.swapskip">1</xsl:param>
 335
 336
 337
 338
 339
 340         <doc:param name="latex.titlepage.file" xmlns="">
 341         <refpurpose> DB2LaTeX allows using an (externally generated) cover page  </refpurpose>
 342         <refdescription>
 343                 <para>
 344                 You may supply a LaTeX file that will supersede DB2LaTeX's default
 345                 cover page or title. If the value of this variable is non-empty, the
 346                 generated LaTeX code includes \input{filename}. Otherwise, it uses the
 347                 \maketitle command.
 348                 </para>
 349                 <warning><para>
 350                         Bear in mind that using an external cover page breaks the
 351                         "encapsulation" of DocBook. Further revisions of these stylesheets
 352                         will add chunking support, and the automation of the cover file
 353                         generation.
 354                 </para></warning>
 355         </refdescription>
 356         </doc:param>
 357         <xsl:param name="latex.titlepage.file">title</xsl:param>
 358
 359
 360
 361
 362         <doc:param name="latex.documentclass" xmlns="">
 363         <refpurpose> DB2LaTeX document class </refpurpose>
 364         <refdescription>
 365                 <para>
 366                 This variable is normally empty and the stylesheets will determine
 367                 the correct document class according to whether the document is a
 368                 book or an article. If you wish to use your own document class,
 369                 put its non-empty value in this variable. It will apply for both
 370                 books and articles.
 371                 </para>
 372         </refdescription>
 373         </doc:param>
 374         <xsl:param name="latex.documentclass"></xsl:param>
 375
 376         <doc:param name="latex.documentclass.common" xmlns="">
 377         <refpurpose> DB2LaTeX document class options  </refpurpose>
 378         <refdescription>
 379                 <para>
 380                 These are the first options to be passed to <literal>\documentclass</literal>
 381                 The common options are set to <literal>french,english</literal> by default.
 382                 They will be augmented or superseded by article/book options (see $latex.documentclass.article and $latex.documentclass.book) and pdftex/dvips options (see $latex.documentclass.pdftex and $latex.documentclass.dvips).
 383                 </para>
 384         </refdescription>
 385         </doc:param>
 386         <xsl:param name="latex.documentclass.common">french,english</xsl:param>
 387
 388         <doc:param name="latex.documentclass.article" xmlns="">
 389         <refpurpose> DB2LaTeX document class options for articles</refpurpose>
 390         <refdescription>
 391                 <para>
 392                 The article options are set to <literal>a4paper,10pt,twoside,twocolumn</literal> by default.
 393                 These are the intermediate options to be passed to <literal>\documentclass</literal>,
 394                 between the common options and the pdftex/dvips options.
 395                 </para>
 396         </refdescription>
 397         </doc:param>
 398         <xsl:param name="latex.documentclass.article">a4paper,10pt,twoside,twocolumn</xsl:param>
 399
 400         <doc:param name="latex.documentclass.book" xmlns="">
 401         <refpurpose> DB2LaTeX document class options for books</refpurpose>
 402         <refdescription>
 403                 <para>
 404                 The book options are set to <literal>a4paper,10pt,twoside,openright</literal> by default.
 405                 These are the intermediate options to be passed to <literal>\documentclass</literal>,
 406                 between the common options and the pdftex/dvips options.
 407                 </para>
 408         </refdescription>
 409         </doc:param>
 410         <xsl:param name="latex.documentclass.book">a4paper,10pt,twoside,openright</xsl:param>
 411
 412         <doc:param name="latex.documentclass.pdftex" xmlns="">
 413         <refpurpose> DB2LaTeX document class options for pdfTeX output</refpurpose>
 414         <refdescription>
 415                 <para>
 416                 The pdfTeX options are empty by default.
 417                 These are the last options to be passed to <literal>\documentclass</literal>
 418                 and override the common/article/book options.
 419                 </para>
 420         </refdescription>
 421         </doc:param>
 422         <xsl:param name="latex.documentclass.pdftex"></xsl:param>
 423
 424         <doc:param name="latex.documentclass.dvips" xmlns="">
 425         <refpurpose> DB2LaTeX document class options for dvips output</refpurpose>
 426         <refdescription>
 427                 <para>
 428                 The dvips options are empty by default.
 429                 These are the last options to be passed to <literal>\documentclass</literal>
 430                 and override the common/article/book options.
 431                 </para>
 432         </refdescription>
 433         </doc:param>
 434         <xsl:param name="latex.documentclass.dvips"></xsl:param>
 435
 436         <doc:param name="latex.admonition.path" xmlns="">
 437         <refpurpose> LaTeX location for admonition graphics </refpurpose>
 438         <refdescription>
 439                 <para>The file path that will be passed to LaTeX in order to find admonition graphics.</para>
 440                 <para>An empty value suppresses the use of admonition graphics.</para>
 441                 <para>If your figures are in <quote>the current directory</quote> then use a value of
 442                 <quote>.</quote> (i.e. the full stop or period on its own) to signify this.</para>
 443         </refdescription>
 444         </doc:param>
 445         <xsl:param name="latex.admonition.path">figures</xsl:param>
 446
 447
 448         <doc:param name="latex.admonition.imagesize" xmlns="">
 449         <refpurpose> DB2LaTeX graphics admonitions size</refpurpose>
 450         <refdescription>
 451                 <para>
 452                         Is passed as an optional parameter for <literal>\includegraphics</literal> and
 453                         can take on any such legal values (or be empty).
 454                 </para>
 455         </refdescription>
 456         </doc:param>
 457         <xsl:param name="latex.admonition.imagesize">width=1cm</xsl:param>
 458
 459
 460         <!--
 461         <xsl:param name="latex.chapter.label">1</xsl:param>
 462
 463     <doc:param name="latex.chapter.hypertarget" xmlns="">
 464         <refpurpose> Hypertarget Chapters  </refpurpose>
 465         <refdescription>
 466             <para>
 467             </para>
 468         </refdescription>
 469     </doc:param>
 470     <xsl:param name="latex.chapter.hypertarget">1</xsl:param>
 471         -->
 472
 473
 474         <doc:param name="latex.biblio.output" xmlns="">
 475         <refpurpose> Control which references are cited in the bibliography </refpurpose>
 476         <refdescription>
 477                 <para>
 478                 The DB2LaTeX generated bibliography (bibitems) may either
 479                 include all biblioentries found in the document, or only thee ones explicitly
 480                 cited with <sgmltag class="element">citation</sgmltag>.
 481                 </para>
 482             <para>Two values are possible: <quote>all</quote> or <quote>cited</quote>.</para>
 483         </refdescription>
 484         </doc:param>
 485         <xsl:param name="latex.biblio.output">all</xsl:param>
 486
 487
 488         <doc:param name="latex.bibfiles" xmlns="">
 489         <refpurpose>
 490                 Control the output of the \bibliography{.bib}.
 491         </refpurpose>
 492         <refdescription>
 493                 <para>The value of this parameter is output.</para>
 494                 <para>An example is <quote><filename>citations.bib</filename></quote>,
 495                 if your BibTeX file has that name.</para>
 496         </refdescription>
 497         </doc:param>
 498         <xsl:param name="latex.bibfiles"></xsl:param>
 499
 500
 501         <doc:param name="latex.bibwidelabel" xmlns="">
 502         <refpurpose> Adjust bibliography formatting </refpurpose>
 503         <refdescription>
 504                 <para>The environment bibliography accepts a parameter that indicates
 505                 the widest label, which is used to correctly format the bibliography
 506                 output. The value of this parameter is output inside the
 507                 <literal>\begin{thebibliography[]}</literal> LaTeX command.</para>
 508         </refdescription>
 509         </doc:param>
 510         <xsl:param name="latex.bibwidelabel">WIDELABEL</xsl:param>
 511
 512         <!--
 513         <xsl:variable name="latex.dont.label">0</xsl:variable>
 514         <xsl:variable name="latex.dont.hypertarget">0</xsl:variable>
 515         -->
 516
 517         <doc:param name="latex.use.ucs" xmlns="">
 518                 <refpurpose> Choose whether to use the <productname>unicode</productname> LaTeX package</refpurpose>
 519                 <refdescription><para>See the <productname>unicode</productname> documentation for details.</para></refdescription>
 520         </doc:param>
 521         <xsl:param name="latex.use.ucs">0</xsl:param>
 522
 523         <doc:param name="latex.ucs.options" xmlns="">
 524                 <refpurpose>Select the optional parameter(s) for the <productname>unicode</productname> LaTeX package</refpurpose>
 525                 <refdescription><para>See the <productname>unicode</productname> documentation for details.</para></refdescription>
 526         </doc:param>
 527         <xsl:param name="latex.ucs.options"></xsl:param>
 528
 529         <doc:param name="latex.babel.language" xmlns="">
 530                 <refpurpose>Select the optional parameter for the <productname>babel</productname> LaTeX package</refpurpose>
 531                 <refdescription><para>See the <productname>babel</productname> documentation for details.</para></refdescription>
 532         </doc:param>
 533         <xsl:param name="latex.babel.language">french</xsl:param>
 534
 535         <doc:param name="latex.use.isolatin1" xmlns="">
 536                 <refpurpose>Toggle the use of the <productname>isolatin1</productname> LaTeX package</refpurpose>
 537         </doc:param>
 538         <xsl:variable name="latex.use.isolatin1">1</xsl:variable>
 539
 540         <doc:param name="latex.use.hyperref" xmlns="">
 541                 <refpurpose>Toggle the use of the <productname>hyperref</productname> LaTeX package</refpurpose>
 542                 <refdescription><para>This is used extensively for hyperlinking within documents.</para></refdescription>
 543         </doc:param>
 544         <xsl:variable name="latex.use.hyperref">1</xsl:variable>
 545
 546         <doc:param name="latex.use.fancybox" xmlns="">
 547                 <refpurpose>Toggle the use of the <productname>fancybox</productname> LaTeX package</refpurpose>
 548                 <refdescription><para>This is essential for admonitions.</para></refdescription>
 549         </doc:param>
 550         <xsl:variable name="latex.use.fancybox">1</xsl:variable>
 551
 552         <doc:param name="latex.use.fancyvrb" xmlns="">
 553                 <refpurpose>Toggle the use of the <productname>fancyvrb</productname> LaTeX package</refpurpose>
 554                 <refdescription><para>Provides support for tabbed whitespace in verbatim environments.
 555                 See also <xref linkend="param.latex.fancyvrb.tabsize"/>.</para></refdescription>
 556         </doc:param>
 557         <xsl:param name="latex.use.fancyvrb">1</xsl:param>
 558
 559         <doc:param name="latex.fancyvrb.tabsize" xmlns="">
 560                 <refpurpose>Choose indentation for tabs in verbatim environments</refpurpose>
 561                 <refdescription><para>When <xref linkend="param.latex.use.fancyvrb"/> is enabled,
 562                 this variable sets the width of a tab in terms of an equivalent number of spaces.</para></refdescription>
 563         </doc:param>
 564         <xsl:param name="latex.fancyvrb.tabsize">3</xsl:param>
 565
 566         <doc:param name="latex.use.fancyhdr" xmlns="">
 567                 <refpurpose>Toggle the use of the <productname>fancyhdr</productname> LaTeX package</refpurpose>
 568                 <refdescription><para>Provides page headers and footers. Disabling support for
 569                 this package will make headers and footer go away.</para></refdescription>
 570         </doc:param>
 571         <xsl:param name="latex.use.fancyhdr">1</xsl:param>
 572
 573         <doc:param name="latex.use.parskip" xmlns="">
 574                 <refpurpose>Toggle the use of the <productname>parskip</productname> LaTeX package</refpurpose>
 575                 <refdescription><para>Support a <quote>block</quote> paragraph style as opposed to
 576                 <quote>indented</quote>.</para></refdescription>
 577         </doc:param>
 578         <xsl:param name="latex.use.parskip">0</xsl:param>
 579
 580         <doc:param name="latex.use.subfigure" xmlns="">
 581                 <refpurpose>Toggle the use of the <productname>subfigure</productname> LaTeX package</refpurpose>
 582                 <refdescription><para>Used to provide nice layout of multiple mediaobjects in figures.</para></refdescription>
 583         </doc:param>
 584         <xsl:param name="latex.use.subfigure">1</xsl:param>
 585
 586         <doc:param name="latex.use.rotating" xmlns="">
 587                 <refpurpose>Toggle the use of the <productname>rotating</productname> LaTeX package</refpurpose>
 588         </doc:param>
 589         <xsl:param name="latex.use.rotating">1</xsl:param>
 590
 591         <doc:param name="latex.use.tabularx" xmlns="">
 592                 <refpurpose>Toggle the use of the <productname>tabularx</productname> LaTeX package</refpurpose>
 593                 <refdescription><para>Used to provide certain table features. Has some incompatabilities
 594                 with packages, but also solves some conflicts that the regular tabular
 595                 environment has.</para></refdescription>
 596         </doc:param>
 597         <xsl:param name="latex.use.tabularx">1</xsl:param>
 598
 599         <doc:param name="latex.use.umoline" xmlns="">
 600                 <refpurpose>Toggle the use of the <productname>umoline</productname> LaTeX package</refpurpose>
 601                 <refdescription><para>Provide underlining.</para></refdescription>
 602         </doc:param>
 603         <xsl:param name="latex.use.umoline">0</xsl:param>
 604
 605         <doc:param name="latex.use.url" xmlns="">
 606                 <refpurpose>Toggle the use of the <productname>url</productname> LaTeX package</refpurpose>
 607                 <refdescription><para>Provide partial support for hyperlinks.</para></refdescription>
 608         </doc:param>
 609         <xsl:param name="latex.use.url">1</xsl:param>
 610
 611         <doc:param name="latex.use.makeidx" xmlns="">
 612                 <refpurpose>Toggle the use of the <productname>makeidx</productname> LaTeX package</refpurpose>
 613                 <refdescription><para>Support index generation.</para></refdescription>
 614         </doc:param>
 615         <xsl:param name="latex.use.makeidx">1</xsl:param>
 616
 617         <doc:param name="latex.hyphenation.tttricks" xmlns="">
 618         <refpurpose> DB2LaTeX hyphenation linebreak tricks </refpurpose>
 619         <refdescription>
 620                 <para>
 621                 Usually, LaTeX does not perform hyphenation in <quote>teletype</quote> (monospace)
 622                 text. This can lead to formatting problems. But certain monospace texts, such as
 623                 URLs and filenames, have <quote>natural</quote> breakpoints such as full stops
 624                 and slashes. DB2LaTeX's <quote>tttricks</quote> exploit a hyphenation trick in
 625                 order to provide line wrapping in the middle of monospace text. Set this to '1'
 626                 to enable these tricks (they are not enabled by default). See also the FAQ.
 627                 </para>
 628         </refdescription>
 629         </doc:param>
 630     <xsl:variable name="latex.hyphenation.tttricks">0</xsl:variable>
 631
 632         <doc:param name="latex.hyperref.param.common" xmlns="">
 633         <refpurpose> DB2LaTeX hyperref options</refpurpose>
 634         <refdescription>
 635                 <para>
 636                 The hyperref options are set to <literal>bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage</literal> by default.
 637                 You may wish to specify additional options using <literal>latex.hyperref.param.pdftex</literal>
 638                 or <literal>latex.hyperref.param.dvips</literal>.
 639                 </para>
 640         </refdescription>
 641         </doc:param>
 642     <xsl:variable name="latex.hyperref.param.common">bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage</xsl:variable>
 643
 644         <doc:param name="latex.hyperref.param.pdftex" xmlns="">
 645         <refpurpose> DB2LaTeX hyperref options for pdfTeX output</refpurpose>
 646         <refdescription>
 647                 <para>
 648                 This variable is empty by default. See the hyperref documentation for further information.
 649                 </para>
 650         </refdescription>
 651         </doc:param>
 652         <xsl:variable name="latex.hyperref.param.pdftex">pdfstartview=FitH</xsl:variable>
 653
 654         <doc:param name="latex.hyperref.param.dvips" xmlns="">
 655         <refpurpose> DB2LaTeX hyperref options for dvips output</refpurpose>
 656         <refdescription>
 657                 <para>
 658                 This variable is empty by default. See the hyperref documentation for further information.
 659                 </para>
 660         </refdescription>
 661         </doc:param>
 662         <xsl:variable name="latex.hyperref.param.dvips"></xsl:variable>
 663
 664     <xsl:variable name="latex.fancyhdr.lh">Left Header</xsl:variable>
 665     <xsl:variable name="latex.fancyhdr.ch">Center Header</xsl:variable>
 666     <xsl:variable name="latex.fancyhdr.rh">Right Header</xsl:variable>
 667     <xsl:variable name="latex.fancyhdr.lf">Left Footer</xsl:variable>
 668     <xsl:variable name="latex.fancyhdr.cf">Center Footer</xsl:variable>
 669     <xsl:variable name="latex.fancyhdr.rf">Right Footer</xsl:variable>
 670
 671     <doc:param name="latex.step.title.style" xmlns="">
 672         <refpurpose> Control the style of step titles  </refpurpose>
 673         <refdescription>
 674             <para>Step titles are typeset in small caps but if
 675                 this option is set to a LaTeX command, such as <literal>\itshape{}</literal>, then
 676                 that command will precede the title and it will be typeset accordingly.</para>
 677         </refdescription>
 678     </doc:param>
 679     <xsl:variable name="latex.step.title.style">\bf</xsl:variable>
 680
 681     <doc:param name="latex.book.article.title.style" xmlns="">
 682         <refpurpose> Control the style of article titles within books </refpurpose>
 683         <refdescription>
 684         </refdescription>
 685     </doc:param>
 686     <xsl:variable name="latex.book.article.title.style">\Large\textbf</xsl:variable>
 687
 688     <doc:param name="latex.article.title.style" xmlns="">
 689         <refpurpose> Control the style of article titles </refpurpose>
 690         <refdescription>
 691         </refdescription>
 692     </doc:param>
 693     <xsl:variable name="latex.article.title.style">\textbf</xsl:variable>
 694
 695     <doc:param name="latex.pagestyle" xmlns="">
 696         <refpurpose> Override DB2LaTeX's choice of LaTeX page numbering style </refpurpose>
 697         <refdescription>
 698             <para>By default, DB2LaTeX will choose the 'plain' or 'fancy' page styles,
 699                 depending on <xref linkend="param.latex.use.fancyhdr"/>. If non-empty, this
 700                 variable overrides the automatic selection. An example would be the literal
 701                 string 'empty', to eliminate headers and page numbers.</para>
 702         </refdescription>
 703     </doc:param>
 704     <xsl:variable name="latex.pagestyle"></xsl:variable>
 705
 706     <doc:param name="latex.procedure.title.style" xmlns="">
 707         <refpurpose> Control the style of procedure titles  </refpurpose>
 708         <refdescription>
 709             <para>Procedure titles are typeset in small caps but if
 710                 this option is set to a LaTeX command, such as <literal>\itshape{}</literal>, then
 711                 that command will precede the title and it will be typeset accordingly.</para>
 712         </refdescription>
 713     </doc:param>
 714     <xsl:variable name="latex.procedure.title.style">\sc</xsl:variable>
 715
 716     <doc:param name="latex.figure.title.style" xmlns="">
 717         <refpurpose> Control the style of figure titles  </refpurpose>
 718         <refdescription>
 719             <para>Figure titles are typeset in the default typeface (usually 'roman') but if
 720                 this option is set to a LaTeX command, such as <literal>\itshape{}</literal>, then
 721                 that command will precede the title and it will be typeset accordingly.</para>
 722         </refdescription>
 723     </doc:param>
 724     <xsl:variable name="latex.figure.title.style"></xsl:variable>
 725
 726     <doc:param name="latex.pdf.support" xmlns="">
 727         <refpurpose> Controls the output of LaTeX commands to support the generation
 728             of PDF files.</refpurpose>
 729         <refdescription>
 730             <para>If this parameter is set to 1, the stylesheets generate code to
 731                 detect if it is either <literal>latex</literal> or <literal>pdflatex</literal>
 732                 the shell command that is being used to compile the LaTeX text file. Some
 733                 packages (<literal>graphicx</literal>, <literal>hyperref</literal>) are used
 734                 with the right parameters. Finally, the graphic extensions declared, to use in
 735                 <literal>\includegraphics</literal> commands depends also on which command is
 736                 being used. If this parameter is set to zero, such code is not generated (which
 737                 does not mean that the file cannot compile with pdflatex, but some strange issues
 738                 may appear). <emphasis>DEFAULT: 1</emphasis> Only more code is generated.
 739             </para>
 740         </refdescription>
 741     </doc:param>
 742     <xsl:variable name="latex.pdf.support">1</xsl:variable>
 743
 744
 745
 746     <doc:param name="latex.thead.row.entry" xmlns="">
 747         <refpurpose> Format the output of tabular headings. </refpurpose>
 748         <refdescription>
 749         </refdescription>
 750     </doc:param>
 751     <xsl:template name="latex.thead.row.entry">
 752         <xsl:apply-templates/>
 753         </xsl:template>
 754
 755
 756
 757     <doc:param name="latex.math.support" xmlns="">
 758         <refpurpose> Controls the output of LaTeX packages and commands to support
 759             documents with math commands and environments..</refpurpose>
 760         <refdescription>
 761             <para>If this parameter is set to 1, the stylesheets generate code to
 762                 <emphasis>DEFAULT: 1</emphasis> Only more code is generated.
 763             </para>
 764         </refdescription>
 765     </doc:param>
 766     <xsl:variable name="latex.math.support">1</xsl:variable>
 767
 768
 769
 770     <doc:param name="latex.output.revhistory" xmlns="">
 771         <refpurpose> Controls  if the revision history table is generated as the first document
 772             table.
 773         </refpurpose>
 774         <refdescription>
 775             <para>If this parameter is set to 1, the stylesheets generate code to
 776                 <emphasis>DEFAULT: 1</emphasis> Only more code is generated.
 777             </para>
 778         </refdescription>
 779     </doc:param>
 780     <xsl:variable name="latex.output.revhistory">1</xsl:variable>
 781
 782
 783
 784
 785     <xsl:variable name="latex.book.preamble.pre">
 786     </xsl:variable>
 787
 788     <xsl:variable name="latex.book.preamble.post">
 789     </xsl:variable>
 790
 791     <doc:param name="latex.book.varsets" xmlns="">
 792         <refpurpose>
 793             All purpose commands to change text width, height, counters, etc.
 794                 Defaults to a two-sided margin layout.
 795         </refpurpose>
 796         <refdescription>
 797         </refdescription>
 798     </doc:param>
 799     <xsl:variable name="latex.book.varsets">
 800         <xsl:text>\usepackage{anysize}&#10;</xsl:text>
 801         <xsl:text>\marginsize{3cm}{2cm}{1.25cm}{1.25cm}&#10;</xsl:text>
 802     </xsl:variable>
 803
 804     <doc:param name="latex.book.begindocument" xmlns="">
 805         <refpurpose>
 806             Begin document command
 807         </refpurpose>
 808         <refdescription>
 809         </refdescription>
 810     </doc:param>
 811     <xsl:variable name="latex.book.begindocument">
 812         <xsl:text>\begin{document}&#10;</xsl:text>
 813     </xsl:variable>
 814
 815
 816
 817
 818
 819     <doc:param name="latex.book.afterauthor" xmlns="">
 820         <refpurpose>
 821             LaTeX code that is output after the author (e.g.
 822             <literal>\makeindex, \makeglossary</literal>
 823         </refpurpose>
 824         <refdescription>
 825         </refdescription>
 826     </doc:param>
 827     <xsl:variable name="latex.book.afterauthor">
 828         <xsl:text>% --------------------------------------------&#10;</xsl:text>
 829         <xsl:text>\makeindex&#10;</xsl:text>
 830         <xsl:text>\makeglossary&#10;</xsl:text>
 831         <xsl:text>% --------------------------------------------&#10;</xsl:text>
 832     </xsl:variable>
 833
 834
 835
 836
 837     <doc:param name="latex.book.end" xmlns="">
 838         <refpurpose>
 839             LaTeX code that is output  at the end of the document
 840             <literal>\end{document}</literal>
 841         </refpurpose>
 842         <refdescription>
 843         </refdescription>
 844     </doc:param>
 845     <xsl:variable name="latex.book.end">
 846         <xsl:text>% --------------------------------------------&#10;</xsl:text>
 847         <xsl:text>% End of document&#10;</xsl:text>
 848         <xsl:text>% --------------------------------------------&#10;</xsl:text>
 849         <xsl:text>\end{document}&#10;</xsl:text>
 850     </xsl:variable>
 851
 852
 853
 854     <!--#############################################################################
 855     |   XSL VARIABLES FOR ARTICLES
 856     |- #############################################################################
 857     |
 858     + ############################################################################## -->
 859
 860
 861
 862     <xsl:variable name="latex.article.preamble.pre">
 863     </xsl:variable>
 864
 865     <xsl:variable name="latex.article.preamble.post">
 866     </xsl:variable>
 867
 868     <doc:param name="latex.article.begindocument" xmlns="">
 869         <refpurpose> The begin document </refpurpose>
 870         <refdescription>The value of this variable is output from the article template
 871             <xref linkend="template.article"/> after the author command. The default value
 872             (shown below) is just the begin document command. Users of the XSL LaTeX
 873             stylesheet may override this parameter in order to output what they want.
 874         </refdescription>
 875         <refreturn><literal>\begin{document}</literal></refreturn>
 876     </doc:param>
 877     <xsl:variable name="latex.article.begindocument">
 878         <xsl:text>\begin{document}&#10;</xsl:text>
 879     </xsl:variable>
 880
 881
 882     <doc:param name="latex.article.varsets" xmlns="">
 883         <refpurpose> Controls what is output after the LaTeX preamble. </refpurpose>
 884         <refdescription>
 885             <para>Default values decrease edge margins and allow a large quantity of figures to be set on each page. </para>
 886         </refdescription>
 887     </doc:param>
 888
 889     <xsl:variable name="latex.article.varsets">
 890         <xsl:text>
 891                 \usepackage{anysize}
 892                 \marginsize{2cm}{2cm}{2cm}{2cm}
 893             \renewcommand\floatpagefraction{.9}
 894             \renewcommand\topfraction{.9}
 895             \renewcommand\bottomfraction{.9}
 896             \renewcommand\textfraction{.1}
 897         </xsl:text>
 898     </xsl:variable>
 899
 900
 901
 902
 903     <doc:param name="latex.maketitle" xmlns="">
 904         <refpurpose> The <literal>\maketitle</literal> for books and articles. </refpurpose>
 905         <refdescription>
 906                 <para>Some users may wish to override or eliminate <literal>\maketitle</literal>.</para>
 907                 <note><para>Does not apply to <sgmltag class="element">article</sgmltag>s within <sgmltag class="element">book</sgmltag>s.</para></note>
 908                 <para>By default, uses LaTeX <literal>\maketitle</literal> with the 'empty' pagestyle
 909                 for the first page. The page style of subsequent pages is determined by
 910                 <xref linkend="template.generate.latex.pagestyle"/>.</para>
 911         </refdescription>
 912     </doc:param>
 913     <xsl:variable name="latex.maketitle">
 914         <xsl:text>{\maketitle</xsl:text>
 915         <xsl:call-template name="generate.latex.pagestyle"/>
 916         <xsl:text>\thispagestyle{empty}}&#10;</xsl:text>
 917     </xsl:variable>
 918
 919
 920     <doc:param name="latex.article.end" xmlns="">
 921         <refpurpose> Controls what is output at the end of the article. Basically the <literal>\end{document}</literal>
 922             command, with some markup comments. </refpurpose>
 923         <refdescription>
 924         </refdescription>
 925     </doc:param>
 926     <xsl:variable name="latex.article.end">
 927         <xsl:text>&#10;</xsl:text>
 928         <xsl:text>% --------------------------------------------&#10;</xsl:text>
 929         <xsl:text>% End of document&#10;</xsl:text>
 930         <xsl:text>% --------------------------------------------&#10;</xsl:text>
 931         <xsl:text>\end{document}&#10;</xsl:text>
 932     </xsl:variable>
 933
 934
 935
 936 </xsl:stylesheet>
 937