FO Parameter Reference
|  | Next

# FO Parameter Reference

### Norman Walsh

$Id: param.xweb 6369 2006-10-19 08:40:35Z xmldoc $

Copyright © 1999, 2000, 2001 Norman Walsh

Abstract

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

I. Admonitions
  admon.graphics — Use graphics in admonitions?
  admon.graphics.extension — Extension for admonition graphics
  admon.graphics.path — Path to admonition graphics
  admon.textlabel — Use text label in admonitions?
  admonition.title.properties — To set the style for admonitions titles.
  admonition.properties — To set the style for admonitions.
  graphical.admonition.properties — To add properties to the outer block of a graphical admonition.
  nongraphical.admonition.properties — To add properties to the outer block of a nongraphical admonition.
II. Callouts
  callout.defaultcolumn — Indicates what column callouts appear in by default
  callout.graphics — Use graphics for callouts?
  callout.graphics.extension — Extension for callout graphics
  callout.graphics.number.limit — Number of the largest callout graphic
  callout.graphics.path — Path to callout graphics
  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 callout graphic
  callout.unicode.start.character — First Unicode character to use, decimal value.
  callouts.extension — Enable the callout extension
III. 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
  index.preferred.page.properties — Properties used to emphasize page number references for significant index terms
  index.entry.properties — Properties applied to the formatted entries in an index
  index.div.title.properties — 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
  xep.index.item.properties — Properties associated with XEP index-items
  toc.section.depth — How deep should recursive `section`s appear in the TOC?
  toc.max.depth — How maximaly deep should be each TOC?
  toc.indent.width — Amount of indentation for TOC entries
  toc.line.properties — Properties for lines in ToC and LoTs
  toc.margin.properties — Margin properties used on Tables of Contents
  bridgehead.in.toc — Should bridgehead elements appear in the TOC?
  simplesect.in.toc — Should `simplesect` elements appear in the TOC?
  generate.section.toc.level — Control depth of TOC generation in sections
IV. Processor Extensions
  arbortext.extensions — Enable Arbortext extensions?
  axf.extensions — Enable XSL Formatter extensions?
  fop.extensions — Enable FOP extensions for version 0.20.5 and earlier
  fop1.extensions — Enable extensions for FOP version 1 and later
  passivetex.extensions — Enable PassiveTeX extensions?
  tex.math.in.alt — TeX notation used for equations
  tex.math.delims — Should be equations outputed for processing by TeX automatically surrounded by math mode delimiters
  xep.extensions — Enable XEP extensions?
V. 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 — Enable the textinsert extension element
  textdata.default.encoding — Default encoding of external text files which are included using textdata element
  use.extensions — Enable extensions
VI. 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 chapters in each part?
  component.label.includes.part.label — Do component labels include the part label?
VII. XSLT Processing
  rootid — Specify the root element to format
VIII. Meta/*Info
  make.single.year.ranges — Print single-year ranges (e.g., 1998-1999)
  make.year.ranges — Collate copyright years into ranges?
  author.othername.in.middle — Is `othername` in `author` a middle name?
IX. Reference Pages
  funcsynopsis.decoration — Decorate elements of a FuncSynopsis?
  funcsynopsis.style — What style of 'FuncSynopsis' should be generated?
  function.parens — Generate parens after a function?
  refentry.generate.name — Output NAME header before 'RefName'(s)?
  refentry.generate.title — Output title before 'RefName'(s)?
  refentry.pagebreak — Start each refentry on a new page
  refentry.title.properties — Title properties for a refentry title
  refentry.xref.manvolnum — Output `manvolnum` as part of `refentry` cross-reference?
  refclass.suppress — Suppress display of refclass contents?
X. Tables
  default.table.width — The default width of tables
  nominal.table.width — The (absolute) nominal width of tables
  table.cell.padding
  table.frame.border.thickness — Specifies the thickness of the frame border
  table.frame.border.style
  table.frame.border.color
  table.cell.border.thickness
  table.cell.border.style
  table.cell.border.color
  table.table.properties — Properties associated with a table
XI. Linking
  current.docid — targetdoc identifier for the document being processed
  collect.xref.targets — Controls whether cross reference data is collected
  insert.olink.page.number — 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?
  olink.properties — 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
  use.local.olink.style — Process olinks using xref style of current document
XII. Cross References
  insert.xref.page.number — Turns page numbers in xrefs on and off
  xref.properties — 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
  insert.link.page.number — Turns page numbers in link elements on and off
XIII. Lists
  compact.list.item.spacing — What space do you want between list items (when spacing=compact)?
  itemizedlist.properties — Properties that apply to each list-block generated by itemizedlist.
  itemizedlist.label.properties — Properties that apply to each label inside itemized list.
  itemizedlist.label.width — The default width of the label (bullet) in an itemized list.
  list.block.properties — 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?
  orderedlist.properties — Properties that apply to each list-block generated by orderedlist.
  orderedlist.label.properties — 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 `term`s within a multi-term `varlistentry`
  variablelist.term.break.after — Generate line break after each `term` within a multi-term `varlistentry`?
XIV. 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.
XV. Bibliography
  biblioentry.item.separator — Text to separate bibliography entries
  bibliography.collection — Name of the bibliography collection file
  bibliography.numbered — Should bibliography entries be numbered?
  biblioentry.properties — To set the style for biblioentry.
XVI. Glossary
  glossterm.auto.link — Generate links from glossterm to glossentry automaticaly?
  firstterm.only.link — Does automatic glossterm linking only apply to firstterms?
  glossary.collection — Name of the glossary collection file
  glossterm.separation — Separation between glossary terms and descriptions in list mode
  glossterm.width — Width of glossterm in list presentation mode
  glossary.as.blocks — Present glossarys using blocks instead of lists?
  glosslist.as.blocks — Use blocks for glosslists?
  glossentry.show.acronym — Display `glossentry` acronyms?
XVII. 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 `comment` elements?
  punct.honorific — Punctuation after an honorific in a personal name.
  segmentedlist.as.table — Format segmented lists as tables?
  variablelist.as.blocks — Format `variablelist`s lists as blocks?
  blockquote.properties — To set the style for block quotations.
  ulink.show — Display URLs after `ulink`s?
  ulink.footnotes — Generate footnotes for `ULink`s?
  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?
  shade.verbatim.style — 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 line break can occur in listings
  use.svg — Allow SVG in the result tree?
  use.role.as.xrefstyle — Use `role` attribute for `xrefstyle` on `xref`?
  menuchoice.separator — Separator between items of a `menuchoice` other than `guimenuitem` and `guisubmenu`
  menuchoice.menu.separator — 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
  footnote.properties — Properties applied to each footnote body
  table.footnote.properties — Properties applied to each table footnote body
  footnote.mark.properties — Properties applied to each footnote mark
  footnote.sep.leader.properties — Properties associated with a procedure
  xref.with.number.and.title — Use number and title in cross references
  superscript.properties — Properties associated with superscripts
  subscript.properties — Properties associated with subscripts
  pgwide.properties — Properties to make a figure or table page wide.
  highlight.source — Should be content of `programlisting` syntactically highlighted?
  highlight.default.language — Default language of programlisting
  email.delimiters.enabled — Generate delimiters around email addresses?
XVIII. 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 image files
  keep.relative.image.uris — Should image URIs be resolved against xml:base?
XIX. 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
  page.margin.top — 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
  body.margin.top — 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
  column.gap.back — Gap between columns in back matter
  column.gap.body — Gap between columns in the body
  column.gap.front — Gap between columns in the front matter
  column.gap.index — Gap between columns in the index
  column.gap.lot — Gap between columns on a 'List-of-Titles' page
  column.gap.titlepage — 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
  header.table.height — Specify the minimum height of the table containing the running page headers
  footer.table.height — Specify the minimum height of the table containing the running page footers
  header.content.properties
  footer.content.properties
  marker.section.level — Control depth of sections shown in running headers or footers
XX. Font Families
  body.font.family — The default font family for body text
  dingbat.font.family — The font family for copyright, quotes, and other symbols
  monospace.font.family — The default font family for monospace environments
  sans.font.family — The default sans-serif font family
  title.font.family — The default font family for titles
  symbol.font.family — The font families to be searched for symbols outside of the body font
XXI. Property Sets
  formal.object.properties — Properties associated with a formal object such as a figure, or other component that has a title
  formal.title.properties — Style the title element of formal object such as a figure.
  informal.object.properties — Properties associated with a formal object such as a figure, or other component that has a title
  monospace.properties — Properties of monospaced content
  verbatim.properties — Properties associated with verbatim text
  monospace.verbatim.properties — What font and size do you want for monospaced content?
  sidebar.properties — Attribute set for sidebar properties
  sidebar.title.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
  margin.note.properties — Attribute set for margin.note properties
  margin.note.title.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
  component.title.properties — Properties for component titles
  section.title.properties — Properties for section titles
  section.title.level1.properties — Properties for level-1 section titles
  section.title.level2.properties — Properties for level-1 section titles
  section.title.level3.properties — Properties for level-1 section titles
  section.title.level4.properties — Properties for level-1 section titles
  section.title.level5.properties — Properties for level-1 section titles
  section.title.level6.properties — Properties for level-1 section titles
  section.properties — Properties for all section levels
  section.level1.properties — Properties for level-1 sections
  section.level2.properties — Properties for level-2 sections
  section.level3.properties — Properties for level-3 sections
  section.level4.properties — Properties for level-4 sections
  section.level5.properties — Properties for level-5 sections
  section.level6.properties — Properties for level-6 sections
  figure.properties — Properties associated with a figure
  example.properties — Properties associated with a example
  equation.properties — Properties associated with a equation
  table.properties — Properties associated with the block surrounding a table
  informalfigure.properties — Properties associated with an informalfigure
  informalexample.properties — Properties associated with an informalexample
  informalequation.properties — Properties associated with a informalequation
  informaltable.properties — Properties associated with the block surrounding an informaltable
  procedure.properties — Properties associated with a procedure
  root.properties — The properties of the fo:root element
  qanda.title.properties — Properties for qanda set titles
  qanda.title.level1.properties — Properties for level-1 qanda set titles
  qanda.title.level2.properties — Properties for level-2 qanda set titles
  qanda.title.level3.properties — Properties for level-3 qanda set titles
  qanda.title.level4.properties — Properties for level-4 qanda set titles
  qanda.title.level5.properties — Properties for level-5 qanda set titles
  qanda.title.level6.properties — Properties for level-6 qanda set titles
  article.appendix.title.properties — Properties for appendix titles that appear in an article
  abstract.properties — Properties associated with the block surrounding an abstract
  abstract.title.properties — Properties for abstract titles
  revhistory.table.properties — The properties of table used for formatting revhistory
  revhistory.table.cell.properties — The properties of table cells used for formatting revhistory
  revhistory.title.properties — The properties of revhistory title
XXII. Profiling
  profile.arch — Target profile for `arch` 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
  profile.security — 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.attribute — Name of user-specified profiling attribute
  profile.value — Target profile for user-specified attribute
  profile.separator — Separator character for compound profile values
XXIII. 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?
XXIV. EBNF
  ebnf.assignment — The EBNF production assignment operator
  ebnf.statement.terminator — Punctuation that ends an EBNF statement.
XXV. 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.
A. The Stylesheet

List of Figures

1. Page Model

|  | Next
|  | Admonitions