diff options
Diffstat (limited to 'fo/pi.xml')
| -rw-r--r-- | fo/pi.xml | 1002 |
1 files changed, 1002 insertions, 0 deletions
diff --git a/fo/pi.xml b/fo/pi.xml new file mode 100644 index 0000000..937ef15 --- /dev/null +++ b/fo/pi.xml @@ -0,0 +1,1002 @@ +<?xml version="1.0"?> + +<reference><info><title>FO Processing Instruction Reference</title> + <releaseinfo role="meta"> + $Id: pi.xsl 9267 2012-04-03 20:23:45Z bobstayton $ + </releaseinfo> + </info> + + <partintro xml: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> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_background-color"> +<refnamediv> +<refname>dbfo_background-color</refname> +<refpurpose>Sets background color for an image</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>background-color="<replaceable>color</replaceable>"</term> + <listitem> + +<para>An HTML color value</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_bgcolor"> +<refnamediv> +<refname>dbfo_bgcolor</refname> +<refpurpose>Sets background color on a table row or table cell</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term> + <listitem> + +<para>An HTML color value</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_float-type"> +<refnamediv> +<refname>dbfo_float-type</refname> +<refpurpose>Specifies float behavior for a sidebar</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<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> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as + side float</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_funcsynopsis-style"> +<refnamediv> +<refname>dbfo_funcsynopsis-style</refname> +<refpurpose>Specifies presentation style for a funcsynopsis</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>funcsynopsis.style</parameter></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossary-presentation"> +<refnamediv> +<refname>dbfo_glossary-presentation</refname> +<refpurpose>Specifies presentation style for a glossary</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>glossary.as.blocks</parameter></para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary + formatting in print</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glosslist-presentation"> +<refnamediv> +<refname>dbfo_glosslist-presentation</refname> +<refpurpose>Specifies presentation style for a glosslist</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>glosslist.as.blocks</parameter> </para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary + formatting in print</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossterm-width"> +<refnamediv> +<refname>dbfo_glossterm-width</refname> +<refpurpose>Specifies the glossterm width for a glossary or + glosslist</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term> + <listitem> + +<para>Specifies the glossterm width (including units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>glossterm.width</parameter>, + <parameter>glossterm.separation</parameter> + </para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary + formatting in print</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_keep-together"> +<refnamediv> +<refname>dbfo_keep-together</refname> +<refpurpose>Specifies “keep” behavior for a table, example, + figure, equation, procedure, or task</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para>formal.object.properties</para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_label-width"> +<refnamediv> +<refname>dbfo_label-width</refname> +<refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist + or calloutlist</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>label-width="<replaceable>width</replaceable>"</term> + <listitem> + +<para>Specifies the label width (including units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.everyNth"> +<refnamediv> +<refname>dbfo_linenumbering.everyNth</refname> +<refpurpose>Specifies interval for line numbers in verbatims</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>linenumbering.everyNth</parameter></para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.separator"> +<refnamediv> +<refname>dbfo_linenumbering.separator</refname> +<refpurpose>Specifies separator text for line numbers in verbatims</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term> + <listitem> + +<para>Specifies the text (zero or more characters)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>linenumbering.separator</parameter></para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.width"> +<refnamediv> +<refname>dbfo_linenumbering.width</refname> +<refpurpose>Specifies width for line numbers in verbatims</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term> + <listitem> + +<para>Specifies the width (inluding units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>linenumbering.width</parameter></para> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-presentation"> +<refnamediv> +<refname>dbfo_list-presentation</refname> +<refpurpose>Specifies presentation style for a variablelist or + segmentedlist</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<itemizedlist> + <listitem> + +<para><parameter>variablelist.as.blocks</parameter></para> + + </listitem> + <listitem> + +<para><parameter>variablelist.as.table</parameter></para> + + </listitem> + </itemizedlist> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-width"> +<refnamediv> +<refname>dbfo_list-width</refname> +<refpurpose>Specifies the width of a horizontal simplelist</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>list-width="<replaceable>width</replaceable>"</term> + <listitem> + +<para>Specifies the <tag>simplelist</tag> width (including units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_orientation"> +<refnamediv> +<refname>dbfo_orientation</refname> +<refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_pgwide"> +<refnamediv> +<refname>dbfo_pgwide</refname> +<refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<para><parameter>pgwide.properties</parameter></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_rotated-width"> +<refnamediv> +<refname>dbfo_rotated-width</refname> +<refpurpose>Specifies the width for a CALS table <tag>entry</tag> or + <tag>row</tag></refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_sidebar-width"> +<refnamediv> +<refname>dbfo_sidebar-width</refname> +<refpurpose>Specifies the width of a sidebar</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term> + <listitem> + +<para>Specifies the <tag>sidebar</tag> width (including units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="params"><title>Related Global Parameters</title> + +<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> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as + side float</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_start"> +<refnamediv> +<refname>dbfo_start</refname> +<refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_table-width"> +<refnamediv> +<refname>dbfo_table-width</refname> +<refpurpose>Specifies the width for a CALS table or for revhistory + output</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_term-width"> +<refnamediv> +<refname>dbfo_term-width</refname> +<refpurpose>Specifies the term width for a variablelist</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>term-width="<replaceable>width</replaceable>"</term> + <listitem> + +<para>Specifies the term width (including units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_toc"> +<refnamediv> +<refname>dbfo_toc</refname> +<refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<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> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo-need"> +<refnamediv> +<refname>dbfo-need</refname> +<refpurpose>Specify a need for space (a kind of soft page break)</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<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> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para> + + </refsect1></refentry> + +<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_row-height"> +<refnamediv> +<refname>dbfo_row-height</refname> +<refpurpose>Specifies the height for a CALS table row</refpurpose> +</refnamediv> +<refsynopsisdiv> + + <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis> + +</refsynopsisdiv> +<refsect1><title>Description</title> + +<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> + + </refsect1><refsect1><title>Parameters</title> + +<variablelist> + <varlistentry><term>row-height="<replaceable>height</replaceable>"</term> + <listitem> + +<para>Specifies the row height (including units)</para> + + </listitem> + </varlistentry> + </variablelist> + + </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title> + +<para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para> + + </refsect1></refentry> +</reference> + |