2008-11-07T12:23:17Z
Reverted to revision #2
93
ODFXSLTRunnerExamples
10
12
= ODF XSLT Runner and ODF XSLT Runner Task Examples =
__TOC__
The '''samle_xslt''' folder contained in the [http://odftoolkit.org/sources/odf-xslt-Runner-src/show source code] of the ODF XSLT Runner project contains several example XSLT style sheets.
The '''build_xref.xml''' file contained in the [[ODF XSLT Runner]] project contains several targets that run these style sheets using '''ODF XSLT Runner'''.
The '''build_xref.xml''' file contained in the [[ODF XSLT Runner Task]] project contains several targets that run these style sheets using '''ODF XSLT Runner Task'''.
== create_flat_schema.xsl ==
This XSLT style sheets converts an ODF schema into a simplified "flat" variant by resolving Relax-NG <tt>ref</tt> elements and by making several other simplifications.
The resulting "flat schema" contains all <tt>element</tt> elements as children of the <tt>grammar</tt> element, regardless whether these may occur on top level or not. These element have <tt>attribute</tt> child elements for all attributes that may be used with the element, and optionally <tt>element</tt> elements for all child elements.
The resulting schema is not equivalent to the source schema, and it must not be used for validating documents. Instead its purpose is to provide a basis for creating cross references regarding the ODF specification.
This stylesheet does neither take an ODF document as input nor does it produce one. It therfore can be called by an usual XSLT processor. It may also be called by odfxsltrunner using the following command line:
java -jar odfxsltrunner.jar create_flat_schema.xsl -i <(strict) ODF schema-file> -o <flat ODF schema file>
The following paramters control the conversion:
{|- border="1"
!name
!values
!description
|-
|<tt>incl-default-values</tt>
|'''<tt>true</tt>''',<tt>false</tt>
|If <tt>true</tt>, default values specified by <tt>a:defaultValue</tt> attributes are preserved.
|-
|<tt>incl-types</tt>
|'''<tt>true</tt>''',<tt>false</tt>
|If <tt>true</tt>, the content of <tt>attribute</tt> elements is preserved. <tt>ref</tt> elements within attribute definitions are not resolved.
|-
|<tt>incl-conditions</tt>
|'''<tt>true</tt>''',<tt>false</tt>
|If <tt>true</tt>, <tt>attribute</tt> and <tt>element</tt> elements get a <tt>condition</tt> attribute that contains all ancestor <tt>choice</tt>, <tt>optional</tt>, etc. elements as an XPath expression, up to the next <tt>element</tt> element. <tt>combine="interleave"</tt> attributes that occur at <tt>define</tt> elements that are resolved are converted into an <tt>interlave</tt> XPath component. <tt>combine="interleave"</tt> attributes are converted into <tt>interleave</tt>.
|-
|<tt>incl-elements</tt>
|<tt>true</tt>,'''<tt>false</tt>'''
|If <tt>true</tt>, information regarding child elements is included..
|}
== create-attribute-xref.xsl ==
This style sheet creates an attribute cross reference from a flat ODF schema which has been created using '''create_flat_schema.xsl'''. The cross reference is a spreadsheet that list all elements that ODF defines, the attributes that these may have, and their data types.
The input is a flat schema, the output a '''content.xml''' that may be used with an appropriate ODF spreadsheet. An example spreadhseet is included in the '''misc''' folder. It has the name '''odf-attribute-xref.odt'''
The following commands creates the ODF attribute reference:
cp <odf xslt runner folder>/misc/odf-attribute-xref.odt odf-attribute-xref.odt
java -jar odfxsltrunner.jar <odf xslt runner folder>/sample_xslt/create_flat_schema.xsl -i <(strict) ODF schema-file> -o flat-odf-schema.rng
java -jar odfxsltrunner.jar <odf xslt runner folder>/sample_xslt/create-attribute-xref.xsl -i flat-odf-schema.rng -t odf-attribute-xref.odt "incl-conditions=false" "incl-default-values=true" "incl-types=true" "incl-elements=false"
<h1><a name='ODF_XSLT_Runner_and_ODF_XSLT_Runner_Task_Examples'></a> ODF XSLT Runner and ODF XSLT Runner Task Examples </h1>
<div id='toc' class='toc'>
<div id='toctitle' class='toc-title'>
<span>Contents</span>
</div>
<div id='toccontents' class='toc-contents'><ul><li>1 <a href='#ODF_XSLT_Runner_and_ODF_XSLT_Runner_Task_Examples'> ODF XSLT Runner and ODF XSLT Runner Task Examples </a></li>
<ul><li>1.1 <a href='#create_flat_schema.xsl'> create_flat_schema.xsl </a></li>
<li>1.2 <a href='#create-attribute-xref.xsl'> create-attribute-xref.xsl </a></li>
</ul></ul></div>
</div><p><br />
</p><p>The <b>samle_xslt</b> folder contained in the <a class='external' href="http://odftoolkit.org/sources/odf-xslt-Runner-src/show">source code</a> of the ODF XSLT Runner project contains several example XSLT style sheets.
</p><p>The <b>build_xref.xml</b> file contained in the <a href='<?url_for_page ODF XSLT Runner?>' class='internal'>ODF XSLT Runner</a> project contains several targets that run these style sheets using <b>ODF XSLT Runner</b>.
</p><p>The <b>build_xref.xml</b> file contained in the <a href='<?url_for_page ODF XSLT Runner Task?>' class='internal'>ODF XSLT Runner Task</a> project contains several targets that run these style sheets using <b>ODF XSLT Runner Task</b>.
</p><h2><a name='create_flat_schema.xsl'></a> create_flat_schema.xsl </h2>
<p>
This XSLT style sheets converts an ODF schema into a simplified "flat" variant by resolving Relax-NG <tt>ref</tt> elements and by making several other simplifications.
</p><p>The resulting "flat schema" contains all <tt>element</tt> elements as children of the <tt>grammar</tt> element, regardless whether these may occur on top level or not. These element have <tt>attribute</tt> child elements for all attributes that may be used with the element, and optionally <tt>element</tt> elements for all child elements.
</p><p>The resulting schema is not equivalent to the source schema, and it must not be used for validating documents. Instead its purpose is to provide a basis for creating cross references regarding the ODF specification.
</p><p>This stylesheet does neither take an ODF document as input nor does it produce one. It therfore can be called by an usual XSLT processor. It may also be called by odfxsltrunner using the following command line:
</p><pre> java -jar odfxsltrunner.jar create_flat_schema.xsl -i <(strict) ODF schema-file> -o <flat ODF schema file>
</pre><p>
The following paramters control the conversion:
</p><div style="overflow-x: auto;"><div style="margin: 0px 2px 0px 2px;">
<table - border="1"><tr><th>name
</th><th>values
</th><th>description
</th></tr>
<tr><td><tt>incl-default-values</tt></td><td><b><tt>true</tt></b>,<tt>false</tt></td><td>If <tt>true</tt>, default values specified by <tt>a:defaultValue</tt> attributes are preserved.
</td></tr>
<tr><td><tt>incl-types</tt></td><td><b><tt>true</tt></b>,<tt>false</tt></td><td>If <tt>true</tt>, the content of <tt>attribute</tt> elements is preserved. <tt>ref</tt> elements within attribute definitions are not resolved.
</td></tr>
<tr><td><tt>incl-conditions</tt></td><td><b><tt>true</tt></b>,<tt>false</tt></td><td>If <tt>true</tt>, <tt>attribute</tt> and <tt>element</tt> elements get a <tt>condition</tt> attribute that contains all ancestor <tt>choice</tt>, <tt>optional</tt>, etc. elements as an XPath expression, up to the next <tt>element</tt> element. <tt>combine="interleave"</tt> attributes that occur at <tt>define</tt> elements that are resolved are converted into an <tt>interlave</tt> XPath component. <tt>combine="interleave"</tt> attributes are converted into <tt>interleave</tt>.
</td></tr>
<tr><td><tt>incl-elements</tt></td><td><tt>true</tt>,<b><tt>false</tt></b></td><td>If <tt>true</tt>, information regarding child elements is included..
</td></tr>
</table>
</div></div>
<h2><a name='create-attribute-xref.xsl'></a> create-attribute-xref.xsl </h2>
<p>
This style sheet creates an attribute cross reference from a flat ODF schema which has been created using <b>create_flat_schema.xsl</b>. The cross reference is a spreadsheet that list all elements that ODF defines, the attributes that these may have, and their data types.
</p><p>The input is a flat schema, the output a <b>content.xml</b> that may be used with an appropriate ODF spreadsheet. An example spreadhseet is included in the <b>misc</b> folder. It has the name <b>odf-attribute-xref.odt</b>
</p><p>The following commands creates the ODF attribute reference:
</p><pre> cp <odf xslt runner folder>/misc/odf-attribute-xref.odt odf-attribute-xref.odt
java -jar odfxsltrunner.jar <odf xslt runner folder>/sample_xslt/create_flat_schema.xsl -i <(strict) ODF schema-file> -o flat-odf-schema.rng
java -jar odfxsltrunner.jar <odf xslt runner folder>/sample_xslt/create-attribute-xref.xsl -i flat-odf-schema.rng -t odf-attribute-xref.odt "incl-conditions=false" "incl-default-values=true" "incl-types=true" "incl-elements=false"
</pre>
2009-02-13T14:34:02Z
51