General

+ +

General¶

About
Downloads
License
Privacy Policy

Components

Components¶

Community

Community¶

Development

Development¶

PPMC

PPMC¶

ASF

ASF¶

Apache Software Foundation
Thanks

ODF XSLT Runner

Simplify the application of XSLT stylesheets to ODF documents

+ +

Simplify the application of XSLT stylesheets to ODF documents¶

ODF XSLT Runner is a small Java application that allows you to apply XSLT stylesheets to XML streams included in ODF packages without extracting them from the package. It can be used from the command line. A driver to use it within Ant buildfiles is also available.

Getting and building ODF XSLT Runner

Getting and building ODF XSLT Runner¶

ODF XSLT Runner is build by a NetBeans project. After you have checked out the sources from the Mercurial repository, you can open the project in NetBeans and build odfxsltrunner.

A binary release of odfxsltrunner.jar is available in the ODF Toolkit binary package. Please download here.
-If you need the earlier single jars, please access here.
-

+If you need the earlier single jars, please access here.

Building and running odfxsltrunner.jar requires additional jar files. Please see Requirements for details.

Command Line Options

Command Line Options¶

ODF XSLT Runner is called by one of the below command lines:

java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package>]
-  [-l log file] <input package> [<output package> [name=value ...]
+java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package>]
+  [-l log file] <input package> [<output package> [name=value ...]
 
- java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package>]
- [-l log file] -t <input package&gt; <output package&gt; [name=value ...]
+ java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package>]
+ [-l log file] -t <input package&gt; <output package&gt; [name=value ...]
 
- java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package&gt;]
-  [-l log file] -r <package> [name=value ...]
+ java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package&gt;]
+  [-l log file] -r <package> [name=value ...]
 
- java -jar odfxsltrunner.jar <style sheet>; [-v] [-f <factory>] [-p <path in package&gt;]
-  [-l log file] [-x <extract path> ...] -o <input package> <output file> [name=value ...]
+ java -jar odfxsltrunner.jar <style sheet>; [-v] [-f <factory>] [-p <path in package&gt;]
+  [-l log file] [-x <extract path> ...] -o <input package> <output file> [name=value ...]
 
- java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package&gt;]
-  [-l log file] -i <input file> <output package> [name=value ...]
+ java -jar odfxsltrunner.jar <style sheet> [-v] [-f <factory>] [-p <path in package&gt;]
+  [-l log file] -i <input file> <output package> [name=value ...]
 
 
 
@@ -139,14 +159,14 @@ If no 
 The -r option allows to modify the content.xml stream (or the stream specified by the -p option) in place. If it is specified, the result of the transformation just replaces the stream that was the source of the transformation. This option should be used with care, because it modifies the original input ODF file.
 The -v option enables a verbose mode.
 The -f option specifies the ''javax.xml.transform.TransformerFactory'' to use. Note: When calling ''java'' with the ''-jar'' option, the user class path is ignored. If a transformer factory is used which is not contained in the JRE, like Saxon, odfxsltrunner has to be called without the ''-jar'' option:
- java -cp odfxsltrunner.jar:&lt;factory jar&gt; org.odftoolkit.odfxsltrunner.Main ...
+ java -cp odfxsltrunner.jar:&lt;factory jar&gt; org.odftoolkit.odfxsltrunner.Main ...
 
 
 
 The -l option can be used to redirect diagnostic messages into a log file. 
 By default they are printed on standard error.
 XSLT Parameters can be passed to the transformation by specifying them as name=value pairs. They must appear behind all other command line parameters.
-URI resolution/document() function
+URI resolution/document() function¶
 If the source of a transformation is an ODF package, the XSLT 
 document function can be used to access other files in the package than 
 the one that is the source of the transformation. To do so, the first parameter 
@@ -162,11 +182,11 @@ containing the document() funct
 the rules ODF defines for resolving relative URIs only for URIs that are 
 relative to a file within an ODF package.
 Example: When transforming a content.xml file contained in an ODF package, the following rule applies templates to the style elements contained in the style.xml file:
- <xsl:apply-templates select="document('styles.xml',.)//office:styles/style:style"/>
+ <xsl:apply-templates select="document('styles.xml',.)//office:styles/style:style"/>
 
 
 
-Requirements
+Requirements¶
 ODF XSLT Runner requires J2RE 5, or a later version of Java.
 It further requires ODFDOM. The NetBeans project is pre-configured to build 
 ODFDOM while building ODF XSLT Runner. This requires that the ODFDOM 
@@ -181,7 +201,7 @@ also must exist in a folder lib<
 must be in the classpath. The ODF XSLT Runner NetBeans projects includes a 
 reference to xersesImpl.jar in the runtime classpath which has to be 
 adapted after checking out the project.

-Examples
+Examples¶
 Example stylesheets can be found on the ODFXSLTRunner Examples page.
   

 

Modified: websites/staging/odftoolkit/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerExamples.html
==============================================================================
--- websites/staging/odftoolkit/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerExamples.html (original)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerExamples.html Tue Apr 11 23:13:30 2017
@@ -50,7 +50,18 @@
   
   
   
-    General
+    
+General¶
 
 About
 Downloads
@@ -58,21 +69,21 @@
 License
 Privacy Policy
 
-Components
+Components¶
 
 ODFDOM
 Simple API
 ODF Validator
 XSLT Runner
 
-Community
+Community¶
 
 Get Involved
 Mailing Lists
 People
 Community FAQs
 
-Development
+Development¶
 
 Source Code
 Bug Tracker
@@ -80,13 +91,12 @@
 Website
 Developer FAQs
 
-PPMC
+PPMC¶
 
 PPMC FAQs
-Release Guide 

-
+Release Guide   
 
-ASF
+ASF¶
 
 Apache Software Foundation
 Thanks
@@ -96,7 +106,18 @@
   
   
     ODF XSLT Runner and ODF XSLT Runner Task Examples
-    XHTML
+    
+XHTML¶
 The XHTML transformation contained in OpenOffice.org can be used to 
 transform ODF documents into XHTML. Using ODFXSLTRunner it is not even 
 required to extract the ODF package.
@@ -104,9 +125,9 @@ required to extract the ODF package.
 Using version 9.1 is recommended.
 The following command converts an ODF text document <ODT> into 
 an XHTML document <XHTML>: 
-java -cp odfxsltrunner.jar:<saxon.jar> org.odftoolkit.odfxsltrunner.Main
-   -f net.sf.saxon.TransformerFactoryImpl  -x Pictures/ 
-  <ooo-xslt>/export/xhtml/opendoc2xhtml.xsl <ODT> -o <XHTML>
+java -cp odfxsltrunner.jar:<saxon.jar> org.odftoolkit.odfxsltrunner.Main
+   -f net.sf.saxon.TransformerFactoryImpl  -x Pictures/ 
+  <ooo-xslt>/export/xhtml/opendoc2xhtml.xsl <ODT> -o <XHTML>
 
 
 
@@ -117,7 +138,7 @@ installation. In a typical OpenOffice.or
 Note: A few changes are necessary to use OpenOffice.org's XHTML 
 transformation with ODFXSLTRunner. These are available as patch in the 
 OpenOffice.org issue i115881.
-XHTML with referenced images only
+XHTML with referenced images only¶
 The XHTML  transformation in the above example extracts all images from the 
 ODF document, regardless whether these are referenced in the XHTML document. 
 To extract only the images that are referenced a list of referenced images 
@@ -126,12 +147,12 @@ contained in the sample-xsltODFXSLTRunner may be used to apply the style sheet.
-java -jar odfxsltrunner.jar create-html-img-list.xsl -i <XHTML> -o <img-list> 
- unzip <ODT> `<img-list>`
+java -jar odfxsltrunner.jar create-html-img-list.xsl -i <XHTML> -o <img-list> 
+ unzip <ODT> `<img-list>`
 
 
 
-Replace embedded objects with bitmap images
+Replace embedded objects with bitmap images¶
 Unlike OpenOffice.org's HTML filter, the XSLT-based XHTML filter does not 
 convert embedded objects into bitmap images. It is however possible to 
 replace the embedded objects of ODF document with the images that the 

Modified: websites/staging/odftoolkit/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html
==============================================================================
--- websites/staging/odftoolkit/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html (original)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html Tue Apr 11 23:13:30 2017
@@ -50,7 +50,18 @@
   

   
   
-    General
+    
+General¶
 
 About
 Downloads
@@ -58,21 +69,21 @@
 License
 Privacy Policy
 
-Components
+Components¶
 
 ODFDOM
 Simple API
 ODF Validator
 XSLT Runner
 
-Community
+Community¶
 
 Get Involved
 Mailing Lists
 People
 Community FAQs
 
-Development
+Development¶
 
 Source Code
 Bug Tracker
@@ -80,13 +91,12 @@
 Website
 Developer FAQs
 
-PPMC
+PPMC¶
 
 PPMC FAQs
-Release Guide 

-
+Release Guide   
 
-ASF
+ASF¶
 
 Apache Software Foundation
 Thanks
@@ -96,12 +106,23 @@
   
   
     ODFXSLTRunnerTask
-    Apply XSLT stylesheets to ODF documents with Ant
+    
+Apply XSLT stylesheets to ODF documents with Ant¶
 ODFXSLTRunnerTask is a task definition for Apache Ant which allows 
 to apply XSLT stylesheets to ODF documents similar to Ant's build-in 
 <xslt> task. It is based on ODFXSLTRunner. Please see 
 ODFXSLTRunner for further details of its operation.
-Getting and building ODFXSLTRunnerTask
+Getting and building ODFXSLTRunnerTask¶
 odfxsltrunnertask is build by a NetBeans project. After you have checked 
 out the odf-xslt-runner-task-src/show, you can open the project in NetBeans 
 and build odfxsltrunnertask.
@@ -109,11 +130,11 @@ and build odfxsltrunnertask
 Building and running odfxsltrunner.jar requires additional jar files. 
 Please see Requirements for details.
-Usage
+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"/>
+ <taskdef name="odfxslt" classname="odfxsltrunnertask.ODFXSLTRunnerTask" 
+     classpath="<path>/odfxsltrunnertak.jar:<path>/odfxsltrunner.jar"/>
 
 
 
@@ -124,7 +145,7 @@ of the <project> element
 <factory>elements which have the same meaning as the 
 <param> and <factory> child elements of the 
 <xslt> task.
-Parameters
+Parameters¶
 
@@ -137,11 +158,11 @@ Unless template has been specified, the
 
 Attribute Description Required
 in specifies an ODF document to which the stylesheet is applied. Yes, unless infile has been specified
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
+Parameters specified as nested elements¶
+Param¶
 Param specifies a parameter that is passed as XSLT parameter to the 
 XSL stylesheet.
-Parameters
+Parameters¶
 
@@ -151,15 +172,15 @@ Note: All parameter values are passed as
 
 Attribute Description Required
 name name of the parameter. Yes
 
 Note: The parameters if and unless which are supported by the <xslt> task are (not yet) supported.
-Factory
+Factory¶
 Factory specifies Java TransformerFactory class to use.
-Parameters
+Parameters¶
 
 Attribute Description Required
 name full qualified TransformerFactory class name. Yes
 
 
-Requirements
+Requirements¶
 odfxsltrunnertask requires J2RE 5, or a later version of Java. 
 It further requires ODFXSLTRunner and the ODFDOM component (at least version  v0.6.1). 
 Note: When building odfxsltrunertask, the odfxsltrunner project has be checked out, too. It is build automatically.

Attribute	Description	Required
in	specifies an ODF document to which the stylesheet is applied.	Yes, unless infile has been specified
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