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