2008-10-19T03:48:25Z

Reverted to revision #2 60 ODFXSLTRunnerTask 13

__TOC__ == Apply XSLT stylesheets to ODF documents with Ant == '''ODFXSLTRunnerTask''' is a task definition for [http://ant.apache.org/ Ant] which allows to apply XSLT stylesheets to ODF documents similar to Ant's build-in <tt><xslt></tt> [http://ant.apache.org/manual/CoreTasks/style.html task]. == Getting and building ODFXSLTRunnerTask == '''odfxsltrunnertask''' is build by a NetBeans project. After you have checked out the [http://odftoolkit.openoffice.org/source/browse/odftoolkit/tools/odfxsltrunnertask/ sources], you can open the project in [http://www.netbeans.info/downloads/index.php NetBeans] and build '''odfxsltrunnertask'''. A binary release of '''odfxsltrunnertask.jar''' is [http://odftoolkit.openoffice.org/files/documents/254/4289/odfxsltrunnertask.jar available here]. Building and running '''odfxsltrunner.jar''' requires additional jar files. Please see [[#Requirements|Requirements]] for details. == Usage == To use '''odfxsltrunner.jar''' with Ant, you have to include the following [http://ant.apache.org/manual/CoreTasks/taskdef.html task definition] into your buildfile, where ''<tt><path></tt>'' has to be replaced with the path where you have stored the '''odfxsltrunnertask.jar''' and '''odfxsltrunner.jar''' files: <taskdef name="odfxslt" classname="odfxsltrunnertask.ODFXSLTRunnerTask" classpath="''<path>''/odfxsltrunnertak.jar:''<path>''/odfxsltrunner.jar"/> You can use this task definition on the top level (that is as a child element of the <tt><project></tt> element or locally within a single <tt><target></tt> element. It defines a new task <tt><odfxslt></tt> which allows to process ODF documents with XSLT stylesheets. The new task supports the use of nested <tt><param></tt> elements which have the same meaning as the <tt><param></tt> child elements of the <tt><xslt></tt> [http://ant.apache.org/manual/CoreTasks/style.html task]. == Parameters == <table border="border"> <tr><th>Attribute</th><th>Description</th><th>Required</th></tr> <tr><td valign="top">in</td><td>specifies an ODF document to which the stylesheet is applied.</td><td valign="top">Yes, unless infile has been specified</td></tr> <tr><td valign="top">infile</td><td>specifies a plain XML document to which the stylesheet is applied.</td><td valign="top">Yes, unless in has been specified</td></tr> <tr><td valign="top">out</td><td>specifies an ODF document to which the result of the transformation is stored.<br/> Unless template has been specified, the package specified by in is copied to out, and the stream specified by path is replaced with the result of the transformation.</td><td valign="top">Yes, unless outfile has been specified</td></tr> <tr><td valign="top">outfile</td><td>specifies a plain XML document to which the result of the transformation is stored.</td><td valign="top">Yes, unless out has been specified</td></tr> <tr><td valign="top">path</td><td>Specifies the stream within the ODF packages specified by in and out, which is the source or target of the transformation.</td><td valign="top">No</td></tr> <tr><td valign="top">template</td><td>Specifies that the specified stream within the out ODF package is replaced with the result of the transformation, without previously copying the package specified by in. The specified out package must exist.</td><td valign="top">No: Default is "content.xml"</td></tr> <tr><td valign="top">force</td><td>Specifies that the target file shall be recreated, even if it is newer than the source file or the stylesheet.</td><td valign="top">No: Default is false</td></tr> </table> == Parameters specified as nested elements == === Param === Param specifies a parameter that is passed as [http://www.w3.org/TR/1999/REC-xslt-19991116#top-level-variables XSLT parameter] to the XSL stylesheet. ==== Parameters ==== <table border="border"> <tr><th>Attribute</th><th>Description</th><th>Required</th></tr> <tr><td valign="top">name</td><td>name of the paramter.</td><td valign="top">Yes</td></tr> <tr><td valign="top">expression</td><td>value of the paramter. '''Note:''' All parameter values are passed as string values to the XSLT paramters specified by <tt><xslt:param></tt> elements within the stylesheet. </td><td valign="top">Yes</td></tr> </table> '''Note:''' The paramters <tt>if</tt> and <tt>unless</tt> which are supported by the <tt><xslt></tt> task are (not yet) supported. == Requirements == '''odfxsltrunnertask''' requires [http://java.sun.com/javase/downloads/index.jsp J2RE 5], or a later version of Java. It further requires [[ODFXSLTRunner]] and [http://odftoolkit.openoffice.org/servlets/ProjectDocumentList?folderID=759&expandFolder=759&folderID=771 ODFDOM] (at least version v0.6.1). '''Note:''' When building '''odfxsltrunertask''', the '''odfxsltrunner''' project has be checked out, too. It is build automatically. In the Ant task definition, the '''classpth''' attribute must include the '''odfxsltrunnertask.jar''' and '''odfxsltrunner.jar''' files. The ODFDOM jar file is found automatically if it is located in a folder called '''lib''' next to the '''odfxsltrunner.jar''' file. '''Note:''' [[ODFDOM]] v0.6.1 requires [http://xml.apache.org/dist/xerces-j/ Apache's xerces]. The jar file '''xercesImpl.jar''' also must exist in a folder '''lib''' next to '''odfxsltrunner.jar''' file. == Background Information == [http://blogs.sun.com/GullFOSS/entry/applying_xslt_stylesheets_to_odf Applying XSLT stylesheets to ODF documents with Ant]

<div id='toc' class='toc'> <div id='toctitle' class='toc-title'> <span>Contents</span> </div> <div id='toccontents' class='toc-contents'><ul><ul><li>1 <a href='#Apply_XSLT_stylesheets_to_ODF_documents_with_Ant'> Apply XSLT stylesheets to ODF documents with Ant </a></li> <li>2 <a href='#Getting_and_building_ODFXSLTRunnerTask'> Getting and building ODFXSLTRunnerTask </a></li> <li>3 <a href='#Usage'> Usage </a></li> <li>4 <a href='#Parameters'> Parameters </a></li> <li>5 <a href='#Parameters_specified_as_nested_elements'> Parameters specified as nested elements </a></li> <ul><li>5.1 <a href='#Param'> Param </a></li> <ul><li>5.1.1 <a href='#Parameters'> Parameters </a></li> </ul></ul><li>6 <a href='#Requirements'> Requirements </a></li> <li>7 <a href='#Background_Information'> Background Information </a></li> </ul></ul></div> </div><p><br /> </p><h2><a name='Apply_XSLT_stylesheets_to_ODF_documents_with_Ant'></a> Apply XSLT stylesheets to ODF documents with Ant </h2> <p><b>ODFXSLTRunnerTask</b> is a task definition for <a class='external' href="http://ant.apache.org/">Ant</a> which allows to apply XSLT stylesheets to ODF documents similar to Ant's build-in <tt><xslt></tt> <a class='external' href="http://ant.apache.org/manual/CoreTasks/style.html">task</a>. </p><h2><a name='Getting_and_building_ODFXSLTRunnerTask'></a> Getting and building ODFXSLTRunnerTask </h2> <p><b>odfxsltrunnertask</b> is build by a NetBeans project. After you have checked out the <a class='external' href="http://odftoolkit.openoffice.org/source/browse/odftoolkit/tools/odfxsltrunnertask/">sources</a>, you can open the project in <a class='external' href="http://www.netbeans.info/downloads/index.php">NetBeans</a> and build <b>odfxsltrunnertask</b>. </p><p>A binary release of <b>odfxsltrunnertask.jar</b> is <a class='external' href="http://odftoolkit.openoffice.org/files/documents/254/4289/odfxsltrunnertask.jar">available here</a>. </p><p>Building and running <b>odfxsltrunner.jar</b> requires additional jar files. Please see <a href='#Requirements' class='internal'>Requirements</a> for details. </p><h2><a name='Usage'></a> Usage </h2> <p> To use <b>odfxsltrunner.jar</b> with Ant, you have to include the following <a class='external' href="http://ant.apache.org/manual/CoreTasks/taskdef.html">task definition</a> into your buildfile, where <i><tt><path></tt></i> has to be replaced with the path where you have stored the <b>odfxsltrunnertask.jar</b> and <b>odfxsltrunner.jar</b> files: </p><pre> <taskdef name="odfxslt" classname="odfxsltrunnertask.ODFXSLTRunnerTask" classpath="<i><path></i>/odfxsltrunnertak.jar:<i><path></i>/odfxsltrunner.jar"/> </pre><p> You can use this task definition on the top level (that is as a child element of the <tt><project></tt> element or locally within a single <tt><target></tt> element. It defines a new task <tt><odfxslt></tt> which allows to process ODF documents with XSLT stylesheets. </p><p>The new task supports the use of nested <tt><param></tt> elements which have the same meaning as the <tt><param></tt> child elements of the <tt><xslt></tt> <a class='external' href="http://ant.apache.org/manual/CoreTasks/style.html">task</a>. </p><h2><a name='Parameters'></a> Parameters </h2> <p><table border="border"><tr><th>Attribute</th><th>Description</th><th>Required</th></tr><tr><td valign="top">in</td><td>specifies an ODF document to which the stylesheet is applied.</td><td valign="top">Yes, unless infile has been specified</td></tr><tr><td valign="top">infile</td><td>specifies a plain XML document to which the stylesheet is applied.</td><td valign="top">Yes, unless in has been specified</td></tr><tr><td valign="top">out</td><td>specifies an ODF document to which the result of the transformation is stored.<br /> Unless template has been specified, the package specified by in is copied to out, and the stream specified by path is replaced with the result of the transformation.</td><td valign="top">Yes, unless outfile has been specified</td></tr><tr><td valign="top">outfile</td><td>specifies a plain XML document to which the result of the transformation is stored.</td><td valign="top">Yes, unless out has been specified</td></tr><tr><td valign="top">path</td><td>Specifies the stream within the ODF packages specified by in and out, which is the source or target of the transformation.</td><td valign="top">No</td></tr><tr><td valign="top">template</td><td>Specifies that the specified stream within the out ODF package is replaced with the result of the transformation, without previously copying the package specified by in. The specified out package must exist.</td><td valign="top">No: Default is "content.xml"</td></tr><tr><td valign="top">force</td><td>Specifies that the target file shall be recreated, even if it is newer than the source file or the stylesheet.</td><td valign="top">No: Default is false</td></tr></table> </p><h2><a name='Parameters_specified_as_nested_elements'></a> Parameters specified as nested elements </h2> <h3><a name='Param'></a> Param </h3> <p> Param specifies a parameter that is passed as <a class='external' href="http://www.w3.org/TR/1999/REC-xslt-19991116#top-level-variables">XSLT parameter</a> to the XSL stylesheet. </p><h4><a name='Parameters'></a> Parameters </h4> <p><table border="border"><tr><th>Attribute</th><th>Description</th><th>Required</th></tr><tr><td valign="top">name</td><td>name of the paramter.</td><td valign="top">Yes</td></tr><tr><td valign="top">expression</td><td>value of the paramter. <b>Note:</b> All parameter values are passed as string values to the XSLT paramters specified by <tt><xslt:param></tt> elements within the stylesheet. </td><td valign="top">Yes</td></tr></table> </p><p><b>Note:</b> The paramters <tt>if</tt> and <tt>unless</tt> which are supported by the <tt><xslt></tt> task are (not yet) supported. </p><h2><a name='Requirements'></a> Requirements </h2> <p><b>odfxsltrunnertask</b> requires <a class='external' href="http://java.sun.com/javase/downloads/index.jsp">J2RE 5</a>, or a later version of Java. </p><p>It further requires <a href='<?url_for_page ODFXSLTRunner?>' class='internal'>ODFXSLTRunner</a> and <a class='external' href="http://odftoolkit.openoffice.org/servlets/ProjectDocumentList?folderID=759&expandFolder=759&folderID=771">ODFDOM</a> (at least version v0.6.1). </p><p><b>Note:</b> When building <b>odfxsltrunertask</b>, the <b>odfxsltrunner</b> project has be checked out, too. It is build automatically. </p><p>In the Ant task definition, the <b>classpth</b> attribute must include the <b>odfxsltrunnertask.jar</b> and <b>odfxsltrunner.jar</b> files. The ODFDOM jar file is found automatically if it is located in a folder called <b>lib</b> next to the <b>odfxsltrunner.jar</b> file. </p><p><b>Note:</b> <a href='<?url_for_page ODFDOM?>' class='internal'>ODFDOM</a> v0.6.1 requires <a class='external' href="http://xml.apache.org/dist/xerces-j/">Apache's xerces</a>. The jar file <b>xercesImpl.jar</b> also must exist in a folder <b>lib</b> next to <b>odfxsltrunner.jar</b> file. </p><h2><a name='Background_Information'></a> Background Information </h2> <p><a class='external' href="http://blogs.sun.com/GullFOSS/entry/applying_xslt_stylesheets_to_odf">Applying XSLT stylesheets to ODF documents with Ant</a></p>

2009-02-10T13:43:32Z