1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE informaltable PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
2
<tgroup cols="3" colsep="1" rowsep="1" align="left">
3
<colspec colname="c1"/>
5
<tgroup align="left" cols="3" colsep="1" rowsep="1">
6
<colspec colname="c1" colwidth="2*" />
8
<colspec colname="c2" colwidth="3*" />
10
<colspec colname="c3" colwidth="*" />
6
14
<entry>Parameter</entry>
8
<entry>Default value</entry>
18
<entry>Default Value</entry>
24
<entry>alt.use</entry>
26
<entry>When an (informal) equation contains both <sgmltag>alt</sgmltag> and
27
another element (graphic, etc.), and when
28
<parameter>tex.math.in.alt</parameter> is not set to 'latex', the alt element
29
is not used to display the equation since it is considered as a fallback
30
element. Set <parameter>alt.use</parameter> to force the use of
31
<sgmltag>alt</sgmltag> as default rendering element even when
32
<parameter>tex.math.in.alt</parameter> is not set to 'latex'.</entry>
40
<entry>annotation.support</entry>
42
<entry>Set to 1 the experimental DocBook 5 <sgmltag>annotation</sgmltag>
43
support is enabled.</entry>
14
51
<entry>callout.markup.circled</entry>
15
53
<entry>Set to 1 the callouts references in a <sgmltag>calloutlist</sgmltag>
16
are white numbers in black circles, like the markups in the listing (or graphic).
17
Set to 0 the references are simple numbers.
54
are white numbers in black circles, like the markups in the listing (or
55
graphic). Set to 0 the references are simple numbers.</entry>
23
63
<entry>callout.linkends.hot</entry>
24
65
<entry>The callouts referenced in a callout list are hot links if the
25
parameter is set to 1. Then, the references are in red such like any
26
other cross-reference link in the document.</entry>
66
parameter is set to 1. Then, the references are in red such like any other
67
cross-reference link in the document.</entry>
75
<entry>calloutlist.style</entry>
77
<entry>Defines how the callout list items are displayed. The value must be
78
some valid enumitem description list options.</entry>
80
<entry>"leftmargin=1cm,style=sameline"</entry>
86
<entry>citation.default.style</entry>
88
<entry>Default natbib citation style to apply when natbib is used. See <xref
89
linkend="sec-natbib" />.</entry>
97
<entry>citation.natbib.options</entry>
99
<entry>Options to pass to the natbib package when it is loaded. See also <xref
100
linkend="sec-natbib" />.</entry>
108
<entry>citation.natbib.use</entry>
110
<entry>Load the natbib package, and allows the use of natbib citation styles.
111
The package is loaded if the parameter is set to 1. See <xref
112
linkend="sec-natbib" />.</entry>
120
<entry>cjk.font</entry>
122
<entry>Fonts to use in CJK environments (i.e. for Chinese, Japanese or Korean
123
documents handled by the CJK package).</entry>
125
<entry>cyberbit</entry>
31
131
<entry>co.linkends.show</entry>
32
133
<entry>Next to a callout markup the links to the corresponding calloutlist
33
items are shown when the parameter is set to 1.
34
Set to 0 the links are not shown.</entry>
134
items are shown when the parameter is set to 1. Set to 0 the links are not
143
<entry>colophon.tocdepth</entry>
145
<entry>Same than <parameter>preface.tocdepth</parameter> for colophon
154
<entry>dedication.tocdepth</entry>
156
<entry>Same than <parameter>preface.tocdepth</parameter> for dedication
39
165
<entry>doc.alignment</entry>
40
167
<entry>Defines the text alignment for the whole document. The valid values
41
168
are: "left", "center", "right", "justify". An empty string is equivalent to
42
169
"justify".</entry>
43
171
<entry>Empty</entry>
177
<entry>doc.collab.show</entry>
179
<entry>Show the collaborators (authors, contributors) defined in the document
180
information block.</entry>
47
188
<entry>doc.lot.show</entry>
48
<entry>Specifies which Lists of Titles should be printed after the
49
Table of Content. The value is a comma separated list of the LoTs to
50
show. The supported LoTs are "figure", "table", "equation", and "example".
51
The list order represents the LoTs order in the output document.</entry>
190
<entry>Specifies which Lists of Titles should be printed after the Table of
191
Content. The value is a comma separated list of the LoTs to show. The
192
supported LoTs are "figure", "table", "equation", and "example". The list
193
order represents the LoTs order in the output document.</entry>
52
195
<entry>"figure,table"</entry>
56
201
<entry>doc.pdfcreator.show</entry>
57
203
<entry>Fill the Creator field of the PDF document information section with
58
204
"DBLaTeX-<version>" if the parameter is set to 1. Set to 0 this field is
59
205
keep untouched.</entry>
64
213
<entry>doc.publisher.show</entry>
65
215
<entry>Print the dblatex logo on the cover page for the native docbook style
66
216
if the parameter is set to 1.</entry>
224
<entry>doc.section.depth</entry>
226
<entry>Depth of the section numbering. Used to set the latex
227
<literal>secnumdepth</literal> counter.</entry>
235
<entry>doc.toc.show</entry>
237
<entry>Print the table of contents when set to 1.</entry>
245
<entry>draft.mode</entry>
247
<entry>Print <sgmltag>releaseinfo</sgmltag> in a framed box in the header,
248
when the parameter is set to 'yes'. The <sgmltag>releaseinfo</sgmltag> is
249
ignored if the parameter is set to 'no', or if the releaseinfo content is
250
empty. When the parameter is set to 'maybe', the draft mode is deduced from
251
the <sgmltag>status</sgmltag> attribute of the root element if set to
260
<entry>draft.watermark</entry>
262
<entry>Print the draft text (that is, "DRAFT") as a watermark on each page, if
263
the document is in draft mode and if the parameter is set to '1'.</entry>
271
<entry>equation.default.position</entry>
273
<entry>Default equation float placement algorithm to apply. See
274
figure.default.position for more details about how to use latex float
275
specifications.</entry>
283
<entry>example.default.position</entry>
285
<entry>Default example float placement algorithm to apply. See
286
figure.default.position for more details about how to use latex float
287
specifications.</entry>
71
295
<entry>figure.caution</entry>
72
<entry>Figure to use to render a <sgmltag>caution</sgmltag> block. This parameter is
73
added to allow new latex styles to use their own figures in admonitions.</entry>
297
<entry>Figure to use to render a <sgmltag>caution</sgmltag> block. This
298
parameter is added to allow new latex styles to use their own figures in
74
301
<entry>"warning"</entry>
78
307
<entry>figure.default.position</entry>
79
<entry>Default figure float placement algorithm to apply. The default parameter value
80
is [htbp] meaning that latex tries to place the figure where it occurs first (h,
81
here), then at the top of the page (t), at the bottom of the page (b), and finally on the next page (p).</entry>
309
<entry>Default figure float placement algorithm to apply. The default
310
parameter value is [htbp] meaning that latex tries to place the figure where
311
it occurs first (h, here), then at the top of the page (t), at the bottom of
312
the page (b), and finally on the next page (p).</entry>
82
314
<entry>[htbp]</entry>
85
318
<entry>figure.important</entry>
86
<entry>Figure to use to render a <sgmltag>important</sgmltag> block. This parameter is
87
added to allow new latex styles to use their own figures in admonitions.</entry>
320
<entry>Figure to use to render a <sgmltag>important</sgmltag> block. This
321
parameter is added to allow new latex styles to use their own figures in
88
324
<entry>"warning"</entry>
91
328
<entry>figure.note</entry>
92
<entry>Figure to use to render a <sgmltag>note</sgmltag> block. This parameter is
93
added to allow new latex styles to use their own figures in admonitions.</entry>
330
<entry>Figure to use to render a <sgmltag>note</sgmltag> block. This parameter
331
is added to allow new latex styles to use their own figures in
94
334
<entry>Empty</entry>
97
338
<entry>figure.tip</entry>
98
<entry>Figure to use to render a <sgmltag>tip</sgmltag> block. This parameter is
99
added to allow new latex styles to use their own figures in admonitions.</entry>
340
<entry>Figure to use to render a <sgmltag>tip</sgmltag> block. This parameter
341
is added to allow new latex styles to use their own figures in
100
344
<entry>Empty</entry>
103
348
<entry>figure.title.top</entry>
104
<entry>Set to 1 the <sgmltag>figure</sgmltag> float title position is above the
105
image. Set to 0 the title is under the image.</entry>
350
<entry>Set to 1 the <sgmltag>figure</sgmltag> float title position is above
351
the image. Set to 0 the title is under the image.</entry>
109
357
<entry>figure.warning</entry>
110
<entry>Figure to use to render a <sgmltag>warning</sgmltag> block. This parameter is
111
added to allow new latex styles to use their own figures in admonitions.</entry>
359
<entry>Figure to use to render a <sgmltag>warning</sgmltag> block. This
360
parameter is added to allow new latex styles to use their own figures in
112
363
<entry>"warning"</entry>
116
369
<entry>filename.as.url</entry>
117
371
<entry>Set to 1 the <sgmltag>filename</sgmltag>s are handled as URLs, with the
118
same hyphenation rules. Set to 0 the <sgmltag>filename</sgmltag> hyphenation is forced for each character.</entry>
372
same hyphenation rules. Set to 0 the <sgmltag>filename</sgmltag> hyphenation
373
is forced for each character.</entry>
123
381
<entry>glossterm.auto.link</entry>
124
383
<entry>When set to 1, the glossterms in the document are linked to their
125
384
definition in the glossary.</entry>
130
392
<entry>imagedata.boxed</entry>
131
394
<entry>If set to 1, put the images into a framed box.</entry>
136
402
<entry>imagedata.default.scale</entry>
137
<entry>cf. <xref linkend="sec-defaultscale"/></entry>
404
<entry>cf. <xref linkend="sec-defaultscale" /></entry>
138
406
<entry>pagebound</entry>
142
<entry>latex.hyperparam</entry>
143
<entry>cf. <xref linkend="sec-hyperparam"/></entry>
412
<entry>imagedata.file.check</entry>
414
<entry>When set to 1 some tex code is added to ensure that latex compilation
415
does not fail when the referenced imagadata file does not exist.</entry>
423
<entry>imageobjectco.hide</entry>
425
<entry>When set to 1 the callout numbered circles are not drawn on the image.
426
Only the anchors are put, allowing callout list items to jump at the
427
referenced position on the image. The purpose of this parameter is to allow
428
the use of images that already contain the callout numbers (like for GIMP
437
<entry>korean.package</entry>
439
<entry>When lang is set to 'ko' and the parameter is set to 'CJK' the CJK
440
package is included to handle the Korean language.</entry>
448
<entry>latex.babel.language</entry>
450
<entry>This parameter forces the use of the specified babel language whatever
451
the document language is.</entry>
148
459
<entry>latex.babel.use</entry>
149
461
<entry>Set to 1 the babel package corresponding to the document language is
150
462
included. Set to 0 no babel package is included whatever the document language
156
<entry>latex.babel.language</entry>
157
<entry>This parameter forces the use of the specified babel
158
language whatever the document language is.</entry>
471
<entry>latex.bibfiles</entry>
473
<entry>Defines the default BibTeX database to use. Used when the bibtex PI
474
does not have a "bibfiles" attribute. See <xref linkend="sec-bibtex" /> for
475
more details.</entry>
483
<entry>latex.biblio.output</entry>
485
<entry>Defines how the BibTeX bibliographic entries are printed out. The
486
available values are defined in <xref linkend="sec-bibtex" />.</entry>
494
<entry>latex.biblio.style</entry>
496
<entry>Defines the default BibTeX style to apply. Meaningful when not empty,
497
only for the used bibtex databases. See <xref linkend="sec-bibtex" />.</entry>
505
<entry>latex.class.article</entry>
507
<entry>This parameter sets the document class to use for
508
<sgmltag>article</sgmltag> documents.</entry>
510
<entry>article</entry>
516
<entry>latex.class.book</entry>
518
<entry>This parameter sets the document class to use for
519
<sgmltag>book</sgmltag> documents.</entry>
521
<entry>report</entry>
163
527
<entry>latex.class.options</entry>
164
529
<entry>Options passed to the \documentclass command.</entry>
165
531
<entry>Empty</entry>
537
<entry>latex.encoding</entry>
539
<entry>Encoding of the latex document to produce. The supported values are:
540
"latin1" and "utf8". See <xref linkend="sec-doc-encode" /> for more details
541
about how to use it.</entry>
543
<entry>"latin1"</entry>
549
<entry>latex.hyperparam</entry>
551
<entry>See <xref linkend="sec-hyperparam" /></entry>
559
<entry>latex.unicode.use</entry>
561
<entry>Set to 1 the passivetex unicode support is included, allowing to handle
562
a wider range of Unicode characters (like cyrillic).</entry>
169
570
<entry>literal.layout.options</entry>
170
572
<entry>Overwrite the default options passed to the \lstset command.</entry>
171
574
<entry>Empty</entry>
175
580
<entry>literal.lines.showall</entry>
176
<entry>Set to 1, all the lines in a verbatim environment like programlisting or
177
screen are printed, even if they are empty. Set to 0, the last empty lines are
178
not printed. It is set to 1 by default.</entry>
582
<entry>Set to 1, all the lines in a verbatim environment like programlisting
583
or screen are printed, even if they are empty. Set to 0, the last empty lines
584
are not printed. It is set to 1 by default.</entry>
183
592
<entry>literal.width.ignore</entry>
184
594
<entry>When set to 1 the programlisting and screen width attribute is ignored.
185
595
In this case all the verbatim environment widths are equal to the enclosing
596
environment width.</entry>
192
604
<entry>make.year.ranges</entry>
193
606
<entry>If non-zero, copyright years will be collated into ranges. Parameter
194
taken from the DocBook XSL stylesheets.
607
taken from the DocBook XSL stylesheets.</entry>
200
615
<entry>make.single.year.ranges</entry>
201
<entry>If non-zero, year ranges that span a single year will be printed in range
202
notation (1998-1999) instead of discrete notation (1998, 1999). Parameter
203
taken from the DocBook XSL stylesheets.
617
<entry>If non-zero, year ranges that span a single year will be printed in
618
range notation (1998-1999) instead of discrete notation (1998, 1999).
619
Parameter taken from the DocBook XSL stylesheets.</entry>
209
627
<entry>mediaobject.caption.style</entry>
210
629
<entry>Font style of the mediaobject caption text. Its value can be any valid
211
latex font style command combinations. By default this parameter put the caption
212
text to italics.</entry>
630
latex font style command combinations. By default this parameter put the
631
caption text to italics.</entry>
213
633
<entry>\slshape</entry>
217
<entry>newtbl.format.thead</entry>
218
<entry>LaTeX formatting for head table cells.</entry>
219
<entry>\bfseries% </entry>
639
<entry>monoseq.hyphenation</entry>
641
<entry>When set to 1, aggressively hyphenates the inlined element rendered
642
with monoseq fonts. When set to 0, let latex do as default. When set to
643
'nohyphen', dblatex tries to avoid overfull boxes (words in the margins) but
644
keeps the monoseq words not splittable.</entry>
652
<entry>monoseq.small</entry>
654
<entry>When set to 1, choose a smaller font to the element rendered with
655
monoseq fonts.</entry>
663
<entry>newtbl.autowidth</entry>
665
<entry>Defines if the table column widths must be automatically sized by
666
latex. See <xref linkend="sec-newtbl-autowidth" />.</entry>
672
<entry>newtbl.bgcolor.thead</entry>
674
<entry>Background color of the <sgmltag>thead</sgmltag> rows.</entry>
680
<entry>newtbl.default.colsep</entry>
682
<entry>Set to 1, print the column separators when no
683
<sgmltag>colspec</sgmltag> attribute is specified.</entry>
689
<entry>newtbl.default.rowsep</entry>
691
<entry>Set to 1, print the row separators when no <sgmltag>rowspec</sgmltag>
692
attribute is specified.</entry>
222
698
<entry>newtbl.format.tbody</entry>
223
700
<entry>LaTeX formatting for body table cells.</entry>
224
702
<entry>Empty</entry>
227
706
<entry>newtbl.format.tfoot</entry>
228
708
<entry>LaTeX formatting for foot table cells.</entry>
229
710
<entry>Empty</entry>
232
<entry>newtbl.default.colsep</entry>
233
<entry>Set to 1, print the column separators when no
234
<sgmltag>colspec</sgmltag> attribute is specified.</entry>
238
<entry>newtbl.default.rowsep</entry>
239
<entry>Set to 1, print the row separators when no
240
<sgmltag>rowspec</sgmltag> attribute is specified.</entry>
714
<entry>newtbl.format.thead</entry>
716
<entry>LaTeX formatting for head table cells.</entry>
718
<entry>\bfseries%</entry>
244
722
<entry>newtbl.use.hhline</entry>
245
<entry>Set to 1, use the <filename>hhline</filename> package to draw the
246
table row separators instead of cline. Using <filename>hhline</filename> seems
247
more suited for colored tables.</entry>
724
<entry>Set to 1, use the <filename>hhline</filename> package to draw the table
725
row separators instead of cline. Using <filename>hhline</filename> seems more
726
suited for colored tables.</entry>
734
<entry>pdf.annot.options</entry>
736
<entry>Options to change how the PDF text annotations should look. The
737
supported options are width, height, depth. The options must be comma
738
separated like: <literal>width=5cm,depth=10cm</literal>.</entry>
746
<entry>preface.tocdepth</entry>
748
<entry>When greater than 0, the preface headings appear in the TOC. The
749
parameter value define the preface section depth appearing in the TOC and in
750
the bookmarks. If set to 0, none of the sections are put in the TOC. If set to
751
1, only the chapter level appears in the TOC and bookmarks, and so on. When
752
the parameter is negative, it behaves like with 0, but it uses the previous
753
implementation (use of unnumbered sections, that is, with latex heading
754
commands ending with '*').</entry>
252
762
<entry>qandaset.defaultlabel</entry>
253
<entry>Defines the default label to use in a <sgmltag>qandadet</sgmltag>
254
when the defaultlabel attribute is not specified.</entry>
764
<entry>Defines the default label to use in a <sgmltag>qandadet</sgmltag> when
765
the defaultlabel attribute is not specified.</entry>
255
767
<entry>"number"</entry>
773
<entry>refentry.numbered</entry>
775
<entry>Defines either the <sgmltag>refentry</sgmltag> titles are numbered or
776
not. When numbered, it is displayed as any other numbered section.</entry>
784
<entry>refentry.tocdepth</entry>
786
<entry>Same than <parameter>preface.tocdepth</parameter> for refentry
787
sections. Meaningful only when <parameter>refentry.numbered</parameter> is set
259
796
<entry>seg.item.separator</entry>
260
798
<entry>Defines the separator to use between several
261
799
<sgmltag>segitem</sgmltag>s.</entry>
262
801
<entry>", "</entry>
266
807
<entry>set.book.num</entry>
267
<entry>When the document root element is a <sgmltag>set</sgmltag> this parameter
268
can be used to select the book to print, because
809
<entry>When the document root element is a <sgmltag>set</sgmltag> this
810
parameter can be used to select the book to print, because
269
811
<command>dblatex</command> can output only one book from the set.</entry>
274
819
<entry>table.default.position</entry>
275
<entry>Default table float placement algorithm to apply. The default parameter value
276
is [htbp] meaning that latex tries to place the table where it occurs first (h,
277
here), then at the top of the page (t), at the bottom of the page (b), and finally on the next page (p).</entry>
821
<entry>Default table float placement algorithm to apply. The default parameter
822
value is [htbp] meaning that latex tries to place the table where it occurs
823
first (h, here), then at the top of the page (t), at the bottom of the page
824
(b), and finally on the next page (p).</entry>
278
826
<entry>[htbp]</entry>
832
<entry>table.in.float</entry>
834
<entry>Set to 0 the formal tables are no more put in table floats. They are
835
displayed with the longtable package, allowing to have formal tables covering
836
several pages (which is not possible with floats). The limitation is that the
837
title must necessarily be on the top of the table.</entry>
282
845
<entry>table.title.top</entry>
283
847
<entry>Set to 1 the <sgmltag>table</sgmltag> float title position is above the
284
848
table. Set to 0 the title is under the table.</entry>
289
856
<entry>term.breakline</entry>
290
<entry>Set to 1 the item following a term in a variable list is put on the next
858
<entry>Set to 1 the item following a term in a variable list is put on the
867
<entry>tex.math.in.alt</entry>
869
<entry>Specifies if the <sgmltag>alt</sgmltag> element in an (informal)
870
equation contains some tex equation. If so, and if the tex equation is in
871
'latex' format, the content is directly used by dblatex.</entry>
296
879
<entry>titleabbrev.in.toc</entry>
297
<entry>Set to 1 the titleabbrev content is put in the TOC instead of the
881
<entry>Set to 1 the titleabbrev content is put in the TOC instead of the
890
<entry>toc.section.depth</entry>
892
<entry>Depth of the TOC. Used to set the latex <literal>tocdepth</literal>
901
<entry>xetex.font</entry>
903
<entry>Font specification for XeTeX. Meaningful only when the xetex backend is
906
<entry>\setmainfont{DejaVU Serif} \setsansfont{DejaVu Sans}</entry>
b'\\ No newline at end of file'
added
removed
docs/custom/param.xml
