Project

General

Profile

1
<?xml version='1.0'?>
2
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
3
                xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
4
                xmlns:xlink="http://www.w3.org/1999/xlink"
5
                exclude-result-prefixes="doc"
6
                version='1.0'>
7

    
8
<!-- ********************************************************************
9
     $Id: pi.xsl 8394 2009-04-02 20:31:30Z mzjn $
10
     ********************************************************************
11

    
12
     This file is part of the XSL DocBook Stylesheet distribution.
13
     See ../README or http://docbook.sf.net/release/xsl/current/ for
14
     copyright and other information.
15

    
16
     ******************************************************************** -->
17

    
18
<doc:reference xmlns=""><info><title>HTML Processing Instruction Reference</title>
19
    <releaseinfo role="meta">
20
      $Id: pi.xsl 8394 2009-04-02 20:31:30Z mzjn $
21
    </releaseinfo>
22
  </info>
23
  <partintro xml:id="partintro">
24
    <title>Introduction</title>
25
    <para>This is generated reference documentation for all
26
      user-specifiable processing instructions (PIs) in the DocBook
27
      XSL stylesheets for HTML output.
28
      <note>
29
        <para>You add these PIs at particular points in a document to
30
          cause specific “exceptions” to formatting/output behavior. To
31
          make global changes in formatting/output behavior across an
32
          entire document, it’s better to do it by setting an
33
          appropriate stylesheet parameter (if there is one).</para>
34
      </note>
35
    </para>
36
  </partintro>
37
</doc:reference>
38

    
39
<!-- ==================================================================== -->
40

    
41
<doc:pi name="dbhtml_background-color" xmlns="">
42
  <refpurpose>Sets background color for an image</refpurpose>
43
  <refdescription>
44
    <para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or
45
      after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
46
      <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
47
      sibling to the element, to set a background color for the
48
      image.</para>
49
  </refdescription>
50
  <refsynopsisdiv>
51
    <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
52
  </refsynopsisdiv>
53
  <refparameter>
54
    <variablelist>
55
      <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
56
        <listitem>
57
          <para>An HTML color value</para>
58
        </listitem>
59
      </varlistentry>
60
    </variablelist>
61
  </refparameter>
62
  <refsee role="tcg">
63
    <para><link role="tcg"
64
        xlink:href="BGcolor.html"
65
        >Background color</link></para>
66
  </refsee>
67
</doc:pi>
68
<xsl:template name="pi.dbhtml_background-color">
69
  <xsl:param name="node" select="."/>
70
  <xsl:call-template name="dbhtml-attribute">
71
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
72
    <xsl:with-param name="attribute" select="'background-color'"/>
73
  </xsl:call-template>
74
</xsl:template>
75

    
76
<doc:pi name="dbhtml_bgcolor" xmlns="">
77
  <refpurpose>Sets background color on a CALS table row or table cell</refpurpose>
78
  <refdescription>
79
    <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row
80
      or cell to set a background color for that table row or cell.</para>
81
  </refdescription>
82
  <refsynopsisdiv>
83
    <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
84
  </refsynopsisdiv>
85
  <refparameter>
86
    <variablelist>
87
      <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
88
        <listitem>
89
          <para>An HTML color value</para>
90
        </listitem>
91
      </varlistentry>
92
    </variablelist>
93
  </refparameter>
94
  <refsee role="tcg">
95
    <para><link role="tcg"
96
        xlink:href="BGtableColor.html#CellBGColor"
97
        >Cell background color</link></para>
98
  </refsee>
99
</doc:pi>
100
<xsl:template name="pi.dbhtml_bgcolor">
101
  <xsl:param name="node" select="."/>
102
  <xsl:call-template name="dbhtml-attribute">
103
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
104
    <xsl:with-param name="attribute" select="'bgcolor'"/>
105
  </xsl:call-template>
106
</xsl:template>
107

    
108
<doc:pi name="dbhtml_cellpadding" xmlns="">
109
  <refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>
110
  <refdescription>
111
    <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
112
      CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
113
      for the HTML <literal>cellpadding</literal> attribute in the
114
      output HTML table.</para>
115
  </refdescription>
116
  <refsynopsisdiv>
117
    <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
118
  </refsynopsisdiv>
119
  <refparameter>
120
    <variablelist>
121
      <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
122
        <listitem>
123
          <para>Specifies the cellpadding</para>
124
        </listitem>
125
      </varlistentry>
126
    </variablelist>
127
  </refparameter>
128
  <refsee role="params">
129
    <para><parameter>html.cellpadding</parameter></para>
130
  </refsee>
131
  <refsee role="tcg">
132
    <para><link role="tcg"
133
        xlink:href="CellSpacing.html"
134
        >Cell spacing and cell padding</link>,
135
      <link role="tcg" xlink:href="QandAformat.html"
136
        >Q and A formatting</link></para>
137
  </refsee>
138
</doc:pi>
139
<xsl:template name="pi.dbhtml_cellpadding">
140
  <xsl:param name="node" select="."/>
141
  <xsl:call-template name="dbhtml-attribute">
142
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
143
    <xsl:with-param name="attribute" select="'cellpadding'"/>
144
  </xsl:call-template>
145
</xsl:template>
146

    
147
<doc:pi name="dbhtml_cellspacing" xmlns="">
148
  <refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>
149
  <refdescription>
150
    <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
151
      CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
152
      for the HTML <literal>cellspacing</literal> attribute in the
153
      output HTML table.</para>
154
  </refdescription>
155
  <refsynopsisdiv>
156
    <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
157
  </refsynopsisdiv>
158
  <refparameter>
159
    <variablelist>
160
      <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
161
        <listitem>
162
          <para>Specifies the cellspacing</para>
163
        </listitem>
164
      </varlistentry>
165
    </variablelist>
166
  </refparameter>
167
  <refsee role="params">
168
    <para><parameter>html.cellspacing</parameter></para>
169
  </refsee>
170
  <refsee role="tcg">
171
    <para><link role="tcg"
172
        xlink:href="CellSpacing.html"
173
        >Cell spacing and cell padding</link>,
174
      <link role="tcg"
175
        xlink:href="QandAformat.html"
176
        >Q and A formatting</link></para>
177
    </refsee>
178
</doc:pi>
179
<xsl:template name="pi.dbhtml_cellspacing">
180
  <xsl:param name="node" select="."/>
181
  <xsl:call-template name="dbhtml-attribute">
182
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
183
    <xsl:with-param name="attribute" select="'cellspacing'"/>
184
  </xsl:call-template>
185
</xsl:template>
186

    
187
<doc:pi name="dbhtml_class" xmlns="">
188
  <refpurpose>Set value of the class attribute for a CALS table row</refpurpose>
189
  <refdescription>
190
    <para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a
191
      <tag>row</tag> to specify a <literal>class</literal>
192
      attribute and value in the HTML output for that row.</para>
193
  </refdescription>
194
  <refsynopsisdiv>
195
    <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
196
  </refsynopsisdiv>
197
  <refparameter>
198
    <variablelist>
199
      <varlistentry><term>class="<replaceable>name</replaceable>"</term>
200
        <listitem>
201
          <para>Specifies the class name</para>
202
        </listitem>
203
      </varlistentry>
204
    </variablelist>
205
  </refparameter>
206
  <refsee role="tcg">
207
    <para><link role="tcg"
208
        xlink:href="CSSTableCells.html"
209
        >Table styles in HTML output</link></para>
210
  </refsee>
211
</doc:pi>
212
<xsl:template name="pi.dbhtml_class">
213
  <xsl:param name="node" select="."/>
214
  <xsl:call-template name="dbhtml-attribute">
215
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
216
    <xsl:with-param name="attribute" select="'class'"/>
217
  </xsl:call-template>
218
</xsl:template> 
219

    
220
<doc:pi name="dbhtml_dir" xmlns="">
221
  <refpurpose>Specifies a directory name in which to write files</refpurpose>
222
  <refdescription>
223
    <para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI
224
      as a child of a chunk source to cause the output of that
225
      chunk to be written to the specified directory; also, use it
226
      as a child of a <tag>mediaobject</tag> to specify a
227
      directory into which any long-description files for that
228
      <tag>mediaobject</tag> will be written.</para>
229
  </refdescription>
230
  <refsynopsisdiv>
231
    <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
232
  </refsynopsisdiv>
233
  <refparameter>
234
    <variablelist>
235
      <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
236
        <listitem>
237
          <para>Specifies the pathname for the directory</para>
238
        </listitem>
239
      </varlistentry>
240
    </variablelist>
241
  </refparameter>
242
  <refsee role="params">
243
    <para><parameter>base.dir</parameter></para>
244
  </refsee>
245
  <refsee role="tcg">
246
    <para><link role="tcg"
247
        xlink:href="Chunking.html#dbhtmlDirPI"
248
        >dbhtml dir processing instruction</link></para>
249
  </refsee>
250
</doc:pi>
251
<xsl:template name="pi.dbhtml_dir">
252
  <xsl:param name="node" select="."/>
253
  <xsl:call-template name="dbhtml-attribute">
254
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
255
    <xsl:with-param name="attribute" select="'dir'"/>
256
  </xsl:call-template>
257
</xsl:template>
258

    
259
<doc:pi name="dbhtml_filename" xmlns="">
260
  <refpurpose>Specifies a filename for a chunk</refpurpose>
261
  <refdescription>
262
    <para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
263
      PI as a child of a chunk source to specify a filename for
264
      the output file for that chunk.</para>
265
  </refdescription>
266
  <refsynopsisdiv>
267
    <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
268
  </refsynopsisdiv>
269
  <refparameter>
270
    <variablelist>
271
      <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
272
        <listitem>
273
          <para>Specifies the filename for the file</para>
274
        </listitem>
275
      </varlistentry>
276
    </variablelist>
277
  </refparameter>
278
  <refsee role="params">
279
    <para><parameter>use.id.as.filename</parameter></para>
280
  </refsee>
281
  <refsee role="tcg">
282
    <para><link role="tcg"
283
        xlink:href="Chunking.html#DbhtmlFilenames"
284
        >dbhtml filenames</link></para>
285
  </refsee>
286
</doc:pi>
287
<xsl:template name="pi.dbhtml_filename">
288
  <xsl:param name="node" select="."/>
289
  <xsl:call-template name="dbhtml-attribute">
290
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
291
    <xsl:with-param name="attribute" select="'filename'"/>
292
  </xsl:call-template>
293
</xsl:template>
294

    
295
<doc:pi name="dbhtml_funcsynopsis-style" xmlns="">
296
  <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
297
  <refdescription>
298
    <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
299
      a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
300
      to control the presentation style for output of all
301
      <tag>funcprototype</tag> instances within that funcsynopsis.</para>
302
  </refdescription>
303
  <refsynopsisdiv>
304
    <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
305
  </refsynopsisdiv>
306
  <refparameter>
307
    <variablelist>
308
      <varlistentry><term>funcsynopsis-style="kr"</term>
309
        <listitem>
310
          <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>
311
        </listitem>
312
      </varlistentry>
313
      <varlistentry><term>funcsynopsis-style="ansi"</term>
314
        <listitem>
315
          <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
316
        </listitem>
317
      </varlistentry>
318
    </variablelist>
319
  </refparameter>
320
  <refsee role="params">
321
    <para><parameter>funcsynopsis.style</parameter></para>
322
  </refsee>
323
</doc:pi>
324
<xsl:template name="pi.dbhtml_funcsynopsis-style">
325
  <xsl:param name="node" select="."/>
326
  <xsl:call-template name="dbhtml-attribute">
327
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
328
    <xsl:with-param name="attribute" select="'funcsynopsis-style'"/>
329
  </xsl:call-template>
330
</xsl:template>
331

    
332
<doc:pi name="dbhtml_img.src.path" xmlns="">
333
  <refpurpose>Specifies a path to the location of an image file</refpurpose>
334
  <refdescription>
335
    <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
336
      after an image (<tag>graphic</tag>,
337
      <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
338
      <tag>videodata</tag> element) as a sibling to the element,
339
      to specify a path to the location of the image; in HTML
340
      output, the value specified for the
341
      <code>img.src.path</code> attribute is prepended to the
342
      filename.</para>
343
  </refdescription>
344
  <refsynopsisdiv>
345
    <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
346
  </refsynopsisdiv>
347
  <refparameter>
348
    <variablelist>
349
      <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
350
        <listitem>
351
          <para>Specifies the pathname to prepend to the name of the image file</para>
352
        </listitem>
353
      </varlistentry>
354
    </variablelist>
355
  </refparameter>
356
  <refsee role="params">
357
    <para><parameter>img.src.path</parameter></para>
358
  </refsee>
359
  <refsee role="tcg">
360
    <para><link role="tcg"
361
        xlink:href="GraphicsLocations.html#UsingFileref"
362
        >Using fileref</link></para>
363
  </refsee>
364
</doc:pi>
365
<xsl:template name="pi.dbhtml_img.src.path">
366
  <xsl:param name="node" select="."/>
367
  <xsl:call-template name="dbhtml-attribute">
368
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
369
    <xsl:with-param name="attribute" select="'img.src.path'"/>
370
  </xsl:call-template>
371
</xsl:template>
372

    
373
<doc:pi name="dbhtml_label-width" xmlns="">
374
  <refpurpose>Specifies the label width for a qandaset</refpurpose>
375
  <refdescription>
376
    <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
377
      <tag>qandaset</tag> to specify the width of labels.</para>
378
  </refdescription>
379
  <refsynopsisdiv>
380
    <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
381
  </refsynopsisdiv>
382
  <refparameter>
383
    <variablelist>
384
      <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
385
        <listitem>
386
          <para>Specifies the label width (including units)</para>
387
        </listitem>
388
      </varlistentry>
389
    </variablelist>
390
  </refparameter>
391
  <refsee role="tcg">
392
    <para><link role="tcg"
393
        xlink:href="QandAformat.html"
394
        >Q and A formatting</link></para>
395
  </refsee>
396
</doc:pi>
397
<xsl:template name="pi.dbhtml_label-width">
398
  <xsl:param name="node" select="."/>
399
  <xsl:call-template name="dbhtml-attribute">
400
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
401
    <xsl:with-param name="attribute" select="'label-width'"/>
402
  </xsl:call-template>
403
</xsl:template> 
404

    
405
<doc:pi name="dbhtml_linenumbering.everyNth" xmlns="">
406
  <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
407
  <refdescription>
408
    <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
409
      of a “verbatim” element – <tag>programlisting</tag>,
410
      <tag>screen</tag>, <tag>synopsis</tag> — to specify
411
      the interval at which lines are numbered.</para>
412
  </refdescription>
413
  <refsynopsisdiv>
414
    <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
415
  </refsynopsisdiv>
416
  <refparameter>
417
    <variablelist>
418
      <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
419
        <listitem>
420
          <para>Specifies numbering interval; a number is output
421
            before every <replaceable>N</replaceable>th line</para>
422
        </listitem>
423
      </varlistentry>
424
    </variablelist>
425
  </refparameter>
426
  <refsee role="params">
427
    <para><parameter>linenumbering.everyNth</parameter></para>
428
  </refsee>
429
  <refsee role="tcg">
430
    <para><link role="tcg"
431
        xlink:href="AnnotateListing.html#LineNumbering"
432
        >Line numbering</link></para>
433
  </refsee>
434
</doc:pi>
435
<xsl:template name="pi.dbhtml_linenumbering.everyNth">
436
  <xsl:param name="node" select="."/>
437
  <xsl:call-template name="dbhtml-attribute">
438
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
439
    <xsl:with-param name="attribute" select="'linenumbering.everyNth'"/>
440
  </xsl:call-template>
441
</xsl:template>
442

    
443
<doc:pi name="dbhtml_linenumbering.separator" xmlns="">
444
  <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
445
  <refdescription>
446
    <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
447
      of a “verbatim” element – <tag>programlisting</tag>,
448
      <tag>screen</tag>, <tag>synopsis</tag> — to specify
449
      the separator text output between the line numbers and content.</para>
450
  </refdescription>
451
  <refsynopsisdiv>
452
    <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
453
  </refsynopsisdiv>
454
  <refparameter>
455
    <variablelist>
456
      <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
457
        <listitem>
458
          <para>Specifies the text (zero or more characters)</para>
459
        </listitem>
460
      </varlistentry>
461
    </variablelist>
462
  </refparameter>
463
  <refsee role="params">
464
    <para><parameter>linenumbering.separator</parameter></para>
465
  </refsee>
466
  <refsee role="tcg">
467
    <para><link role="tcg"
468
        xlink:href="AnnotateListing.html#LineNumbering"
469
        >Line numbering</link></para>
470
  </refsee>
471
</doc:pi>
472
<xsl:template name="pi.dbhtml_linenumbering.separator">
473
  <xsl:param name="node" select="."/>
474
  <xsl:call-template name="dbhtml-attribute">
475
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
476
    <xsl:with-param name="attribute" select="'linenumbering.separator'"/>
477
  </xsl:call-template>
478
</xsl:template>
479

    
480
<doc:pi name="dbhtml_linenumbering.width" xmlns="">
481
  <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
482
  <refdescription>
483
    <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
484
      of a “verbatim” element – <tag>programlisting</tag>,
485
      <tag>screen</tag>, <tag>synopsis</tag> — to specify
486
      the width set aside for line numbers.</para>
487
  </refdescription>
488
  <refsynopsisdiv>
489
    <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
490
  </refsynopsisdiv>
491
  <refparameter>
492
    <variablelist>
493
      <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
494
        <listitem>
495
          <para>Specifies the width (inluding units)</para>
496
        </listitem>
497
      </varlistentry>
498
    </variablelist>
499
  </refparameter>
500
  <refsee role="params">
501
    <para><parameter>linenumbering.width</parameter></para>
502
  </refsee>
503
  <refsee role="tcg">
504
    <para><link role="tcg"
505
        xlink:href="AnnotateListing.html#LineNumbering"
506
        >Line numbering</link></para>
507
  </refsee>
508
</doc:pi>
509
<xsl:template name="pi.dbhtml_linenumbering.width">
510
  <xsl:param name="node" select="."/>
511
  <xsl:call-template name="dbhtml-attribute">
512
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
513
    <xsl:with-param name="attribute" select="'linenumbering.width'"/>
514
  </xsl:call-template>
515
</xsl:template>
516

    
517
<doc:pi name="dbhtml_list-presentation" xmlns="">
518
  <refpurpose>Specifies presentation style for a variablelist or
519
    segmentedlist</refpurpose>
520
  <refdescription>
521
    <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
522
      a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
523
      control the presentation style for the list (to cause it, for
524
      example, to be displayed as a table).</para>
525
  </refdescription>
526
  <refsynopsisdiv>
527
    <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
528
  </refsynopsisdiv>
529
  <refparameter>
530
    <variablelist>
531
      <varlistentry><term>list-presentation="list"</term>
532
        <listitem>
533
          <para>Displays the list as a list</para>
534
        </listitem>
535
      </varlistentry>
536
      <varlistentry><term>list-presentation="table"</term>
537
        <listitem>
538
          <para>Displays the list as a table</para>
539
        </listitem>
540
      </varlistentry>
541
    </variablelist>
542
  </refparameter>
543
  <refsee role="params">
544
    <itemizedlist>
545
      <listitem>
546
        <para><parameter>variablelist.as.table</parameter></para>
547
      </listitem>
548
      <listitem>
549
        <para><parameter>segmentedlist.as.table</parameter></para>
550
      </listitem>
551
    </itemizedlist>
552
  </refsee>
553
  <refsee role="tcg">
554
    <para><link role="tcg"
555
        xlink:href="Variablelists.html#VarListFormatting"
556
        >Variable list formatting in HTML</link></para>
557
  </refsee>
558
</doc:pi>
559
<xsl:template name="pi.dbhtml_list-presentation">
560
  <xsl:param name="node" select="."/>
561
  <xsl:call-template name="dbhtml-attribute">
562
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
563
    <xsl:with-param name="attribute" select="'list-presentation'"/>
564
  </xsl:call-template>
565
</xsl:template>
566

    
567
<doc:pi name="dbhtml_list-width" xmlns="">
568
  <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
569
  <refdescription>
570
    <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
571
      <tag>variablelist</tag> or a <tag>simplelist</tag> presented
572
      as a table, to specify the output width.</para>
573
  </refdescription>
574
  <refsynopsisdiv>
575
    <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
576
  </refsynopsisdiv>
577
  <refparameter>
578
    <variablelist>
579
      <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
580
        <listitem>
581
          <para>Specifies the output width (including units)</para>
582
        </listitem>
583
      </varlistentry>
584
    </variablelist>
585
  </refparameter>
586
  <refsee role="tcg">
587
    <para><link role="tcg"
588
        xlink:href="Variablelists.html#VarListFormatting"
589
        >Variable list formatting in HTML</link></para>
590
  </refsee>
591
</doc:pi>
592
<xsl:template name="pi.dbhtml_list-width">
593
  <xsl:param name="node" select="."/>
594
  <xsl:call-template name="dbhtml-attribute">
595
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
596
    <xsl:with-param name="attribute" select="'list-width'"/>
597
  </xsl:call-template>
598
</xsl:template>
599

    
600
<doc:pi name="dbhtml_row-height" xmlns="">
601
  <refpurpose>Specifies the height for a CALS table row</refpurpose>
602
  <refdescription>
603
    <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
604
      <tag>row</tag> to specify the height of the row.</para>
605
  </refdescription>
606
  <refsynopsisdiv>
607
    <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
608
  </refsynopsisdiv>
609
  <refparameter>
610
    <variablelist>
611
      <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
612
        <listitem>
613
          <para>Specifies the row height (including units)</para>
614
        </listitem>
615
      </varlistentry>
616
    </variablelist>
617
  </refparameter>
618
  <refsee role="tcg">
619
    <para><link role="tcg"
620
        xlink:href="RowHeight.html"
621
        >Row height</link></para>
622
  </refsee>
623
</doc:pi>
624
<xsl:template name="pi.dbhtml_row-height">
625
  <xsl:param name="node" select="."/>
626
  <xsl:call-template name="dbhtml-attribute">
627
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
628
    <xsl:with-param name="attribute" select="'row-height'"/>
629
  </xsl:call-template>
630
</xsl:template> 
631

    
632
<doc:pi name="dbhtml_start" xmlns="">
633
  <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
634
  <refdescription>
635
    <para><emphasis>This PI is obsolete</emphasis>. The intent of
636
      this PI was to provide a means for setting a specific starting
637
      number for an ordered list. Instead of this PI, set a value
638
      for the <literal>override</literal> attribute on the first
639
      <tag>listitem</tag> in the list; that will have the same
640
      effect as what this PI was intended for.</para>
641
  </refdescription>
642
  <refsynopsisdiv>
643
    <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
644
  </refsynopsisdiv>
645
  <refparameter>
646
    <variablelist>
647
      <varlistentry><term>start="<replaceable>character</replaceable>"</term>
648
        <listitem>
649
          <para>Specifies the character to use as the starting
650
            number; use 0-9, a-z, A-Z, or lowercase or uppercase
651
            Roman numerals</para>
652
        </listitem>
653
      </varlistentry>
654
    </variablelist>
655
  </refparameter>
656
  <refsee role="tcg">
657
    <para><link role="tcg"
658
        xlink:href="Orderedlists.html#ListStartNum"
659
        >List starting number</link></para>
660
  </refsee>
661
</doc:pi>
662
<xsl:template name="pi.dbhtml_start">
663
  <xsl:param name="node" select="."/>
664
  <xsl:call-template name="pi-attribute">
665
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
666
    <xsl:with-param name="attribute" select="'start'"/>
667
  </xsl:call-template>
668
</xsl:template>
669

    
670
  <doc:pi name="dbhtml_stop-chunking" xmlns="">
671
	<refpurpose>Do not chunk any descendants of this element.</refpurpose>
672
	<refdescription>
673
    <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:
674
<programlisting><![CDATA[<section>
675
<title>Configuring pencil</title>
676
<?dbhtml stop-chunking?>
677

    
678
...
679

    
680
</section>]]></programlisting>
681
</para>
682
  </refdescription>
683
  <refsynopsisdiv>
684
    <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
685
  </refsynopsisdiv>	
686
  <refsee role="tcg">
687
    <para><link role="tcg"
688
        xlink:href="Chunking.html"
689
        >Chunking into multiple HTML files</link></para>
690
  </refsee>
691
  </doc:pi>
692
  <!-- The code that handles the stop-chunking pi is in chunk-common.xsl -->
693

    
694
<doc:pi name="dbhtml_table-summary" xmlns="">
695
  <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
696
  <refdescription>
697
    <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
698
      a CALS <tag>table</tag>, <tag>variablelist</tag>,
699
      <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
700
      the text for the HTML <literal>summary</literal> attribute
701
      in the output HTML table.</para>
702
  </refdescription>
703
  <refsynopsisdiv>
704
    <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
705
  </refsynopsisdiv>
706
  <refparameter>
707
    <variablelist>
708
      <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
709
        <listitem>
710
          <para>Specifies the summary text (zero or more characters)</para>
711
        </listitem>
712
      </varlistentry>
713
    </variablelist>
714
  </refparameter>
715
  <refsee role="tcg">
716
    <para><link role="tcg"
717
        xlink:href="Variablelists.html#VarListFormatting"
718
        >Variable list formatting in HTML</link>,
719
      <link role="tcg" xlink:href="TableSummary.html"
720
        >Table summary text</link></para>
721
  </refsee>
722
</doc:pi>
723
<xsl:template name="pi.dbhtml_table-summary">
724
  <xsl:param name="node" select="."/>
725
  <xsl:call-template name="dbhtml-attribute">
726
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
727
    <xsl:with-param name="attribute" select="'table-summary'"/>
728
  </xsl:call-template>
729
</xsl:template>
730

    
731
<doc:pi name="dbhtml_table-width" xmlns="">
732
  <refpurpose>Specifies the width for a CALS table</refpurpose>
733
  <refdescription>
734
    <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
735
      CALS <tag>table</tag> to specify the width of the table in
736
      output.</para>
737
  </refdescription>
738
  <refsynopsisdiv>
739
    <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
740
  </refsynopsisdiv>
741
  <refparameter>
742
    <variablelist>
743
      <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
744
        <listitem>
745
          <para>Specifies the table width (including units or as a percentage)</para>
746
        </listitem>
747
      </varlistentry>
748
    </variablelist>
749
  </refparameter>
750
  <refsee role="params">
751
    <para><parameter>default.table.width</parameter></para>
752
  </refsee>
753
  <refsee role="tcg">
754
    <para><link role="tcg"
755
        xlink:href="Tables.html#TableWidth"
756
        >Table width</link></para>
757
  </refsee>
758
</doc:pi>
759
<xsl:template name="pi.dbhtml_table-width">
760
  <xsl:param name="node" select="."/>
761
  <xsl:call-template name="dbhtml-attribute">
762
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
763
    <xsl:with-param name="attribute" select="'table-width'"/>
764
  </xsl:call-template>
765
</xsl:template>
766

    
767
<doc:pi name="dbhtml_term-presentation" xmlns="">
768
  <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
769
  <refdescription>
770
    <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
771
      of a <tag>variablelist</tag> to set character formatting for
772
      the <tag>term</tag> output of the list.</para>
773
  </refdescription>
774
  <refsynopsisdiv>
775
    <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
776
  </refsynopsisdiv>
777
  <refparameter>
778
    <variablelist>
779
      <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
780
        <listitem>
781
          <para>Specifies that terms are displayed in bold</para>
782
        </listitem>
783
      </varlistentry>
784
      <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
785
        <listitem>
786
          <para>Specifies that terms are displayed in italic</para>
787
        </listitem>
788
      </varlistentry>
789
      <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
790
        <listitem>
791
          <para>Specifies that terms are displayed in bold-italic</para>
792
        </listitem>
793
      </varlistentry>
794
    </variablelist>
795
  </refparameter>
796
  <refsee role="tcg">
797
    <para><link role="tcg"
798
        xlink:href="Variablelists.html#VarListFormatting"
799
        >Variable list formatting in HTML</link></para>
800
  </refsee>
801
</doc:pi>
802
<xsl:template name="pi.dbhtml_term-presentation">
803
  <xsl:param name="node" select="."/>
804
  <xsl:call-template name="dbhtml-attribute">
805
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
806
    <xsl:with-param name="attribute" select="'term-presentation'"/>
807
  </xsl:call-template>
808
</xsl:template>
809

    
810
<doc:pi name="dbhtml_term-separator" xmlns="">
811
  <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
812
  <refdescription>
813
    <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
814
      of a <tag>variablelist</tag> to specify the separator text
815
      among <tag>term</tag> instances.</para>
816
  </refdescription>
817
  <refsynopsisdiv>
818
    <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
819
  </refsynopsisdiv>
820
  <refparameter>
821
    <variablelist>
822
      <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
823
        <listitem>
824
          <para>Specifies the text (zero or more characters)</para>
825
        </listitem>
826
      </varlistentry>
827
    </variablelist>
828
  </refparameter>
829
  <refsee role="params">
830
    <para><parameter>variablelist.term.separator</parameter></para>
831
  </refsee>
832
  <refsee role="tcg">
833
    <para><link role="tcg"
834
        xlink:href="Variablelists.html#VarListFormatting"
835
        >Variable list formatting in HTML</link></para>
836
  </refsee>
837
</doc:pi>
838
<xsl:template name="pi.dbhtml_term-separator">
839
  <xsl:param name="node" select="."/>
840
  <xsl:call-template name="dbhtml-attribute">
841
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
842
    <xsl:with-param name="attribute" select="'term-separator'"/>
843
  </xsl:call-template>
844
</xsl:template>
845

    
846
<doc:pi name="dbhtml_term-width" xmlns="">
847
  <refpurpose>Specifies the term width for a variablelist</refpurpose>
848
  <refdescription>
849
    <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
850
      <tag>variablelist</tag> to specify the width for
851
      <tag>term</tag> output.</para>
852
  </refdescription>
853
  <refsynopsisdiv>
854
    <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
855
  </refsynopsisdiv>
856
  <refparameter>
857
    <variablelist>
858
      <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
859
        <listitem>
860
          <para>Specifies the term width (including units)</para>
861
        </listitem>
862
      </varlistentry>
863
    </variablelist>
864
  </refparameter>
865
  <refsee role="tcg">
866
    <para><link role="tcg"
867
        xlink:href="Variablelists.html#VarListFormatting"
868
        >Variable list formatting in HTML</link></para>
869
  </refsee>
870
</doc:pi>
871
<xsl:template name="pi.dbhtml_term-width">
872
  <xsl:param name="node" select="."/>
873
  <xsl:call-template name="dbhtml-attribute">
874
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
875
    <xsl:with-param name="attribute" select="'term-width'"/>
876
  </xsl:call-template>
877
</xsl:template>
878

    
879
<doc:pi name="dbhtml_toc" xmlns="">
880
  <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
881
  <refdescription>
882
    <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
883
      <tag>qandaset</tag> to specify whether a table of contents
884
      (TOC) is generated for the <tag>qandaset</tag>.</para>
885
  </refdescription>
886
  <refsynopsisdiv>
887
    <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
888
  </refsynopsisdiv>
889
  <refparameter>
890
    <variablelist>
891
      <varlistentry><term>toc="0"</term>
892
        <listitem>
893
          <para>If zero, no TOC is generated</para>
894
        </listitem>
895
      </varlistentry>
896
      <varlistentry><term>toc="1"</term>
897
        <listitem>
898
          <para>If <code>1</code> (or any non-zero value),
899
            a TOC is generated</para>
900
        </listitem>
901
      </varlistentry>
902
    </variablelist>
903
  </refparameter>
904
  <refsee role="tcg">
905
    <para><link role="tcg"
906
        xlink:href="QandAtoc.html"
907
        >Q and A list of questions</link>,
908
      <link role="tcg"
909
        xlink:href="QandAformat.html"
910
        >Q and A formatting</link></para>
911
  </refsee>
912
</doc:pi>
913
<xsl:template name="pi.dbhtml_toc">
914
  <xsl:param name="node" select="."/>
915
  <xsl:call-template name="dbhtml-attribute">
916
    <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
917
    <xsl:with-param name="attribute" select="'toc'"/>
918
  </xsl:call-template>
919
</xsl:template>
920

    
921
<doc:pi name="dbcmdlist" xmlns="">
922
  <refpurpose>Generates a hyperlinked list of commands</refpurpose>
923
  <refdescription>
924
    <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
925
      element (for example, <tag>refsynopsisdiv</tag>) containing multiple
926
      <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
927
      “command list” will be generated at the top of output for that
928
      element, enabling users to quickly jump
929
      to each command synopsis.</para>
930
  </refdescription>
931
  <refsynopsisdiv>
932
    <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
933
  </refsynopsisdiv>
934
  <refparameter>
935
    <para>[No parameters]</para>
936
  </refparameter>
937
</doc:pi>
938
<xsl:template name="pi.dbcmdlist">
939
  <xsl:variable name="cmdsynopses" select="..//cmdsynopsis"/>
940
  <xsl:if test="count($cmdsynopses)&lt;1">
941
    <xsl:message><xsl:text>No cmdsynopsis elements matched dbcmdlist PI, perhaps it's nested too deep?</xsl:text>
942
    </xsl:message>
943
  </xsl:if>
944
  <dl>
945
    <xsl:call-template name="process.cmdsynopsis.list">
946
      <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/>
947
    </xsl:call-template>
948
  </dl>
949
</xsl:template>
950

    
951
<doc:pi name="dbfunclist" xmlns="">
952
  <refpurpose>Generates a hyperlinked list of functions</refpurpose>
953
  <refdescription>
954
    <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
955
      element (for example, <tag>refsynopsisdiv</tag>) containing multiple
956
      <tag>funcsynopsis</tag> instances; a hyperlinked
957
      navigational “function list” will be generated at the top of
958
      output for that element, enabling users to quickly
959
      jump to to each function synopsis.</para>
960
  </refdescription>
961
  <refsynopsisdiv>
962
    <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
963
  </refsynopsisdiv>
964
  <refparameter>
965
    <para>[No parameters]</para>
966
  </refparameter>
967
</doc:pi>
968
<xsl:template name="pi.dbfunclist">
969
  <xsl:variable name="funcsynopses" select="..//funcsynopsis"/>
970
  <xsl:if test="count($funcsynopses)&lt;1">
971
    <xsl:message><xsl:text>No funcsynopsis elements matched dbfunclist PI, perhaps it's nested too deep?</xsl:text>
972
    </xsl:message>
973
  </xsl:if>
974
  <dl>
975
    <xsl:call-template name="process.funcsynopsis.list">
976
      <xsl:with-param name="funcsynopses" select="$funcsynopses"/>
977
    </xsl:call-template>
978
  </dl>
979
</xsl:template>
980

    
981
<doc:pi name="dbhtml-include_href" xmlns="">
982
  <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
983
  <refdescription>
984
    <para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a
985
      document to cause the contents of the file referenced by the
986
      <code>href</code> pseudo-attribute to be copied/inserted “as
987
      is” into your HTML output at the point in document order
988
      where the PI occurs in the source.</para>
989
    <note>
990
      <para>The referenced file may contain plain text (as long as
991
        it is “wrapped” in an <tag>html</tag> element — see the
992
        note below) or markup in any arbitrary vocabulary,
993
        including HTML — but it must conform to XML
994
        well-formedness constraints (because the feature in XSLT
995
        1.0 for opening external files, the
996
        <function>document()</function> function, can only handle
997
        files that meet XML well-formedness constraints).</para>
998
      <para>Among other things, XML well-formedness constraints
999
        require a document to have <emphasis>a single root
1000
          element</emphasis>. So if the content you want to
1001
        include is plain text or is markup that does
1002
        <emphasis>not</emphasis> have a single root element,
1003
        <emphasis role="strong">wrap the content in an
1004
          <tag>html</tag> element</emphasis>. The stylesheets will
1005
        strip out that surrounding <tag>html</tag> “wrapper” when
1006
        they find it, leaving just the content you want to
1007
        insert.</para>
1008
    </note>
1009
  </refdescription>
1010
  <refsynopsisdiv>
1011
    <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
1012
  </refsynopsisdiv>
1013
  <refparameter>
1014
    <variablelist>
1015
      <varlistentry><term>href="<replaceable>URI</replaceable>"</term>
1016
        <listitem>
1017
          <para>Specifies the URI for the file to include; the URI
1018
            can be, for example, a remote <literal>http:</literal>
1019
            URI, or a local filesystem <literal>file:</literal>
1020
            URI</para>
1021
        </listitem>
1022
      </varlistentry>
1023
    </variablelist>
1024
  </refparameter>
1025
  <refsee role="params">
1026
    <para><parameter>textinsert.extension</parameter></para>
1027
  </refsee>
1028
  <refsee role="tcg">
1029
    <para><link role="tcg"
1030
        xlink:href="InsertExtHtml.html"
1031
        >Inserting external HTML code</link>,
1032
      <link role="tcg"
1033
        xlink:href="ExternalCode.html"
1034
        >External code files</link></para>
1035
  </refsee>
1036
</doc:pi>
1037
<xsl:template name="pi.dbhtml-include">
1038
  <xsl:param name="href">
1039
    <xsl:call-template name="dbhtml-attribute">
1040
      <xsl:with-param name="pis" select="."/>
1041
      <xsl:with-param name="attribute">href</xsl:with-param>
1042
    </xsl:call-template>
1043
  </xsl:param>
1044
  <xsl:choose>
1045
    <xsl:when test="$href != ''">
1046
      <xsl:variable name="content" select="document($href,/)"/>
1047
      <xsl:choose>
1048
        <xsl:when test="$content/*">
1049
          <xsl:choose>
1050
            <xsl:when test="$content/*[1][self::html]">
1051
              <!-- include just the children of html wrapper -->
1052
              <xsl:copy-of select="$content/*[1]/node()"/>
1053
            </xsl:when>
1054
            <xsl:otherwise>
1055
              <xsl:copy-of select="$content"/>
1056
            </xsl:otherwise>
1057
          </xsl:choose>
1058
        </xsl:when>
1059
        <xsl:otherwise>
1060
          <xsl:message>
1061
            <xsl:text>ERROR: dbhtml-include processing instruction </xsl:text>
1062
            <xsl:text>href has no content.</xsl:text>
1063
          </xsl:message>
1064
        </xsl:otherwise>
1065
      </xsl:choose>
1066
    </xsl:when>
1067
    <xsl:otherwise>
1068
      <xsl:message>
1069
        <xsl:text>ERROR: dbhtml-include processing instruction has </xsl:text>
1070
        <xsl:text>missing or empty href value.</xsl:text>
1071
      </xsl:message>
1072
    </xsl:otherwise>
1073
  </xsl:choose>
1074
</xsl:template>
1075

    
1076
<!-- There are two templates matching this PI in htmlhelp-common.xsl -->
1077
<doc:pi name="dbhh" xmlns="">
1078
  <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
1079
  <refdescription>
1080
    <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
1081
      that should be used as targets for context-sensitive help requests.</para>
1082
  </refdescription>
1083
  <refsynopsisdiv>
1084
    <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
1085
  </refsynopsisdiv>
1086
  <refparameter>
1087
    <variablelist>
1088
      <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
1089
        <listitem>
1090
          <para>Specifies a unique string constant that identifies a help topic</para>
1091
        </listitem>
1092
      </varlistentry>
1093
      <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
1094
        <listitem>
1095
          <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
1096
        </listitem>
1097
      </varlistentry>
1098
    </variablelist>
1099
  </refparameter>
1100
  <refsee role="tcg">
1101
    <para><link role="tcg"
1102
        xlink:href="HtmlHelp.html#HHContextHelp"
1103
        >Context-sensitive help</link></para>
1104
  </refsee>
1105
</doc:pi>
1106

    
1107
<!-- ==================================================================== -->
1108

    
1109
<xsl:template name="dbhtml-attribute">
1110
  <!-- * dbhtml-attribute is an interal utility template for retrieving -->
1111
  <!-- * pseudo-attributes/parameters from PIs -->
1112
  <xsl:param name="pis" select="processing-instruction('dbhtml')"/>
1113
  <xsl:param name="attribute">filename</xsl:param>
1114
  <xsl:call-template name="pi-attribute">
1115
    <xsl:with-param name="pis" select="$pis"/>
1116
    <xsl:with-param name="attribute" select="$attribute"/>
1117
  </xsl:call-template>
1118
</xsl:template>
1119

    
1120
<!-- ==================================================================== -->
1121

    
1122
<xsl:template match="processing-instruction()">
1123
</xsl:template>
1124

    
1125
<xsl:template match="processing-instruction('dbhtml')">
1126
  <!-- nop -->
1127
</xsl:template>
1128

    
1129
<!-- ==================================================================== -->
1130

    
1131
<xsl:template match="processing-instruction('dbcmdlist')">
1132
  <xsl:call-template name="pi.dbcmdlist"/>
1133
</xsl:template>
1134
<xsl:template name="process.cmdsynopsis.list">
1135
  <xsl:param name="cmdsynopses"/><!-- empty node list by default -->
1136
  <xsl:param name="count" select="1"/>
1137

    
1138
  <xsl:choose>
1139
    <xsl:when test="$count>count($cmdsynopses)"></xsl:when>
1140
    <xsl:otherwise>
1141
      <xsl:variable name="cmdsyn" select="$cmdsynopses[$count]"/>
1142

    
1143
       <dt>
1144
       <a>
1145
         <xsl:attribute name="href">
1146
           <xsl:text>#</xsl:text>
1147
           <xsl:call-template name="object.id">
1148
             <xsl:with-param name="object" select="$cmdsyn"/>
1149
           </xsl:call-template>
1150
         </xsl:attribute>
1151

    
1152
         <xsl:choose>
1153
           <xsl:when test="$cmdsyn/@xreflabel">
1154
             <xsl:call-template name="xref.xreflabel">
1155
               <xsl:with-param name="target" select="$cmdsyn"/>
1156
             </xsl:call-template>
1157
           </xsl:when>
1158
           <xsl:otherwise>
1159
             <xsl:apply-templates select="$cmdsyn" mode="xref-to">
1160
               <xsl:with-param name="target" select="$cmdsyn"/>
1161
             </xsl:apply-templates>
1162
           </xsl:otherwise>
1163
         </xsl:choose>
1164
       </a>
1165
       </dt>
1166

    
1167
        <xsl:call-template name="process.cmdsynopsis.list">
1168
          <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/>
1169
          <xsl:with-param name="count" select="$count+1"/>
1170
        </xsl:call-template>
1171
      </xsl:otherwise>
1172
    </xsl:choose>
1173
</xsl:template>
1174

    
1175
<!-- ==================================================================== -->
1176

    
1177
<xsl:template match="processing-instruction('dbfunclist')">
1178
  <xsl:call-template name="pi.dbfunclist"/>
1179
</xsl:template>
1180
<xsl:template name="process.funcsynopsis.list">
1181
  <xsl:param name="funcsynopses"/><!-- empty node list by default -->
1182
  <xsl:param name="count" select="1"/>
1183

    
1184
  <xsl:choose>
1185
    <xsl:when test="$count>count($funcsynopses)"></xsl:when>
1186
    <xsl:otherwise>
1187
      <xsl:variable name="cmdsyn" select="$funcsynopses[$count]"/>
1188

    
1189
       <dt>
1190
       <a>
1191
         <xsl:attribute name="href">
1192
           <xsl:text>#</xsl:text>
1193
           <xsl:call-template name="object.id">
1194
             <xsl:with-param name="object" select="$cmdsyn"/>
1195
           </xsl:call-template>
1196
         </xsl:attribute>
1197

    
1198
         <xsl:choose>
1199
           <xsl:when test="$cmdsyn/@xreflabel">
1200
             <xsl:call-template name="xref.xreflabel">
1201
               <xsl:with-param name="target" select="$cmdsyn"/>
1202
             </xsl:call-template>
1203
           </xsl:when>
1204
           <xsl:otherwise>
1205
              <xsl:apply-templates select="$cmdsyn" mode="xref-to">
1206
                <xsl:with-param name="target" select="$cmdsyn"/>
1207
              </xsl:apply-templates>
1208
           </xsl:otherwise>
1209
         </xsl:choose>
1210
       </a>
1211
       </dt>
1212

    
1213
        <xsl:call-template name="process.funcsynopsis.list">
1214
          <xsl:with-param name="funcsynopses" select="$funcsynopses"/>
1215
          <xsl:with-param name="count" select="$count+1"/>
1216
        </xsl:call-template>
1217
      </xsl:otherwise>
1218
    </xsl:choose>
1219
</xsl:template>
1220

    
1221
<!-- ==================================================================== -->
1222

    
1223
<xsl:template match="processing-instruction('dbhtml-include')">
1224
  <xsl:call-template name="pi.dbhtml-include"/>
1225
</xsl:template>
1226

    
1227
<!-- ==================================================================== -->
1228

    
1229
<xsl:template name="dbhtml-dir">
1230
  <xsl:param name="context" select="."/>
1231
  <!-- directories are now inherited from previous levels -->
1232
  <xsl:variable name="ppath">
1233
    <xsl:if test="$context/parent::*">
1234
      <xsl:call-template name="dbhtml-dir">
1235
        <xsl:with-param name="context" select="$context/parent::*"/>
1236
      </xsl:call-template>
1237
    </xsl:if>
1238
  </xsl:variable>
1239
  <xsl:variable name="path">
1240
    <xsl:call-template name="pi.dbhtml_dir">
1241
      <xsl:with-param name="node" select="$context"/>
1242
    </xsl:call-template>
1243
  </xsl:variable>
1244
  <xsl:choose>
1245
    <xsl:when test="$path = ''">
1246
      <xsl:if test="$ppath != ''">
1247
        <xsl:value-of select="$ppath"/>
1248
      </xsl:if>
1249
    </xsl:when>
1250
    <xsl:otherwise>
1251
      <xsl:if test="$ppath != ''">
1252
        <xsl:value-of select="$ppath"/>
1253
        <xsl:if test="substring($ppath, string-length($ppath), 1) != '/'">
1254
          <xsl:text>/</xsl:text>
1255
        </xsl:if>
1256
      </xsl:if>
1257
      <xsl:value-of select="$path"/>
1258
      <xsl:text>/</xsl:text>
1259
    </xsl:otherwise>
1260
  </xsl:choose>
1261
</xsl:template>
1262

    
1263
</xsl:stylesheet>
(28-28/39)