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