]> git.stg.codes - stg.git/blob - doc/xslt/roundtrip/param.xml
Added template specification.
[stg.git] / doc / xslt / roundtrip / param.xml
1 <?xml version="1.0" encoding="ASCII"?>
2 <book version="5.0">
3   <info>
4     <title>Roundtrip Parameter Reference</title>
5     <releaseinfo role="meta">
6       $Id: param.xweb 7042 2007-07-17 04:28:48Z xmldoc $
7     </releaseinfo>
8     <author>
9       <personname>
10       <surname>Ball</surname>
11       <firstname>Steve</firstname>
12       </personname>
13     </author>
14     <copyright>
15       <year>2007</year>
16       <year>2006</year>
17       <year>2005</year>
18       <year>2004</year>
19       <holder>Steve Ball</holder>
20     </copyright>
21     <abstract>
22       <para>This is reference documentation for all user-configurable
23       parameters in the DocBook &#8220;Roundtrip&#8221; Stylesheets (for
24       transforming DocBook to WordML, OpenDocument, and Apple Pages,
25       and for converting from those formats back to DocBook).</para>
26     </abstract>
27   </info>
28   <reference xml:id="params">
29   <title>Parameters</title>
30 <refentry version="5.0" xml:id="wordml.template">
31 <refmeta>
32 <refentrytitle>wordml.template</refentrytitle>
33 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
34 </refmeta>
35 <refnamediv>
36 <refname>wordml.template</refname>
37 <refpurpose>Specify the template WordML document</refpurpose>
38 </refnamediv>
39
40 <refsynopsisdiv>
41 <programlisting xml:id="wordml.template.frag">
42 &lt;xsl:param name="wordml.template"&gt;&lt;/xsl:param&gt;
43 </programlisting>
44 </refsynopsisdiv>
45
46 <refsection><info><title>Description</title></info>
47
48 <para>The <parameter>wordml.template</parameter> parameter specifies a WordML document to use as a template for the generated document.  The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements.  Any content in the template document is ignored.</para>
49
50 <para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Word itself, rather than these XSL stylesheets.</para>
51
52 </refsection>
53 </refentry>
54
55 <refentry version="5.0" xml:id="pages.template">
56 <refmeta>
57 <refentrytitle>pages.template</refentrytitle>
58 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
59 </refmeta>
60 <refnamediv>
61 <refname>pages.template</refname>
62 <refpurpose>Specify the template Pages document</refpurpose>
63 </refnamediv>
64
65 <refsynopsisdiv>
66 <programlisting xml:id="pages.template.frag">
67 &lt;xsl:param name="pages.template"&gt;&lt;/xsl:param&gt;
68 </programlisting>
69 </refsynopsisdiv>
70
71 <refsection><info><title>Description</title></info>
72
73 <para>The <parameter>pages.template</parameter> parameter specifies a Pages (the Apple word processing application) document to use as a template for the generated document.  The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements.  Any content in the template document is ignored.</para>
74
75 <para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Pages itself, rather than these XSL stylesheets.</para>
76
77 </refsection>
78 </refentry>
79
80   </reference>
81   <appendix xml:id="stylesheet">
82     <title>The Stylesheet</title>
83     <para>The <filename>param.xsl</filename> stylesheet is just a
84       wrapper around all of these parameters.</para>
85     <programlisting xml:id="top">
86 &lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;
87
88 &lt;!-- This file is generated from param.xweb --&gt;
89
90 &lt;!-- ********************************************************************
91      $Id: param.xweb 7042 2007-07-17 04:28:48Z xmldoc $
92      ********************************************************************
93
94      This file is part of the XSL DocBook Stylesheet distribution.
95      See ../README or http://docbook.sf.net/release/xsl/current/ for
96      copyright and other information.
97
98      ******************************************************************** --&gt;
99
100 &lt;src:fragref linkend="wordml.template.frag"&gt;&lt;/src:fragref&gt;
101 &lt;src:fragref linkend="pages.template.frag"&gt;&lt;/src:fragref&gt;
102 &lt;/xsl:stylesheet&gt;
103     </programlisting>
104   </appendix>
105 </book>