1 <?xml version="1.0"?>
\r
3 <reference><info><title>FO Processing Instruction Reference</title>
\r
4 <releaseinfo role="meta">
\r
5 $Id: pi.xsl 8487 2009-07-14 21:43:36Z bobstayton $
\r
9 <partintro xml:id="partintro">
\r
10 <title>Introduction</title>
\r
13 <para>This is generated reference documentation for all
\r
14 user-specifiable processing instructions (PIs) in the DocBook
\r
15 XSL stylesheets for FO output.
\r
18 <para>You add these PIs at particular points in a document to
\r
19 cause specific “exceptions” to formatting/output behavior. To
\r
20 make global changes in formatting/output behavior across an
\r
21 entire document, it’s better to do it by setting an
\r
22 appropriate stylesheet parameter (if there is one).</para>
\r
29 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_background-color">
\r
31 <refname>dbfo_background-color</refname>
\r
32 <refpurpose>Sets background color for an image</refpurpose>
\r
36 <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
\r
39 <refsect1><title>Description</title>
\r
41 <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
\r
42 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
\r
43 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
\r
44 sibling to the element, to set a background color for the
\r
47 </refsect1><refsect1><title>Parameters</title>
\r
50 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
\r
53 <para>An HTML color value</para>
\r
59 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
61 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
\r
63 </refsect1></refentry>
\r
65 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_bgcolor">
\r
67 <refname>dbfo_bgcolor</refname>
\r
68 <refpurpose>Sets background color on a table row or table cell</refpurpose>
\r
72 <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
\r
75 <refsect1><title>Description</title>
\r
77 <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
\r
78 or cell to set a background color for that table row or cell.</para>
\r
81 <para>This PI works for both CALS and HTML tables.</para>
\r
83 </refsect1><refsect1><title>Parameters</title>
\r
86 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
\r
89 <para>An HTML color value</para>
\r
95 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
97 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
\r
99 </refsect1></refentry>
\r
101 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_float-type">
\r
103 <refname>dbfo_float-type</refname>
\r
104 <refpurpose>Specifies float behavior for a sidebar</refpurpose>
\r
108 <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
\r
111 <refsect1><title>Description</title>
\r
113 <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
\r
114 behavior for a <tag>sidebar</tag> (to cause the sidebar to be
\r
115 displayed as a marginal note).</para>
\r
117 </refsect1><refsect1><title>Parameters</title>
\r
120 <varlistentry><term>float-type="margin.note"</term>
\r
123 <para>Specifies that the <tag>sidebar</tag> should be
\r
124 displayed as a marginal note.</para>
\r
130 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
132 <para><parameter>sidebar.float.type</parameter> (parameter),
\r
133 <parameter>sidebar.float.width</parameter> (parameter),
\r
134 <parameter>sidebar.properties</parameter> (attribute-set),
\r
135 <parameter>sidebar.title.properties</parameter> (attribute-set)
\r
138 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
140 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
\r
141 side float</link></para>
\r
143 </refsect1></refentry>
\r
145 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_funcsynopsis-style">
\r
147 <refname>dbfo_funcsynopsis-style</refname>
\r
148 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
\r
152 <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
\r
155 <refsect1><title>Description</title>
\r
157 <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
\r
158 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
\r
159 to control the presentation style for output of all
\r
160 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
\r
162 </refsect1><refsect1><title>Parameters</title>
\r
165 <varlistentry><term>funcsynopsis-style="kr"</term>
\r
168 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
\r
172 <varlistentry><term>funcsynopsis-style="ansi"</term>
\r
175 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
\r
181 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
183 <para><parameter>funcsynopsis.style</parameter></para>
\r
185 </refsect1></refentry>
\r
187 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossary-presentation">
\r
189 <refname>dbfo_glossary-presentation</refname>
\r
190 <refpurpose>Specifies presentation style for a glossary</refpurpose>
\r
194 <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
\r
197 <refsect1><title>Description</title>
\r
199 <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
\r
200 a <tag>glossary</tag> to control its presentation style.</para>
\r
202 </refsect1><refsect1><title>Parameters</title>
\r
205 <varlistentry><term>glossary-presentation="list"</term>
\r
208 <para>Displays the glossary as a list</para>
\r
212 <varlistentry><term>glossary-presentation="blocks"</term>
\r
215 <para>Displays the glossary as blocks</para>
\r
221 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
223 <para><parameter>glossary.as.blocks</parameter></para>
\r
225 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
227 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
\r
228 formatting in print</link></para>
\r
230 </refsect1></refentry>
\r
232 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glosslist-presentation">
\r
234 <refname>dbfo_glosslist-presentation</refname>
\r
235 <refpurpose>Specifies presentation style for a glosslist</refpurpose>
\r
239 <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
\r
242 <refsect1><title>Description</title>
\r
244 <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
\r
245 a <tag>glosslist</tag> to control its presentation style.</para>
\r
247 </refsect1><refsect1><title>Parameters</title>
\r
250 <varlistentry><term>glosslist-presentation="list"</term>
\r
253 <para>Displays the glosslist as a list</para>
\r
257 <varlistentry><term>glosslist-presentation="blocks"</term>
\r
260 <para>Displays the glosslist as blocks</para>
\r
266 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
268 <para><parameter>glosslist.as.blocks</parameter> </para>
\r
270 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
272 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
\r
273 formatting in print</link></para>
\r
275 </refsect1></refentry>
\r
277 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossterm-width">
\r
279 <refname>dbfo_glossterm-width</refname>
\r
280 <refpurpose>Specifies the glossterm width for a glossary or
\r
281 glosslist</refpurpose>
\r
285 <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
288 <refsect1><title>Description</title>
\r
290 <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
\r
291 <tag>glossary</tag> or <tag>glosslist</tag> to specify the
\r
292 width for output of <tag>glossterm</tag> instances in the
\r
295 </refsect1><refsect1><title>Parameters</title>
\r
298 <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
\r
301 <para>Specifies the glossterm width (including units)</para>
\r
307 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
309 <para><parameter>glossterm.width</parameter>,
\r
310 <parameter>glossterm.separation</parameter>
\r
313 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
315 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
\r
316 formatting in print</link></para>
\r
318 </refsect1></refentry>
\r
320 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_keep-together">
\r
322 <refname>dbfo_keep-together</refname>
\r
323 <refpurpose>Specifies “keep” behavior for a table, example,
\r
324 figure, equation, procedure, or task</refpurpose>
\r
328 <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
\r
331 <refsect1><title>Description</title>
\r
333 <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
\r
334 formal object (<tag>table</tag>, <tag>example</tag>,
\r
335 <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
\r
336 <tag>task</tag>) to specify “keep” behavior (to allow the object to
\r
337 “break” across a page).</para>
\r
340 <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
\r
341 <tag>informalfigure</tag> and <tag>informalequation</tag>.
\r
345 </refsect1><refsect1><title>Parameters</title>
\r
348 <varlistentry><term>keep-together="auto"</term>
\r
351 <para>Enables the object to break across a page</para>
\r
355 <varlistentry><term>keep-together="always"</term>
\r
358 <para>Prevents the object from breaking across a page (the
\r
359 default stylesheet behavior)</para>
\r
365 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
367 <para>formal.object.properties</para>
\r
369 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
371 <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
\r
373 </refsect1></refentry>
\r
375 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_label-width">
\r
377 <refname>dbfo_label-width</refname>
\r
378 <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
\r
379 or calloutlist</refpurpose>
\r
383 <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
386 <refsect1><title>Description</title>
\r
388 <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
\r
389 <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
\r
390 or <tag>calloutlist</tag> to specify the width of labels.</para>
\r
392 </refsect1><refsect1><title>Parameters</title>
\r
395 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
\r
398 <para>Specifies the label width (including units)</para>
\r
404 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
406 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
\r
408 </refsect1></refentry>
\r
410 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.everyNth">
\r
412 <refname>dbfo_linenumbering.everyNth</refname>
\r
413 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
\r
417 <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
\r
420 <refsect1><title>Description</title>
\r
422 <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
\r
423 of a “verbatim” element – <tag>programlisting</tag>,
\r
424 <tag>screen</tag>, <tag>synopsis</tag> — to specify
\r
425 the interval at which lines are numbered.</para>
\r
427 </refsect1><refsect1><title>Parameters</title>
\r
430 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
\r
433 <para>Specifies numbering interval; a number is output
\r
434 before every <replaceable>N</replaceable>th line</para>
\r
440 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
442 <para><parameter>linenumbering.everyNth</parameter></para>
\r
444 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
446 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
\r
448 </refsect1></refentry>
\r
450 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.separator">
\r
452 <refname>dbfo_linenumbering.separator</refname>
\r
453 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
\r
457 <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
\r
460 <refsect1><title>Description</title>
\r
462 <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
\r
463 of a “verbatim” element – <tag>programlisting</tag>,
\r
464 <tag>screen</tag>, <tag>synopsis</tag> — to specify
\r
465 the separator text output between the line numbers and content.</para>
\r
467 </refsect1><refsect1><title>Parameters</title>
\r
470 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
\r
473 <para>Specifies the text (zero or more characters)</para>
\r
479 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
481 <para><parameter>linenumbering.separator</parameter></para>
\r
483 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
485 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
\r
487 </refsect1></refentry>
\r
489 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.width">
\r
491 <refname>dbfo_linenumbering.width</refname>
\r
492 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
\r
496 <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
\r
499 <refsect1><title>Description</title>
\r
501 <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
\r
502 of a “verbatim” element – <tag>programlisting</tag>,
\r
503 <tag>screen</tag>, <tag>synopsis</tag> — to specify
\r
504 the width set aside for line numbers.</para>
\r
506 </refsect1><refsect1><title>Parameters</title>
\r
509 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
\r
512 <para>Specifies the width (inluding units)</para>
\r
518 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
520 <para><parameter>linenumbering.width</parameter></para>
\r
522 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
524 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
\r
526 </refsect1></refentry>
\r
528 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-presentation">
\r
530 <refname>dbfo_list-presentation</refname>
\r
531 <refpurpose>Specifies presentation style for a variablelist or
\r
532 segmentedlist</refpurpose>
\r
536 <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
\r
539 <refsect1><title>Description</title>
\r
541 <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
\r
542 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
\r
543 control the presentation style for the list (to cause it, for
\r
544 example, to be displayed as a table).</para>
\r
546 </refsect1><refsect1><title>Parameters</title>
\r
549 <varlistentry><term>list-presentation="list"</term>
\r
552 <para>Displays the list as a list</para>
\r
556 <varlistentry><term>list-presentation="blocks"</term>
\r
559 <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
\r
563 <varlistentry><term>list-presentation="table"</term>
\r
566 <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
\r
572 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
577 <para><parameter>variablelist.as.blocks</parameter></para>
\r
582 <para><parameter>variablelist.as.table</parameter></para>
\r
587 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
589 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
\r
591 </refsect1></refentry>
\r
593 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-width">
\r
595 <refname>dbfo_list-width</refname>
\r
596 <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
\r
600 <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
603 <refsect1><title>Description</title>
\r
605 <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
\r
606 <tag>simplelist</tag> whose <tag class="attribute">class</tag>
\r
607 value is <literal>horizontal</literal>, to specify the width
\r
608 of the <tag>simplelist</tag>.</para>
\r
610 </refsect1><refsect1><title>Parameters</title>
\r
613 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
\r
616 <para>Specifies the <tag>simplelist</tag> width (including units)</para>
\r
622 </refsect1></refentry>
\r
624 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_orientation">
\r
626 <refname>dbfo_orientation</refname>
\r
627 <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
\r
631 <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
\r
634 <refsect1><title>Description</title>
\r
636 <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
\r
637 <tag>table</tag> row or cell to specify the orientation
\r
638 (rotation) for the row or cell.</para>
\r
640 </refsect1><refsect1><title>Parameters</title>
\r
643 <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
\r
646 <para>Specifies the number of degrees by which the cell or
\r
647 row is rotated</para>
\r
653 </refsect1></refentry>
\r
655 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_pgwide">
\r
657 <refname>dbfo_pgwide</refname>
\r
658 <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
\r
662 <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
\r
665 <refsect1><title>Description</title>
\r
667 <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
\r
668 <tag>equation</tag> or <tag>example</tag> to specify that the
\r
669 content should rendered across the full width of the page.</para>
\r
671 </refsect1><refsect1><title>Parameters</title>
\r
674 <varlistentry><term>pgwide="0"</term>
\r
677 <para>If zero, the content is rendered across the current
\r
682 <varlistentry><term>pgwide="1"</term>
\r
685 <para>If <code>1</code> (or any non-zero value), the
\r
686 content is rendered across the full width of the page</para>
\r
692 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
694 <para><parameter>pgwide.properties</parameter></para>
\r
696 </refsect1></refentry>
\r
698 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_rotated-width">
\r
700 <refname>dbfo_rotated-width</refname>
\r
701 <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
\r
702 <tag>row</tag></refpurpose>
\r
706 <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
709 <refsect1><title>Description</title>
\r
711 <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
\r
712 <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
\r
713 width of that the <tag>entry</tag> or <tag>row</tag>; or
\r
714 use it higher up in table to cause the width to be inherited
\r
715 recursively down.</para>
\r
717 </refsect1><refsect1><title>Parameters</title>
\r
720 <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
\r
723 <para>Specifies the width of a row or cell (including units)</para>
\r
729 </refsect1></refentry>
\r
731 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_sidebar-width">
\r
733 <refname>dbfo_sidebar-width</refname>
\r
734 <refpurpose>Specifies the width of a sidebar</refpurpose>
\r
738 <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
741 <refsect1><title>Description</title>
\r
743 <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
\r
744 <tag>sidebar</tag> to specify the width of the sidebar.</para>
\r
746 </refsect1><refsect1><title>Parameters</title>
\r
749 <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
\r
752 <para>Specifies the <tag>sidebar</tag> width (including units)</para>
\r
758 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
\r
760 <para><parameter>sidebar.float.type parameter</parameter>,
\r
761 <parameter>sidebar.float.width parameter</parameter>,
\r
762 <parameter>sidebar.properties attribute-set</parameter>,
\r
763 <parameter>sidebar.title.properties</parameter>
\r
766 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
768 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
\r
769 side float</link></para>
\r
771 </refsect1></refentry>
\r
773 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_start">
\r
775 <refname>dbfo_start</refname>
\r
776 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
\r
780 <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
\r
783 <refsect1><title>Description</title>
\r
785 <para><emphasis>This PI is obsolete</emphasis>. The intent of
\r
786 it was to provide a means for setting a specific starting
\r
787 number for an ordered list. Instead of this PI, set a value
\r
788 for the <literal>override</literal> attribute on the first
\r
789 <tag>listitem</tag> in the list; that will have the same
\r
790 effect as what this PI was intended for.</para>
\r
792 </refsect1><refsect1><title>Parameters</title>
\r
795 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
\r
798 <para>Specifies the character to use as the starting
\r
799 number; use 0-9, a-z, A-Z, or lowercase or uppercase
\r
800 Roman numerals</para>
\r
806 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
808 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
\r
810 </refsect1></refentry>
\r
812 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_table-width">
\r
814 <refname>dbfo_table-width</refname>
\r
815 <refpurpose>Specifies the width for a CALS table or for revhistory
\r
816 output</refpurpose>
\r
820 <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
823 <refsect1><title>Description</title>
\r
825 <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
\r
826 sibling of a CALS <tag>table</tag>, or as a child of an
\r
827 <tag>informaltable</tag>, <tag>entrytbl</tag>, or
\r
828 <tag>revhistory</tag> instance (which is rendered as a table
\r
829 in output) to specify the width of the table in output.</para>
\r
831 </refsect1><refsect1><title>Parameters</title>
\r
834 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
\r
837 <para>Specifies the table width (including units or as a percentage)</para>
\r
843 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
845 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
\r
847 </refsect1></refentry>
\r
849 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_term-width">
\r
851 <refname>dbfo_term-width</refname>
\r
852 <refpurpose>Specifies the term width for a variablelist</refpurpose>
\r
856 <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
\r
859 <refsect1><title>Description</title>
\r
861 <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
\r
862 <tag>variablelist</tag> to specify the width for
\r
863 <tag>term</tag> output.</para>
\r
865 </refsect1><refsect1><title>Parameters</title>
\r
868 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
\r
871 <para>Specifies the term width (including units)</para>
\r
877 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
879 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
\r
881 </refsect1></refentry>
\r
883 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_toc">
\r
885 <refname>dbfo_toc</refname>
\r
886 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
\r
890 <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
\r
893 <refsect1><title>Description</title>
\r
895 <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
\r
896 <tag>qandaset</tag> to specify whether a table of contents
\r
897 (TOC) is generated for the <tag>qandaset</tag>.</para>
\r
899 </refsect1><refsect1><title>Parameters</title>
\r
902 <varlistentry><term>toc="0"</term>
\r
905 <para>If zero, no TOC is generated</para>
\r
909 <varlistentry><term>toc="1"</term>
\r
912 <para>If <code>1</code> (or any non-zero value),
\r
913 a TOC is generated</para>
\r
919 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
921 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
\r
922 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
\r
924 </refsect1></refentry>
\r
926 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo-need">
\r
928 <refname>dbfo-need</refname>
\r
929 <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
\r
933 <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
\r
936 <refsect1><title>Description</title>
\r
938 <para>A “need” is a request for space on a page. If the
\r
939 requested space is not available, the page breaks and the
\r
940 content that follows the need request appears on the next
\r
941 page. If the requested space is available, then no page break
\r
942 is inserted.</para>
\r
944 </refsect1><refsect1><title>Parameters</title>
\r
947 <varlistentry><term>height="<replaceable>n</replaceable>"</term>
\r
950 <para>The amount of height needed (including units)</para>
\r
954 <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
\r
957 <para>The amount of extra vertical space to add (including units)</para>
\r
963 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
965 <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
\r
967 </refsect1></refentry>
\r
969 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_row-height">
\r
971 <refname>dbfo_row-height</refname>
\r
972 <refpurpose>Specifies the height for a CALS table row</refpurpose>
\r
976 <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
\r
979 <refsect1><title>Description</title>
\r
981 <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
\r
982 <tag>row</tag> to specify the height of the row.</para>
\r
984 </refsect1><refsect1><title>Parameters</title>
\r
987 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
\r
990 <para>Specifies the row height (including units)</para>
\r
996 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
\r
998 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
\r
1000 </refsect1></refentry>
\r