FO Processing Instruction Reference
$Id$
IntroductionThis is generated reference documentation for all
user-specifiable processing instructions (PIs) in the DocBook
XSL stylesheets for FO output.
You add these PIs at particular points in a document to
cause specific “exceptions” to formatting/output behavior. To
make global changes in formatting/output behavior across an
entire document, it’s better to do it by setting an
appropriate stylesheet parameter (if there is one).Sets background color for an imageUse the dbfo background-color PI before or
after an image (graphic, inlinegraphic,
imagedata, or videodata element) as a
sibling to the element, to set a background color for the
image.dbfo background-color="color"background-color="color"An HTML color valueBackground colorSets background color on a table row or table cellUse the dbfo bgcolor PI as child of a table row
or cell to set a background color for that table row or cell.dbfo bgcolor="color"bgcolor="color"An HTML color valueCell background colorSpecifies float behavior for a sidebarUse the dbfo float-type PI to specify the float
behavior for a sidebar (to cause the sidebar to be
displayed as a marginal note).dbfo float-type="margin.note"float-type="margin.note"Specifies that the sidebar should be
displayed as a marginal note.sidebar.float.type parameter,
sidebar.float.width parameter,
sidebar.properties attribute-set,
sidebar.title.propertiesA sidebar as
side floatSpecifies presentation style for a glossaryUse the dbfo glossary-presentation PI as a child of
a glossary to control its presentation style.dbfo glossary-presentation="list"|"blocks"glossary-presentation="list"Displays the glossary as a listglossary-presentation="blocks"Displays the glossary as blocksglossary.as.blocksGlossary
formatting in printSpecifies presentation style for a glosslistUse the dbfo glosslist-presentation PI as a child of
a glosslist to control its presentation style.dbfo glosslist-presentation="list"|"blocks"glosslist-presentation="list"Displays the glosslist as a listglosslist-presentation="blocks"Displays the glosslist as blocksglosslist.as.blocksGlossary
formatting in printSpecifies the glossterm width for a glossary or
glosslistUse the dbfo glossterm-width PI as a child of a
glossary or glosslist to specify the
width for output of glossterm instances in the
output.dbfo glossterm-width="width"glossterm-width="width"Specifies the glossterm width (including units)glossterm.width,
glossterm.separationGlossary
formatting in printSpecifies “keep” behavior for a table, example,
figure, or equationUse the dbfo keep-together PI as a child of a
formal object (table, example,
figure, or equation) or their informal
equivalents) to specify “keep” behavior for the object (to
allow the object to “break” across a page).dbfo keep-together="auto"|"always"keep-together="auto"Enables the object to break across a pagekeep-together="always"Prevents the object from breaking across a page (the
default stylesheet behavior)formal.object.propertiesKeep-together processing instructionSpecifies the label width for a qandasetUse the dbfo label-width PI as a child of a
qandaset to specify the width of labels.dbfo label-width="width"label-width="width"Specifies the label width (including units)Q and A formattingSpecifies interval for lines numbers in verbatimsUse the dbfo linenumbering.everyNth PI as a child
of a “verbatim” element – programlisting,
screen, synopsis — to specify
the interval at which lines are numbered.dbfo linenumbering.everyNth="N"linenumbering.everyNth="N"Specifies numbering interval; a number is output
before every Nth linelinenumbering.everyNthLine numberingSpecifies separator text for line numbers in verbatimsUse the dbfo linenumbering.separator PI as a child
of a “verbatim” element – programlisting,
screen, synopsis — to specify
the separator text output between the line numbers and content.dbfo linenumbering.separator="text"linenumbering.separator="text"Specifies the text (zero or more characters)linenumbering.separatorLine numberingSpecifies width for line numbers in verbatimsUse the dbfo linenumbering.width PI as a child
of a “verbatim” element – programlisting,
screen, synopsis — to specify
the width set aside for line numbers.dbfo linenumbering.width="width"linenumbering.width="width"Specifies the width (inluding units)linenumbering.widthLine numberingSpecifies presentation style for a variablelist or
segmentedlistUse the dbfo list-presentation PI as a child of
a variablelist or segmentedlist to
control the presentation style for the list (to cause it, for
example, to be displayed as a table).dbfo list-presentation="list"|"blocks"|"table"list-presentation="list"Displays the list as a listlist-presentation="blocks"(variablelist only) Displays the list as blockslist-presentation="table"(segmentedlist only) Displays the list as a tablevariablelist.as.blocksvariablelist.as.tableVariable list formatting in printSpecifies the width of a horizontal simplelistUse the dbfo list-width PI as a child of a
simplelist whose class
value is horizontal, to specify the width
of the simplelist.dbfo list-width="width"list-width="width"Specifies the simplelist width (including units)Specifies the orientation for table row or cellUse the dbfo orientation PI as a child of an
table row or cell to specify the orientation
(rotation) for the row or cell.dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"Specifies the number of degrees by which the cell or
row is rotatedSpecifies if an equation or example goes across full page widthUse the dbfo pgwide PI as a child of an
equation or example to specify that the
content should rendered across the full width of the page.dbfo pgwide="0"|"1"pgwide="0"If zero, the content is rendered across the current
text flowpgwide="1"If 1 (or any non-zero value), the
content is rendered across the full width of the pagepgwide.propertiesSpecifies the width for a table entry or
rowUse the dbfo rotated-width PI as a child of an
entry or row instance to specify the
width of that the entry or row; or
use it higher up in table to cause the width to be inherited
recursively down.dbfo rotated-width="width"rotated-width="width"Specifies the width of a row or cell (including units)Specifies the width of a sidebarUse the dbfo sidebar-width PI as a child of a
sidebar to specify the width of the sidebar.dbfo sidebar-width="width"sidebar-width="width"Specifies the sidebar width (including units)sidebar.float.type parameter,
sidebar.float.width parameter,
sidebar.properties attribute-set,
sidebar.title.propertiesA sidebar as
side float(obsolete) Sets the starting number on an ordered listThis PI is obsolete. The intent of
it was to provide a means for setting a specific starting
number for an ordered list. Instead of this PI, set a value
for the override attribute on the first
listitem in the list; that will have the same
effect as what this PI was intended for.dbfo start="character"start="character"Specifies the character to use as the starting
number; use 0-9, a-z, A-Z, or lowercase or uppercase
Roman numeralsList starting numberSpecifies the width for a table or for revhistory
outputUse the dbfo table-width PI as a child or
sibling of a table, or as a child of an
informaltable, entrybl, or
revhistory instance (which is rendered as a table
in output) to specify the width of the table in output.dbfo table-width="width"table-width="width"Specifies the table width (including units or as a percentage)Table widthSpecifies the term width for a variablelistUse the dbfo term-width PI as a child of a
variablelist to specify the width for
term output.dbfo term-width="width"term-width="width"Specifies the term width (including units)Variable list formatting in printSpecifies whether a TOC should be generated for a qandasetUse the dbfo toc PI as a child of a
qandaset to specify whether a table of contents
(TOC) is generated for the qandaset.dbfo toc="0"|"1"toc="0"If zero, no TOC is generatedtoc="1"If 1 (or any non-zero value),
a TOC is generatedQ and A list of questions,
Q and A formattingSpecify a need for space (a kind of soft page break)A “need” is a request for space on a page. If the
requested space is not available, the page breaks and the
content that follows the need request appears on the next
page. If the requested space is available, then no page break
is inserted.dbfo-need height="n" [space-before="n"]height="n"The amount of height needed (including units)space-before="n"The amount of extra vertical space to add (including units)Soft page breaks0ptfilename