incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robw...@apache.org
Subject svn commit: r1161338 - /incubator/odf/site/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.mdtext
Date Thu, 25 Aug 2011 00:24:42 GMT
Author: robweir
Date: Thu Aug 25 00:24:42 2011
New Revision: 1161338

URL: http://svn.apache.org/viewvc?rev=1161338&view=rev
Log:
Convert MediaWiki to MDText

Modified:
    incubator/odf/site/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.mdtext

Modified: incubator/odf/site/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.mdtext
URL: http://svn.apache.org/viewvc/incubator/odf/site/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.mdtext?rev=1161338&r1=1161337&r2=1161338&view=diff
==============================================================================
--- incubator/odf/site/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.mdtext (original)
+++ incubator/odf/site/trunk/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.mdtext Thu Aug
25 00:24:42 2011
@@ -1,31 +1,44 @@
-__TOC__
+Title: ODFXSLTRunnerTask
+## Apply XSLT stylesheets to ODF documents with Ant
 
-== 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>&lt;xslt&gt;</tt>
[http://ant.apache.org/manual/CoreTasks/style.html task]. It is based on  [[ODFXSLTRunner]].
Please see [[ODFXSLTRunner]] for further details of its operation.
+**ODFXSLTRunnerTask** is a task definition for [Apache Ant][1] which allows 
+to apply XSLT stylesheets to ODF documents similar to Ant's build-in 
+<tt>&lt;xslt&gt;</tt> [task][2]. 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**.
 
-'''odfxsltrunnertask''' is build by a NetBeans project. After you have checked out the [http://odftoolkit.org/projects/conformancetools/sources/odf-xslt-runner-task-src/show],
you can open the project in [http://www.netbeans.info/downloads/index.php NetBeans] and build
'''odfxsltrunnertask'''.
+A binary release of **odfxsltrunnertask.jar** is available in the download 
+section.
 
-A binary release of '''odfxsltrunnertask.jar''' is available in the [http://odftoolkit.org/projects/conformancetools/downloads
download section].
+Building and running **odfxsltrunner.jar** requires additional jar files. 
+Please see Requirements for details.
 
-Building and running '''odfxsltrunner.jar''' requires additional jar files. Please see [[#Requirements|Requirements]]
for details.
+##Usage
 
-== Usage ==
+To use **odfxsltrunner.jar** with Ant, you have to include the following [task definition][3]
into 
+your buildfile, where ''<tt>&lt;path&gt;</tt>'' has to be replaced with
the path where you have stored the **odfxsltrunnertask.jar** and **odfxsltrunner.jar** files:
 
-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>&lt;path&gt;</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"/>
 
  
- &lt;taskdef name="odfxslt" classname="odfxsltrunnertask.ODFXSLTRunnerTask" 
-          classpath="''&lt;path&gt;''/odfxsltrunnertak.jar:''&lt;path&gt;''/odfxsltrunner.jar"/&gt;
- 
-
-You can use this task definition on the top level (that is as a child element of the <tt>&lt;project&gt;</tt>
element or locally within a single <tt>&lt;target&gt;</tt> element. It
defines a new task <tt>&lt;odfxslt&gt;</tt> which allows to process ODF
documents with XSLT stylesheets.
 
-The new task supports the use of nested <tt>&lt;param&gt;</tt> and <tt>&lt;factory&gt;</tt>elements
which have the same meaning as the <tt>&lt;param&gt;</tt> and <tt>&lt;factory&gt;</tt>
child elements of the <tt>&lt;xslt&gt;</tt> [http://ant.apache.org/manual/CoreTasks/style.html
task].
+You can use this task definition on the top level (that is as a child element 
+of the <tt>&lt;project&gt;</tt> element or locally within a single 
+<tt>&lt;target&gt;</tt> element. It defines a new task <tt>&lt;odfxslt&gt;</tt>
which allows to process ODF documents with XSLT stylesheets.
+
+The new task supports the use of nested <tt>&lt;param&gt;</tt> and 
+<tt>&lt;factory&gt;</tt>elements which have the same meaning as the 
+<tt>&lt;param&gt;</tt> and <tt>&lt;factory&gt;</tt>
child elements of the 
+<tt>&lt;xslt&gt;</tt> [task][2].
 
-== Parameters ==
+##Parameters
 
 <table border="border">
 <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
@@ -39,50 +52,52 @@ Unless template has been specified, the 
 <tr><td valign="top">force</td><td valign="top">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 ==
+##Parameters specified as nested elements
 
-=== Param ===
+###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.
+Param specifies a parameter that is passed as [XSLT parameter][4] to the 
+XSL stylesheet.
 
-==== Parameters ====
+###Parameters
 
 <table border="border">
 <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
 <tr><td valign="top">name</td><td valign="top">name of the parameter.</td><td
valign="top">Yes</td></tr>
 <tr><td valign="top">expression</td><td>value of the parameter.
-'''Note:''' All parameter values are passed as string values to the XSLT parameters specified
by <tt>&lt;xslt:param&gt;</tt> elements within the stylesheet.
+Note: All parameter values are passed as string values to the XSLT parameters specified by
<tt>&lt;xslt:param&gt;</tt> elements within the stylesheet.
 </td><td valign="top">Yes</td></tr>
 </table>
 
-'''Note:''' The parameters <tt>if</tt> and <tt>unless</tt> which
are supported by the <tt>&lt;xslt&gt;</tt> task are (not yet) supported.
+**Note:** The parameters <tt>if</tt> and <tt>unless</tt> which are
supported by the <tt>&lt;xslt&gt;</tt> task are (not yet) supported.
 
-=== Factory ===
+###Factory
 
 Factory specifies Java TransformerFactory class to use.
 
-==== Parameters ====
+###Parameters
 
 <table border="border">
 <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
 <tr><td valign="top">name</td><td valign="top">full qualified TransformerFactory
class name.</td><td valign="top">Yes</td></tr>
 </table>
 
-== 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). 
+##Requirements
 
-'''Note:''' When building '''odfxsltrunertask''', the '''odfxsltrunner''' project has be
checked out, too. It is build automatically.
+**odfxsltrunnertask** requires [J2RE 5][5], or a later version of Java. 
 
-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. 
+It further requires ODFXSLTRunner and the ODFDOM component (at least version  v0.6.1). 
 
-'''Note:''' <a href="{{project odfdom page home}}">ODFDOM</a> 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.
+**Note:** When building **odfxsltrunertask**, the **odfxsltrunner** project has be checked
out, too. It is build automatically.
 
-== Background Information ==
+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. 
 
-[http://blogs.sun.com/GullFOSS/entry/applying_xslt_stylesheets_to_odf Applying XSLT stylesheets
to ODF documents with Ant]
+**Note:** <a href="{{project odfdom page home}}">ODFDOM</a> v0.6.1  requires
[Apache Xerces][6]. The jar file **xercesImpl.jar** also must exist in a folder **lib** next
to **odfxsltrunner.jar** file.
 
-<p style="margin: 15px 0px"><center>Back to: [[Home|ODF Conformance and other
Tools Wiki Home]]</center></p> 
 
+[1]: http://ant.apache.org/
+[2]: http://ant.apache.org/manual/CoreTasks/style.html
+[3]: http://ant.apache.org/manual/CoreTasks/taskdef.html
+[4]: http://www.w3.org/TR/1999/REC-xslt-19991116#top-level-variables
+[5]: http://java.sun.com/javase/downloads/index.jsp
+[6]: http://xml.apache.org/dist/xerces-j/
\ No newline at end of file



Mime
View raw message