Debian Codegraph @

tests/docbook/doc/fo/param.html

raw
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4
5 <title>Formatting Object Parameter Reference</title>
6 <link rel="stylesheet" href="../reference.css" type="text/css">
7 <meta name="generator" content="DocBook XSL Stylesheets V1.39">
8 </head>
9 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
10 <div class="reference">
11 <div class="titlepage">
12 <div>
13 <h1 class="title"><a name="d41e1"></a>Formatting Object Parameter Reference
14 </h1>
15 </div>
16 <div>
17 <h3 class="author">Norman Walsh</h3>
18 </div>
19 <div>
20 <p class="releaseinfo">
21 $Id$
22
23 </p>
24 </div>
25 <div>
26 <p class="copyright"><a href="../copyright.html">Copyright</a> &copy; 1999, 2000 by Norman Walsh. <a href="../warranty.html">No Warranty</a>.
27 </p>
28 </div>
29 <hr>
30 </div>
31 <div class="partintro">
32 <div></div>
33 <div class="section"><a name="d41e24"></a><div class="titlepage">
34 <div>
35 <h2 class="title" style="clear: both"><a name="d41e24"></a>Introduction
36 </h2>
37 </div>
38 </div>
39 <p>This is technical reference documentation for the DocBook XSL
40 Stylesheets; it documents (some of) the parameters, templates, and
41 other elements of the stylesheets.
42 </p>
43 <p>This reference describes each of the Formatting Object
44 Stylesheet parameters. These are the &#8220;easily
45 customizable&#8221; parts of the stylesheet. If you want to specify
46 an alternate value for one or more of these parameters, you can do so
47 in a &#8220;driver&#8221; stylesheet.
48 </p>
49 <p>For example, if you want to turn on automatic section numbering,
50 you might create a driver stylesheet like this:
51 </p><pre class="programlisting">&lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
52 version='1.0'&gt;
53
54 &lt;xsl:import href="/path/to/fo/docbook.xsl"/&gt;
55
56 &lt;xsl:param name="section.autolabel" select="1"/&gt;
57
58 &lt;/xsl:stylesheet&gt;</pre><p>Naturally, you have to change the
59 <tt>href</tt> attribute on
60 <tt>&lt;xsl:import&gt;</tt>
61 to point to <tt>docbook.xsl</tt>
62 on your system.
63 </p>
64 <p>This is not intended to be &#8220;user&#8221; documentation.
65 It is provided for developers writing customization layers for the
66 stylesheets, and for anyone who's interested in &#8220;how it
67 works&#8221;.
68 </p>
69 <p>Although I am trying to be thorough, this documentation is known
70 to be incomplete. Don't forget to read the source, too :-)
71 </p>
72 </div>
73 <div class="toc">
74 <p><b>Table of Contents</b></p>
75 <dl>
76 <dt><a href="#param.admon.graphics.extension">admon.graphics.extension</a></dt>
77 <dt><a href="#var.qandadiv.autolabel">qandadiv.autolabel</a></dt>
78 <dt><a href="#var.qanda.inherit.numeration">qanda.inherit.numeration</a></dt>
79 <dt><a href="#var.graphic.default.extension">graphic.default.extension</a></dt>
80 <dt><a href="#attrset.formal.title.properties">formal.title.properties mode</a></dt>
81 <dt><a href="#attrset.component.title.properties">component.title.properties mode</a></dt>
82 <dt><a href="#attrset.admonition.title.properties">admonition.title.properties mode</a></dt>
83 <dt><a href="#attrset.xref.properties">xref.properties mode</a></dt>
84 <dt><a href="#param.insert.xref.page.number">insert.xref.page.number</a></dt>
85 <dt><a href="#attrset.normal.para.spacing">normal.para.spacing mode</a></dt>
86 <dt><a href="#attrset.list.block.spacing">list.block.spacing mode</a></dt>
87 <dt><a href="#attrset.list.item.spacing">list.item.spacing mode</a></dt>
88 <dt><a href="#param.rootid">rootid</a></dt>
89 <dt><a href="#param.callout.graphics">callout.graphics</a></dt>
90 <dt><a href="#param.callout.unicode">callout.unicode</a></dt>
91 <dt><a href="#param.callout.dingbats">callout.dingbats</a></dt>
92 <dt><a href="#param.callout.unicode.start.character">callout.unicode.start.character</a></dt>
93 <dt><a href="#param.callout.unicode.number.limit">callout.unicode.number.limit</a></dt>
94 <dt><a href="#param.callout.graphics.extension">callout.graphics.extension</a></dt>
95 <dt><a href="#param.callout.graphics.path">callout.graphics.path</a></dt>
96 <dt><a href="#param.callout.graphics.number.limit">callout.graphics.number.limit</a></dt>
97 <dt><a href="#param.use.extensions">use.extensions</a></dt>
98 <dt><a href="#param.textinsert.extension">textinsert.extension</a></dt>
99 <dt><a href="#param.linenumbering.extension">linenumbering.extension</a></dt>
100 <dt><a href="#param.linenumbering.everyNth">linenumbering.everyNth</a></dt>
101 <dt><a href="#param.linenumbering.width">linenumbering.width</a></dt>
102 <dt><a href="#param.linenumbering.separator">linenumbering.separator</a></dt>
103 <dt><a href="#param.callouts.extension">callouts.extension</a></dt>
104 <dt><a href="#param.callout.defaultcolumn">callout.defaultcolumn</a></dt>
105 <dt><a href="#param.tablecolumns.extension">tablecolumns.extension</a></dt>
106 <dt><a href="#param.nominal.table.width">nominal.table.width</a></dt>
107 <dt><a href="#param.default.table.width">default.table.width</a></dt>
108 <dt><a href="#param.paper.type">paper.type</a></dt>
109 <dt><a href="#param.page.orientation">page.orientation</a></dt>
110 <dt><a href="#param.page.width.portrait">page.width.portrait</a></dt>
111 <dt><a href="#param.page.height.portrait">page.height.portrait</a></dt>
112 <dt><a href="#param.page.width">page.width</a></dt>
113 <dt><a href="#param.page.height">page.height</a></dt>
114 <dt><a href="#param.double.sided">double.sided</a></dt>
115 <dt><a href="#param.column.count">column.count</a></dt>
116 <dt><a href="#param.region.after.extent">region.after.extent</a></dt>
117 <dt><a href="#param.region.before.extent">region.before.extent</a></dt>
118 <dt><a href="#param.page.margin.top">page.margin.top</a></dt>
119 <dt><a href="#param.page.margin.bottom">page.margin.bottom</a></dt>
120 <dt><a href="#param.page.margin.inner">page.margin.inner</a></dt>
121 <dt><a href="#param.page.margin.outer">page.margin.outer</a></dt>
122 <dt><a href="#param.body.margin.bottom">body.margin.bottom</a></dt>
123 <dt><a href="#param.body.margin.top">body.margin.top</a></dt>
124 <dt><a href="#param.body.font.family">body.font.family</a></dt>
125 <dt><a href="#param.title.font.family">title.font.family</a></dt>
126 <dt><a href="#param.monospace.font.family">monospace.font.family</a></dt>
127 <dt><a href="#param.sans.font.family">sans.font.family</a></dt>
128 <dt><a href="#param.body.font.master">body.font.master</a></dt>
129 <dt><a href="#param.body.font.size">body.font.size</a></dt>
130 <dt><a href="#param.footnote.font.size">footnote.font.size</a></dt>
131 <dt><a href="#param.hyphenate">hyphenate</a></dt>
132 <dt><a href="#param.alignment">alignment</a></dt>
133 <dt><a href="#param.stylesheet.result.type">stylesheet.result.type</a></dt>
134 <dt><a href="#param.generate.component.toc">generate.component.toc</a></dt>
135 <dt><a href="#param.generate.division.toc">generate.division.toc</a></dt>
136 <dt><a href="#param.generate.division.figure.lot">generate.division.figure.lot</a></dt>
137 <dt><a href="#param.generate.division.example.lot">generate.division.example.lot</a></dt>
138 <dt><a href="#param.generate.division.equation.lot">generate.division.equation.lot</a></dt>
139 <dt><a href="#param.generate.division.table.lot">generate.division.table.lot</a></dt>
140 <dt><a href="#param.passivetex.extensions">passivetex.extensions</a></dt>
141 <dt><a href="#param.arbortext.extensions">arbortext.extensions</a></dt>
142 <dt><a href="#param.fop.extensions">fop.extensions</a></dt>
143 <dt><a href="#param.default.units">default.units</a></dt>
144 <dt><a href="#param.label.from.part">label.from.part</a></dt>
145 </dl>
146 </div>
147 </div>
148 <hr>
149 <div class="refentry">
150 <h1 class="title"><a name="param.admon.graphics.extension"></a>admon.graphics.extension
151 </h1>
152 <div class="refnamediv"><a name="d41e63"></a><h2>Name</h2>admon.graphics.extension &#8212; Extension for admonition graphics
153 </div>
154 <div class="refsynopsisdiv"><a name="d41e68"></a><h2>Synopsis</h2><pre class="synopsis">
155 &lt;xsl:param name="admon.graphics.extension" select="'.png'" doc:type="string"/&gt;</pre></div>
156 <div class="refdescription"><a name="d41e71"></a>
157
158
159 <p>Sets the extension to use on admonition graphics.</p>
160
161
162 </div>
163 </div>
164 <hr>
165 <div class="refentry">
166 <h1 class="title"><a name="var.qandadiv.autolabel"></a>qandadiv.autolabel
167 </h1>
168 <div class="refnamediv"><a name="d41e77"></a><h2>Name</h2>qandadiv.autolabel &#8212; Are divisions in QAndASets enumerated?
169 </div>
170 <div class="refsynopsisdiv"><a name="d41e82"></a><h2>Synopsis</h2><pre class="synopsis"></pre></div>
171 <div class="refdescription"><a name="d41e84"></a>
172
173
174 <p>If true (non-zero), unlabeled qandadivs will be enumerated.
175
176 </p>
177
178
179 </div>
180 </div>
181 <hr>
182 <div class="refentry">
183 <h1 class="title"><a name="var.qanda.inherit.numeration"></a>qanda.inherit.numeration
184 </h1>
185 <div class="refnamediv"><a name="d41e90"></a><h2>Name</h2>qanda.inherit.numeration &#8212; Does enumeration of QandASet components inherit the numeration of parent elements?
186 </div>
187 <div class="refsynopsisdiv"><a name="d41e95"></a><h2>Synopsis</h2><pre class="synopsis"></pre></div>
188 <div class="refdescription"><a name="d41e97"></a>
189
190
191 <p>If true (non-zero), numbered QandADiv elements and Questions and Answers inherit
192 the numeration of the ancestors of the QandASet.
193
194 </p>
195
196
197 </div>
198 </div>
199 <hr>
200 <div class="refentry">
201 <h1 class="title"><a name="var.graphic.default.extension"></a>graphic.default.extension
202 </h1>
203 <div class="refnamediv"><a name="d41e103"></a><h2>Name</h2>graphic.default.extension &#8212; Default extension for graphic filenames
204 </div>
205 <div class="refsynopsisdiv"><a name="d41e108"></a><h2>Synopsis</h2><pre class="synopsis"></pre></div>
206 <div class="refdescription"><a name="d41e110"></a>
207
208
209 <p>If a <tt>graphic</tt> or <tt>mediaobject</tt>
210 includes a reference to a filename that does not include an extension,
211 and the <tt>format</tt> attribute is
212 <i>unspecified</i>, the default extension will be used.
213
214 </p>
215
216
217 </div>
218 </div>
219 <hr>
220 <div class="refentry">
221 <h1 class="title"><a name="attrset.formal.title.properties"></a>formal.title.properties mode
222 </h1>
223 <div class="refnamediv"><a name="d41e128"></a><h2>Name</h2>formal.title.properties mode &#8212; Properties of formal object titles
224 </div>
225 <div class="refdescription"><a name="d41e133"></a>
226
227
228 <p>This attribute set is used to specify the properties of formal
229 object titles.
230
231 </p>
232
233
234 </div>
235 </div>
236 <hr>
237 <div class="refentry">
238 <h1 class="title"><a name="attrset.component.title.properties"></a>component.title.properties mode
239 </h1>
240 <div class="refnamediv"><a name="d41e139"></a><h2>Name</h2>component.title.properties mode &#8212; Properties of component titles
241 </div>
242 <div class="refdescription"><a name="d41e144"></a>
243
244
245 <p>This attribute set is used to specify the properties of component
246 titles.
247
248 </p>
249
250
251 </div>
252 </div>
253 <hr>
254 <div class="refentry">
255 <h1 class="title"><a name="attrset.admonition.title.properties"></a>admonition.title.properties mode
256 </h1>
257 <div class="refnamediv"><a name="d41e150"></a><h2>Name</h2>admonition.title.properties mode &#8212; Properties of admonition titles
258 </div>
259 <div class="refdescription"><a name="d41e155"></a>
260
261
262 <p>This attribute set is used to specify the properties of admonition
263 titles.
264
265 </p>
266
267
268 </div>
269 </div>
270 <hr>
271 <div class="refentry">
272 <h1 class="title"><a name="attrset.xref.properties"></a>xref.properties mode
273 </h1>
274 <div class="refnamediv"><a name="d41e161"></a><h2>Name</h2>xref.properties mode &#8212; Visual properties of hotlinks
275 </div>
276 <div class="refdescription"><a name="d41e166"></a>
277
278
279 <p>This attribute set is used to specify properties of xrefs
280
281 </p>
282
283
284 </div>
285 </div>
286 <hr>
287 <div class="refentry">
288 <h1 class="title"><a name="param.insert.xref.page.number"></a>insert.xref.page.number
289 </h1>
290 <div class="refnamediv"><a name="d41e172"></a><h2>Name</h2>insert.xref.page.number &#8212; Turns page numbers in xrefs on and off
291 </div>
292 <div class="refsynopsisdiv"><a name="d41e177"></a><h2>Synopsis</h2><pre class="synopsis">
293 &lt;xsl:param name="insert.xref.page.number" select="0" doc:type="boolean"/&gt;</pre></div>
294 <div class="refdescription"><a name="d41e180"></a>
295
296
297 <p>When equal to 1, this parameter triggers generation of page
298 number citations after xrefs.
299
300 </p>
301
302
303 </div>
304 </div>
305 <hr>
306 <div class="refentry">
307 <h1 class="title"><a name="attrset.normal.para.spacing"></a>normal.para.spacing mode
308 </h1>
309 <div class="refnamediv"><a name="d41e186"></a><h2>Name</h2>normal.para.spacing mode &#8212; Spacing properties of normal paragraphs
310 </div>
311 <div class="refdescription"><a name="d41e191"></a>
312
313
314 <p>This attribute set is used to specify the spacing properties
315 of normal paragraphs.
316
317 </p>
318
319
320 </div>
321 </div>
322 <hr>
323 <div class="refentry">
324 <h1 class="title"><a name="attrset.list.block.spacing"></a>list.block.spacing mode
325 </h1>
326 <div class="refnamediv"><a name="d41e197"></a><h2>Name</h2>list.block.spacing mode &#8212; Spacing properties of list blocks
327 </div>
328 <div class="refdescription"><a name="d41e202"></a>
329
330
331 <p>This attribute set is used to specify the spacing properties
332 of list blocks.
333
334 </p>
335
336
337 </div>
338 </div>
339 <hr>
340 <div class="refentry">
341 <h1 class="title"><a name="attrset.list.item.spacing"></a>list.item.spacing mode
342 </h1>
343 <div class="refnamediv"><a name="d41e208"></a><h2>Name</h2>list.item.spacing mode &#8212; Spacing properties of list items
344 </div>
345 <div class="refdescription"><a name="d41e213"></a>
346
347
348 <p>This attribute set is used to specify the spacing properties
349 of list items.
350
351 </p>
352
353
354 </div>
355 </div>
356 <hr>
357 <div class="refentry">
358 <h1 class="title"><a name="param.rootid"></a>rootid
359 </h1>
360 <div class="refnamediv"><a name="d41e219"></a><h2>Name</h2>rootid &#8212; Specify the root element to format
361 </div>
362 <div class="refsynopsisdiv"><a name="d41e224"></a><h2>Synopsis</h2><pre class="synopsis">
363 &lt;xsl:param name="rootid" select="''"/&gt;</pre></div>
364 <div class="refdescription"><a name="d41e227"></a>
365
366
367 <p>If <i><tt>rootid</tt></i> is specified, it must be the
368 value of an ID that occurs in the document being formatted. The entire
369 document will be loaded and parsed, but formatting will begin at the
370 element identified, rather than at the root. For example, this allows
371 you to process only chapter 4 of a book.
372 </p>
373
374
375
376 <p>Because the entire document is available to the processor, automatic
377 numbering, cross references, and other dependencies are correctly
378 resolved.
379 </p>
380
381
382 </div>
383 </div>
384 <hr>
385 <div class="refentry">
386 <h1 class="title"><a name="param.callout.graphics"></a>callout.graphics
387 </h1>
388 <div class="refnamediv"><a name="d41e239"></a><h2>Name</h2>callout.graphics &#8212; Use graphics for callouts?
389 </div>
390 <div class="refsynopsisdiv"><a name="d41e244"></a><h2>Synopsis</h2><pre class="synopsis">
391 &lt;xsl:param name="callout.graphics" select="'0'"/&gt;</pre></div>
392 <div class="refdescription"><a name="d41e247"></a>
393
394
395 <p>If non-zero, callouts are presented with graphics (e.g., reverse-video
396 circled numbers instead of "(1)", "(2)", etc.).
397 Default graphics are provided in the distribution.
398
399 </p>
400
401
402 </div>
403 </div>
404 <hr>
405 <div class="refentry">
406 <h1 class="title"><a name="param.callout.unicode"></a>callout.unicode
407 </h1>
408 <div class="refnamediv"><a name="d41e253"></a><h2>Name</h2>callout.unicode &#8212; First character to use for Unicode callouts
409 </div>
410 <div class="refsynopsisdiv"><a name="d41e258"></a><h2>Synopsis</h2><pre class="synopsis">
411 &lt;xsl:param name="callout.unicode" select="1"/&gt;</pre></div>
412 <div class="refdescription"><a name="d41e261"></a>
413
414
415 <p>If non-zero, callouts are presented with Unicode characters
416 starting with the character specified. Zero indicates that Unicode
417 callouts should not be used.
418
419 </p>
420
421
422 </div>
423 </div>
424 <hr>
425 <div class="refentry">
426 <h1 class="title"><a name="param.callout.dingbats"></a>callout.dingbats
427 </h1>
428 <div class="refnamediv"><a name="d41e267"></a><h2>Name</h2>callout.dingbats &#8212; Use Zapf Dingbats for callouts?
429 </div>
430 <div class="refsynopsisdiv"><a name="d41e272"></a><h2>Synopsis</h2><pre class="synopsis">
431 &lt;xsl:param name="callout.dingbats" select="'0'"/&gt;</pre></div>
432 <div class="refdescription"><a name="d41e275"></a>
433
434
435 <p>If non-zero, callouts are presented with Zapf Dingbats.
436
437 </p>
438
439
440 </div>
441 </div>
442 <hr>
443 <div class="refentry">
444 <h1 class="title"><a name="param.callout.unicode.start.character"></a>callout.unicode.start.character
445 </h1>
446 <div class="refnamediv"><a name="d41e281"></a><h2>Name</h2>callout.unicode.start.character &#8212; Number of the largest callout graphic
447 </div>
448 <div class="refsynopsisdiv"><a name="d41e286"></a><h2>Synopsis</h2><pre class="synopsis">
449 &lt;xsl:param name="callout.unicode.start.character" select="10102" doc:type="integer"/&gt;</pre></div>
450 <div class="refdescription"><a name="d41e289"></a>
451
452
453 <p>If <i><tt>callout.graphics</tt></i>
454 is non-zero, graphics are used to represent
455 callout numbers. The value of
456 <i><tt>callout.graphics.number.limit</tt></i>
457 is
458 the largest number for which a graphic exists. If the callout number
459 exceeds this limit, the default presentation "(nnn)" will always
460 be used.
461
462 </p>
463
464
465 </div>
466 </div>
467 <hr>
468 <div class="refentry">
469 <h1 class="title"><a name="param.callout.unicode.number.limit"></a>callout.unicode.number.limit
470 </h1>
471 <div class="refnamediv"><a name="d41e301"></a><h2>Name</h2>callout.unicode.number.limit &#8212; Number of the largest callout graphic
472 </div>
473 <div class="refsynopsisdiv"><a name="d41e306"></a><h2>Synopsis</h2><pre class="synopsis">
474 &lt;xsl:param name="callout.unicode.number.limit" select="'10'" doc:type="integer"/&gt;</pre></div>
475 <div class="refdescription"><a name="d41e309"></a>
476
477
478 <p>If <i><tt>callout.graphics</tt></i>
479 is non-zero, graphics are used to represent
480 callout numbers. The value of
481 <i><tt>callout.graphics.number.limit</tt></i>
482 is
483 the largest number for which a graphic exists. If the callout number
484 exceeds this limit, the default presentation "(nnn)" will always
485 be used.
486
487 </p>
488
489
490 </div>
491 </div>
492 <hr>
493 <div class="refentry">
494 <h1 class="title"><a name="param.callout.graphics.extension"></a>callout.graphics.extension
495 </h1>
496 <div class="refnamediv"><a name="d41e321"></a><h2>Name</h2>callout.graphics.extension &#8212; Extension for callout graphics
497 </div>
498 <div class="refsynopsisdiv"><a name="d41e326"></a><h2>Synopsis</h2><pre class="synopsis">
499 &lt;xsl:param name="callout.graphics.extension" select="'.png'"/&gt;</pre></div>
500 <div class="refdescription"><a name="d41e329"></a>
501
502
503 <p>Sets the extension to use on callout graphics.</p>
504
505
506 </div>
507 </div>
508 <hr>
509 <div class="refentry">
510 <h1 class="title"><a name="param.callout.graphics.path"></a>callout.graphics.path
511 </h1>
512 <div class="refnamediv"><a name="d41e335"></a><h2>Name</h2>callout.graphics.path &#8212; Path to callout graphics
513 </div>
514 <div class="refsynopsisdiv"><a name="d41e340"></a><h2>Synopsis</h2><pre class="synopsis">
515 &lt;xsl:param name="callout.graphics.path" select="'../images/callouts/'"/&gt;</pre></div>
516 <div class="refdescription"><a name="d41e343"></a>
517
518
519 <p>Sets the path, probably relative to the directory where the HTML
520 files are created, to the callout graphics.
521
522 </p>
523
524
525 </div>
526 </div>
527 <hr>
528 <div class="refentry">
529 <h1 class="title"><a name="param.callout.graphics.number.limit"></a>callout.graphics.number.limit
530 </h1>
531 <div class="refnamediv"><a name="d41e349"></a><h2>Name</h2>callout.graphics.number.limit &#8212; Number of the largest callout graphic
532 </div>
533 <div class="refsynopsisdiv"><a name="d41e354"></a><h2>Synopsis</h2><pre class="synopsis">
534 &lt;xsl:param name="callout.graphics.number.limit" select="'10'"/&gt;</pre></div>
535 <div class="refdescription"><a name="d41e357"></a>
536
537
538 <p>If <i><tt>callout.graphics</tt></i>
539 is non-zero, graphics are used to represent
540 callout numbers. The value of
541 <i><tt>callout.graphics.number.limit</tt></i>
542 is
543 the largest number for which a graphic exists. If the callout number
544 exceeds this limit, the default presentation "(nnn)" will always
545 be used.
546
547 </p>
548
549
550 </div>
551 </div>
552 <hr>
553 <div class="refentry">
554 <h1 class="title"><a name="param.use.extensions"></a>use.extensions
555 </h1>
556 <div class="refnamediv"><a name="d41e369"></a><h2>Name</h2>use.extensions &#8212; Enable extensions
557 </div>
558 <div class="refsynopsisdiv"><a name="d41e374"></a><h2>Synopsis</h2><pre class="synopsis">
559 &lt;xsl:param name="use.extensions" select="'0'"/&gt;</pre></div>
560 <div class="refdescription"><a name="d41e377"></a>
561
562
563 <p>If non-zero, extensions may be used. Each extension is
564 further controlled by its own parameter. But if
565 <i><tt>use.extensions</tt></i> is zero, no extensions will
566 be used.
567
568 </p>
569
570
571 </div>
572 </div>
573 <hr>
574 <div class="refentry">
575 <h1 class="title"><a name="param.textinsert.extension"></a>textinsert.extension
576 </h1>
577 <div class="refnamediv"><a name="d41e386"></a><h2>Name</h2>textinsert.extension &#8212; Enable the textinsert extension element
578 </div>
579 <div class="refsynopsisdiv"><a name="d41e391"></a><h2>Synopsis</h2><pre class="synopsis">
580 &lt;xsl:param name="textinsert.extension" select="'1'"/&gt;</pre></div>
581 <div class="refdescription"><a name="d41e394"></a>
582
583
584 <p>The textinsert extension element inserts the contents of a
585 a file into the result tree (as text).
586
587 </p>
588
589
590 </div>
591 </div>
592 <hr>
593 <div class="refentry">
594 <h1 class="title"><a name="param.linenumbering.extension"></a>linenumbering.extension
595 </h1>
596 <div class="refnamediv"><a name="d41e400"></a><h2>Name</h2>linenumbering.extension &#8212; Enable the line numbering extension
597 </div>
598 <div class="refsynopsisdiv"><a name="d41e405"></a><h2>Synopsis</h2><pre class="synopsis">
599 &lt;xsl:param name="linenumbering.extension" select="'1'"/&gt;</pre></div>
600 <div class="refdescription"><a name="d41e408"></a>
601
602
603 <p>If true, verbatim environments (elements that have the
604 format='linespecific' notation attribute: address, literallayout,
605 programlisting, screen, synopsis) that specify line numbering will
606 have, surprise, line numbers.
607
608 </p>
609
610
611 </div>
612 </div>
613 <hr>
614 <div class="refentry">
615 <h1 class="title"><a name="param.linenumbering.everyNth"></a>linenumbering.everyNth
616 </h1>
617 <div class="refnamediv"><a name="d41e414"></a><h2>Name</h2>linenumbering.everyNth &#8212; Indicate which lines should be numbered
618 </div>
619 <div class="refsynopsisdiv"><a name="d41e419"></a><h2>Synopsis</h2><pre class="synopsis">
620 &lt;xsl:param name="linenumbering.everyNth" select="'5'"/&gt;</pre></div>
621 <div class="refdescription"><a name="d41e422"></a>
622
623
624 <p>If line numbering is enabled, everyNth line will be numbered.
625
626 </p>
627
628
629 </div>
630 </div>
631 <hr>
632 <div class="refentry">
633 <h1 class="title"><a name="param.linenumbering.width"></a>linenumbering.width
634 </h1>
635 <div class="refnamediv"><a name="d41e428"></a><h2>Name</h2>linenumbering.width &#8212; Indicates the width of line numbers
636 </div>
637 <div class="refsynopsisdiv"><a name="d41e433"></a><h2>Synopsis</h2><pre class="synopsis">
638 &lt;xsl:param name="linenumbering.width" select="'3'"/&gt;</pre></div>
639 <div class="refdescription"><a name="d41e436"></a>
640
641
642 <p>If line numbering is enabled, line numbers will appear right
643 justified in a field "width" characters wide.
644
645 </p>
646
647
648 </div>
649 </div>
650 <hr>
651 <div class="refentry">
652 <h1 class="title"><a name="param.linenumbering.separator"></a>linenumbering.separator
653 </h1>
654 <div class="refnamediv"><a name="d41e442"></a><h2>Name</h2>linenumbering.separator &#8212; Specify a separator between line numbers and lines
655 </div>
656 <div class="refsynopsisdiv"><a name="d41e447"></a><h2>Synopsis</h2><pre class="synopsis">
657 &lt;xsl:param name="linenumbering.separator" select="' '"/&gt;</pre></div>
658 <div class="refdescription"><a name="d41e450"></a>
659
660
661 <p>The separator is inserted between line numbers and lines in
662 the verbatim environment.
663
664 </p>
665
666
667 </div>
668 </div>
669 <hr>
670 <div class="refentry">
671 <h1 class="title"><a name="param.callouts.extension"></a>callouts.extension
672 </h1>
673 <div class="refnamediv"><a name="d41e456"></a><h2>Name</h2>callouts.extension &#8212; Enable the callout extension
674 </div>
675 <div class="refsynopsisdiv"><a name="d41e461"></a><h2>Synopsis</h2><pre class="synopsis">
676 &lt;xsl:param name="callouts.extension" select="'1'"/&gt;</pre></div>
677 <div class="refdescription"><a name="d41e464"></a>
678
679
680 <p>The callouts extension processes <tt>areaset</tt>
681 elements in <tt>ProgramListingCO</tt> and other text-based
682 callout elements.
683
684 </p>
685
686
687 </div>
688 </div>
689 <hr>
690 <div class="refentry">
691 <h1 class="title"><a name="param.callout.defaultcolumn"></a>callout.defaultcolumn
692 </h1>
693 <div class="refnamediv"><a name="d41e476"></a><h2>Name</h2>callout.defaultcolumn &#8212; Indicates what column callouts appear in by default
694 </div>
695 <div class="refsynopsisdiv"><a name="d41e481"></a><h2>Synopsis</h2><pre class="synopsis">
696 &lt;xsl:param name="callout.defaultcolumn" select="'60'"/&gt;</pre></div>
697 <div class="refdescription"><a name="d41e484"></a>
698
699
700 <p>If a callout does not identify a column (for example, if it uses
701 the <tt>linerange</tt> <tt>unit</tt>),
702 it will appear in the default column.
703
704 </p>
705
706
707 </div>
708 </div>
709 <hr>
710 <div class="refentry">
711 <h1 class="title"><a name="param.tablecolumns.extension"></a>tablecolumns.extension
712 </h1>
713 <div class="refnamediv"><a name="d41e496"></a><h2>Name</h2>tablecolumns.extension &#8212; Enable the table columns extension function
714 </div>
715 <div class="refsynopsisdiv"><a name="d41e501"></a><h2>Synopsis</h2><pre class="synopsis">
716 &lt;xsl:param name="tablecolumns.extension" select="'1'" doc:type="boolean"/&gt;</pre></div>
717 <div class="refdescription"><a name="d41e504"></a>
718
719
720 <p>The table columns extension function adjusts the widths of table
721 columns in the HTML result to more accurately reflect the specifications
722 in the CALS table.
723
724 </p>
725
726
727 </div>
728 </div>
729 <hr>
730 <div class="refentry">
731 <h1 class="title"><a name="param.nominal.table.width"></a>nominal.table.width
732 </h1>
733 <div class="refnamediv"><a name="d41e510"></a><h2>Name</h2>nominal.table.width &#8212; The (absolute) nominal width of tables
734 </div>
735 <div class="refsynopsisdiv"><a name="d41e515"></a><h2>Synopsis</h2><pre class="synopsis">
736 &lt;xsl:param name="nominal.table.width" select="'6in'" doc:type="length"/&gt;</pre></div>
737 <div class="refdescription"><a name="d41e518"></a>
738
739
740 <p>In order to convert CALS column widths into FO column widths, it
741 is sometimes necessary to have an absolute table width to use for conversion
742 of mixed absolute and relative widths. This value must be an absolute
743 length (not a percentage).
744 </p>
745
746
747 </div>
748 </div>
749 <hr>
750 <div class="refentry">
751 <h1 class="title"><a name="param.default.table.width"></a>default.table.width
752 </h1>
753 <div class="refnamediv"><a name="d41e524"></a><h2>Name</h2>default.table.width &#8212; The default width of tables
754 </div>
755 <div class="refsynopsisdiv"><a name="d41e529"></a><h2>Synopsis</h2><pre class="synopsis">
756 &lt;xsl:param name="default.table.width" select="''" doc:type="length"/&gt;</pre></div>
757 <div class="refdescription"><a name="d41e532"></a>
758
759
760 <p>If specified, this value will be used for the WIDTH attribute on
761 tables that do not specify an alternate width (with the dbhtml processing
762 instruction).
763 </p>
764
765
766 </div>
767 </div>
768 <hr>
769 <div class="refentry">
770 <h1 class="title"><a name="param.paper.type"></a>paper.type
771 </h1>
772 <div class="refnamediv"><a name="d41e538"></a><h2>Name</h2>paper.type &#8212; Select the paper type
773 </div>
774 <div class="refsynopsisdiv"><a name="d41e543"></a><h2>Synopsis</h2><pre class="synopsis">
775 &lt;xsl:param name="paper.type" select="'USletter'"/&gt;</pre></div>
776 <div class="refdescription"><a name="d41e546"></a>
777
778
779 <p>The paper type is a convenient way to specify the paper size.
780 The list of known paper sizes includes USletter and most of the A,
781 B, and C sizes. See <tt>page.width.portrait</tt>, for example.
782
783 </p>
784
785
786 </div>
787 </div>
788 <hr>
789 <div class="refentry">
790 <h1 class="title"><a name="param.page.orientation"></a>page.orientation
791 </h1>
792 <div class="refnamediv"><a name="d41e555"></a><h2>Name</h2>page.orientation &#8212; Select the page orientation
793 </div>
794 <div class="refsynopsisdiv"><a name="d41e560"></a><h2>Synopsis</h2><pre class="synopsis">
795 &lt;xsl:param name="page.orientation" select="'portrait'"/&gt;</pre></div>
796 <div class="refdescription"><a name="d41e563"></a>
797
798
799 <p>In portrait orientation, the short edge is horizontal; in
800 landscape orientation, it is vertical.
801
802 </p>
803
804
805 </div>
806 </div>
807 <hr>
808 <div class="refentry">
809 <h1 class="title"><a name="param.page.width.portrait"></a>page.width.portrait
810 </h1>
811 <div class="refnamediv"><a name="d41e569"></a><h2>Name</h2>page.width.portrait &#8212; Specify the physical size of the short edge of the page
812 </div>
813 <div class="refsynopsisdiv"><a name="d41e574"></a><h2>Synopsis</h2><pre class="synopsis">
814 &lt;xsl:param name="page.width.portrait"&gt;
815 &lt;xsl:choose&gt;
816 &lt;xsl:when test="$paper.type = 'USletter'"&gt;8.5in&lt;/xsl:when&gt;
817 &lt;xsl:when test="$paper.type = '4A0'"&gt;1682mm&lt;/xsl:when&gt;
818 &lt;xsl:when test="$paper.type = '2A0'"&gt;1189mm&lt;/xsl:when&gt;
819 &lt;xsl:when test="$paper.type = 'A0'"&gt;841mm&lt;/xsl:when&gt;
820 &lt;xsl:when test="$paper.type = 'A1'"&gt;594mm&lt;/xsl:when&gt;
821 &lt;xsl:when test="$paper.type = 'A2'"&gt;420mm&lt;/xsl:when&gt;
822 &lt;xsl:when test="$paper.type = 'A3'"&gt;297mm&lt;/xsl:when&gt;
823 &lt;xsl:when test="$paper.type = 'A4'"&gt;210mm&lt;/xsl:when&gt;
824 &lt;xsl:when test="$paper.type = 'A5'"&gt;148mm&lt;/xsl:when&gt;
825 &lt;xsl:when test="$paper.type = 'A6'"&gt;105mm&lt;/xsl:when&gt;
826 &lt;xsl:when test="$paper.type = 'A7'"&gt;74mm&lt;/xsl:when&gt;
827 &lt;xsl:when test="$paper.type = 'A8'"&gt;52mm&lt;/xsl:when&gt;
828 &lt;xsl:when test="$paper.type = 'A9'"&gt;37mm&lt;/xsl:when&gt;
829 &lt;xsl:when test="$paper.type = 'A10'"&gt;26mm&lt;/xsl:when&gt;
830 &lt;xsl:when test="$paper.type = 'B0'"&gt;1000mm&lt;/xsl:when&gt;
831 &lt;xsl:when test="$paper.type = 'B1'"&gt;707mm&lt;/xsl:when&gt;
832 &lt;xsl:when test="$paper.type = 'B2'"&gt;500mm&lt;/xsl:when&gt;
833 &lt;xsl:when test="$paper.type = 'B3'"&gt;353mm&lt;/xsl:when&gt;
834 &lt;xsl:when test="$paper.type = 'B4'"&gt;250mm&lt;/xsl:when&gt;
835 &lt;xsl:when test="$paper.type = 'B5'"&gt;176mm&lt;/xsl:when&gt;
836 &lt;xsl:when test="$paper.type = 'B6'"&gt;125mm&lt;/xsl:when&gt;
837 &lt;xsl:when test="$paper.type = 'B7'"&gt;88mm&lt;/xsl:when&gt;
838 &lt;xsl:when test="$paper.type = 'B8'"&gt;62mm&lt;/xsl:when&gt;
839 &lt;xsl:when test="$paper.type = 'B9'"&gt;44mm&lt;/xsl:when&gt;
840 &lt;xsl:when test="$paper.type = 'B10'"&gt;31mm&lt;/xsl:when&gt;
841 &lt;xsl:when test="$paper.type = 'C0'"&gt;917mm&lt;/xsl:when&gt;
842 &lt;xsl:when test="$paper.type = 'C1'"&gt;648mm&lt;/xsl:when&gt;
843 &lt;xsl:when test="$paper.type = 'C2'"&gt;458mm&lt;/xsl:when&gt;
844 &lt;xsl:when test="$paper.type = 'C3'"&gt;324mm&lt;/xsl:when&gt;
845 &lt;xsl:when test="$paper.type = 'C4'"&gt;229mm&lt;/xsl:when&gt;
846 &lt;xsl:when test="$paper.type = 'C5'"&gt;162mm&lt;/xsl:when&gt;
847 &lt;xsl:when test="$paper.type = 'C6'"&gt;114mm&lt;/xsl:when&gt;
848 &lt;xsl:when test="$paper.type = 'C7'"&gt;81mm&lt;/xsl:when&gt;
849 &lt;xsl:when test="$paper.type = 'C8'"&gt;57mm&lt;/xsl:when&gt;
850 &lt;xsl:when test="$paper.type = 'C9'"&gt;40mm&lt;/xsl:when&gt;
851 &lt;xsl:when test="$paper.type = 'C10'"&gt;28mm&lt;/xsl:when&gt;
852 &lt;xsl:otherwise&gt;8.5in&lt;/xsl:otherwise&gt;
853 &lt;/xsl:choose&gt;
854 &lt;/xsl:param&gt;</pre></div>
855 <div class="refdescription"><a name="d41e577"></a>
856
857
858 <p>The portrait page width is the length of the short
859 edge of the physical page.
860
861 </p>
862
863
864 </div>
865 </div>
866 <hr>
867 <div class="refentry">
868 <h1 class="title"><a name="param.page.height.portrait"></a>page.height.portrait
869 </h1>
870 <div class="refnamediv"><a name="d41e583"></a><h2>Name</h2>page.height.portrait &#8212; Specify the physical size of the long edge of the page
871 </div>
872 <div class="refsynopsisdiv"><a name="d41e588"></a><h2>Synopsis</h2><pre class="synopsis">
873 &lt;xsl:param name="page.height.portrait"&gt;
874 &lt;xsl:choose&gt;
875 &lt;xsl:when test="$paper.type = 'A4landscape'"&gt;210mm&lt;/xsl:when&gt;
876 &lt;xsl:when test="$paper.type = 'USletter'"&gt;11in&lt;/xsl:when&gt;
877 &lt;xsl:when test="$paper.type = 'USlandscape'"&gt;8.5in&lt;/xsl:when&gt;
878 &lt;xsl:when test="$paper.type = '4A0'"&gt;2378mm&lt;/xsl:when&gt;
879 &lt;xsl:when test="$paper.type = '2A0'"&gt;1682mm&lt;/xsl:when&gt;
880 &lt;xsl:when test="$paper.type = 'A0'"&gt;1189mm&lt;/xsl:when&gt;
881 &lt;xsl:when test="$paper.type = 'A1'"&gt;841mm&lt;/xsl:when&gt;
882 &lt;xsl:when test="$paper.type = 'A2'"&gt;594mm&lt;/xsl:when&gt;
883 &lt;xsl:when test="$paper.type = 'A3'"&gt;420mm&lt;/xsl:when&gt;
884 &lt;xsl:when test="$paper.type = 'A4'"&gt;297mm&lt;/xsl:when&gt;
885 &lt;xsl:when test="$paper.type = 'A5'"&gt;210mm&lt;/xsl:when&gt;
886 &lt;xsl:when test="$paper.type = 'A6'"&gt;148mm&lt;/xsl:when&gt;
887 &lt;xsl:when test="$paper.type = 'A7'"&gt;105mm&lt;/xsl:when&gt;
888 &lt;xsl:when test="$paper.type = 'A8'"&gt;74mm&lt;/xsl:when&gt;
889 &lt;xsl:when test="$paper.type = 'A9'"&gt;52mm&lt;/xsl:when&gt;
890 &lt;xsl:when test="$paper.type = 'A10'"&gt;37mm&lt;/xsl:when&gt;
891 &lt;xsl:when test="$paper.type = 'B0'"&gt;1414mm&lt;/xsl:when&gt;
892 &lt;xsl:when test="$paper.type = 'B1'"&gt;1000mm&lt;/xsl:when&gt;
893 &lt;xsl:when test="$paper.type = 'B2'"&gt;707mm&lt;/xsl:when&gt;
894 &lt;xsl:when test="$paper.type = 'B3'"&gt;500mm&lt;/xsl:when&gt;
895 &lt;xsl:when test="$paper.type = 'B4'"&gt;353mm&lt;/xsl:when&gt;
896 &lt;xsl:when test="$paper.type = 'B5'"&gt;250mm&lt;/xsl:when&gt;
897 &lt;xsl:when test="$paper.type = 'B6'"&gt;176mm&lt;/xsl:when&gt;
898 &lt;xsl:when test="$paper.type = 'B7'"&gt;125mm&lt;/xsl:when&gt;
899 &lt;xsl:when test="$paper.type = 'B8'"&gt;88mm&lt;/xsl:when&gt;
900 &lt;xsl:when test="$paper.type = 'B9'"&gt;62mm&lt;/xsl:when&gt;
901 &lt;xsl:when test="$paper.type = 'B10'"&gt;44mm&lt;/xsl:when&gt;
902 &lt;xsl:when test="$paper.type = 'C0'"&gt;1297mm&lt;/xsl:when&gt;
903 &lt;xsl:when test="$paper.type = 'C1'"&gt;917mm&lt;/xsl:when&gt;
904 &lt;xsl:when test="$paper.type = 'C2'"&gt;648mm&lt;/xsl:when&gt;
905 &lt;xsl:when test="$paper.type = 'C3'"&gt;458mm&lt;/xsl:when&gt;
906 &lt;xsl:when test="$paper.type = 'C4'"&gt;324mm&lt;/xsl:when&gt;
907 &lt;xsl:when test="$paper.type = 'C5'"&gt;229mm&lt;/xsl:when&gt;
908 &lt;xsl:when test="$paper.type = 'C6'"&gt;162mm&lt;/xsl:when&gt;
909 &lt;xsl:when test="$paper.type = 'C7'"&gt;114mm&lt;/xsl:when&gt;
910 &lt;xsl:when test="$paper.type = 'C8'"&gt;81mm&lt;/xsl:when&gt;
911 &lt;xsl:when test="$paper.type = 'C9'"&gt;57mm&lt;/xsl:when&gt;
912 &lt;xsl:when test="$paper.type = 'C10'"&gt;40mm&lt;/xsl:when&gt;
913 &lt;xsl:otherwise&gt;11in&lt;/xsl:otherwise&gt;
914 &lt;/xsl:choose&gt;
915 &lt;/xsl:param&gt;</pre></div>
916 <div class="refdescription"><a name="d41e591"></a>
917
918
919 <p>The portrait page height is the length of the long
920 edge of the physical page.
921
922 </p>
923
924
925 </div>
926 </div>
927 <hr>
928 <div class="refentry">
929 <h1 class="title"><a name="param.page.width"></a>page.width
930 </h1>
931 <div class="refnamediv"><a name="d41e597"></a><h2>Name</h2>page.width &#8212; The width of the physical page
932 </div>
933 <div class="refsynopsisdiv"><a name="d41e602"></a><h2>Synopsis</h2><pre class="synopsis">
934 &lt;xsl:param name="page.width"&gt;
935 &lt;xsl:choose&gt;
936 &lt;xsl:when test="$page.orientation = 'portrait'"&gt;
937 &lt;xsl:value-of select="$page.width.portrait"/&gt;
938 &lt;/xsl:when&gt;
939 &lt;xsl:otherwise&gt;
940 &lt;xsl:value-of select="$page.height.portrait"/&gt;
941 &lt;/xsl:otherwise&gt;
942 &lt;/xsl:choose&gt;
943 &lt;/xsl:param&gt;</pre></div>
944 <div class="refdescription"><a name="d41e605"></a>
945
946
947 <p>The page width is generally calculated from the
948 <tt>paper.type</tt> and
949 <tt>page.orientation</tt>.
950
951 </p>
952
953
954 </div>
955 </div>
956 <hr>
957 <div class="refentry">
958 <h1 class="title"><a name="param.page.height"></a>page.height
959 </h1>
960 <div class="refnamediv"><a name="d41e617"></a><h2>Name</h2>page.height &#8212; The height of the physical page
961 </div>
962 <div class="refsynopsisdiv"><a name="d41e622"></a><h2>Synopsis</h2><pre class="synopsis">
963 &lt;xsl:param name="page.height"&gt;
964 &lt;xsl:choose&gt;
965 &lt;xsl:when test="$page.orientation = 'portrait'"&gt;
966 &lt;xsl:value-of select="$page.height.portrait"/&gt;
967 &lt;/xsl:when&gt;
968 &lt;xsl:otherwise&gt;
969 &lt;xsl:value-of select="$page.width.portrait"/&gt;
970 &lt;/xsl:otherwise&gt;
971 &lt;/xsl:choose&gt;
972 &lt;/xsl:param&gt;</pre></div>
973 <div class="refdescription"><a name="d41e625"></a>
974
975
976 <p>The page height is generally calculated from the
977 <tt>paper.type</tt> and
978 <tt>page.orientation</tt>.
979
980 </p>
981
982
983 </div>
984 </div>
985 <hr>
986 <div class="refentry">
987 <h1 class="title"><a name="param.double.sided"></a>double.sided
988 </h1>
989 <div class="refnamediv"><a name="d41e637"></a><h2>Name</h2>double.sided &#8212; Is the document to be printed double sided?
990 </div>
991 <div class="refsynopsisdiv"><a name="d41e642"></a><h2>Synopsis</h2><pre class="synopsis">
992 &lt;xsl:param name="double.sided" select="'0'"/&gt;</pre></div>
993 <div class="refdescription"><a name="d41e645"></a>
994
995
996 <p>Double-sided documents are printed with a slightly wider margin
997 on the binding edge of the page.
998
999 </p>
1000
1001
1002
1003 <p>FIXME: The current set of parameters does not take writing direction
1004 into account.
1005 </p>
1006
1007
1008 </div>
1009 </div>
1010 <hr>
1011 <div class="refentry">
1012 <h1 class="title"><a name="param.column.count"></a>column.count
1013 </h1>
1014 <div class="refnamediv"><a name="d41e654"></a><h2>Name</h2>column.count &#8212; Specifies the number of columns of text on the page
1015 </div>
1016 <div class="refsynopsisdiv"><a name="d41e659"></a><h2>Synopsis</h2><pre class="synopsis">
1017 &lt;xsl:param name="column.count" select="'1'"/&gt;</pre></div>
1018 <div class="refdescription"><a name="d41e662"></a>
1019
1020
1021 <p>The specified number of columns of text will appear on each page.
1022
1023 </p>
1024
1025
1026 </div>
1027 </div>
1028 <hr>
1029 <div class="refentry">
1030 <h1 class="title"><a name="param.region.after.extent"></a>region.after.extent
1031 </h1>
1032 <div class="refnamediv"><a name="d41e668"></a><h2>Name</h2>region.after.extent &#8212; Specifies the height of the footer.
1033 </div>
1034 <div class="refsynopsisdiv"><a name="d41e673"></a><h2>Synopsis</h2><pre class="synopsis">
1035 &lt;xsl:param name="region.after.extent" select="'12pt'"/&gt;</pre></div>
1036 <div class="refdescription"><a name="d41e676"></a>
1037
1038
1039 <p>The region after extent is the height of the area where footers
1040 are printed.
1041
1042 </p>
1043
1044
1045 </div>
1046 </div>
1047 <hr>
1048 <div class="refentry">
1049 <h1 class="title"><a name="param.region.before.extent"></a>region.before.extent
1050 </h1>
1051 <div class="refnamediv"><a name="d41e682"></a><h2>Name</h2>region.before.extent &#8212; Specifies the height of the header
1052 </div>
1053 <div class="refsynopsisdiv"><a name="d41e687"></a><h2>Synopsis</h2><pre class="synopsis">
1054 &lt;xsl:param name="region.before.extent" select="'12pt'"/&gt;</pre></div>
1055 <div class="refdescription"><a name="d41e690"></a>
1056
1057
1058 <p>The region before extent is the height of the area where headers
1059 are printed.
1060
1061 </p>
1062
1063
1064 </div>
1065 </div>
1066 <hr>
1067 <div class="refentry">
1068 <h1 class="title"><a name="param.page.margin.top"></a>page.margin.top
1069 </h1>
1070 <div class="refnamediv"><a name="d41e696"></a><h2>Name</h2>page.margin.top &#8212; The top margin of the page
1071 </div>
1072 <div class="refsynopsisdiv"><a name="d41e701"></a><h2>Synopsis</h2><pre class="synopsis">
1073 &lt;xsl:param name="page.margin.top"&gt;1in&lt;/xsl:param&gt;</pre></div>
1074 <div class="refdescription"><a name="d41e704"></a>
1075
1076
1077 <p>The top page margin is the distance from the physical top of the
1078 page to the first line of text (body or header).
1079
1080 </p>
1081
1082
1083 </div>
1084 </div>
1085 <hr>
1086 <div class="refentry">
1087 <h1 class="title"><a name="param.page.margin.bottom"></a>page.margin.bottom
1088 </h1>
1089 <div class="refnamediv"><a name="d41e710"></a><h2>Name</h2>page.margin.bottom &#8212; The bottom margin of the page
1090 </div>
1091 <div class="refsynopsisdiv"><a name="d41e715"></a><h2>Synopsis</h2><pre class="synopsis">
1092 &lt;xsl:param name="page.margin.bottom"&gt;1in&lt;/xsl:param&gt;</pre></div>
1093 <div class="refdescription"><a name="d41e718"></a>
1094
1095
1096 <p>The bottom page margin is the distance from the physical bottom of
1097 the page to the last line of text (body or footer).
1098
1099 </p>
1100
1101
1102 </div>
1103 </div>
1104 <hr>
1105 <div class="refentry">
1106 <h1 class="title"><a name="param.page.margin.inner"></a>page.margin.inner
1107 </h1>
1108 <div class="refnamediv"><a name="d41e724"></a><h2>Name</h2>page.margin.inner &#8212; The inner page margin
1109 </div>
1110 <div class="refsynopsisdiv"><a name="d41e729"></a><h2>Synopsis</h2><pre class="synopsis">
1111 &lt;xsl:param name="page.margin.inner"&gt;
1112 &lt;xsl:choose&gt;
1113 &lt;xsl:when test="$double.sided != 0"&gt;1.25in&lt;/xsl:when&gt;
1114 &lt;xsl:otherwise&gt;1in&lt;/xsl:otherwise&gt;
1115 &lt;/xsl:choose&gt;
1116 &lt;/xsl:param&gt;</pre></div>
1117 <div class="refdescription"><a name="d41e732"></a>
1118
1119
1120 <p>The inner page margin is the distance from binding edge of the
1121 page to the first column of text. In the left-to-right, top-to-bottom writing
1122 direction, this is the left margin of recto pages.
1123 </p>
1124
1125
1126
1127 <p>The inner and outer margins are usually the same unless the output
1128 is double-sided.
1129
1130 </p>
1131
1132
1133 </div>
1134 </div>
1135 <hr>
1136 <div class="refentry">
1137 <h1 class="title"><a name="param.page.margin.outer"></a>page.margin.outer
1138 </h1>
1139 <div class="refnamediv"><a name="d41e741"></a><h2>Name</h2>page.margin.outer &#8212; The outer page margin
1140 </div>
1141 <div class="refsynopsisdiv"><a name="d41e746"></a><h2>Synopsis</h2><pre class="synopsis">
1142 &lt;xsl:param name="page.margin.outer"&gt;
1143 &lt;xsl:choose&gt;
1144 &lt;xsl:when test="$double.sided != 0"&gt;0.75in&lt;/xsl:when&gt;
1145 &lt;xsl:otherwise&gt;10pc&lt;/xsl:otherwise&gt;
1146 &lt;/xsl:choose&gt;
1147 &lt;/xsl:param&gt;</pre></div>
1148 <div class="refdescription"><a name="d41e749"></a>
1149
1150
1151 <p>The outer page margin is the distance from non-binding edge of the
1152 page to the last column of text. In the left-to-right, top-to-bottom writing
1153 direction, this is the right margin of recto pages.
1154 </p>
1155
1156
1157
1158 <p>The inner and outer margins are usually the same unless the output
1159 is double-sided.
1160
1161 </p>
1162
1163
1164 </div>
1165 </div>
1166 <hr>
1167 <div class="refentry">
1168 <h1 class="title"><a name="param.body.margin.bottom"></a>body.margin.bottom
1169 </h1>
1170 <div class="refnamediv"><a name="d41e758"></a><h2>Name</h2>body.margin.bottom &#8212; The bottom margin of the body text
1171 </div>
1172 <div class="refsynopsisdiv"><a name="d41e763"></a><h2>Synopsis</h2><pre class="synopsis">
1173 &lt;xsl:param name="body.margin.bottom"&gt;24pt&lt;/xsl:param&gt;</pre></div>
1174 <div class="refdescription"><a name="d41e766"></a>
1175
1176
1177 <p>The body bottom margin is the distance from the last line of text
1178 in the page body to the bottom page margin. Note that the page footer, if
1179 any, appears in the space between the body bottom margin and the page
1180 bottom margin.
1181
1182 </p>
1183
1184
1185 </div>
1186 </div>
1187 <hr>
1188 <div class="refentry">
1189 <h1 class="title"><a name="param.body.margin.top"></a>body.margin.top
1190 </h1>
1191 <div class="refnamediv"><a name="d41e772"></a><h2>Name</h2>body.margin.top &#8212; FIXME:
1192 </div>
1193 <div class="refsynopsisdiv"><a name="d41e777"></a><h2>Synopsis</h2><pre class="synopsis">
1194 &lt;xsl:param name="body.margin.top"&gt;24pt&lt;/xsl:param&gt;</pre></div>
1195 <div class="refdescription"><a name="d41e780"></a>
1196
1197
1198 <p>The body top margin is the distance from the page top margin to
1199 the first line of text
1200 in the page body. Note that the page header, if
1201 any, appears in the space between the page top margin and the body
1202 top margin.
1203
1204 </p>
1205
1206
1207 </div>
1208 </div>
1209 <hr>
1210 <div class="refentry">
1211 <h1 class="title"><a name="param.body.font.family"></a>body.font.family
1212 </h1>
1213 <div class="refnamediv"><a name="d41e786"></a><h2>Name</h2>body.font.family &#8212; The default font family for body text
1214 </div>
1215 <div class="refsynopsisdiv"><a name="d41e791"></a><h2>Synopsis</h2><pre class="synopsis">
1216 &lt;xsl:param name="body.font.family"&gt;Times Roman&lt;/xsl:param&gt;</pre></div>
1217 <div class="refdescription"><a name="d41e794"></a>
1218
1219
1220 <p>The body font family is the default font used for text in the page body.
1221
1222 </p>
1223
1224
1225 </div>
1226 </div>
1227 <hr>
1228 <div class="refentry">
1229 <h1 class="title"><a name="param.title.font.family"></a>title.font.family
1230 </h1>
1231 <div class="refnamediv"><a name="d41e800"></a><h2>Name</h2>title.font.family &#8212; The default font family for titles
1232 </div>
1233 <div class="refsynopsisdiv"><a name="d41e805"></a><h2>Synopsis</h2><pre class="synopsis">
1234 &lt;xsl:param name="title.font.family"&gt;Helvetica&lt;/xsl:param&gt;</pre></div>
1235 <div class="refdescription"><a name="d41e808"></a>
1236
1237
1238 <p>The title font family is used for titles (chapter, section, figure,
1239 etc.)
1240
1241 </p>
1242
1243
1244 </div>
1245 </div>
1246 <hr>
1247 <div class="refentry">
1248 <h1 class="title"><a name="param.monospace.font.family"></a>monospace.font.family
1249 </h1>
1250 <div class="refnamediv"><a name="d41e814"></a><h2>Name</h2>monospace.font.family &#8212; The default font family for monospace environments
1251 </div>
1252 <div class="refsynopsisdiv"><a name="d41e819"></a><h2>Synopsis</h2><pre class="synopsis">
1253 &lt;xsl:param name="monospace.font.family"&gt;Courier&lt;/xsl:param&gt;</pre></div>
1254 <div class="refdescription"><a name="d41e822"></a>
1255
1256
1257 <p>The monospace font family is used for verbatim environments
1258 (program listings, screens, etc.).
1259
1260 </p>
1261
1262
1263 </div>
1264 </div>
1265 <hr>
1266 <div class="refentry">
1267 <h1 class="title"><a name="param.sans.font.family"></a>sans.font.family
1268 </h1>
1269 <div class="refnamediv"><a name="d41e828"></a><h2>Name</h2>sans.font.family &#8212; The default sans-serif font family
1270 </div>
1271 <div class="refsynopsisdiv"><a name="d41e833"></a><h2>Synopsis</h2><pre class="synopsis">
1272 &lt;xsl:param name="sans.font.family"&gt;Helvetica&lt;/xsl:param&gt;</pre></div>
1273 <div class="refdescription"><a name="d41e836"></a>
1274
1275
1276 <p>The default sans-serif font family. At the present, this isn't
1277 actually used by the stylesheets.
1278
1279 </p>
1280
1281
1282 </div>
1283 </div>
1284 <hr>
1285 <div class="refentry">
1286 <h1 class="title"><a name="param.body.font.master"></a>body.font.master
1287 </h1>
1288 <div class="refnamediv"><a name="d41e842"></a><h2>Name</h2>body.font.master &#8212; Specifies the default point size for body text
1289 </div>
1290 <div class="refsynopsisdiv"><a name="d41e847"></a><h2>Synopsis</h2><pre class="synopsis">
1291 &lt;xsl:param name="body.font.master"&gt;10&lt;/xsl:param&gt;</pre></div>
1292 <div class="refdescription"><a name="d41e850"></a>
1293
1294
1295 <p>The body font size is specified in two parameters
1296 (<tt>body.font.master</tt> and <tt>body.font.size</tt>)
1297 so that math can be performed on the font size by XSLT.
1298
1299 </p>
1300
1301
1302 </div>
1303 </div>
1304 <hr>
1305 <div class="refentry">
1306 <h1 class="title"><a name="param.body.font.size"></a>body.font.size
1307 </h1>
1308 <div class="refnamediv"><a name="d41e862"></a><h2>Name</h2>body.font.size &#8212; Specifies the default font size for body text
1309 </div>
1310 <div class="refsynopsisdiv"><a name="d41e867"></a><h2>Synopsis</h2><pre class="synopsis">
1311 &lt;xsl:param name="body.font.size"&gt;
1312 &lt;xsl:value-of select="$body.font.master"/&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
1313 &lt;/xsl:param&gt;</pre></div>
1314 <div class="refdescription"><a name="d41e870"></a>
1315
1316
1317 <p>The body font size is specified in two parameters
1318 (<tt>body.font.master</tt> and <tt>body.font.size</tt>)
1319 so that math can be performed on the font size by XSLT.
1320
1321 </p>
1322
1323
1324 </div>
1325 </div>
1326 <hr>
1327 <div class="refentry">
1328 <h1 class="title"><a name="param.footnote.font.size"></a>footnote.font.size
1329 </h1>
1330 <div class="refnamediv"><a name="d41e882"></a><h2>Name</h2>footnote.font.size &#8212; The font size for footnotes
1331 </div>
1332 <div class="refsynopsisdiv"><a name="d41e887"></a><h2>Synopsis</h2><pre class="synopsis">
1333 &lt;xsl:param name="footnote.font.size"&gt;
1334 &lt;xsl:value-of select="$body.font.master * 0.8"/&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
1335 &lt;/xsl:param&gt;</pre></div>
1336 <div class="refdescription"><a name="d41e890"></a>
1337
1338
1339 <p>The footnote font size is used for...footnotes!
1340
1341 </p>
1342
1343
1344 </div>
1345 </div>
1346 <hr>
1347 <div class="refentry">
1348 <h1 class="title"><a name="param.hyphenate"></a>hyphenate
1349 </h1>
1350 <div class="refnamediv"><a name="d41e896"></a><h2>Name</h2>hyphenate &#8212; Specify hyphenation behavior
1351 </div>
1352 <div class="refsynopsisdiv"><a name="d41e901"></a><h2>Synopsis</h2><pre class="synopsis">
1353 &lt;xsl:param name="hyphenate"&gt;true&lt;/xsl:param&gt;</pre></div>
1354 <div class="refdescription"><a name="d41e904"></a>
1355
1356
1357 <p>If true, words may be hyphenated. Otherwise, they may not.
1358
1359 </p>
1360
1361
1362 </div>
1363 </div>
1364 <hr>
1365 <div class="refentry">
1366 <h1 class="title"><a name="param.alignment"></a>alignment
1367 </h1>
1368 <div class="refnamediv"><a name="d41e910"></a><h2>Name</h2>alignment &#8212; Specify the default text alignment
1369 </div>
1370 <div class="refsynopsisdiv"><a name="d41e915"></a><h2>Synopsis</h2><pre class="synopsis">
1371 &lt;xsl:param name="alignment"&gt;justify&lt;/xsl:param&gt;</pre></div>
1372 <div class="refdescription"><a name="d41e918"></a>
1373
1374
1375 <p>The default text alignment is used for most body text.
1376
1377 </p>
1378
1379
1380 </div>
1381 </div>
1382 <hr>
1383 <div class="refentry">
1384 <h1 class="title"><a name="param.stylesheet.result.type"></a>stylesheet.result.type
1385 </h1>
1386 <div class="refnamediv"><a name="d41e924"></a><h2>Name</h2>stylesheet.result.type &#8212; Identifies the output format of this stylesheet
1387 </div>
1388 <div class="refsynopsisdiv"><a name="d41e929"></a><h2>Synopsis</h2><pre class="synopsis">
1389 &lt;xsl:param name="stylesheet.result.type" select="'fo'"/&gt;</pre></div>
1390 <div class="refdescription"><a name="d41e932"></a>
1391
1392
1393 <p>The extension functions need to know if the output format
1394 is HTML ('html') or XSL Formatting Objects ('fo'). This variable answers
1395 that question. Valid settings are 'html' or 'fo'.
1396 </p>
1397
1398
1399 </div>
1400 </div>
1401 <hr>
1402 <div class="refentry">
1403 <h1 class="title"><a name="param.generate.component.toc"></a>generate.component.toc
1404 </h1>
1405 <div class="refnamediv"><a name="d41e938"></a><h2>Name</h2>generate.component.toc &#8212; Generate a table of contents for components?
1406 </div>
1407 <div class="refsynopsisdiv"><a name="d41e943"></a><h2>Synopsis</h2><pre class="synopsis">
1408 &lt;xsl:param name="generate.component.toc" select="0" doc:type="boolean"/&gt;</pre></div>
1409 <div class="refdescription"><a name="d41e946"></a>
1410
1411
1412 <p>If non-zero, a table of contents is generated at the beginning
1413 of each component (chapters, appendixes, etc.)
1414
1415 </p>
1416
1417
1418 </div>
1419 </div>
1420 <hr>
1421 <div class="refentry">
1422 <h1 class="title"><a name="param.generate.division.toc"></a>generate.division.toc
1423 </h1>
1424 <div class="refnamediv"><a name="d41e952"></a><h2>Name</h2>generate.division.toc &#8212; Generate a table of contents for divisions?
1425 </div>
1426 <div class="refsynopsisdiv"><a name="d41e957"></a><h2>Synopsis</h2><pre class="synopsis">
1427 &lt;xsl:param name="generate.division.toc" select="1" doc:type="boolean"/&gt;</pre></div>
1428 <div class="refdescription"><a name="d41e960"></a>
1429
1430
1431 <p>If non-zero, a table of contents is generated at the beginning
1432 of each division (sets, books, etc.)
1433
1434 </p>
1435
1436
1437 </div>
1438 </div>
1439 <hr>
1440 <div class="refentry">
1441 <h1 class="title"><a name="param.generate.division.figure.lot"></a>generate.division.figure.lot
1442 </h1>
1443 <div class="refnamediv"><a name="d41e966"></a><h2>Name</h2>generate.division.figure.lot &#8212; Generate a list of titles for Figures?
1444 </div>
1445 <div class="refsynopsisdiv"><a name="d41e971"></a><h2>Synopsis</h2><pre class="synopsis">
1446 &lt;xsl:param name="generate.division.figure.lot" select="1" doc:type="boolean"/&gt;</pre></div>
1447 <div class="refdescription"><a name="d41e974"></a>
1448
1449
1450 <p>If non-zero, a list of titles is generated for Figures.
1451
1452 </p>
1453
1454
1455 </div>
1456 </div>
1457 <hr>
1458 <div class="refentry">
1459 <h1 class="title"><a name="param.generate.division.example.lot"></a>generate.division.example.lot
1460 </h1>
1461 <div class="refnamediv"><a name="d41e980"></a><h2>Name</h2>generate.division.example.lot &#8212; Generate a list of titles for Examples?
1462 </div>
1463 <div class="refsynopsisdiv"><a name="d41e985"></a><h2>Synopsis</h2><pre class="synopsis">
1464 &lt;xsl:param name="generate.division.example.lot" select="1" doc:type="boolean"/&gt;</pre></div>
1465 <div class="refdescription"><a name="d41e988"></a>
1466
1467
1468 <p>If non-zero, a list of titles is generated for Examples.
1469
1470 </p>
1471
1472
1473 </div>
1474 </div>
1475 <hr>
1476 <div class="refentry">
1477 <h1 class="title"><a name="param.generate.division.equation.lot"></a>generate.division.equation.lot
1478 </h1>
1479 <div class="refnamediv"><a name="d41e994"></a><h2>Name</h2>generate.division.equation.lot &#8212; Generate a list of titles for Equations?
1480 </div>
1481 <div class="refsynopsisdiv"><a name="d41e999"></a><h2>Synopsis</h2><pre class="synopsis">
1482 &lt;xsl:param name="generate.division.equation.lot" select="1" doc:type="boolean"/&gt;</pre></div>
1483 <div class="refdescription"><a name="d41e1002"></a>
1484
1485
1486 <p>If non-zero, a list of titles is generated for Equations.
1487
1488 </p>
1489
1490
1491 </div>
1492 </div>
1493 <hr>
1494 <div class="refentry">
1495 <h1 class="title"><a name="param.generate.division.table.lot"></a>generate.division.table.lot
1496 </h1>
1497 <div class="refnamediv"><a name="d41e1008"></a><h2>Name</h2>generate.division.table.lot &#8212; Generate a list of titles for Tables?
1498 </div>
1499 <div class="refsynopsisdiv"><a name="d41e1013"></a><h2>Synopsis</h2><pre class="synopsis">
1500 &lt;xsl:param name="generate.division.table.lot" select="1" doc:type="boolean"/&gt;</pre></div>
1501 <div class="refdescription"><a name="d41e1016"></a>
1502
1503
1504 <p>If non-zero, a list of titles is generated for Tables.
1505
1506 </p>
1507
1508
1509 </div>
1510 </div>
1511 <hr>
1512 <div class="refentry">
1513 <h1 class="title"><a name="param.passivetex.extensions"></a>passivetex.extensions
1514 </h1>
1515 <div class="refnamediv"><a name="d41e1022"></a><h2>Name</h2>passivetex.extensions &#8212; Enable PassiveTeX extensions?
1516 </div>
1517 <div class="refsynopsisdiv"><a name="d41e1027"></a><h2>Synopsis</h2><pre class="synopsis">
1518 &lt;xsl:param name="passivetex.extensions" select="0" doc:type="boolean"/&gt;</pre></div>
1519 <div class="refdescription"><a name="d41e1030"></a>
1520
1521
1522 <p>If non-zero,
1523 <a href="http://users.ox.ac.uk/~rahtz/passivetex/" target="_top">PassiveTeX</a>
1524 extensions will be used. At present, this consists of PDF bookmarks
1525 and sorted index terms.
1526
1527 </p>
1528
1529
1530 </div>
1531 </div>
1532 <hr>
1533 <div class="refentry">
1534 <h1 class="title"><a name="param.arbortext.extensions"></a>arbortext.extensions
1535 </h1>
1536 <div class="refnamediv"><a name="d41e1039"></a><h2>Name</h2>arbortext.extensions &#8212; Enable Arbortext extensions?
1537 </div>
1538 <div class="refsynopsisdiv"><a name="d41e1044"></a><h2>Synopsis</h2><pre class="synopsis">
1539 &lt;xsl:param name="arbortext.extensions" select="0" doc:type="boolean"/&gt;</pre></div>
1540 <div class="refdescription"><a name="d41e1047"></a>
1541
1542
1543 <p>If non-zero,
1544 <a href="http://www.arbortext.com/" target="_top">Arbortext</a>
1545 extensions will be used.
1546
1547 </p>
1548
1549
1550 </div>
1551 </div>
1552 <hr>
1553 <div class="refentry">
1554 <h1 class="title"><a name="param.fop.extensions"></a>fop.extensions
1555 </h1>
1556 <div class="refnamediv"><a name="d41e1056"></a><h2>Name</h2>fop.extensions &#8212; Enable FOP extensions?
1557 </div>
1558 <div class="refsynopsisdiv"><a name="d41e1061"></a><h2>Synopsis</h2><pre class="synopsis">
1559 &lt;xsl:param name="fop.extensions" select="0" doc:type="boolean"/&gt;</pre></div>
1560 <div class="refdescription"><a name="d41e1064"></a>
1561
1562
1563 <p>If non-zero,
1564 <a href="http://xml.apache.org/fop/" target="_top">FOP</a>
1565 extensions will be used. At present, this consists of PDF bookmarks.
1566
1567 </p>
1568
1569
1570 </div>
1571 </div>
1572 <hr>
1573 <div class="refentry">
1574 <h1 class="title"><a name="param.default.units"></a>default.units
1575 </h1>
1576 <div class="refnamediv"><a name="d41e1073"></a><h2>Name</h2>default.units &#8212; Default units for an unqualified dimension
1577 </div>
1578 <div class="refsynopsisdiv"><a name="d41e1078"></a><h2>Synopsis</h2><pre class="synopsis">
1579 &lt;xsl:param name="default.units" select="'pt'" doc:type="list" doc:list="cm mm in pt pc px em"/&gt;</pre></div>
1580 <div class="refdescription"><a name="d41e1081"></a>
1581
1582
1583 <p>If an unqualified dimension is encountered (for example, in a
1584 graphic width), the <i><tt>default-units</tt></i> will be used for the
1585 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
1586
1587 </p>
1588
1589
1590 </div>
1591 </div>
1592 <hr>
1593 <div class="refentry">
1594 <h1 class="title"><a name="param.label.from.part"></a>label.from.part
1595 </h1>
1596 <div class="refnamediv"><a name="d41e1090"></a><h2>Name</h2>label.from.part &#8212; Renumber chapters in each part?
1597 </div>
1598 <div class="refsynopsisdiv"><a name="d41e1095"></a><h2>Synopsis</h2><pre class="synopsis">
1599 &lt;xsl:param name="label.from.part" select="'0'" doc:type="boolean"/&gt;</pre></div>
1600 <div class="refdescription"><a name="d41e1098"></a>
1601
1602
1603 <p>If <i><tt>label.from.part</tt></i> is non-zero, components
1604 (<tt>chapter</tt>s, <tt>appendixe</tt>s, etc.)
1605 will be numbered from 1 in each <tt>part</tt>. Otherwise,
1606 they will be numbered monotonically throughout each
1607 <tt>book</tt>.
1608
1609 </p>
1610
1611
1612 </div>
1613 </div>
1614 </div>
1615 </body>
1616 </html>