incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robw...@apache.org
Subject svn commit: r794867 - in /websites/production/odftoolkit: ./ content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html
Date Thu, 25 Aug 2011 00:25:34 GMT
Author: robweir
Date: Thu Aug 25 00:25:34 2011
New Revision: 794867

Log:
Publishing merge to odftoolkit site by robweir

Modified:
    websites/production/odftoolkit/   (props changed)
    websites/production/odftoolkit/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html

Propchange: websites/production/odftoolkit/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Thu Aug 25 00:25:34 2011
@@ -1 +1 @@
-/websites/staging/odftoolkit/trunk:794771-794862
+/websites/staging/odftoolkit/trunk:794771-794866

Modified: websites/production/odftoolkit/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html
==============================================================================
--- websites/production/odftoolkit/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html (original)
+++ websites/production/odftoolkit/content/odftoolkit/xsltrunner/ODFXSLTRunnerTask.html Thu
Aug 25 00:25:34 2011
@@ -21,7 +21,7 @@
 
 <link href="/odftoolkit/css/odf.css" rel="stylesheet" type="text/css">
 
-<title></title>
+<title>ODFXSLTRunnerTask</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
 </head>
@@ -77,21 +77,36 @@
   </div>
   <div id="contenta">
   
-    
-    <p><strong>TOC</strong></p>
-<p>== 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.</p>
-<p>== Getting and building ODFXSLTRunnerTask ==</p>
-<p>'''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'''.</p>
-<p>A binary release of '''odfxsltrunnertask.jar''' is available in the [http://odftoolkit.org/projects/conformancetools/downloads
download section].</p>
-<p>Building and running '''odfxsltrunner.jar''' requires additional jar files. Please
see [[#Requirements|Requirements]] for details.</p>
-<p>== Usage ==</p>
-<p>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:</p>
-<p>&lt;taskdef name="odfxslt" classname="odfxsltrunnertask.ODFXSLTRunnerTask" 
-          classpath="''&lt;path&gt;''/odfxsltrunnertak.jar:''&lt;path&gt;''/odfxsltrunner.jar"/&gt;</p>
-<p>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.</p>
-<p>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].</p>
-<p>== Parameters ==</p>
+    <h1 class="title">ODFXSLTRunnerTask</h1>
+    <h2 id="apply_xslt_stylesheets_to_odf_documents_with_ant">Apply XSLT stylesheets
to ODF documents with Ant</h2>
+<p><strong>ODFXSLTRunnerTask</strong> is a task definition for <a href="http://ant.apache.org/">Apache
Ant</a> which allows 
+to apply XSLT stylesheets to ODF documents similar to Ant's build-in 
+<tt>&lt;xslt&gt;</tt> <a href="http://ant.apache.org/manual/CoreTasks/style.html">task</a>.
It is based on ODFXSLTRunner. Please see 
+ODFXSLTRunner for further details of its operation.</p>
+<h2 id="getting_and_building_odfxsltrunnertask">Getting and building ODFXSLTRunnerTask</h2>
+<p><strong>odfxsltrunnertask</strong> 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 <strong>odfxsltrunnertask</strong>.</p>
+<p>A binary release of <strong>odfxsltrunnertask.jar</strong> is available
in the download 
+section.</p>
+<p>Building and running <strong>odfxsltrunner.jar</strong> requires additional
jar files. 
+Please see Requirements for details.</p>
+<h2 id="usage">Usage</h2>
+<p>To use <strong>odfxsltrunner.jar</strong> with Ant, you have to include
the following <a href="http://ant.apache.org/manual/CoreTasks/taskdef.html">task definition</a>
into 
+your buildfile, where ''<tt>&lt;path&gt;</tt>'' has to be replaced with
the path where you have stored the <strong>odfxsltrunnertask.jar</strong> and
<strong>odfxsltrunner.jar</strong> files:</p>
+<div class="codehilite"><pre> <span class="o">&lt;</span><span
class="n">taskdef</span> <span class="n">name</span><span class="o">=</span><span
class="s">&quot;odfxslt&quot;</span> <span class="n">classname</span><span
class="o">=</span><span class="s">&quot;odfxsltrunnertask.ODFXSLTRunnerTask&quot;</span>

+     <span class="n">classpath</span><span class="o">=</span><span
class="s">&quot;&lt;path&gt;/odfxsltrunnertak.jar:&lt;path&gt;/odfxsltrunner.jar&quot;</span><span
class="o">/&gt;</span>
+</pre></div>
+
+
+<p>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.</p>
+<p>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> <a href="http://ant.apache.org/manual/CoreTasks/style.html">task</a>.</p>
+<h2 id="parameters">Parameters</h2>
 <table border="border">
 <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
 <tr><td valign="top">in</td><td valign="top">specifies an ODF document
to which the stylesheet is applied.</td><td valign="top">Yes, unless infile has
been specified</td></tr>
@@ -104,36 +119,34 @@ 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>
 
-<p>== Parameters specified as nested elements ==</p>
-<p>=== Param ===</p>
-<p>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.</p>
-<p>==== Parameters ====</p>
+<h2 id="parameters_specified_as_nested_elements">Parameters specified as nested elements</h2>
+<h3 id="param">Param</h3>
+<p>Param specifies a parameter that is passed as <a href="http://www.w3.org/TR/1999/REC-xslt-19991116#top-level-variables">XSLT
parameter</a> to the 
+XSL stylesheet.</p>
+<h3 id="parameters_1">Parameters</h3>
 <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>
 
-<p>'''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.</p>
-<p>=== Factory ===</p>
+<p><strong>Note:</strong> The parameters <tt>if</tt> and <tt>unless</tt>
which are supported by the <tt>&lt;xslt&gt;</tt> task are (not yet) supported.</p>
+<h3 id="factory">Factory</h3>
 <p>Factory specifies Java TransformerFactory class to use.</p>
-<p>==== Parameters ====</p>
+<h3 id="parameters_2">Parameters</h3>
 <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>
 
-<p>== Requirements ==</p>
-<p>'''odfxsltrunnertask''' requires [http://java.sun.com/javase/downloads/index.jsp
J2RE 5], or a later version of Java. </p>
-<p>It further requires [[ODFXSLTRunner]] and [http://odftoolkit.openoffice.org/servlets/ProjectDocumentList?folderID=759&amp;expandFolder=759&amp;folderID=771
ODFDOM] (at least version  v0.6.1). </p>
-<p>'''Note:''' When building '''odfxsltrunertask''', the '''odfxsltrunner''' project
has be checked out, too. It is build automatically.</p>
-<p>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. </p>
-<p>'''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.</p>
-<p>== Background Information ==</p>
-<p>[http://blogs.sun.com/GullFOSS/entry/applying_xslt_stylesheets_to_odf Applying XSLT
stylesheets to ODF documents with Ant]</p>
-<p style="margin: 15px 0px"><center>Back to: [[Home|ODF Conformance and other
Tools Wiki Home]]</center></p>
+<h2 id="requirements">Requirements</h2>
+<p><strong>odfxsltrunnertask</strong> requires <a href="http://java.sun.com/javase/downloads/index.jsp">J2RE
5</a>, or a later version of Java. </p>
+<p>It further requires ODFXSLTRunner and the ODFDOM component (at least version  v0.6.1).
</p>
+<p><strong>Note:</strong> When building <strong>odfxsltrunertask</strong>,
the <strong>odfxsltrunner</strong> project has be checked out, too. It is build
automatically.</p>
+<p>In the Ant task definition, the <strong>classpth</strong> attribute
must include the <strong>odfxsltrunnertask.jar</strong> and <strong>odfxsltrunner.jar</strong>
files. The  ODFDOM jar file is found automatically if it is located in a folder called <strong>lib</strong>
next to the <strong>odfxsltrunner.jar</strong> file. </p>
+<p><strong>Note:</strong> <a href="{{project odfdom page home}}">ODFDOM</a>
v0.6.1  requires <a href="http://xml.apache.org/dist/xerces-j/">Apache Xerces</a>.
The jar file <strong>xercesImpl.jar</strong> also must exist in a folder <strong>lib</strong>
next to <strong>odfxsltrunner.jar</strong> file.</p>
   </div>
 
   <div id="footera">



Mime
View raw message