2
<!DOCTYPE xsl:stylesheet [ <!ENTITY % xsldoc.ent SYSTEM "./xsldoc.ent"> %xsldoc.ent; ]>
3
<!--############################################################################
4
| $Id: param-direct.mod.xsl,v 1.7 2004/01/31 11:05:05 j-devenish Exp $
5
+ ############################################################################## -->
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'>
12
<doc:reference id="param-direct" xmlns="">
14
<releaseinfo role="meta">
15
$Id: param-direct.mod.xsl,v 1.7 2004/01/31 11:05:05 j-devenish Exp $
22
<year>2000</year><year>2001</year><year>2002</year><year>2003</year><year>2004</year>
23
<holder>Ramon Casellas</holder>
26
<doc:revision rcasver="1.1">&rev_2003_05;</doc:revision>
29
<title>Parameters: &LaTeX;-direct Strings <filename>param-direct.mod.xsl</filename></title>
33
The values of the parameters in this file will be passed
35
All parameter names begin with <quote>latex.</quote>.
42
<refpurpose> DB2LaTeX document class </refpurpose>
45
This variable is normally empty and the stylesheets will determine
46
the correct document class according to whether the document is a
47
book or an article. If you wish to use your own document class,
48
put its non-empty value in this variable. It will apply for both
53
<xsl:param name="latex.documentclass"></xsl:param>
56
<refpurpose> The <literal>\maketitle</literal> for books and articles. </refpurpose>
58
<para>Some users may wish to override or eliminate <literal>\maketitle</literal>.</para>
59
<note><para>Does not apply to <sgmltag class="element">article</sgmltag>s within <sgmltag class="element">book</sgmltag>s.</para></note>
60
<para>By default, uses LaTeX <literal>\maketitle</literal> with the 'empty' pagestyle
61
for the first page. The page style of subsequent pages is determined by
62
<xref linkend="template.generate.latex.pagestyle"/>.</para>
65
<xsl:param name="latex.maketitle">
66
<xsl:text>{\maketitle</xsl:text>
67
<xsl:call-template name="generate.latex.pagestyle"/>
68
<xsl:text>\thispagestyle{empty}} </xsl:text>
72
<refpurpose> Undocumented </refpurpose>
74
<para> Undocumented. </para>
77
<xsl:param name="latex.article.preamble.pre">
81
<refpurpose> Undocumented </refpurpose>
83
<para> Undocumented. </para>
86
<xsl:param name="latex.article.preamble.post">
90
<refpurpose> Controls what is output after the LaTeX preamble. </refpurpose>
92
<para>Default values decrease edge margins and allow a large quantity of figures to be set on each page. </para>
95
<xsl:param name="latex.article.varsets">
98
\marginsize{2cm}{2cm}{2cm}{2cm}
99
\renewcommand\floatpagefraction{.9}
100
\renewcommand\topfraction{.9}
101
\renewcommand\bottomfraction{.9}
102
\renewcommand\textfraction{.1}
108
<refpurpose> Undocumented </refpurpose>
110
<para> Undocumented. </para>
113
<xsl:param name="latex.book.preamble.pre">
117
<refpurpose> Undocumented </refpurpose>
119
<para> Undocumented. </para>
122
<xsl:param name="latex.book.preamble.post">
127
All purpose commands to change text width, height, counters, etc.
128
Defaults to a two-sided margin layout.
131
<para> Undocumented. </para>
134
<xsl:param name="latex.book.varsets">
135
<xsl:text>\usepackage{anysize} </xsl:text>
136
<xsl:text>\marginsize{3cm}{2cm}{1.25cm}{1.25cm} </xsl:text>
141
Begin document command
144
<para> Undocumented. </para>
147
<xsl:param name="latex.book.begindocument">
148
<xsl:text>\begin{document} </xsl:text>
153
LaTeX code that is output after the author (e.g.
154
<literal>\makeindex, \makeglossary</literal>
157
<para> Undocumented. </para>
160
<xsl:param name="latex.book.afterauthor">
161
<xsl:text>% -------------------------------------------- </xsl:text>
162
<xsl:text>\makeindex </xsl:text>
163
<xsl:text>\makeglossary </xsl:text>
164
<xsl:text>% -------------------------------------------- </xsl:text>
167
<doc:template xmlns="">
168
<refpurpose> Format the output of tabular headings. </refpurpose>
170
<para> Undocumented. </para>
173
<xsl:template name="latex.thead.row.entry">
174
<xsl:apply-templates/>
177
<doc:template xmlns="">
178
<refpurpose> Format the output of tabular footers. </refpurpose>
180
<para> Undocumented. </para>
183
<xsl:template name="latex.tfoot.row.entry">
184
<xsl:apply-templates/>
188
<refpurpose> Control the style of article titles </refpurpose>
190
<para>This is passed directly to &LaTeX;. Typically,
191
it is either a \command or an empty string.</para>
194
<xsl:param name="latex.article.title.style">\textbf</xsl:param>
197
<refpurpose> Control the style of article titles within books </refpurpose>
199
<para>This is passed directly to &LaTeX;. Typically,
200
it is either a \command or an empty string.</para>
203
<xsl:param name="latex.book.article.title.style">\Large\textbf</xsl:param>
206
<refpurpose> Control the style of authors and dates within a book's articles </refpurpose>
208
<para>This is passed directly to &LaTeX;. Typically,
209
it is either a \command or an empty string.</para>
212
<xsl:param name="latex.book.article.header.style">\textsf</xsl:param>
215
<refpurpose> Control the style of equation captions </refpurpose>
217
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
218
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
219
that command will precede the caption and it will be typeset accordingly.</para>
222
<xsl:param name="latex.equation.caption.style"></xsl:param>
225
<refpurpose> Control the style of example captions </refpurpose>
227
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
228
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
229
that command will precede the caption and it will be typeset accordingly.</para>
232
<xsl:param name="latex.example.caption.style"></xsl:param>
235
<refpurpose> Control the style of figure captions </refpurpose>
237
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
238
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
239
that command will precede the caption and it will be typeset accordingly.</para>
242
<xsl:param name="latex.figure.caption.style"></xsl:param>
245
<refpurpose> Control the style of figure titles </refpurpose>
247
<para>Figure titles are typeset in the default typeface (usually 'roman') but if
248
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
249
that command will precede the title and it will be typeset accordingly.</para>
252
<xsl:param name="latex.figure.title.style"></xsl:param>
255
<refpurpose> Control the style of equation captions </refpurpose>
257
<para>The titles of <doc:db basename="formalpara">formalparas</doc:db> are typeset in the bold typeface by default.
258
This parameter can be set to an alternative &latex; command, such as <function condition="latex">textit</function> (or empty).</para>
261
<xsl:param name="latex.formalpara.title.style">\textbf</xsl:param>
264
<refpurpose> Control the style of list titles </refpurpose>
266
<para>List titles are typeset in small caps but if
267
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
268
that command will precede the title and it will be typeset accordingly.</para>
271
<xsl:param name="latex.list.title.style">\sc</xsl:param>
274
<refpurpose> Control the style of procedure titles </refpurpose>
276
<para>Procedure titles are typeset in small caps but if
277
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
278
that command will precede the title and it will be typeset accordingly.</para>
281
<xsl:param name="latex.procedure.title.style">\sc</xsl:param>
284
<refpurpose> Control the style of segtitles </refpurpose>
286
<para>This is passed directly to &LaTeX;. Typically,
287
it is either a \command or an empty string.</para>
290
<xsl:param name="latex.segtitle.style">\em</xsl:param>
293
<refpurpose> Control the style of step titles </refpurpose>
295
<para>Step titles are typeset in small caps but if
296
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
297
that command will precede the title and it will be typeset accordingly.</para>
300
<xsl:param name="latex.step.title.style">\bf</xsl:param>
303
<refpurpose> Control the style of table captions </refpurpose>
305
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
306
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
307
that command will precede the caption and it will be typeset accordingly.</para>
310
<xsl:param name="latex.table.caption.style"></xsl:param>
312
<xsl:param name="latex.fancyhdr.lh">Left Header</xsl:param>
313
<xsl:param name="latex.fancyhdr.ch">Center Header</xsl:param>
314
<xsl:param name="latex.fancyhdr.rh">Right Header</xsl:param>
315
<xsl:param name="latex.fancyhdr.lf">Left Footer</xsl:param>
316
<xsl:param name="latex.fancyhdr.cf">Center Footer</xsl:param>
317
<xsl:param name="latex.fancyhdr.rf">Right Footer</xsl:param>
320
<refpurpose> Override DB2LaTeX's choice of LaTeX page numbering style </refpurpose>
322
<para>By default, DB2LaTeX will choose the 'plain' or 'fancy' page styles,
323
depending on <xref linkend="param.latex.use.fancyhdr"/>. If non-empty, this
324
variable overrides the automatic selection. An example would be the literal
325
string 'empty', to eliminate headers and page numbers.</para>
328
<xsl:param name="latex.pagestyle"/>
331
<refpurpose> DB2LaTeX hyperref options</refpurpose>
334
In addition to this variable, you can specify additional options using
335
<literal>latex.hyperref.param.pdftex</literal> or <literal>latex.hyperref.param.dvips</literal>.
339
<xsl:param name="latex.hyperref.param.common">bookmarksnumbered,colorlinks,backref,bookmarks,breaklinks,linktocpage,plainpages=false</xsl:param>
342
<refpurpose> DB2LaTeX hyperref options for pdfTeX output</refpurpose>
345
See the hyperref documentation for further information.
349
<xsl:param name="latex.hyperref.param.pdftex">pdfstartview=FitH</xsl:param>
351
what is the unicode option?
355
<refpurpose> DB2LaTeX hyperref options for dvips output</refpurpose>
358
See the hyperref documentation for further information.
362
<xsl:param name="latex.hyperref.param.dvips"></xsl:param>
365
<refpurpose>Options for the <productname>varioref</productname> LaTeX package</refpurpose>
366
<doc:description><para>Support index generation.</para></doc:description>
368
<xsl:param name="latex.varioref.options">
369
<xsl:if test="$latex.language.option!='none'">
370
<xsl:value-of select="$latex.language.option" />
374
<doc:template name="latex.vpageref.options" xmlns="">
375
<refpurpose>Toggle the use of the <productname>varioref</productname> LaTeX package</refpurpose>
376
<doc:description><para>Support index generation.</para></doc:description>
378
<xsl:template name="latex.vpageref.options">on this page</xsl:template>
381
<refpurpose>Choose indentation for tabs in verbatim environments</refpurpose>
382
<doc:description><para>When <xref linkend="param.latex.use.fancyvrb"/> is enabled,
383
this variable sets the width of a tab in terms of an equivalent number of spaces.</para></doc:description>
385
<xsl:param name="latex.fancyvrb.tabsize">3</xsl:param>
387
<doc:template name="latex.fancyvrb.options" xmlns="">
388
<refpurpose>Insert <productname>LaTeX</productname> options for <productname>fancyvrb</productname> Verbatim environments</refpurpose>
390
<para> Undocumented. </para>
393
<xsl:template name="latex.fancyvrb.options"/>
396
<refpurpose>Control the use of the <productname>inputenc</productname> LaTeX package</refpurpose>
399
If this option is non-empty, the <productname>inputenc</productname> package
400
will be used with the specified encoding. This should agree with the your driver
401
file. For example, the default value of <literal>latin1</literal>
402
is compatible with <filename>docbook.xsl</filename>, which contains
403
<literal><![CDATA[<xsl:output method="text" encoding="ISO-8859-1" indent="yes"/>]]></literal>
406
If this option is empty, the <productname>inputenc</productname> package
407
will not be invoked by <productname>DB2LaTeX</productname>.
410
<title>Common Combinations</title>
411
<segtitle>Output Encoding</segtitle><segtitle><productname>inputenc</productname> Option</segtitle>
412
<seglistitem><seg>ISO-8859-1</seg><seg>latin1</seg></seglistitem>
413
<seglistitem><seg>UTF-8</seg><seg>utf8<footnote><simpara>When used in conjunction with a package such as <ulink url="http://www.ctan.org/tools/cataloguesearch?action=/search/&catstring=unicode"><productname>unicode</productname></ulink>.</simpara></footnote></seg></seglistitem>
416
<productname>inputenc</productname> is a <productname>LaTeX</productname> base package.
420
<xsl:param name="latex.inputenc">latin1</xsl:param>
423
<refpurpose> Options for the <productname>fontenc</productname> package </refpurpose>
425
<para> Undocumented. </para>
428
<xsl:param name="latex.fontenc"></xsl:param>
431
<refpurpose>Select the optional parameter(s) for the <productname>unicode</productname> LaTeX package</refpurpose>
432
<doc:description><para>See the <productname>unicode</productname> documentation for details.</para></doc:description>
434
<xsl:param name="latex.ucs.options"></xsl:param>
437
<refpurpose>Select the optional parameter for the <productname>babel</productname> LaTeX package</refpurpose>
439
<para>See the <productname>babel</productname> documentation for details.</para>
440
<para>Although DB2LaTeX will try to choose the correct babel options for your
441
document, you may need to specify the correct choice here. The special value
442
of 'none' (without the quotes) will cause DB2LaTeX to skip babel configuration.</para>
445
<xsl:param name="latex.babel.language"></xsl:param>
448
<refpurpose> Adjust bibliography formatting </refpurpose>
450
<para>The environment bibliography accepts a parameter that indicates
451
the widest label, which is used to correctly format the bibliography
452
output. The value of this parameter is output inside the
453
<literal>\begin{thebibliography[]}</literal> LaTeX command.</para>
456
<xsl:param name="latex.bibwidelabel">
458
<xsl:when test="$latex.biblioentry.style='ieee' or $latex.biblioentry.style='IEEE'">
459
<xsl:text>123</xsl:text>
462
<xsl:text>WIDELABEL</xsl:text>
468
<refpurpose> DB2LaTeX document class options </refpurpose>
471
These are the first options to be passed to <literal>\documentclass</literal>
472
(The common options are
474
set to <literal>french,english</literal>
478
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).
482
<xsl:param name="latex.documentclass.common"></xsl:param>
485
<refpurpose> DB2LaTeX document class options for articles</refpurpose>
488
The article options are set to <literal>a4paper,10pt,twoside,twocolumn</literal> by default.
489
These are the intermediate options to be passed to <literal>\documentclass</literal>,
490
between the common options and the pdftex/dvips options.
494
<xsl:param name="latex.documentclass.article">a4paper,10pt,twoside,twocolumn</xsl:param>
497
<refpurpose> DB2LaTeX document class options for books</refpurpose>
500
The book options are set to <literal>a4paper,10pt,twoside,openright</literal> by default.
501
These are the intermediate options to be passed to <literal>\documentclass</literal>,
502
between the common options and the pdftex/dvips options.
506
<xsl:param name="latex.documentclass.book">a4paper,10pt,twoside,openright</xsl:param>
509
<refpurpose> DB2LaTeX document class options for pdfTeX output</refpurpose>
512
The pdfTeX options are empty by default.
513
These are the last options to be passed to <literal>\documentclass</literal>
514
and override the common/article/book options.
518
<xsl:param name="latex.documentclass.pdftex"></xsl:param>
521
<refpurpose> DB2LaTeX document class options for dvips output</refpurpose>
524
The dvips options are empty by default.
525
These are the last options to be passed to <literal>\documentclass</literal>
526
and override the common/article/book options.
530
<xsl:param name="latex.documentclass.dvips"></xsl:param>
533
<refpurpose> DB2LaTeX graphics admonitions size</refpurpose>
536
Is passed as an optional parameter for <literal>\includegraphics</literal> and
537
can take on any such legal values (or be empty).
541
<xsl:param name="latex.admonition.imagesize">width=1cm</xsl:param>
544
<refpurpose> DB2LaTeX allows using an (externally generated) cover page </refpurpose>
547
You may supply a LaTeX file that will supersede DB2LaTeX's default
548
cover page or title. If the value of this variable is non-empty, the
549
generated LaTeX code includes \input{filename}. Otherwise, it uses the
553
Bear in mind that using an external cover page breaks the
554
"encapsulation" of DocBook. Further revisions of these stylesheets
555
will add chunking support, and the automation of the cover file
560
<xsl:param name="latex.titlepage.file">title</xsl:param>
562
<refpurpose> Document Font(s) </refpurpose>
565
Document fonts can be chosen by providing &LaTeX; package names.
566
Common values include <literal>default</literal>, <literal>times</literal>, <literal>palatcm</literal>, <literal>charter</literal>, <literal>helvet</literal>, <literal>palatino</literal>, <literal>avant</literal>, <literal>newcent</literal> and <literal>bookman</literal>.
567
Particular combinations may also work. For example, <literal>mathptm,charter,courier</literal>.
570
If you want to change explicitly to a certain font, use the command \fontfamily{XYZ}\selectfont whereby XYZ can be set to: pag for Adobe AvantGarde, pbk for Adobe Bookman, pcr for Adobe Courier, phv for Adobe Helvetica, pnc for Adobe NewCenturySchoolbook, ppl for Adobe Palatino, ptm for Adobe Times Roman, pzc for Adobe ZapfChancery
574
<xsl:param name="latex.document.font">palatino</xsl:param>
577
<refpurpose> Override DB2LaTeX's preamble with a custom preamble. </refpurpose>
580
When this variable is set, the entire DB2LaTeX premable will be superseded.
581
<emphasis>You should not normally need or want to use this.</emphasis>
582
It may cause LaTeX typesetting problems. This is a last resort or
583
<quote>expert</quote> feature.
587
<xsl:param name="latex.override"></xsl:param>