param.xml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788
  1. <?xml version="1.0" encoding="ASCII"?>
  2. <book version="5.0">
  3. <info>
  4. <title>Website Parameter Reference</title>
  5. <releaseinfo role="meta">
  6. $Id: param.xweb 9130 2011-10-11 08:05:37Z dpawson $
  7. </releaseinfo>
  8. <author>
  9. <personname>
  10. <surname>Walsh</surname>
  11. <firstname>Norman</firstname>
  12. </personname>
  13. </author>
  14. <copyright>
  15. <year>2002-2011</year>
  16. <holder>Norman Walsh</holder>
  17. </copyright>
  18. <abstract>
  19. <para>This is reference documentation for all user-configurable
  20. parameters in the DocBook XSL Website stylesheet (for
  21. generating websites from DocBook XML sources). Note that the
  22. Website stylesheet is a customization layer of the DocBook XSL
  23. HTML stylesheet. Therefore, in addition to the
  24. Website-specific parameters listed in this section, you can
  25. also use a number of <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="../html/">HTML
  26. stylesheet parameters</link> to control Website output.</para>
  27. </abstract>
  28. </info>
  29. <reference xml:id="general">
  30. <title>General Parameters</title>
  31. <refentry version="5.0" xml:id="autolayout-file">
  32. <refmeta>
  33. <refentrytitle>autolayout-file</refentrytitle>
  34. <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
  35. </refmeta>
  36. <refnamediv>
  37. <refname>autolayout-file</refname>
  38. <refpurpose>Identifies the autolayout.xml file</refpurpose>
  39. </refnamediv>
  40. <refsynopsisdiv>
  41. <programlisting xml:id="autolayout-file.frag">
  42. &lt;xsl:param name="autolayout-file"&gt;autolayout.xml&lt;/xsl:param&gt;
  43. </programlisting>
  44. </refsynopsisdiv>
  45. <refsection><info><title>Description</title></info>
  46. <para>When the source pages are spread over several directories, this
  47. parameter can be set (for example, from the command line of a batch-mode
  48. XSLT processor) to indicate the location of the autolayout.xml file.</para>
  49. <para>FIXME: for browser-based use, there needs to be a PI for this...
  50. </para>
  51. </refsection>
  52. </refentry>
  53. <refentry version="5.0" xml:id="body.attributes">
  54. <refmeta>
  55. <refentrytitle>body.attributes</refentrytitle>
  56. <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
  57. </refmeta>
  58. <refnamediv>
  59. <refname>body.attributes</refname>
  60. <refpurpose>DEPRECATED</refpurpose>
  61. </refnamediv>
  62. <refsynopsisdiv>
  63. <programlisting xml:id="body.attributes.frag">
  64. &lt;xsl:attribute-set name="body.attributes"&gt;
  65. &lt;xsl:attribute name="bgcolor"&gt;white&lt;/xsl:attribute&gt;
  66. &lt;xsl:attribute name="text"&gt;black&lt;/xsl:attribute&gt;
  67. &lt;xsl:attribute name="link"&gt;#0000FF&lt;/xsl:attribute&gt;
  68. &lt;xsl:attribute name="vlink"&gt;#840084&lt;/xsl:attribute&gt;
  69. &lt;xsl:attribute name="alink"&gt;#0000FF&lt;/xsl:attribute&gt;
  70. &lt;/xsl:attribute-set&gt;
  71. </programlisting>
  72. </refsynopsisdiv>
  73. <refsection><info><title>Description</title></info>
  74. <para>DEPRECATED</para>
  75. </refsection>
  76. </refentry>
  77. <refentry version="5.0" xml:id="currentpage.marker">
  78. <refmeta>
  79. <refentrytitle>currentpage.marker</refentrytitle>
  80. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  81. </refmeta>
  82. <refnamediv>
  83. <refname>currentpage.marker</refname>
  84. <refpurpose>The text symbol used to mark the current page</refpurpose>
  85. </refnamediv>
  86. <refsynopsisdiv>
  87. <programlisting xml:id="currentpage.marker.frag">
  88. &lt;xsl:param name="currentpage.marker"&gt;@&lt;/xsl:param&gt;
  89. </programlisting>
  90. </refsynopsisdiv>
  91. <refsection><info><title>Description</title></info>
  92. <para>Character to use as identifying the current page in </para>
  93. </refsection>
  94. </refentry>
  95. <refentry version="5.0" xml:id="dry-run">
  96. <refmeta>
  97. <refentrytitle>dry-run</refentrytitle>
  98. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  99. </refmeta>
  100. <refnamediv>
  101. <refname>dry-run</refname>
  102. <refpurpose>Indicates that no files should be produced</refpurpose>
  103. </refnamediv>
  104. <refsynopsisdiv>
  105. <programlisting xml:id="dry-run.frag">
  106. &lt;xsl:param name="dry-run" select="0"&gt;&lt;/xsl:param&gt;
  107. </programlisting>
  108. </refsynopsisdiv>
  109. <refsection><info><title>Description</title></info>
  110. <para>When using the XSLT processor to manage dependencies and construct
  111. the website, this parameter can be used to suppress the generation of
  112. new and updated files. Effectively, this allows you to see what the
  113. stylesheet would do, without actually making any changes.</para>
  114. <para>Only applies when XSLT-based chunking is being used.</para>
  115. </refsection>
  116. </refentry>
  117. <refentry version="5.0" xml:id="feedback.href">
  118. <refmeta>
  119. <refentrytitle>feedback.href</refentrytitle>
  120. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  121. </refmeta>
  122. <refnamediv>
  123. <refname>feedback.href</refname>
  124. <refpurpose>HREF (URI) for feedback link</refpurpose>
  125. </refnamediv>
  126. <refsynopsisdiv>
  127. <programlisting xml:id="feedback.href.frag">
  128. &lt;xsl:param name="feedback.href"&gt;&lt;/xsl:param&gt;
  129. </programlisting>
  130. </refsynopsisdiv>
  131. <refsection><info><title>Description</title></info>
  132. <para>The <varname>feedback.href</varname> value is used as the value
  133. for the <tag class="attribute">href</tag> attribute on the feedback
  134. link. If <varname>feedback.href</varname>
  135. is empty, no feedback link is generated.</para>
  136. </refsection>
  137. </refentry>
  138. <refentry version="5.0" xml:id="feedback.link.text">
  139. <refmeta>
  140. <refentrytitle>feedback.link.text</refentrytitle>
  141. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  142. </refmeta>
  143. <refnamediv>
  144. <refname>feedback.link.text</refname>
  145. <refpurpose>The text of the feedback link</refpurpose>
  146. </refnamediv>
  147. <refsynopsisdiv>
  148. <programlisting xml:id="feedback.link.text.frag">
  149. &lt;xsl:param name="feedback.link.text"&gt;Feedback&lt;/xsl:param&gt;
  150. </programlisting>
  151. </refsynopsisdiv>
  152. <refsection><info><title>Description</title></info>
  153. <para>The contents of this variable is used as the text of the feedback
  154. link if <varname>feedback.href</varname> is not empty. If
  155. <varname>feedback.href</varname> is empty, no feedback link is
  156. generated.</para>
  157. </refsection>
  158. </refentry>
  159. <refentry version="5.0" xml:id="feedback.with.ids">
  160. <refmeta>
  161. <refentrytitle>feedback.with.ids</refentrytitle>
  162. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  163. </refmeta>
  164. <refnamediv>
  165. <refname>feedback.with.ids</refname>
  166. <refpurpose>Toggle use of IDs in feedback</refpurpose>
  167. </refnamediv>
  168. <refsynopsisdiv>
  169. <programlisting xml:id="feedback.with.ids.frag">
  170. &lt;xsl:param name="feedback.with.ids" select="0"&gt;&lt;/xsl:param&gt;
  171. </programlisting>
  172. </refsynopsisdiv>
  173. <refsection><info><title>Description</title></info>
  174. <para>If <varname>feedback.with.ids</varname> is non-zero, the ID of the
  175. current page will be added to the feedback link. This can be used, for
  176. example, if the <varname>feedback.href</varname> is a CGI script.</para>
  177. </refsection>
  178. </refentry>
  179. <refentry version="5.0" xml:id="filename-prefix">
  180. <refmeta>
  181. <refentrytitle>filename-prefix</refentrytitle>
  182. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  183. </refmeta>
  184. <refnamediv>
  185. <refname>filename-prefix</refname>
  186. <refpurpose>Prefix added to all filenames</refpurpose>
  187. </refnamediv>
  188. <refsynopsisdiv>
  189. <programlisting xml:id="filename-prefix.frag">
  190. &lt;xsl:param name="filename-prefix"&gt;&lt;/xsl:param&gt;
  191. </programlisting>
  192. </refsynopsisdiv>
  193. <refsection><info><title>Description</title></info>
  194. <para>To produce the <quote>text-only</quote> (that is, non-tabular) layout
  195. of a website simultaneously with the tabular layout, the filenames have to
  196. be distinguished. That's accomplished by adding the
  197. <varname>filename-prefix</varname> to the front of each filename.</para>
  198. </refsection>
  199. </refentry>
  200. <refentry version="5.0" xml:id="footer.hr">
  201. <refmeta>
  202. <refentrytitle>footer.hr</refentrytitle>
  203. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  204. </refmeta>
  205. <refnamediv>
  206. <refname>footer.hr</refname>
  207. <refpurpose>Toggle &lt;HR&gt; before footer</refpurpose>
  208. </refnamediv>
  209. <refsynopsisdiv>
  210. <programlisting xml:id="footer.hr.frag">
  211. &lt;xsl:param name="footer.hr" select="1"&gt;&lt;/xsl:param&gt;
  212. </programlisting>
  213. </refsynopsisdiv>
  214. <refsection><info><title>Description</title></info>
  215. <para>If non-zero, an &lt;HR&gt; is generated at the bottom of each web page,
  216. before the footer.</para>
  217. </refsection>
  218. </refentry>
  219. <refentry version="5.0" xml:id="header.hr">
  220. <refmeta>
  221. <refentrytitle>header.hr</refentrytitle>
  222. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  223. </refmeta>
  224. <refnamediv>
  225. <refname>header.hr</refname>
  226. <refpurpose>Toggle &lt;HR&gt; after header</refpurpose>
  227. </refnamediv>
  228. <refsynopsisdiv>
  229. <programlisting xml:id="header.hr.frag">
  230. &lt;xsl:param name="header.hr" select="1"&gt;&lt;/xsl:param&gt;
  231. </programlisting>
  232. </refsynopsisdiv>
  233. <refsection><info><title>Description</title></info>
  234. <para>If non-zero, an &lt;HR&gt; is generated at the bottom of each web page,
  235. before the footer.</para>
  236. </refsection>
  237. </refentry>
  238. <refentry version="5.0" xml:id="output-root">
  239. <refmeta>
  240. <refentrytitle>output-root</refentrytitle>
  241. <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
  242. </refmeta>
  243. <refnamediv>
  244. <refname>output-root</refname>
  245. <refpurpose>Specifies the root directory of the website</refpurpose>
  246. </refnamediv>
  247. <refsynopsisdiv>
  248. <programlisting xml:id="output-root.frag">
  249. &lt;xsl:param name="output-root"&gt;.&lt;/xsl:param&gt;
  250. </programlisting>
  251. </refsynopsisdiv>
  252. <refsection><info><title>Description</title></info>
  253. <para>When using the XSLT processor to manage dependencies and construct
  254. the website, this parameter can be used to indicate the root directory
  255. where the resulting pages are placed.</para>
  256. <para>Only applies when XSLT-based chunking is being used.</para>
  257. </refsection>
  258. </refentry>
  259. <refentry version="5.0" xml:id="rebuild-all">
  260. <refmeta>
  261. <refentrytitle>rebuild-all</refentrytitle>
  262. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  263. </refmeta>
  264. <refnamediv>
  265. <refname>rebuild-all</refname>
  266. <refpurpose>Indicates that all files should be produced</refpurpose>
  267. </refnamediv>
  268. <refsynopsisdiv>
  269. <programlisting xml:id="rebuild-all.frag">
  270. &lt;xsl:param name="rebuild-all" select="0"&gt;&lt;/xsl:param&gt;
  271. </programlisting>
  272. </refsynopsisdiv>
  273. <refsection><info><title>Description</title></info>
  274. <para>When using the XSLT processor to manage dependencies and construct
  275. the website, this parameter can be used to regenerate the whole website,
  276. updating even pages that don't appear to need to be updated.</para>
  277. <para>The dependency extension only looks at the source documents. So
  278. if you change something in the stylesheet, for example, that has a global
  279. effect, you can use this parameter to force the stylesheet to rebuild the
  280. whole website.
  281. </para>
  282. <para>Only applies when XSLT-based chunking is being used.</para>
  283. </refsection>
  284. </refentry>
  285. <refentry version="5.0" xml:id="sequential.links">
  286. <refmeta>
  287. <refentrytitle>sequential.links</refentrytitle>
  288. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  289. </refmeta>
  290. <refnamediv>
  291. <refname>sequential.links</refname>
  292. <refpurpose>Make sequentional links?</refpurpose>
  293. </refnamediv>
  294. <refsynopsisdiv>
  295. <programlisting xml:id="sequential.links.frag">
  296. &lt;xsl:param name="sequential.links" select="0"&gt;&lt;/xsl:param&gt;
  297. </programlisting>
  298. </refsynopsisdiv>
  299. <refsection><info><title>Description</title></info>
  300. <para>FIXME</para>
  301. </refsection>
  302. </refentry>
  303. <refentry version="5.0" xml:id="suppress.homepage.title">
  304. <refmeta>
  305. <refentrytitle>suppress.homepage.title</refentrytitle>
  306. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  307. </refmeta>
  308. <refnamediv>
  309. <refname>suppress.homepage.title</refname>
  310. <refpurpose>Suppress title on homepage?</refpurpose>
  311. </refnamediv>
  312. <refsynopsisdiv>
  313. <programlisting xml:id="suppress.homepage.title.frag">
  314. &lt;xsl:param name="suppress.homepage.title" select="1"&gt;&lt;/xsl:param&gt;
  315. </programlisting>
  316. </refsynopsisdiv>
  317. <refsection><info><title>Description</title></info>
  318. <para>FIXME:If non-zero, the title on the homepage is suppressed?</para>
  319. </refsection>
  320. </refentry>
  321. <refentry version="5.0" xml:id="table.spacer.image">
  322. <refmeta>
  323. <refentrytitle>table.spacer.image</refentrytitle>
  324. <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
  325. </refmeta>
  326. <refnamediv>
  327. <refname>table.spacer.image</refname>
  328. <refpurpose>Invisible pixel for tabular accessibility</refpurpose>
  329. </refnamediv>
  330. <refsynopsisdiv>
  331. <programlisting xml:id="table.spacer.image.frag">
  332. &lt;xsl:param name="table.spacer.image"&gt;graphics/spacer.gif&lt;/xsl:param&gt;
  333. </programlisting>
  334. </refsynopsisdiv>
  335. <refsection><info><title>Description</title></info>
  336. <para>This is the 1x1 pixel, transparent pixel used for <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://diveintoaccessibility.org/day_10_presenting_your_main_content_first.html">the table trick</link> to increase the accessibility of the tabular
  337. website presentation.</para>
  338. </refsection>
  339. </refentry>
  340. </reference>
  341. <reference xml:id="nav">
  342. <title>Navigation Parameters</title>
  343. <refentry version="5.0" xml:id="banner.before.navigation">
  344. <refmeta>
  345. <refentrytitle>banner.before.navigation</refentrytitle>
  346. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  347. </refmeta>
  348. <refnamediv>
  349. <refname>banner.before.navigation</refname>
  350. <refpurpose>Put banner before navigation?</refpurpose>
  351. </refnamediv>
  352. <refsynopsisdiv>
  353. <programlisting xml:id="banner.before.navigation.frag">
  354. &lt;xsl:param name="banner.before.navigation" select="1"&gt;&lt;/xsl:param&gt;
  355. </programlisting>
  356. </refsynopsisdiv>
  357. <refsection><info><title>Description</title></info>
  358. <para>FIXME</para>
  359. </refsection>
  360. </refentry>
  361. <refentry version="5.0" xml:id="navbgcolor">
  362. <refmeta>
  363. <refentrytitle>navbgcolor</refentrytitle>
  364. <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
  365. </refmeta>
  366. <refnamediv>
  367. <refname>navbgcolor</refname>
  368. <refpurpose>The background color of the navigation TOC</refpurpose>
  369. </refnamediv>
  370. <refsynopsisdiv>
  371. <programlisting xml:id="navbgcolor.frag">
  372. &lt;xsl:param name="navbgcolor"&gt;#4080FF&lt;/xsl:param&gt;
  373. </programlisting>
  374. </refsynopsisdiv>
  375. <refsection><info><title>Description</title></info>
  376. <para>The background color of the navigation TOC.</para>
  377. <para>Only applies with the tabular presentation is being used.</para>
  378. </refsection>
  379. </refentry>
  380. <refentry version="5.0" xml:id="navbodywidth">
  381. <refmeta>
  382. <refentrytitle>navbodywidth</refentrytitle>
  383. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  384. </refmeta>
  385. <refnamediv>
  386. <refname>navbodywidth</refname>
  387. <refpurpose>Specifies the width of the navigation table body</refpurpose>
  388. </refnamediv>
  389. <refsynopsisdiv>
  390. <programlisting xml:id="navbodywidth.frag">
  391. &lt;xsl:param name="navbodywidth"&gt;&lt;/xsl:param&gt;
  392. </programlisting>
  393. </refsynopsisdiv>
  394. <refsection><info><title>Description</title></info>
  395. <para>The width of the body column.</para>
  396. <para>Only applies with the tabular presentation is being used.</para>
  397. </refsection>
  398. </refentry>
  399. <refentry version="5.0" xml:id="nav.table.summary">
  400. <refmeta>
  401. <refentrytitle>nav.table.summary</refentrytitle>
  402. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  403. </refmeta>
  404. <refnamediv>
  405. <refname>nav.table.summary</refname>
  406. <refpurpose>HTML Table summary attribute value for navigation tables</refpurpose>
  407. </refnamediv>
  408. <refsynopsisdiv>
  409. <programlisting xml:id="nav.table.summary.frag">
  410. &lt;xsl:param name="nav.table.summary"&gt;Navigation&lt;/xsl:param&gt;
  411. </programlisting>
  412. </refsynopsisdiv>
  413. <refsection><info><title>Description</title></info>
  414. <para>The value of this parameter is used as the value of the table
  415. summary attribute for the navigation table.</para>
  416. <para>Only applies with the tabular presentation is being used.</para>
  417. </refsection>
  418. </refentry>
  419. <refentry version="5.0" xml:id="navtocwidth">
  420. <refmeta>
  421. <refentrytitle>navtocwidth</refentrytitle>
  422. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  423. </refmeta>
  424. <refnamediv>
  425. <refname>navtocwidth</refname>
  426. <refpurpose>Specifies the width of the navigation table TOC</refpurpose>
  427. </refnamediv>
  428. <refsynopsisdiv>
  429. <programlisting xml:id="navtocwidth.frag">
  430. &lt;xsl:param name="navtocwidth"&gt;220&lt;/xsl:param&gt;
  431. </programlisting>
  432. </refsynopsisdiv>
  433. <refsection><info><title>Description</title></info>
  434. <para>The width, in pixels, of the navigation column.</para>
  435. <para>Only applies with the tabular presentation is being used.</para>
  436. </refsection>
  437. </refentry>
  438. <refentry version="5.0" xml:id="textbgcolor">
  439. <refmeta>
  440. <refentrytitle>textbgcolor</refentrytitle>
  441. <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
  442. </refmeta>
  443. <refnamediv>
  444. <refname>textbgcolor</refname>
  445. <refpurpose>The background color of the table body</refpurpose>
  446. </refnamediv>
  447. <refsynopsisdiv>
  448. <programlisting xml:id="textbgcolor.frag">
  449. &lt;xsl:param name="textbgcolor"&gt;white&lt;/xsl:param&gt;
  450. </programlisting>
  451. </refsynopsisdiv>
  452. <refsection><info><title>Description</title></info>
  453. <para>The background color of the table body.</para>
  454. <para>Only applies with the tabular presentation is being used.</para>
  455. </refsection>
  456. </refentry>
  457. </reference>
  458. <reference xml:id="toc">
  459. <title>ToC Parameters</title>
  460. <refentry version="5.0" xml:id="toc.blank.graphic">
  461. <refmeta>
  462. <refentrytitle>toc.blank.graphic</refentrytitle>
  463. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  464. </refmeta>
  465. <refnamediv>
  466. <refname>toc.blank.graphic</refname>
  467. <refpurpose>Use graphic for "blanks" in TOC?</refpurpose>
  468. </refnamediv>
  469. <refsynopsisdiv>
  470. <programlisting xml:id="toc.blank.graphic.frag">
  471. &lt;xsl:param name="toc.blank.graphic" select="1"&gt;&lt;/xsl:param&gt;
  472. </programlisting>
  473. </refsynopsisdiv>
  474. <refsection><info><title>Description</title></info>
  475. <para>If non-zero, "blanks" in the the TOC will be accomplished
  476. with the graphic identified by <varname>toc.spacer.image</varname>.
  477. </para>
  478. <para>Only applies with the tabular presentation is being used.</para>
  479. </refsection>
  480. </refentry>
  481. <refentry version="5.0" xml:id="toc.blank.image">
  482. <refmeta>
  483. <refentrytitle>toc.blank.image</refentrytitle>
  484. <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
  485. </refmeta>
  486. <refnamediv>
  487. <refname>toc.blank.image</refname>
  488. <refpurpose>The image for "blanks" in the TOC</refpurpose>
  489. </refnamediv>
  490. <refsynopsisdiv>
  491. <programlisting xml:id="toc.blank.image.frag">
  492. &lt;xsl:param name="toc.blank.image"&gt;graphics/blank.gif&lt;/xsl:param&gt;
  493. </programlisting>
  494. </refsynopsisdiv>
  495. <refsection><info><title>Description</title></info>
  496. <para>If <varname>toc.blank.graphic</varname> is non-zero, this image
  497. will be used to for "blanks" in the TOC.</para>
  498. <para>Only applies with the tabular presentation is being used.</para>
  499. </refsection>
  500. </refentry>
  501. <refentry version="5.0" xml:id="toc.blank.text">
  502. <refmeta>
  503. <refentrytitle>toc.blank.text</refentrytitle>
  504. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  505. </refmeta>
  506. <refnamediv>
  507. <refname>toc.blank.text</refname>
  508. <refpurpose>The text for "blanks" in the TOC</refpurpose>
  509. </refnamediv>
  510. <refsynopsisdiv>
  511. <programlisting xml:id="toc.blank.text.frag">
  512. &lt;xsl:param name="toc.blank.text"&gt;&#160;&#160;&#160;&lt;/xsl:param&gt;
  513. </programlisting>
  514. </refsynopsisdiv>
  515. <refsection><info><title>Description</title></info>
  516. <para>If <varname>toc.blank.graphic</varname> is zero, this text string
  517. will be used for "blanks" in the TOC.</para>
  518. <para>Only applies with the tabular presentation is being used.</para>
  519. </refsection>
  520. </refentry>
  521. <refentry version="5.0" xml:id="toc.pointer.graphic">
  522. <refmeta>
  523. <refentrytitle>toc.pointer.graphic</refentrytitle>
  524. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  525. </refmeta>
  526. <refnamediv>
  527. <refname>toc.pointer.graphic</refname>
  528. <refpurpose>Use graphic for TOC pointer?</refpurpose>
  529. </refnamediv>
  530. <refsynopsisdiv>
  531. <programlisting xml:id="toc.pointer.graphic.frag">
  532. &lt;xsl:param name="toc.pointer.graphic" select="1"&gt;&lt;/xsl:param&gt;
  533. </programlisting>
  534. </refsynopsisdiv>
  535. <refsection><info><title>Description</title></info>
  536. <para>If non-zero, the "pointer" in the TOC will be displayed
  537. with the graphic identified by <varname>toc.pointer.image</varname>.
  538. </para>
  539. <para>Only applies with the tabular presentation is being used.</para>
  540. </refsection>
  541. </refentry>
  542. <refentry version="5.0" xml:id="toc.pointer.image">
  543. <refmeta>
  544. <refentrytitle>toc.pointer.image</refentrytitle>
  545. <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
  546. </refmeta>
  547. <refnamediv>
  548. <refname>toc.pointer.image</refname>
  549. <refpurpose>The image for the "pointer" in the TOC</refpurpose>
  550. </refnamediv>
  551. <refsynopsisdiv>
  552. <programlisting xml:id="toc.pointer.image.frag">
  553. &lt;xsl:param name="toc.pointer.image"&gt;graphics/arrow.gif&lt;/xsl:param&gt;
  554. </programlisting>
  555. </refsynopsisdiv>
  556. <refsection><info><title>Description</title></info>
  557. <para>If <varname>toc.pointer.graphic</varname> is non-zero, this image
  558. will be used for the "pointer" in the TOC.</para>
  559. <para>Only applies with the tabular presentation is being used.</para>
  560. </refsection>
  561. </refentry>
  562. <refentry version="5.0" xml:id="toc.pointer.text">
  563. <refmeta>
  564. <refentrytitle>toc.pointer.text</refentrytitle>
  565. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  566. </refmeta>
  567. <refnamediv>
  568. <refname>toc.pointer.text</refname>
  569. <refpurpose>The text for the "pointer" in the TOC</refpurpose>
  570. </refnamediv>
  571. <refsynopsisdiv>
  572. <programlisting xml:id="toc.pointer.text.frag">
  573. &lt;xsl:param name="toc.pointer.text"&gt;&#160;&gt;&#160;&lt;/xsl:param&gt;
  574. </programlisting>
  575. </refsynopsisdiv>
  576. <refsection><info><title>Description</title></info>
  577. <para>If <varname>toc.pointer.graphic</varname> is zero, this text string
  578. will be used to display the "pointer" in the TOC.</para>
  579. <para>Only applies with the tabular presentation is being used.</para>
  580. </refsection>
  581. </refentry>
  582. <refentry version="5.0" xml:id="toc.spacer.graphic">
  583. <refmeta>
  584. <refentrytitle>toc.spacer.graphic</refentrytitle>
  585. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  586. </refmeta>
  587. <refnamediv>
  588. <refname>toc.spacer.graphic</refname>
  589. <refpurpose>Use graphic for TOC spacer?</refpurpose>
  590. </refnamediv>
  591. <refsynopsisdiv>
  592. <programlisting xml:id="toc.spacer.graphic.frag">
  593. &lt;xsl:param name="toc.spacer.graphic" select="1"&gt;&lt;/xsl:param&gt;
  594. </programlisting>
  595. </refsynopsisdiv>
  596. <refsection><info><title>Description</title></info>
  597. <para>If non-zero, the indentation in the TOC will be accomplished
  598. with the graphic identified by <varname>toc.spacer.image</varname>.
  599. </para>
  600. <para>Only applies with the tabular presentation is being used.</para>
  601. </refsection>
  602. </refentry>
  603. <refentry version="5.0" xml:id="toc.spacer.image">
  604. <refmeta>
  605. <refentrytitle>toc.spacer.image</refentrytitle>
  606. <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
  607. </refmeta>
  608. <refnamediv>
  609. <refname>toc.spacer.image</refname>
  610. <refpurpose>The image for spacing the TOC</refpurpose>
  611. </refnamediv>
  612. <refsynopsisdiv>
  613. <programlisting xml:id="toc.spacer.image.frag">
  614. &lt;xsl:param name="toc.spacer.image"&gt;graphics/blank.gif&lt;/xsl:param&gt;
  615. </programlisting>
  616. </refsynopsisdiv>
  617. <refsection><info><title>Description</title></info>
  618. <para>If <varname>toc.spacer.graphic</varname> is non-zero, this image
  619. will be used to indent the TOC.</para>
  620. <para>Only applies with the tabular presentation is being used.</para>
  621. </refsection>
  622. </refentry>
  623. <refentry version="5.0" xml:id="toc.spacer.text">
  624. <refmeta>
  625. <refentrytitle>toc.spacer.text</refentrytitle>
  626. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  627. </refmeta>
  628. <refnamediv>
  629. <refname>toc.spacer.text</refname>
  630. <refpurpose>The text for spacing the TOC</refpurpose>
  631. </refnamediv>
  632. <refsynopsisdiv>
  633. <programlisting xml:id="toc.spacer.text.frag">
  634. &lt;xsl:param name="toc.spacer.text"&gt;&#160;&#160;&#160;&lt;/xsl:param&gt;
  635. </programlisting>
  636. </refsynopsisdiv>
  637. <refsection><info><title>Description</title></info>
  638. <para>If <varname>toc.spacer.graphic</varname> is zero, this text string
  639. will be used to indent the TOC.</para>
  640. <para>Only applies with the tabular presentation is being used.</para>
  641. </refsection>
  642. </refentry>
  643. </reference>
  644. <appendix xml:id="stylesheet"><title>The Stylesheet</title>
  645. <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
  646. around all these parameters.</para>
  647. <programlisting xml:id="top">
  648. &lt;!-- This file is generated from param.xweb --&gt;
  649. &lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;
  650. &lt;!-- ********************************************************************
  651. $Id: param.xweb 9130 2011-10-11 08:05:37Z dpawson $
  652. ********************************************************************
  653. This file is part of the DocBook XSL Stylesheets distribution.
  654. See ../README or http://docbook.sf.net/release/xsl/current/ for
  655. copyright and other information.
  656. ******************************************************************** --&gt;
  657. &lt;src:fragref linkend="autolayout-file.frag"&gt;&lt;/src:fragref&gt;
  658. &lt;src:fragref linkend="header.hr.frag"&gt;&lt;/src:fragref&gt;
  659. &lt;src:fragref linkend="footer.hr.frag"&gt;&lt;/src:fragref&gt;
  660. &lt;src:fragref linkend="feedback.href.frag"&gt;&lt;/src:fragref&gt;
  661. &lt;src:fragref linkend="feedback.with.ids.frag"&gt;&lt;/src:fragref&gt;
  662. &lt;src:fragref linkend="feedback.link.text.frag"&gt;&lt;/src:fragref&gt;
  663. &lt;src:fragref linkend="filename-prefix.frag"&gt;&lt;/src:fragref&gt;
  664. &lt;src:fragref linkend="output-root.frag"&gt;&lt;/src:fragref&gt;
  665. &lt;src:fragref linkend="dry-run.frag"&gt;&lt;/src:fragref&gt;
  666. &lt;src:fragref linkend="rebuild-all.frag"&gt;&lt;/src:fragref&gt;
  667. &lt;src:fragref linkend="nav.table.summary.frag"&gt;&lt;/src:fragref&gt;
  668. &lt;src:fragref linkend="navtocwidth.frag"&gt;&lt;/src:fragref&gt;
  669. &lt;src:fragref linkend="navbodywidth.frag"&gt;&lt;/src:fragref&gt;
  670. &lt;src:fragref linkend="textbgcolor.frag"&gt;&lt;/src:fragref&gt;
  671. &lt;src:fragref linkend="navbgcolor.frag"&gt;&lt;/src:fragref&gt;
  672. &lt;src:fragref linkend="toc.spacer.graphic.frag"&gt;&lt;/src:fragref&gt;
  673. &lt;src:fragref linkend="toc.spacer.text.frag"&gt;&lt;/src:fragref&gt;
  674. &lt;src:fragref linkend="toc.spacer.image.frag"&gt;&lt;/src:fragref&gt;
  675. &lt;src:fragref linkend="toc.pointer.graphic.frag"&gt;&lt;/src:fragref&gt;
  676. &lt;src:fragref linkend="toc.pointer.text.frag"&gt;&lt;/src:fragref&gt;
  677. &lt;src:fragref linkend="toc.pointer.image.frag"&gt;&lt;/src:fragref&gt;
  678. &lt;src:fragref linkend="toc.blank.graphic.frag"&gt;&lt;/src:fragref&gt;
  679. &lt;src:fragref linkend="toc.blank.text.frag"&gt;&lt;/src:fragref&gt;
  680. &lt;src:fragref linkend="toc.blank.image.frag"&gt;&lt;/src:fragref&gt;
  681. &lt;src:fragref linkend="suppress.homepage.title.frag"&gt;&lt;/src:fragref&gt;
  682. &lt;src:fragref linkend="body.attributes.frag"&gt;&lt;/src:fragref&gt;
  683. &lt;src:fragref linkend="sequential.links.frag"&gt;&lt;/src:fragref&gt;
  684. &lt;src:fragref linkend="currentpage.marker.frag"&gt;&lt;/src:fragref&gt;
  685. &lt;src:fragref linkend="banner.before.navigation.frag"&gt;&lt;/src:fragref&gt;
  686. &lt;src:fragref linkend="table.spacer.image.frag"&gt;&lt;/src:fragref&gt;
  687. &lt;/xsl:stylesheet&gt;
  688. </programlisting>
  689. </appendix>
  690. </book>