Documentation update for the new param element of the style task and

other style task changes.

Submitted by:	Jeff Martin <jmartin@silacom.com>


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268423 13f79535-47bb-0310-9956-ffa450edef68

docs/index.html

@@ -4349,11 +4349,12 @@ finally with the <i>defaultexcludes</i> attribute, you can specify whether you
 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>&lt;fileset&gt;</code>
-(<code>dir</code> becomes <code>basedir</code>) as well as the nested
-<code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
-<code>&lt;patternset&gt;</code> elements.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and supports all 
+  attributes of <code>&lt;fileset&gt;</code> (<code>dir</code> becomes <code>basedir</code>) 
+  as well as the nested <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> 
+  and <code>&lt;patternset&gt;</code> elements.</p>
+<p>Style supports the use of a &lt;param&gt; element which is use to pass values 
+  to an &lt;xsl:param&gt; declaration.</p>
 <h3>Parameters</h3>
 <table border="1" cellpadding="2" cellspacing="0">
   <tr>
@@ -4373,8 +4374,8 @@ supports all attributes of <code>&lt;fileset&gt;</code>
   </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 &quot;html&quot;.</td>
+    <td valign="top">desired file extension to be used for the targets. If not 
+      specified, the default is &quot;html&quot;.</td>
     <td align="center" valign="top">No</td>
   </tr>
   <tr>
@@ -4385,34 +4386,35 @@ supports all attributes of <code>&lt;fileset&gt;</code>
   <tr>
     <td valign="top">processor</td>
     <td valign="top">name of the XSLT processor to use.  Permissible values are
-&quot;trax&quot; for a TraX compliant processor, &quot;xslp&quot; for the XSL:P
-processor, &quot;xalan&quot; 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>
+      &quot;trax&quot; for a TraX compliant processor, &quot;xslp&quot; for the 
+      XSL:P processor, &quot;xalan&quot; 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 @@ found in your class path is the one that is used.</td>
       (&quot;yes&quot;/&quot;no&quot;). 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>
 &lt;style basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
-       extension=&quot;html&quot; style=&quot;style/apache.xml&quot;/&gt;
-</pre>
-</blockquote>
+       extension=&quot;html&quot; style=&quot;style/apache.xsl&quot;/&gt;</pre>
+  <h4><br>
+    Using XSL parameters<br>
+  </h4>
+  <pre>&lt;style basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
+		extension=&quot;html&quot; style=&quot;style/apache.xsl&quot;&gt;
+	&lt;param name=&quot;date&quot; expression=&quot;'07-01-2000'&quot;/&gt;
+&lt;/style&gt;</pre>
+  <p>This will replace an xsl:param definition&lt;xsl:param name="date"&gt;&lt;/xsl:param&gt; 
+    with the text value 07-01-2000 </p>
+  </blockquote>
 <hr>
 <h2><a name="tar">Tar</a></h2>
 <h3>Description</h3>