Difference between revisions of "ODFXSLTRunnerTask"
(→Parameters) |
(→Parameters) |
||
| Line 45: | Line 45: | ||
<table border="border"> | <table border="border"> | ||
<tr><th>Attribute</th><th>Description</th><th>Required</th></tr> | <tr><th>Attribute</th><th>Description</th><th>Required</th></tr> | ||
| − | <tr><td>name</td><td>name of the paramter.</td><td>Yes</td> | + | <tr><td valign="top">name</td><td>name of the paramter.</td><td valign="top">Yes</td> |
| − | <tr><td>expression</td><td>value of the paramter. | + | <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. | '''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>Yes</td> | + | </td><td valign="top">Yes</td> |
| + | </table> | ||
'''Note:''' The paramters <tt>if</tt> and <tt>unless</tt> which are supported by the <tt><xslt></tt> task are (not yet) supported. | '''Note:''' The paramters <tt>if</tt> and <tt>unless</tt> which are supported by the <tt><xslt></tt> task are (not yet) supported. | ||
Revision as of 10:32, 31 July 2008
Contents
Apply XSLT stylesheets to ODF documents with Ant
ODFXSLTRunnerTask is a task definition for Ant which allows to apply XSLT stylesheets to ODF documents similar to Ant's build-in <xslt> task.
Getting and building ODFXSLTRunnerTask
odfxsltrunnertask is build by a NetBeans project. After you have checked out the sources, you can open the project in NetBeans and build odfxsltrunnertask.
A binary release of odfxsltrunnertask.jar is available here.
Building and running odfxsltrunner.jar requires additional jar files. Please see Requirements for details.
Usage
To use odfxsltrunner.jar with Ant, you have to include the following task definition into your buildfile, where <path> 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 <project> element or locally within a single <target> element. It defines a new task <odfxslt> which allows to process ODF documents with XSLT stylesheets.
The new task supports the use of nested <param> elements which have the same meaning as the <param> child elements of the <xslt> task.
Parameters
| Attribute | Description | Required |
|---|---|---|
| in | specifies an ODF document to which the stylesheet is applied. | Yes, unless infile has been specified |
| infile | specifies a plain XML document to which the stylesheet is applied. | Yes, unless in has been specified |
| out | specifies an ODF document to which the result of the transformation is stored. 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. | Yes, unless outfile has been specified |
| outfile | specifies a plain XML document to which the result of the transformation is stored. | Yes, unless out has been specified |
| path | Specifies the stream within the ODF packages specified by in and out, which is the source or target of the transformation. | No |
| template | 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. | No: Default is "content.xml" |
| force | Specifies that the target file shall be recreated, even if it is newer than the source file or the stylesheet. | No: Default is false |
Parameters specified as nested elements
Param
Param specifies a parameter that is passed as XSLT parameter to the XSL stylesheet.
Parameters
| Attribute | Description | Required |
|---|---|---|
| name | name of the paramter. | Yes |
| expression | value of the paramter.
Note: All parameter values are passed as string values to the XSLT paramters specified by <xslt:param> elements within the stylesheet. | Yes |
Note: The paramters if and unless which are supported by the <xslt> task are (not yet) supported.
Requirements
odfxsltrunner requires J2RE 5, or a later version of Java. It further requires ODFDOM (at least version v0.6.1). The ODFDOM jar file must be either located in folder called lib next to the odfxsltrunner.jar file, or it must be in the classpath.
Note: ODFDOM v0.6.1 requires Apache's xerces. The jar file xercesImpl.jar also must exist in a folder lib next to odfxsltrunner.jar file, or it must be in the classpath.
