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
+ ############################################################################## -->
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-common" xmlns="">
14
<releaseinfo role="meta">
15
$Id: param-common.mod.xsl,v 1.12 2004/01/26 13:25:17 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: Common Options <filename>param-common.mod.xsl</filename></title>
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;.
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
61
<refpurpose> &LaTeX; location for admonition graphics </refpurpose>
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>
69
<xsl:param name="admon.graphics.path">
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"/>
76
<xsl:text>figures</xsl:text>
80
<xsl:param name="latex.admonition.path"/>
83
<refpurpose> Control the escaping of <doc:db>alt</doc:db> text </refpurpose>
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!).
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>
111
<xsl:param name="latex.alt.is.latex"/>
114
<refpurpose> Display <doc:db>remark</doc:db> and <doc:db>comment</doc:db> elements? </refpurpose>
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"/>.
124
<xsl:param name="show.comments">
125
<xsl:value-of select="$latex.is.draft"/>
129
<refpurpose> Control the display of <doc:db>othername</doc:db> elements in <doc:db basename="author">authors</doc:db> </refpurpose>
133
When disabled, <doc:db>othername</doc:db> elements will be suppressed when
134
<doc:db>author</doc:db> elements are formatted.
139
<xsl:param name="author.othername.in.middle" select="1"/>
142
<refpurpose> Separator for bibliography items </refpurpose>
144
<para><doc:todo>This parameter is under review.</doc:todo></para>
147
<xsl:param name="biblioentry.item.separator">, </xsl:param>
150
<refpurpose> Cull table-of-contents entries that are deeply nested </refpurpose>
152
<para>Specifies the maximum depth before sections are omitted from the table of contents.</para>
155
<xsl:param name="toc.section.depth">4</xsl:param>
158
<refpurpose> Control the automatic numbering of section, parts, and chapters </refpurpose>
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.
168
<xsl:param name="section.depth">4</xsl:param>
171
<refpurpose> Default filename extension for <function condition="latex">includegraphics</function> </refpurpose>
174
Specify the &LaTeX; search parameters for graphics filenames.
175
If empty, &DB2LaTeX; will specify some explicit defaults.
179
<xsl:param name="graphic.default.extension"/>
182
<refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose>
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.
196
<xsl:param name="use.role.for.mediaobject">1</xsl:param>
199
<refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose>
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>.
215
<xsl:param name="preferred.mediaobject.role"/>
218
<refpurpose> Specifies where formal component titles should occur </refpurpose>
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>.
230
<xsl:param name="formal.title.placement">
239
<refpurpose> Control the appearance of page numbers in cross references </refpurpose>
243
When enabled, <doc:db basename="xref">xrefs</doc:db> will
244
include page numbers after their generated cross-reference
250
<xsl:param name="insert.xref.page.number">0</xsl:param>
253
<refpurpose> Control the display of URLs after <doc:db basename="ulink">ulinks</doc:db> </refpurpose>
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.
265
<xsl:param name="ulink.show">1</xsl:param>
268
<refpurpose> Control the generation of footnotes for ulinks </refpurpose>
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.
280
<xsl:param name="ulink.footnotes">0</xsl:param>
283
<refpurpose> Honour role as proxy for xrefstyle </refpurpose>
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.
295
<xsl:param name="use.role.as.xrefstyle">0</xsl:param>
297
<xsl:variable name="default-classsynopsis-language">java</xsl:variable>
299
<refpurpose> Choose whether to include <doc:db>manvolnum</doc:db> in cross-references </refpurpose>
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>.
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>
316
<refpurpose> Control the use of NAME headers </refpurpose>
320
See <ulink url="http://docbook.sourceforge.net/release/xsl/current/doc/fo/refentry.generate.name.html"/>.
325
<xsl:param name="refentry.generate.name" select="1"/>
326
<xsl:param name="glossentry.show.acronym" select="'no'"/>
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>
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>
349
<xsl:template name="is.graphic.format">
350
<xsl:message terminate="yes">Logic error: is.graphic.format is unsupported.</xsl:message>
352
<xsl:template name="lookup.key">
353
<xsl:message terminate="yes">Logic error: lookup.key is unsupported.</xsl:message>
355
<xsl:variable name="check.idref">1</xsl:variable>
358
<refpurpose> Process only one element tree within a document </refpurpose>
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.
374
<xsl:param name="rootid" select="''"/>
377
<xsl:variable name="link.mailto.url"></xsl:variable>
378
<xsl:variable name="toc.list.type">dl</xsl:variable>