2
<!DOCTYPE xsl:stylesheet [ <!ENTITY % xsldoc.ent SYSTEM "./xsldoc.ent"> %xsldoc.ent; ]>
3
<!--############################################################################
4
| $Id: param-direct.mod.xsl,v 1.9 2004/08/12 05:17:01 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.9 2004/08/12 05:17:01 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>\makeglossary</literal>
157
<para> Undocumented. </para>
160
<xsl:param name="latex.book.afterauthor">
161
<xsl:text>% -------------------------------------------- </xsl:text>
162
<xsl:text>\makeglossary </xsl:text>
163
<xsl:text>% -------------------------------------------- </xsl:text>
166
<doc:template xmlns="">
167
<refpurpose> Format the output of tabular headings. </refpurpose>
169
<para> Undocumented. </para>
173
<xsl:template name="latex.thead.row.entry">
174
<xsl:apply-templates/>
178
<doc:template xmlns="">
179
<refpurpose> Format the output of tabular row entries. </refpurpose>
181
<para> Undocumented. </para>
185
<xsl:template name="latex.tbody.row.entry">
186
<xsl:apply-templates/>
191
<doc:template xmlns="">
192
<refpurpose> Format the output of tabular footers. </refpurpose>
194
<para> Undocumented. </para>
198
<xsl:template name="latex.tfoot.row.entry">
199
<xsl:apply-templates/>
203
<refpurpose> Control the style of inline monospaced text </refpurpose>
205
<para>This is passed directly to &LaTeX;. Typically,
206
it is <literal>\frenchspacing\texttt</literal>.</para>
209
<xsl:param name="latex.inline.monoseq.style">\frenchspacing\texttt</xsl:param>
212
<refpurpose> Control the style of article titles </refpurpose>
214
<para>This is passed directly to &LaTeX;. Typically,
215
it is either a \command or an empty string.</para>
218
<xsl:param name="latex.article.title.style">\textbf</xsl:param>
221
<refpurpose> Control the style of article titles within books </refpurpose>
223
<para>This is passed directly to &LaTeX;. Typically,
224
it is either a \command or an empty string.</para>
227
<xsl:param name="latex.book.article.title.style">\Large\textbf</xsl:param>
230
<refpurpose> Control the style of authors and dates within a book's articles </refpurpose>
232
<para>This is passed directly to &LaTeX;. Typically,
233
it is either a \command or an empty string.</para>
236
<xsl:param name="latex.book.article.header.style">\textsf</xsl:param>
239
<refpurpose> Control the style of equation captions </refpurpose>
241
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
242
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
243
that command will precede the caption and it will be typeset accordingly.</para>
246
<xsl:param name="latex.equation.caption.style"></xsl:param>
249
<refpurpose> Control the style of example captions </refpurpose>
251
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
252
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
253
that command will precede the caption and it will be typeset accordingly.</para>
256
<xsl:param name="latex.example.caption.style"></xsl:param>
259
<refpurpose> Control the style of figure captions </refpurpose>
261
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
262
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
263
that command will precede the caption and it will be typeset accordingly.</para>
266
<xsl:param name="latex.figure.caption.style"></xsl:param>
269
<refpurpose> Control the style of figure titles </refpurpose>
271
<para>Figure titles are typeset in the default typeface (usually 'roman') but if
272
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
273
that command will precede the title and it will be typeset accordingly.</para>
276
<xsl:param name="latex.figure.title.style"></xsl:param>
279
<refpurpose> Control the style of equation captions </refpurpose>
281
<para>The titles of <doc:db basename="formalpara">formalparas</doc:db> are typeset in the bold typeface by default.
282
This parameter can be set to an alternative &latex; command, such as <function condition="latex">textit</function> (or empty).</para>
285
<xsl:param name="latex.formalpara.title.style">\textbf</xsl:param>
288
<refpurpose> Control the style of list titles </refpurpose>
290
<para>List titles are typeset in small caps but if
291
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
292
that command will precede the title and it will be typeset accordingly.</para>
295
<xsl:param name="latex.list.title.style">\sc</xsl:param>
298
<refpurpose> Control the style of admonition titles </refpurpose>
300
<para>Admonition titles are typeset in small bold caps but if
301
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
302
that command will precede the title and it will be typeset accordingly.</para>
305
<xsl:param name="latex.admonition.title.style">\bfseries \sc\large</xsl:param>
308
<refpurpose> Control the style of procedure titles </refpurpose>
310
<para>Procedure titles are typeset in small caps but if
311
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
312
that command will precede the title and it will be typeset accordingly.</para>
315
<xsl:param name="latex.procedure.title.style">\sc</xsl:param>
318
<refpurpose> Control the style of segtitles </refpurpose>
320
<para>This is passed directly to &LaTeX;. Typically,
321
it is either a \command or an empty string.</para>
324
<xsl:param name="latex.segtitle.style">\em</xsl:param>
327
<refpurpose> Control the style of step titles </refpurpose>
329
<para>Step titles are typeset in small caps but if
330
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
331
that command will precede the title and it will be typeset accordingly.</para>
334
<xsl:param name="latex.step.title.style">\bf</xsl:param>
337
<refpurpose> Control the style of table captions </refpurpose>
339
<para>Figure captions are typeset in the default typeface (usually 'roman') but if
340
this option is set to a LaTeX command, such as <literal>\textit</literal>, then
341
that command will precede the caption and it will be typeset accordingly.</para>
344
<xsl:param name="latex.table.caption.style"></xsl:param>
346
<xsl:param name="latex.fancyhdr.lh">Left Header</xsl:param>
347
<xsl:param name="latex.fancyhdr.ch">Center Header</xsl:param>
348
<xsl:param name="latex.fancyhdr.rh">Right Header</xsl:param>
349
<xsl:param name="latex.fancyhdr.lf">Left Footer</xsl:param>
350
<xsl:param name="latex.fancyhdr.cf">Center Footer</xsl:param>
351
<xsl:param name="latex.fancyhdr.rf">Right Footer</xsl:param>
354
<refpurpose> Override DB2LaTeX's choice of LaTeX page numbering style </refpurpose>
356
<para>By default, DB2LaTeX will choose the 'plain' or 'fancy' page styles,
357
depending on <xref linkend="param.latex.use.fancyhdr"/>. If non-empty, this
358
variable overrides the automatic selection. An example would be the literal
359
string 'empty', to eliminate headers and page numbers.</para>
362
<xsl:param name="latex.pagestyle"/>
365
<refpurpose> DB2LaTeX hyperref options</refpurpose>
368
In addition to this variable, you can specify additional options using
369
<literal>latex.hyperref.param.pdftex</literal> or <literal>latex.hyperref.param.dvips</literal>.
373
<xsl:param name="latex.hyperref.param.common">bookmarksnumbered,colorlinks,backref,bookmarks,breaklinks,linktocpage,plainpages=false</xsl:param>
376
<refpurpose> DB2LaTeX hyperref options for pdfTeX output</refpurpose>
379
See the hyperref documentation for further information.
383
<xsl:param name="latex.hyperref.param.pdftex">pdfstartview=FitH</xsl:param>
385
what is the unicode option?
389
<refpurpose> DB2LaTeX hyperref options for dvips output</refpurpose>
392
See the hyperref documentation for further information.
396
<xsl:param name="latex.hyperref.param.dvips"></xsl:param>
399
<refpurpose>Options for the <productname>varioref</productname> LaTeX package</refpurpose>
400
<doc:description><para>Support index generation.</para></doc:description>
402
<xsl:param name="latex.varioref.options">
403
<xsl:if test="$latex.language.option!='none'">
404
<xsl:value-of select="$latex.language.option" />
408
<doc:template name="latex.vpageref.options" xmlns="">
409
<refpurpose>Toggle the use of the <productname>varioref</productname> LaTeX package</refpurpose>
410
<doc:description><para>Support index generation.</para></doc:description>
412
<xsl:template name="latex.vpageref.options">on this page</xsl:template>
415
<refpurpose>Choose indentation for tabs in verbatim environments</refpurpose>
416
<doc:description><para>When <xref linkend="param.latex.use.fancyvrb"/> is enabled,
417
this variable sets the width of a tab in terms of an equivalent number of spaces.</para></doc:description>
419
<xsl:param name="latex.fancyvrb.tabsize">3</xsl:param>
421
<doc:template name="latex.fancyvrb.options" xmlns="">
422
<refpurpose>Insert <productname>LaTeX</productname> options for <productname>fancyvrb</productname> Verbatim environments</refpurpose>
424
<para> Undocumented. </para>
427
<xsl:template name="latex.fancyvrb.options"/>
430
<refpurpose>Control the use of the <productname>inputenc</productname> LaTeX package</refpurpose>
433
If this option is non-empty, the <productname>inputenc</productname> package
434
will be used with the specified encoding. This should agree with the your driver
435
file. For example, the default value of <literal>latin1</literal>
436
is compatible with <filename>docbook.xsl</filename>, which contains
437
<literal><![CDATA[<xsl:output method="text" encoding="ISO-8859-1" indent="yes"/>]]></literal>
440
If this option is empty, the <productname>inputenc</productname> package
441
will not be invoked by <productname>DB2LaTeX</productname>.
444
<title>Common Combinations</title>
445
<segtitle>Output Encoding</segtitle><segtitle><productname>inputenc</productname> Option</segtitle>
446
<seglistitem><seg>ISO-8859-1</seg><seg>latin1</seg></seglistitem>
447
<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>
450
<productname>inputenc</productname> is a <productname>LaTeX</productname> base package.
454
<xsl:param name="latex.inputenc">latin1</xsl:param>
457
<refpurpose> Options for the <productname>fontenc</productname> package </refpurpose>
459
<para> Undocumented. </para>
462
<xsl:param name="latex.fontenc"></xsl:param>
465
<refpurpose>Select the optional parameter(s) for the <productname>unicode</productname> LaTeX package</refpurpose>
466
<doc:description><para>See the <productname>unicode</productname> documentation for details.</para></doc:description>
468
<xsl:param name="latex.ucs.options"></xsl:param>
471
<refpurpose>Select the optional parameter for the <productname>babel</productname> LaTeX package</refpurpose>
473
<para>See the <productname>babel</productname> documentation for details.</para>
474
<para>Although DB2LaTeX will try to choose the correct babel options for your
475
document, you may need to specify the correct choice here. The special value
476
of 'none' (without the quotes) will cause DB2LaTeX to skip babel configuration.</para>
479
<xsl:param name="latex.babel.language"></xsl:param>
482
<refpurpose> Adjust bibliography formatting </refpurpose>
484
<para>The environment bibliography accepts a parameter that indicates
485
the widest label, which is used to correctly format the bibliography
486
output. The value of this parameter is output inside the
487
<literal>\begin{thebibliography[]}</literal> LaTeX command.</para>
490
<xsl:param name="latex.bibwidelabel">
492
<xsl:when test="$latex.biblioentry.style='ieee' or $latex.biblioentry.style='IEEE'">
493
<xsl:text>123</xsl:text>
496
<xsl:text>WIDELABEL</xsl:text>
502
<refpurpose> DB2LaTeX document class options </refpurpose>
505
These are the first options to be passed to <literal>\documentclass</literal>
506
(The common options are
508
set to <literal>french,english</literal>
512
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).
516
<xsl:param name="latex.documentclass.common"></xsl:param>
519
<refpurpose> DB2LaTeX document class options for articles</refpurpose>
522
The article options are set to <literal>a4paper,10pt,twoside,twocolumn</literal> by default.
523
These are the intermediate options to be passed to <literal>\documentclass</literal>,
524
between the common options and the pdftex/dvips options.
528
<xsl:param name="latex.documentclass.article">a4paper,10pt,twoside,twocolumn</xsl:param>
531
<refpurpose> DB2LaTeX document class options for books</refpurpose>
534
The book options are set to <literal>a4paper,10pt,twoside,openright</literal> by default.
535
These are the intermediate options to be passed to <literal>\documentclass</literal>,
536
between the common options and the pdftex/dvips options.
540
<xsl:param name="latex.documentclass.book">a4paper,10pt,twoside,openright</xsl:param>
543
<refpurpose> DB2LaTeX document class options for pdfTeX output</refpurpose>
546
The pdfTeX options are empty by default.
547
These are the last options to be passed to <literal>\documentclass</literal>
548
and override the common/article/book options.
552
<xsl:param name="latex.documentclass.pdftex"></xsl:param>
555
<refpurpose> DB2LaTeX document class options for dvips output</refpurpose>
558
The dvips options are empty by default.
559
These are the last options to be passed to <literal>\documentclass</literal>
560
and override the common/article/book options.
564
<xsl:param name="latex.documentclass.dvips"></xsl:param>
567
<refpurpose> DB2LaTeX graphics admonitions size</refpurpose>
570
Is passed as an optional parameter for <literal>\includegraphics</literal> and
571
can take on any such legal values (or be empty).
575
<xsl:param name="latex.admonition.imagesize">width=1cm</xsl:param>
578
<refpurpose> DB2LaTeX allows using an (externally generated) cover page </refpurpose>
581
You may supply a LaTeX file that will supersede DB2LaTeX's default
582
cover page or title. If the value of this variable is non-empty, the
583
generated LaTeX code includes \input{filename}. Otherwise, it uses the
587
Bear in mind that using an external cover page breaks the
588
"encapsulation" of DocBook. Further revisions of these stylesheets
589
will add chunking support, and the automation of the cover file
594
<xsl:param name="latex.titlepage.file">title</xsl:param>
596
<refpurpose> Document Font(s) </refpurpose>
599
Document fonts can be chosen by providing &LaTeX; package names.
600
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>.
601
Particular combinations may also work. For example, <literal>mathptm,charter,courier</literal>.
604
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
608
<xsl:param name="latex.document.font">palatino</xsl:param>
611
<refpurpose> Override DB2LaTeX's preamble with a custom preamble. </refpurpose>
614
When this variable is set, the entire DB2LaTeX premable will be superseded.
615
<emphasis>You should not normally need or want to use this.</emphasis>
616
It may cause LaTeX typesetting problems. This is a last resort or
617
<quote>expert</quote> feature.
621
<xsl:param name="latex.override"></xsl:param>
added
removed
build/stylesheets/db2latex/param-direct.mod.xsl
