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