pi.xsl 51 KB

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