$Id: param.xweb,v 1.3 2002/05/30 12:06:25 nwalsh Exp $
Copyright © 2002 Norman Walsh
Table of Contents
This is reference documentation for the Slides stylesheet parameters.
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:
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> <xsl:import href="http://docbook.sourceforge.net/release/slides/current/xsl/slides.xsl"/> <xsl:param name="keyboard.nav" select="0"/> </xsl:stylesheet>
Naturally, you have to change the href attribute on <xsl:import> to point to the stylesheet on your system.
This is not intended to be “user” documentation. It is provided for developers writing customization layers for the stylesheets, and for anyone who's interested in “how it works”.
Although I am trying to be thorough, this documentation is known to be incomplete. Don't forget to read the source, too :-)
Table of Contents
keyboard.nav — Enable keyboard navigation?
If non-zero, JavaScript is added to the slides to enable keyboard navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves backward.
css.stylesheet — CSS stylesheet for slides
Identifies the CSS stylesheet used by all the slides. This parameter can be set in the source document with the <?dbhtml?> pseudo-attribute css-stylesheet.
titlefoil.html — Name of title foil HTML file
Sets the filename used for the slides titlepage.
toc.html — Name of ToC HTML file
Sets the filename used for the table of contents page.
output.indent — Indent output?
Specifies 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.
overlay — Overlay footer navigation?
If 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.
Table of Contents
nav.separator — Output separator between navigation and body?
If non-zero, a separator (<HR>) is added between the navigation links and the content of each slide.
toc.row.height — Height of ToC rows in dynamic ToCs
This 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.color — Background color for ToC frame
Specifies the background color used in the ToC frame.
body.bg.color — Background color for body frame
Specifies the background color used in the body column of tabular slides.
toc.hide.show — Enable hide/show button for ToC frame
If 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.toc — Dynamic ToCs?
If 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.toc — Active ToCs?
If 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.logo — Logo to overlay on ToC frame
§15: §35 |
1| <xsl:param name="overlay.logo" 2| select="'http://docbook.sourceforge.net/release/buttons/slides-1.png'"/> |
If this URI is non-empty, JavaScript is used to overlay the specified image on the ToC frame.
multiframe.top.bgcolor — Background color for top navigation frame
Specifies the background color of the top navigation frame when multiframe is enabled.
multiframe.bottom.bgcolor — Background color for bottom navigation frame
Specifies the background color of the bottom navigation frame when multiframe is enabled.
multiframe.navigation.height — Height of navigation frames
Specifies the height of the navigation frames when multiframe is enabled.
Table of Contents
graphics.dir — Graphics directory
Identifies 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.image — Bullet image
Specifies the filename of the bullet image used for foils in the framed ToC.
right.image — Right-arrow image
Specifies the filename of the right-pointing navigation arrow.
left.image — Left-arrow image
Specifies the filename of the left-pointing navigation arrow.
plus.image — Plus image
Specifies the filename of the “plus” image; the image used in a dynamic ToC to indicate that a section can be expanded.
minus.image — Minus image
Specifies the filename of the “minus” image; the image used in a dynamic ToC to indicate that a section can be collapsed.
hidetoc.image — Hide ToC image
Specifies the filename of the “hide ToC” image. This is used when the ToC hide/show parameter is enabled.
showtoc.image — Show ToC image
Specifies the filename of the “show ToC” image. This is used when the ToC hide/show parameter is enabled.
Table of Contents
script.dir — Script directory
Identifies 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.js — UA JavaScript file
Specifies the filename of the UA JavaScript file. It's unlikely that you will ever need to change this parameter.
xbDOM.js — xbDOM JavaScript file
Specifies the filename of the xbDOM JavaScript file. It's unlikely that you will ever need to change this parameter.
xbStyle.js — xbStyle JavaScript file
Specifies the filename of the xbStyle JavaScript file. It's unlikely that you will ever need to change this parameter.
xbCollapsibleLists.js — xbCollapsibleLists JavaScript file
Specifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely that you will ever need to change this parameter.
overlay.js — Overlay JavaScript file
Specifies the filename of the overlay JavaScript file. It's unlikely that you will ever need to change this parameter.
The param.xsl stylesheet is just a wrapper around all these parameters.
§35 |
1| | <!-- This file is generated from param.xweb; do not edit this file! --> | | <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 5| exclude-result-prefixes="src" | version="1.0"> | | <!-- ******************************************************************** | $Id: param.xweb,v 1.3 2002/05/30 12:06:25 nwalsh Exp $ 10| ******************************************************************** | | This file is part of the DocBook Slides Stylesheet distribution. | See ../README or http://nwalsh.com/docbook/xsl/ for copyright | and other information. 15| | ******************************************************************** --> | | §1. keyboard.nav | §2. css.stylesheet 20| §3. titlefoil.html | §4. toc.html | §5. output.indent | §6. overlay | §7. nav.separator 25| §8. toc.row.height | §9. toc.bg.color | §11. toc.width | §12. toc.hide.show | §13. dynamic.toc 30| §10. body.bg.color | §14. active.toc | §15. overlay.logo | §16. multiframe | §17. multiframe.top.bgcolor 35| §18. multiframe.bottom.bgcolor | §19. multiframe.navigation.height | §20. graphics.dir | §21. bullet.image | §22. right.image 40| §23. left.image | §24. plus.image | §25. minus.image | §26. hidetoc.image | §27. showtoc.image 45| §28. script.dir | §29. ua.js | §30. xbDOM.js | §31. xbStyle.js | §32. xbCollapsibleLists.js 50| §33. overlay.js | §34. slides.js | | </xsl:stylesheet> |