1
<?xml version="1.0" encoding="ASCII"?>
4
<title>Website Parameter Reference</title>
5
<releaseinfo role="meta">
6
$Id: param.xweb 7076 2007-07-18 16:20:33Z xmldoc $
10
<surname>Walsh</surname>
11
<firstname>Norman</firstname>
15
<year>2002-2005</year>
16
<holder>Norman Walsh</holder>
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>
29
<reference xml:id="general">
30
<title>General Parameters</title>
31
<refentry version="5.0" xml:id="autolayout-file">
33
<refentrytitle>autolayout-file</refentrytitle>
34
<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
37
<refname>autolayout-file</refname>
38
<refpurpose>Identifies the autolayout.xml file</refpurpose>
42
<programlisting xml:id="autolayout-file.frag">
43
<xsl:param name="autolayout-file">autolayout.xml</xsl:param>
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...
56
<refentry version="5.0" xml:id="body.attributes">
58
<refentrytitle>body.attributes</refentrytitle>
59
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
62
<refname>body.attributes</refname>
63
<refpurpose>DEPRECATED</refpurpose>
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>
78
<refsection><info><title>Description</title></info>
79
<para>DEPRECATED</para>
83
<refentry version="5.0" xml:id="currentpage.marker">
85
<refentrytitle>currentpage.marker</refentrytitle>
86
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
89
<refname>currentpage.marker</refname>
90
<refpurpose>The text symbol used to mark the current page</refpurpose>
94
<programlisting xml:id="currentpage.marker.frag">
95
<xsl:param name="currentpage.marker">@</xsl:param>
99
<refsection><info><title>Description</title></info>
100
<para>Character to use as identifying the current page in </para>
104
<refentry version="5.0" xml:id="dry-run">
106
<refentrytitle>dry-run</refentrytitle>
107
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
110
<refname>dry-run</refname>
111
<refpurpose>Indicates that no files should be produced</refpurpose>
114
<programlisting xml:id="dry-run.frag">
115
<xsl:param name="dry-run" select="0"></xsl:param>
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>
127
<refentry version="5.0" xml:id="feedback.href">
129
<refentrytitle>feedback.href</refentrytitle>
130
<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
133
<refname>feedback.href</refname>
134
<refpurpose>HREF (URI) for feedback link</refpurpose>
138
<programlisting xml:id="feedback.href.frag">
139
<xsl:param name="feedback.href"></xsl:param>
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>
151
<refentry version="5.0" xml:id="feedback.link.text">
153
<refentrytitle>feedback.link.text</refentrytitle>
154
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
157
<refname>feedback.link.text</refname>
158
<refpurpose>The text of the feedback link</refpurpose>
162
<programlisting xml:id="feedback.link.text.frag">
163
<xsl:param name="feedback.link.text">Feedback</xsl:param>
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
175
<refentry version="5.0" xml:id="feedback.with.ids">
177
<refentrytitle>feedback.with.ids</refentrytitle>
178
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
181
<refname>feedback.with.ids</refname>
182
<refpurpose>Toggle use of IDs in feedback</refpurpose>
186
<programlisting xml:id="feedback.with.ids.frag">
187
<xsl:param name="feedback.with.ids" select="0"></xsl:param>
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>
198
<refentry version="5.0" xml:id="filename-prefix">
200
<refentrytitle>filename-prefix</refentrytitle>
201
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
204
<refname>filename-prefix</refname>
205
<refpurpose>Prefix added to all filenames</refpurpose>
209
<programlisting xml:id="filename-prefix.frag">
210
<xsl:param name="filename-prefix"></xsl:param>
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>
222
<refentry version="5.0" xml:id="footer.hr">
224
<refentrytitle>footer.hr</refentrytitle>
225
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
228
<refname>footer.hr</refname>
229
<refpurpose>Toggle <HR> before footer</refpurpose>
233
<programlisting xml:id="footer.hr.frag">
234
<xsl:param name="footer.hr" select="1"></xsl:param>
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>
244
<refentry version="5.0" xml:id="header.hr">
246
<refentrytitle>header.hr</refentrytitle>
247
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
250
<refname>header.hr</refname>
251
<refpurpose>Toggle <HR> after header</refpurpose>
255
<programlisting xml:id="header.hr.frag">
256
<xsl:param name="header.hr" select="1"></xsl:param>
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>
266
<refentry version="5.0" xml:id="output-root">
268
<refentrytitle>output-root</refentrytitle>
269
<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
272
<refname>output-root</refname>
273
<refpurpose>Specifies the root directory of the website</refpurpose>
277
<programlisting xml:id="output-root.frag">
278
<xsl:param name="output-root">.</xsl:param>
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>
290
<refentry version="5.0" xml:id="rebuild-all">
292
<refentrytitle>rebuild-all</refentrytitle>
293
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
296
<refname>rebuild-all</refname>
297
<refpurpose>Indicates that all files should be produced</refpurpose>
301
<programlisting xml:id="rebuild-all.frag">
302
<xsl:param name="rebuild-all" select="0"></xsl:param>
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
315
<para>Only applies when XSLT-based chunking is being used.</para>
319
<refentry version="5.0" xml:id="sequential.links">
321
<refentrytitle>sequential.links</refentrytitle>
322
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
325
<refname>sequential.links</refname>
326
<refpurpose>Make sequentional links?</refpurpose>
330
<programlisting xml:id="sequential.links.frag">
331
<xsl:param name="sequential.links" select="0"></xsl:param>
335
<refsection><info><title>Description</title></info>
340
<refentry version="5.0" xml:id="suppress.homepage.title">
342
<refentrytitle>suppress.homepage.title</refentrytitle>
343
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
346
<refname>suppress.homepage.title</refname>
347
<refpurpose>Suppress title on homepage?</refpurpose>
351
<programlisting xml:id="suppress.homepage.title.frag">
352
<xsl:param name="suppress.homepage.title" select="1"></xsl:param>
356
<refsection><info><title>Description</title></info>
357
<para>FIXME:If non-zero, the title on the homepage is suppressed?</para>
361
<refentry version="5.0" xml:id="table.spacer.image">
363
<refentrytitle>table.spacer.image</refentrytitle>
364
<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
367
<refname>table.spacer.image</refname>
368
<refpurpose>Invisible pixel for tabular accessibility</refpurpose>
372
<programlisting xml:id="table.spacer.image.frag">
373
<xsl:param name="table.spacer.image">graphics/spacer.gif</xsl:param>
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>
384
<reference xml:id="nav">
385
<title>Navigation Parameters</title>
386
<refentry version="5.0" xml:id="banner.before.navigation">
388
<refentrytitle>banner.before.navigation</refentrytitle>
389
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
392
<refname>banner.before.navigation</refname>
393
<refpurpose>Put banner before navigation?</refpurpose>
397
<programlisting xml:id="banner.before.navigation.frag">
398
<xsl:param name="banner.before.navigation" select="1"></xsl:param>
402
<refsection><info><title>Description</title></info>
407
<refentry version="5.0" xml:id="navbgcolor">
409
<refentrytitle>navbgcolor</refentrytitle>
410
<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
413
<refname>navbgcolor</refname>
414
<refpurpose>The background color of the navigation TOC</refpurpose>
418
<programlisting xml:id="navbgcolor.frag">
419
<xsl:param name="navbgcolor">#4080FF</xsl:param>
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>
429
<refentry version="5.0" xml:id="navbodywidth">
431
<refentrytitle>navbodywidth</refentrytitle>
432
<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
435
<refname>navbodywidth</refname>
436
<refpurpose>Specifies the width of the navigation table body</refpurpose>
440
<programlisting xml:id="navbodywidth.frag">
441
<xsl:param name="navbodywidth"></xsl:param>
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>
451
<refentry version="5.0" xml:id="nav.table.summary">
453
<refentrytitle>nav.table.summary</refentrytitle>
454
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
457
<refname>nav.table.summary</refname>
458
<refpurpose>HTML Table summary attribute value for navigation tables</refpurpose>
462
<programlisting xml:id="nav.table.summary.frag">
463
<xsl:param name="nav.table.summary">Navigation</xsl:param>
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>
474
<refentry version="5.0" xml:id="navtocwidth">
476
<refentrytitle>navtocwidth</refentrytitle>
477
<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
480
<refname>navtocwidth</refname>
481
<refpurpose>Specifies the width of the navigation table TOC</refpurpose>
485
<programlisting xml:id="navtocwidth.frag">
486
<xsl:param name="navtocwidth">220</xsl:param>
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>
496
<refentry version="5.0" xml:id="textbgcolor">
498
<refentrytitle>textbgcolor</refentrytitle>
499
<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
502
<refname>textbgcolor</refname>
503
<refpurpose>The background color of the table body</refpurpose>
507
<programlisting xml:id="textbgcolor.frag">
508
<xsl:param name="textbgcolor">white</xsl:param>
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>
519
<reference xml:id="toc">
520
<title>ToC Parameters</title>
521
<refentry version="5.0" xml:id="toc.blank.graphic">
523
<refentrytitle>toc.blank.graphic</refentrytitle>
524
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
527
<refname>toc.blank.graphic</refname>
528
<refpurpose>Use graphic for "blanks" in TOC?</refpurpose>
532
<programlisting xml:id="toc.blank.graphic.frag">
533
<xsl:param name="toc.blank.graphic" select="1"></xsl:param>
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>.
541
<para>Only applies with the tabular presentation is being used.</para>
545
<refentry version="5.0" xml:id="toc.blank.image">
547
<refentrytitle>toc.blank.image</refentrytitle>
548
<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
551
<refname>toc.blank.image</refname>
552
<refpurpose>The image for "blanks" in the TOC</refpurpose>
556
<programlisting xml:id="toc.blank.image.frag">
557
<xsl:param name="toc.blank.image">graphics/blank.gif</xsl:param>
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>
568
<refentry version="5.0" xml:id="toc.blank.text">
570
<refentrytitle>toc.blank.text</refentrytitle>
571
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
574
<refname>toc.blank.text</refname>
575
<refpurpose>The text for "blanks" in the TOC</refpurpose>
579
<programlisting xml:id="toc.blank.text.frag">
580
<xsl:param name="toc.blank.text">   </xsl:param>
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>
591
<refentry version="5.0" xml:id="toc.pointer.graphic">
593
<refentrytitle>toc.pointer.graphic</refentrytitle>
594
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
597
<refname>toc.pointer.graphic</refname>
598
<refpurpose>Use graphic for TOC pointer?</refpurpose>
602
<programlisting xml:id="toc.pointer.graphic.frag">
603
<xsl:param name="toc.pointer.graphic" select="1"></xsl:param>
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>.
611
<para>Only applies with the tabular presentation is being used.</para>
615
<refentry version="5.0" xml:id="toc.pointer.image">
617
<refentrytitle>toc.pointer.image</refentrytitle>
618
<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
621
<refname>toc.pointer.image</refname>
622
<refpurpose>The image for the "pointer" in the TOC</refpurpose>
626
<programlisting xml:id="toc.pointer.image.frag">
627
<xsl:param name="toc.pointer.image">graphics/arrow.gif</xsl:param>
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>
638
<refentry version="5.0" xml:id="toc.pointer.text">
640
<refentrytitle>toc.pointer.text</refentrytitle>
641
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
644
<refname>toc.pointer.text</refname>
645
<refpurpose>The text for the "pointer" in the TOC</refpurpose>
649
<programlisting xml:id="toc.pointer.text.frag">
650
<xsl:param name="toc.pointer.text"> > </xsl:param>
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>
661
<refentry version="5.0" xml:id="toc.spacer.graphic">
663
<refentrytitle>toc.spacer.graphic</refentrytitle>
664
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
667
<refname>toc.spacer.graphic</refname>
668
<refpurpose>Use graphic for TOC spacer?</refpurpose>
672
<programlisting xml:id="toc.spacer.graphic.frag">
673
<xsl:param name="toc.spacer.graphic" select="1"></xsl:param>
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>.
681
<para>Only applies with the tabular presentation is being used.</para>
685
<refentry version="5.0" xml:id="toc.spacer.image">
687
<refentrytitle>toc.spacer.image</refentrytitle>
688
<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
691
<refname>toc.spacer.image</refname>
692
<refpurpose>The image for spacing the TOC</refpurpose>
696
<programlisting xml:id="toc.spacer.image.frag">
697
<xsl:param name="toc.spacer.image">graphics/blank.gif</xsl:param>
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>
708
<refentry version="5.0" xml:id="toc.spacer.text">
710
<refentrytitle>toc.spacer.text</refentrytitle>
711
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
714
<refname>toc.spacer.text</refname>
715
<refpurpose>The text for spacing the TOC</refpurpose>
719
<programlisting xml:id="toc.spacer.text.frag">
720
<xsl:param name="toc.spacer.text">   </xsl:param>
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>
732
<appendix xml:id="stylesheet"><title>The Stylesheet</title>
734
<para>The <filename>param.xsl</filename> stylesheet is just a wrapper
735
around all these parameters.</para>
737
<programlisting xml:id="top">
739
<!-- This file is generated from param.xweb -->
741
<xsl:stylesheet exclude-result-prefixes="src" version="1.0">
743
<!-- ********************************************************************
744
$Id: param.xweb 7076 2007-07-18 16:20:33Z xmldoc $
745
********************************************************************
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.
751
******************************************************************** -->
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>
784
</xsl:stylesheet>
added
removed
doc/build/docbook-xsl-1.76.1/website/param.xml
