$Id: pi.xsl 9267 2012-04-03 20:23:45Z bobstayton $ This 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 image Use 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 value Background color Sets background color on a table row or table cell Use the dbfo bgcolor PI as child of a table row or cell to set a background color for that table row or cell. This PI works for both CALS and HTML tables. dbfo bgcolor="color" bgcolor="color" An HTML color value Cell background color Specifies float behavior for a sidebar Use 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.properties (attribute-set) A sidebar as side float Specifies presentation style for a funcsynopsis Use the dbfo funcsynopsis-style PI as a child of a funcsynopsis or anywhere within a funcsynopsis to control the presentation style for output of all funcprototype instances within that funcsynopsis. dbfo funcsynopsis-style="kr"|"ansi" funcsynopsis-style="kr" Displays funcprototype output in K&R style funcsynopsis-style="ansi" Displays funcprototype output in ANSI style funcsynopsis.style Specifies presentation style for a glossary Use 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 list glossary-presentation="blocks" Displays the glossary as blocks glossary.as.blocks Glossary formatting in print Specifies presentation style for a glosslist Use 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 list glosslist-presentation="blocks" Displays the glosslist as blocks glosslist.as.blocks Glossary formatting in print Specifies the glossterm width for a glossary or glosslist Use 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.separation Glossary formatting in print Specifies “keep” behavior for a table, example, figure, equation, procedure, or task Use the dbfo keep-together PI as a child of a formal object (table, example, figure, equation, procedure, or task) to specify “keep” behavior (to allow the object to “break” across a page). The PI also works with informaltable, informalexample, informalfigure and informalequation. dbfo keep-together="auto"|"always" keep-together="auto" Enables the object to break across a page keep-together="always" Prevents the object from breaking across a page (the default stylesheet behavior) formal.object.properties Keep-together processing instruction Specifies the label width for a qandaset, itemizedlist, orderedlist or calloutlist Use the dbfo label-width PI as a child of a qandaset, itemizedlist, orderedlist, or calloutlist to specify the width of labels. dbfo label-width="width" label-width="width" Specifies the label width (including units) Q and A formatting Specifies interval for line numbers in verbatims Use 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 line linenumbering.everyNth Line numbering Specifies separator text for line numbers in verbatims Use 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.separator Line numbering Specifies width for line numbers in verbatims Use 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.width Line numbering Specifies presentation style for a variablelist or segmentedlist Use 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 list list-presentation="blocks" (variablelist only) Displays the list as blocks list-presentation="table" (segmentedlist only) Displays the list as a table variablelist.as.blocks variablelist.as.table Variable list formatting in print Specifies the width of a horizontal simplelist Use 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 a CALS table row or cell Use the dbfo orientation PI as a child of a CALS 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 rotated Specifies if an equation or example goes across full page width Use 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 flow pgwide="1" If 1 (or any non-zero value), the content is rendered across the full width of the page pgwide.properties Specifies the width for a CALS table entry or row Use the dbfo rotated-width PI as a child of entry or row instance in a CALS table 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 sidebar Use 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.properties A sidebar as side float (obsolete) Sets the starting number on an ordered list This 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 numerals List starting number Specifies the width for a CALS table or for revhistory output Use the dbfo table-width PI as a child or sibling of a CALS table, or as a child of an informaltable, entrytbl, 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 width Specifies the term width for a variablelist Use 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 print Specifies whether a TOC should be generated for a qandaset Use 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 generated toc="1" If 1 (or any non-zero value), a TOC is generated Q and A list of questions, Q and A formatting Specify 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 breaks Specifies the height for a CALS table row Use the dbfo row-height PI as a child of a row to specify the height of the row. dbfo row-height="height" row-height="height" Specifies the row height (including units) Row height 0pt filename