doc/xslt/xhtml/pi.xsl

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