Slides (HTML) Parameter Reference
$Id: param.xweb,v 1.9 2005/06/17 08:38:11 xmldoc Exp $
WalshNorman2002Norman WalshIntroductionThis is reference documentation for all user-configurable
parameters in the DocBook XSL Slides HTML stylesheets (for generating
HTML output from DocBook Slides documents).There currently are no Slides parameters for FO
output.This reference describes each of the parameters.
These are the easily customizable parts of the stylesheet.
If you want to specify an alternate value for one or more of these
parameters, you can do so in a driver stylesheet.For example, if you want to change the keyboard.nav
parameter to 0, you might create a driver
stylesheet like this:
]]>Naturally, you have to change the
href attribute on
<xsl:import> to point to the stylesheet
on your system.General Parameterskeyboard.navbooleankeyboard.navEnable keyboard navigation?DescriptionIf non-zero, JavaScript is added to the slides to enable keyboard
navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves
backward.css.stylesheetURIcss.stylesheetCSS stylesheet for slidesDescriptionIdentifies the CSS stylesheet used by all the slides. This parameter
can be set in the source document with the <?dbhtml?> pseudo-attribute
css-stylesheet.css.stylesheet.dirURIcss.stylesheet.dirDefault directory for CSS stylesheetsDescriptionIdentifies the default directory for the CSS stylesheet
generated on all the slides. This parameter can be set in the source
document with the <?dbhtml?> pseudo-attribute
css-stylesheet-dir.If non-empty, this value is prepended to each of the stylesheets.
titlefoil.htmlfilenametitlefoil.htmlName of title foil HTML fileDescriptionSets the filename used for the slides titlepage.toc.htmlfilenametoc.htmlName of ToC HTML fileDescriptionSets the filename used for the table of contents page.foilgroup.tocbooleanfoilgroup.tocPut ToC on foilgroup pages?DescriptionIf non-zero, a ToC will be placed on foilgroup pages (after any
other content).
output.indentlistnoyesoutput.indentIndent output?DescriptionSpecifies the setting of the indent parameter
on the HTML slides. For more information, see the discussion of the
xsl:output element in the XSLT specification.overlaybooleanoverlayOverlay footer navigation?DescriptionIf non-zero, JavaScript is added to the slides to make the
bottom navigation appear at the bottom of each page. This option and
multiframe are mutually exclusive.If this parameter is zero, the bottom navigation simply appears
below the content of each slide.show.foil.numberbooleanshow.foil.numberShow foil number on each foil?DescriptionIf non-zero, on each slide there will be its number. Currently
not supported in all output formats.Frame Parametersnav.separatorbooleannav.separatorOutput separator between navigation and body?DescriptionIf non-zero, a separator (<HR>) is
added between the navigation links and the content of each slide.toc.row.heightlengthtoc.row.heightHeight of ToC rows in dynamic ToCsDescriptionThis parameter specifies the height of each row in the table of
contents. This is only applicable if a dynamic ToC is used. You may want to
adjust this parameter for optimal appearance with the font and image sizes
selected by your CSS stylesheet.
toc.bg.colorcolortoc.bg.colorBackground color for ToC frameDescriptionSpecifies the background color used in the ToC frame.body.bg.colorcolorbody.bg.colorBackground color for body frameDescriptionSpecifies the background color used in the body column of tabular slides.toc.widthlengthtoc.widthWidth of ToC frameDescriptionSpecifies the width of the ToC frame.toc.hide.showbooleantoc.hide.showEnable hide/show button for ToC frameDescriptionIf non-zero, JavaScript (and an additional icon, see
hidetoc.image and
showtoc.image) is added to each slide
to allow the ToC panel to be toggled on each panel.There is a bug in Mozilla 1.0 (at least as of CR3) that causes
the browser to reload the titlepage when this feature is used.dynamic.tocbooleandynamic.tocDynamic ToCs?DescriptionIf non-zero, JavaScript is used to make the ToC panel dynamic.
In a dynamic ToC, each section in the ToC can be expanded and collapsed by
clicking on the appropriate image.active.tocbooleanactive.tocActive ToCs?DescriptionIf non-zero, JavaScript is used to keep the ToC and the current slide
in sync. That is, each time the slide changes, the corresponding
ToC entry will be underlined.overlay.logoURIoverlay.logoLogo to overlay on ToC frameDescriptionIf this URI is non-empty, JavaScript is used to overlay the
specified image on the ToC frame.multiframebooleanmultiframeUse multiple frames for slide bodies?DescriptionIf non-zero, multiple frames are used for the body of each
slide. This is one way of forcing the slide navigation elements to
appear in constant locations. The other way is with overlays. The overlay and
multiframe parameters are mutually
exclusive.multiframe.top.bgcolorcolormultiframe.top.bgcolorBackground color for top navigation frameDescriptionSpecifies the background color of the top navigation frame when
multiframe is enabled.multiframe.bottom.bgcolorcolormultiframe.bottom.bgcolorBackground color for bottom navigation frameDescriptionSpecifies the background color of the bottom navigation frame when
multiframe is enabled.multiframe.navigation.heightlengthmultiframe.navigation.heightHeight of navigation framesDescriptionSpecifies the height of the navigation frames when
multiframe is enabled.Graphics Parametersgraphics.dirURIgraphics.dirGraphics directoryDescriptionIdentifies the graphics directory for the navigation components
generated on all the slides. This parameter can be set in the source
document with the <?dbhtml?> pseudo-attribute
graphics-dir.If non-empty, this value is prepended to each of the graphic
image paths.bullet.imagefilenamebullet.imageBullet imageDescriptionSpecifies the filename of the bullet image used for foils in the
framed ToC.next.imagefilenamenext.imageRight-arrow imageDescriptionSpecifies the filename of the right-pointing navigation arrow.prev.imagefilenameprev.imageLeft-arrow imageDescriptionSpecifies the filename of the left-pointing navigation arrow.up.imagefilenameup.imageUp-arrow imageDescriptionSpecifies the filename of the upward-pointing navigation arrow.home.imagefilenamehome.imageHome imageDescriptionSpecifies the filename of the home navigation icon.toc.imagefilenametoc.imageToC imageDescriptionSpecifies the filename of the ToC navigation icon.no.next.imagefilenameno.next.imageInactive right-arrow imageDescriptionSpecifies the filename of the inactive right-pointing navigation arrow.no.prev.imagefilenameno.prev.imageInactive left-arrow imageDescriptionSpecifies the filename of the inactive left-pointing navigation arrow.no.up.imagefilenameno.up.imageInactive up-arrow imageDescriptionSpecifies the filename of the inactive upward-pointing navigation arrow.no.home.imagefilenameno.home.imageInactive home imageDescriptionSpecifies the filename of the inactive home navigation icon.no.toc.imagefilenameno.toc.imageInactive ToC imageDescriptionSpecifies the filename of the inactive ToC navigation icon.plus.imagefilenameplus.imagePlus imageDescriptionSpecifies the filename of the plus image; the image used in a
dynamic ToC to indicate that a section
can be expanded.minus.imagefilenameminus.imageMinus imageDescriptionSpecifies the filename of the minus image; the image used in a
dynamic ToC to indicate that a section
can be collapsed.hidetoc.imagefilenamehidetoc.imageHide ToC imageDescriptionSpecifies the filename of the hide ToC image. This is used
when the ToC hide/show parameter is
enabled.showtoc.imagefilenameshowtoc.imageShow ToC imageDescriptionSpecifies the filename of the show ToC image. This is used
when the ToC hide/show parameter is
enabled.JavaScript Parametersscript.dirURIscript.dirScript directoryDescriptionIdentifies the JavaScript source directory for the slides.
This parameter can be set in the source
document with the <?dbhtml?> pseudo-attribute
script-dir.If non-empty, this value is prepended to each of the JavaScript files.
ua.jsfilenameua.jsUA JavaScript fileDescriptionSpecifies the filename of the UA JavaScript file. It's unlikely
that you will ever need to change this parameter.xbDOM.jsfilenamexbDOM.jsxbDOM JavaScript fileDescriptionSpecifies the filename of the xbDOM JavaScript file. It's unlikely
that you will ever need to change this parameter.xbStyle.jsfilenamexbStyle.jsxbStyle JavaScript fileDescriptionSpecifies the filename of the xbStyle JavaScript file. It's unlikely
that you will ever need to change this parameter.xbLibrary.jsfilenamexbLibrary.jsxbLibrary JavaScript fileDescriptionSpecifies the filename of the xbLibrary JavaScript file. It's unlikely
that you will ever need to change this parameter.xbCollapsibleLists.jsfilenamexbCollapsibleLists.jsxbCollapsibleLists JavaScript fileDescriptionSpecifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely
that you will ever need to change this parameter.overlay.jsfilenameoverlay.jsOverlay JavaScript fileDescriptionSpecifies the filename of the overlay JavaScript file. It's unlikely
that you will ever need to change this parameter.slides.jsfilenameslides.jsSlides overlay fileDescriptionSpecifies the filename of the slides JavaScript file. It's unlikely
that you will ever need to change this parameter.Localization Parameterstext.homestringtext.homeHomeDescriptionFIXME:text.tocstringtext.tocFIXME:DescriptionFIXME:text.prevstringtext.prevFIXME:DescriptionFIXME:text.upstringtext.upFIXME:DescriptionFIXME:text.nextstringtext.nextFIXME:DescriptionFIXME:The StylesheetThe param.xsl stylesheet is just a wrapper
around all these parameters.