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

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