stylesheets/styleguide/docbook-xsl-1.75.2/html/pi.xml

   1 <?xml version="1.0"?>\r
   2 \r
   3 <reference><info><title>HTML Processing Instruction Reference</title>\r
   4     <releaseinfo role="meta">\r
   5       $Id: pi.xsl 8394 2009-04-02 20:31:30Z mzjn $\r
   6     </releaseinfo>\r
   7   </info>\r
   8   <partintro xml:id="partintro">\r
   9     <title>Introduction</title>\r
  10     \r
  11 <para>This is generated reference documentation for all\r
  12       user-specifiable processing instructions (PIs) in the DocBook\r
  13       XSL stylesheets for HTML output.\r
  14       <note>\r
  15         \r
  16 <para>You add these PIs at particular points in a document to\r
  17           cause specific “exceptions” to formatting/output behavior. To\r
  18           make global changes in formatting/output behavior across an\r
  19           entire document, it’s better to do it by setting an\r
  20           appropriate stylesheet parameter (if there is one).</para>\r
  21 \r
  22       </note>\r
  23     </para>\r
  24 \r
  25   </partintro>\r
  26 \r
  27 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_background-color">\r
  28 <refnamediv>\r
  29 <refname>dbhtml_background-color</refname>\r
  30 <refpurpose>Sets background color for an image</refpurpose>\r
  31 </refnamediv>\r
  32 <refsynopsisdiv>\r
  33 \r
  34     <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>\r
  35   \r
  36 </refsynopsisdiv>\r
  37 <refsect1><title>Description</title>\r
  38     \r
  39 <para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or\r
  40       after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,\r
  41       <tag>imagedata</tag>, or <tag>videodata</tag> element) as a\r
  42       sibling to the element, to set a background color for the\r
  43       image.</para>\r
  44 \r
  45   </refsect1><refsect1><title>Parameters</title>\r
  46     \r
  47 <variablelist>\r
  48       <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>\r
  49         <listitem>\r
  50           \r
  51 <para>An HTML color value</para>\r
  52 \r
  53         </listitem>\r
  54       </varlistentry>\r
  55     </variablelist>\r
  56 \r
  57   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
  58     \r
  59 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>\r
  60 \r
  61   </refsect1></refentry>\r
  62 \r
  63 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_bgcolor">\r
  64 <refnamediv>\r
  65 <refname>dbhtml_bgcolor</refname>\r
  66 <refpurpose>Sets background color on a CALS table row or table cell</refpurpose>\r
  67 </refnamediv>\r
  68 <refsynopsisdiv>\r
  69 \r
  70     <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>\r
  71   \r
  72 </refsynopsisdiv>\r
  73 <refsect1><title>Description</title>\r
  74     \r
  75 <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row\r
  76       or cell to set a background color for that table row or cell.</para>\r
  77 \r
  78   </refsect1><refsect1><title>Parameters</title>\r
  79     \r
  80 <variablelist>\r
  81       <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>\r
  82         <listitem>\r
  83           \r
  84 <para>An HTML color value</para>\r
  85 \r
  86         </listitem>\r
  87       </varlistentry>\r
  88     </variablelist>\r
  89 \r
  90   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
  91     \r
  92 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>\r
  93 \r
  94   </refsect1></refentry>\r
  95 \r
  96 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_cellpadding">\r
  97 <refnamediv>\r
  98 <refname>dbhtml_cellpadding</refname>\r
  99 <refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>\r
 100 </refnamediv>\r
 101 <refsynopsisdiv>\r
 102 \r
 103     <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>\r
 104   \r
 105 </refsynopsisdiv>\r
 106 <refsect1><title>Description</title>\r
 107     \r
 108 <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a\r
 109       CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value\r
 110       for the HTML <literal>cellpadding</literal> attribute in the\r
 111       output HTML table.</para>\r
 112 \r
 113   </refsect1><refsect1><title>Parameters</title>\r
 114     \r
 115 <variablelist>\r
 116       <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>\r
 117         <listitem>\r
 118           \r
 119 <para>Specifies the cellpadding</para>\r
 120 \r
 121         </listitem>\r
 122       </varlistentry>\r
 123     </variablelist>\r
 124 \r
 125   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 126     \r
 127 <para><parameter>html.cellpadding</parameter></para>\r
 128 \r
 129   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 130     \r
 131 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,\r
 132       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>\r
 133 \r
 134   </refsect1></refentry>\r
 135 \r
 136 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_cellspacing">\r
 137 <refnamediv>\r
 138 <refname>dbhtml_cellspacing</refname>\r
 139 <refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>\r
 140 </refnamediv>\r
 141 <refsynopsisdiv>\r
 142 \r
 143     <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>\r
 144   \r
 145 </refsynopsisdiv>\r
 146 <refsect1><title>Description</title>\r
 147     \r
 148 <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a\r
 149       CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value\r
 150       for the HTML <literal>cellspacing</literal> attribute in the\r
 151       output HTML table.</para>\r
 152 \r
 153   </refsect1><refsect1><title>Parameters</title>\r
 154     \r
 155 <variablelist>\r
 156       <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>\r
 157         <listitem>\r
 158           \r
 159 <para>Specifies the cellspacing</para>\r
 160 \r
 161         </listitem>\r
 162       </varlistentry>\r
 163     </variablelist>\r
 164 \r
 165   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 166     \r
 167 <para><parameter>html.cellspacing</parameter></para>\r
 168 \r
 169   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 170     \r
 171 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,\r
 172       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>\r
 173 \r
 174     </refsect1></refentry>\r
 175 \r
 176 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_class">\r
 177 <refnamediv>\r
 178 <refname>dbhtml_class</refname>\r
 179 <refpurpose>Set value of the class attribute for a CALS table row</refpurpose>\r
 180 </refnamediv>\r
 181 <refsynopsisdiv>\r
 182 \r
 183     <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>\r
 184   \r
 185 </refsynopsisdiv>\r
 186 <refsect1><title>Description</title>\r
 187     \r
 188 <para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a\r
 189       <tag>row</tag> to specify a <literal>class</literal>\r
 190       attribute and value in the HTML output for that row.</para>\r
 191 \r
 192   </refsect1><refsect1><title>Parameters</title>\r
 193     \r
 194 <variablelist>\r
 195       <varlistentry><term>class="<replaceable>name</replaceable>"</term>\r
 196         <listitem>\r
 197           \r
 198 <para>Specifies the class name</para>\r
 199 \r
 200         </listitem>\r
 201       </varlistentry>\r
 202     </variablelist>\r
 203 \r
 204   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 205     \r
 206 <para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>\r
 207 \r
 208   </refsect1></refentry>\r
 209 \r
 210 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_dir">\r
 211 <refnamediv>\r
 212 <refname>dbhtml_dir</refname>\r
 213 <refpurpose>Specifies a directory name in which to write files</refpurpose>\r
 214 </refnamediv>\r
 215 <refsynopsisdiv>\r
 216 \r
 217     <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>\r
 218   \r
 219 </refsynopsisdiv>\r
 220 <refsect1><title>Description</title>\r
 221     \r
 222 <para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI\r
 223       as a child of a chunk source to cause the output of that\r
 224       chunk to be written to the specified directory; also, use it\r
 225       as a child of a <tag>mediaobject</tag> to specify a\r
 226       directory into which any long-description files for that\r
 227       <tag>mediaobject</tag> will be written.</para>\r
 228 \r
 229   </refsect1><refsect1><title>Parameters</title>\r
 230     \r
 231 <variablelist>\r
 232       <varlistentry><term>dir="<replaceable>path</replaceable>"</term>\r
 233         <listitem>\r
 234           \r
 235 <para>Specifies the pathname for the directory</para>\r
 236 \r
 237         </listitem>\r
 238       </varlistentry>\r
 239     </variablelist>\r
 240 \r
 241   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 242     \r
 243 <para><parameter>base.dir</parameter></para>\r
 244 \r
 245   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 246     \r
 247 <para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>\r
 248 \r
 249   </refsect1></refentry>\r
 250 \r
 251 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_filename">\r
 252 <refnamediv>\r
 253 <refname>dbhtml_filename</refname>\r
 254 <refpurpose>Specifies a filename for a chunk</refpurpose>\r
 255 </refnamediv>\r
 256 <refsynopsisdiv>\r
 257 \r
 258     <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>\r
 259   \r
 260 </refsynopsisdiv>\r
 261 <refsect1><title>Description</title>\r
 262     \r
 263 <para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>\r
 264       PI as a child of a chunk source to specify a filename for\r
 265       the output file for that chunk.</para>\r
 266 \r
 267   </refsect1><refsect1><title>Parameters</title>\r
 268     \r
 269 <variablelist>\r
 270       <varlistentry><term>filename="<replaceable>path</replaceable>"</term>\r
 271         <listitem>\r
 272           \r
 273 <para>Specifies the filename for the file</para>\r
 274 \r
 275         </listitem>\r
 276       </varlistentry>\r
 277     </variablelist>\r
 278 \r
 279   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 280     \r
 281 <para><parameter>use.id.as.filename</parameter></para>\r
 282 \r
 283   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 284     \r
 285 <para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>\r
 286 \r
 287   </refsect1></refentry>\r
 288 \r
 289 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_funcsynopsis-style">\r
 290 <refnamediv>\r
 291 <refname>dbhtml_funcsynopsis-style</refname>\r
 292 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>\r
 293 </refnamediv>\r
 294 <refsynopsisdiv>\r
 295 \r
 296     <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>\r
 297   \r
 298 </refsynopsisdiv>\r
 299 <refsect1><title>Description</title>\r
 300     \r
 301 <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of\r
 302       a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis\r
 303       to control the presentation style for output of all\r
 304       <tag>funcprototype</tag> instances within that funcsynopsis.</para>\r
 305 \r
 306   </refsect1><refsect1><title>Parameters</title>\r
 307     \r
 308 <variablelist>\r
 309       <varlistentry><term>funcsynopsis-style="kr"</term>\r
 310         <listitem>\r
 311           \r
 312 <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>\r
 313 \r
 314         </listitem>\r
 315       </varlistentry>\r
 316       <varlistentry><term>funcsynopsis-style="ansi"</term>\r
 317         <listitem>\r
 318           \r
 319 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>\r
 320 \r
 321         </listitem>\r
 322       </varlistentry>\r
 323     </variablelist>\r
 324 \r
 325   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 326     \r
 327 <para><parameter>funcsynopsis.style</parameter></para>\r
 328 \r
 329   </refsect1></refentry>\r
 330 \r
 331 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_img.src.path">\r
 332 <refnamediv>\r
 333 <refname>dbhtml_img.src.path</refname>\r
 334 <refpurpose>Specifies a path to the location of an image file</refpurpose>\r
 335 </refnamediv>\r
 336 <refsynopsisdiv>\r
 337 \r
 338     <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>\r
 339   \r
 340 </refsynopsisdiv>\r
 341 <refsect1><title>Description</title>\r
 342     \r
 343 <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or\r
 344       after an image (<tag>graphic</tag>,\r
 345       <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or\r
 346       <tag>videodata</tag> element) as a sibling to the element,\r
 347       to specify a path to the location of the image; in HTML\r
 348       output, the value specified for the\r
 349       <code>img.src.path</code> attribute is prepended to the\r
 350       filename.</para>\r
 351 \r
 352   </refsect1><refsect1><title>Parameters</title>\r
 353     \r
 354 <variablelist>\r
 355       <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>\r
 356         <listitem>\r
 357           \r
 358 <para>Specifies the pathname to prepend to the name of the image file</para>\r
 359 \r
 360         </listitem>\r
 361       </varlistentry>\r
 362     </variablelist>\r
 363 \r
 364   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 365     \r
 366 <para><parameter>img.src.path</parameter></para>\r
 367 \r
 368   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 369     \r
 370 <para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>\r
 371 \r
 372   </refsect1></refentry>\r
 373 \r
 374 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_label-width">\r
 375 <refnamediv>\r
 376 <refname>dbhtml_label-width</refname>\r
 377 <refpurpose>Specifies the label width for a qandaset</refpurpose>\r
 378 </refnamediv>\r
 379 <refsynopsisdiv>\r
 380 \r
 381     <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>\r
 382   \r
 383 </refsynopsisdiv>\r
 384 <refsect1><title>Description</title>\r
 385     \r
 386 <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a\r
 387       <tag>qandaset</tag> to specify the width of labels.</para>\r
 388 \r
 389   </refsect1><refsect1><title>Parameters</title>\r
 390     \r
 391 <variablelist>\r
 392       <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>\r
 393         <listitem>\r
 394           \r
 395 <para>Specifies the label width (including units)</para>\r
 396 \r
 397         </listitem>\r
 398       </varlistentry>\r
 399     </variablelist>\r
 400 \r
 401   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 402     \r
 403 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>\r
 404 \r
 405   </refsect1></refentry>\r
 406 \r
 407 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_linenumbering.everyNth">\r
 408 <refnamediv>\r
 409 <refname>dbhtml_linenumbering.everyNth</refname>\r
 410 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>\r
 411 </refnamediv>\r
 412 <refsynopsisdiv>\r
 413 \r
 414     <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>\r
 415   \r
 416 </refsynopsisdiv>\r
 417 <refsect1><title>Description</title>\r
 418     \r
 419 <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child\r
 420       of a “verbatim” element – <tag>programlisting</tag>,\r
 421       <tag>screen</tag>, <tag>synopsis</tag> — to specify\r
 422       the interval at which lines are numbered.</para>\r
 423 \r
 424   </refsect1><refsect1><title>Parameters</title>\r
 425     \r
 426 <variablelist>\r
 427       <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>\r
 428         <listitem>\r
 429           \r
 430 <para>Specifies numbering interval; a number is output\r
 431             before every <replaceable>N</replaceable>th line</para>\r
 432 \r
 433         </listitem>\r
 434       </varlistentry>\r
 435     </variablelist>\r
 436 \r
 437   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 438     \r
 439 <para><parameter>linenumbering.everyNth</parameter></para>\r
 440 \r
 441   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 442     \r
 443 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>\r
 444 \r
 445   </refsect1></refentry>\r
 446 \r
 447 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_linenumbering.separator">\r
 448 <refnamediv>\r
 449 <refname>dbhtml_linenumbering.separator</refname>\r
 450 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>\r
 451 </refnamediv>\r
 452 <refsynopsisdiv>\r
 453 \r
 454     <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>\r
 455   \r
 456 </refsynopsisdiv>\r
 457 <refsect1><title>Description</title>\r
 458     \r
 459 <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child\r
 460       of a “verbatim” element – <tag>programlisting</tag>,\r
 461       <tag>screen</tag>, <tag>synopsis</tag> — to specify\r
 462       the separator text output between the line numbers and content.</para>\r
 463 \r
 464   </refsect1><refsect1><title>Parameters</title>\r
 465     \r
 466 <variablelist>\r
 467       <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>\r
 468         <listitem>\r
 469           \r
 470 <para>Specifies the text (zero or more characters)</para>\r
 471 \r
 472         </listitem>\r
 473       </varlistentry>\r
 474     </variablelist>\r
 475 \r
 476   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 477     \r
 478 <para><parameter>linenumbering.separator</parameter></para>\r
 479 \r
 480   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 481     \r
 482 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>\r
 483 \r
 484   </refsect1></refentry>\r
 485 \r
 486 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_linenumbering.width">\r
 487 <refnamediv>\r
 488 <refname>dbhtml_linenumbering.width</refname>\r
 489 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>\r
 490 </refnamediv>\r
 491 <refsynopsisdiv>\r
 492 \r
 493     <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>\r
 494   \r
 495 </refsynopsisdiv>\r
 496 <refsect1><title>Description</title>\r
 497     \r
 498 <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child\r
 499       of a “verbatim” element – <tag>programlisting</tag>,\r
 500       <tag>screen</tag>, <tag>synopsis</tag> — to specify\r
 501       the width set aside for line numbers.</para>\r
 502 \r
 503   </refsect1><refsect1><title>Parameters</title>\r
 504     \r
 505 <variablelist>\r
 506       <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>\r
 507         <listitem>\r
 508           \r
 509 <para>Specifies the width (inluding units)</para>\r
 510 \r
 511         </listitem>\r
 512       </varlistentry>\r
 513     </variablelist>\r
 514 \r
 515   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 516     \r
 517 <para><parameter>linenumbering.width</parameter></para>\r
 518 \r
 519   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 520     \r
 521 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>\r
 522 \r
 523   </refsect1></refentry>\r
 524 \r
 525 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_list-presentation">\r
 526 <refnamediv>\r
 527 <refname>dbhtml_list-presentation</refname>\r
 528 <refpurpose>Specifies presentation style for a variablelist or\r
 529     segmentedlist</refpurpose>\r
 530 </refnamediv>\r
 531 <refsynopsisdiv>\r
 532 \r
 533     <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>\r
 534   \r
 535 </refsynopsisdiv>\r
 536 <refsect1><title>Description</title>\r
 537     \r
 538 <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of\r
 539       a <tag>variablelist</tag> or <tag>segmentedlist</tag> to\r
 540       control the presentation style for the list (to cause it, for\r
 541       example, to be displayed as a table).</para>\r
 542 \r
 543   </refsect1><refsect1><title>Parameters</title>\r
 544     \r
 545 <variablelist>\r
 546       <varlistentry><term>list-presentation="list"</term>\r
 547         <listitem>\r
 548           \r
 549 <para>Displays the list as a list</para>\r
 550 \r
 551         </listitem>\r
 552       </varlistentry>\r
 553       <varlistentry><term>list-presentation="table"</term>\r
 554         <listitem>\r
 555           \r
 556 <para>Displays the list as a table</para>\r
 557 \r
 558         </listitem>\r
 559       </varlistentry>\r
 560     </variablelist>\r
 561 \r
 562   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 563     \r
 564 <itemizedlist>\r
 565       <listitem>\r
 566         \r
 567 <para><parameter>variablelist.as.table</parameter></para>\r
 568 \r
 569       </listitem>\r
 570       <listitem>\r
 571         \r
 572 <para><parameter>segmentedlist.as.table</parameter></para>\r
 573 \r
 574       </listitem>\r
 575     </itemizedlist>\r
 576 \r
 577   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 578     \r
 579 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>\r
 580 \r
 581   </refsect1></refentry>\r
 582 \r
 583 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_list-width">\r
 584 <refnamediv>\r
 585 <refname>dbhtml_list-width</refname>\r
 586 <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>\r
 587 </refnamediv>\r
 588 <refsynopsisdiv>\r
 589 \r
 590     <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>\r
 591   \r
 592 </refsynopsisdiv>\r
 593 <refsect1><title>Description</title>\r
 594     \r
 595 <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a\r
 596       <tag>variablelist</tag> or a <tag>simplelist</tag> presented\r
 597       as a table, to specify the output width.</para>\r
 598 \r
 599   </refsect1><refsect1><title>Parameters</title>\r
 600     \r
 601 <variablelist>\r
 602       <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>\r
 603         <listitem>\r
 604           \r
 605 <para>Specifies the output width (including units)</para>\r
 606 \r
 607         </listitem>\r
 608       </varlistentry>\r
 609     </variablelist>\r
 610 \r
 611   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 612     \r
 613 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>\r
 614 \r
 615   </refsect1></refentry>\r
 616 \r
 617 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_row-height">\r
 618 <refnamediv>\r
 619 <refname>dbhtml_row-height</refname>\r
 620 <refpurpose>Specifies the height for a CALS table row</refpurpose>\r
 621 </refnamediv>\r
 622 <refsynopsisdiv>\r
 623 \r
 624     <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>\r
 625   \r
 626 </refsynopsisdiv>\r
 627 <refsect1><title>Description</title>\r
 628     \r
 629 <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a\r
 630       <tag>row</tag> to specify the height of the row.</para>\r
 631 \r
 632   </refsect1><refsect1><title>Parameters</title>\r
 633     \r
 634 <variablelist>\r
 635       <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>\r
 636         <listitem>\r
 637           \r
 638 <para>Specifies the row height (including units)</para>\r
 639 \r
 640         </listitem>\r
 641       </varlistentry>\r
 642     </variablelist>\r
 643 \r
 644   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 645     \r
 646 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>\r
 647 \r
 648   </refsect1></refentry>\r
 649 \r
 650 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_start">\r
 651 <refnamediv>\r
 652 <refname>dbhtml_start</refname>\r
 653 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>\r
 654 </refnamediv>\r
 655 <refsynopsisdiv>\r
 656 \r
 657     <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>\r
 658   \r
 659 </refsynopsisdiv>\r
 660 <refsect1><title>Description</title>\r
 661     \r
 662 <para><emphasis>This PI is obsolete</emphasis>. The intent of\r
 663       this PI was to provide a means for setting a specific starting\r
 664       number for an ordered list. Instead of this PI, set a value\r
 665       for the <literal>override</literal> attribute on the first\r
 666       <tag>listitem</tag> in the list; that will have the same\r
 667       effect as what this PI was intended for.</para>\r
 668 \r
 669   </refsect1><refsect1><title>Parameters</title>\r
 670     \r
 671 <variablelist>\r
 672       <varlistentry><term>start="<replaceable>character</replaceable>"</term>\r
 673         <listitem>\r
 674           \r
 675 <para>Specifies the character to use as the starting\r
 676             number; use 0-9, a-z, A-Z, or lowercase or uppercase\r
 677             Roman numerals</para>\r
 678 \r
 679         </listitem>\r
 680       </varlistentry>\r
 681     </variablelist>\r
 682 \r
 683   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 684     \r
 685 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>\r
 686 \r
 687   </refsect1></refentry>\r
 688 \r
 689 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_stop-chunking">\r
 690 <refnamediv>\r
 691 <refname>dbhtml_stop-chunking</refname>\r
 692 <refpurpose>Do not chunk any descendants of this element.</refpurpose>\r
 693 </refnamediv>\r
 694 <refsynopsisdiv>\r
 695 \r
 696     <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>\r
 697   \r
 698 </refsynopsisdiv>\r
 699 <refsect1><title>Description</title>\r
 700     \r
 701 <para>When generating chunked HTML output, adding this PI as the child of an element that contains elements that would normally be generated on separate pages if generating chunked output causes chunking to stop at this point. No descendants of the current element will be split into new HTML pages:\r
 702 <programlisting>&lt;section&gt;\r
 703 &lt;title&gt;Configuring pencil&lt;/title&gt;\r
 704 &lt;?dbhtml stop-chunking?&gt;\r
 705 \r
 706 ...\r
 707 \r
 708 &lt;/section&gt;</programlisting>\r
 709 </para>\r
 710 \r
 711   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 712     \r
 713 <para><link role="tcg" xlink:href="Chunking.html">Chunking into multiple HTML files</link></para>\r
 714 \r
 715   </refsect1></refentry>\r
 716 \r
 717 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_table-summary">\r
 718 <refnamediv>\r
 719 <refname>dbhtml_table-summary</refname>\r
 720 <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>\r
 721 </refnamediv>\r
 722 <refsynopsisdiv>\r
 723 \r
 724     <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>\r
 725   \r
 726 </refsynopsisdiv>\r
 727 <refsect1><title>Description</title>\r
 728     \r
 729 <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of\r
 730       a CALS <tag>table</tag>, <tag>variablelist</tag>,\r
 731       <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify\r
 732       the text for the HTML <literal>summary</literal> attribute\r
 733       in the output HTML table.</para>\r
 734 \r
 735   </refsect1><refsect1><title>Parameters</title>\r
 736     \r
 737 <variablelist>\r
 738       <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>\r
 739         <listitem>\r
 740           \r
 741 <para>Specifies the summary text (zero or more characters)</para>\r
 742 \r
 743         </listitem>\r
 744       </varlistentry>\r
 745     </variablelist>\r
 746 \r
 747   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 748     \r
 749 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link>,\r
 750       <link role="tcg" xlink:href="TableSummary.html">Table summary text</link></para>\r
 751 \r
 752   </refsect1></refentry>\r
 753 \r
 754 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_table-width">\r
 755 <refnamediv>\r
 756 <refname>dbhtml_table-width</refname>\r
 757 <refpurpose>Specifies the width for a CALS table</refpurpose>\r
 758 </refnamediv>\r
 759 <refsynopsisdiv>\r
 760 \r
 761     <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>\r
 762   \r
 763 </refsynopsisdiv>\r
 764 <refsect1><title>Description</title>\r
 765     \r
 766 <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a\r
 767       CALS <tag>table</tag> to specify the width of the table in\r
 768       output.</para>\r
 769 \r
 770   </refsect1><refsect1><title>Parameters</title>\r
 771     \r
 772 <variablelist>\r
 773       <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>\r
 774         <listitem>\r
 775           \r
 776 <para>Specifies the table width (including units or as a percentage)</para>\r
 777 \r
 778         </listitem>\r
 779       </varlistentry>\r
 780     </variablelist>\r
 781 \r
 782   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 783     \r
 784 <para><parameter>default.table.width</parameter></para>\r
 785 \r
 786   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 787     \r
 788 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>\r
 789 \r
 790   </refsect1></refentry>\r
 791 \r
 792 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_term-presentation">\r
 793 <refnamediv>\r
 794 <refname>dbhtml_term-presentation</refname>\r
 795 <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>\r
 796 </refnamediv>\r
 797 <refsynopsisdiv>\r
 798 \r
 799     <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>\r
 800   \r
 801 </refsynopsisdiv>\r
 802 <refsect1><title>Description</title>\r
 803     \r
 804 <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child\r
 805       of a <tag>variablelist</tag> to set character formatting for\r
 806       the <tag>term</tag> output of the list.</para>\r
 807 \r
 808   </refsect1><refsect1><title>Parameters</title>\r
 809     \r
 810 <variablelist>\r
 811       <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>\r
 812         <listitem>\r
 813           \r
 814 <para>Specifies that terms are displayed in bold</para>\r
 815 \r
 816         </listitem>\r
 817       </varlistentry>\r
 818       <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>\r
 819         <listitem>\r
 820           \r
 821 <para>Specifies that terms are displayed in italic</para>\r
 822 \r
 823         </listitem>\r
 824       </varlistentry>\r
 825       <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>\r
 826         <listitem>\r
 827           \r
 828 <para>Specifies that terms are displayed in bold-italic</para>\r
 829 \r
 830         </listitem>\r
 831       </varlistentry>\r
 832     </variablelist>\r
 833 \r
 834   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 835     \r
 836 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>\r
 837 \r
 838   </refsect1></refentry>\r
 839 \r
 840 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_term-separator">\r
 841 <refnamediv>\r
 842 <refname>dbhtml_term-separator</refname>\r
 843 <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>\r
 844 </refnamediv>\r
 845 <refsynopsisdiv>\r
 846 \r
 847     <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>\r
 848   \r
 849 </refsynopsisdiv>\r
 850 <refsect1><title>Description</title>\r
 851     \r
 852 <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child\r
 853       of a <tag>variablelist</tag> to specify the separator text\r
 854       among <tag>term</tag> instances.</para>\r
 855 \r
 856   </refsect1><refsect1><title>Parameters</title>\r
 857     \r
 858 <variablelist>\r
 859       <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>\r
 860         <listitem>\r
 861           \r
 862 <para>Specifies the text (zero or more characters)</para>\r
 863 \r
 864         </listitem>\r
 865       </varlistentry>\r
 866     </variablelist>\r
 867 \r
 868   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
 869     \r
 870 <para><parameter>variablelist.term.separator</parameter></para>\r
 871 \r
 872   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 873     \r
 874 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>\r
 875 \r
 876   </refsect1></refentry>\r
 877 \r
 878 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_term-width">\r
 879 <refnamediv>\r
 880 <refname>dbhtml_term-width</refname>\r
 881 <refpurpose>Specifies the term width for a variablelist</refpurpose>\r
 882 </refnamediv>\r
 883 <refsynopsisdiv>\r
 884 \r
 885     <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>\r
 886   \r
 887 </refsynopsisdiv>\r
 888 <refsect1><title>Description</title>\r
 889     \r
 890 <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a\r
 891       <tag>variablelist</tag> to specify the width for\r
 892       <tag>term</tag> output.</para>\r
 893 \r
 894   </refsect1><refsect1><title>Parameters</title>\r
 895     \r
 896 <variablelist>\r
 897       <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>\r
 898         <listitem>\r
 899           \r
 900 <para>Specifies the term width (including units)</para>\r
 901 \r
 902         </listitem>\r
 903       </varlistentry>\r
 904     </variablelist>\r
 905 \r
 906   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 907     \r
 908 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>\r
 909 \r
 910   </refsect1></refentry>\r
 911 \r
 912 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_toc">\r
 913 <refnamediv>\r
 914 <refname>dbhtml_toc</refname>\r
 915 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>\r
 916 </refnamediv>\r
 917 <refsynopsisdiv>\r
 918 \r
 919     <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>\r
 920   \r
 921 </refsynopsisdiv>\r
 922 <refsect1><title>Description</title>\r
 923     \r
 924 <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a\r
 925       <tag>qandaset</tag> to specify whether a table of contents\r
 926       (TOC) is generated for the <tag>qandaset</tag>.</para>\r
 927 \r
 928   </refsect1><refsect1><title>Parameters</title>\r
 929     \r
 930 <variablelist>\r
 931       <varlistentry><term>toc="0"</term>\r
 932         <listitem>\r
 933           \r
 934 <para>If zero, no TOC is generated</para>\r
 935 \r
 936         </listitem>\r
 937       </varlistentry>\r
 938       <varlistentry><term>toc="1"</term>\r
 939         <listitem>\r
 940           \r
 941 <para>If <code>1</code> (or any non-zero value),\r
 942             a TOC is generated</para>\r
 943 \r
 944         </listitem>\r
 945       </varlistentry>\r
 946     </variablelist>\r
 947 \r
 948   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
 949     \r
 950 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,\r
 951       <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>\r
 952 \r
 953   </refsect1></refentry>\r
 954 \r
 955 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbcmdlist">\r
 956 <refnamediv>\r
 957 <refname>dbcmdlist</refname>\r
 958 <refpurpose>Generates a hyperlinked list of commands</refpurpose>\r
 959 </refnamediv>\r
 960 <refsynopsisdiv>\r
 961 \r
 962     <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>\r
 963   \r
 964 </refsynopsisdiv>\r
 965 <refsect1><title>Description</title>\r
 966     \r
 967 <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any\r
 968       element (for example, <tag>refsynopsisdiv</tag>) containing multiple\r
 969       <tag>cmdsynopsis</tag> instances; a hyperlinked navigational\r
 970       “command list” will be generated at the top of output for that\r
 971       element, enabling users to quickly jump\r
 972       to each command synopsis.</para>\r
 973 \r
 974   </refsect1><refsect1><title>Parameters</title>\r
 975     \r
 976 <para>[No parameters]</para>\r
 977 \r
 978   </refsect1></refentry>\r
 979 \r
 980 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfunclist">\r
 981 <refnamediv>\r
 982 <refname>dbfunclist</refname>\r
 983 <refpurpose>Generates a hyperlinked list of functions</refpurpose>\r
 984 </refnamediv>\r
 985 <refsynopsisdiv>\r
 986 \r
 987     <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>\r
 988   \r
 989 </refsynopsisdiv>\r
 990 <refsect1><title>Description</title>\r
 991     \r
 992 <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any\r
 993       element (for example, <tag>refsynopsisdiv</tag>) containing multiple\r
 994       <tag>funcsynopsis</tag> instances; a hyperlinked\r
 995       navigational “function list” will be generated at the top of\r
 996       output for that element, enabling users to quickly\r
 997       jump to to each function synopsis.</para>\r
 998 \r
 999   </refsect1><refsect1><title>Parameters</title>\r
1000     \r
1001 <para>[No parameters]</para>\r
1002 \r
1003   </refsect1></refentry>\r
1004 \r
1005 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml-include_href">\r
1006 <refnamediv>\r
1007 <refname>dbhtml-include_href</refname>\r
1008 <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>\r
1009 </refnamediv>\r
1010 <refsynopsisdiv>\r
1011 \r
1012     <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>\r
1013   \r
1014 </refsynopsisdiv>\r
1015 <refsect1><title>Description</title>\r
1016     \r
1017 <para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a\r
1018       document to cause the contents of the file referenced by the\r
1019       <code>href</code> pseudo-attribute to be copied/inserted “as\r
1020       is” into your HTML output at the point in document order\r
1021       where the PI occurs in the source.</para>\r
1022 \r
1023     <note>\r
1024       \r
1025 <para>The referenced file may contain plain text (as long as\r
1026         it is “wrapped” in an <tag>html</tag> element — see the\r
1027         note below) or markup in any arbitrary vocabulary,\r
1028         including HTML — but it must conform to XML\r
1029         well-formedness constraints (because the feature in XSLT\r
1030         1.0 for opening external files, the\r
1031         <function>document()</function> function, can only handle\r
1032         files that meet XML well-formedness constraints).</para>\r
1033 \r
1034       \r
1035 <para>Among other things, XML well-formedness constraints\r
1036         require a document to have <emphasis>a single root\r
1037           element</emphasis>. So if the content you want to\r
1038         include is plain text or is markup that does\r
1039         <emphasis>not</emphasis> have a single root element,\r
1040         <emphasis role="strong">wrap the content in an\r
1041           <tag>html</tag> element</emphasis>. The stylesheets will\r
1042         strip out that surrounding <tag>html</tag> “wrapper” when\r
1043         they find it, leaving just the content you want to\r
1044         insert.</para>\r
1045 \r
1046     </note>\r
1047   </refsect1><refsect1><title>Parameters</title>\r
1048     \r
1049 <variablelist>\r
1050       <varlistentry><term>href="<replaceable>URI</replaceable>"</term>\r
1051         <listitem>\r
1052           \r
1053 <para>Specifies the URI for the file to include; the URI\r
1054             can be, for example, a remote <literal>http:</literal>\r
1055             URI, or a local filesystem <literal>file:</literal>\r
1056             URI</para>\r
1057 \r
1058         </listitem>\r
1059       </varlistentry>\r
1060     </variablelist>\r
1061 \r
1062   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>\r
1063     \r
1064 <para><parameter>textinsert.extension</parameter></para>\r
1065 \r
1066   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
1067     \r
1068 <para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,\r
1069       <link role="tcg" xlink:href="ExternalCode.html">External code files</link></para>\r
1070 \r
1071   </refsect1></refentry>\r
1072 \r
1073 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhh">\r
1074 <refnamediv>\r
1075 <refname>dbhh</refname>\r
1076 <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>\r
1077 </refnamediv>\r
1078 <refsynopsisdiv>\r
1079 \r
1080     <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>\r
1081   \r
1082 </refsynopsisdiv>\r
1083 <refsect1><title>Description</title>\r
1084     \r
1085 <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components\r
1086       that should be used as targets for context-sensitive help requests.</para>\r
1087 \r
1088   </refsect1><refsect1><title>Parameters</title>\r
1089     \r
1090 <variablelist>\r
1091       <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>\r
1092         <listitem>\r
1093           \r
1094 <para>Specifies a unique string constant that identifies a help topic</para>\r
1095 \r
1096         </listitem>\r
1097       </varlistentry>\r
1098       <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>\r
1099         <listitem>\r
1100           \r
1101 <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>\r
1102 \r
1103         </listitem>\r
1104       </varlistentry>\r
1105     </variablelist>\r
1106 \r
1107   </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>\r
1108     \r
1109 <para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>\r
1110 \r
1111   </refsect1></refentry>\r
1112 </reference>\r
1113 \r