Google Git
Sign in
apache / ofbiz / ed08f7400905d2fa9d58fea1158690032affba06 / . / plugins / cmssite / template / docbook / slides / fo / param.xml
blob: 8f16212bda4e24ee9690405cb742c3fc4aac1d41 [file] [log] [blame]
<?xml version="1.0" encoding="ASCII"?>
<book version="5.0" xml:id="slides_fo_doc">
<info>
<title>Slides FO Parameter Reference</title>
<releaseinfo role="meta">
$Id$
</releaseinfo>
<author>
<personname>
<surname>Walsh</surname>
<firstname>Norman</firstname>
</personname>
</author>
<copyright>
<year>2002-2011</year>
<holder>Norman Walsh</holder>
</copyright>
<abstract>
<para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="../fo/">FO stylesheet
parameters</link> to control Slides FO output.</para>
</abstract>
</info>
<reference xml:id="fo">
<title>FO: General Params</title>
<refentry version="5.0" xml:id="slide.title.font.family">
<refmeta>
<refentrytitle>slide.title.font.family</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
<refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
</refmeta>
<refnamediv>
<refname>slide.title.font.family</refname>
<refpurpose>Specifies font family to use for slide titles</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="slide.title.font.family.frag">
&lt;xsl:param name="slide.title.font.family"&gt;Helvetica&lt;/xsl:param&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>Specifies the font family to use for slides titles.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="slide.font.family">
<refmeta>
<refentrytitle>slide.font.family</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
<refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
</refmeta>
<refnamediv>
<refname>slide.font.family</refname>
<refpurpose>Specifies font family to use for slide bodies</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="slide.font.family.frag">
&lt;xsl:param name="slide.font.family"&gt;Helvetica&lt;/xsl:param&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>Specifies the font family to use for slides bodies.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="foil.title.master">
<refmeta>
<refentrytitle>foil.title.master</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
</refmeta>
<refnamediv>
<refname>foil.title.master</refname>
<refpurpose>Specifies unitless font size to use for foil titles</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="foil.title.master.frag">
&lt;xsl:param name="foil.title.master"&gt;36&lt;/xsl:param&gt;
&lt;!-- Inconsistant use of point size? --&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>Specifies a unitless font size to use for foil titles; used in
combination with the <parameter>foil.title.size</parameter>
parameter.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="foil.title.size">
<refmeta>
<refentrytitle>foil.title.size</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
</refmeta>
<refnamediv>
<refname>foil.title.size</refname>
<refpurpose>Specifies font size to use for foil titles, including units</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="foil.title.size.frag">
&lt;xsl:param name="foil.title.size"&gt;
&lt;xsl:value-of select="$foil.title.master"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
&lt;/xsl:param&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter combines the value of the
<parameter>foil.title.master</parameter> parameter with a unit
specification. The default unit is <literal>pt</literal>
(points).</para>
</refsection>
</refentry>
</reference>
<reference xml:id="propsets">
<title>FO: Property Sets</title>
<refentry version="5.0" xml:id="slides.properties">
<refmeta>
<refentrytitle>slides.properties</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
</refmeta>
<refnamediv>
<refname>slides.properties</refname>
<refpurpose>Specifies properties for all slides</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="slides.properties.frag">
&lt;xsl:attribute-set name="slides.properties"&gt;
&lt;xsl:attribute name="font-family"&gt;
&lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter specifies properties that are applied to all slides.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="foilgroup.properties">
<refmeta>
<refentrytitle>foilgroup.properties</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
</refmeta>
<refnamediv>
<refname>foilgroup.properties</refname>
<refpurpose>Specifies properties for all foilgroups</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="foilgroup.properties.frag">
&lt;xsl:attribute-set name="foilgroup.properties"&gt;
&lt;xsl:attribute name="font-family"&gt;
&lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter specifies properties that are applied to all foilgroups.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="foil.subtitle.properties">
<refmeta>
<refentrytitle>foil.subtitle.properties</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
</refmeta>
<refnamediv>
<refname>foil.subtitle.properties</refname>
<refpurpose>Specifies properties for all foil subtitles</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="foil.subtitle.properties.frag">
&lt;xsl:attribute-set name="foil.subtitle.properties"&gt;
&lt;xsl:attribute name="font-family"&gt;
&lt;xsl:value-of select="$slide.title.font.family"&gt;&lt;/xsl:value-of&gt;
&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="text-align"&gt;center&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-size"&gt;
&lt;xsl:value-of select="$foil.title.master * 0.8"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="space-after"&gt;12pt&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter specifies properties that are applied to all foil subtitles.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="foil.properties">
<refmeta>
<refentrytitle>foil.properties</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
</refmeta>
<refnamediv>
<refname>foil.properties</refname>
<refpurpose>Specifies properties for all foils</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="foil.properties.frag">
&lt;xsl:attribute-set name="foil.properties"&gt;
&lt;xsl:attribute name="font-family"&gt;
&lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="margin-{$direction.align.start}"&gt;1in&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="margin-{$direction.align.end}"&gt;1in&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-size"&gt;
&lt;xsl:value-of select="$body.font.size"&gt;&lt;/xsl:value-of&gt;
&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter specifies properties that are applied to all foils.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="speakernote.properties">
<refmeta>
<refentrytitle>speakernote.properties</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
</refmeta>
<refnamediv>
<refname>speakernote.properties</refname>
<refpurpose>Specifies properties for all speakernotes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="speakernote.properties.frag">
&lt;xsl:attribute-set name="speakernote.properties"&gt;
&lt;xsl:attribute name="font-family"&gt;Times Roman&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-style"&gt;italic&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-size"&gt;12pt&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter specifies properties that are applied to all speakernotes.</para>
</refsection>
</refentry>
<refentry version="5.0" xml:id="running.foot.properties">
<refmeta>
<refentrytitle>running.foot.properties</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
</refmeta>
<refnamediv>
<refname>running.foot.properties</refname>
<refpurpose>Specifies properties for running foot on each slide</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting xml:id="running.foot.properties.frag">
&lt;xsl:attribute-set name="running.foot.properties"&gt;
&lt;xsl:attribute name="font-family"&gt;
&lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="font-size"&gt;14pt&lt;/xsl:attribute&gt;
&lt;xsl:attribute name="color"&gt;#9F9F9F&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;
</programlisting>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This parameter specifies properties that are applied to the
running foot area of each slide.</para>
</refsection>
</refentry>
</reference>
<appendix xml:id="styleheet"><title>The Stylesheet</title>
<para>The <filename>param.xsl</filename> stylesheet is just a wrapper
around all these parameters.</para>
<programlisting xml:id="top">
&lt;!-- This file is generated from param.xweb --&gt;
&lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;
&lt;!-- ********************************************************************
$Id$
********************************************************************
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.
******************************************************************** --&gt;
&lt;src:fragref linkend="slide.font.family.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="slide.title.font.family.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="foil.title.master.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="foil.title.size.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="foilgroup.properties.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="foil.properties.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="foil.subtitle.properties.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="running.foot.properties.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="speakernote.properties.frag"&gt;&lt;/src:fragref&gt;
&lt;src:fragref linkend="slides.properties.frag"&gt;&lt;/src:fragref&gt;
&lt;/xsl:stylesheet&gt;
</programlisting>
</appendix>
</book>