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