pi.xsl 53 KB

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