source: stylesheets/lfs-xsl/docbook-xsl-1.78.1/html/pi.xsl@ 15c7d39

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 7.5 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since 15c7d39 was 15c7d39, checked in by Matthew Burgess <matthew@…>, 11 years ago

Update stylesheets to docbook-xsl-1.78.1.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@10355 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 48.0 KB
Line 
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 9022 2011-07-14 19:21:36Z bobstayton $
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 9022 2011-07-14 19:21:36Z bobstayton $
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
230<para>The output directory specification is inherited by all
231chunks of the descendants of the element. If descendants need
232to go to a different directory, then add another
233<tag class="xmlpi">dbhtml dir</tag> processing
234instruction as a child of the source element
235for that chunk, and specify the path relative to the
236ancestor path.</para>
237
238<para>For example, to put most chunk files into
239<filename class="directory">shared</filename>
240but one chapter into
241<filename class="directory">exception</filename>
242at the same level, use:</para>
243
244<programlisting><![CDATA[<book>
245 <?dbhtml dir="shared"?>
246 ...
247 <chapter>
248 <?dbhtml dir="../exception"?>
249 </chapter>
250</book>
251]]></programlisting>
252
253
254 </refdescription>
255 <refsynopsisdiv>
256 <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
257 </refsynopsisdiv>
258 <refparameter>
259 <variablelist>
260 <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
261 <listitem>
262 <para>Specifies the pathname for the directory</para>
263 </listitem>
264 </varlistentry>
265 </variablelist>
266 </refparameter>
267 <refsee role="params">
268 <para><parameter>base.dir</parameter></para>
269 </refsee>
270 <refsee role="tcg">
271 <para><link role="tcg"
272 xlink:href="Chunking.html#dbhtmlDirPI"
273 >dbhtml dir processing instruction</link></para>
274 </refsee>
275</doc:pi>
276<xsl:template name="pi.dbhtml_dir">
277 <xsl:param name="node" select="."/>
278 <xsl:call-template name="dbhtml-attribute">
279 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
280 <xsl:with-param name="attribute" select="'dir'"/>
281 </xsl:call-template>
282</xsl:template>
283
284<doc:pi name="dbhtml_filename" xmlns="">
285 <refpurpose>Specifies a filename for a chunk</refpurpose>
286 <refdescription>
287<para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
288 PI as a child of a chunk source to specify a filename for
289 the output file for that chunk. Include the filename suffix.</para>
290
291<para>You cannot include a directory path in the filename value,
292or your links may not work. Add a
293<tag class="xmlpi">dbhtml dir</tag> processing instruction
294to specify the output directory. You can also combine the two
295specifications in one processing instruction:
296<tag class="xmlpi">dbhtml dir="mydir" filename="myfile.html"</tag>.</para>
297
298 </refdescription>
299 <refsynopsisdiv>
300 <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
301 </refsynopsisdiv>
302 <refparameter>
303 <variablelist>
304 <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
305 <listitem>
306 <para>Specifies the filename for the file</para>
307 </listitem>
308 </varlistentry>
309 </variablelist>
310 </refparameter>
311 <refsee role="params">
312 <para><parameter>use.id.as.filename</parameter></para>
313 </refsee>
314 <refsee role="tcg">
315 <para><link role="tcg"
316 xlink:href="Chunking.html#DbhtmlFilenames"
317 >dbhtml filenames</link></para>
318 </refsee>
319</doc:pi>
320<xsl:template name="pi.dbhtml_filename">
321 <xsl:param name="node" select="."/>
322 <xsl:call-template name="dbhtml-attribute">
323 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
324 <xsl:with-param name="attribute" select="'filename'"/>
325 </xsl:call-template>
326</xsl:template>
327
328<doc:pi name="dbhtml_funcsynopsis-style" xmlns="">
329 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
330 <refdescription>
331 <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
332 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
333 to control the presentation style for output of all
334 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
335 </refdescription>
336 <refsynopsisdiv>
337 <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
338 </refsynopsisdiv>
339 <refparameter>
340 <variablelist>
341 <varlistentry><term>funcsynopsis-style="kr"</term>
342 <listitem>
343 <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>
344 </listitem>
345 </varlistentry>
346 <varlistentry><term>funcsynopsis-style="ansi"</term>
347 <listitem>
348 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
349 </listitem>
350 </varlistentry>
351 </variablelist>
352 </refparameter>
353 <refsee role="params">
354 <para><parameter>funcsynopsis.style</parameter></para>
355 </refsee>
356</doc:pi>
357<xsl:template name="pi.dbhtml_funcsynopsis-style">
358 <xsl:param name="node" select="."/>
359 <xsl:call-template name="dbhtml-attribute">
360 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
361 <xsl:with-param name="attribute" select="'funcsynopsis-style'"/>
362 </xsl:call-template>
363</xsl:template>
364
365<doc:pi name="dbhtml_img.src.path" xmlns="">
366 <refpurpose>Specifies a path to the location of an image file</refpurpose>
367 <refdescription>
368 <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
369 after an image (<tag>graphic</tag>,
370 <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
371 <tag>videodata</tag> element) as a sibling to the element,
372 to specify a path to the location of the image; in HTML
373 output, the value specified for the
374 <code>img.src.path</code> attribute is prepended to the
375 filename.</para>
376 </refdescription>
377 <refsynopsisdiv>
378 <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
379 </refsynopsisdiv>
380 <refparameter>
381 <variablelist>
382 <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
383 <listitem>
384 <para>Specifies the pathname to prepend to the name of the image file</para>
385 </listitem>
386 </varlistentry>
387 </variablelist>
388 </refparameter>
389 <refsee role="params">
390 <para><parameter>img.src.path</parameter></para>
391 </refsee>
392 <refsee role="tcg">
393 <para><link role="tcg"
394 xlink:href="GraphicsLocations.html#UsingFileref"
395 >Using fileref</link></para>
396 </refsee>
397</doc:pi>
398<xsl:template name="pi.dbhtml_img.src.path">
399 <xsl:param name="node" select="."/>
400 <xsl:call-template name="dbhtml-attribute">
401 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
402 <xsl:with-param name="attribute" select="'img.src.path'"/>
403 </xsl:call-template>
404</xsl:template>
405
406<doc:pi name="dbhtml_label-width" xmlns="">
407 <refpurpose>Specifies the label width for a qandaset</refpurpose>
408 <refdescription>
409 <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
410 <tag>qandaset</tag> to specify the width of labels.</para>
411 </refdescription>
412 <refsynopsisdiv>
413 <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
414 </refsynopsisdiv>
415 <refparameter>
416 <variablelist>
417 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
418 <listitem>
419 <para>Specifies the label width (including units)</para>
420 </listitem>
421 </varlistentry>
422 </variablelist>
423 </refparameter>
424 <refsee role="tcg">
425 <para><link role="tcg"
426 xlink:href="QandAformat.html"
427 >Q and A formatting</link></para>
428 </refsee>
429</doc:pi>
430<xsl:template name="pi.dbhtml_label-width">
431 <xsl:param name="node" select="."/>
432 <xsl:call-template name="dbhtml-attribute">
433 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
434 <xsl:with-param name="attribute" select="'label-width'"/>
435 </xsl:call-template>
436</xsl:template>
437
438<doc:pi name="dbhtml_linenumbering.everyNth" xmlns="">
439 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
440 <refdescription>
441 <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
442 of a “verbatim” element – <tag>programlisting</tag>,
443 <tag>screen</tag>, <tag>synopsis</tag> — to specify
444 the interval at which lines are numbered.</para>
445 </refdescription>
446 <refsynopsisdiv>
447 <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
448 </refsynopsisdiv>
449 <refparameter>
450 <variablelist>
451 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
452 <listitem>
453 <para>Specifies numbering interval; a number is output
454 before every <replaceable>N</replaceable>th line</para>
455 </listitem>
456 </varlistentry>
457 </variablelist>
458 </refparameter>
459 <refsee role="params">
460 <para><parameter>linenumbering.everyNth</parameter></para>
461 </refsee>
462 <refsee role="tcg">
463 <para><link role="tcg"
464 xlink:href="AnnotateListing.html#LineNumbering"
465 >Line numbering</link></para>
466 </refsee>
467</doc:pi>
468<xsl:template name="pi.dbhtml_linenumbering.everyNth">
469 <xsl:param name="node" select="."/>
470 <xsl:call-template name="dbhtml-attribute">
471 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
472 <xsl:with-param name="attribute" select="'linenumbering.everyNth'"/>
473 </xsl:call-template>
474</xsl:template>
475
476<doc:pi name="dbhtml_linenumbering.separator" xmlns="">
477 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
478 <refdescription>
479 <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
480 of a “verbatim” element – <tag>programlisting</tag>,
481 <tag>screen</tag>, <tag>synopsis</tag> — to specify
482 the separator text output between the line numbers and content.</para>
483 </refdescription>
484 <refsynopsisdiv>
485 <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
486 </refsynopsisdiv>
487 <refparameter>
488 <variablelist>
489 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
490 <listitem>
491 <para>Specifies the text (zero or more characters)</para>
492 </listitem>
493 </varlistentry>
494 </variablelist>
495 </refparameter>
496 <refsee role="params">
497 <para><parameter>linenumbering.separator</parameter></para>
498 </refsee>
499 <refsee role="tcg">
500 <para><link role="tcg"
501 xlink:href="AnnotateListing.html#LineNumbering"
502 >Line numbering</link></para>
503 </refsee>
504</doc:pi>
505<xsl:template name="pi.dbhtml_linenumbering.separator">
506 <xsl:param name="node" select="."/>
507 <xsl:call-template name="dbhtml-attribute">
508 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
509 <xsl:with-param name="attribute" select="'linenumbering.separator'"/>
510 </xsl:call-template>
511</xsl:template>
512
513<doc:pi name="dbhtml_linenumbering.width" xmlns="">
514 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
515 <refdescription>
516 <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
517 of a “verbatim” element – <tag>programlisting</tag>,
518 <tag>screen</tag>, <tag>synopsis</tag> — to specify
519 the width set aside for line numbers.</para>
520 </refdescription>
521 <refsynopsisdiv>
522 <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
523 </refsynopsisdiv>
524 <refparameter>
525 <variablelist>
526 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
527 <listitem>
528 <para>Specifies the width (inluding units)</para>
529 </listitem>
530 </varlistentry>
531 </variablelist>
532 </refparameter>
533 <refsee role="params">
534 <para><parameter>linenumbering.width</parameter></para>
535 </refsee>
536 <refsee role="tcg">
537 <para><link role="tcg"
538 xlink:href="AnnotateListing.html#LineNumbering"
539 >Line numbering</link></para>
540 </refsee>
541</doc:pi>
542<xsl:template name="pi.dbhtml_linenumbering.width">
543 <xsl:param name="node" select="."/>
544 <xsl:call-template name="dbhtml-attribute">
545 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
546 <xsl:with-param name="attribute" select="'linenumbering.width'"/>
547 </xsl:call-template>
548</xsl:template>
549
550<doc:pi name="dbhtml_list-presentation" xmlns="">
551 <refpurpose>Specifies presentation style for a variablelist or
552 segmentedlist</refpurpose>
553 <refdescription>
554 <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
555 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
556 control the presentation style for the list (to cause it, for
557 example, to be displayed as a table).</para>
558 </refdescription>
559 <refsynopsisdiv>
560 <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
561 </refsynopsisdiv>
562 <refparameter>
563 <variablelist>
564 <varlistentry><term>list-presentation="list"</term>
565 <listitem>
566 <para>Displays the list as a list</para>
567 </listitem>
568 </varlistentry>
569 <varlistentry><term>list-presentation="table"</term>
570 <listitem>
571 <para>Displays the list as a table</para>
572 </listitem>
573 </varlistentry>
574 </variablelist>
575 </refparameter>
576 <refsee role="params">
577 <itemizedlist>
578 <listitem>
579 <para><parameter>variablelist.as.table</parameter></para>
580 </listitem>
581 <listitem>
582 <para><parameter>segmentedlist.as.table</parameter></para>
583 </listitem>
584 </itemizedlist>
585 </refsee>
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-presentation">
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-presentation'"/>
597 </xsl:call-template>
598</xsl:template>
599
600<doc:pi name="dbhtml_list-width" xmlns="">
601 <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
602 <refdescription>
603 <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
604 <tag>variablelist</tag> or a <tag>simplelist</tag> presented
605 as a table, to specify the output width.</para>
606 </refdescription>
607 <refsynopsisdiv>
608 <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
609 </refsynopsisdiv>
610 <refparameter>
611 <variablelist>
612 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
613 <listitem>
614 <para>Specifies the output width (including units)</para>
615 </listitem>
616 </varlistentry>
617 </variablelist>
618 </refparameter>
619 <refsee role="tcg">
620 <para><link role="tcg"
621 xlink:href="Variablelists.html#VarListFormatting"
622 >Variable list formatting in HTML</link></para>
623 </refsee>
624</doc:pi>
625<xsl:template name="pi.dbhtml_list-width">
626 <xsl:param name="node" select="."/>
627 <xsl:call-template name="dbhtml-attribute">
628 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
629 <xsl:with-param name="attribute" select="'list-width'"/>
630 </xsl:call-template>
631</xsl:template>
632
633<doc:pi name="dbhtml_row-height" xmlns="">
634 <refpurpose>Specifies the height for a CALS table row</refpurpose>
635 <refdescription>
636 <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
637 <tag>row</tag> to specify the height of the row.</para>
638 </refdescription>
639 <refsynopsisdiv>
640 <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
641 </refsynopsisdiv>
642 <refparameter>
643 <variablelist>
644 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
645 <listitem>
646 <para>Specifies the row height (including units)</para>
647 </listitem>
648 </varlistentry>
649 </variablelist>
650 </refparameter>
651 <refsee role="tcg">
652 <para><link role="tcg"
653 xlink:href="RowHeight.html"
654 >Row height</link></para>
655 </refsee>
656</doc:pi>
657<xsl:template name="pi.dbhtml_row-height">
658 <xsl:param name="node" select="."/>
659 <xsl:call-template name="dbhtml-attribute">
660 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
661 <xsl:with-param name="attribute" select="'row-height'"/>
662 </xsl:call-template>
663</xsl:template>
664
665<doc:pi name="dbhtml_start" xmlns="">
666 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
667 <refdescription>
668 <para><emphasis>This PI is obsolete</emphasis>. The intent of
669 this PI was to provide a means for setting a specific starting
670 number for an ordered list. Instead of this PI, set a value
671 for the <literal>override</literal> attribute on the first
672 <tag>listitem</tag> in the list; that will have the same
673 effect as what this PI was intended for.</para>
674 </refdescription>
675 <refsynopsisdiv>
676 <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
677 </refsynopsisdiv>
678 <refparameter>
679 <variablelist>
680 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
681 <listitem>
682 <para>Specifies the character to use as the starting
683 number; use 0-9, a-z, A-Z, or lowercase or uppercase
684 Roman numerals</para>
685 </listitem>
686 </varlistentry>
687 </variablelist>
688 </refparameter>
689 <refsee role="tcg">
690 <para><link role="tcg"
691 xlink:href="Orderedlists.html#ListStartNum"
692 >List starting number</link></para>
693 </refsee>
694</doc:pi>
695<xsl:template name="pi.dbhtml_start">
696 <xsl:param name="node" select="."/>
697 <xsl:call-template name="pi-attribute">
698 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
699 <xsl:with-param name="attribute" select="'start'"/>
700 </xsl:call-template>
701</xsl:template>
702
703 <doc:pi name="dbhtml_stop-chunking" xmlns="">
704 <refpurpose>Do not chunk any descendants of this element.</refpurpose>
705 <refdescription>
706 <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:
707<programlisting><![CDATA[<section>
708<title>Configuring pencil</title>
709<?dbhtml stop-chunking?>
710
711...
712
713</section>]]></programlisting>
714</para>
715 </refdescription>
716 <refsynopsisdiv>
717 <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
718 </refsynopsisdiv>
719 <refsee role="tcg">
720 <para><link role="tcg"
721 xlink:href="Chunking.html"
722 >Chunking into multiple HTML files</link></para>
723 </refsee>
724 </doc:pi>
725 <!-- The code that handles the stop-chunking pi is in chunk-common.xsl -->
726
727<doc:pi name="dbhtml_table-summary" xmlns="">
728 <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
729 <refdescription>
730 <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
731 a CALS <tag>table</tag>, <tag>variablelist</tag>,
732 <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
733 the text for the HTML <literal>summary</literal> attribute
734 in the output HTML table.</para>
735 </refdescription>
736 <refsynopsisdiv>
737 <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
738 </refsynopsisdiv>
739 <refparameter>
740 <variablelist>
741 <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
742 <listitem>
743 <para>Specifies the summary text (zero or more characters)</para>
744 </listitem>
745 </varlistentry>
746 </variablelist>
747 </refparameter>
748 <refsee role="tcg">
749 <para><link role="tcg"
750 xlink:href="Variablelists.html#VarListFormatting"
751 >Variable list formatting in HTML</link>,
752 <link role="tcg" xlink:href="TableSummary.html"
753 >Table summary text</link></para>
754 </refsee>
755</doc:pi>
756<xsl:template name="pi.dbhtml_table-summary">
757 <xsl:param name="node" select="."/>
758 <xsl:call-template name="dbhtml-attribute">
759 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
760 <xsl:with-param name="attribute" select="'table-summary'"/>
761 </xsl:call-template>
762</xsl:template>
763
764<doc:pi name="dbhtml_table-width" xmlns="">
765 <refpurpose>Specifies the width for a CALS table</refpurpose>
766 <refdescription>
767 <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
768 CALS <tag>table</tag> to specify the width of the table in
769 output.</para>
770 </refdescription>
771 <refsynopsisdiv>
772 <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
773 </refsynopsisdiv>
774 <refparameter>
775 <variablelist>
776 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
777 <listitem>
778 <para>Specifies the table width (including units or as a percentage)</para>
779 </listitem>
780 </varlistentry>
781 </variablelist>
782 </refparameter>
783 <refsee role="params">
784 <para><parameter>default.table.width</parameter></para>
785 </refsee>
786 <refsee role="tcg">
787 <para><link role="tcg"
788 xlink:href="Tables.html#TableWidth"
789 >Table width</link></para>
790 </refsee>
791</doc:pi>
792<xsl:template name="pi.dbhtml_table-width">
793 <xsl:param name="node" select="."/>
794 <xsl:call-template name="dbhtml-attribute">
795 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
796 <xsl:with-param name="attribute" select="'table-width'"/>
797 </xsl:call-template>
798</xsl:template>
799
800<doc:pi name="dbhtml_term-presentation" xmlns="">
801 <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
802 <refdescription>
803 <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
804 of a <tag>variablelist</tag> to set character formatting for
805 the <tag>term</tag> output of the list.</para>
806 </refdescription>
807 <refsynopsisdiv>
808 <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
809 </refsynopsisdiv>
810 <refparameter>
811 <variablelist>
812 <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
813 <listitem>
814 <para>Specifies that terms are displayed in bold</para>
815 </listitem>
816 </varlistentry>
817 <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
818 <listitem>
819 <para>Specifies that terms are displayed in italic</para>
820 </listitem>
821 </varlistentry>
822 <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
823 <listitem>
824 <para>Specifies that terms are displayed in bold-italic</para>
825 </listitem>
826 </varlistentry>
827 </variablelist>
828 </refparameter>
829 <refsee role="tcg">
830 <para><link role="tcg"
831 xlink:href="Variablelists.html#VarListFormatting"
832 >Variable list formatting in HTML</link></para>
833 </refsee>
834</doc:pi>
835<xsl:template name="pi.dbhtml_term-presentation">
836 <xsl:param name="node" select="."/>
837 <xsl:call-template name="dbhtml-attribute">
838 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
839 <xsl:with-param name="attribute" select="'term-presentation'"/>
840 </xsl:call-template>
841</xsl:template>
842
843<doc:pi name="dbhtml_term-separator" xmlns="">
844 <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
845 <refdescription>
846 <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
847 of a <tag>variablelist</tag> to specify the separator text
848 among <tag>term</tag> instances.</para>
849 </refdescription>
850 <refsynopsisdiv>
851 <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
852 </refsynopsisdiv>
853 <refparameter>
854 <variablelist>
855 <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
856 <listitem>
857 <para>Specifies the text (zero or more characters)</para>
858 </listitem>
859 </varlistentry>
860 </variablelist>
861 </refparameter>
862 <refsee role="params">
863 <para><parameter>variablelist.term.separator</parameter></para>
864 </refsee>
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-separator">
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-separator'"/>
876 </xsl:call-template>
877</xsl:template>
878
879<doc:pi name="dbhtml_term-width" xmlns="">
880 <refpurpose>Specifies the term width for a variablelist</refpurpose>
881 <refdescription>
882 <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
883 <tag>variablelist</tag> to specify the width for
884 <tag>term</tag> output.</para>
885 </refdescription>
886 <refsynopsisdiv>
887 <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
888 </refsynopsisdiv>
889 <refparameter>
890 <variablelist>
891 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
892 <listitem>
893 <para>Specifies the term width (including units)</para>
894 </listitem>
895 </varlistentry>
896 </variablelist>
897 </refparameter>
898 <refsee role="tcg">
899 <para><link role="tcg"
900 xlink:href="Variablelists.html#VarListFormatting"
901 >Variable list formatting in HTML</link></para>
902 </refsee>
903</doc:pi>
904<xsl:template name="pi.dbhtml_term-width">
905 <xsl:param name="node" select="."/>
906 <xsl:call-template name="dbhtml-attribute">
907 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
908 <xsl:with-param name="attribute" select="'term-width'"/>
909 </xsl:call-template>
910</xsl:template>
911
912<doc:pi name="dbhtml_toc" xmlns="">
913 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
914 <refdescription>
915 <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
916 <tag>qandaset</tag> to specify whether a table of contents
917 (TOC) is generated for the <tag>qandaset</tag>.</para>
918 </refdescription>
919 <refsynopsisdiv>
920 <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
921 </refsynopsisdiv>
922 <refparameter>
923 <variablelist>
924 <varlistentry><term>toc="0"</term>
925 <listitem>
926 <para>If zero, no TOC is generated</para>
927 </listitem>
928 </varlistentry>
929 <varlistentry><term>toc="1"</term>
930 <listitem>
931 <para>If <code>1</code> (or any non-zero value),
932 a TOC is generated</para>
933 </listitem>
934 </varlistentry>
935 </variablelist>
936 </refparameter>
937 <refsee role="tcg">
938 <para><link role="tcg"
939 xlink:href="QandAtoc.html"
940 >Q and A list of questions</link>,
941 <link role="tcg"
942 xlink:href="QandAformat.html"
943 >Q and A formatting</link></para>
944 </refsee>
945</doc:pi>
946<xsl:template name="pi.dbhtml_toc">
947 <xsl:param name="node" select="."/>
948 <xsl:call-template name="dbhtml-attribute">
949 <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
950 <xsl:with-param name="attribute" select="'toc'"/>
951 </xsl:call-template>
952</xsl:template>
953
954<doc:pi name="dbcmdlist" xmlns="">
955 <refpurpose>Generates a hyperlinked list of commands</refpurpose>
956 <refdescription>
957 <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
958 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
959 <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
960 “command list” will be generated at the top of output for that
961 element, enabling users to quickly jump
962 to each command synopsis.</para>
963 </refdescription>
964 <refsynopsisdiv>
965 <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
966 </refsynopsisdiv>
967 <refparameter>
968 <para>[No parameters]</para>
969 </refparameter>
970</doc:pi>
971<xsl:template name="pi.dbcmdlist">
972 <xsl:variable name="cmdsynopses" select="..//cmdsynopsis"/>
973 <xsl:if test="count($cmdsynopses)&lt;1">
974 <xsl:message><xsl:text>No cmdsynopsis elements matched dbcmdlist PI, perhaps it's nested too deep?</xsl:text>
975 </xsl:message>
976 </xsl:if>
977 <dl>
978 <xsl:call-template name="process.cmdsynopsis.list">
979 <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/>
980 </xsl:call-template>
981 </dl>
982</xsl:template>
983
984<doc:pi name="dbfunclist" xmlns="">
985 <refpurpose>Generates a hyperlinked list of functions</refpurpose>
986 <refdescription>
987 <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
988 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
989 <tag>funcsynopsis</tag> instances; a hyperlinked
990 navigational “function list” will be generated at the top of
991 output for that element, enabling users to quickly
992 jump to to each function synopsis.</para>
993 </refdescription>
994 <refsynopsisdiv>
995 <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
996 </refsynopsisdiv>
997 <refparameter>
998 <para>[No parameters]</para>
999 </refparameter>
1000</doc:pi>
1001<xsl:template name="pi.dbfunclist">
1002 <xsl:variable name="funcsynopses" select="..//funcsynopsis"/>
1003 <xsl:if test="count($funcsynopses)&lt;1">
1004 <xsl:message><xsl:text>No funcsynopsis elements matched dbfunclist PI, perhaps it's nested too deep?</xsl:text>
1005 </xsl:message>
1006 </xsl:if>
1007 <dl>
1008 <xsl:call-template name="process.funcsynopsis.list">
1009 <xsl:with-param name="funcsynopses" select="$funcsynopses"/>
1010 </xsl:call-template>
1011 </dl>
1012</xsl:template>
1013
1014<doc:pi name="dbhtml-include_href" xmlns="">
1015 <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
1016 <refdescription>
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 <note>
1023 <para>The referenced file may contain plain text (as long as
1024 it is “wrapped” in an <tag>html</tag> element — see the
1025 note below) or markup in any arbitrary vocabulary,
1026 including HTML — but it must conform to XML
1027 well-formedness constraints (because the feature in XSLT
1028 1.0 for opening external files, the
1029 <function>document()</function> function, can only handle
1030 files that meet XML well-formedness constraints).</para>
1031 <para>Among other things, XML well-formedness constraints
1032 require a document to have <emphasis>a single root
1033 element</emphasis>. So if the content you want to
1034 include is plain text or is markup that does
1035 <emphasis>not</emphasis> have a single root element,
1036 <emphasis role="strong">wrap the content in an
1037 <tag>html</tag> element</emphasis>. The stylesheets will
1038 strip out that surrounding <tag>html</tag> “wrapper” when
1039 they find it, leaving just the content you want to
1040 insert.</para>
1041 </note>
1042 </refdescription>
1043 <refsynopsisdiv>
1044 <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
1045 </refsynopsisdiv>
1046 <refparameter>
1047 <variablelist>
1048 <varlistentry><term>href="<replaceable>URI</replaceable>"</term>
1049 <listitem>
1050 <para>Specifies the URI for the file to include; the URI
1051 can be, for example, a remote <literal>http:</literal>
1052 URI, or a local filesystem <literal>file:</literal>
1053 URI</para>
1054 </listitem>
1055 </varlistentry>
1056 </variablelist>
1057 </refparameter>
1058 <refsee role="params">
1059 <para><parameter>textinsert.extension</parameter></para>
1060 </refsee>
1061 <refsee role="tcg">
1062 <para><link role="tcg"
1063 xlink:href="InsertExtHtml.html"
1064 >Inserting external HTML code</link>,
1065 <link role="tcg"
1066 xlink:href="ExternalCode.html"
1067 >External code files</link></para>
1068 </refsee>
1069</doc:pi>
1070<xsl:template name="pi.dbhtml-include">
1071 <xsl:param name="href">
1072 <xsl:call-template name="dbhtml-attribute">
1073 <xsl:with-param name="pis" select="."/>
1074 <xsl:with-param name="attribute">href</xsl:with-param>
1075 </xsl:call-template>
1076 </xsl:param>
1077 <xsl:choose>
1078 <xsl:when test="$href != ''">
1079 <xsl:variable name="content" select="document($href,/)"/>
1080 <xsl:choose>
1081 <xsl:when test="$content/*">
1082 <xsl:choose>
1083 <xsl:when test="$content/*[1][self::html]">
1084 <!-- include just the children of html wrapper -->
1085 <xsl:copy-of select="$content/*[1]/node()"/>
1086 </xsl:when>
1087 <xsl:otherwise>
1088 <xsl:copy-of select="$content"/>
1089 </xsl:otherwise>
1090 </xsl:choose>
1091 </xsl:when>
1092 <xsl:otherwise>
1093 <xsl:message>
1094 <xsl:text>ERROR: dbhtml-include processing instruction </xsl:text>
1095 <xsl:text>href has no content.</xsl:text>
1096 </xsl:message>
1097 </xsl:otherwise>
1098 </xsl:choose>
1099 </xsl:when>
1100 <xsl:otherwise>
1101 <xsl:message>
1102 <xsl:text>ERROR: dbhtml-include processing instruction has </xsl:text>
1103 <xsl:text>missing or empty href value.</xsl:text>
1104 </xsl:message>
1105 </xsl:otherwise>
1106 </xsl:choose>
1107</xsl:template>
1108
1109<!-- There are two templates matching this PI in htmlhelp-common.xsl -->
1110<doc:pi name="dbhh" xmlns="">
1111 <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
1112 <refdescription>
1113 <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
1114 that should be used as targets for context-sensitive help requests.</para>
1115 </refdescription>
1116 <refsynopsisdiv>
1117 <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
1118 </refsynopsisdiv>
1119 <refparameter>
1120 <variablelist>
1121 <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
1122 <listitem>
1123 <para>Specifies a unique string constant that identifies a help topic</para>
1124 </listitem>
1125 </varlistentry>
1126 <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
1127 <listitem>
1128 <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
1129 </listitem>
1130 </varlistentry>
1131 </variablelist>
1132 </refparameter>
1133 <refsee role="tcg">
1134 <para><link role="tcg"
1135 xlink:href="HtmlHelp.html#HHContextHelp"
1136 >Context-sensitive help</link></para>
1137 </refsee>
1138</doc:pi>
1139
1140<!-- ==================================================================== -->
1141
1142<xsl:template name="dbhtml-attribute">
1143 <!-- * dbhtml-attribute is an interal utility template for retrieving -->
1144 <!-- * pseudo-attributes/parameters from PIs -->
1145 <xsl:param name="pis" select="processing-instruction('dbhtml')"/>
1146 <xsl:param name="attribute">filename</xsl:param>
1147 <xsl:call-template name="pi-attribute">
1148 <xsl:with-param name="pis" select="$pis"/>
1149 <xsl:with-param name="attribute" select="$attribute"/>
1150 </xsl:call-template>
1151</xsl:template>
1152
1153<!-- ==================================================================== -->
1154
1155<xsl:template match="processing-instruction()">
1156</xsl:template>
1157
1158<xsl:template match="processing-instruction('dbhtml')">
1159 <!-- nop -->
1160</xsl:template>
1161
1162<!-- ==================================================================== -->
1163
1164<xsl:template match="processing-instruction('dbcmdlist')">
1165 <xsl:call-template name="pi.dbcmdlist"/>
1166</xsl:template>
1167<xsl:template name="process.cmdsynopsis.list">
1168 <xsl:param name="cmdsynopses"/><!-- empty node list by default -->
1169 <xsl:param name="count" select="1"/>
1170
1171 <xsl:choose>
1172 <xsl:when test="$count>count($cmdsynopses)"></xsl:when>
1173 <xsl:otherwise>
1174 <xsl:variable name="cmdsyn" select="$cmdsynopses[$count]"/>
1175
1176 <dt>
1177 <a>
1178 <xsl:attribute name="href">
1179 <xsl:text>#</xsl:text>
1180 <xsl:call-template name="object.id">
1181 <xsl:with-param name="object" select="$cmdsyn"/>
1182 </xsl:call-template>
1183 </xsl:attribute>
1184
1185 <xsl:choose>
1186 <xsl:when test="$cmdsyn/@xreflabel">
1187 <xsl:call-template name="xref.xreflabel">
1188 <xsl:with-param name="target" select="$cmdsyn"/>
1189 </xsl:call-template>
1190 </xsl:when>
1191 <xsl:otherwise>
1192 <xsl:apply-templates select="$cmdsyn" mode="xref-to">
1193 <xsl:with-param name="target" select="$cmdsyn"/>
1194 </xsl:apply-templates>
1195 </xsl:otherwise>
1196 </xsl:choose>
1197 </a>
1198 </dt>
1199
1200 <xsl:call-template name="process.cmdsynopsis.list">
1201 <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/>
1202 <xsl:with-param name="count" select="$count+1"/>
1203 </xsl:call-template>
1204 </xsl:otherwise>
1205 </xsl:choose>
1206</xsl:template>
1207
1208<!-- ==================================================================== -->
1209
1210<xsl:template match="processing-instruction('dbfunclist')">
1211 <xsl:call-template name="pi.dbfunclist"/>
1212</xsl:template>
1213<xsl:template name="process.funcsynopsis.list">
1214 <xsl:param name="funcsynopses"/><!-- empty node list by default -->
1215 <xsl:param name="count" select="1"/>
1216
1217 <xsl:choose>
1218 <xsl:when test="$count>count($funcsynopses)"></xsl:when>
1219 <xsl:otherwise>
1220 <xsl:variable name="cmdsyn" select="$funcsynopses[$count]"/>
1221
1222 <dt>
1223 <a>
1224 <xsl:attribute name="href">
1225 <xsl:text>#</xsl:text>
1226 <xsl:call-template name="object.id">
1227 <xsl:with-param name="object" select="$cmdsyn"/>
1228 </xsl:call-template>
1229 </xsl:attribute>
1230
1231 <xsl:choose>
1232 <xsl:when test="$cmdsyn/@xreflabel">
1233 <xsl:call-template name="xref.xreflabel">
1234 <xsl:with-param name="target" select="$cmdsyn"/>
1235 </xsl:call-template>
1236 </xsl:when>
1237 <xsl:otherwise>
1238 <xsl:apply-templates select="$cmdsyn" mode="xref-to">
1239 <xsl:with-param name="target" select="$cmdsyn"/>
1240 </xsl:apply-templates>
1241 </xsl:otherwise>
1242 </xsl:choose>
1243 </a>
1244 </dt>
1245
1246 <xsl:call-template name="process.funcsynopsis.list">
1247 <xsl:with-param name="funcsynopses" select="$funcsynopses"/>
1248 <xsl:with-param name="count" select="$count+1"/>
1249 </xsl:call-template>
1250 </xsl:otherwise>
1251 </xsl:choose>
1252</xsl:template>
1253
1254<!-- ==================================================================== -->
1255
1256<xsl:template match="processing-instruction('dbhtml-include')">
1257 <xsl:call-template name="pi.dbhtml-include"/>
1258</xsl:template>
1259
1260<!-- ==================================================================== -->
1261
1262<xsl:template name="dbhtml-dir">
1263 <xsl:param name="context" select="."/>
1264 <!-- directories are now inherited from previous levels -->
1265 <xsl:variable name="ppath">
1266 <xsl:if test="$context/parent::*">
1267 <xsl:call-template name="dbhtml-dir">
1268 <xsl:with-param name="context" select="$context/parent::*"/>
1269 </xsl:call-template>
1270 </xsl:if>
1271 </xsl:variable>
1272 <xsl:variable name="path">
1273 <xsl:call-template name="pi.dbhtml_dir">
1274 <xsl:with-param name="node" select="$context"/>
1275 </xsl:call-template>
1276 </xsl:variable>
1277 <xsl:choose>
1278 <xsl:when test="$path = ''">
1279 <xsl:if test="$ppath != ''">
1280 <xsl:value-of select="$ppath"/>
1281 </xsl:if>
1282 </xsl:when>
1283 <xsl:otherwise>
1284 <xsl:if test="$ppath != ''">
1285 <xsl:value-of select="$ppath"/>
1286 <xsl:if test="substring($ppath, string-length($ppath), 1) != '/'">
1287 <xsl:text>/</xsl:text>
1288 </xsl:if>
1289 </xsl:if>
1290 <xsl:value-of select="$path"/>
1291 <xsl:text>/</xsl:text>
1292 </xsl:otherwise>
1293 </xsl:choose>
1294</xsl:template>
1295
1296</xsl:stylesheet>
Note: See TracBrowser for help on using the repository browser.