# Slides XHTML Parameter Reference

$Id$
Kövesdán Gábor
2012 Gábor Kövesdán

This is reference documentation for all user-configurable parameters in the DocBook XSL Slides XHTML stylesheet. Note that the Slides stylesheet for XHTML output is a customization layer of the DocBook XSL XHTML stylesheet. Therefore, in addition to the slides-specific parameters listed in this section, you can also use a number of XHTML stylesheet parameters to control Slides XHTML output.

## XHTML: General Params

disable.collapsible boolean
disable.collapsible Specifies whether collapsible rendering is enabled

        <xsl:param name="disable.collapsible">0</xsl:param>

#### Description

This parameter specifies whether elements marked as collapsible are generated as such in the output document.

disable.incremental boolean
disable.incremental Specifies whether incremental rendering is enabled

        <xsl:param name="disable.incremental">0</xsl:param>

#### Description

This parameter specifies whether elements marked as incremental are generated as such in the output document.

generate.copyright boolean
generate.copyright Specifies whether copyright is generated

        <xsl:param name="generate.copyright">1</xsl:param>

#### Description

This parameter specifies whether the copyright info is generated in the footer area.

generate.foilgroup.numbered.toc boolean
generate.foilgroup.numbered.toc Specifies whether foilgroups have a numbered TOC

        <xsl:param name="generate.foilgroup.numbered.toc">1</xsl:param>

#### Description

If TOC generation is turned on, this parameter specifies whether foilgroups have a numbered TOC. If disabled, TOC items will be bulleted, not numbered.

generate.foilgroup.toc boolean
generate.foilgroup.toc Specifies whether foilgroups have a TOC

        <xsl:param name="generate.foilgroup.toc">1</xsl:param>

#### Description

This parameter specifies whether foilgroups will contain a table of contents of the included foils.

generate.handoutnotes boolean
generate.handoutnotes Specifies whether handoutnotes are generated

        <xsl:param name="generate.handoutnotes">0</xsl:param>

#### Description

This parameter specifies whether handoutnotes shall be generated to the output.

generate.pubdate boolean
generate.pubdate Specifies whether the pubdate is generated

        <xsl:param name="generate.pubdate">1</xsl:param>

#### Description

This parameter specifies whether the publication date is generated in the footer area.

generate.speakernotes boolean
generate.speakernotes Specifies whether speakernotes are generated

        <xsl:param name="generate.speakernotes">0</xsl:param>

#### Description

This parameter specifies whether speakernotes shall be generated to the output.

generate.titlepage boolean
generate.titlepage Specifies whether titlepage is generated

        <xsl:param name="generate.titlepage">1</xsl:param>

#### Description

This parameter specifies whether titlepage is generated for the presentation.

mml.embedding.mode list inline object image link iframe embed
mml.embedding.mode Specifies how inline MathML is processed

        <xsl:param name="mml.embedding.mode">inline</xsl:param>

#### Description

This parameter specifies how inline MathML formulas are embedded into the output document.

inline

  Content is copied over inline with its namespace.

object

  Content is extracted into an externel file and referenced by an object element.

image

  Content is extracted into an externel file and referenced by an img element.

link

  Content is extracted into an externel file and referenced by an a element.

iframe

  Content is extracted into an externel file and referenced by an iframe element.

embed

  Content is extracted into an externel file and referenced by an embed element.

svg.embedding.mode list inline object image link iframe embed
svg.embedding.mode Specifies how inline SVG is processed

        <xsl:param name="svg.embedding.mode">object</xsl:param>

#### Description

This parameter specifies how inline SVG graphics are embedded into the output document.

inline

  Content is copied over inline with its namespace.

object

  Content is extracted into an externel file and referenced by an object element.

image

  Content is extracted into an externel file and referenced by an img element.

link

  Content is extracted into an externel file and referenced by an a element.

iframe

  Content is extracted into an externel file and referenced by an iframe element.

embed

  Content is extracted into an externel file and referenced by an embed element.

user.css filename
user.css Specifies the path to user-supplied CSS

        <xsl:param name="user.css">user.css</xsl:param>

#### Description

This parameter specifies the path from where the CSS styling is read. This file can be used to add additional styling to the slides.

wrap.slidecontent boolean
wrap.slidecontent Specifies whether the foil content is wrapped into a div

        <xsl:param name="wrap.slidecontent">0</xsl:param>

#### Description

This parameter specifies whether the foil content is wrapped into a div so that additional styling can be applied.

## XHTML: S5 Params

s5.controls boolean
s5.controls Specifies whether S5 controls are visible

        <xsl:param name="s5.controls">0</xsl:param>

#### Description

This parameter specifies whether S5 navigation controls are visible by default.

s5.defaultview list slideshow outline
s5.defaultview Specifies the default S5 view

        <xsl:param name="s5.defaultview">slideshow</xsl:param>

#### Description

This parameter specifies, which is the default view in the generated S5 presentation.

s5.opera.css filename
s5.opera.css Specifies the name of the S5 Opera-specific CSS file

        <xsl:param name="s5.opera.css">opera.css</xsl:param>

#### Description

This parameter specifies the name of the S5 Opera-specific CSS file.

s5.outline.css filename
s5.outline.css Specifies the name of the S5 outline CSS file

        <xsl:param name="s5.outline.css">outline.css</xsl:param>

#### Description

This parameter specifies the name of the S5 outline CSS file.

s5.path.prefix uri
s5.path.prefix Specifies the path to S5 files

        <xsl:param name="s5.path.prefix">files/s5/ui/default/</xsl:param>

#### Description

This parameter specifies the path where S5 CSS and JavaScript files reside. All the CSS and JavaScript paths will be generated relative to this directory.

s5.print.css filename
s5.print.css Specifies the name of the S5 print CSS file

        <xsl:param name="s5.print.css">print.css</xsl:param>

#### Description

This parameter specifies the name of the S5 print CSS file.

s5.slides.css filename
s5.slides.css Specifies the name of the S5 slides CSS file

        <xsl:param name="s5.slides.css">slides.css</xsl:param>

#### Description

This parameter specifies the name of the S5 slides CSS file.

s5.slides.js filename
s5.slides.js Specifies the name of the S5 slides JavaScript file

        <xsl:param name="s5.slides.js">slides.js</xsl:param>

#### Description

This parameter specifies the name of the S5 slides JavaScript file.

## XHTML: Slidy Params

slidy.duration integer
slidy.duration Specifies the duration of the presentation

        <xsl:param name="slidy.duration">0</xsl:param>

#### Description

This parameter specifies the duration of the presentation in minutes. A JavaScript clock will count down to help the speaker in not running out of time. Can be disabled if set to 0.

slidy.path.prefix uri
slidy.path.prefix Specifies the path to Slidy files

        <xsl:param name="slidy.path.prefix">files/slidy/</xsl:param>

#### Description

This parameter specifies the path where Slidy CSS and JavaScript files reside. All the CSS and JavaScript paths will be generated relative to this directory.

slidy.slidy.css filename
slidy.slidy.css Specifies the name of the main Slidy CSS file

        <xsl:param name="slidy.slidy.css">styles/slidy.css</xsl:param>

#### Description

This parameter specifies the name of the main Slidy CSS file.

slidy.slidy.js filename
slidy.slidy.js Specifies the name of the Slidy JavaScript file

        <xsl:param name="slidy.slidy.js">scripts/slidy.js</xsl:param>

#### Description

This parameter specifies the name of the Slidy JavaScript file.

slidy.user.css filename
slidy.user.css Specifies the name of the Slidy user CSS file

        <xsl:param name="slidy.user.css">styles/w3c-blue.css</xsl:param>

#### Description

This parameter specifies the name of the Slidy user CSS file.

## The Stylesheet

The `param.xsl` stylesheet is just a wrapper around all these parameters.

    <!-- This file is generated from param.xweb -->

    <xsl:stylesheet exclude-result-prefixes="src" version="1.0">

    <!-- ********************************************************************
         $Id: param.xweb 6633 2007-02-21 18:33:33Z xmldoc $
         ********************************************************************

         This file is part of the DocBook Slides Stylesheet distribution.
         See ../README or http://docbook.sf.net/release/xsl/current/ for
         copyright and other information.

         ******************************************************************** -->

    <src:fragref linkend="disable.collapsible.frag"></src:fragref>
    <src:fragref linkend="disable.incremental.frag"></src:fragref>
    <src:fragref linkend="generate.copyright.frag"></src:fragref>
    <src:fragref linkend="generate.foilgroup.numbered.toc.frag"></src:fragref>
    <src:fragref linkend="generate.foilgroup.toc.frag"></src:fragref>
    <src:fragref linkend="generate.handoutnotes.frag"></src:fragref>
    <src:fragref linkend="generate.pubdate.frag"></src:fragref>
    <src:fragref linkend="generate.speakernotes.frag"></src:fragref>
    <src:fragref linkend="generate.titlepage.frag"></src:fragref>
    <src:fragref linkend="mml.embedding.mode.frag"></src:fragref>
    <src:fragref linkend="svg.embedding.mode.frag"></src:fragref>
    <src:fragref linkend="user.css.frag"></src:fragref>
    <src:fragref linkend="wrap.slidecontent.frag"></src:fragref>

    <src:fragref linkend="s5.controls.frag"></src:fragref>
    <src:fragref linkend="s5.defaultview.frag"></src:fragref>
    <src:fragref linkend="s5.opera.css.frag"></src:fragref>
    <src:fragref linkend="s5.outline.css.frag"></src:fragref>
    <src:fragref linkend="s5.path.prefix.frag"></src:fragref>
    <src:fragref linkend="s5.print.css.frag"></src:fragref>
    <src:fragref linkend="s5.slides.css.frag"></src:fragref>
    <src:fragref linkend="s5.slides.js.frag"></src:fragref>

    <src:fragref linkend="slidy.duration.frag"></src:fragref>
    <src:fragref linkend="slidy.path.prefix.frag"></src:fragref>
    <src:fragref linkend="slidy.slidy.css.frag"></src:fragref>
    <src:fragref linkend="slidy.slidy.js.frag"></src:fragref>
    <src:fragref linkend="slidy.user.css.frag"></src:fragref>

    </xsl:stylesheet>