Parameter | Role | Default Value
--- | --- | ---
alt.use | When an (informal) equation contains both `alt` and another element (graphic, etc.), and when `tex.math.in.alt` is not set to 'latex', the alt element is not used to display the equation since it is considered as a fallback element. Set `alt.use` to force the use of `alt` as default rendering element even when `tex.math.in.alt` is not set to 'latex'. | 0
annotation.support | Set to 1 the experimental DocBook 5 `annotation` support is enabled. | 0
callout.markup.circled | Set to 1 the callouts references in a `calloutlist` are white numbers in black circles, like the markups in the listing (or graphic). Set to 0 the references are simple numbers. | 1
callout.linkends.hot | The callouts referenced in a callout list are hot links if the parameter is set to 1. Then, the references are in red such like any other cross-reference link in the document. | 1
calloutlist.style | Defines how the callout list items are displayed. The value must be some valid enumitem description list options. | "leftmargin=1cm,style=sameline"
citation.default.style | Default natbib citation style to apply when natbib is used. See . | Empty
citation.natbib.options | Options to pass to the natbib package when it is loaded. See also . | Empty
citation.natbib.use | Load the natbib package, and allows the use of natbib citation styles. The package is loaded if the parameter is set to 1. See . | 0
cjk.font | Fonts to use in CJK environments (i.e. for Chinese, Japanese or Korean documents handled by the CJK package). | cyberbit
co.linkends.show | Next to a callout markup the links to the corresponding calloutlist items are shown when the parameter is set to 1. Set to 0 the links are not shown. | 1
colophon.tocdepth | Same than `preface.tocdepth` for colophon sections. | 0
dedication.tocdepth | Same than `preface.tocdepth` for dedication sections. | 0
doc.alignment | Defines the text alignment for the whole document. The valid values are: "left", "center", "right", "justify". An empty string is equivalent to "justify". | Empty
doc.collab.show | Show the collaborators (authors, contributors) defined in the document information block. | 1
doc.lot.show | Specifies which Lists of Titles should be printed after the Table of Content. The value is a comma separated list of the LoTs to show. The supported LoTs are "figure", "table", "equation", and "example". The list order represents the LoTs order in the output document. | "figure,table"
doc.pdfcreator.show | Fill the Creator field of the PDF document information section with "DBLaTeX-<version>" if the parameter is set to 1. Set to 0 this field is keep untouched. | 1
doc.publisher.show | Print the dblatex logo on the cover page for the native docbook style if the parameter is set to 1. | 0
doc.section.depth | Depth of the section numbering. Used to set the latex `secnumdepth` counter. | 5
doc.toc.show | Print the table of contents when set to 1. | 1
draft.mode | Print `releaseinfo` in a framed box in the header, when the parameter is set to 'yes'. The `releaseinfo` is ignored if the parameter is set to 'no', or if the releaseinfo content is empty. When the parameter is set to 'maybe', the draft mode is deduced from the `status` attribute of the root element if set to 'draft'. | maybe
draft.watermark | Print the draft text (that is, "DRAFT") as a watermark on each page, if the document is in draft mode and if the parameter is set to '1'. | 1
equation.default.position | Default equation float placement algorithm to apply. See figure.default.position for more details about how to use latex float specifications. | [H]
example.default.position | Default example float placement algorithm to apply. See figure.default.position for more details about how to use latex float specifications. | [H]
figure.caution | Figure to use to render a `caution` block. This parameter is added to allow new latex styles to use their own figures in admonitions. | "warning"
figure.default.position | Default figure float placement algorithm to apply. The default parameter value is [htbp] meaning that latex tries to place the figure where it occurs first (h, here), then at the top of the page (t), at the bottom of the page (b), and finally on the next page (p). | [htbp]
figure.important | Figure to use to render a `important` block. This parameter is added to allow new latex styles to use their own figures in admonitions. | "warning"
figure.note | Figure to use to render a `note` block. This parameter is added to allow new latex styles to use their own figures in admonitions. | Empty
figure.tip | Figure to use to render a `tip` block. This parameter is added to allow new latex styles to use their own figures in admonitions. | Empty
figure.title.top | Set to 1 the `figure` float title position is above the image. Set to 0 the title is under the image. | 0
figure.warning | Figure to use to render a `warning` block. This parameter is added to allow new latex styles to use their own figures in admonitions. | "warning"
filename.as.url | Set to 1 the `filename`s are handled as URLs, with the same hyphenation rules. Set to 0 the `filename` hyphenation is forced for each character. | 1
glossterm.auto.link | When set to 1, the glossterms in the document are linked to their definition in the glossary. | 0
imagedata.boxed | If set to 1, put the images into a framed box. | 0
imagedata.default.scale | cf. | pagebound
imagedata.file.check | When set to 1 some tex code is added to ensure that latex compilation does not fail when the referenced imagadata file does not exist. | 1
imageobjectco.hide | When set to 1 the callout numbered circles are not drawn on the image. Only the anchors are put, allowing callout list items to jump at the referenced position on the image. The purpose of this parameter is to allow the use of images that already contain the callout numbers (like for GIMP manual). | 0
korean.package | When lang is set to 'ko' and the parameter is set to 'CJK' the CJK package is included to handle the Korean language. | CJK
latex.babel.language | This parameter forces the use of the specified babel language whatever the document language is. | Empty
latex.babel.use | Set to 1 the babel package corresponding to the document language is included. Set to 0 no babel package is included whatever the document language is. | 1
latex.bibfiles | Defines the default BibTeX database to use. Used when the bibtex PI does not have a "bibfiles" attribute. See for more details. | Empty
latex.biblio.output | Defines how the BibTeX bibliographic entries are printed out. The available values are defined in . | all
latex.biblio.style | Defines the default BibTeX style to apply. Meaningful when not empty, only for the used bibtex databases. See . | Empty
latex.class.article | This parameter sets the document class to use for `article` documents. | article
latex.class.book | This parameter sets the document class to use for `book` documents. | report
latex.class.options | Options passed to the \documentclass command. | Empty
latex.encoding | Encoding of the latex document to produce. The supported values are: "latin1" and "utf8". See for more details about how to use it. | "latin1"
latex.hyperparam | See | empty
latex.unicode.use | Set to 1 the passivetex unicode support is included, allowing to handle a wider range of Unicode characters (like cyrillic). | 0
literal.layout.options | Overwrite the default options passed to the \lstset command. | Empty
literal.lines.showall | Set to 1, all the lines in a verbatim environment like programlisting or screen are printed, even if they are empty. Set to 0, the last empty lines are not printed. It is set to 1 by default. | 1
literal.width.ignore | When set to 1 the programlisting and screen width attribute is ignored. In this case all the verbatim environment widths are equal to the enclosing environment width. | 0
make.year.ranges | If non-zero, copyright years will be collated into ranges. Parameter taken from the DocBook XSL stylesheets. | 0
make.single.year.ranges | If non-zero, year ranges that span a single year will be printed in range notation (1998-1999) instead of discrete notation (1998, 1999). Parameter taken from the DocBook XSL stylesheets. | 0
mediaobject.caption.style | Font style of the mediaobject caption text. Its value can be any valid latex font style command combinations. By default this parameter put the caption text to italics. | \slshape
monoseq.hyphenation | When set to 1, aggressively hyphenates the inlined element rendered with monoseq fonts. When set to 0, let latex do as default. When set to 'nohyphen', dblatex tries to avoid overfull boxes (words in the margins) but keeps the monoseq words not splittable. | 1
monoseq.small | When set to 1, choose a smaller font to the element rendered with monoseq fonts. | 0
newtbl.autowidth | Defines if the table column widths must be automatically sized by latex. See . | Empty
newtbl.bgcolor.thead | Background color of the `thead` rows. | 1
newtbl.default.colsep | Set to 1, print the column separators when no `colspec` attribute is specified. | 1
newtbl.default.rowsep | Set to 1, print the row separators when no `rowspec` attribute is specified. | 1
newtbl.format.tbody | LaTeX formatting for body table cells. | Empty
newtbl.format.tfoot | LaTeX formatting for foot table cells. | Empty
newtbl.format.thead | LaTeX formatting for head table cells. | \bfseries%
newtbl.use.hhline | Set to 1, use the `hhline` package to draw the table row separators instead of cline. Using `hhline` seems more suited for colored tables. | 0
pdf.annot.options | Options to change how the PDF text annotations should look. The supported options are width, height, depth. The options must be comma separated like: `width=5cm,depth=10cm`. | Empty

preface.tocdepth

When greater than 0, the preface headings appear in the TOC. The parameter value define the preface section depth appearing in the TOC and in the bookmarks. If set to 0, none of the sections are put in the TOC. If set to 1, only the chapter level appears in the TOC and bookmarks, and so on. When the parameter is negative, it behaves like with 0, but it uses the previous implementation (use of unnumbered sections, that is, with latex heading commands ending with '*').

0

qandaset.defaultlabel | Defines the default label to use in a `qandadet` when the defaultlabel attribute is not specified. | "number"
refentry.numbered | Defines either the `refentry` titles are numbered or not. When numbered, it is displayed as any other numbered section. | 1
refentry.tocdepth | Same than `preface.tocdepth` for refentry sections. Meaningful only when `refentry.numbered` is set to 0. | 5
seg.item.separator | Defines the separator to use between several `segitem`s. | ", "
set.book.num | When the document root element is a `set` this parameter can be used to select the book to print, because `dblatex` can output only one book from the set. | 1
table.default.position | Default table float placement algorithm to apply. The default parameter value is [htbp] meaning that latex tries to place the table where it occurs first (h, here), then at the top of the page (t), at the bottom of the page (b), and finally on the next page (p). | [htbp]
table.in.float | Set to 0 the formal tables are no more put in table floats. They are displayed with the longtable package, allowing to have formal tables covering several pages (which is not possible with floats). The limitation is that the title must necessarily be on the top of the table. | 1
table.title.top | Set to 1 the `table` float title position is above the table. Set to 0 the title is under the table. | 0
term.breakline | Set to 1 the item following a term in a variable list is put on the next line. | 0
tex.math.in.alt | Specifies if the `alt` element in an (informal) equation contains some tex equation. If so, and if the tex equation is in 'latex' format, the content is directly used by dblatex. | latex
titleabbrev.in.toc | Set to 1 the titleabbrev content is put in the TOC instead of the title. | 1
toc.section.depth | Depth of the TOC. Used to set the latex `tocdepth` counter. | 5
xetex.font | Font specification for XeTeX. Meaningful only when the xetex backend is used. | \setmainfont{DejaVU Serif} \setsansfont{DejaVu Sans}