fo/pi.xml

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