doc/xslt/slides/fo/param.xml

   1 <?xml version="1.0" encoding="ASCII"?>
   2 <book version="5.0" xml:id="slides_fo_doc">
   3 <info>
   4 <title>Slides FO Parameter Reference</title>
   5 <releaseinfo role="meta">
   6 $Id: param.xweb 6633 2007-02-21 18:33:33Z xmldoc $
   7 </releaseinfo>
   8 <author>
   9   <personname>
  10     <surname>Walsh</surname>
  11     <firstname>Norman</firstname>
  12   </personname>
  13 </author>
  14 <copyright>
  15   <year>2002</year>
  16   <holder>Norman Walsh</holder>
  17 </copyright>
  18 <abstract>
  19   <para>This is reference documentation for all user-configurable
  20     parameters in the DocBook XSL Slides FO stylesheet (for
  21     generating PDF slide presentations). Note that the Slides
  22     stylesheet for FO output is a customization layer of the
  23     DocBook XSL FO stylesheet. Therefore, in addition to the
  24     slides-specific parameters listed in this section, you can
  25     also use a number of <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="../fo/">FO stylesheet
  26     parameters</link> to control Slides FO output.</para>
  27 </abstract>
  28 </info>
  29 <reference xml:id="fo">
  30   <title>FO: General Params</title>
  31 <refentry version="5.0" xml:id="slide.title.font.family">
  32 <refmeta>
  33 <refentrytitle>slide.title.font.family</refentrytitle>
  34 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  35 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
  36 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
  37 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
  38 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
  39 </refmeta>
  40 <refnamediv>
  41 <refname>slide.title.font.family</refname>
  42 <refpurpose>Specifies font family to use for slide titles</refpurpose>
  43 </refnamediv>
  44
  45 <refsynopsisdiv>
  46 <programlisting xml:id="slide.title.font.family.frag">
  47 &lt;xsl:param name="slide.title.font.family"&gt;Helvetica&lt;/xsl:param&gt;
  48 </programlisting>
  49 </refsynopsisdiv>
  50
  51 <refsection><info><title>Description</title></info>
  52
  53 <para>Specifies the font family to use for slides titles.</para>
  54
  55 </refsection>
  56 </refentry>
  57
  58 <refentry version="5.0" xml:id="slide.font.family">
  59 <refmeta>
  60 <refentrytitle>slide.font.family</refentrytitle>
  61 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  62 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
  63 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
  64 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
  65 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
  66 </refmeta>
  67 <refnamediv>
  68 <refname>slide.font.family</refname>
  69 <refpurpose>Specifies font family to use for slide bodies</refpurpose>
  70 </refnamediv>
  71
  72 <refsynopsisdiv>
  73 <programlisting xml:id="slide.font.family.frag">
  74 &lt;xsl:param name="slide.font.family"&gt;Helvetica&lt;/xsl:param&gt;
  75 </programlisting>
  76 </refsynopsisdiv>
  77
  78 <refsection><info><title>Description</title></info>
  79
  80 <para>Specifies the font family to use for slides bodies.</para>
  81
  82 </refsection>
  83 </refentry>
  84
  85 <refentry version="5.0" xml:id="foil.title.master">
  86 <refmeta>
  87 <refentrytitle>foil.title.master</refentrytitle>
  88 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
  89 </refmeta>
  90 <refnamediv>
  91 <refname>foil.title.master</refname>
  92 <refpurpose>Specifies unitless font size to use for foil titles</refpurpose>
  93 </refnamediv>
  94
  95 <refsynopsisdiv>
  96 <programlisting xml:id="foil.title.master.frag">
  97 &lt;xsl:param name="foil.title.master"&gt;36&lt;/xsl:param&gt;
  98 &lt;!-- Inconsistant use of point size? --&gt;
  99 </programlisting>
 100 </refsynopsisdiv>
 101
 102 <refsection><info><title>Description</title></info>
 103
 104 <para>Specifies a unitless font size to use for foil titles; used in
 105 combination with the <parameter>foil.title.size</parameter>
 106 parameter.</para>
 107 </refsection>
 108 </refentry>
 109
 110 <refentry version="5.0" xml:id="foil.title.size">
 111 <refmeta>
 112 <refentrytitle>foil.title.size</refentrytitle>
 113 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
 114 </refmeta>
 115 <refnamediv>
 116 <refname>foil.title.size</refname>
 117 <refpurpose>Specifies font size to use for foil titles, including units</refpurpose>
 118 </refnamediv>
 119
 120 <refsynopsisdiv>
 121   <programlisting xml:id="foil.title.size.frag">
 122     &lt;xsl:param name="foil.title.size"&gt;
 123       &lt;xsl:value-of select="$foil.title.master"&gt;&lt;/xsl:value-of&gt;&lt;xsl:text&gt;pt&lt;/xsl:text&gt;
 124     &lt;/xsl:param&gt;
 125   </programlisting>
 126 </refsynopsisdiv>
 127
 128 <refsection><info><title>Description</title></info>
 129
 130 <para>This parameter combines the value of the
 131 <parameter>foil.title.master</parameter> parameter with a unit
 132 specification. The default unit is <literal>pt</literal>
 133 (points).</para>
 134
 135 </refsection>
 136 </refentry>
 137
 138 </reference>
 139 <reference xml:id="propsets">
 140   <title>FO: Property Sets</title>
 141 <refentry version="5.0" xml:id="slides.properties">
 142 <refmeta>
 143 <refentrytitle>slides.properties</refentrytitle>
 144 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
 145 </refmeta>
 146 <refnamediv>
 147 <refname>slides.properties</refname>
 148 <refpurpose>Specifies properties for all slides</refpurpose>
 149 </refnamediv>
 150
 151 <refsynopsisdiv>
 152   <programlisting xml:id="slides.properties.frag">
 153     &lt;xsl:attribute-set name="slides.properties"&gt;
 154       &lt;xsl:attribute name="font-family"&gt;
 155         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
 156       &lt;/xsl:attribute&gt;
 157     &lt;/xsl:attribute-set&gt;
 158   </programlisting>
 159 </refsynopsisdiv>
 160
 161 <refsection><info><title>Description</title></info>
 162
 163 <para>This parameter specifies properties that are applied to all slides.</para>
 164
 165 </refsection>
 166 </refentry>
 167
 168 <refentry version="5.0" xml:id="foilgroup.properties">
 169 <refmeta>
 170 <refentrytitle>foilgroup.properties</refentrytitle>
 171 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
 172 </refmeta>
 173 <refnamediv>
 174 <refname>foilgroup.properties</refname>
 175 <refpurpose>Specifies properties for all foilgroups</refpurpose>
 176 </refnamediv>
 177
 178 <refsynopsisdiv>
 179   <programlisting xml:id="foilgroup.properties.frag">
 180     &lt;xsl:attribute-set name="foilgroup.properties"&gt;
 181       &lt;xsl:attribute name="font-family"&gt;
 182         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
 183       &lt;/xsl:attribute&gt;
 184     &lt;/xsl:attribute-set&gt;
 185   </programlisting>
 186 </refsynopsisdiv>
 187
 188 <refsection><info><title>Description</title></info>
 189
 190 <para>This parameter specifies properties that are applied to all foilgroups.</para>
 191
 192 </refsection>
 193 </refentry>
 194
 195 <refentry version="5.0" xml:id="foil.subtitle.properties">
 196 <refmeta>
 197 <refentrytitle>foil.subtitle.properties</refentrytitle>
 198 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
 199 </refmeta>
 200 <refnamediv>
 201 <refname>foil.subtitle.properties</refname>
 202 <refpurpose>Specifies properties for all foil subtitles</refpurpose>
 203 </refnamediv>
 204
 205 <refsynopsisdiv>
 206   <programlisting xml:id="foil.subtitle.properties.frag">
 207     &lt;xsl:attribute-set name="foil.subtitle.properties"&gt;
 208       &lt;xsl:attribute name="font-family"&gt;
 209         &lt;xsl:value-of select="$slide.title.font.family"&gt;&lt;/xsl:value-of&gt;
 210       &lt;/xsl:attribute&gt;
 211       &lt;xsl:attribute name="text-align"&gt;center&lt;/xsl:attribute&gt;
 212       &lt;xsl:attribute name="font-size"&gt;
 213         &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;
 214       &lt;/xsl:attribute&gt;
 215       &lt;xsl:attribute name="space-after"&gt;12pt&lt;/xsl:attribute&gt;
 216     &lt;/xsl:attribute-set&gt;
 217   </programlisting>
 218 </refsynopsisdiv>
 219
 220 <refsection><info><title>Description</title></info>
 221
 222 <para>This parameter specifies properties that are applied to all foil subtitles.</para>
 223
 224 </refsection>
 225 </refentry>
 226
 227 <refentry version="5.0" xml:id="foil.properties">
 228 <refmeta>
 229 <refentrytitle>foil.properties</refentrytitle>
 230 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
 231 </refmeta>
 232 <refnamediv>
 233 <refname>foil.properties</refname>
 234 <refpurpose>Specifies properties for all foils</refpurpose>
 235 </refnamediv>
 236
 237 <refsynopsisdiv>
 238   <programlisting xml:id="foil.properties.frag">
 239     &lt;xsl:attribute-set name="foil.properties"&gt;
 240       &lt;xsl:attribute name="font-family"&gt;
 241         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
 242       &lt;/xsl:attribute&gt;
 243       &lt;xsl:attribute name="margin-{$direction.align.start}"&gt;1in&lt;/xsl:attribute&gt;
 244       &lt;xsl:attribute name="margin-{$direction.align.end}"&gt;1in&lt;/xsl:attribute&gt;
 245       &lt;xsl:attribute name="font-size"&gt;
 246         &lt;xsl:value-of select="$body.font.size"&gt;&lt;/xsl:value-of&gt;
 247       &lt;/xsl:attribute&gt;
 248       &lt;xsl:attribute name="font-weight"&gt;bold&lt;/xsl:attribute&gt;
 249     &lt;/xsl:attribute-set&gt;
 250   </programlisting>
 251 </refsynopsisdiv>
 252
 253 <refsection><info><title>Description</title></info>
 254
 255 <para>This parameter specifies properties that are applied to all foils.</para>
 256
 257 </refsection>
 258 </refentry>
 259
 260 <refentry version="5.0" xml:id="speakernote.properties">
 261 <refmeta>
 262 <refentrytitle>speakernote.properties</refentrytitle>
 263 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
 264 </refmeta>
 265 <refnamediv>
 266 <refname>speakernote.properties</refname>
 267 <refpurpose>Specifies properties for all speakernotes</refpurpose>
 268 </refnamediv>
 269
 270 <refsynopsisdiv>
 271   <programlisting xml:id="speakernote.properties.frag">
 272     &lt;xsl:attribute-set name="speakernote.properties"&gt;
 273       &lt;xsl:attribute name="font-family"&gt;Times Roman&lt;/xsl:attribute&gt;
 274       &lt;xsl:attribute name="font-style"&gt;italic&lt;/xsl:attribute&gt;
 275       &lt;xsl:attribute name="font-size"&gt;12pt&lt;/xsl:attribute&gt;
 276       &lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
 277     &lt;/xsl:attribute-set&gt;
 278   </programlisting>
 279 </refsynopsisdiv>
 280
 281 <refsection><info><title>Description</title></info>
 282
 283 <para>This parameter specifies properties that are applied to all speakernotes.</para>
 284
 285 </refsection>
 286 </refentry>
 287
 288 <refentry version="5.0" xml:id="running.foot.properties">
 289 <refmeta>
 290 <refentrytitle>running.foot.properties</refentrytitle>
 291 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
 292 </refmeta>
 293 <refnamediv>
 294 <refname>running.foot.properties</refname>
 295 <refpurpose>Specifies properties for running foot on each slide</refpurpose>
 296 </refnamediv>
 297
 298 <refsynopsisdiv>
 299   <programlisting xml:id="running.foot.properties.frag">
 300     &lt;xsl:attribute-set name="running.foot.properties"&gt;
 301       &lt;xsl:attribute name="font-family"&gt;
 302         &lt;xsl:value-of select="$slide.font.family"&gt;&lt;/xsl:value-of&gt;
 303       &lt;/xsl:attribute&gt;
 304       &lt;xsl:attribute name="font-size"&gt;14pt&lt;/xsl:attribute&gt;
 305       &lt;xsl:attribute name="color"&gt;#9F9F9F&lt;/xsl:attribute&gt;
 306     &lt;/xsl:attribute-set&gt;
 307   </programlisting>
 308 </refsynopsisdiv>
 309
 310 <refsection><info><title>Description</title></info>
 311
 312 <para>This parameter specifies properties that are applied to the
 313 running foot area of each slide.</para>
 314
 315 </refsection>
 316 </refentry>
 317
 318 </reference>
 319
 320 <appendix xml:id="styleheet"><title>The Stylesheet</title>
 321
 322 <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
 323 around all these parameters.</para>
 324
 325 <programlisting xml:id="top">
 326
 327 &lt;!-- This file is generated from param.xweb --&gt;
 328
 329 &lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;
 330
 331 &lt;!-- ********************************************************************
 332      $Id: param.xweb 6633 2007-02-21 18:33:33Z xmldoc $
 333      ********************************************************************
 334
 335      This file is part of the DocBook Slides Stylesheet distribution.
 336      See ../README or http://docbook.sf.net/release/xsl/current/ for
 337      copyright and other information.
 338
 339      ******************************************************************** --&gt;
 340
 341 &lt;src:fragref linkend="slide.font.family.frag"&gt;&lt;/src:fragref&gt;
 342 &lt;src:fragref linkend="slide.title.font.family.frag"&gt;&lt;/src:fragref&gt;
 343 &lt;src:fragref linkend="foil.title.master.frag"&gt;&lt;/src:fragref&gt;
 344 &lt;src:fragref linkend="foil.title.size.frag"&gt;&lt;/src:fragref&gt;
 345 &lt;src:fragref linkend="foilgroup.properties.frag"&gt;&lt;/src:fragref&gt;
 346 &lt;src:fragref linkend="foil.properties.frag"&gt;&lt;/src:fragref&gt;
 347 &lt;src:fragref linkend="foil.subtitle.properties.frag"&gt;&lt;/src:fragref&gt;
 348 &lt;src:fragref linkend="running.foot.properties.frag"&gt;&lt;/src:fragref&gt;
 349 &lt;src:fragref linkend="speakernote.properties.frag"&gt;&lt;/src:fragref&gt;
 350 &lt;src:fragref linkend="slides.properties.frag"&gt;&lt;/src:fragref&gt;
 351
 352 &lt;/xsl:stylesheet&gt;
 353 </programlisting>
 354
 355 </appendix>
 356 </book>