<?xml version='1.0'?>
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:d="http://docbook.org/ns/docbook"
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:xlink="http://www.w3.org/1999/xlink"
exclude-result-prefixes="doc xlink d"
version='1.0'>
<!-- ********************************************************************
$Id: pi.xsl 9267 2012-04-03 20:23:45Z bobstayton $
********************************************************************
This file is part of the XSL DocBook Stylesheet distribution.
See ../README or http://docbook.sf.net/release/xsl/current/ for
copyright and other information.
******************************************************************** -->
<doc:reference xmlns=""><info><title>FO Processing Instruction Reference</title>
<releaseinfo role="meta">
$Id: pi.xsl 9267 2012-04-03 20:23:45Z bobstayton $
</releaseinfo>
</info>
<partintro id="partintro">
<title>Introduction</title>
<para>This is generated reference documentation for all
user-specifiable processing instructions (PIs) in the DocBook
XSL stylesheets for FO output.
<note>
<para>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).</para>
</note>
</para>
</partintro>
</doc:reference>
<!-- ==================================================================== -->
<doc:pi name="dbfo_background-color" xmlns="">
<refpurpose>Sets background color for an image</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
<tag>imagedata</tag>, or <tag>videodata</tag> element) as a
sibling to the element, to set a background color for the
image.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
<listitem>
<para>An HTML color value</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="BGcolor.html"
>Background color</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_background-color">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'background-color'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_bgcolor" xmlns="">
<refpurpose>Sets background color on a table row or table cell</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
or cell to set a background color for that table row or cell.</para>
<para>This PI works for both CALS and HTML tables.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
<listitem>
<para>An HTML color value</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="BGtableColor.html#CellBGColor"
>Cell background color</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_bgcolor">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'bgcolor'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_float-type" xmlns="">
<refpurpose>Specifies float behavior for a sidebar</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
behavior for a <tag>sidebar</tag> (to cause the sidebar to be
displayed as a marginal note).</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>float-type="margin.note"</term>
<listitem>
<para>Specifies that the <tag>sidebar</tag> should be
displayed as a marginal note.</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>sidebar.float.type</parameter> (parameter),
<parameter>sidebar.float.width</parameter> (parameter),
<parameter>sidebar.properties</parameter> (attribute-set),
<parameter>sidebar.title.properties</parameter> (attribute-set)
</para>
</refsee>
<refsee role="tcg">
<para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats" >A sidebar as
side float</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_float-type">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'float-type'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_funcsynopsis-style" xmlns="">
<refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
to control the presentation style for output of all
<tag>funcprototype</tag> instances within that funcsynopsis.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>funcsynopsis-style="kr"</term>
<listitem>
<para>Displays <tag>funcprototype</tag> output in K&R style</para>
</listitem>
</varlistentry>
<varlistentry><term>funcsynopsis-style="ansi"</term>
<listitem>
<para>Displays <tag>funcprototype</tag> output in ANSI style</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>funcsynopsis.style</parameter></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_funcsynopsis-style">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'funcsynopsis-style'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_glossary-presentation" xmlns="">
<refpurpose>Specifies presentation style for a glossary</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
a <tag>glossary</tag> to control its presentation style.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>glossary-presentation="list"</term>
<listitem>
<para>Displays the glossary as a list</para>
</listitem>
</varlistentry>
<varlistentry><term>glossary-presentation="blocks"</term>
<listitem>
<para>Displays the glossary as blocks</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>glossary.as.blocks</parameter></para>
</refsee>
<refsee role="tcg">
<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint" >Glossary
formatting in print</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_glossary-presentation">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'glossary-presentation'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_glosslist-presentation" xmlns="">
<refpurpose>Specifies presentation style for a glosslist</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
a <tag>glosslist</tag> to control its presentation style.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>glosslist-presentation="list"</term>
<listitem>
<para>Displays the glosslist as a list</para>
</listitem>
</varlistentry>
<varlistentry><term>glosslist-presentation="blocks"</term>
<listitem>
<para>Displays the glosslist as blocks</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>glosslist.as.blocks</parameter> </para>
</refsee>
<refsee role="tcg">
<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint" >Glossary
formatting in print</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_glosslist-presentation">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'glosslist-presentation'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_glossterm-width" xmlns="">
<refpurpose>Specifies the glossterm width for a glossary or
glosslist</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
<tag>glossary</tag> or <tag>glosslist</tag> to specify the
width for output of <tag>glossterm</tag> instances in the
output.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the glossterm width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>glossterm.width</parameter>,
<parameter>glossterm.separation</parameter>
</para>
</refsee>
<refsee role="tcg">
<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint" >Glossary
formatting in print</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_glossterm-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'glossterm-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_keep-together" xmlns="">
<refpurpose>Specifies “keep” behavior for a table, example,
figure, equation, procedure, or task</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
formal object (<tag>table</tag>, <tag>example</tag>,
<tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
<tag>task</tag>) to specify “keep” behavior (to allow the object to
“break” across a page).</para>
<para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
<tag>informalfigure</tag> and <tag>informalequation</tag>.
</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>keep-together="auto"</term>
<listitem>
<para>Enables the object to break across a page</para>
</listitem>
</varlistentry>
<varlistentry><term>keep-together="always"</term>
<listitem>
<para>Prevents the object from breaking across a page (the
default stylesheet behavior)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para>formal.object.properties</para>
</refsee>
<refsee role="tcg">
<para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI"
>Keep-together processing instruction</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_keep-together">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'keep-together'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_label-width" xmlns="">
<refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
or calloutlist</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
<tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
or <tag>calloutlist</tag> to specify the width of labels.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the label width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="QandAformat.html"
>Q and A formatting</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_label-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'label-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_linenumbering.everyNth" xmlns="">
<refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
of a “verbatim” element – <tag>programlisting</tag>,
<tag>screen</tag>, <tag>synopsis</tag> — to specify
the interval at which lines are numbered.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
<listitem>
<para>Specifies numbering interval; a number is output
before every <replaceable>N</replaceable>th line</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>linenumbering.everyNth</parameter></para>
</refsee>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="AnnotateListing.html#LineNumbering"
>Line numbering</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_linenumbering.everyNth">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'linenumbering.everyNth'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_linenumbering.separator" xmlns="">
<refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
of a “verbatim” element – <tag>programlisting</tag>,
<tag>screen</tag>, <tag>synopsis</tag> — to specify
the separator text output between the line numbers and content.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
<listitem>
<para>Specifies the text (zero or more characters)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>linenumbering.separator</parameter></para>
</refsee>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="AnnotateListing.html#LineNumbering"
>Line numbering</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_linenumbering.separator">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'linenumbering.separator'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_linenumbering.width" xmlns="">
<refpurpose>Specifies width for line numbers in verbatims</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
of a “verbatim” element – <tag>programlisting</tag>,
<tag>screen</tag>, <tag>synopsis</tag> — to specify
the width set aside for line numbers.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the width (inluding units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>linenumbering.width</parameter></para>
</refsee>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="AnnotateListing.html#LineNumbering"
>Line numbering</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_linenumbering.width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'linenumbering.width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_list-presentation" xmlns="">
<refpurpose>Specifies presentation style for a variablelist or
segmentedlist</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
control the presentation style for the list (to cause it, for
example, to be displayed as a table).</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>list-presentation="list"</term>
<listitem>
<para>Displays the list as a list</para>
</listitem>
</varlistentry>
<varlistentry><term>list-presentation="blocks"</term>
<listitem>
<para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
</listitem>
</varlistentry>
<varlistentry><term>list-presentation="table"</term>
<listitem>
<para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<itemizedlist>
<listitem>
<para><parameter>variablelist.as.blocks</parameter></para>
</listitem>
<listitem>
<para><parameter>variablelist.as.table</parameter></para>
</listitem>
</itemizedlist>
</refsee>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="Variablelists.html#ListIndents"
>Variable list formatting in print</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_list-presentation">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'list-presentation'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_list-width" xmlns="">
<refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
<tag>simplelist</tag> whose <tag class="attribute">class</tag>
value is <literal>horizontal</literal>, to specify the width
of the <tag>simplelist</tag>.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the <tag>simplelist</tag> width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
</doc:pi>
<xsl:template name="pi.dbfo_list-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'list-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_orientation" xmlns="">
<refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
<tag>table</tag> row or cell to specify the orientation
(rotation) for the row or cell.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
<listitem>
<para>Specifies the number of degrees by which the cell or
row is rotated</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
</doc:pi>
<xsl:template name="pi.dbfo_orientation">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'orientation'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_pgwide" xmlns="">
<refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
<tag>equation</tag> or <tag>example</tag> to specify that the
content should rendered across the full width of the page.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>pgwide="0"</term>
<listitem>
<para>If zero, the content is rendered across the current
text flow</para>
</listitem>
</varlistentry>
<varlistentry><term>pgwide="1"</term>
<listitem>
<para>If <code>1</code> (or any non-zero value), the
content is rendered across the full width of the page</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>pgwide.properties</parameter></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_pgwide">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'pgwide'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_rotated-width" xmlns="">
<refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
<tag>row</tag></refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
<tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
width of that the <tag>entry</tag> or <tag>row</tag>; or
use it higher up in table to cause the width to be inherited
recursively down.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the width of a row or cell (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
</doc:pi>
<xsl:template name="pi.dbfo_rotated-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'rotated-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_sidebar-width" xmlns="">
<refpurpose>Specifies the width of a sidebar</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
<tag>sidebar</tag> to specify the width of the sidebar.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the <tag>sidebar</tag> width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="params">
<para><parameter>sidebar.float.type parameter</parameter>,
<parameter>sidebar.float.width parameter</parameter>,
<parameter>sidebar.properties attribute-set</parameter>,
<parameter>sidebar.title.properties</parameter>
</para>
</refsee>
<refsee role="tcg">
<para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats" >A sidebar as
side float</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_sidebar-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'sidebar-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_start" xmlns="">
<refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
<refdescription>
<para><emphasis>This PI is obsolete</emphasis>. 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 <literal>override</literal> attribute on the first
<tag>listitem</tag> in the list; that will have the same
effect as what this PI was intended for.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>start="<replaceable>character</replaceable>"</term>
<listitem>
<para>Specifies the character to use as the starting
number; use 0-9, a-z, A-Z, or lowercase or uppercase
Roman numerals</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="Orderedlists.html#ListStartNum"
>List starting number</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_start">
<xsl:param name="node" select="."/>
<xsl:call-template name="pi-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'start'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_table-width" xmlns="">
<refpurpose>Specifies the width for a CALS table or for revhistory
output</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
sibling of a CALS <tag>table</tag>, or as a child of an
<tag>informaltable</tag>, <tag>entrytbl</tag>, or
<tag>revhistory</tag> instance (which is rendered as a table
in output) to specify the width of the table in output.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the table width (including units or as a percentage)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="Tables.html#TableWidth"
>Table width</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_table-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'table-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_term-width" xmlns="">
<refpurpose>Specifies the term width for a variablelist</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
<tag>variablelist</tag> to specify the width for
<tag>term</tag> output.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the term width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="Variablelists.html#ListIndents"
>Variable list formatting in print</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_term-width">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'term-width'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo_toc" xmlns="">
<refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
<tag>qandaset</tag> to specify whether a table of contents
(TOC) is generated for the <tag>qandaset</tag>.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>toc="0"</term>
<listitem>
<para>If zero, no TOC is generated</para>
</listitem>
</varlistentry>
<varlistentry><term>toc="1"</term>
<listitem>
<para>If <code>1</code> (or any non-zero value),
a TOC is generated</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="QandAtoc.html"
>Q and A list of questions</link>,
<link role="tcg"
xlink:href="QandAformat.html"
>Q and A formatting</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_toc">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'toc'"/>
</xsl:call-template>
</xsl:template>
<doc:pi name="dbfo-need" xmlns="">
<refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
<refdescription>
<para>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.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>height="<replaceable>n</replaceable>"</term>
<listitem>
<para>The amount of height needed (including units)</para>
</listitem>
</varlistentry>
<varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
<listitem>
<para>The amount of extra vertical space to add (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="PageBreaking.html#SoftPageBreaks"
>Soft page breaks</link></para>
</refsee>
</doc:pi>
<doc:pi name="dbfo_row-height" xmlns="">
<refpurpose>Specifies the height for a CALS table row</refpurpose>
<refdescription>
<para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
<tag>row</tag> to specify the height of the row.</para>
</refdescription>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refparameter>
<variablelist>
<varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
<listitem>
<para>Specifies the row height (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refparameter>
<refsee role="tcg">
<para><link role="tcg"
xlink:href="RowHeight.html"
>Row height</link></para>
</refsee>
</doc:pi>
<xsl:template name="pi.dbfo_row-height">
<xsl:param name="node" select="."/>
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
<xsl:with-param name="attribute" select="'row-height'"/>
</xsl:call-template>
</xsl:template>
<xsl:template name="pi.dbfo-need">
<xsl:variable name="pi-height">
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="."/>
<xsl:with-param name="attribute" select="'height'"/>
</xsl:call-template>
</xsl:variable>
<xsl:variable name="height">
<xsl:choose>
<xsl:when test="$pi-height != ''">
<xsl:value-of select="$pi-height"/>
</xsl:when>
<xsl:otherwise>0pt</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:variable name="pi-before">
<xsl:call-template name="dbfo-attribute">
<xsl:with-param name="pis" select="."/>
<xsl:with-param name="attribute" select="'space-before'"/>
</xsl:call-template>
</xsl:variable>
<xsl:variable name="spacer">
<fo:block-container width="100%" height="{$height}">
<fo:block><fo:leader leader-length="0pt"/></fo:block>
</fo:block-container>
</xsl:variable>
<xsl:choose>
<xsl:when test="$fop1.extensions != 0">
<!-- Doesn't work in fop -->
</xsl:when>
<xsl:when test="$fop.extensions != 0">
<!-- Doesn't work in fop -->
</xsl:when>
<xsl:when test="$pi-before != '' and
not(following-sibling::d:listitem) and
not(following-sibling::d:step)">
<fo:block space-after="0pt" space-before="{$pi-before}">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:when>
<xsl:when test="following-sibling::d:para">
<fo:block space-after="0pt"
xsl:use-attribute-sets="normal.para.spacing">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:when>
<xsl:when test="following-sibling::d:table or
following-sibling::d:figure or
following-sibling::d:example or
following-sibling::d:equation">
<fo:block space-after="0pt"
xsl:use-attribute-sets="formal.object.properties">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:when>
<xsl:when test="following-sibling::d:informaltable or
following-sibling::d:informalfigure or
following-sibling::d:informalexample or
following-sibling::d:informalequation">
<fo:block space-after="0pt"
xsl:use-attribute-sets="informal.object.properties">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:when>
<xsl:when test="following-sibling::d:itemizedlist or
following-sibling::d:orderedlist or
following-sibling::d:variablelist or
following-sibling::d:simplelist">
<fo:block space-after="0pt"
xsl:use-attribute-sets="informal.object.properties">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:when>
<xsl:when test="following-sibling::d:listitem or
following-sibling::d:step">
<fo:list-item space-after="0pt"
xsl:use-attribute-sets="informal.object.properties">
<fo:list-item-label>
<fo:block line-height="0pt"/>
</fo:list-item-label>
<fo:list-item-body start-indent="0pt" end-indent="0pt">
<xsl:copy-of select="$spacer"/>
</fo:list-item-body>
</fo:list-item>
</xsl:when>
<xsl:when test="following-sibling::d:sect1 or
following-sibling::d:sect2 or
following-sibling::d:sect3 or
following-sibling::d:sect4 or
following-sibling::d:sect5 or
following-sibling::d:section">
<fo:block space-after="0pt"
xsl:use-attribute-sets="section.title.properties">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block space-after="0pt" space-before="0em">
<xsl:copy-of select="$spacer"/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
<xsl:choose>
<xsl:when test="$fop1.extensions != 0">
<!-- Doesn't work in fop -->
</xsl:when>
<xsl:when test="$fop.extensions != 0">
<!-- Doesn't work in fop -->
</xsl:when>
<xsl:when test="following-sibling::d:listitem or
following-sibling::d:step">
<fo:list-item space-before.precedence="force"
space-before="-{$height}"
space-after="0pt"
space-after.precedence="force">
<fo:list-item-label>
<fo:block line-height="0pt"/>
</fo:list-item-label>
<fo:list-item-body start-indent="0pt" end-indent="0pt">
<fo:block line-height="0pt"/>
</fo:list-item-body>
</fo:list-item>
</xsl:when>
<xsl:otherwise>
<fo:block space-before.precedence="force"
space-before="-{$height}"
space-after="0pt"
space-after.precedence="force">
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- ==================================================================== -->
<xsl:template name="dbfo-attribute">
<!-- * dbfo-attribute is an interal utility template for retrieving -->
<!-- * pseudo-attributes/parameters from PIs -->
<xsl:param name="pis" select="processing-instruction('dbfo')"/>
<xsl:param name="attribute">filename</xsl:param>
<xsl:call-template name="pi-attribute">
<xsl:with-param name="pis" select="$pis"/>
<xsl:with-param name="attribute" select="$attribute"/>
</xsl:call-template>
</xsl:template>
<!-- ==================================================================== -->
<xsl:template match="processing-instruction()">
</xsl:template>
<!-- ==================================================================== -->
<xsl:template match="processing-instruction('dbfo-need')">
<xsl:call-template name="pi.dbfo-need"/>
</xsl:template>
</xsl:stylesheet>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 10838 | Robert Cowham |
Populate //guest/robert_cowham/perforce/utils/p4convert/... from //guest/perforce_software/p4convert/.... |
||
| //guest/perforce_software/p4convert/docs/_build/docbook-xsl-ns-1.78.1/fo/pi.xsl | |||||
| #1 | 10706 | Paul Allen | Add document '_build' files. | ||