docs-xml/xslt/db2latex-xsl/xsl/param-switch.mod.xsl

   1 <?xml version='1.0'?>
   2 <!DOCTYPE xsl:stylesheet [ <!ENTITY % xsldoc.ent SYSTEM "./xsldoc.ent"> %xsldoc.ent; ]>
   3 <!--############################################################################
   4 |       $Id: param-switch.mod.xsl,v 1.17 2004/01/31 11:52:31 j-devenish Exp $
   5 + ############################################################################## -->
   6
   7 <xsl:stylesheet
   8         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         <doc:reference id="param-switch" xmlns="">
  13                 <referenceinfo>
  14                         <releaseinfo role="meta">
  15                                 $Id: param-switch.mod.xsl,v 1.17 2004/01/31 11:52:31 j-devenish Exp $
  16                         </releaseinfo>
  17                         <authorgroup>
  18                                 &ramon;
  19                                 &james;
  20                         </authorgroup>
  21                         <copyright>
  22                                 <year>2000</year><year>2001</year><year>2002</year><year>2003</year><year>2004</year>
  23                                 <holder>Ramon Casellas</holder>
  24                         </copyright>
  25                         <revhistory>
  26                                 <doc:revision rcasver="1.1">&rev_2003_05;</doc:revision>
  27                         </revhistory>
  28                 </referenceinfo>
  29                 <title>Parameters: &DB2LaTeX; Switches <filename>param-switch.mod.xsl</filename></title>
  30                 <partintro>
  31                         <para>
  32
  33                         The values of parameters in this file are used to influence
  34                         the behaviour of &DB2LaTeX; templates through the selection
  35                         of pre-defined options.
  36                         All parameter names begin with <quote>latex.</quote>.
  37
  38                         </para>
  39                         <note>
  40                                 <para>
  41
  42                                 In some stylesheets, tests of parameter values use
  43                                 <quote>!=0</quote> logic. However, &DB2LaTeX; uses
  44                                 <quote>=1</quote> logic. This means that empty parameters are
  45                                 <quote>off</quote> in &DB2LaTeX; but <quote>on</quote> in those
  46                                 other stylesheets. The <ulink
  47                                 url="http://www.w3.org">XPath</ulink> values
  48                                 <quote>true()</quote> and <quote>false()</quote> work as
  49                                 expected.
  50
  51                                 </para>
  52                         </note>
  53                 </partintro>
  54         </doc:reference>
  55
  56         <doc:param xmlns="">
  57         <refpurpose> Control the display of <doc:db basename="caption">captions</doc:db> in lists of figures.  </refpurpose>
  58         <doc:description>
  59                 <para>
  60                 By default, lists of figures (see <xref linkend="template.lot"/>)
  61                 will include both figure <doc:db basename="title">titles</doc:db> and mediaobject <doc:db basename="caption">captions</doc:db>.
  62                 This is useful for readers, as they have a full description of each figure.
  63                 However, it is impractical for large documents because the list
  64                 of figures will occupy too many pages.
  65                 </para>
  66                 <para>
  67                 This variable, when set to '1', authorises DB2LaTeX to include
  68                 mediaobject captions in lists of figures. It is enabled by default.
  69                 When set to '0', lists of figures will contain only the
  70                 titles of figures.
  71                 </para>
  72         </doc:description>
  73         </doc:param>
  74         <xsl:param name="latex.caption.lot.titles.only">1</xsl:param>
  75
  76         <doc:param xmlns="">
  77         <refpurpose>
  78                 Control the output of the \bibliography{.bib}.
  79         </refpurpose>
  80         <doc:description>
  81                 <para>The value of this parameter is output.</para>
  82                 <para>An example is <quote><filename>citations.bib</filename></quote>,
  83                 if your BibTeX file has that name.</para>
  84         </doc:description>
  85         </doc:param>
  86         <xsl:param name="latex.bibfiles"></xsl:param>
  87
  88     <doc:param xmlns="">
  89         <refpurpose> Controls the output of LaTeX packages and commands to support
  90             documents with math commands and environments..</refpurpose>
  91         <doc:description>
  92             <para>If this parameter is set to 1, the stylesheets generate code to
  93                 <emphasis>DEFAULT: 1</emphasis> Only more code is generated.
  94             </para>
  95         </doc:description>
  96     </doc:param>
  97         <xsl:param name="latex.math.support">1</xsl:param>
  98
  99     <doc:param xmlns="">
 100         <refpurpose> Controls  if the revision history table is generated as the first document
 101             table.
 102         </refpurpose>
 103         <doc:description>
 104             <para>If this parameter is set to 1, the stylesheets generate code to
 105                 <emphasis>DEFAULT: 1</emphasis> Only more code is generated.
 106             </para>
 107         </doc:description>
 108     </doc:param>
 109         <xsl:param name="latex.output.revhistory">1</xsl:param>
 110
 111     <doc:template name="latex.fancybox.options" xmlns="">
 112         <refpurpose> Options for fancybox </refpurpose>
 113         <doc:description>
 114                         <!--
 115                         <xsl:if test="@role">
 116                                 <xsl:choose>
 117                                         <xsl:when test="@role='small'">
 118                                                 <xsl:text>,fontsize=\small</xsl:text>
 119                                         </xsl:when>
 120                                         <xsl:when test="@role='large'">
 121                                                 <xsl:text>,fontsize=\large</xsl:text>
 122                                         </xsl:when>
 123                                 </xsl:choose>
 124                         </xsl:if>
 125                         -->
 126                         <para>
 127                                 <doc:todo>Undocumented.</doc:todo>
 128                         </para>
 129         </doc:description>
 130     </doc:template>
 131     <xsl:template name="latex.fancybox.options">
 132         </xsl:template>
 133
 134     <doc:param xmlns="">
 135         <refpurpose> Controls the output of LaTeX commands to support the generation
 136             of PDF files.</refpurpose>
 137         <doc:description>
 138             <para>If this parameter is set to 1, the stylesheets generate code to
 139                 detect if it is either <literal>latex</literal> or <literal>pdflatex</literal>
 140                 the shell command that is being used to compile the LaTeX text file. Some
 141                 packages (<literal>graphicx</literal>, <literal>hyperref</literal>) are used
 142                 with the right parameters. Finally, the graphic extensions declared, to use in
 143                 <literal>\includegraphics</literal> commands depends also on which command is
 144                 being used. If this parameter is set to zero, such code is not generated (which
 145                 does not mean that the file cannot compile with pdflatex, but some strange issues
 146                 may appear). <emphasis>DEFAULT: 1</emphasis> Only more code is generated.
 147             </para>
 148         </doc:description>
 149     </doc:param>
 150         <xsl:param name="latex.pdf.support">1</xsl:param>
 151
 152         <doc:param xmlns="">
 153                 <refpurpose> Enable the generation of indexterms </refpurpose>
 154                 <doc:description><para>Support index generation.</para></doc:description>
 155         </doc:param>
 156         <xsl:param name="latex.generate.indexterm">1</xsl:param>
 157
 158         <doc:param xmlns="">
 159         <refpurpose> DB2LaTeX hyphenation linebreak tricks </refpurpose>
 160         <doc:description>
 161                 <para>
 162                 Usually, LaTeX does not perform hyphenation in <quote>teletype</quote> (monospace)
 163                 text. This can lead to formatting problems. But certain monospace texts, such as
 164                 URLs and filenames, have <quote>natural</quote> breakpoints such as full stops
 165                 and slashes. DB2LaTeX's <quote>tttricks</quote> exploit a hyphenation trick in
 166                 order to provide line wrapping in the middle of monospace text. Set this to '1'
 167                 to enable these tricks (they are not enabled by default). See also the FAQ.
 168                 </para>
 169         </doc:description>
 170         </doc:param>
 171         <xsl:param name="latex.hyphenation.tttricks">0</xsl:param>
 172
 173         <doc:param xmlns="">
 174                 <refpurpose> Decimal point for &LaTeX; tables </refpurpose>
 175                 <doc:description>
 176                         <para>
 177
 178                         This is a non-localisable character that may be used
 179                         for decimal alignment of &LaTeX; tables.
 180
 181                         </para>
 182                 </doc:description>
 183         </doc:param>
 184         <xsl:param name="latex.decimal.point"/>
 185
 186         <doc:param xmlns="">
 187                 <refpurpose>Toggle the trimming of leading and trailing whitespace in verbatim environments </refpurpose>
 188                 <doc:description><para>
 189                         In verbatim environments such as <doc:db>programlisting</doc:db> and <doc:db>screen</doc:db>,
 190                         it can be useful to trim leading and trailing whitespace. However, this is not compliant
 191                         with The Definitive Guide.
 192                 </para></doc:description>
 193         </doc:param>
 194         <xsl:param name="latex.trim.verbatim">0</xsl:param>
 195
 196         <doc:param xmlns="">
 197                 <refpurpose>Toggle the use of the <productname>ltxtable</productname> LaTeX package</refpurpose>
 198                 <doc:description>
 199                 <note><para>
 200                 This is not implemented as true ltxtable support, yet.
 201                 It uses longtable until we can integrate proper ltxtable support.
 202                 One the feature is supported, it should probably be enabled by
 203                 default!
 204                 </para></note>
 205                 <para>If this package is used then tables will be have the capability
 206                 to run over multiple pages when necessary.</para>
 207                 <warning><para>
 208                 Cells spanning multiple columns may require extra passes with LaTeX
 209                 in order for column widths to 'converge'.
 210                 </para></warning>
 211                 </doc:description>
 212         </doc:param>
 213         <xsl:param name="latex.use.ltxtable">0</xsl:param>
 214
 215         <doc:param xmlns="">
 216                 <refpurpose>Toggle the use of the <productname>longtable</productname> LaTeX package</refpurpose>
 217                 <doc:description>
 218                         <para>
 219                                 Enabling this option allows <doc:db
 220                                 basename="simplelist">simplelists</doc:db> to run over multiple
 221                                 pages. In the future, it will be superseded by <xref
 222                                 linkend="param.latex.use.ltxtable"/>.
 223                         </para>
 224                 </doc:description>
 225         </doc:param>
 226         <xsl:param name="latex.use.longtable">0</xsl:param>
 227
 228         <doc:param xmlns="">
 229                 <refpurpose>Toggle the use of the <productname>overpic</productname> LaTeX package</refpurpose>
 230                 <doc:description><para>Facilitates overlays (for callouts).</para></doc:description>
 231         </doc:param>
 232         <xsl:param name="latex.use.overpic">1</xsl:param>
 233
 234         <doc:param xmlns="">
 235                 <refpurpose>Toggle the use of the <productname>umoline</productname> LaTeX package</refpurpose>
 236                 <doc:description><para>Provide underlining.</para></doc:description>
 237         </doc:param>
 238         <xsl:param name="latex.use.umoline">0</xsl:param>
 239
 240         <doc:param xmlns="">
 241                 <refpurpose>Toggle the use of the <productname>url</productname> LaTeX package</refpurpose>
 242                 <doc:description><para>Provide partial support for hyperlinks.</para></doc:description>
 243         </doc:param>
 244         <xsl:param name="latex.use.url">1</xsl:param>
 245
 246         <doc:param xmlns="">
 247                 <refpurpose>Toggle the use of the the <quote>draft</quote> preamble</refpurpose>
 248                 <doc:description><para>&DB2LaTeX; provides a number of draft-mode features to aid
 249                 the refinement of documents. Normally, this mode is enabled or disabled according
 250                 to the <sgmltag class='attribute'>status</sgmltag> attribute of the top-level
 251                 <doc:db>book</doc:db> or <doc:db>article</doc:db> element. However, this variable
 252                 will take precedence when it is not empty. It is empty by default.</para>
 253                 </doc:description>
 254                 <doc:samples>
 255                         <simplelist type='inline'>
 256                                 &test_index_draft;
 257                                 &test_draft;
 258                         </simplelist>
 259                 </doc:samples>
 260         </doc:param>
 261         <xsl:param name="latex.is.draft"/>
 262
 263         <doc:param xmlns="">
 264                 <refpurpose>Toggle the use of the <productname>varioref</productname> LaTeX package</refpurpose>
 265                 <doc:description><para><productname>varioref</productname> seemed like a good idea at first,
 266                 but we not realise it does understand &DocBook; gentext localisations. By default, it is enabled
 267                 when <xref linkend="param.insert.xref.page.number"/> is enabled.</para></doc:description>
 268         </doc:param>
 269         <xsl:param name="latex.use.varioref">
 270                 <xsl:if test="$insert.xref.page.number='1'">1</xsl:if>
 271         </xsl:param>
 272
 273         <doc:param xmlns="">
 274                 <refpurpose>Toggle the use of the <productname>fancyhdr</productname> LaTeX package</refpurpose>
 275                 <doc:description><para>Provides page headers and footers. Disabling support for
 276                 this package will make headers and footer go away.</para></doc:description>
 277         </doc:param>
 278         <xsl:param name="latex.use.fancyhdr">1</xsl:param>
 279
 280         <doc:param xmlns="">
 281                 <refpurpose> Control the inclusion of chapter titles in <doc:db basename="lot">lots</doc:db> </refpurpose>
 282                 <doc:description>
 283                         <para>
 284                                 When this variable is set, lists of tables and lists of figures
 285                                 will be grouped and labeled by chapter.
 286                         </para>
 287                 </doc:description>
 288         </doc:param>
 289         <xsl:param name="latex.bridgehead.in.lot">1</xsl:param>
 290
 291         <doc:param xmlns="">
 292                 <refpurpose> Configure the application of truncation partitions </refpurpose>
 293                 <doc:description>
 294                         <para>
 295
 296                                 For <xref linkend="param.latex.fancyhdr.truncation.partition"/>, the
 297                                 partition can be modulated in a left-right fashion or an
 298                                 inside-outside fashion. Use <quote>lr</quote> for left-right,
 299                                 all other values are inside-outside (<quote>io</quote> is
 300                                 suggested). The default is <quote>io</quote>, because this
 301                                 matches <xref linkend="param.latex.documentclass.book"/>.
 302
 303                         </para>
 304                 </doc:description>
 305         </doc:param>
 306         <xsl:param name="latex.fancyhdr.truncation.style">io</xsl:param>
 307
 308         <doc:param xmlns="">
 309                 <refpurpose> Configure the width of header portions on each page </refpurpose>
 310                 <doc:description>
 311                         <para>
 312
 313                                 It is possible that the titles of chapter or sections will
 314                                 occupy more than the width of a single line. When this variable
 315                                 is empty, headers will be allowed to occupy multiple lines.
 316                                 However, it is possible that the left-hand portion of a header
 317                                 will collide with the right-hand portion of header. To prevent
 318                                 this, headers can be truncated if they exceed an allowable
 319                                 width. When this variables is set to a number from zero to 100,
 320                                 the left-hand (or inside) side of each header will have that
 321                                 width reserved. The right-hand (or outside) side will have the
 322                                 remainder. A common option is to set this variable to zero and
 323                                 set <xref linkend="param.latex.fancyhdr.truncation.style"/> to
 324                                 <quote>io</quote>.
 325
 326                         </para>
 327                 </doc:description>
 328         </doc:param>
 329         <xsl:param name="latex.fancyhdr.truncation.partition">50</xsl:param>
 330
 331         <doc:param xmlns="">
 332                 <refpurpose> Section/chapter style for fancy headers </refpurpose>
 333                 <doc:description>
 334                         <para>
 335
 336                                 &DB2LaTeX; comes with some pre-configured styles for page
 337                                 headers. These include <quote></quote>, the default, which is
 338                                 determined by the <productname>fancyhdr</productname> package.
 339                                 Another option is <quote>natural</quote>, in which both the
 340                                 chapter and section are shown on each page with their numbers.
 341                                 An alternative is to provide your own <xref
 342                                 linkend="template.generate.latex.pagestyle"/> template with a
 343                                 value such as <literal>\pagestyle{headings}</literal> (the
 344                                 <quote>headings</quote> page style, which is not a
 345                                 <productname>fancyhdr</productname> style, shows page numbers
 346                                 in the headers whereas the others show page numbers in the
 347                                 footers).
 348
 349                         </para>
 350                 </doc:description>
 351         </doc:param>
 352         <xsl:param name="latex.fancyhdr.style"/>
 353
 354         <doc:param xmlns="">
 355                 <refpurpose>Toggle the use of the <productname>parskip</productname> &latex; package</refpurpose>
 356                 <doc:description>
 357                         <para>Use <quote>block</quote> paragraph style instead of indentation.</para>
 358                 </doc:description>
 359                 <doc:notes>
 360                         <para><productname>parskip</productname> introduces vertical whitespace between
 361                         paragraphs and list items. However, &db2latex;'s <doc:db>toc</doc:db> and
 362                         <doc:db>lot</doc:db> templates attempt to suppress this whitespace.</para>
 363                         <para>When this option is off, you may wish to investigate <xref linkend="param.latex.use.noindent"/>.</para>
 364                 </doc:notes>
 365                 <doc:seealso>
 366                         <itemizedlist>
 367                                 <listitem><simpara><xref linkend="template.para"/></simpara></listitem>
 368                         </itemizedlist>
 369                 </doc:seealso>
 370         </doc:param>
 371         <xsl:param name="latex.use.parskip">0</xsl:param>
 372
 373         <doc:param xmlns="">
 374                 <refpurpose>Toggle the use of <function condition="latex">noindent</function> commands</refpurpose>
 375                 <doc:description>
 376                         <para>
 377
 378                         When this parameter is 1, &DB2LaTeX; will deliberately insert
 379                         noindents at particular locations within your document.
 380
 381                         </para>
 382                 </doc:description>
 383                 <doc:notes>
 384                         <para>
 385
 386                         When traditional &LaTeX; paragraph indentation and spacing is used,
 387                         it is often necessary to use <function
 388                         condition="latex">noindent</function> after certain block-formatted
 389                         elements (e.g. <doc:db>itemizedlist</doc:db>). Let us know if we
 390                         need to insert more <function
 391                         condition="latex">noindent</function>---so far, there are few
 392                         places where we make use of it.
 393
 394                         </para>
 395                         <para>
 396
 397                         By default, this option will be turned on when <xref
 398                         linkend="param.latex.use.parskip"/> is <emphasis>off</emphasis> and
 399                         will be turned off when <xref linkend="param.latex.use.parskip"/>
 400                         is <emphasis>on</emphasis>.
 401
 402                         </para>
 403                 </doc:notes>
 404                 <doc:seealso>
 405                         <itemizedlist>
 406                                 <listitem><simpara><xref linkend="param.latex.use.parskip"/></simpara></listitem>
 407                         </itemizedlist>
 408                 </doc:seealso>
 409         </doc:param>
 410         <xsl:param name="latex.use.noindent">
 411                 <xsl:choose>
 412                         <xsl:when test="$latex.use.parskip=1">
 413                                 <xsl:value-of select="0"/>
 414                         </xsl:when>
 415                         <xsl:otherwise>
 416                                 <xsl:value-of select="1"/>
 417                         </xsl:otherwise>
 418                 </xsl:choose>
 419         </xsl:param>
 420
 421         <doc:param xmlns="">
 422                 <refpurpose>Toggle the use of the <productname>subfigure</productname> LaTeX package</refpurpose>
 423                 <doc:description><para>Used to provide nice layout of multiple mediaobjects in figures.</para></doc:description>
 424         </doc:param>
 425         <xsl:param name="latex.use.subfigure">1</xsl:param>
 426
 427         <doc:param xmlns="">
 428                 <refpurpose>Toggle the use of the <productname>rotating</productname> LaTeX package</refpurpose>
 429                 <doc:description><para>Undocumented.</para></doc:description>
 430         </doc:param>
 431         <xsl:param name="latex.use.rotating">1</xsl:param>
 432
 433         <doc:param xmlns="">
 434                 <refpurpose>Toggle the use of the <productname>tabularx</productname> LaTeX package</refpurpose>
 435                 <doc:description><para>Used to provide certain table features. Has some incompatabilities
 436                 with packages, but also solves some conflicts that the regular tabular
 437                 environment has.</para></doc:description>
 438         </doc:param>
 439         <xsl:param name="latex.use.tabularx">1</xsl:param>
 440
 441         <doc:param xmlns="">
 442                 <refpurpose>Toggle the use of the <productname>dcolumn</productname> LaTeX package</refpurpose>
 443                 <doc:description>
 444                 <warning><para>
 445                         Currently, <productname>dcolumn</productname> support does not function
 446                         correctly.
 447                 </para></warning>
 448                 <para>
 449                         <productname>dcolumn</productname> provides support for the <literal>char</literal>
 450                         alignment of table cells.
 451                 </para>
 452                 </doc:description>
 453                 <doc:seealso>
 454                         <itemizedlist>
 455                                 <listitem><simpara><xref linkend="param.latex.decimal.point"/></simpara></listitem>
 456                         </itemizedlist>
 457                 </doc:seealso>
 458         </doc:param>
 459         <xsl:param name="latex.use.dcolumn">0</xsl:param>
 460
 461         <doc:param xmlns="">
 462                 <refpurpose>Toggle the use of the <productname>hyperref</productname> LaTeX package</refpurpose>
 463                 <doc:description><para>This is used extensively for hyperlinking within documents.</para></doc:description>
 464         </doc:param>
 465         <xsl:param name="latex.use.hyperref">1</xsl:param>
 466
 467         <doc:param xmlns="">
 468                 <refpurpose>Toggle the use of the <productname>fancybox</productname> LaTeX package</refpurpose>
 469                 <doc:description><para>This is essential for admonitions.</para></doc:description>
 470         </doc:param>
 471         <xsl:param name="latex.use.fancybox">1</xsl:param>
 472
 473         <doc:param xmlns="">
 474                 <refpurpose>Toggle the use of the <productname>fancyvrb</productname> LaTeX package</refpurpose>
 475                 <doc:description><para>Provides support for tabbed whitespace in verbatim environments.
 476                 See also <xref linkend="param.latex.fancyvrb.tabsize"/>.</para></doc:description>
 477         </doc:param>
 478         <xsl:param name="latex.use.fancyvrb">1</xsl:param>
 479
 480         <doc:param xmlns="">
 481                 <refpurpose>Toggle the use of the <productname>isolatin1</productname> LaTeX package</refpurpose>
 482                 <doc:description>
 483                         <warning><para>
 484                         This option is deprecated. See <xref linkend="param.latex.inputenc"/>.
 485                         </para></warning>
 486                 </doc:description>
 487         </doc:param>
 488         <xsl:param name="latex.use.isolatin1">0</xsl:param>
 489
 490         <doc:param xmlns="">
 491                 <refpurpose> Choose whether to use the <productname>unicode</productname> LaTeX package</refpurpose>
 492                 <doc:description><para>See the <productname>unicode</productname> documentation for details.</para></doc:description>
 493         </doc:param>
 494         <xsl:param name="latex.use.ucs">0</xsl:param>
 495
 496         <doc:param xmlns="">
 497         <refpurpose> Control which references are cited in the bibliography </refpurpose>
 498         <doc:description>
 499                 <para>
 500                 The DB2LaTeX generated bibliography (bibitems) may either
 501                 include all biblioentries found in the document, or only thee ones explicitly
 502                 cited with <sgmltag class="element">citation</sgmltag>.
 503                 </para>
 504             <para>Two values are possible: <quote>all</quote> or <quote>cited</quote>.</para>
 505         </doc:description>
 506         </doc:param>
 507         <xsl:param name="latex.biblio.output">all</xsl:param>
 508
 509         <doc:param xmlns="">
 510         <refpurpose> Control bibliographic citation style </refpurpose>
 511         <doc:description>
 512                 <para>By default, this value is empty. Alternatively, a special value
 513                 is recognised: <quote>ieee</quote> (or <quote>IEEE</quote>).</para>
 514         </doc:description>
 515         </doc:param>
 516         <xsl:param name="latex.biblioentry.style"/>
 517
 518         <doc:param xmlns="">
 519         <refpurpose> Improved typesetting of captions  </refpurpose>
 520         <doc:description>
 521                 <para>
 522                 DB2LaTeX supports <link linkend="param.formal.title.placement">$formal.title.placement</link>
 523                 as a mechanism for choosing whether captions will appear above or below the objects they describe.
 524                 <!--
 525                 ($formal.title.placement is described in the <ulink
 526                 url="http://docbook.sourceforge.net/release/xsl/current/doc/html/formal.title.placement.html">DocBook
 527                 XSL Stylesheet HTML Parameter Reference</ulink>.)
 528                 -->
 529                 However, LaTeX will often produce an ugly result when captions occur
 530                 above their corresponding content. This usually arises because of
 531                 unsuitable \abovecaptionskip and \belowcaptionskip.
 532                 </para>
 533                 <para>
 534                 This variable, when set to '1', authorises DB2LaTeX to swap the caption
 535                 'skip' lengths when a caption is placed <emphasis>above</emphasis> its
 536                 corresponding content. This is enabled by default.
 537                 </para>
 538         </doc:description>
 539         </doc:param>
 540         <xsl:param name="latex.caption.swapskip">1</xsl:param>
 541
 542         <doc:param xmlns="">
 543         <refpurpose> Control <sgmltag class="element">imagedata</sgmltag> selection. </refpurpose>
 544         <doc:description>
 545                 <para>This controls how DB2LaTeX behaves when a <sgmltag class="element">mediaobject</sgmltag> contains
 546                 multiple <sgmltag class="element">imagedata</sgmltag>. When non-empty, DB2LaTeX will exclude
 547                 imagedata that have a format no listed within this variable.</para>
 548         </doc:description>
 549         </doc:param>
 550         <xsl:param name="latex.graphics.formats"></xsl:param>
 551
 552         <doc:param xmlns="">
 553         <refpurpose> Control Unicode character handling. </refpurpose>
 554         <doc:description>
 555                 <para>
 556                 Normally, XSLT processors will convert SGML character entities into
 557                 Unicode characters and DB2LaTeX doesn't have much chance to do anything
 558                 toward converting them to LaTeX equivalents. We do not yet know how we
 559                 can solve this problem best.
 560                 </para>
 561                 <para>
 562                 Proposed values: 'catcode', 'unicode', 'extension'.
 563                 Currently only 'catcode' is supported. All other values will
 564                 cause no special handling except for certain mappings in MathML.
 565                 In future, perhaps the 'unicode' LaTeX package could be of assistance.
 566                 'Extension' could be an XSLT extension that handles the characters
 567                 using a mapping table.
 568                 </para>
 569         </doc:description>
 570         </doc:param>
 571         <xsl:param name="latex.entities"></xsl:param>
 572
 573         <doc:param xmlns="">
 574         <refpurpose> Control the use of <sgmltag class="attribute">otherterm</sgmltag> attributes </refpurpose>
 575                 <doc:description>
 576                         <para>
 577                                 When a <doc:db>glosssee</doc:db> or <doc:db>glossseealso</doc:db> element contains
 578                                 both an <quote>otherterm</quote> attribute <emphasis>and</emphasis> content templates,
 579                                 this variable elects which will be the source of the displayed text. By default,
 580                                 this variable is enabled and a cross-reference to the otherwterm will be
 581                                 generated (i.e. content templates will be ignored).
 582                         </para>
 583                 </doc:description>
 584         </doc:param>
 585         <xsl:param name="latex.otherterm.is.preferred">1</xsl:param>
 586
 587         <doc:param xmlns="">
 588         <refpurpose> Control the use of <sgmltag class="element">alt</sgmltag> text </refpurpose>
 589         <doc:description>
 590                 <para>
 591                 By default, DB2LaTeX assumes that <sgmltag class="element">alt</sgmltag>
 592                 text should be typeset in preference to any
 593                 <sgmltag class="element">mediaobject</sgmltag>s.
 594                 </para>
 595         </doc:description>
 596                 <doc:seealso>
 597                         <itemizedlist>
 598                                 <listitem><simpara><xref linkend="param.tex.math.in.alt"/></simpara></listitem>
 599                         </itemizedlist>
 600                 </doc:seealso>
 601         </doc:param>
 602         <xsl:param name="latex.alt.is.preferred">1</xsl:param>
 603
 604         <doc:param xmlns="">
 605         <refpurpose> Whether to apply templates for component titles. </refpurpose>
 606         <doc:description>
 607                 <para>
 608                 Controls whether component titles will be generated by
 609                 applying templates or by conversion to string values.
 610                 When enabled, templates will be applied. This enables template
 611                 expression in titles but may have problematic side-effects such
 612                 as nested links.
 613                 </para>
 614                 <note>
 615                         <para>
 616                                 This variable does not influence all <sgmltag class="element">title</sgmltag>
 617                                 elements. Some may have their own configuration variables or be non-configurable.
 618                         </para>
 619                 </note>
 620         </doc:description>
 621         </doc:param>
 622         <xsl:param name="latex.apply.title.templates">1</xsl:param>
 623
 624         <doc:param xmlns="">
 625         <refpurpose> Whether to apply templates for admonition titles. </refpurpose>
 626         <doc:description>
 627                 <para>
 628                 Controls whether admonition titles will be generated by
 629                 applying templates or by conversion to string values.
 630                 When enabled, templates will be applied.
 631                 </para>
 632         </doc:description>
 633         </doc:param>
 634         <xsl:param name="latex.apply.title.templates.admonitions">1</xsl:param>
 635
 636         <doc:param xmlns="">
 637         <refpurpose> Whether to delimit URLs with quotation characters </refpurpose>
 638         <doc:description>
 639                 <para>
 640                 When this option is enabled, gentext quotation characters
 641                 (urlstartquote and urlendquote) are used to delimit the
 642                 URLs when they are displayed as part of <doc:db>ulink</doc:db>
 643                 formatting. The delimiters do not form part of the URL or
 644                 hyperlink per se.
 645                 </para>
 646         </doc:description>
 647         </doc:param>
 648         <xsl:param name="latex.url.quotation">1</xsl:param>
 649
 650         <doc:param xmlns="">
 651                 <refpurpose> Control string comparison for <doc:db basename="ulink">ulinks</doc:db> </refpurpose>
 652                 <doc:description>
 653                         <para>
 654
 655                         The formatting of a <doc:db>ulink</doc:db> element varies according
 656                         to whether its <sgmltag class="attribute">url</sgmltag> attribute
 657                         differs from its content. When this option is enabled, the
 658                         comparison between these two values ignores the
 659                         <quote>protocol</quote> portion of the URL (that which occurs
 660                         before ':' or '://', as a concession to HTTP URLs). For example,
 661                         when this option is enabled, <quote>a.b.c/d</quote> would be
 662                         considered equivalent to <quote>http://a.b.c/d</quote> and
 663                         <quote>file:a.b.c/d</quote>.
 664
 665                         </para>
 666                 </doc:description>
 667         </doc:param>
 668         <xsl:param name="latex.ulink.protocols.relaxed">
 669       <xsl:choose>
 670          <xsl:when test="$ulink.protocols.relaxed!=''">
 671             <xsl:message>Warning: $ulink.protocols.relaxed was a misnomer: use $latex.ulink.protocols.relaxed instead</xsl:message>
 672             <xsl:value-of select="$ulink.protocols.relaxed"/>
 673          </xsl:when>
 674                         <xsl:otherwise>
 675             <xsl:value-of select="0"/>
 676                         </xsl:otherwise>
 677       </xsl:choose>
 678    </xsl:param>
 679    <xsl:param name="ulink.protocols.relaxed"/>
 680
 681         <doc:param xmlns="">
 682                 <refpurpose> Control the suppression of headers/footers on blank pages in double-side documents </refpurpose>
 683                 <doc:description>
 684                         <para>
 685
 686                         When this option is enabled, &DB2LaTeX; will attempt to
 687                         suppress headers and footers on pages that contain no
 688                         other content (i.e. left-handed pages in a double-sided
 689                         document). When this option is disabled, &DB2LaTeX; does
 690                         not interfere with the default appearance of headers and
 691                         footers.
 692
 693                         </para>
 694                 </doc:description>
 695         </doc:param>
 696         <xsl:param name="latex.suppress.blank.page.headers">1</xsl:param>
 697
 698 </xsl:stylesheet>