source: BOOK/stylesheets/lfs-xsl/docbook-xsl-snapshot/xhtml/pi.xsl@ d8a4dcf

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since d8a4dcf was d7c9f58, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

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