You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/02/28 07:01:38 UTC
[23/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/style.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/style.html b/manual/Tasks/style.html
index 2dbe9d5..199a585 100644
--- a/manual/Tasks/style.html
+++ b/manual/Tasks/style.html
@@ -25,436 +25,386 @@
<body>
<h2 id="style">XSLT</h2>
-<p><em>The name <code>style</code> is a deprecated name for the same task.</em></p>
+<p><em>The name <code>style</code> is a <u>deprecated</u> name for the same task.</em></p>
<h3>Description</h3>
<p>Process a set of documents via XSLT.</p>
-<p>This is useful for building views of XML based documentation,
-or for generating code.</p>
-<p><strong>Note</strong>: If you are using JDK 1.4 or higher, this task does not require external libraries
-not supplied in the Apache Ant distribution. However, often the built in XSL engine is not as up
-to date as a fresh download, so an update is still highly recommended
- in particular since the built-in XSLT processors of Java 5 (and to a
- certain extent Java 6) are known to have serious issues.
-See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
-<p>It is possible to refine the set of files that are being processed. This can be
-done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
-attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
-have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
-the files you want to have excluded. This is also done with patterns. And
-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="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
+<p>This is useful for building views of XML based documentation, or for generating code.</p>
+<p><strong>Note</strong>: If you are using JDK 1.4 or higher, this task does not require external
+libraries not supplied in the Apache Ant distribution. However, often the built in XSL engine is not
+as up to date as a fresh download, so an update is still highly recommended in particular since the
+built-in XSLT processors of Java 5 (and to a certain extent Java 6) are known to have serious
+issues. See <a href="../install.html#librarydependencies">Library Dependencies</a> for more
+information.</p>
+<p>It is possible to refine the set of files that are being processed. This can be done with
+the <var>includes</var>, <var>includesfile</var>, <var>excludes</var>, <var>excludesfile</var>
+and <var>defaultexcludes</var> attributes. With the <var>includes</var> or <var>includesfile</var>
+attribute you specify the files you want to have included by using patterns. The <var>exclude</var>
+or <var>excludesfile</var> attribute is used to specify the files you want to have excluded. This is
+also done with patterns. And finally with the <var>defaultexcludes</var> attribute, you can specify
+whether you want to use default exclusions or not. See the section
+on <a href="../dirtasks.html#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="../Types/fileset.html">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><strong>Note</strong>: Unlike other similar tasks, this task treats
-directories that have been matched by the include/exclude patterns of
-the implicit fileset in a special way. It will apply the stylesheets
-to all files contain in them as well. Since the default include
-pattern is <code>**</code> this means it will apply the stylesheet to
-all files. If you specify an excludes pattern, it may still work on
-the files matched by those patterns because the parent directory has
-been matched. If this behavior is not what you want, set the
-scanincludedirectories attribute to false.</p>
-
-<p><em>Since Ant 1.7</em>, this task supports nested <a
-href="../Types/resources.html#collection">resource collection</a>s
-in addition to (or instead of, depending on the useImplicitFileset
-attribute) the implicit fileset formed by this task.</p>
-
-<p>This task supports the use of a nested <code><param></code> element which is used to pass values
- to an <code><xsl:param></code> declaration.</p>
-<p>This task supports the use of a nested <a href="../Types/xmlcatalog.html">xmlcatalog</a>
-element which is used to perform Entity and URI resolution.</p>
-
-<p><b>Note on XSLT extension functions</b>: when using the default
- TraX implementation of the Java class library and
- a <code>SecurityManager</code> is active - e.g. when running from
- within an IDE - XSLT extension functions cannot be used as "secure
- processing" is active in Java 7 and above. Ant contains a special
- "hack" that allows XSLT extensions to be used in Java 7 and 8, but
- this hack fails for Java 9. If you want to use extensions like the
- redirect extension that are provided by the Java class library
- itself, you can allow them by enabling the
- feature <code>http://www.oracle.com/xml/jaxp/properties/enableExtensionFunctions</code>
- in Java 9 and above. If you need to use an extension function not
- provided by Java itself you can set the
- attribute <code>jdk.xml.transform.extensionClassLoader</code> to a
- classloader (reference to an Ant PATH-like structure).</p>
+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><strong>Note</strong>: Unlike other similar tasks, this task treats directories that have been
+matched by the include/exclude patterns of the implicit fileset in a special way. It will apply the
+stylesheets to all files contain in them as well. Since the default <var>includes</var> pattern
+is <code>**</code> this means it will apply the stylesheet to all files. If you specify
+an <var>excludes</var> pattern, it may still work on the files matched by those patterns because the
+parent directory has been matched. If this behavior is not what you want, set
+the <var>scanincludedirectories</var> attribute to false.</p>
+
+<p><em>Since Ant 1.7</em>, this task supports
+nested <a href="../Types/resources.html#collection">resource collection</a>s in addition to (or
+instead of, depending on the <var>useImplicitFileset</var> attribute) the implicit fileset formed by
+this task.</p>
+
+<p>This task supports the use of a nested <code><param></code> element which is used to pass
+values to an <code><xsl:param></code> declaration.</p>
+<p>This task supports the use of a nested <a href="../Types/xmlcatalog.html">xmlcatalog</a> element
+which is used to perform Entity and URI resolution.</p>
+
+<p><strong>Note on XSLT extension functions</strong>: when using the default TrAX implementation of
+the Java class library and a <code>SecurityManager</code> is active—e.g. when running from
+within an IDE—XSLT extension functions cannot be used as "secure processing" is active in Java
+7 and above. Ant contains a special "hack" that allows XSLT extensions to be used in Java 7 and 8,
+but this hack fails for Java 9. If you want to use extensions like the redirect extension that are
+provided by the Java class library itself, you can allow them by enabling the
+feature <var>http://www.oracle.com/xml/jaxp/properties/enableExtensionFunctions</var> in Java 9 and
+above. If you need to use an extension function not provided by Java itself you can set the
+attribute <var>jdk.xml.transform.extensionClassLoader</var> to a classloader (reference to an Ant
+path-like structure).</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">basedir</td>
- <td valign="top">where to find the source XML file, default is the
- project's basedir.</td>
- <td align="center" valign="top">No</td>
+ <td>basedir</td>
+ <td>where to find the source XML file.</td>
+ <td>No; defaults to the project's <var>basedir</var></td>
</tr>
<tr>
- <td valign="top">destdir</td>
- <td valign="top">directory in which to store the results.</td>
- <td align="center" valign="top">Yes, unless in and out have been
- specified.</td>
+ <td>destdir</td>
+ <td>directory in which to store the results.</td>
+ <td>Yes, unless <var>in</var> and <var>out</var> have been specified.</td>
</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". Will be ignored if
- a nested <code><mapper></code> or both <code>in</code> and
- <code>out</code> have been specified.</td>
- <td align="center" valign="top">No</td>
+ <td>extension</td>
+ <td>desired file extension to be used for the targets.</td>
+ <td>No; default is <q>.html</q>, ignored if a nested <code><mapper></code> or
+ both <var>in</var> and <var>out</var> have been specified</td>
</tr>
<tr>
- <td valign="top">style</td>
- <td valign="top">name of the stylesheet to use - given either relative
- to the project's basedir or as an absolute path.<br/>
- <br/>
- Alternatively, a nested element which Ant can interpret as a resource
- can be used to indicate where to find the stylesheet<br/>
- <em>deprecated variation :</em> <br/>
- If the stylesheet cannot be found, and if you have specified the
- attribute basedir for the task, Ant will assume that the style
- attribute is relative to the basedir of the task.
- </td>
- <td align="center" valign="top">No, if the location of
- the stylesheet is specified using a nested <style> element</td>
+ <td>style</td>
+ <td>name of the stylesheet to use—given either relative to the
+ project's <var>basedir</var> or as an absolute path.<br/> Alternatively, a nested element
+ which Ant can interpret as a resource can be used to indicate where to find the
+ stylesheet.<br/><em><u>Deprecated</u> variation</em>:<br/> If the stylesheet cannot be found,
+ and if you have specified the attribute <var>basedir</var> for the task, Ant will assume that
+ the <var>style</var> attribute is relative to the <var>basedir</var> of the task.</td>
+ <td>No, if the location of the stylesheet is specified using a nested <code><style></code>
+ element</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">the classpath to use when looking up the XSLT
- processor.</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>the classpath to use when looking up the XSLT processor.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">the classpath to use, given as <a
- href="../using.html#references">reference</a> to a path defined elsewhere.</td>
- <td align="center" valign="top">No</td>
+ <td>classpathref</td>
+ <td>the classpath to use, given as <a href="../using.html#references">reference</a> to a path
+ defined elsewhere.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">force</td>
- <td valign="top">Recreate target files, even if they are newer
- than their corresponding source files or the stylesheet.</td>
- <td valign="top" align="center">No; default is false</td>
+ <td>force</td>
+ <td>Recreate target files, even if they are newer than their corresponding source files or the
+ stylesheet.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">processor</td>
- <td valign="top">name of the XSLT processor to use.
- Permissible value is :<ul>
- <li>"trax" for a TraX compliant processor (ie JAXP interface
- implementation such as Xalan 2 or Saxon)</li></ul>
- Defaults to trax.
- <br/>
- Support for Xalan 1 has been removed in Ant 1.7.
- </td>
- <td align="center" valign="top">No</td>
+ <td>processor</td>
+ <td>name of the XSLT processor to use. Permissible value is:
+ <ul>
+ <li><q>trax</q> for a TraX compliant processor (ie JAXP interface implementation such as
+ Xalan 2 or Saxon)</li>
+ </ul>
+ Support for Xalan 1 has been removed <em>since Ant 1.7</em>.
+ </td>
+ <td>No; defaults to <q>trax</q></td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be included.
- All files are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</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" align="center">No</td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-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>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></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" align="center">No</td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used or not
- ("yes"/"no"). Default excludes are used when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></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>
+ <td>in</td>
+ <td>specifies a single XML document to be styled. Should be used
+ with the <var>out</var> attribute.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">out</td>
- <td valign="top">specifies the output name for the styled result from the
- in attribute.</td>
- <td valign="top" align="center">No</td>
+ <td>out</td>
+ <td>specifies the output name for the styled result from the <var>in</var> attribute.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">scanincludeddirectories</td>
- <td valign="top">If any directories are matched by the
- includes/excludes patterns, try to transform all files in these
- directories. Default is <code>true</code></td>
- <td valign="top" align="center">No</td>
+ <td>scanincludeddirectories</td>
+ <td>If any directories are matched by the <var>includes</var>/<var>excludes</var> patterns, try
+ to transform all files in these directories.
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">reloadstylesheet</td>
- <td valign="top">Control whether the stylesheet transformer is created
- anew for every transform operation. If you set this to true, performance may
- suffer, but you may work around a bug in certain Xalan-J versions.
- Default is <code>false</code>. <em>Since Ant 1.5.2</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>reloadstylesheet</td>
+ <td>Control whether the stylesheet transformer is created anew for every transform operation. If
+ you set this to <q>true</q>, performance may suffer, but you may work around a bug in certain
+ Xalan versions. <em>Since Ant 1.5.2</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">useImplicitFileset</td>
- <td valign="top">Whether the implicit fileset formed by this task
- shall be used. If you set this to false you must use nested
- resource collections - or the in attribute, in which case this
- attribute has no impact anyway. Default is <code>true</code>.
- <em>Since Ant 1.7</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>useImplicitFileset</td>
+ <td>Whether the implicit fileset formed by this task shall be used. If you set this
+ to <q>false</q> you must use nested resource collections—or the <var>in</var> attribute,
+ in which case this attribute has no impact anyway. <em>Since Ant 1.7</em>.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">filenameparameter</td>
- <td valign="top">Specifies a xsl parameter for accessing the name
- of the current processed file. If not set, the file name is not
- passed to the transformation.
- <em>Since Ant 1.7</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>filenameparameter</td>
+ <td>Specifies an XSL parameter for accessing the name of the current processed file. If not set,
+ the file name is not passed to the transformation. <em>Since Ant 1.7</em>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">filedirparameter</td>
- <td valign="top">Specifies a xsl parameter for accessing the directory
- of the current processed file. For files in the current directory a
- value of '.' will be passed to the transformation.
- If not set, the directory is not passed to the transformation.
- <em>Since Ant 1.7</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>filedirparameter</td>
+ <td>Specifies a XSL parameter for accessing the directory of the current processed file. For
+ files in the current directory, a value of <q>.</q> will be passed to the transformation. If
+ not set, the directory is not passed to the transformation. <em>Since Ant 1.7</em>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">suppressWarnings</td>
- <td valign="top">Whether processor warnings shall be suppressed.
- This option requires support by the processor, it is supported by
- the trax processor bundled with Ant.
- <em>Since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, default is false.</td>
+ <td>suppressWarnings</td>
+ <td>Whether processor warnings shall be suppressed. This option requires support by the
+ processor, it is supported by the TrAX processor bundled with Ant. <em>Since Ant
+ 1.8.0</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">failOnError</td>
- <td valign="top">Whether the build should fail if any error
- occurs. Note that transformation errors can still be suppressed by
- setting failOnTransformationError to false even if this attribute
- is true.
- <em>Since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, default is true.</td>
+ <td>failOnError</td>
+ <td>Whether the build should fail if any error occurs. Note that transformation errors can
+ still be suppressed by setting <q>failOnTransformationError</q> to <q>false</q> even if this
+ attribute is <q>true</q>. <em>Since Ant 1.8.0</em>.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">failOnTransformationError</td>
- <td valign="top">Whether the build should fail if an error occurs
- while transforming the document. Note that this attribute has no
- effect of <code>failOnError</code> is false.
- <em>Since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, default is true.</td>
+ <td>failOnTransformationError</td>
+ <td>Whether the build should fail if an error occurs while transforming the document. Note that
+ this attribute has no effect if <var>failOnError</var> is <q>false</q>. <em>Since Ant
+ 1.8.0</em>.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">failOnNoResources</td>
- <td valign="top">Whether the build should fail if the nested
- resource collection is empty. Note that this attribute has no
- effect of <code>failOnError</code> is false.
- <em>Since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, default is true.</td>
+ <td>failOnNoResources</td>
+ <td>Whether the build should fail if the nested resource collection is empty. Note that this
+ attribute has no effect of <var>failOnError</var> is <q>false</q>. <em>Since Ant
+ 1.8.0</em>.</td>
+ <td>No; default is <q>true</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
-<h4>any <a href="../Types/resources.html#collection">resource
-collection</a></h4>
+<h4>any <a href="../Types/resources.html#collection">resource collection</a></h4>
<p><em>since Ant 1.7</em></p>
-<p>Use resource collections to specify resources that the stylesheet
-should be applied to. Use a nested mapper and the task's destdir
-attribute to specify the output files.</p>
+<p>Use resource collections to specify resources that the stylesheet should be applied to. Use a
+nested mapper and the task's <q>destdir</q> attribute to specify the output files.</p>
<h4 id="classpath">classpath</h4>
<p>The classpath to load the processor from can be specified via a
-nested <code><classpath></code>, as well - that is, a
-<a href="../using.html#path">path</a>-like structure.</p>
+nested <code><classpath></code>, as well—that is,
+a <a href="../using.html#path">path-like structure</a>.</p>
<h4>xmlcatalog</h4>
-<p>The <a href="../Types/xmlcatalog.html">xmlcatalog</a>
-element is used to perform Entity and URI resolution.</p>
+<p>The <a href="../Types/xmlcatalog.html">xmlcatalog</a> element is used to perform Entity and URI
+resolution.</p>
<h4>param</h4>
-<p>Param is used to pass a parameter to the XSL stylesheet.</p>
+<p><code>Param</code> is used to pass a parameter to the XSL stylesheet.</p>
<h5>Parameters</h5>
-<table>
- <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">
- The value to be placed into the param or an XPath expression
- (depending on <code>type</code>).
- </td>
- <td align="center" valign="top">Yes</td>
- </tr>
- <tr>
- <td valign="top">type</td>
- <td valign="top">
- Data type of the parameter. Possible values are:
- <ul>
- <li><code>STRING</code></li>
- <li><code>BOOLEAN</code></li>
- <li><code>INT</code></li>
- <li><code>LONG</code></li>
- <li><code>DOUBLE</code></li>
- <li><code>XPATH_STRING</code></li>
- <li><code>XPATH_BOOLEAN</code></li>
- <li><code>XPATH_NUMBER</code></li>
- <li><code>XPATH_NODE</code></li>
- <li><code>XPATH_NODESET</code></li>
- </ul>
- <em>since Ant 1.9.3</em>
+<table class="attr">
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>Name of the XSL parameter</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>expression</td>
+ <td>The value to be placed into the param or an XPath expression (depending
+ on <var>type</var>).</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>Data type of the parameter. Possible values are:
+ <ul>
+ <li><q>STRING</q></li>
+ <li><q>BOOLEAN</q></li>
+ <li><q>INT</q></li>
+ <li><q>LONG</q></li>
+ <li><q>DOUBLE</q></li>
+ <li><q>XPATH_STRING</q></li>
+ <li><q>XPATH_BOOLEAN</q></li>
+ <li><q>XPATH_NUMBER</q></li>
+ <li><q>XPATH_NODE</q></li>
+ <li><q>XPATH_NODESET</q></li>
+ </ul><em>since Ant 1.9.3</em>
</td>
- <td align="center" valign="top">No; default is <code>STRING</code></td>
+ <td>No; default is <q>STRING</q></td>
</tr>
<tr>
- <td valign="top">if</td>
- <td valign="top">The param will only be passed <a href="../properties.html#if+unless">if this property is set</a>.</td>
- <td align="center" valign="top">No</td>
+ <td>if</td>
+ <td>The param will only be passed <a href="../properties.html#if+unless">if this property is
+ set</a>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">unless</td>
- <td valign="top">The param will not be passed <a href="../properties.html#if+unless">if this property is set</a>.</td>
- <td align="center" valign="top">No</td>
+ <td>unless</td>
+ <td>The param will not be passed <a href="../properties.html#if+unless">if this property is
+ set</a>.</td>
+ <td>No</td>
</tr>
</table>
-
- <p>
- The <code>XPATH_*</code> types says that the <code>expression</code> is not just a primitive-type value but an XPath expression.
- This expression will be evaluated on an empty XML document and the result will be passed to the XSLT transformer as a parameter of given type.
- In these expressions the declared Ant properties can be used as XPath variables e.g. <code>$someProperty</code>.
- So you can compute something using standard XPath functions and operators.
- </p>
- <p>
- If you write <code>${someProperty}</code> instead of <code>$someProperty</code>,
- the value will be simply substituted by Ant before evaluating the XPath expression
- (this substitution works also for primitive types).
- </p>
-
-<h4>outputproperty ('trax' processors only)</h4>
-<p>Used to specify how you wish the result tree to be output
-as specified in the <a href="http://www.w3.org/TR/xslt#output">
-XSLT specifications</a>.
+<p>The <q>XPATH_*</q> types says that the <var>expression</var> is not just a primitive-type value
+but an XPath expression. This expression will be evaluated on an empty XML document and the result
+will be passed to the XSLT transformer as a parameter of given type. In these expressions the
+declared Ant properties can be used as XPath variables e.g. <code>$someProperty</code>. So you can
+compute something using standard XPath functions and operators.</p>
+<p>If you write <code>${someProperty}</code> instead of <code>$someProperty</code>, the value will
+be simply substituted by Ant before evaluating the XPath expression (this substitution works also
+for primitive types).</p>
+
+<h4>outputproperty (<var>trax</var> processors only)</h4>
+<p>Used to specify how you wish the result tree to be output as specified in
+the <a href="https://www.w3.org/TR/xslt#output"> XSLT specifications</a>.
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">Name of the property</td>
- <td align="center" valign="top">Yes</td>
+ <td>name</td>
+ <td>Name of the property</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">value of the property.</td>
- <td align="center" valign="top">Yes</td>
+ <td>value</td>
+ <td>Value of the property</td>
+ <td>Yes</td>
</tr>
</table>
-<h4 id="factory">factory ('trax' processors only)</h4>
-Used to specify factory settings.
+<h4 id="factory">factory (<var>trax</var> processors only)</h4>
+<p>Used to specify factory settings.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">fully qualified classname of the
- transformer factory to use. For example
- <tt>org.apache.xalan.processor.TransformerFactoryImpl</tt>
- or <tt>org.apache.xalan.xsltc.trax.TransformerFactoryImpl</tt>
- or <tt>net.sf.saxon.TransformerFactoryImpl</tt>...
- </td>
- <td align="center" valign="top">No. Defaults to the JAXP lookup mechanism.</td>
+ <td>name</td>
+ <td>fully qualified classname of the transformer factory to use. For
+ example <code>org.apache.xalan.processor.TransformerFactoryImpl</code>
+ or <code>org.apache.xalan.xsltc.trax.TransformerFactoryImpl</code>
+ or <code>net.sf.saxon.TransformerFactoryImpl</code>...</td>
+ <td>No; defaults to the JAXP lookup mechanism</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<h6>attribute</h6>
-<p>Used to specify settings of the processor factory.
-The attribute names and values are entirely processor specific
-so you must be aware of the implementation to figure them out.
-Read the documentation of your processor.
-For example, in Xalan 2.x:
+<p>Used to specify settings of the processor factory. The attribute names and values are entirely
+processor specific so you must be aware of the implementation to figure them out. Read the
+documentation of your processor. For example, in Xalan 2.x:</p>
<ul>
-<li>http://xml.apache.org/xalan/features/optimize (boolean)</li>
-<li>http://xml.apache.org/xalan/features/incremental (boolean)</li>
-<li>...</li>
+ <li><var>http://xml.apache.org/xalan/features/optimize</var> (boolean)</li>
+ <li><var>http://xml.apache.org/xalan/features/incremental</var> (boolean)</li>
+ <li>...</li>
</ul>
-And in Saxon 7.x:
+<p>And in Saxon 7.x:</p>
<ul>
-<li>http://saxon.sf.net/feature/allow-external-functions (boolean)</li>
-<li>http://saxon.sf.net/feature/timing (boolean)</li>
-<li>http://saxon.sf.net/feature/traceListener (string)</li>
-<li>http://saxon.sf.net/feature/treeModel (integer)</li>
-<li>http://saxon.sf.net/feature/linenumbering (integer)</li>
-<li>...</li>
+ <li><var>http://saxon.sf.net/feature/allow-external-functions</var> (boolean)</li>
+ <li><var>http://saxon.sf.net/feature/timing</var> (boolean)</li>
+ <li><var>http://saxon.sf.net/feature/traceListener</var> (string)</li>
+ <li><var>http://saxon.sf.net/feature/treeModel</var> (integer)</li>
+ <li><var>http://saxon.sf.net/feature/linenumbering</var> (integer)</li>
+ <li>...</li>
</ul>
<blockquote>
<h6>Parameters</h6>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">Name of the attribute</td>
- <td align="center" valign="top">Yes</td>
+ <td>name</td>
+ <td>Name of the attribute</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">value of the attribute.</td>
- <td align="center" valign="middle" rowspan="3">Exactly one of these</td>
+ <td>value</td>
+ <td>Value of the attribute.</td>
+ <td rowspan="3">Exactly one of these</td>
</tr>
<tr>
- <td valign="top">valueref</td>
- <td valign="top">value of the attribute is the value of the
- project reference with the given id. <em>since Ant 1.9.8</em></td>
+ <td>valueref</td>
+ <td class="left">Value of the attribute is the value of the project reference with the given
+ id. <em>since Ant 1.9.8</em></td>
</tr>
<tr>
- <td valign="top">classloaderforpath</td>
- <td valign="top">value of the attribute is a classloader that uses
- the classpath specified by a path that is the project reference
- with the given id. <em>since Ant 1.9.8</em></td>
+ <td>classloaderforpath</td>
+ <td class="left">Value of the attribute is a classloader that uses the classpath specified by a
+ path that is the project reference with the given id. <em>since Ant 1.9.8</em></td>
</tr>
</table>
</blockquote>
@@ -462,48 +412,44 @@ And in Saxon 7.x:
<h5>Examples</h5>
<pre>
- <path id="extension-path">
- ...
- </path>
+<path id="extension-path">
+ ...
+</path>
+<xslt ...>
+ <factory>
+ <attribute name="jdk.xml.transform.extensionClassLoader"
+ classloaderforpath="extension-path"/>
+ </factory>
+</xslt ...></pre>
- <xslt ...>
- <factory>
- <attribute name="jdk.xml.transform.extensionClassLoader"
- classloaderforpath="extension-path"/>
- </factory>
- </xslt ...>
-</pre>
-<p>Sets the classloader to use when loading extension functions to a
- classloader using the <code>path</code> with the
- id <code>extension-path</code>.</p>
+<p>Sets the classloader to use when loading extension functions to a classloader using
+the <code>path</code> with the id <code>extension-path</code>.</p>
<p><em>since Ant 1.9.8</em></p>
<h6>feature</h6>
-<p>Used to specify settings of the processor factory. The feature
-names are mostly processor specific so you must be aware of the
-implementation to figure them out. Read the documentation of your
-processor. The only feature all implementations are required to
-support
-is <code>http://javax.xml.XMLConstants/feature/secure-processing</code>.
+<p>Used to specify settings of the processor factory. The feature names are mostly processor
+specific so you must be aware of the implementation to figure them out. Read the documentation of
+your processor. The only feature all implementations are required to support
+is <var>http://javax.xml.XMLConstants/feature/secure-processing</var>.
<blockquote>
<h6>Parameters</h6>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">Name of the feature</td>
- <td align="center" valign="top">Yes</td>
+ <td>name</td>
+ <td>Name of the feature</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">value of the feature. A boolean value
- (i.e. permitted values are true, false, yes, no, on, off).</td>
- <td align="center" valign="top">No, defaults to false</td>
+ <td>value</td>
+ <td>Value of the feature. A boolean value (i.e. permitted values
+ are <q>true</q>, <q>false</q>, <q>yes</q>, <q>no</q>, <q>on</q>, <q>off</q>).</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
</blockquote>
@@ -512,28 +458,25 @@ is <code>http://javax.xml.XMLConstants/feature/secure-processing</code>.
<p><em>since Ant 1.6.2</em></p>
-<p>You can define filename transformations by using a nested <a
-href="../Types/mapper.html">mapper</a> element. The default mapper
-used by <code><xslt></code> removes the file extension from the
-source file and adds the extension specified via the extension
-attribute.</p>
+<p>You can define filename transformations by using a
+nested <a href="../Types/mapper.html">mapper</a> element. The default mapper used
+by <code><xslt></code> removes the file extension from the source file and adds the extension
+specified via the extension attribute.</p>
<h4>style</h4>
<p><em>Since Ant 1.7</em></p>
-<p>The nested style element can be used to specify your stylesheet in terms
-of Ant's <a href="../Types/resources.html">resource</a> types. With
-this element, the stylesheet should be specified as a nested resource or
-single-element collection. Alternatively, use the <code>refid</code> to
-specify the resource or collection as a reference.</p>
+<p>The nested <code>style</code> element can be used to specify your stylesheet in terms of
+Ant's <a href="../Types/resources.html">resource</a> types. With this element, the stylesheet
+should be specified as a nested resource or single-element collection. Alternatively, use
+the <var>refid</var> to specify the resource or collection as a reference.</p>
<h4>sysproperty</h4>
-<p>Use nested <code><sysproperty></code> elements to specify
-system properties required by the factory or transformation. These
-properties will be made available to the VM during the execution of
-the class. The attributes for this element are the same as
-for <a href="exec.html#env">environment variables</a>.</p>
+<p>Use nested <code><sysproperty></code> elements to specify system properties required by the
+factory or transformation. These properties will be made available to JVM during the execution of
+the class. The attributes for this element are the same as for <a href="exec.html#env">environment
+variables</a>.</p>
<p><em>since Ant 1.8.0</em>.</p>
@@ -545,41 +488,40 @@ with <a href="../Types/propertyset.html">syspropertyset</a>s.</p>
<p><em>since Ant 1.8.0</em>.</p>
<h3>Examples</h3>
- <pre>
+<pre>
<xslt basedir="doc" destdir="build/doc"
extension=".html" style="style/apache.xsl"/></pre>
- <h4>Using an xmlcatalog</h4>
- <pre>
+<h4>Using an xmlcatalog</h4>
+<pre>
<xslt basedir="doc" destdir="build/doc"
extension=".html" style="style/apache.xsl">
<xmlcatalog refid="mycatalog"/>
</xslt>
<xslt basedir="doc" destdir="build/doc"
- extension=".html" style="style/apache.xsl">
+ extension=".html" style="style/apache.xsl">
<xmlcatalog>
<dtd
publicId="-//ArielPartners//DTD XML Article V1.0//EN"
location="com/arielpartners/knowledgebase/dtd/article.dtd"/>
</xmlcatalog>
-</xslt>
-</pre>
- <h4>Using XSL parameters</h4>
- <p>Simple String parameter:</p>
+</xslt></pre>
+<h4>Using XSL parameters</h4>
+<p>Simple String parameter:</p>
<pre>
<xslt basedir="doc" destdir="build/doc"
extension=".html" style="style/apache.xsl">
<param name="date" expression="07-01-2000"/>
</xslt></pre>
- <p>Then if you declare a global parameter "date" with the top-level
- element <xsl:param name="date"/>, the variable
- <code>$date</code> will subsequently have the value 07-01-2000.
- </p>
+<p>Then if you declare a global parameter <q>date</q> with the top-level element <code><xsl:param
+name="date"/></code>, the variable <code>$date</code> will subsequently have the value
+07-01-2000.</p>
- <p>Various data types and XPath expressions:</p>
+<p>Various data types and XPath expressions:</p>
- <pre><property name="antProperty1" value="ANT_PROPERTY_1"/>
+<pre>
+<property name="antProperty1" value="ANT_PROPERTY_1"/>
<property name="antProperty2" value="ANT_PROPERTY_2"/>
<property name="antProperty3" value="3"/>
<property name="antProperty4" value="substring-before"/>
@@ -626,7 +568,7 @@ with <a href="../Types/propertyset.html">syspropertyset</a>s.</p>
<param name="p9" expression="default type is String"/>
</xslt></pre>
- <h4>Using output properties</h4>
+<h4>Using output properties</h4>
<pre>
<xslt in="doc.xml" out="build/doc/output.xml"
style="style/apache.xsl">
@@ -634,10 +576,9 @@ with <a href="../Types/propertyset.html">syspropertyset</a>s.</p>
<outputproperty name="standalone" value="yes"/>
<outputproperty name="encoding" value="iso8859_1"/>
<outputproperty name="indent" value="yes"/>
-</xslt>
-</pre>
+</xslt></pre>
- <h4>Using factory settings</h4>
+<h4>Using factory settings</h4>
<pre>
<xslt in="doc.xml" out="build/doc/output.xml"
style="style/apache.xsl">
@@ -646,15 +587,15 @@ with <a href="../Types/propertyset.html">syspropertyset</a>s.</p>
</factory>
</xslt></pre>
- <h4>Using a mapper</h4>
+<h4>Using a mapper</h4>
<pre>
<xslt basedir="in" destdir="out"
style="style/apache.xsl">
<mapper type="glob" from="*.xml.en" to="*.html.en"/>
</xslt></pre>
- <h4>Using a nested resource to define the stylesheet</h4>
- <pre>
+<h4>Using a nested resource to define the stylesheet</h4>
+<pre>
<xslt in="data.xml" out="${out.dir}/out.xml">
<style>
<url url="${printParams.xsl.url}"/>
@@ -662,7 +603,7 @@ with <a href="../Types/propertyset.html">syspropertyset</a>s.</p>
<param name="set" expression="value"/>
</xslt></pre>
- <h4>Print the current processed file name</h4>
+<h4>Print the current processed file name</h4>
<pre>
<project>
<xslt style="printFilename.xsl" destdir="out" basedir="in" extension=".txt"
@@ -671,15 +612,15 @@ with <a href="../Types/propertyset.html">syspropertyset</a>s.</p>
</project>
<xsl:stylesheet
- version="1.0"
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+ version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
- <xsl:param name="filename"></xsl:param>
- <xsl:param name="filedir">.</xsl:param>
+ <xsl:param name="filename"></xsl:param>
+ <xsl:param name="filedir">.</xsl:param>
-<xsl:template match="/">
- Current file is <xsl:value-of select="$filename"/> in directory <xsl:value-of select="$filedir"/>.
-</xsl:template>
+ <xsl:template match="/">
+ Current file is <xsl:value-of select="$filename"/> in directory <xsl:value-of select="$filedir"/>.
+ </xsl:template>
</xsl:stylesheet>
</pre>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/subant.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/subant.html b/manual/Tasks/subant.html
index c5bc952..e7b001e 100644
--- a/manual/Tasks/subant.html
+++ b/manual/Tasks/subant.html
@@ -25,345 +25,239 @@
<body>
<h2>Subant Task</h2>
<h3 id="description">Description</h3>
-<p>
- Calls a given target for all defined sub-builds.
- This is an extension
- of Ant for bulk project execution.
-
- <strong>This task must not be used outside of a
- <code>target</code> if it invokes the same build file it is
- part of.</strong>
-</p>
+<p>Calls a given target for all defined sub-builds. This is an extension of Ant for bulk project
+execution. <strong>This task must not be used outside of a <code>target</code> if it invokes the
+same build file it is part of.</strong></p>
<p><em>Since Apache Ant 1.6</em></p>
-<p>
- <code>subant</code> uses <code>ant</code> internally so many things
- said in <a href="ant.html"><code>ant</code>'s manual page</a> apply
- here as well.
-</p>
+<p><code>subant</code> uses <code>ant</code> internally so many things said
+in <a href="ant.html"><code>ant</code>'s manual page</a> apply here as well.</p>
<h3 id="Use with directories">Use with directories</h3>
-<p>
- subant can be used with directory sets to execute a build from different directories.
- 2 different options are offered :
-</p>
+<p><code>subant</code> can be used with directory sets to execute a build from different
+directories. 2 different options are offered:</p>
<ul>
- <li>
- to run the same build file <code>/somepath/otherpath/mybuild.xml</code>
- with different base directories, use the genericantfile attribute
- </li>
- <li>if you want to run <code>directory1/mybuild.xml</code>, <code>directory2/mybuild.xml</code>, <code>....</code>,
- use the antfile attribute. The subant task does not set the base directory for you in this case, because you can specify it in each build file.
- </li>
+ <li>to run the same build file <samp>/somepath/otherpath/mybuild.xml</samp> with different base
+ directories, use the <var>genericantfile</var> attribute</li>
+ <li>if you want to
+ run <samp>directory1/mybuild.xml</samp>, <samp>directory2/mybuild.xml</samp>, <samp>...</samp>,
+ use the <var>antfile</var> attribute. The <code>subant</code> task does not set the base
+ directory for you in this case, because you can specify it in each build file.</li>
</ul>
<h3 id="attributes">Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top" align="left">
- <b>Attribute</b>
- </td>
- <td valign="top" align="left">
- <b>Description</b>
- </td>
- <td valign="top" align="left">
- <b>Type</b>
- </td>
- <td valign="top" align="left">
- <b>Requirement</b>
- </td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Type</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top" align="left">
- antfile
- </td>
- <td valign="top" align="left">
- Build file name, to use in conjunction with directories.<br> Defaults to "build.xml".<br> If <code>genericantfile</code> is set, this attribute is ignored.
- </td>
- <td valign="top" align="left">
- String
- </td>
- <td valign="top" align="left" rowspan="10">
- Optional
- </td>
+ <td>antfile</td>
+ <td>Build file name, to use in conjunction with directories.</td>
+ <td>String</td>
+ <td>No; defaults to <q>build.xml</q>, ignored if <var>genericantfile</var> is set</td>
</tr>
<tr>
- <td valign="top" align="left">
- buildpath
- </td>
- <td valign="top" align="left">
- Set the buildpath to be used to find sub-projects.
- </td>
- <td valign="top" align="left">
- Path
- </td>
+ <td>buildpath</td>
+ <td>Set the buildpath to be used to find sub-projects.</td>
+ <td>Path</td>
+ <td rowspan="8">No</td>
</tr>
<tr>
- <td valign="top" align="left">
- buildpathref
- </td>
- <td valign="top" align="left">
- Buildpath to use, by reference.
- </td>
- <td valign="top" align="left">
- Reference
- </td>
+ <td>buildpathref</td>
+ <td>Buildpath to use, by reference.</td>
+ <td class="left">Reference</td>
</tr>
<tr>
- <td valign="top" align="left">
- failonerror
- </td>
- <td valign="top" align="left">
- Sets whether to fail with a build exception on error, or go on.
- </td>
- <td valign="top" align="left">
- boolean
- </td>
+ <td>failonerror</td>
+ <td>Sets whether to fail with a build exception on error, or go on.</td>
+ <td class="left">boolean</td>
</tr>
<tr>
- <td valign="top" align="left">
- genericantfile
- </td>
- <td valign="top" align="left">
- Build file path, to use in conjunction with directories.<br> Use <code>genericantfile</code>, in order to run the same build file with different basedirs.<br> If this attribute is set, <code>antfile</code> is ignored.
- </td>
- <td valign="top" align="left">
- File
- </td>
+ <td>genericantfile</td>
+ <td>Build file path, to use in conjunction with directories.<br> Use <var>genericantfile</var>,
+ in order to run the same build file with different <var>basedir</var>s.<br> If this attribute
+ is set, <var>antfile</var> is ignored.</td>
+ <td class="left">File</td>
</tr>
<tr>
- <td valign="top" align="left">
- inheritall
- </td>
- <td valign="top" align="left">
- Corresponds to
- <code><ant></code>'s
- <code>inheritall</code> attribute but defaults
- to false in this task..
- </td>
- <td valign="top" align="left">
- boolean
- </td>
+ <td>inheritall</td>
+ <td>Corresponds to <code><ant></code>'s <var>inheritall</var> attribute but defaults
+ to <q>false</q> in this task.</td>
+ <td class="left">boolean</td>
</tr>
<tr>
- <td valign="top" align="left">
- inheritrefs
- </td>
- <td valign="top" align="left">
- Corresponds to <code><ant></code>'s <code>inheritrefs</code> attribute.
- </td>
- <td valign="top" align="left">
- boolean
- </td>
+ <td>inheritrefs</td>
+ <td>Corresponds to <code><ant></code>'s <var>inheritrefs</var> attribute.</td>
+ <td class="left">boolean</td>
</tr>
<tr>
- <td valign="top" align="left">
- output
- </td>
- <td valign="top" align="left">
- Corresponds to <code><ant></code>'s <code>output</code> attribute.
- </td>
- <td valign="top" align="left">
- String
- </td>
+ <td>output</td>
+ <td>Corresponds to <code><ant></code>'s <var>output</var> attribute.</td>
+ <td class="left">String</td>
</tr>
<tr>
- <td valign="top" align="left">
- target
- </td>
- <td valign="top" align="left"> </td>
- <td valign="top" align="left">
- String
- </td>
+ <td>target</td>
+ <td> </td>
+ <td class="left">String</td>
</tr>
<tr>
- <td valign="top" align="left">
- verbose
- </td>
- <td valign="top" align="left">
- Enable/ disable log messages showing when each sub-build path is entered/ exited.
- The default value is false.
- </td>
- <td valign="top" align="left">
- boolean
- </td>
+ <td>verbose</td>
+ <td>Enable/disable log messages showing when each sub-build path is entered/exited.</td>
+ <td>boolean</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h3 id="elements">Parameters as nested elements</h3>
<h4>any filesystem based <a href="../Types/resources.html#collection">resource collection</a></h4>
- This includes <code><fileset></code>,
- <code><dirset></code> and <code><filelist></code>
- which are the nested resource collections supported prior
- to Ant 1.7.
+<p>This includes <code><fileset></code>, <code><dirset></code>
+and <code><filelist></code> which are the nested resource collections supported prior to Ant
+1.7.</p>
<h4><strong>dirset</strong> (org.apache.tools.ant.types.DirSet)</h4>
Adds a directory set to the implicit build path.
-<p>
- <em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em>
-</p>
+<p><em>Note that the directories will be added to the build path in no particular order, so if order
+is significant, one should use a file list instead!</em></p>
<h4><strong>filelist</strong> (org.apache.tools.ant.types.FileList)</h4>
-Adds an ordered file list to the implicit build path.
-<p>
- <em>Note that contrary to file and directory sets, file lists can reference non-existent files or directories!</em>
-</p>
+<p>Adds an ordered file list to the implicit build path.</p>
+<p><em>Note that contrary to file and directory sets, file lists can reference non-existent files or
+directories!</em></p>
<h4><strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</h4>
-Adds a file set to the implicit build path.
-<p>
- <em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em>
-</p>
+<p>Adds a file set to the implicit build path.</p>
+<p><em>Note that the directories will be added to the build path in no particular order, so if order
+is significant, one should use a file list instead!</em></p>
<h4><strong>property</strong> (org.apache.tools.ant.taskdefs.Property)</h4>
-Corresponds to <code><ant></code>'s nested <code><property></code> element.
-<p>
- When more than one nested <code><property></code> element
- would set a property of the same name, the one declared last will
- win. This is for backwards compatibility reasons even so it is
- different from the way <code><property></code> tasks in build
- files behave.
-</p>
+<p>Corresponds to <code><ant></code>'s nested <code><property></code> element.</p>
+<p>When more than one nested <code><property></code> element would set a property of the same
+name, the one declared last will win. This is for backwards compatibility reasons even so it is
+different from the way <code><property></code> tasks in build files behave.</p>
<h4><strong>propertyset</strong> (org.apache.tools.ant.types.PropertySet)</h4>
- Corresponds to <code><ant></code>'s nested <code><propertyset></code> element.
+<p>Corresponds to <code><ant></code>'s nested <code><propertyset></code> element.</p>
<h4><strong>buildpath</strong> (org.apache.tools.ant.types.Path)</h4>
- Creates a nested build path, and add it to the implicit build path.
+<p>Creates a nested build path, and add it to the implicit build path.</p>
<h4><strong>buildpathelement</strong> (org.apache.tools.ant.types.Path.PathElement)</h4>
- Creates a nested <code><buildpathelement></code>, and add it to the implicit build path.
+<p>Creates a nested <code><buildpathelement></code>, and add it to the implicit build
+path.</p>
<h4><strong>target</strong> (org.apache.tools.ant.taskdefs.Ant.TargetElement)</h4>
- You can specify multiple targets using nested <code><target></code> elements
- instead of using the target attribute. These will be executed as if
- Ant had been invoked with a single target whose dependencies are the
- targets so specified, in the order specified.
- <table>
- <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">The name of the called target.</td>
- <td valign="top" align="center">Yes</td>
- </tr>
- </table>
+<p>You can specify multiple targets using nested <code><target></code> elements instead of
+using the target attribute. These will be executed as if Ant had been invoked with a single target
+whose dependencies are the targets so specified, in the order specified.</p>
+<table class="attr">
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>The name of the called target.</td>
+ <td>Yes</td>
+ </tr>
+</table>
<p><em>since Ant 1.7</em>.</p>
<h3 id="examples">Examples</h3>
<pre>
- <project name="subant" default="subant1">
- <property name="build.dir" value="subant.build"/>
- <target name="subant1">
- <subant target="">
- <property name="build.dir" value="subant1.build"/>
- <property name="not.overloaded" value="not.overloaded"/>
- <fileset dir="." includes="*/build.xml"/>
- </subant>
- </target>
- </project>
-</pre>
-<p>
- this snippet build file will run ant in each subdirectory of the project directory,
- where a file called build.xml can be found.
- The property build.dir will have the value subant1.build in the ant projects called by subant.
-</p>
+<project name="subant" default="subant1">
+ <property name="build.dir" value="subant.build"/>
+ <target name="subant1">
+ <subant target="">
+ <property name="build.dir" value="subant1.build"/>
+ <property name="not.overloaded" value="not.overloaded"/>
+ <fileset dir="." includes="*/build.xml"/>
+ </subant>
+ </target>
+</project></pre>
+<p>this snippet build file will run <code>ant</code> in each subdirectory of the project directory,
+where a file called <samp>build.xml</samp> can be found. The property <code>build.dir</code> will
+have the value <q>subant1.build</q> in the Ant projects called by <code>subant</code>.</p>
<pre>
- <subant target="">
- <propertyset>
- <propertyref prefix="toplevel"/>
- <mapper type="glob" from="foo*" to="bar*"/>
- </propertyset>
- <fileset dir="." includes="*/build.xml"/>
- </subant>
-</pre>
-<p>
- this snippet build file will run ant in each subdirectory of the project directory,
- where a file called build.xml can be found.
- All properties whose name starts with "foo" are passed, their names are changed to start with "bar" instead
-</p>
+<subant target="">
+ <propertyset>
+ <propertyref prefix="toplevel"/>
+ <mapper type="glob" from="foo*" to="bar*"/>
+ </propertyset>
+ <fileset dir="." includes="*/build.xml"/>
+</subant></pre>
+<p>this snippet build file will run <code>ant</code> in each subdirectory of the project directory,
+where a file called <samp>build.xml</samp> can be found. All properties whose name starts
+with <q>foo</q> are passed, their names are changed to start with <q>bar</q> instead</p>
<pre>
- <subant target="compile" genericantfile="/opt/project/build1.xml">
- <dirset dir="." includes="projects*"/>
- </subant>
-</pre>
-<p>
- assuming the subdirs of the project dir are called projects1, projects2, projects3
- this snippet will execute the compile target of /opt/project/build1.xml,
- setting the basedir to projects1, projects2, projects3
-</p>
-<p>
- Now a little more complex - but useful - scenario. Assume that we have
- a directory structure like this:
-</p>
+<subant target="compile" genericantfile="/opt/project/build1.xml">
+ <dirset dir="." includes="projects*"/>
+</subant></pre>
+<p>assuming the subdirs of the project dir are
+called <samp>projects1</samp>, <samp>projects2</samp>, <samp>projects3</samp> this snippet will
+execute the compile target of <samp>/opt/project/build1.xml</samp>, setting the <var>basedir</var>
+to <q>projects1</q>, <q>projects2</q>, <q>projects3</q></p>
+<p>Now a little more complex—but useful—scenario. Assume that we have a directory
+structure like this:</p>
<pre>
- root
- | common.xml
- | build.xml
- |
- +-- modules
- +-- modA
- | +-- src
- +-- modB
- +-- src
+root
+ | common.xml
+ | build.xml
+ |
+ +-- modules
+ +-- modA
+ | +-- src
+ +-- modB
+ +-- src
- <u><b>common.xml:</b></u><br>
- <project>
- <property name="src.dir" value="src"/>
- <property name="build.dir" value="build"/>
- <property name="classes.dir" value="${build.dir}/classes"/>
+<b>common.xml:</b><br/>
+<project>
+ <property name="src.dir" value="src"/>
+ <property name="build.dir" value="build"/>
+ <property name="classes.dir" value="${build.dir}/classes"/>
- <target name="compile">
- <mkdir dir="${classes.dir}"/>
- <javac srcdir="${src.dir}" destdir="${classes.dir}"/>
- </target>
+ <target name="compile">
+ <mkdir dir="${classes.dir}"/>
+ <javac srcdir="${src.dir}" destdir="${classes.dir}"/>
+ </target>
- <!-- more targets -->
- </project>
+ <!-- more targets -->
+</project>
- <u><b>build.xml:</b></u><br>
- <project>
- <macrodef name="iterate">
- <attribute name="target"/>
- <sequential>
- <subant target="@{target}">
- <fileset dir="modules" includes="*/build.xml"/>
- </subant>
- </sequential>
- </macrodef>
+<b>build.xml:</b><br/>
+<project>
+ <macrodef name="iterate">
+ <attribute name="target"/>
+ <sequential>
+ <subant target="@{target}">
+ <fileset dir="modules" includes="*/build.xml"/>
+ </subant>
+ </sequential>
+ </macrodef>
+ <target name="compile">
+ <iterate target="compile"/>
+ </target>
- <target name="compile">
- <iterate target="compile"/>
- </target>
+ <!-- more targets -->
+</project>
- <!-- more targets -->
- </project>
+<b>modules/modA/build.xml:</b><br/>
+<project name="modA">
+ <import file="../../common.xml"/>
+</project></pre>
- <u><b>modules/modA/build.xml:</b></u><br>
- <project name="modA">
- <import file="../../common.xml"/>
- </project>
-</pre>
-
-<p>
- This results in very small buildfiles in the modules, maintainable
- buildfile (common.xml) and a clear project structure. Additionally
- the root buildfile is capable to run the whole build over all
- modules.
-</p>
+<p>This results in very small build files in the modules, maintainable build file
+(<samp>common.xml</samp>) and a clear project structure. Additionally the root build file is capable
+to run the whole build over all modules.</p>
<pre>
- <subant failonerror="false">
- <fileset dir="." includes="**/build.xml" excludes="build.xml"/>
- <target name="clean"/>
- <target name="build"/>
- </subant>
-</pre>
+<subant failonerror="false">
+ <fileset dir="." includes="**/build.xml" excludes="build.xml"/>
+ <target name="clean"/>
+ <target name="build"/>
+</subant></pre>
<p>Does a "clean build" for each subproject.</p>
-<p>
- <b>Hint:</b> because buildfiles are plain xml, you could generate the
- masterbuildfile from the common buildfile by using a XSLT transformation:
-</p>
+<p><strong>Hint</strong>: because build files are plain xml, you could generate the master build
+file from the common build file by using a XSLT transformation:</p>
<pre>
- <xslt in="common.xml"
- out="master.xml"
- style="${ant.home}/etc/common2master.xsl"/>
-</pre>
+<xslt in="common.xml"
+ out="master.xml"
+ style="${ant.home}/etc/common2master.xsl"/></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/symlink.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/symlink.html b/manual/Tasks/symlink.html
index 127514e..e8a93ee 100644
--- a/manual/Tasks/symlink.html
+++ b/manual/Tasks/symlink.html
@@ -26,114 +26,99 @@
<h2 id="symlink">Symlink</h2>
<h3>Description</h3>
-<p>
-Manages symbolic links on platforms where Java supports symbolic links.
-Can be used to make an individual link, delete a link, create multiple links
-from properties files, or create properties files describing links in the
-specified directories. Existing files are not overwritten by default.
-</p>
-<p>
-<a href="../Types/fileset.html">FileSet</a>s are used to select a
-set of links to record, or a set of property files to create links from.
-</p>
+<p>Manages symbolic links on platforms where Java supports symbolic links. Can be used to make an
+individual link, delete a link, create multiple links from properties files, or create properties
+files describing links in the specified directories. Existing files are not overwritten by
+default.</p>
+<p><a href="../Types/fileset.html">FileSet</a>s are used to select a set of links to record, or a
+set of property files to create links from.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">action</td>
- <td valign="top">The type of action to perform, may be "single",
- "record", "recreate" or "delete".</td>
- <td valign="top" align="center">No, defaults to single.</td>
+ <td>action</td>
+ <td>The type of action to perform, may be <q>single</q>, "<q>record</q>, <q>recreate</q>
+ or <q>delete</q>.</td>
+ <td>No; defaults to <q>single</q></td>
</tr>
<tr>
- <td valign="top">link</td>
- <td valign="top">The name of the link to be created or deleted.<br/>
- <strong>Note</strong>: this attribute is resolved against the current
- working directory rather than the project's basedir for
- historical reasons. It is recommended you always use an
- absolute path or a path like <code>${basedir}/some-path</code>
- as its value.
+ <td>link</td>
+ <td>The name of the link to be created or deleted.<br/><strong>Note</strong>: this attribute is
+ resolved against the current working directory rather than the project's <var>basedir</var>
+ for historical reasons. It is recommended you always use an absolute path or a path
+ like <samp>${basedir}/some-path</samp> as its value.
</td>
- <td valign="center" align="center" >required for
- action="single" or "delete". Ignored in other actions.</td>
+ <td>Yes, for <var>action</var>=<q>single</q> or <q>delete</q>; ignored in other actions</td>
</tr>
<tr>
- <td valign="top">resource</td>
- <td valign="top">The resource the link should point to.</td>
- <td valign="top" align="center">required for action="single". Ignored in other actions.</td>
+ <td>resource</td>
+ <td>The resource the link should point to.</td>
+ <td>Yes, for <var>action</var>=<q>single</q>; ignored in other actions</td>
</tr>
<tr>
- <td valign="top">linkfilename</td>
- <td valign="top">The name of the properties file to create in
- each included directory.</td>
- <td valign="top" align="center">required for action="record".
- Ignored in other actions.</td>
+ <td>linkfilename</td>
+ <td>The name of the properties file to create in each included directory.</td>
+ <td>Yes, for <var>action</var>=<q>record</q>; ignored in other actions</td>
</tr>
<tr>
- <td valign="top">overwrite</td>
- <td valign="top">Overwrite existing files or not. If overwrite is set to true, then
- any existing file, specified by the link attribute, will be overwritten irrespective
- of whether or not the existing file is a symbolic link.</td>
- <td valign="top" align="center">No; defaults to false.</td>
+ <td>overwrite</td>
+ <td>Overwrite existing files or not. If overwrite is set to <q>true</q>, then any existing file,
+ specified by the link attribute, will be overwritten irrespective of whether or not the
+ existing file is a symbolic link.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">Stop build if true, log a warning message, but do not stop the build,
- when the an error occurs if false.
- </td>
- <td valign="top" align="center">No; defaults to true.</td>
+ <td>failonerror</td>
+ <td>Stop build if true, log a warning message, but do not stop the build, when the an error
+ occurs if false.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>fileset</h4>
- <p><a href="../Types/fileset.html">FileSet</a>s
- are used when action = "record" to select directories and linknames to be recorded.
- They are also used when action = "recreate" to specify both the name of the property
- files to be processed, and the directories in which they can be found. At least one
- fileset is required for each case.</p>
+<p><a href="../Types/fileset.html">FileSet</a>s are used when <var>action</var>=<q>record</q> to
+select directories and link names to be recorded. They are also used
+when <var>action</var>=<q>recreate</q> to specify both the name of the property files to be
+processed, and the directories in which they can be found. At least one fileset is required for each
+case.</p>
<h3>Examples</h3>
- <p>Make a link named "foo" to a resource named "bar.foo" in subdir:</p>
- <pre>
- <symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/>
- </pre>
+<p>Make a link named <samp>foo</samp> to a resource named <samp>bar.foo</samp>
+in <samp>subdir</samp>:</p>
+<pre><symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/></pre>
- <p>Record all links in subdir and it's descendants in files named
- "dir.links"</p>
- <pre>
- <symlink action="record" linkfilename="dir.links">
- <fileset dir="${dir.top}" includes="subdir/**"/>
- </symlink>
- </pre>
+<p>Record all links in <samp>subdir</samp> and it's descendants in files
+named <samp>dir.links</samp></p>
+<pre>
+<symlink action="record" linkfilename="dir.links">
+ <fileset dir="${dir.top}" includes="subdir/**"/>
+</symlink></pre>
- <p>Recreate the links recorded in the previous example:</p>
- <pre>
- <symlink action="recreate">
- <fileset dir="${dir.top}" includes="subdir/**/dir.links"/>
- </symlink>
- </pre>
+<p>Recreate the links recorded in the previous example:</p>
+<pre>
+<symlink action="recreate">
+ <fileset dir="${dir.top}" includes="subdir/**/dir.links"/>
+</symlink></pre>
- <p>Delete a link named "foo":</p>
- <pre>
- <symlink action="delete" link="${dir.top}/foo"/>
- </pre>
+<p>Delete a link named <samp>foo</samp>:</p>
+<pre><symlink action="delete" link="${dir.top}/foo"/></pre>
- <p><strong>Java 1.2 and earlier</strong>: Due to limitations on executing system
- level commands in Java versions earlier than 1.3 this task may have difficulty
- operating with a relative path in ANT_HOME. The typical symptom is an
- IOException where Apache Ant can't find /some/working/directory${ANT_HOME}/bin/antRun
- or something similar. The workaround is to change your ANT_HOME environment
- variable to an absolute path, which will remove the /some/working/directory portion
- of the above path and allow Ant to find the correct commandline execution script.
+<p><strong>Java 1.2 and earlier</strong>: Due to limitations on executing system level commands in
+Java versions earlier than 1.3 this task may have difficulty operating with a relative path
+in <code>ANT_HOME</code>. The typical symptom is an IOException where Apache Ant can't
+find <samp>/some/working/directory${ANT_HOME}/bin/antRun</samp> or something similar. The workaround
+is to change your <code>ANT_HOME</code> environment variable to an absolute path, which will remove
+the <samp>/some/working/directory</samp> portion of the above path and allow Ant to find the correct
+command line execution script.</p>
-<p><strong>Note</strong>: <em>Since Ant 1.10.2</em>, this task relies on the symbolic
- link support introduced in Java 7 through the java.nio.file.Files APIs</p>
+<p><strong>Note</strong>: <em>Since Ant 1.10.2</em>, this task relies on the symbolic link support
+introduced in Java 7 through the <code>java.nio.file.Files</code> APIs</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/sync.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/sync.html b/manual/Tasks/sync.html
index a598175..916cc73 100644
--- a/manual/Tasks/sync.html
+++ b/manual/Tasks/sync.html
@@ -31,107 +31,90 @@
<p>Synchronize a target directory from the files defined in one or
more <a href="../Types/resources.html#collection">Resource Collection</a>s.</p>
-<p>Any file in the target directory that has not been matched by at
-least one of the nested resource collections gets removed. I.e. if you exclude a
-file in your sources and a file of that name is present in the target
-dir, it will get removed from the target.</p>
+<p>Any file in the target directory that has not been matched by at least one of the nested resource
+collections gets removed. I.e. if you exclude a file in your sources and a file of that name is
+present in the target dir, it will get removed from the target.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">todir</td>
- <td valign="top">the target directory to sync with the resource collections</td>
- <td align="center" valign="top">Yes</td>
+ <td>todir</td>
+ <td>the target directory to sync with the resource collections</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">overwrite</td>
- <td valign="top">Overwrite existing files even if the destination
- files are newer.</td>
- <td valign="top" align="center">No; defaults to false.</td>
+ <td>overwrite</td>
+ <td>Overwrite existing files even if the destination files are newer.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">includeEmptyDirs</td>
- <td valign="top">Copy any empty directories included in the
- resource collection(s).<br/>
- <strong>Note</strong> this attribute also controls the behavior for any
- nested <preserveintarget> element. If this attribute is
- false (the default) empty directories that only exist in the
- target directory will be removed even if they are matched by
- the patterns of <preserveintarget>. This can be
- overridden by <preserveintarget>'s
- preserveEmptyDirs attribute.
- </td>
- <td valign="top" align="center">No; defaults to false.</td>
+ <td>includeEmptyDirs</td>
+ <td>Copy any empty directories included in the resource
+ collection(s).<br/><strong>Note</strong>: this attribute also controls the behavior for any
+ nested <preserveintarget> element. If this attribute is <q>false</q> (the default)
+ empty directories that only exist in the target directory will be removed even if they are
+ matched by the patterns of <preserveintarget>. This can be overridden by
+ <preserveintarget>'s <var>preserveEmptyDirs</var> attribute.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">If is set to false, log a warning message, but do not stop the build,
- when one of the nested filesets points to a directory that
- doesn't exist.
- </td>
- <td valign="top" align="center">No; defaults to true.</td>
+ <td>failonerror</td>
+ <td>If set to <q>false</q>, log a warning message, but do not stop the build, when one of the
+ nested filesets points to a directory that doesn't exist.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Log the files that are being copied.</td>
- <td valign="top" align="center">No; defaults to false.</td>
+ <td>verbose</td>
+ <td>Log the files that are being copied.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">granularity</td>
- <td valign="top">The number of milliseconds leeway to give before
- deciding a file is out of date. This is needed because not every
- file system supports tracking the last modified time to the
- millisecond level. Default is 0 milliseconds, or 2 seconds on DOS
- systems. This can also be useful if source and target files live
- on separate machines with clocks being out of sync. <em>since Ant
- 1.6.2</em>.</td>
- <td valign="top" align="center">No.</td>
+ <td>granularity</td>
+ <td>The number of milliseconds leeway to give before deciding a file is out of date. This is
+ needed because not every file system supports tracking the last modified time to the
+ millisecond level. This can also be useful if source and target files live on separate
+ machines with clocks being out of sync. <em>since Ant 1.6.2</em>.</td>
+ <td>No; default is 0 milliseconds, or 2 seconds on DOS systems.</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>fileset or any other resource collection</h4>
-<p><a href="../Types/resources.html#collection">Resource
-Collection</a>s are used to select groups of files to copy.</p>
-<p>Prior to Ant 1.7 only <code><fileset></code> has been
-supported as a nested element.</p>
+<p><a href="../Types/resources.html#collection">Resource Collection</a>s are used to select groups
+of files to copy.</p>
+<p>Prior to Ant 1.7 only <code><fileset></code> has been supported as a nested element.</p>
<h4>preserveInTarget</h4>
<p><em>Since Ant 1.7.0</em></p>
-<p>Specifies files or directories that should be kept in the target
-directory even if they are not present in one of the source
-directories.</p>
+<p>Specifies files or directories that should be kept in the target directory even if they are not
+present in one of the source directories.</p>
-<p>This nested element is like a <a
-href="../Types/fileset.html">FileSet</a> except that it doesn't
-support the dir attribute and the usedefaultexcludes attribute
-defaults to false.</p>
+<p>This nested element is like a <a href="../Types/fileset.html">FileSet</a> except that it doesn't
+support the <var>dir</var> attribute and the <var>usedefaultexcludes</var> attribute defaults
+to <q>false</q>.</p>
<h5>Additional Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">preserveEmptyDirs</td>
- <td valign="top">Overrules the includeEmptydirs setting for
- directories matched by this element. If you want to preserve
- empty directories that are not in your source directory you can
- either set the task's includeemptydirs attribute or this one.
- If the two attribute values conflict, this attribute
- "wins".</td>
- <td align="center" valign="top">No, defaults to the value of the
- task's includeemptydirs attribute</td>
+ <td>preserveEmptyDirs</td>
+ <td>Overrules the <var>includeEmptydirs</var> setting for directories matched by this element.
+ If you want to preserve empty directories that are not in your source directory you can either
+ set the task's <var>includeemptydirs</var> attribute or this one. If the two attribute values
+ conflict, this attribute "wins".</td>
+ <td>No; defaults to the value of the task's <var>includeemptydirs</var> attribute</td>
</tr>
</table>
@@ -140,11 +123,9 @@ defaults to false.</p>
<pre>
<sync todir="site">
<fileset dir="generated-site"/>
-</sync>
-</pre>
-<p>overwrites all files in <em>site</em> with newer files from
-<em>generated-site</em>, deletes files from <em>site</em> that are not
-present in <em>generated-site</em>.</p>
+</sync></pre>
+<p>overwrites all files in <samp>site</samp> with newer files from <samp>generated-site</samp>,
+deletes files from <samp>site</samp> that are not present in <samp>generated-site</samp>.</p>
<pre>
<sync todir="site">
@@ -152,12 +133,10 @@ present in <em>generated-site</em>.</p>
<preserveintarget>
<include name="**/CVS/**"/>
</preserveintarget>
-</sync>
-</pre>
-<p>overwrites all files in <em>site</em> with newer files from
-<em>generated-site</em>, deletes files from <em>site</em> that are not
-present in <em>generated-site</em> but keeps all files in any
-<em>CVS</em> sub-directory.</p>
+</sync></pre>
+<p>overwrites all files in <samp>site</samp> with newer files from <samp>generated-site</samp>,
+deletes files from <samp>site</samp> that are not present in <samp>generated-site</samp> but keeps
+all files in any <samp>CVS</samp> sub-directory.</p>
</body>
</html>