doc/xslt/fo/pi.xml

   1 <?xml version="1.0"?>
   2
   3 <reference><info><title>FO Processing Instruction Reference</title>
   4     <releaseinfo role="meta">
   5       $Id: pi.xsl 8487 2009-07-14 21:43:36Z bobstayton $
   6     </releaseinfo>
   7   </info>
   8
   9   <partintro xml:id="partintro">
  10     <title>Introduction</title>
  11
  12
  13 <para>This is generated reference documentation for all
  14       user-specifiable processing instructions (PIs) in the DocBook
  15       XSL stylesheets for FO output.
  16       <note>
  17
  18 <para>You add these PIs at particular points in a document to
  19           cause specific “exceptions” to formatting/output behavior. To
  20           make global changes in formatting/output behavior across an
  21           entire document, it’s better to do it by setting an
  22           appropriate stylesheet parameter (if there is one).</para>
  23
  24       </note>
  25     </para>
  26
  27   </partintro>
  28
  29 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_background-color">
  30 <refnamediv>
  31 <refname>dbfo_background-color</refname>
  32 <refpurpose>Sets background color for an image</refpurpose>
  33 </refnamediv>
  34 <refsynopsisdiv>
  35
  36     <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
  37
  38 </refsynopsisdiv>
  39 <refsect1><title>Description</title>
  40
  41 <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
  42       after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
  43       <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
  44       sibling to the element, to set a background color for the
  45       image.</para>
  46
  47   </refsect1><refsect1><title>Parameters</title>
  48
  49 <variablelist>
  50       <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
  51         <listitem>
  52
  53 <para>An HTML color value</para>
  54
  55         </listitem>
  56       </varlistentry>
  57     </variablelist>
  58
  59   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  60
  61 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
  62
  63   </refsect1></refentry>
  64
  65 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_bgcolor">
  66 <refnamediv>
  67 <refname>dbfo_bgcolor</refname>
  68 <refpurpose>Sets background color on a table row or table cell</refpurpose>
  69 </refnamediv>
  70 <refsynopsisdiv>
  71
  72     <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
  73
  74 </refsynopsisdiv>
  75 <refsect1><title>Description</title>
  76
  77 <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
  78       or cell to set a background color for that table row or cell.</para>
  79
  80
  81 <para>This PI works for both CALS and HTML tables.</para>
  82
  83   </refsect1><refsect1><title>Parameters</title>
  84
  85 <variablelist>
  86       <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
  87         <listitem>
  88
  89 <para>An HTML color value</para>
  90
  91         </listitem>
  92       </varlistentry>
  93     </variablelist>
  94
  95   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  96
  97 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
  98
  99   </refsect1></refentry>
 100
 101 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_float-type">
 102 <refnamediv>
 103 <refname>dbfo_float-type</refname>
 104 <refpurpose>Specifies float behavior for a sidebar</refpurpose>
 105 </refnamediv>
 106 <refsynopsisdiv>
 107
 108     <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
 109
 110 </refsynopsisdiv>
 111 <refsect1><title>Description</title>
 112
 113 <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
 114       behavior for a <tag>sidebar</tag> (to cause the sidebar to be
 115       displayed as a marginal note).</para>
 116
 117   </refsect1><refsect1><title>Parameters</title>
 118
 119 <variablelist>
 120       <varlistentry><term>float-type="margin.note"</term>
 121         <listitem>
 122
 123 <para>Specifies that the <tag>sidebar</tag> should be
 124             displayed as a marginal note.</para>
 125
 126         </listitem>
 127       </varlistentry>
 128     </variablelist>
 129
 130   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 131
 132 <para><parameter>sidebar.float.type</parameter> (parameter),
 133       <parameter>sidebar.float.width</parameter> (parameter),
 134       <parameter>sidebar.properties</parameter> (attribute-set),
 135       <parameter>sidebar.title.properties</parameter> (attribute-set)
 136     </para>
 137
 138   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 139
 140 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
 141         side float</link></para>
 142
 143   </refsect1></refentry>
 144
 145 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_funcsynopsis-style">
 146 <refnamediv>
 147 <refname>dbfo_funcsynopsis-style</refname>
 148 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
 149 </refnamediv>
 150 <refsynopsisdiv>
 151
 152     <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
 153
 154 </refsynopsisdiv>
 155 <refsect1><title>Description</title>
 156
 157 <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
 158       a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
 159       to control the presentation style for output of all
 160       <tag>funcprototype</tag> instances within that funcsynopsis.</para>
 161
 162   </refsect1><refsect1><title>Parameters</title>
 163
 164 <variablelist>
 165       <varlistentry><term>funcsynopsis-style="kr"</term>
 166         <listitem>
 167
 168 <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>
 169
 170         </listitem>
 171       </varlistentry>
 172       <varlistentry><term>funcsynopsis-style="ansi"</term>
 173         <listitem>
 174
 175 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
 176
 177         </listitem>
 178       </varlistentry>
 179     </variablelist>
 180
 181   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 182
 183 <para><parameter>funcsynopsis.style</parameter></para>
 184
 185   </refsect1></refentry>
 186
 187 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossary-presentation">
 188 <refnamediv>
 189 <refname>dbfo_glossary-presentation</refname>
 190 <refpurpose>Specifies presentation style for a glossary</refpurpose>
 191 </refnamediv>
 192 <refsynopsisdiv>
 193
 194     <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
 195
 196 </refsynopsisdiv>
 197 <refsect1><title>Description</title>
 198
 199 <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
 200       a <tag>glossary</tag> to control its presentation style.</para>
 201
 202   </refsect1><refsect1><title>Parameters</title>
 203
 204 <variablelist>
 205       <varlistentry><term>glossary-presentation="list"</term>
 206         <listitem>
 207
 208 <para>Displays the glossary as a list</para>
 209
 210         </listitem>
 211       </varlistentry>
 212       <varlistentry><term>glossary-presentation="blocks"</term>
 213         <listitem>
 214
 215 <para>Displays the glossary as blocks</para>
 216
 217         </listitem>
 218       </varlistentry>
 219     </variablelist>
 220
 221   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 222
 223 <para><parameter>glossary.as.blocks</parameter></para>
 224
 225   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 226
 227 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
 228         formatting in print</link></para>
 229
 230   </refsect1></refentry>
 231
 232 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glosslist-presentation">
 233 <refnamediv>
 234 <refname>dbfo_glosslist-presentation</refname>
 235 <refpurpose>Specifies presentation style for a glosslist</refpurpose>
 236 </refnamediv>
 237 <refsynopsisdiv>
 238
 239     <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
 240
 241 </refsynopsisdiv>
 242 <refsect1><title>Description</title>
 243
 244 <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
 245       a <tag>glosslist</tag> to control its presentation style.</para>
 246
 247   </refsect1><refsect1><title>Parameters</title>
 248
 249 <variablelist>
 250       <varlistentry><term>glosslist-presentation="list"</term>
 251         <listitem>
 252
 253 <para>Displays the glosslist as a list</para>
 254
 255         </listitem>
 256       </varlistentry>
 257       <varlistentry><term>glosslist-presentation="blocks"</term>
 258         <listitem>
 259
 260 <para>Displays the glosslist as blocks</para>
 261
 262         </listitem>
 263       </varlistentry>
 264     </variablelist>
 265
 266   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 267
 268 <para><parameter>glosslist.as.blocks</parameter> </para>
 269
 270   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 271
 272 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
 273         formatting in print</link></para>
 274
 275   </refsect1></refentry>
 276
 277 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossterm-width">
 278 <refnamediv>
 279 <refname>dbfo_glossterm-width</refname>
 280 <refpurpose>Specifies the glossterm width for a glossary or
 281     glosslist</refpurpose>
 282 </refnamediv>
 283 <refsynopsisdiv>
 284
 285     <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
 286
 287 </refsynopsisdiv>
 288 <refsect1><title>Description</title>
 289
 290 <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
 291       <tag>glossary</tag> or <tag>glosslist</tag> to specify the
 292       width for output of <tag>glossterm</tag> instances in the
 293       output.</para>
 294
 295   </refsect1><refsect1><title>Parameters</title>
 296
 297 <variablelist>
 298       <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
 299         <listitem>
 300
 301 <para>Specifies the glossterm width (including units)</para>
 302
 303         </listitem>
 304       </varlistentry>
 305     </variablelist>
 306
 307   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 308
 309 <para><parameter>glossterm.width</parameter>,
 310       <parameter>glossterm.separation</parameter>
 311     </para>
 312
 313   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 314
 315 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
 316         formatting in print</link></para>
 317
 318   </refsect1></refentry>
 319
 320 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_keep-together">
 321 <refnamediv>
 322 <refname>dbfo_keep-together</refname>
 323 <refpurpose>Specifies “keep” behavior for a table, example,
 324     figure, equation, procedure, or task</refpurpose>
 325 </refnamediv>
 326 <refsynopsisdiv>
 327
 328     <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
 329
 330 </refsynopsisdiv>
 331 <refsect1><title>Description</title>
 332
 333 <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
 334       formal object (<tag>table</tag>, <tag>example</tag>,
 335       <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
 336       <tag>task</tag>) to specify “keep” behavior (to allow the object to
 337     “break” across a page).</para>
 338
 339
 340 <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
 341       <tag>informalfigure</tag> and <tag>informalequation</tag>.
 342     </para>
 343
 344
 345   </refsect1><refsect1><title>Parameters</title>
 346
 347 <variablelist>
 348       <varlistentry><term>keep-together="auto"</term>
 349         <listitem>
 350
 351 <para>Enables the object to break across a page</para>
 352
 353         </listitem>
 354       </varlistentry>
 355       <varlistentry><term>keep-together="always"</term>
 356         <listitem>
 357
 358 <para>Prevents the object from breaking across a page (the
 359             default stylesheet behavior)</para>
 360
 361         </listitem>
 362       </varlistentry>
 363     </variablelist>
 364
 365   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 366
 367 <para>formal.object.properties</para>
 368
 369   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 370
 371 <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
 372
 373   </refsect1></refentry>
 374
 375 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_label-width">
 376 <refnamediv>
 377 <refname>dbfo_label-width</refname>
 378 <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
 379   or calloutlist</refpurpose>
 380 </refnamediv>
 381 <refsynopsisdiv>
 382
 383     <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
 384
 385 </refsynopsisdiv>
 386 <refsect1><title>Description</title>
 387
 388 <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
 389       <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
 390       or <tag>calloutlist</tag> to specify the width of labels.</para>
 391
 392   </refsect1><refsect1><title>Parameters</title>
 393
 394 <variablelist>
 395       <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
 396         <listitem>
 397
 398 <para>Specifies the label width (including units)</para>
 399
 400         </listitem>
 401       </varlistentry>
 402     </variablelist>
 403
 404   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 405
 406 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
 407
 408   </refsect1></refentry>
 409
 410 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.everyNth">
 411 <refnamediv>
 412 <refname>dbfo_linenumbering.everyNth</refname>
 413 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
 414 </refnamediv>
 415 <refsynopsisdiv>
 416
 417     <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
 418
 419 </refsynopsisdiv>
 420 <refsect1><title>Description</title>
 421
 422 <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
 423       of a “verbatim” element – <tag>programlisting</tag>,
 424       <tag>screen</tag>, <tag>synopsis</tag> — to specify
 425       the interval at which lines are numbered.</para>
 426
 427   </refsect1><refsect1><title>Parameters</title>
 428
 429 <variablelist>
 430       <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
 431         <listitem>
 432
 433 <para>Specifies numbering interval; a number is output
 434             before every <replaceable>N</replaceable>th line</para>
 435
 436         </listitem>
 437       </varlistentry>
 438     </variablelist>
 439
 440   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 441
 442 <para><parameter>linenumbering.everyNth</parameter></para>
 443
 444   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 445
 446 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
 447
 448   </refsect1></refentry>
 449
 450 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.separator">
 451 <refnamediv>
 452 <refname>dbfo_linenumbering.separator</refname>
 453 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
 454 </refnamediv>
 455 <refsynopsisdiv>
 456
 457     <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
 458
 459 </refsynopsisdiv>
 460 <refsect1><title>Description</title>
 461
 462 <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
 463       of a “verbatim” element – <tag>programlisting</tag>,
 464       <tag>screen</tag>, <tag>synopsis</tag> — to specify
 465       the separator text output between the line numbers and content.</para>
 466
 467   </refsect1><refsect1><title>Parameters</title>
 468
 469 <variablelist>
 470       <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
 471         <listitem>
 472
 473 <para>Specifies the text (zero or more characters)</para>
 474
 475         </listitem>
 476       </varlistentry>
 477     </variablelist>
 478
 479   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 480
 481 <para><parameter>linenumbering.separator</parameter></para>
 482
 483   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 484
 485 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
 486
 487   </refsect1></refentry>
 488
 489 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.width">
 490 <refnamediv>
 491 <refname>dbfo_linenumbering.width</refname>
 492 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
 493 </refnamediv>
 494 <refsynopsisdiv>
 495
 496     <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
 497
 498 </refsynopsisdiv>
 499 <refsect1><title>Description</title>
 500
 501 <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
 502       of a “verbatim” element – <tag>programlisting</tag>,
 503       <tag>screen</tag>, <tag>synopsis</tag> — to specify
 504       the width set aside for line numbers.</para>
 505
 506   </refsect1><refsect1><title>Parameters</title>
 507
 508 <variablelist>
 509       <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
 510         <listitem>
 511
 512 <para>Specifies the width (inluding units)</para>
 513
 514         </listitem>
 515       </varlistentry>
 516     </variablelist>
 517
 518   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 519
 520 <para><parameter>linenumbering.width</parameter></para>
 521
 522   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 523
 524 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
 525
 526   </refsect1></refentry>
 527
 528 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-presentation">
 529 <refnamediv>
 530 <refname>dbfo_list-presentation</refname>
 531 <refpurpose>Specifies presentation style for a variablelist or
 532     segmentedlist</refpurpose>
 533 </refnamediv>
 534 <refsynopsisdiv>
 535
 536     <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
 537
 538 </refsynopsisdiv>
 539 <refsect1><title>Description</title>
 540
 541 <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
 542       a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
 543       control the presentation style for the list (to cause it, for
 544       example, to be displayed as a table).</para>
 545
 546   </refsect1><refsect1><title>Parameters</title>
 547
 548 <variablelist>
 549       <varlistentry><term>list-presentation="list"</term>
 550         <listitem>
 551
 552 <para>Displays the list as a list</para>
 553
 554         </listitem>
 555       </varlistentry>
 556       <varlistentry><term>list-presentation="blocks"</term>
 557         <listitem>
 558
 559 <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
 560
 561         </listitem>
 562       </varlistentry>
 563       <varlistentry><term>list-presentation="table"</term>
 564         <listitem>
 565
 566 <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
 567
 568         </listitem>
 569       </varlistentry>
 570     </variablelist>
 571
 572   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 573
 574 <itemizedlist>
 575       <listitem>
 576
 577 <para><parameter>variablelist.as.blocks</parameter></para>
 578
 579       </listitem>
 580       <listitem>
 581
 582 <para><parameter>variablelist.as.table</parameter></para>
 583
 584       </listitem>
 585     </itemizedlist>
 586
 587   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 588
 589 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
 590
 591   </refsect1></refentry>
 592
 593 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-width">
 594 <refnamediv>
 595 <refname>dbfo_list-width</refname>
 596 <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
 597 </refnamediv>
 598 <refsynopsisdiv>
 599
 600     <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
 601
 602 </refsynopsisdiv>
 603 <refsect1><title>Description</title>
 604
 605 <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
 606       <tag>simplelist</tag> whose <tag class="attribute">class</tag>
 607       value is <literal>horizontal</literal>, to specify the width
 608       of the <tag>simplelist</tag>.</para>
 609
 610   </refsect1><refsect1><title>Parameters</title>
 611
 612 <variablelist>
 613       <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
 614         <listitem>
 615
 616 <para>Specifies the <tag>simplelist</tag> width (including units)</para>
 617
 618         </listitem>
 619       </varlistentry>
 620     </variablelist>
 621
 622   </refsect1></refentry>
 623
 624 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_orientation">
 625 <refnamediv>
 626 <refname>dbfo_orientation</refname>
 627 <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
 628 </refnamediv>
 629 <refsynopsisdiv>
 630
 631     <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
 632
 633 </refsynopsisdiv>
 634 <refsect1><title>Description</title>
 635
 636 <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
 637       <tag>table</tag> row or cell to specify the orientation
 638       (rotation) for the row or cell.</para>
 639
 640   </refsect1><refsect1><title>Parameters</title>
 641
 642 <variablelist>
 643       <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
 644         <listitem>
 645
 646 <para>Specifies the number of degrees by which the cell or
 647             row is rotated</para>
 648
 649         </listitem>
 650       </varlistentry>
 651     </variablelist>
 652
 653   </refsect1></refentry>
 654
 655 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_pgwide">
 656 <refnamediv>
 657 <refname>dbfo_pgwide</refname>
 658 <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
 659 </refnamediv>
 660 <refsynopsisdiv>
 661
 662     <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
 663
 664 </refsynopsisdiv>
 665 <refsect1><title>Description</title>
 666
 667 <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
 668       <tag>equation</tag> or <tag>example</tag> to specify that the
 669       content should rendered across the full width of the page.</para>
 670
 671   </refsect1><refsect1><title>Parameters</title>
 672
 673 <variablelist>
 674       <varlistentry><term>pgwide="0"</term>
 675         <listitem>
 676
 677 <para>If zero, the content is rendered across the current
 678             text flow</para>
 679
 680         </listitem>
 681       </varlistentry>
 682       <varlistentry><term>pgwide="1"</term>
 683         <listitem>
 684
 685 <para>If <code>1</code> (or any non-zero value), the
 686             content is rendered across the full width of the page</para>
 687
 688         </listitem>
 689       </varlistentry>
 690     </variablelist>
 691
 692   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 693
 694 <para><parameter>pgwide.properties</parameter></para>
 695
 696   </refsect1></refentry>
 697
 698 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_rotated-width">
 699 <refnamediv>
 700 <refname>dbfo_rotated-width</refname>
 701 <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
 702     <tag>row</tag></refpurpose>
 703 </refnamediv>
 704 <refsynopsisdiv>
 705
 706     <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
 707
 708 </refsynopsisdiv>
 709 <refsect1><title>Description</title>
 710
 711 <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
 712       <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
 713       width of that the <tag>entry</tag> or <tag>row</tag>; or
 714       use it higher up in table to cause the width to be inherited
 715       recursively down.</para>
 716
 717   </refsect1><refsect1><title>Parameters</title>
 718
 719 <variablelist>
 720       <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
 721         <listitem>
 722
 723 <para>Specifies the width of a row or cell (including units)</para>
 724
 725         </listitem>
 726       </varlistentry>
 727     </variablelist>
 728
 729   </refsect1></refentry>
 730
 731 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_sidebar-width">
 732 <refnamediv>
 733 <refname>dbfo_sidebar-width</refname>
 734 <refpurpose>Specifies the width of a sidebar</refpurpose>
 735 </refnamediv>
 736 <refsynopsisdiv>
 737
 738     <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
 739
 740 </refsynopsisdiv>
 741 <refsect1><title>Description</title>
 742
 743 <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
 744       <tag>sidebar</tag> to specify the width of the sidebar.</para>
 745
 746   </refsect1><refsect1><title>Parameters</title>
 747
 748 <variablelist>
 749       <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
 750         <listitem>
 751
 752 <para>Specifies the <tag>sidebar</tag> width (including units)</para>
 753
 754         </listitem>
 755       </varlistentry>
 756     </variablelist>
 757
 758   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 759
 760 <para><parameter>sidebar.float.type parameter</parameter>,
 761       <parameter>sidebar.float.width parameter</parameter>,
 762       <parameter>sidebar.properties attribute-set</parameter>,
 763       <parameter>sidebar.title.properties</parameter>
 764     </para>
 765
 766   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 767
 768 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
 769         side float</link></para>
 770
 771   </refsect1></refentry>
 772
 773 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_start">
 774 <refnamediv>
 775 <refname>dbfo_start</refname>
 776 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
 777 </refnamediv>
 778 <refsynopsisdiv>
 779
 780     <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
 781
 782 </refsynopsisdiv>
 783 <refsect1><title>Description</title>
 784
 785 <para><emphasis>This PI is obsolete</emphasis>. The intent of
 786       it was to provide a means for setting a specific starting
 787       number for an ordered list. Instead of this PI, set a value
 788       for the <literal>override</literal> attribute on the first
 789       <tag>listitem</tag> in the list; that will have the same
 790       effect as what this PI was intended for.</para>
 791
 792   </refsect1><refsect1><title>Parameters</title>
 793
 794 <variablelist>
 795       <varlistentry><term>start="<replaceable>character</replaceable>"</term>
 796         <listitem>
 797
 798 <para>Specifies the character to use as the starting
 799             number; use 0-9, a-z, A-Z, or lowercase or uppercase
 800             Roman numerals</para>
 801
 802         </listitem>
 803       </varlistentry>
 804     </variablelist>
 805
 806   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 807
 808 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
 809
 810   </refsect1></refentry>
 811
 812 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_table-width">
 813 <refnamediv>
 814 <refname>dbfo_table-width</refname>
 815 <refpurpose>Specifies the width for a CALS table or for revhistory
 816     output</refpurpose>
 817 </refnamediv>
 818 <refsynopsisdiv>
 819
 820     <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
 821
 822 </refsynopsisdiv>
 823 <refsect1><title>Description</title>
 824
 825 <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
 826       sibling of a CALS <tag>table</tag>, or as a child of an
 827       <tag>informaltable</tag>, <tag>entrytbl</tag>, or
 828       <tag>revhistory</tag> instance (which is rendered as a table
 829       in output) to specify the width of the table in output.</para>
 830
 831   </refsect1><refsect1><title>Parameters</title>
 832
 833 <variablelist>
 834       <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
 835         <listitem>
 836
 837 <para>Specifies the table width (including units or as a percentage)</para>
 838
 839         </listitem>
 840       </varlistentry>
 841     </variablelist>
 842
 843   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 844
 845 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
 846
 847   </refsect1></refentry>
 848
 849 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_term-width">
 850 <refnamediv>
 851 <refname>dbfo_term-width</refname>
 852 <refpurpose>Specifies the term width for a variablelist</refpurpose>
 853 </refnamediv>
 854 <refsynopsisdiv>
 855
 856     <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
 857
 858 </refsynopsisdiv>
 859 <refsect1><title>Description</title>
 860
 861 <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
 862       <tag>variablelist</tag> to specify the width for
 863       <tag>term</tag> output.</para>
 864
 865   </refsect1><refsect1><title>Parameters</title>
 866
 867 <variablelist>
 868       <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
 869         <listitem>
 870
 871 <para>Specifies the term width (including units)</para>
 872
 873         </listitem>
 874       </varlistentry>
 875     </variablelist>
 876
 877   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 878
 879 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
 880
 881   </refsect1></refentry>
 882
 883 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_toc">
 884 <refnamediv>
 885 <refname>dbfo_toc</refname>
 886 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
 887 </refnamediv>
 888 <refsynopsisdiv>
 889
 890     <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
 891
 892 </refsynopsisdiv>
 893 <refsect1><title>Description</title>
 894
 895 <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
 896       <tag>qandaset</tag> to specify whether a table of contents
 897       (TOC) is generated for the <tag>qandaset</tag>.</para>
 898
 899   </refsect1><refsect1><title>Parameters</title>
 900
 901 <variablelist>
 902       <varlistentry><term>toc="0"</term>
 903         <listitem>
 904
 905 <para>If zero, no TOC is generated</para>
 906
 907         </listitem>
 908       </varlistentry>
 909       <varlistentry><term>toc="1"</term>
 910         <listitem>
 911
 912 <para>If <code>1</code> (or any non-zero value),
 913             a TOC is generated</para>
 914
 915         </listitem>
 916       </varlistentry>
 917     </variablelist>
 918
 919   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 920
 921 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
 922       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
 923
 924   </refsect1></refentry>
 925
 926 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo-need">
 927 <refnamediv>
 928 <refname>dbfo-need</refname>
 929 <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
 930 </refnamediv>
 931 <refsynopsisdiv>
 932
 933     <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
 934
 935 </refsynopsisdiv>
 936 <refsect1><title>Description</title>
 937
 938 <para>A “need” is a request for space on a page.  If the
 939       requested space is not available, the page breaks and the
 940       content that follows the need request appears on the next
 941       page. If the requested space is available, then no page break
 942       is inserted.</para>
 943
 944   </refsect1><refsect1><title>Parameters</title>
 945
 946 <variablelist>
 947       <varlistentry><term>height="<replaceable>n</replaceable>"</term>
 948         <listitem>
 949
 950 <para>The amount of height needed (including units)</para>
 951
 952         </listitem>
 953       </varlistentry>
 954       <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
 955         <listitem>
 956
 957 <para>The amount of extra vertical space to add (including units)</para>
 958
 959         </listitem>
 960       </varlistentry>
 961     </variablelist>
 962
 963   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 964
 965 <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
 966
 967   </refsect1></refentry>
 968
 969 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_row-height">
 970 <refnamediv>
 971 <refname>dbfo_row-height</refname>
 972 <refpurpose>Specifies the height for a CALS table row</refpurpose>
 973 </refnamediv>
 974 <refsynopsisdiv>
 975
 976     <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
 977
 978 </refsynopsisdiv>
 979 <refsect1><title>Description</title>
 980
 981 <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
 982       <tag>row</tag> to specify the height of the row.</para>
 983
 984   </refsect1><refsect1><title>Parameters</title>
 985
 986 <variablelist>
 987       <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
 988         <listitem>
 989
 990 <para>Specifies the row height (including units)</para>
 991
 992         </listitem>
 993       </varlistentry>
 994     </variablelist>
 995
 996   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
 997
 998 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
 999
1000   </refsect1></refentry>
1001 </reference>
1002