+++ /dev/null
-<?xml version="1.0"?>\r
-\r
-<reference><info><title>FO Processing Instruction Reference</title>\r
- <releaseinfo role="meta">\r
- $Id: pi.xsl 8487 2009-07-14 21:43:36Z bobstayton $\r
- </releaseinfo>\r
- </info>\r
-\r
- <partintro xml:id="partintro">\r
- <title>Introduction</title>\r
-\r
- \r
-<para>This is generated reference documentation for all\r
- user-specifiable processing instructions (PIs) in the DocBook\r
- XSL stylesheets for FO output.\r
- <note>\r
- \r
-<para>You add these PIs at particular points in a document to\r
- cause specific “exceptions” to formatting/output behavior. To\r
- make global changes in formatting/output behavior across an\r
- entire document, it’s better to do it by setting an\r
- appropriate stylesheet parameter (if there is one).</para>\r
-\r
- </note>\r
- </para>\r
-\r
- </partintro>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_background-color">\r
-<refnamediv>\r
-<refname>dbfo_background-color</refname>\r
-<refpurpose>Sets background color for an image</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or\r
- after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,\r
- <tag>imagedata</tag>, or <tag>videodata</tag> element) as a\r
- sibling to the element, to set a background color for the\r
- image.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>An HTML color value</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_bgcolor">\r
-<refnamediv>\r
-<refname>dbfo_bgcolor</refname>\r
-<refpurpose>Sets background color on a table row or table cell</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row\r
- or cell to set a background color for that table row or cell.</para>\r
-\r
- \r
-<para>This PI works for both CALS and HTML tables.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>An HTML color value</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_float-type">\r
-<refnamediv>\r
-<refname>dbfo_float-type</refname>\r
-<refpurpose>Specifies float behavior for a sidebar</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float\r
- behavior for a <tag>sidebar</tag> (to cause the sidebar to be\r
- displayed as a marginal note).</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>float-type="margin.note"</term>\r
- <listitem>\r
- \r
-<para>Specifies that the <tag>sidebar</tag> should be\r
- displayed as a marginal note.</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>sidebar.float.type</parameter> (parameter),\r
- <parameter>sidebar.float.width</parameter> (parameter), \r
- <parameter>sidebar.properties</parameter> (attribute-set),\r
- <parameter>sidebar.title.properties</parameter> (attribute-set)\r
- </para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as\r
- side float</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_funcsynopsis-style">\r
-<refnamediv>\r
-<refname>dbfo_funcsynopsis-style</refname>\r
-<refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of\r
- a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis\r
- to control the presentation style for output of all\r
- <tag>funcprototype</tag> instances within that funcsynopsis.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>funcsynopsis-style="kr"</term>\r
- <listitem>\r
- \r
-<para>Displays <tag>funcprototype</tag> output in K&R style</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>funcsynopsis-style="ansi"</term>\r
- <listitem>\r
- \r
-<para>Displays <tag>funcprototype</tag> output in ANSI style</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>funcsynopsis.style</parameter></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossary-presentation">\r
-<refnamediv>\r
-<refname>dbfo_glossary-presentation</refname>\r
-<refpurpose>Specifies presentation style for a glossary</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of\r
- a <tag>glossary</tag> to control its presentation style.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>glossary-presentation="list"</term>\r
- <listitem>\r
- \r
-<para>Displays the glossary as a list</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>glossary-presentation="blocks"</term>\r
- <listitem>\r
- \r
-<para>Displays the glossary as blocks</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>glossary.as.blocks</parameter></para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary\r
- formatting in print</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glosslist-presentation">\r
-<refnamediv>\r
-<refname>dbfo_glosslist-presentation</refname>\r
-<refpurpose>Specifies presentation style for a glosslist</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of\r
- a <tag>glosslist</tag> to control its presentation style.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>glosslist-presentation="list"</term>\r
- <listitem>\r
- \r
-<para>Displays the glosslist as a list</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>glosslist-presentation="blocks"</term>\r
- <listitem>\r
- \r
-<para>Displays the glosslist as blocks</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>glosslist.as.blocks</parameter> </para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary\r
- formatting in print</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossterm-width">\r
-<refnamediv>\r
-<refname>dbfo_glossterm-width</refname>\r
-<refpurpose>Specifies the glossterm width for a glossary or\r
- glosslist</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a\r
- <tag>glossary</tag> or <tag>glosslist</tag> to specify the\r
- width for output of <tag>glossterm</tag> instances in the\r
- output.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the glossterm width (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>glossterm.width</parameter>,\r
- <parameter>glossterm.separation</parameter>\r
- </para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary\r
- formatting in print</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_keep-together">\r
-<refnamediv>\r
-<refname>dbfo_keep-together</refname>\r
-<refpurpose>Specifies “keep” behavior for a table, example,\r
- figure, equation, procedure, or task</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a\r
- formal object (<tag>table</tag>, <tag>example</tag>,\r
- <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or\r
- <tag>task</tag>) to specify “keep” behavior (to allow the object to \r
- “break” across a page).</para>\r
-\r
- \r
-<para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,\r
- <tag>informalfigure</tag> and <tag>informalequation</tag>.\r
- </para>\r
-\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>keep-together="auto"</term>\r
- <listitem>\r
- \r
-<para>Enables the object to break across a page</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>keep-together="always"</term>\r
- <listitem>\r
- \r
-<para>Prevents the object from breaking across a page (the\r
- default stylesheet behavior)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para>formal.object.properties</para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_label-width">\r
-<refnamediv>\r
-<refname>dbfo_label-width</refname>\r
-<refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist\r
- or calloutlist</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a\r
- <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>, \r
- or <tag>calloutlist</tag> to specify the width of labels.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the label width (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.everyNth">\r
-<refnamediv>\r
-<refname>dbfo_linenumbering.everyNth</refname>\r
-<refpurpose>Specifies interval for line numbers in verbatims</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child\r
- of a “verbatim” element – <tag>programlisting</tag>,\r
- <tag>screen</tag>, <tag>synopsis</tag> — to specify\r
- the interval at which lines are numbered.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies numbering interval; a number is output\r
- before every <replaceable>N</replaceable>th line</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>linenumbering.everyNth</parameter></para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.separator">\r
-<refnamediv>\r
-<refname>dbfo_linenumbering.separator</refname>\r
-<refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child\r
- of a “verbatim” element – <tag>programlisting</tag>,\r
- <tag>screen</tag>, <tag>synopsis</tag> — to specify\r
- the separator text output between the line numbers and content.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the text (zero or more characters)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>linenumbering.separator</parameter></para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.width">\r
-<refnamediv>\r
-<refname>dbfo_linenumbering.width</refname>\r
-<refpurpose>Specifies width for line numbers in verbatims</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child\r
- of a “verbatim” element – <tag>programlisting</tag>,\r
- <tag>screen</tag>, <tag>synopsis</tag> — to specify\r
- the width set aside for line numbers.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the width (inluding units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>linenumbering.width</parameter></para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-presentation">\r
-<refnamediv>\r
-<refname>dbfo_list-presentation</refname>\r
-<refpurpose>Specifies presentation style for a variablelist or\r
- segmentedlist</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of\r
- a <tag>variablelist</tag> or <tag>segmentedlist</tag> to\r
- control the presentation style for the list (to cause it, for\r
- example, to be displayed as a table).</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>list-presentation="list"</term>\r
- <listitem>\r
- \r
-<para>Displays the list as a list</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>list-presentation="blocks"</term>\r
- <listitem>\r
- \r
-<para>(<tag>variablelist</tag> only) Displays the list as blocks</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>list-presentation="table"</term>\r
- <listitem>\r
- \r
-<para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<itemizedlist>\r
- <listitem>\r
- \r
-<para><parameter>variablelist.as.blocks</parameter></para>\r
-\r
- </listitem>\r
- <listitem>\r
- \r
-<para><parameter>variablelist.as.table</parameter></para>\r
-\r
- </listitem>\r
- </itemizedlist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-width">\r
-<refnamediv>\r
-<refname>dbfo_list-width</refname>\r
-<refpurpose>Specifies the width of a horizontal simplelist</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a\r
- <tag>simplelist</tag> whose <tag class="attribute">class</tag>\r
- value is <literal>horizontal</literal>, to specify the width\r
- of the <tag>simplelist</tag>.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the <tag>simplelist</tag> width (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_orientation">\r
-<refnamediv>\r
-<refname>dbfo_orientation</refname>\r
-<refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS\r
- <tag>table</tag> row or cell to specify the orientation\r
- (rotation) for the row or cell.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>\r
- <listitem>\r
- \r
-<para>Specifies the number of degrees by which the cell or\r
- row is rotated</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_pgwide">\r
-<refnamediv>\r
-<refname>dbfo_pgwide</refname>\r
-<refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an\r
- <tag>equation</tag> or <tag>example</tag> to specify that the\r
- content should rendered across the full width of the page.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>pgwide="0"</term>\r
- <listitem>\r
- \r
-<para>If zero, the content is rendered across the current\r
- text flow</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>pgwide="1"</term>\r
- <listitem>\r
- \r
-<para>If <code>1</code> (or any non-zero value), the\r
- content is rendered across the full width of the page</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>pgwide.properties</parameter></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_rotated-width">\r
-<refnamediv>\r
-<refname>dbfo_rotated-width</refname>\r
-<refpurpose>Specifies the width for a CALS table <tag>entry</tag> or\r
- <tag>row</tag></refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of \r
- <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the\r
- width of that the <tag>entry</tag> or <tag>row</tag>; or\r
- use it higher up in table to cause the width to be inherited\r
- recursively down.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the width of a row or cell (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_sidebar-width">\r
-<refnamediv>\r
-<refname>dbfo_sidebar-width</refname>\r
-<refpurpose>Specifies the width of a sidebar</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a\r
- <tag>sidebar</tag> to specify the width of the sidebar.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the <tag>sidebar</tag> width (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
- \r
-<para><parameter>sidebar.float.type parameter</parameter>,\r
- <parameter>sidebar.float.width parameter</parameter>, \r
- <parameter>sidebar.properties attribute-set</parameter>,\r
- <parameter>sidebar.title.properties</parameter>\r
- </para>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as\r
- side float</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_start">\r
-<refnamediv>\r
-<refname>dbfo_start</refname>\r
-<refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para><emphasis>This PI is obsolete</emphasis>. The intent of\r
- it was to provide a means for setting a specific starting\r
- number for an ordered list. Instead of this PI, set a value\r
- for the <literal>override</literal> attribute on the first\r
- <tag>listitem</tag> in the list; that will have the same\r
- effect as what this PI was intended for.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>start="<replaceable>character</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the character to use as the starting\r
- number; use 0-9, a-z, A-Z, or lowercase or uppercase\r
- Roman numerals</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_table-width">\r
-<refnamediv>\r
-<refname>dbfo_table-width</refname>\r
-<refpurpose>Specifies the width for a CALS table or for revhistory\r
- output</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or\r
- sibling of a CALS <tag>table</tag>, or as a child of an\r
- <tag>informaltable</tag>, <tag>entrytbl</tag>, or\r
- <tag>revhistory</tag> instance (which is rendered as a table\r
- in output) to specify the width of the table in output.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the table width (including units or as a percentage)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_term-width">\r
-<refnamediv>\r
-<refname>dbfo_term-width</refname>\r
-<refpurpose>Specifies the term width for a variablelist</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a\r
- <tag>variablelist</tag> to specify the width for\r
- <tag>term</tag> output.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the term width (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_toc">\r
-<refnamediv>\r
-<refname>dbfo_toc</refname>\r
-<refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a\r
- <tag>qandaset</tag> to specify whether a table of contents\r
- (TOC) is generated for the <tag>qandaset</tag>.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>toc="0"</term>\r
- <listitem>\r
- \r
-<para>If zero, no TOC is generated</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>toc="1"</term>\r
- <listitem>\r
- \r
-<para>If <code>1</code> (or any non-zero value),\r
- a TOC is generated</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,\r
- <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo-need">\r
-<refnamediv>\r
-<refname>dbfo-need</refname>\r
-<refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>A “need” is a request for space on a page. If the\r
- requested space is not available, the page breaks and the\r
- content that follows the need request appears on the next\r
- page. If the requested space is available, then no page break\r
- is inserted.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>height="<replaceable>n</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>The amount of height needed (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>The amount of extra vertical space to add (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>\r
-\r
- </refsect1></refentry>\r
-\r
-<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_row-height">\r
-<refnamediv>\r
-<refname>dbfo_row-height</refname>\r
-<refpurpose>Specifies the height for a CALS table row</refpurpose>\r
-</refnamediv>\r
-<refsynopsisdiv>\r
-\r
- <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>\r
- \r
-</refsynopsisdiv>\r
-<refsect1><title>Description</title>\r
- \r
-<para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a\r
- <tag>row</tag> to specify the height of the row.</para>\r
-\r
- </refsect1><refsect1><title>Parameters</title>\r
- \r
-<variablelist>\r
- <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>\r
- <listitem>\r
- \r
-<para>Specifies the row height (including units)</para>\r
-\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
-\r
- </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
- \r
-<para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>\r
-\r
- </refsect1></refentry>\r
-</reference>\r
-\r
projects / Evergreen-DocBook.git / blobdiff