Part 2. FO Parameter Reference

This is reference documentation for all user-configurable parameters in the DocBook XSL FO stylesheets (for generating XSL-FO output destined for final print/PDF output).

Table of Contents

2.1. Admonitions — Use graphics in admonitions? — Filename extension for admonition graphics — Path to admonition graphics
admon.textlabel — Use text label in admonitions? — To set the style for admonitions titles. — To set the style for admonitions. — To add properties to the outer block of a graphical admonition. — To add properties to the outer block of a nongraphical admonition.
2.2. Callouts
callout.defaultcolumn — Indicates what column callouts appear in by default — Use graphics for callouts? — Filename extension for callout graphics — Number of the largest callout graphic — Path to callout graphics
callout.icon.size — Specifies the size of callout marker icons
callout.unicode — Use Unicode characters rather than images for callouts.
callout.unicode.font — Specify a font for Unicode glyphs
callout.unicode.number.limit — Number of the largest unicode callout character
callout.unicode.start.character — First Unicode character to use, decimal value.
callouts.extension — Enable the callout extension
2.3. ToC/LoT/Index Generation
autotoc.label.separator — Separator between labels and titles in the ToC
process.empty.source.toc — Generate automated TOC if toc element occurs in a source document?
process.source.toc — Process a non-empty toc element if it occurs in a source document?
generate.toc — Control generation of ToCs and LoTs
generate.index — Do you want an index?
make.index.markup — Generate XML index markup in the index?
index.method — Select method used to group index entries in an index
index.on.type — Select indexterms based on type attribute value
index.on.role — Select indexterms based on role value — Properties used to emphasize page number references for significant index terms — Properties applied to the formatted entries in an index — Properties associated with the letter headings in an index
index.number.separator — Override for punctuation separating page numbers in index
index.range.separator — Override for punctuation separating the two numbers in a page range in index
index.term.separator — Override for punctuation separating an index term from its list of page references in an index — Properties associated with XEP index-items
toc.section.depth — How deep should recursive sections appear in the TOC?
toc.max.depth — How many levels should be created for each TOC?
toc.indent.width — Amount of indentation for TOC entries — Properties for lines in ToC and LoTs — Margin properties used on Tables of Contents — Should bridgehead elements appear in the TOC? — Should simplesect elements appear in the TOC?
generate.section.toc.level — Control depth of TOC generation in sections
2.4. Processor Extensions
arbortext.extensions — Enable Arbortext extensions?
axf.extensions — Enable XSL Formatter extensions?
fop.extensions — Enable extensions for FOP version 0.20.5 and earlier
fop1.extensions — Enable extensions for FOP version 0.90 and later
passivetex.extensions — Enable PassiveTeX extensions? — TeX notation used for equations
tex.math.delims — Should equations output for processing by TeX be surrounded by math mode delimiters?
xep.extensions — Enable XEP extensions?
2.5. Stylesheet Extensions
linenumbering.everyNth — Indicate which lines should be numbered
linenumbering.extension — Enable the line numbering extension
linenumbering.separator — Specify a separator between line numbers and lines
linenumbering.width — Indicates the width of line numbers
tablecolumns.extension — Enable the table columns extension function
textinsert.extension — Enables the textinsert extension element
textdata.default.encoding — Default encoding of external text files which are included using textdata element
use.extensions — Enable extensions
2.6. Automatic labelling
appendix.autolabel — Specifies the labeling format for Appendix titles
chapter.autolabel — Specifies the labeling format for Chapter titles
part.autolabel — Specifies the labeling format for Part titles
reference.autolabel — Specifies the labeling format for Reference titles
preface.autolabel — Specifices the labeling format for Preface titles
section.autolabel — Are sections enumerated?
section.autolabel.max.depth — The deepest level of sections that are numbered.
section.label.includes.component.label — Do section labels include the component label?
label.from.part — Renumber components in each part?
component.label.includes.part.label — Do component labels include the part label?
2.7. XSLT Processing
rootid — Specify the root element to format
2.8. Meta/*Info
make.single.year.ranges — Print single-year ranges (e.g., 1998-1999)
make.year.ranges — Collate copyright years into ranges? — Is othername in author a middle name?
2.9. Reference Pages
funcsynopsis.decoration — Decorate elements of a funcsynopsis? — What style of funcsynopsis should be generated?
function.parens — Generate parens after a function? — Output NAME header before refnames?
refentry.generate.title — Output title before refnames?
refentry.pagebreak — Start each refentry on a new page — Title properties for a refentry title
refentry.xref.manvolnum — Output manvolnum as part of refentry cross-reference?
refclass.suppress — Suppress display of refclass contents?
2.10. Tables
default.table.width — The default width of tables
nominal.table.width — The (absolute) nominal width of tables
default.table.frame — The default framing of tables
default.table.rules — The default column and row rules for tables using HTML markup
table.cell.padding — Specifies the padding of table cells
table.frame.border.thickness — Specifies the thickness of the frame border — Specifies the border style of table frames
table.frame.border.color — Specifies the border color of table frames
table.cell.border.thickness — Specifies the thickness of table cell borders — Specifies the border style of table cells
table.cell.border.color — Specifies the border color of table cells — Properties associated with a table
2.11. Linking
current.docid — targetdoc identifier for the document being processed
collect.xref.targets — Controls whether cross reference data is collected — Turns page numbers in olinks on and off
insert.olink.pdf.frag — Add fragment identifiers for links into PDF files
olink.base.uri — Base URI used in olink hrefs
olink.debug — Turn on debugging messages for olinks
olink.doctitle — show the document title for external olinks?
olink.lang.fallback.sequence — look up translated documents if olink not found? — Properties associated with the cross-reference text of an olink.
prefer.internal.olink — Prefer a local olink reference to an external reference
target.database.document — Name of master database file for resolving olinks
targets.filename — Name of cross reference targets data file — Process olinks using xref style of current document
2.12. Cross References — Turns page numbers in xrefs on and off — Properties associated with cross-reference text
xref.label-title.separator — Punctuation or space separating label from title in xref
xref.label-page.separator — Punctuation or space separating label from page number in xref
xref.title-page.separator — Punctuation or space separating title from page number in xref — Turns page numbers in link elements on and off
2.13. Lists
compact.list.item.spacing — What space do you want between list items (when spacing="compact")? — Properties that apply to each list-block generated by itemizedlist. — Properties that apply to each label inside itemized list.
itemizedlist.label.width — The default width of the label (bullet) in an itemized list. — Properties that apply to each list-block generated by list.
list.block.spacing — What spacing do you want before and after lists?
list.item.spacing — What space do you want between list items? — Properties that apply to each list-block generated by orderedlist. — Properties that apply to each label inside ordered list.
orderedlist.label.width — The default width of the label (number) in an ordered list.
variablelist.max.termlength — Specifies the longest term in variablelists
variablelist.term.separator — Text to separate terms within a multi-term varlistentry — To add properties to the term elements in a variablelist.
variablelist.term.break.after — Generate line break after each term within a multi-term varlistentry?
2.14. QAndASet
qandadiv.autolabel — Are divisions in QAndASets enumerated?
qanda.inherit.numeration — Does enumeration of QandASet components inherit the numeration of parent elements?
qanda.defaultlabel — Sets the default for defaultlabel on QandASet. — Should qandaentry questions appear in the document table of contents? — Should nested answer/qandaentry instances appear in TOC?
2.15. Bibliography — Style used for formatting of biblioentries.
biblioentry.item.separator — Text to separate bibliography entries
bibliography.collection — Name of the bibliography collection file
bibliography.numbered — Should bibliography entries be numbered? — To set the style for biblioentry.
2.16. Glossary — Generate links from glossterm to glossentry automatically? — Does automatic glossterm linking only apply to firstterms?
glossary.collection — Name of the glossary collection file — Present glossarys using blocks instead of lists? — Use blocks for glosslists? — To add properties to each glossentry in a list. — To add properties to the block of a glossentry's glossterm. — To add properties to the block of a glossary definition. — To add properties to the glossterm in a list. — To add properties to the glossary definition in a list.
glossterm.width — Width of glossterm in list presentation mode
glossterm.separation — Separation between glossary terms and descriptions in list mode — Display glossentry acronyms?
glossary.sort — Sort glossentry elements?
2.17. Miscellaneous
formal.procedures — Selects formal or informal procedures
formal.title.placement — Specifies where formal object titles should occur
runinhead.default.title.end.punct — Default punctuation character on a run-in-head
runinhead.title.end.punct — Characters that count as punctuation on a run-in-head
show.comments — Display remark elements?
punct.honorific — Punctuation after an honorific in a personal name. — Format segmented lists as tables? — Format variablelists lists as blocks? — To set the style for block quotations. — Display URLs after ulinks?
ulink.footnotes — Generate footnotes for ulinks?
ulink.hyphenate — Allow URLs to be automatically hyphenated
ulink.hyphenate.chars — List of characters to allow ulink URLs to be automatically hyphenated on
shade.verbatim — Should verbatim environments be shaded? — Properties that specify the style of shaded verbatim listings
hyphenate.verbatim — Should verbatim environments be hyphenated on space characters?
hyphenate.verbatim.characters — List of characters after which a line break can occur in listings
use.svg — Allow SVG in the result tree? — Use role attribute for xrefstyle on xref?
menuchoice.separator — Separator between items of a menuchoice other than guimenuitem and guisubmenu — Separator between items of a menuchoice with guimenuitem or guisubmenu
default.float.class — Specifies the default float class
footnote.number.format — Identifies the format used for footnote numbers
table.footnote.number.format — Identifies the format used for footnote numbers in tables
footnote.number.symbols — Special characters to use as footnote markers
table.footnote.number.symbols — Special characters to use a footnote markers in tables — Properties applied to each footnote body — Properties applied to each table footnote body — Properties applied to each footnote mark — Properties associated with footnote separators
xref.with.number.and.title — Use number and title in cross references — Properties associated with superscripts — Properties associated with subscripts — Properties to make a figure or table page wide.
highlight.source — Should the content of programlisting be syntactically highlighted?
highlight.xslthl.config — Location of XSLTHL configuration file
highlight.default.language — Default language of programlisting
email.delimiters.enabled — Generate delimiters around email addresses?
email.mailto.enabled — Generate mailto: links for email addresses?
section.container.element — Select XSL-FO element name to contain sections
monospace.verbatim.font.width — Width of a single monospace font character
exsl.node.set.available — Is the test function-available('exsl:node-set') true?
bookmarks.collapse — Specifies the initial state of bookmarks
2.18. Graphics
graphic.default.extension — Default extension for graphic filenames
default.image.width — The default width of images
preferred.mediaobject.role — Select which mediaobject to use based on this value of an object's role attribute.
use.role.for.mediaobject — Use role attribute value for selecting which of several objects within a mediaobject to use.
ignore.image.scaling — Tell the stylesheets to ignore the author's image scaling attributes
img.src.path — Path to HTML/FO image files
keep.relative.image.uris — Should image URIs be resolved against xml:base?
2.19. Pagination and General Styles
page.height — The height of the physical page
page.height.portrait — Specify the physical size of the long edge of the page
page.margin.bottom — The bottom margin of the page
page.margin.inner — The inner page margin
page.margin.outer — The outer page margin — The top margin of the page
page.orientation — Select the page orientation
page.width — The width of the physical page
page.width.portrait — Specify the physical size of the short edge of the page
paper.type — Select the paper type
double.sided — Is the document to be printed double sided?
body.margin.bottom — The bottom margin of the body text — To specify the size of the top margin of a page
body.start.indent — The start-indent for the body text
body.end.indent — The end-indent for the body text
alignment — Specify the default text alignment
hyphenate — Specify hyphenation behavior
line-height — Specify the line-height property
column.count.back — Number of columns on back matter pages
column.count.body — Number of columns on body pages
column.count.front — Number of columns on front matter pages
column.count.index — Number of columns on index pages
column.count.lot — Number of columns on a 'List-of-Titles' page
column.count.titlepage — Number of columns on a title page — Gap between columns in back matter — Gap between columns in the body — Gap between columns in the front matter — Gap between columns in the index — Gap between columns on a 'List-of-Titles' page — Gap between columns on title pages
region.after.extent — Specifies the height of the footer.
region.before.extent — Specifies the height of the header
default.units — Default units for an unqualified dimension
normal.para.spacing — What space do you want between normal paragraphs
body.font.master — Specifies the default point size for body text
body.font.size — Specifies the default font size for body text
footnote.font.size — The font size for footnotes
title.margin.left — Adjust the left margin for titles
draft.mode — Select draft mode
draft.watermark.image — The URI of the image to be used for draft watermarks
headers.on.blank.pages — Put headers on blank pages?
footers.on.blank.pages — Put footers on blank pages?
header.rule — Rule under headers?
footer.rule — Rule over footers?
header.column.widths — Specify relative widths of header areas
footer.column.widths — Specify relative widths of footer areas — Apply properties to the header layout table
header.table.height — Specify the minimum height of the table containing the running page headers — Apply properties to the footer layout table
footer.table.height — Specify the minimum height of the table containing the running page footers — Properties of page header content — Properties of page footer content
marker.section.level — Control depth of sections shown in running headers or footers
2.20. Font Families — The default font family for body text — The font family for copyright, quotes, and other symbols — The default font family for monospace environments — The default sans-serif font family — The default font family for titles — The font families to be searched for symbols outside of the body font
2.21. Property Sets — Properties associated with a formal object such as a figure, or other component that has a title — Style the title element of formal object such as a figure. — Properties associated with an informal (untitled) object, such as an informalfigure — Properties of monospaced content — Properties associated with verbatim text — What font and size do you want for monospaced content? — Attribute set for sidebar properties — Attribute set for sidebar titles
sidebar.float.type — Select type of float for sidebar elements
sidebar.float.width — Set the default width for sidebars — Attribute set for margin.note properties — Attribute set for margin note titles
margin.note.float.type — Select type of float for margin note customizations
margin.note.width — Set the default width for margin notes — Properties for component titles — Properties for component titlepages — Properties for section titles — Properties for level-1 section titles — Properties for level-2 section titles — Properties for level-3 section titles — Properties for level-4 section titles — Properties for level-5 section titles — Properties for level-6 section titles — Properties for all section levels — Properties for level-1 sections — Properties for level-2 sections — Properties for level-3 sections — Properties for level-4 sections — Properties for level-5 sections — Properties for level-6 sections — Properties associated with a figure — Properties associated with a example — Properties associated with a equation — Properties associated with the block surrounding a table — Properties associated with an informalfigure — Properties associated with an informalexample — Properties associated with an informalequation — Properties associated with the block surrounding an informaltable — Properties associated with a procedure — The properties of the fo:root element — Properties for qanda set titles — Properties for level-1 qanda set titles — Properties for level-2 qanda set titles — Properties for level-3 qanda set titles — Properties for level-4 qanda set titles — Properties for level-5 qanda set titles — Properties for level-6 qanda set titles — Properties for appendix titles that appear in an article — Properties associated with the block surrounding an abstract — Properties for abstract titles — Properties associated with index page numbers — The properties of table used for formatting revhistory — The properties of table cells used for formatting revhistory — The properties of revhistory title
2.22. Profiling
profile.arch — Target profile for arch attribute
profile.audience — Target profile for audience attribute
profile.condition — Target profile for condition attribute
profile.conformance — Target profile for conformance attribute
profile.lang — Target profile for lang attribute
profile.os — Target profile for os attribute
profile.revision — Target profile for revision attribute
profile.revisionflag — Target profile for revisionflag attribute
profile.role — Target profile for role attribute — Target profile for security attribute
profile.status — Target profile for status attribute
profile.userlevel — Target profile for userlevel attribute
profile.vendor — Target profile for vendor attribute
profile.wordsize — Target profile for wordsize attribute
profile.attribute — Name of user-specified profiling attribute
profile.value — Target profile for user-specified attribute
profile.separator — Separator character for compound profile values
2.23. Localization
l10n.gentext.language — Sets the gentext language
l10n.gentext.default.language — Sets the default language for generated text
l10n.gentext.use.xref.language — Use the language of target when generating cross-reference text?
l10n.lang.value.rfc.compliant — Make value of lang attribute RFC compliant?
writing.mode — Direction of text flow based on locale
2.24. EBNF
ebnf.assignment — The EBNF production assignment operator
ebnf.statement.terminator — Punctuation that ends an EBNF statement.
2.25. Prepress
crop.marks — Output crop marks?
crop.mark.width — Width of crop marks.
crop.mark.offset — Length of crop marks.
crop.mark.bleed — Length of invisible part of crop marks.