# Slides FO Parameter Reference

$Id: param.xweb 6633 2007-02-21 18:33:33Z xmldoc $
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 FO stylesheet (for generating PDF slide presentations). Note that the Slides stylesheet for FO output is a customization layer of the DocBook XSL FO stylesheet. Therefore, in addition to the slides-specific parameters listed in this section, you can also use a number of FO stylesheet parameters to control Slides FO output.

## FO: General Params

foil.title.master number
foil.title.master Specifies unitless font size to use for foil titles

    <xsl:param name="foil.title.master">36</xsl:param>
    <!-- Inconsistant use of point size? -->

#### Description

Specifies a unitless font size to use for foil titles; used in combination with the foil.title.size parameter.

foil.title.size length
foil.title.size Specifies font size to use for foil titles, including units

        <xsl:param name="foil.title.size">
          <xsl:value-of select="$foil.title.master"></xsl:value-of><xsl:text>pt</xsl:text>
        </xsl:param>

#### Description

This parameter combines the value of the foil.title.master parameter with a unit specification. The default unit is `pt` (points).

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.page.number list full1/2 compact1 no
generate.page.number Specifies whether page numbers are generated

        <xsl:param name="generate.page.number">compact</xsl:param>

#### Description

This parameter specifies how page numbers are generated in the footer area.

no

  No page numbers generated at all.

full

  Current page number, a slash and the total number of pages

compact

  Current page number only

no

  No page numbers generated at all.

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 external-graphic instream-foreign-object
mml.embedding.mode Specifies how inline MathML is processed

        <xsl:param name="mml.embedding.mode">external-graphic</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.

external-graphic

  Content is extracted into an externel file and referenced by an external-graphic element.

instream-foreign-object

  Content is copied over with its namespace inside an instream-foreign-object element.

slide.font.family list open serif sans-serif monospace
slide.font.family Specifies font family to use for slide bodies

    <xsl:param name="slide.font.family">Helvetica</xsl:param>

#### Description

Specifies the font family to use for slides bodies.

slide.title.font.family list open serif sans-serif monospace
slide.title.font.family Specifies font family to use for slide titles

    <xsl:param name="slide.title.font.family">Helvetica</xsl:param>

#### Description

Specifies the font family to use for slides titles.

svg.embedding.mode list external-graphic instream-foreign-object
svg.embedding.mode Specifies how inline SVG is processed

        <xsl:param name="svg.embedding.mode">instream-foreign-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.

external-graphic

  Content is extracted into an externel file and referenced by an external-graphic element.

instream-foreign-object

  Content is copied over with its namespace inside an instream-foreign-object element.

## FO: Property Sets

foil.header.properties attribute set
foil.header.properties Specifies properties for foil header area

        <xsl:attribute-set name="foil.header.properties">
          <xsl:attribute name="background-color">white</xsl:attribute>
          <xsl:attribute name="color">black</xsl:attribute>
          <xsl:attribute name="font-weight">bold</xsl:attribute>
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="font-family">
            <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="space-after">12pt</xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the foil header area.

foil.master.properties attribute set
foil.master.properties Specifies properties for foil master

        <xsl:attribute-set name="foil.master.properties">
          <xsl:attribute name="page-width">
            <xsl:value-of select="$page.width"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="page-height">
            <xsl:value-of select="$page.height"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-top">
            <xsl:value-of select="$page.margin.top"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-bottom">
            <xsl:value-of select="$page.margin.bottom"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-left">
            <xsl:value-of select="$page.margin.inner"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-right">
            <xsl:value-of select="$page.margin.outer"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the foil master.

foil.page-sequence.properties attribute set
foil.page-sequence.properties Specifies properties for foil page-sequence

        <xsl:attribute-set name="foil.page-sequence.properties">
          <xsl:attribute name="hyphenate">
            <xsl:value-of select="$hyphenate"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for foil page-sequence.

foil.properties attribute set
foil.properties Specifies properties for all foils

        <xsl:attribute-set name="foil.properties">
          <xsl:attribute name="font-family">
            <xsl:value-of select="$slide.font.family"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-{$direction.align.start}">1in</xsl:attribute>
          <xsl:attribute name="margin-{$direction.align.end}">1in</xsl:attribute>
          <xsl:attribute name="font-size">
            <xsl:value-of select="$body.font.size"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties that are applied to all foils.

foil.region-after.properties attribute set
foil.region-after.properties Specifies properties for foil region-after

        <xsl:attribute-set name="foil.region-after.properties">
          <xsl:attribute name="extent">
            <xsl:value-of select="$region.after.extent"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="display-align">after</xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the foil region-after.

foil.region-before.properties attribute set
foil.region-before.properties Specifies properties for foil region-before

        <xsl:attribute-set name="foil.region-before.properties">
          <xsl:attribute name="extent">
            <xsl:value-of select="$region.before.extent"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="display-align">
            <xsl:value-of select="'before'"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the foil region-before.

foil.region-body.properties attribute set
foil.region-body.properties Specifies properties for foil region-body

        <xsl:attribute-set name="foil.region-body.properties">
          <xsl:attribute name="margin-bottom">
            <xsl:value-of select="$body.margin.bottom"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-top">
            <xsl:value-of select="$body.margin.top"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="column-count">
            <xsl:value-of select="$column.count.body"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the foil region-body.

foil.subtitle.properties attribute set
foil.subtitle.properties Specifies properties for all foil subtitles

        <xsl:attribute-set name="foil.subtitle.properties">
          <xsl:attribute name="font-family">
            <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="font-size">
            <xsl:value-of select="$foil.title.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
          </xsl:attribute>
          <xsl:attribute name="space-after">12pt</xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties that are applied to all foil subtitles.

foil.title.properties attribute set
foil.title.properties Specifies properties for foil title

        <xsl:attribute-set name="foil.title.properties">
          <xsl:attribute name="font-size">
            <xsl:value-of select="$foil.title.size"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the foil title.

foil.footer.properties attribute set
foil.footer.properties Specifies properties for slides footer

        <xsl:attribute-set name="foil.footer.properties"></xsl:attribute-set>

#### Description

This parameter specifies properties for the foil footer.

handoutnotes.properties attribute set
footnote.properties Properties applied to handoutnotes

    <xsl:attribute-set name="handoutnotes.properties"></xsl:attribute-set>

#### Description

This attribute set is applied to handoutnotes.

slides.properties attribute set
slides.properties Specifies properties for all slides

        <xsl:attribute-set name="slides.properties">
          <xsl:attribute name="font-family">
            <xsl:value-of select="$slide.font.family"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties that are applied to all slides.

slides.titlepage.master.properties attribute set
slides.titlepage.master.properties Specifies properties for slides titlepage master

        <xsl:attribute-set name="slides.titlepage.master.properties">
          <xsl:attribute name="page-width">
            <xsl:value-of select="$page.width"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="page-height">
            <xsl:value-of select="$page.height"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-top">
            <xsl:value-of select="$page.margin.top"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-bottom">
            <xsl:value-of select="$page.margin.bottom"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-left">
            <xsl:value-of select="$page.margin.inner"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="margin-right">
            <xsl:value-of select="$page.margin.outer"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the slides titlepage master.

slides.titlepage.region-body.properties attribute set
slides.titlepage.region-body.properties Specifies properties for slides titlepage region-body

        <xsl:attribute-set name="slides.titlepage.region-body.properties">
          <xsl:attribute name="margin-bottom">0pt</xsl:attribute>
          <xsl:attribute name="margin-top">0pt</xsl:attribute>
          <xsl:attribute name="column-count">
            <xsl:value-of select="$column.count.body"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the slides titlepage region-body.

slides.titlepage.corpauthor.properties attribute set
slides.titlepage.corpauthor.properties Specifies properties for slides titlepage title

        <xsl:attribute-set name="slides.titlepage.corpauthor.properties">
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="space-after">1em</xsl:attribute>
          <xsl:attribute name="font-size">20.736pt</xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the corpauthor on the default titlepage.

slides.titlepage.title.properties attribute set
slides.titlepage.title.properties Specifies properties for slides titlepage title

        <xsl:attribute-set name="slides.titlepage.title.properties">
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="space-after">1em</xsl:attribute>
          <xsl:attribute name="padding-top">1.5in</xsl:attribute>
          <xsl:attribute name="keep-with-next">always</xsl:attribute>
          <xsl:attribute name="font-size">
    	<xsl:value-of select="$foil.title.size"></xsl:value-of>
          </xsl:attribute>
          <xsl:attribute name="font-weight">bold</xsl:attribute>
          <xsl:attribute name="font-family">
    	<xsl:value-of select="$slide.title.font.family"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the title on the default titlepage.

slides.titlepage.subtitle.properties attribute set
slides.titlepage.subtitle.properties Specifies properties for slides titlepage title

        <xsl:attribute-set name="slides.titlepage.subtitle.properties">
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="space-after">1em</xsl:attribute>
          <xsl:attribute name="font-family">
    	<xsl:value-of select="$slide.title.font.family"></xsl:value-of>
          </xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the subtitle on the default titlepage.

slides.titlepage.author.properties attribute set
slides.titlepage.author.properties Specifies properties for slides titlepage title

        <xsl:attribute-set name="slides.titlepage.author.properties">
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="space-after">1em</xsl:attribute>
          <xsl:attribute name="font-size">20.736pt</xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the author on the default titlepage.

slides.titlepage.pubdate.properties attribute set
slides.titlepage.pubdate.properties Specifies properties for slides titlepage title

        <xsl:attribute-set name="slides.titlepage.pubdate.properties">
          <xsl:attribute name="text-align">center</xsl:attribute>
          <xsl:attribute name="space-after">1em</xsl:attribute>
          <xsl:attribute name="font-size">17.28pt</xsl:attribute>
        </xsl:attribute-set>

#### Description

This parameter specifies properties for the pubdate on the default titlepage.

slides.titlepage.authorgroup.properties attribute set
slides.titlepage.authorgroup.properties Specifies properties for slides titlepage title

        <xsl:attribute-set name="slides.titlepage.authorgroup.properties"></xsl:attribute-set>

#### Description

This parameter specifies properties for the authorgroup on the default titlepage.

speakernotes.properties attribute set
footnote.properties Properties applied to speakernotes

    <xsl:attribute-set name="speakernotes.properties"></xsl:attribute-set>

#### Description

This attribute set is applied to speakernotes.

## 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="foil.title.master.frag"></src:fragref>
    <src:fragref linkend="foil.title.size.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.page.number.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.fo.frag"></src:fragref>
    <src:fragref linkend="slide.font.family.frag"></src:fragref>
    <src:fragref linkend="slide.title.font.family.frag"></src:fragref>
    <src:fragref linkend="svg.embedding.mode.fo.frag"></src:fragref>

    <src:fragref linkend="foil.header.properties.frag"></src:fragref>
    <src:fragref linkend="foil.master.properties.frag"></src:fragref>
    <src:fragref linkend="foil.page-sequence.properties.frag"></src:fragref>
    <src:fragref linkend="foil.properties.frag"></src:fragref>
    <src:fragref linkend="foil.region-after.properties.frag"></src:fragref>
    <src:fragref linkend="foil.region-before.properties.frag"></src:fragref>
    <src:fragref linkend="foil.region-body.properties.frag"></src:fragref>
    <src:fragref linkend="foil.subtitle.properties.frag"></src:fragref>
    <src:fragref linkend="foil.title.properties.frag"></src:fragref>
    <src:fragref linkend="handoutnotes.properties.frag"></src:fragref>
    <src:fragref linkend="slides.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.master.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.region-body.properties.frag"></src:fragref>
    <src:fragref linkend="speakernotes.properties.frag"></src:fragref>

    <src:fragref linkend="slides.titlepage.corpauthor.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.title.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.subtitle.properties.frag"></src:fragref>
    <src:fragref linkend="foil.footer.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.author.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.pubdate.properties.frag"></src:fragref>
    <src:fragref linkend="slides.titlepage.authorgroup.properties.frag"></src:fragref>

    </xsl:stylesheet>