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