docs/xslt/db2latex-xsl/xsl/param-common.mod.xsl

   1 <?xml version='1.0'?>
   2 <!DOCTYPE xsl:stylesheet [ <!ENTITY % xsldoc.ent SYSTEM "./xsldoc.ent"> %xsldoc.ent; ]>
   3 <!--############################################################################
   4 |       $Id: param-common.mod.xsl,v 1.12 2004/01/26 13:25:17 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-common" xmlns="">
  13                 <referenceinfo>
  14                         <releaseinfo role="meta">
  15                                 $Id: param-common.mod.xsl,v 1.12 2004/01/26 13:25:17 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: Common Options <filename>param-common.mod.xsl</filename></title>
  30                 <partintro>
  31                         <para>
  32
  33                         This file contains parameters that are shared with other XSL
  34                         stylesheets such as those as <ulink
  35                         url="http://docbook.sourceforge.net"/> (see <citetitle>Parameter
  36                         References</citetitle> in the <ulink
  37                         url="http://docbook.sourceforge.net/release/xsl/current/doc/reference.html">DocBook
  38                         XSL Stylesheet Reference Documentation</ulink>). These are
  39                         parameters are honoured so that you can coordinate your XHTML or FO
  40                         stylesheets with &DB2LaTeX;.
  41
  42                         </para>
  43                         <note>
  44                                 <para>
  45
  46                                 In some stylesheets, tests of parameter values use
  47                                 <quote>!=0</quote> logic. However, &DB2LaTeX; uses
  48                                 <quote>=1</quote> logic. This means that empty parameters are
  49                                 <quote>off</quote> in &DB2LaTeX; but <quote>on</quote> in those
  50                                 other stylesheets. The <ulink
  51                                 url="http://www.w3.org">XPath</ulink> values
  52                                 <quote>true()</quote> and <quote>false()</quote> work as
  53                                 expected.
  54
  55                                 </para>
  56                         </note>
  57                 </partintro>
  58         </doc:reference>
  59
  60         <doc:param xmlns="">
  61                 <refpurpose> &LaTeX; location for admonition graphics </refpurpose>
  62                 <doc:description>
  63                         <para>The file path that will be passed to &LaTeX; in order to find admonition graphics.</para>
  64                         <para>An empty value suppresses the use of admonition graphics.</para>
  65                         <para>If your figures are in <quote>the current directory</quote> then use a value of
  66                         <quote>.</quote> (i.e. the full stop or period on its own) to signify this.</para>
  67                 </doc:description>
  68         </doc:param>
  69         <xsl:param name="admon.graphics.path">
  70                 <xsl:choose>
  71                         <xsl:when test="$latex.admonition.path!=''">
  72                                 <xsl:message>Warning: $latex.admonition.path is deprecated: use $admon.graphics.path instead</xsl:message>
  73                                 <xsl:value-of select="$latex.admonition.path"/>
  74                         </xsl:when>
  75                         <xsl:otherwise>
  76                                 <xsl:text>figures</xsl:text>
  77                         </xsl:otherwise>
  78                 </xsl:choose>
  79         </xsl:param>
  80         <xsl:param name="latex.admonition.path"/>
  81
  82         <doc:param xmlns="">
  83                 <refpurpose> Control the escaping of <doc:db>alt</doc:db> text </refpurpose>
  84                 <doc:description>
  85                         <para>
  86
  87                         Text within <doc:db>alt</doc:db> elements <!--within equation-type
  88                         elements--> is assumed to be valid &LaTeX; and is passed through
  89                         unescaped by default (though you should set its value to
  90                         <quote>plain</quote> or <quote>latex</quote>, which are considered
  91                         confirmative and equivalent by &DB2LaTeX;). If this is not
  92                         appropriate for your document, set this variable to the empty
  93                         value. If you use an explicit <sgmltag
  94                         class="attribute">role</sgmltag> attribute with the values
  95                         <quote>latex</quote> or <quote>tex</quote>, you need not concern
  96                         yourself with this variable. Alt text within equation-type
  97                         elements is currently assumed to be valid &LaTeX; regardless
  98                         of this variable (this is probably a bug!).
  99
 100                         </para>
 101                 </doc:description>
 102         </doc:param>
 103         <xsl:param name="tex.math.in.alt">
 104                 <xsl:if test="$latex.alt.is.latex!=''">
 105                         <xsl:message>Warning: $latex.alt.is.latex is deprecated: use $tex.math.in.alt instead</xsl:message>
 106                         <xsl:if test="$latex.alt.is.latex=1">
 107                                 <xsl:text>latex</xsl:text>
 108                         </xsl:if>
 109                 </xsl:if>
 110         </xsl:param>
 111         <xsl:param name="latex.alt.is.latex"/>
 112
 113         <doc:param xmlns="">
 114                 <refpurpose> Display <doc:db>remark</doc:db> and <doc:db>comment</doc:db> elements? </refpurpose>
 115                 <doc:description>
 116                         <para>
 117
 118                         Enables or disables the display of <doc:db basename="comment">comments</doc:db> and <doc:db basename="remark">remarks</doc:db>.
 119                         By default, this is equal to <xref linkend="param.latex.is.draft"/>.
 120
 121                         </para>
 122                 </doc:description>
 123         </doc:param>
 124         <xsl:param name="show.comments">
 125                 <xsl:value-of select="$latex.is.draft"/>
 126         </xsl:param>
 127
 128         <doc:param xmlns="">
 129                 <refpurpose> Control the display of <doc:db>othername</doc:db> elements in <doc:db basename="author">authors</doc:db> </refpurpose>
 130                 <doc:description>
 131                         <para>
 132
 133                         When disabled, <doc:db>othername</doc:db> elements will be suppressed when
 134                         <doc:db>author</doc:db> elements are formatted.
 135
 136                         </para>
 137                 </doc:description>
 138         </doc:param>
 139         <xsl:param name="author.othername.in.middle" select="1"/>
 140
 141         <doc:param xmlns="">
 142                 <refpurpose> Separator for bibliography items </refpurpose>
 143                 <doc:description>
 144                         <para><doc:todo>This parameter is under review.</doc:todo></para>
 145                 </doc:description>
 146         </doc:param>
 147         <xsl:param name="biblioentry.item.separator">, </xsl:param>
 148
 149         <doc:param xmlns="">
 150                 <refpurpose> Cull table-of-contents entries that are deeply nested </refpurpose>
 151                 <doc:description>
 152                         <para>Specifies the maximum depth before sections are omitted from the table of contents.</para>
 153                 </doc:description>
 154         </doc:param>
 155         <xsl:param name="toc.section.depth">4</xsl:param>
 156
 157         <doc:param xmlns="">
 158                 <refpurpose> Control the automatic numbering of section, parts, and chapters </refpurpose>
 159                 <doc:description>
 160                         <para>
 161                         Specifies the maximum depth before sections cease to be uniquely numbered.
 162                         This is passed to &LaTeX; using the <literal>secnumdepth</literal> counter.
 163                         Therefore, it is possible to use a value of <quote>0</quote> (zero) to disable section numbering.
 164                         A value of <quote>-1</quote> will disable the numbering of parts and chapters, too.
 165                         </para>
 166                 </doc:description>
 167         </doc:param>
 168         <xsl:param name="section.depth">4</xsl:param>
 169
 170         <doc:param xmlns="">
 171                 <refpurpose> Default filename extension for <function condition="latex">includegraphics</function> </refpurpose>
 172                 <doc:description>
 173                         <para>
 174                                 Specify the &LaTeX; search parameters for graphics filenames.
 175                                 If empty, &DB2LaTeX; will specify some explicit defaults.
 176                         </para>
 177                 </doc:description>
 178         </doc:param>
 179         <xsl:param name="graphic.default.extension"/>
 180
 181         <doc:param xmlns="">
 182                 <refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose>
 183                 <doc:description>
 184                         <para>
 185
 186                         This controls how &DB2LaTeX; behaves when a <doc:db>figure</doc:db>
 187                         contains multiple <doc:db
 188                         basename="mediaobject">mediaobjects</doc:db>. When enabled,
 189                         &DB2LaTeX; will prefer the <sgmltag>mediaobject</sgmltag> with the
 190                         <quote>latex</quote>, <quote>tex</quote> or <xref
 191                         linkend="param.preferred.mediaobject.role"/> role, if any.
 192
 193                         </para>
 194                 </doc:description>
 195         </doc:param>
 196         <xsl:param name="use.role.for.mediaobject">1</xsl:param>
 197
 198         <doc:param xmlns="">
 199                 <refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose>
 200                 <doc:description>
 201                         <para>
 202
 203                         When <xref linkend="param.use.role.for.mediaobject"/> is enabled,
 204                         this variable can be used to specify the
 205                         <doc:db>mediaobject</doc:db> <sgmltag
 206                         class="attribute">role</sgmltag> that your document uses for
 207                         &LaTeX; output. &DB2LaTeX; will try to use this role before using
 208                         the <quote>latex</quote> or <quote>tex</quote> roles. For example,
 209                         some authors may choose to set this to
 210                         <quote><literal>pdf</literal></quote>.
 211
 212                         </para>
 213                 </doc:description>
 214         </doc:param>
 215         <xsl:param name="preferred.mediaobject.role"/>
 216
 217         <doc:param xmlns="">
 218                 <refpurpose> Specifies where formal component titles should occur </refpurpose>
 219                 <doc:description>
 220                         <para>
 221
 222                                 Titles for the formal object types (figure, example, quation,
 223                                 table, and procedure) can be placed before or after those
 224                                 objects. The keyword <quote>before</quote> is recognised. All
 225                                 other strings qualify as <quote>after</quote>.
 226
 227                         </para>
 228                 </doc:description>
 229         </doc:param>
 230         <xsl:param name="formal.title.placement">
 231                 figure not_before
 232                 example before
 233                 equation not_before
 234                 table before
 235                 procedure before
 236         </xsl:param>
 237
 238         <doc:param xmlns="">
 239                 <refpurpose> Control the appearance of page numbers in cross references </refpurpose>
 240                 <doc:description>
 241                         <para>
 242
 243                                 When enabled, <doc:db basename="xref">xrefs</doc:db> will
 244                                 include page numbers after their generated cross-reference
 245                                 text.
 246
 247                         </para>
 248                 </doc:description>
 249                 </doc:param>
 250         <xsl:param name="insert.xref.page.number">0</xsl:param>
 251
 252         <doc:param xmlns="">
 253                 <refpurpose> Control the display of URLs after <doc:db basename="ulink">ulinks</doc:db> </refpurpose>
 254                 <doc:description>
 255                         <para>
 256
 257                         When this option is enabled, and a ulink has a URL that is different
 258                         from the displayed content, the URL will be typeset after the content.
 259                         If the URL and content are identical, only one of them will appear.
 260                         Otherwise, the URL is hyperlinked and the content is not.
 261
 262                         </para>
 263                 </doc:description>
 264         </doc:param>
 265         <xsl:param name="ulink.show">1</xsl:param>
 266
 267         <doc:param xmlns="">
 268                 <refpurpose> Control the generation of footnotes for ulinks </refpurpose>
 269                 <doc:description>
 270                         <para>
 271
 272                         When this option is enabled, a <doc:db>ulink</doc:db> that has
 273                         content different to its URL will have an associated footnote. The
 274                         contents of the footnote will be the URL. If the ulink is within a
 275                         <doc:db>footnote</doc:db>, the URL is shown after the content.
 276
 277                         </para>
 278                 </doc:description>
 279         </doc:param>
 280         <xsl:param name="ulink.footnotes">0</xsl:param>
 281
 282         <doc:param xmlns="">
 283                 <refpurpose> Honour role as proxy for xrefstyle </refpurpose>
 284                 <doc:description>
 285                         <para>
 286
 287                         The <sgmltag class="attribute">xrefstyle</sgmltag> attribute is not
 288                         yet part of &DocBook; so the <sgmltag
 289                         class="attribute">role</sgmltag> attribute can be used until
 290                         xrefstyle is available for <doc:db>xref</doc:db> elements.
 291
 292                         </para>
 293                 </doc:description>
 294         </doc:param>
 295     <xsl:param name="use.role.as.xrefstyle">0</xsl:param>
 296
 297         <xsl:variable name="default-classsynopsis-language">java</xsl:variable>
 298         <doc:param xmlns="">
 299                 <refpurpose> Choose whether to include <doc:db>manvolnum</doc:db> in cross-references </refpurpose>
 300                 <doc:description>
 301                         <para>
 302
 303                                 When this option is enabled, <doc:db
 304                                 basename="manvolnum">manvolnums</doc:db> will be displayed when
 305                                 cross-referencing <doc:db
 306                                 basename="refentry">refentries</doc:db>.
 307
 308                         </para>
 309                 </doc:description>
 310         </doc:param>
 311         <xsl:param name="refentry.xref.manvolnum" select="1"/>
 312         <xsl:variable name="funcsynopsis.style">kr</xsl:variable>
 313         <xsl:variable name="funcsynopsis.decoration" select="1"/>
 314         <xsl:variable name="function.parens">0</xsl:variable>
 315         <doc:param xmlns="">
 316                 <refpurpose> Control the use of NAME headers </refpurpose>
 317                 <doc:description>
 318                         <para>
 319
 320                                 See <ulink url="http://docbook.sourceforge.net/release/xsl/current/doc/fo/refentry.generate.name.html"/>.
 321
 322                         </para>
 323                 </doc:description>
 324         </doc:param>
 325         <xsl:param name="refentry.generate.name" select="1"/>
 326         <xsl:param name="glossentry.show.acronym" select="'no'"/>
 327
 328         <xsl:variable name="section.autolabel" select="1"/>
 329         <xsl:variable name="section.label.includes.component.label" select="0"/>
 330         <xsl:variable name="chapter.autolabel" select="1"/>
 331         <xsl:variable name="preface.autolabel" select="0"/>
 332         <xsl:variable name="part.autolabel" select="1"/>
 333         <xsl:variable name="qandadiv.autolabel" select="1"/>
 334         <xsl:variable name="autotoc.label.separator" select="'. '"/>
 335         <xsl:variable name="qanda.inherit.numeration" select="1"/>
 336         <xsl:variable name="qanda.defaultlabel">number</xsl:variable>
 337
 338         <xsl:param name="punct.honorific" select="'.'"/>
 339         <xsl:param name="stylesheet.result.type" select="'xhtml'"/>
 340         <xsl:param name="use.svg" select="0"/>
 341         <xsl:param name="formal.procedures" select="1"/>
 342         <xsl:param name="xref.with.number.and.title" select="1"/>
 343         <xsl:param name="xref.label-title.separator">: </xsl:param>
 344         <xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param>
 345         <xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param>
 346         <xsl:template name="is.graphic.extension">
 347                 <xsl:message terminate="yes">Logic error: is.graphic.extension is unsupported.</xsl:message>
 348         </xsl:template>
 349         <xsl:template name="is.graphic.format">
 350                 <xsl:message terminate="yes">Logic error: is.graphic.format is unsupported.</xsl:message>
 351         </xsl:template>
 352         <xsl:template name="lookup.key">
 353                 <xsl:message terminate="yes">Logic error: lookup.key is unsupported.</xsl:message>
 354         </xsl:template>
 355     <xsl:variable name="check.idref">1</xsl:variable>
 356
 357         <doc:param xmlns="">
 358                 <refpurpose> Process only one element tree within a document </refpurpose>
 359                 <doc:description>
 360                         <para>
 361
 362                                 When this variable is non-empty, it is interpreted as the ID of
 363                                 an element that should be typeset by &DB2LaTeX;. The element's
 364                                 children, but none of its siblings or ancestors, will be
 365                                 processed as per normal. When the root element is a
 366                                 <doc:db>book</doc:db> or <doc:db>article</doc:db>, that
 367                                 component will have its normal infrastructure (including
 368                                 <doc:db>bookinfo</doc:db> or <doc:db>articleinfo</doc:db>)
 369                                 processed before the <quote>rootid</quote> element.
 370
 371                         </para>
 372                 </doc:description>
 373         </doc:param>
 374         <xsl:param name="rootid" select="''"/>
 375
 376     <!--
 377     <xsl:variable name="link.mailto.url"></xsl:variable>
 378     <xsl:variable name="toc.list.type">dl</xsl:variable>
 379     -->
 380
 381 </xsl:stylesheet>