conor 01/01/09 03:45:56
Modified: docs index.html
Log:
Documentation update for the new param element of the style task and
other style task changes.
Submitted by: Jeff Martin <[EMAIL PROTECTED]>
Revision Changes Path
1.182 +69 -24 jakarta-ant/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/index.html,v
retrieving revision 1.181
retrieving revision 1.182
diff -u -r1.181 -r1.182
--- index.html 2001/01/08 16:51:29 1.181
+++ index.html 2001/01/09 11:45:52 1.182
@@ -29,7 +29,7 @@
</ul>
<p>Version: @VERSION@</p>
-<p>$Id: index.html,v 1.181 2001/01/08 16:51:29 bodewig Exp $</p>
+<p>$Id: index.html,v 1.182 2001/01/09 11:45:52 conor Exp $</p>
<hr>
<h2>Table of Contents</h2>
@@ -4349,11 +4349,12 @@
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
inclusion/exclusion of files works, and how to write patterns.</p>
-<p>This task forms an implicit <a href="#fileset">FileSet</a> and
-supports all attributes of <code><fileset></code>
-(<code>dir</code> becomes <code>basedir</code>) as well as the nested
-<code><include></code>, <code><exclude></code> and
-<code><patternset></code> elements.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and supports
all
+ attributes of <code><fileset></code> (<code>dir</code> becomes
<code>basedir</code>)
+ as well as the nested <code><include></code>,
<code><exclude></code>
+ and <code><patternset></code> elements.</p>
+<p>Style supports the use of a <param> element which is use to pass
values
+ to an <xsl:param> declaration.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -4373,8 +4374,8 @@
</tr>
<tr>
<td valign="top">extension</td>
- <td valign="top">desired file extension to be used for the targets.
- If not specified, the default is "html".</td>
+ <td valign="top">desired file extension to be used for the targets. If
not
+ specified, the default is "html".</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -4385,34 +4386,35 @@
<tr>
<td valign="top">processor</td>
<td valign="top">name of the XSLT processor to use. Permissible values
are
-"trax" for a TraX compliant processor, "xslp" for the
XSL:P
-processor, "xalan" for the Apache XML Xalan (version 1) processor,
or the name of an arbitrary XSLTLiaison class.
-Defaults to trax, followed by xslp then xalan (in that order). The first one
-found in your class path is the one that is used.</td>
+ "trax" for a TraX compliant processor, "xslp" for
the
+ XSL:P processor, "xalan" for the Apache XML Xalan (version
1)
+ processor, or the name of an arbitrary XSLTLiaison class. Defaults to
trax,
+ followed by xslp then xalan (in that order). The first one found in
your
+ class path is the one that is used.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
- <td valign="top">comma separated list of patterns of files that must be
- included. All files are included when omitted.</td>
+ <td valign="top">comma separated list of patterns of files that must be
included.
+ All files are included when omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an include pattern</td>
+ <td valign="top">the name of a file. Each line of this file is taken to
be
+ an include pattern</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
- <td valign="top">comma separated list of patterns of files that must be
- excluded. No files (except default excludes) are excluded when
omitted.</td>
+ <td valign="top">comma separated list of patterns of files that must be
excluded.
+ No files (except default excludes) are excluded when omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an exclude pattern</td>
+ <td valign="top">the name of a file. Each line of this file is taken to
be
+ an exclude pattern</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -4421,14 +4423,57 @@
("yes"/"no"). Default excludes are used when
omitted.</td>
<td valign="top" align="center">No</td>
</tr>
+ <tr>
+ <td valign="top">in</td>
+ <td valign="top">specifies a single XML document to be styled. Should be
used
+ with the out attribute.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">out</td>
+ <td valign="top">specifies the output name for the sytled result from
the
+ in attribute.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
</table>
+<h3>Parameters specified as nested elements</h3>
+<h4>param</h4>
+<p>Param is used to pass a parameter to the XSL stylesheet.</p>
+<h4>Parameters</h4>
+<table width="60%" border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">name</td>
+ <td valign="top">Name of the XSL parameter</td>
+ <td align="center" valign="top">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">expression</td>
+ <td valign="top">XSL expression to be placed into the param. To pass a
text
+ value into the style sheet it needs to be escaped using single
quotes.</td>
+ <td align="center" valign="top">Yes</td>
+ </tr>
+</table>
<h3>Examples</h3>
<blockquote>
- <p><pre>
+ <p>
+ <pre>
<style basedir="doc" destdir="build/doc"
- extension="html" style="style/apache.xml"/>
-</pre>
-</blockquote>
+ extension="html"
style="style/apache.xsl"/></pre>
+ <h4><br>
+ Using XSL parameters<br>
+ </h4>
+ <pre><style basedir="doc" destdir="build/doc"
+ extension="html"
style="style/apache.xsl">
+ <param name="date" expression="'07-01-2000'"/>
+</style></pre>
+ <p>This will replace an xsl:param definition<xsl:param
name="date"></xsl:param>
+ with the text value 07-01-2000 </p>
+ </blockquote>
<hr>
<h2><a name="tar">Tar</a></h2>
<h3>Description</h3>
