From: Norman Walsh Date: Thu, 30 May 2002 00:33:10 +0000 (+0000) Subject: Updated documentation; added overlay.logo parameter X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=22d834c78ece644d2c7edcd4e69da5ea94096e2e;p=docbook-dsssl Updated documentation; added overlay.logo parameter --- diff --git a/slides/xsl/param.xweb b/slides/xsl/param.xweb index 4584dc6bc..ec2ee8709 100644 --- a/slides/xsl/param.xweb +++ b/slides/xsl/param.xweb @@ -58,11 +58,11 @@ to be incomplete. Don't forget to read the source, too :-) keyboard.nav - +boolean keyboard.nav - +Enable keyboard navigation? @@ -73,7 +73,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +If non-zero, JavaScript is added to the slides to enable keyboard +navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves +backward. @@ -81,11 +83,11 @@ to be incomplete. Don't forget to read the source, too :-) css.stylesheet - +URI css.stylesheet - +CSS stylesheet for slides @@ -96,7 +98,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. @@ -104,11 +108,11 @@ to be incomplete. Don't forget to read the source, too :-) titlefoil.html - +filename titlefoil.html - +Name of title foil HTML file @@ -119,7 +123,7 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Sets the filename used for the slides titlepage. @@ -127,11 +131,11 @@ to be incomplete. Don't forget to read the source, too :-) toc.html - +filename toc.html - +Name of ToC HTML file @@ -142,7 +146,7 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Sets the filename used for the table of contents page. @@ -150,11 +154,13 @@ to be incomplete. Don't forget to read the source, too :-) output.indent - +list +no +yes output.indent - +Indent output? @@ -165,7 +171,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. @@ -173,11 +181,11 @@ to be incomplete. Don't forget to read the source, too :-) overlay - +boolean overlay - +Overlay footer navigation? @@ -188,7 +196,12 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. @@ -201,11 +214,11 @@ to be incomplete. Don't forget to read the source, too :-) nav.separator - +boolean nav.separator - +Output separator between navigation and body? @@ -216,7 +229,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +If non-zero, a separator (<HR>) is +added between the navigation links and the content of each slide. @@ -224,11 +238,11 @@ to be incomplete. Don't forget to read the source, too :-) toc.row.height - +length toc.row.height - +Height of ToC rows in dynamic ToCs @@ -239,7 +253,12 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. + @@ -247,11 +266,11 @@ to be incomplete. Don't forget to read the source, too :-) toc.bg.color - +color toc.bg.color - +Background color for ToC frame @@ -262,7 +281,7 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the background color used in the ToC frame. @@ -270,11 +289,11 @@ to be incomplete. Don't forget to read the source, too :-) toc.width - +length toc.width - +Width of ToC frame @@ -285,7 +304,7 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the width of the ToC frame. @@ -293,11 +312,11 @@ to be incomplete. Don't forget to read the source, too :-) toc.hide.show - +boolean toc.hide.show - +Enable hide/show button for ToC frame @@ -308,7 +327,13 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. @@ -316,11 +341,11 @@ to be incomplete. Don't forget to read the source, too :-) dynamic.toc - +boolean dynamic.toc - +Dynamic ToCs? @@ -331,7 +356,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. @@ -339,11 +366,11 @@ to be incomplete. Don't forget to read the source, too :-) active.toc - +boolean active.toc - +Active ToCs? @@ -354,7 +381,33 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. + + + + + @@ -362,11 +415,11 @@ to be incomplete. Don't forget to read the source, too :-) multiframe - +boolean multiframe - +Use multiple frames for slide bodies? @@ -377,7 +430,13 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +If 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. @@ -385,11 +444,11 @@ to be incomplete. Don't forget to read the source, too :-) multiframe.top.bgcolor - +color multiframe.top.bgcolor - +Background color for top navigation frame @@ -400,7 +459,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the background color of the top navigation frame when +multiframe is enabled. @@ -408,11 +468,11 @@ to be incomplete. Don't forget to read the source, too :-) multiframe.bottom.bgcolor - +color multiframe.bottom.bgcolor - +Background color for bottom navigation frame @@ -423,7 +483,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the background color of the bottom navigation frame when +multiframe is enabled. @@ -431,11 +492,11 @@ to be incomplete. Don't forget to read the source, too :-) multiframe.navigation.height - +length multiframe.navigation.height - +Height of navigation frames @@ -446,7 +507,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the height of the navigation frames when +multiframe is enabled. @@ -459,11 +521,11 @@ to be incomplete. Don't forget to read the source, too :-) graphics.dir - +URI graphics.dir - +Graphics directory @@ -474,7 +536,13 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. @@ -482,11 +550,11 @@ to be incomplete. Don't forget to read the source, too :-) bullet.image - +filename bullet.image - +Bullet image @@ -497,7 +565,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the bullet image used for foils in the +framed ToC. @@ -505,11 +574,11 @@ to be incomplete. Don't forget to read the source, too :-) right.image - +filename right.image - +Right-arrow image @@ -520,7 +589,7 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the right-pointing navigation arrow. @@ -528,11 +597,11 @@ to be incomplete. Don't forget to read the source, too :-) left.image - +filename left.image - +Left-arrow image @@ -543,7 +612,7 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the left-pointing navigation arrow. @@ -551,11 +620,11 @@ to be incomplete. Don't forget to read the source, too :-) plus.image - +filename plus.image - +Plus image @@ -566,7 +635,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the plus image; the image used in a +dynamic ToC to indicate that a section +can be expanded. @@ -574,11 +645,11 @@ to be incomplete. Don't forget to read the source, too :-) minus.image - +filename minus.image - +Minus image @@ -589,7 +660,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the minus image; the image used in a +dynamic ToC to indicate that a section +can be collapsed. @@ -597,11 +670,11 @@ to be incomplete. Don't forget to read the source, too :-) hidetoc.image - +filename hidetoc.image - +Hide ToC image @@ -612,7 +685,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the hide ToC image. This is used +when the ToC hide/show parameter is +enabled. @@ -620,11 +695,11 @@ to be incomplete. Don't forget to read the source, too :-) showtoc.image - +filename showtoc.image - +Show ToC image @@ -635,7 +710,9 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the show ToC image. This is used +when the ToC hide/show parameter is +enabled. @@ -648,11 +725,11 @@ to be incomplete. Don't forget to read the source, too :-) script.dir - +URI script.dir - +Script directory @@ -663,7 +740,13 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +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. + @@ -671,11 +754,11 @@ to be incomplete. Don't forget to read the source, too :-) ua.js - +filename ua.js - +UA JavaScript file @@ -686,7 +769,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the UA JavaScript file. It's unlikely +that you will ever need to change this parameter. @@ -694,11 +778,11 @@ to be incomplete. Don't forget to read the source, too :-) xbDOM.js - +filename xbDOM.js - +xbDOM JavaScript file @@ -709,7 +793,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the xbDOM JavaScript file. It's unlikely +that you will ever need to change this parameter. @@ -717,11 +802,11 @@ to be incomplete. Don't forget to read the source, too :-) xbStyle.js - +filename xbStyle.js - +xbStyle JavaScript file @@ -732,7 +817,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the xbStyle JavaScript file. It's unlikely +that you will ever need to change this parameter. @@ -740,11 +826,11 @@ to be incomplete. Don't forget to read the source, too :-) xbCollapsibleLists.js - +filename xbCollapsibleLists.js - +xbCollapsibleLists JavaScript file @@ -755,7 +841,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely +that you will ever need to change this parameter. @@ -763,11 +850,11 @@ to be incomplete. Don't forget to read the source, too :-) overlay.js - +filename overlay.js - +Overlay JavaScript file @@ -778,7 +865,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the overlay JavaScript file. It's unlikely +that you will ever need to change this parameter. @@ -786,11 +874,11 @@ to be incomplete. Don't forget to read the source, too :-) slides.js - +filename slides.js - +Slides overlay file @@ -801,7 +889,8 @@ to be incomplete. Don't forget to read the source, too :-) Description -FIXME: +Specifies the filename of the slides JavaScript file. It's unlikely +that you will ever need to change this parameter. @@ -824,7 +913,7 @@ around all these parameters. $Id$ ******************************************************************** - This file is part of the XSL DocBook Stylesheet distribution. + This file is part of the DocBook Slides Stylesheet distribution. See ../README or http://nwalsh.com/docbook/xsl/ for copyright and other information. @@ -843,6 +932,7 @@ around all these parameters. +