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:33 UTC
[18/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/custom-programming.html
----------------------------------------------------------------------
diff --git a/manual/Types/custom-programming.html b/manual/Types/custom-programming.html
index 5f851e4..caf3b94 100644
--- a/manual/Types/custom-programming.html
+++ b/manual/Types/custom-programming.html
@@ -17,26 +17,26 @@
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
-<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
-<title>Custom Components</title>
+ <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
+ <title>Custom Components</title>
</head>
<body>
<h2>Custom Components</h2>
<h3>Overview</h3>
<p>
- Custom components are conditions, selectors, filters and other
- objects that are defined outside Apache Ant core.
+ Custom components are conditions, selectors, filters and other objects
+ that are defined outside Apache Ant core.
</p>
<p>
- In Ant 1.6 custom conditions, selectors and filters has
- been overhauled.
+ In Ant 1.6 custom conditions, selectors and filters has been
+ overhauled.
</p>
<p>
It is now possible to define custom conditions, selectors and filters
- that behave like Ant Core components.
- This is achieved by allowing datatypes defined in build scripts
- to be used as custom components if the class of the datatype
- is compatible, or has been adapted by an adapter class.
+ that behave like Ant Core components. This is achieved by allowing
+ datatypes defined in build scripts to be used as custom components if
+ the class of the datatype is compatible, or has been adapted by an
+ adapter class.
</p>
<p>
The old methods of defining custom components are still supported.
@@ -44,25 +44,25 @@
<h3>Definition and use</h3>
<p>
A custom component is a normal Java class that implements a particular
- interface or extends a particular class, or has been adapted to the
+ interface or extends a particular class, or has been adapted to the
interface or class.
</p>
<p>
- It is exactly like writing a
- <a href="../develop.html#writingowntask">custom task</a>.
- One defines attributes and nested elements by writing <i>setter</i>
- methods and <i>add</i> methods.
+ It is exactly like writing
+ a <a href="../develop.html#writingowntask">custom task</a>. One
+ defines attributes and nested elements by writing <em>setter</em>
+ methods and <em>add</em> methods.
</p>
<p>
- After the class has been written, it is added to the ant system
- by using <code><typedef></code>.
+ After the class has been written, it is added to the ant system by
+ using <code><typedef></code>.
</p>
<h3 id="customconditions">Custom Conditions</h3>
<p>
- Custom conditions are datatypes that implement
- <code>org.apache.tools.ant.taskdefs.condition.Condition</code>.
- For example a custom condition that returns true if a
- string is all upper case could be written as:
+ Custom conditions are datatypes that
+ implement <code>org.apache.tools.ant.taskdefs.condition.Condition</code>.
+ For example a custom condition that returns true if a string is all
+ upper case could be written as:
</p>
<pre>
package com.mydomain;
@@ -84,42 +84,37 @@ public class AllUpperCaseCondition implements Condition {
throw new BuildException("value attribute is not set");
}
return value.toUpperCase().equals(value);
- }
-}
- </pre>
+ }
+}</pre>
<p>
- Adding the condition to the system is achieved as follows:
+ Adding the condition to the system is achieved as follows:
</p>
<pre>
<typedef
name="alluppercase"
classname="com.mydomain.AllUpperCaseCondition"
- classpath="${mydomain.classes}"/>
- </pre>
+ classpath="${mydomain.classes}"/></pre>
<p>
- This condition can now be used wherever a Core Ant condition
- is used.
+ This condition can now be used wherever a Core Ant condition is used.
</p>
<pre>
<condition property="allupper">
- <alluppercase value="THIS IS ALL UPPER CASE"/>
-</condition>
- </pre>
+ <alluppercase value="THIS IS ALL UPPER CASE"/>
+</condition></pre>
<h3 id="customselectors">Custom Selectors</h3>
<p>
- Custom selectors are datatypes that implement
- <code>org.apache.tools.ant.types.selectors.FileSelector</code>.
+ Custom selectors are datatypes that
+ implement <code>org.apache.tools.ant.types.selectors.FileSelector</code>.
</p>
- <p>There is only one method required.
- <code>public boolean isSelected(File basedir, String filename,
- File file)</code>.
- It returns true
- or false depending on whether the given file should be
+ <p>
+ There is only one method required, <code>public boolean
+ isSelected(File basedir, String filename, File file)</code>. It
+ returns true or false depending on whether the given file should be
selected or not.
</p>
<p>
An example of a custom selection that selects filenames ending
- in ".java" would be:
+ in <samp>.java</samp> would be:
</p>
<pre>
package com.mydomain;
@@ -127,10 +122,9 @@ import java.io.File;
import org.apache.tools.ant.types.selectors.FileSelector;
public class JavaSelector implements FileSelector {
public boolean isSelected(File b, String filename, File f) {
- return filename.toLowerCase().endsWith(".java");
+ return filename.toLowerCase().endsWith(".java");
}
-}
- </pre>
+}</pre>
<p>
Adding the selector to the system is achieved as follows:
</p>
@@ -138,50 +132,46 @@ public class JavaSelector implements FileSelector {
<typedef
name="javaselector"
classname="com.mydomain.JavaSelector"
- classpath="${mydomain.classes}"/>
- </pre>
+ classpath="${mydomain.classes}"/></pre>
<p>
- This selector can now be used wherever a Core Ant selector
- is used, for example:
+ This selector can now be used wherever a Core Ant selector is used,
+ for example:
</p>
<pre>
<copy todir="to">
- <fileset dir="src">
- <javaselector/>
- </fileset>
-</copy>
- </pre>
+ <fileset dir="src">
+ <javaselector/>
+ </fileset>
+</copy></pre>
<p>
- One may use
- <code>org.apache.tools.ant.types.selectors.BaseSelector</code>,
- a convenience class that provides reasonable default
- behaviour.
- It has some predefined behaviours you can take advantage
- of. Any time you encounter a problem when setting attributes or
- adding tags, you can call setError(String errmsg) and the class
- will know that there is a problem. Then, at the top of your
- <code>isSelected()</code> method call <code>validate()</code> and
- a BuildException will be thrown with the contents of your error
- message. The <code>validate()</code> method also gives you a
- last chance to check your settings for consistency because it
- calls <code>verifySettings()</code>. Override this method and
- call <code>setError()</code> within it if you detect any
- problems in how your selector is set up.
+ One may
+ use <code>org.apache.tools.ant.types.selectors.BaseSelector</code>, a
+ convenience class that provides reasonable default behaviour. It has
+ some predefined behaviours you can take advantage of. Any time you
+ encounter a problem when setting attributes or adding tags, you can
+ call <code>setError(String errmsg)</code> and the class will know that
+ there is a problem. Then, at the top of your <code>isSelected()</code>
+ method call <code>validate()</code> and a BuildException will be
+ thrown with the contents of your error
+ message. The <code>validate()</code> method also gives you a last
+ chance to check your settings for consistency because it
+ calls <code>verifySettings()</code>. Override this method and
+ call <code>setError()</code> within it if you detect any problems in
+ how your selector is set up.
</p>
<p>
- To write custom selector containers one should extend
- <code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>.
- Implement the
- <code>public boolean isSelected(File baseDir, String filename, File file)</code>
- method to do the right thing. Chances are you'll want to iterate
- over the selectors under you, so use
- <code>selectorElements()</code> to get an iterator that will do
+ To write custom selector containers one should
+ extend <code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>.
+ Implement the <code>public boolean isSelected(File baseDir, String
+ filename, File file)</code> method to do the right thing. Chances are
+ you'll want to iterate over the selectors under you, so
+ use <code>selectorElements()</code> to get an iterator that will do
that.
</p>
<p>
- For example to create a selector container that will select files
- if a certain number of contained selectors select, one could write
- a selector as follows:
+ For example to create a selector container that will select files if a
+ certain number of contained selectors select, one could write a
+ selector as follows:
</p>
<pre>
public class MatchNumberSelectors extends BaseSelectorContainer {
@@ -205,8 +195,7 @@ public class MatchNumberSelectors extends BaseSelectorContainer {
}
return numberSelected == number;
}
-}
- </pre>
+}</pre>
<p>
To define and use this selector one could do:
</p>
@@ -215,170 +204,167 @@ public class MatchNumberSelectors extends BaseSelectorContainer {
classname="com.mydomain.MatchNumberSelectors"/>
...
<fileset dir="${src.path}">
- <numberselected number="2">
- <contains text="script" casesensitive="no"/>
- <size value="4" units="Ki" when="more"/>
- <javaselector/>
- </numberselected>
-</fileset>
- </pre>
+ <numberselected number="2">
+ <contains text="script" casesensitive="no"/>
+ <size value="4" units="Ki" when="more"/>
+ <javaselector/>
+ </numberselected>
+</fileset></pre>
<p>
- <i>The custom selector</i>
+ <em>The custom selector</em>
</p>
<p>
- The custom selector was the pre ant 1.6 way of defining custom selectors.
- This method is still supported for backward compatibility.
+ The custom selector was the pre Ant 1.6 way of defining custom
+ selectors. This method is still supported for backward compatibility.
</p>
- <p>You can write your own selectors and use them within the selector
- containers by specifying them within the <code><custom></code> tag.</p>
-
- <p>To create a new Custom Selector, you have to create a class that
- implements
- <code>org.apache.tools.ant.types.selectors.ExtendFileSelector</code>.
- The easiest way to do that is through the convenience base class
- <code>org.apache.tools.ant.types.selectors.BaseExtendSelector</code>,
- which provides all of the methods for supporting
- <code><param></code> tags. First, override the
- <code>isSelected()</code> method, and optionally the
- <code>verifySettings()</code> method. If your custom
- selector requires parameters to be set, you can also override
- the <code>setParameters()</code> method and interpret the
- parameters that are passed in any way you like. Several of the
- core selectors demonstrate how to do that because they can
- also be used as custom selectors.</p>
-
- <p>Once that is written, you include it in your build file by using
+ <p>
+ You can write your own selectors and use them within the selector
+ containers by specifying them within the <code><custom></code>
+ tag.
+ </p>
+ <p>
+ To create a new Custom Selector, you have to create a class that
+ implements <code>org.apache.tools.ant.types.selectors.ExtendFileSelector</code>.
+ The easiest way to do that is through the convenience base
+ class <code>org.apache.tools.ant.types.selectors.BaseExtendSelector</code>,
+ which provides all of the methods for
+ supporting <code><param></code> tags. First, override
+ the <code>isSelected()</code> method, and optionally
+ the <code>verifySettings()</code> method. If your custom selector
+ requires parameters to be set, you can also override
+ the <code>setParameters()</code> method and interpret the parameters
+ that are passed in any way you like. Several of the core selectors
+ demonstrate how to do that because they can also be used as custom
+ selectors.
+ </p>
+ <p>
+ Once that is written, you include it in your build file by using
the <code><custom></code> tag.
</p>
- <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">classname</td>
- <td valign="top">The name of your class that implements
- <code>org.apache.tools.ant.types.selectors.FileSelector</code>.
+ <td>classname</td>
+ <td>
+ The name of your class that
+ implements <code>org.apache.tools.ant.types.selectors.FileSelector</code>.
</td>
- <td valign="top" align="center">Yes</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">The classpath to use in order to load the
- custom selector class. If neither this classpath nor the
- classpathref are specified, the class will be
+ <td>classpath</td>
+ <td>
+ The classpath to use in order to load the custom selector
+ class. If neither <var>classpath</var> nor
+ <var>classpathref</var> are specified, the class will be
loaded from the classpath that Ant uses.
</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">A reference to a classpath previously
- defined. If neither this reference nor the
- classpath above are specified, the class will be
- loaded from the classpath that Ant uses.
+ <td>classpathref</td>
+ <td>
+ A reference to a classpath previously defined. If
+ neither <var>classpathref</var> nor <var>classpath</var> above are
+ specified, the class will be loaded from the classpath that Ant
+ uses.
</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
</table>
- <p>Here is how you use <code><custom></code> to
- use your class as a selector:
+ <p>
+ Here is how you use <code><custom></code> to use your class as a
+ selector:
</p>
<pre>
<fileset dir="${mydir}" includes="**/*">
<custom classname="com.mydomain.MySelector">
<param name="myattribute" value="myvalue"/>
</custom>
-</fileset>
- </pre>
- <p>The core selectors that can also be used as custom selectors
- are</p>
+</fileset></pre>
+ <p>The core selectors that can also be used as custom selectors are</p>
<ul>
<li><a href="selectors.html#containsselect">Contains Selector</a> with
- classname <code>org.apache.tools.ant.types.selectors.ContainsSelector</code>
- </li>
+ classname <code>org.apache.tools.ant.types.selectors.ContainsSelector</code></li>
<li><a href="selectors.html#dateselect">Date Selector</a> with
- classname <code>org.apache.tools.ant.types.selectors.DateSelector</code>
- </li>
+ classname <code>org.apache.tools.ant.types.selectors.DateSelector</code></li>
<li><a href="selectors.html#depthselect">Depth Selector</a> with
- classname <code>org.apache.tools.ant.types.selectors.DepthSelector</code>
- </li>
+ classname <code>org.apache.tools.ant.types.selectors.DepthSelector</code></li>
<li><a href="selectors.html#filenameselect">Filename Selector</a> with
- classname <code>org.apache.tools.ant.types.selectors.FilenameSelector</code>
- </li>
+ classname <code>org.apache.tools.ant.types.selectors.FilenameSelector</code></li>
<li><a href="selectors.html#sizeselect">Size Selector</a> with
- classname <code>org.apache.tools.ant.types.selectors.SizeSelector</code>
- </li>
+ classname <code>org.apache.tools.ant.types.selectors.SizeSelector</code></li>
</ul>
- <p>Here is the example from the Depth Selector section rewritten
- to use the selector through <code><custom></code>.</p>
+ <p>
+ Here is the example from the Depth Selector section rewritten to use
+ the selector through <code><custom></code>.
+ </p>
<pre>
<fileset dir="${doc.path}" includes="**/*">
<custom classname="org.apache.tools.ant.types.selectors.DepthSelector">
<param name="max" value="1"/>
</custom>
-</fileset>
- </pre>
- <p>Selects all files in the base directory and one directory below
- that.</p>
+</fileset></pre>
+ <p>Selects all files in the base directory and one directory below that.</p>
<h3 id="filterreaders">Custom Filter Readers</h3>
<p>
- Custom filter readers selectors are datatypes that implement
- <code>org.apache.tools.ant.types.filters.ChainableReader</code>.
+ Custom filter readers selectors are datatypes that
+ implement <code>org.apache.tools.ant.types.filters.ChainableReader</code>.
</p>
- <p>There is only one method required.
- <code>Reader chain(Reader reader)</code>.
- This returns a reader that filters input from the specified
- reader.
+ <p>
+ There is only one method required. <code>Reader chain(Reader
+ reader)</code>. This returns a reader that filters input from the
+ specified reader.
</p>
<p>
- For example a filterreader that removes every second character
- could be:
+ For example a filterreader that removes every second character could
+ be:
</p>
<pre>
public class RemoveOddCharacters implements ChainableReader {
- public Reader chain(Reader reader) {
- return new BaseFilterReader(reader) {
- int count = 0;
- public int read() throws IOException {
- while (true) {
- int c = in.read();
- if (c == -1) {
- return c;
- }
- count++;
- if ((count % 2) == 1) {
- return c;
+ public Reader chain(Reader reader) {
+ return new BaseFilterReader(reader) {
+ int count = 0;
+ public int read() throws IOException {
+ while (true) {
+ int c = in.read();
+ if (c == -1) {
+ return c;
+ }
+ count++;
+ if ((count % 2) == 1) {
+ return c;
+ }
}
- }
- }
- }
- }
-}
- </pre>
+ }
+ }
+ }
+}</pre>
<p>
- For line oriented filters it may be easier to extend
- <code>ChainableFilterReader</code> an inner class of
- <code>org.apache.tools.ant.filters.TokenFilter</code>.
+ For line oriented filters it may be easier to
+ extend <code>ChainableFilterReader</code> an inner class
+ of <code>org.apache.tools.ant.filters.TokenFilter</code>.
</p>
<p>
For example a filter that appends the line number could be
</p>
<pre>
public class AddLineNumber extends ChainableReaderFilter {
- private void lineNumber = 0;
- public String filter(String string) {
- lineNumber++;
- return "" + lineNumber + "\t" + string;
- }
-}
- </pre>
+ private void lineNumber = 0;
+ public String filter(String string) {
+ lineNumber++;
+ return "" + lineNumber + "\t" + string;
+ }
+}</pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/description.html
----------------------------------------------------------------------
diff --git a/manual/Types/description.html b/manual/Types/description.html
index 0445d61..f5cf02c 100644
--- a/manual/Types/description.html
+++ b/manual/Types/description.html
@@ -26,9 +26,8 @@
<h2 id="description">Description</h2>
<h3>Description</h3>
-<p>Allows for a description of the project to be specified that
-will be included in the output of the <code>ant ‑projecthelp</code>
-command.</p>
+<p>Allows for a description of the project to be specified that will be
+included in the output of the <code>ant -projecthelp</code> command.</p>
<h3>Parameters</h3>
<p>(none)</p>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/dirset.html
----------------------------------------------------------------------
diff --git a/manual/Types/dirset.html b/manual/Types/dirset.html
index 3e790dc..76484f0 100644
--- a/manual/Types/dirset.html
+++ b/manual/Types/dirset.html
@@ -25,83 +25,68 @@
<body>
<h2 id="dirset">DirSet</h2>
-<p>A DirSet is a group of directories. These directories can be found in a
-directory tree starting in a base directory and are matched by
-patterns taken from a number of <a href="patternset.html">PatternSets</a>
-and <a href="selectors.html">Selectors</a>.
-</p>
-<p>PatternSets can be specified as nested
-<code><patternset></code> elements. In addition, DirSet holds
-an implicit PatternSet and supports the nested
-<code><include></code>, <code><includesfile></code>,
-<code><exclude></code> and <code><excludesfile></code>
-elements of <code><patternset></code> directly, as well as
-<code><patternset></code>'s attributes.</p>
-<p>Selectors are available as nested elements within the DirSet.
-If any of the selectors within the DirSet do not select the directory, it
-is not considered part of the DirSet. This makes a DirSet
-equivalent to an <code><and></code> selector container.</p>
-<table>
+<p>A DirSet is a group of directories. These directories can be found in a directory tree
+starting in a base directory and are matched by patterns taken from a number
+of <a href="patternset.html">PatternSets</a> and <a href="selectors.html">Selectors</a>.</p>
+<p>PatternSets can be specified as nested <code><patternset></code> elements. In
+addition, DirSet holds an implicit PatternSet and supports the
+nested <code><include></code>, <code><includesfile></code>, <code><exclude></code>
+and <code><excludesfile></code> elements of <code><patternset></code> directly,
+as well as <code><patternset></code>'s attributes.</p>
+<p>Selectors are available as nested elements within the DirSet. If any of the selectors
+within the DirSet do not select the directory, it is not considered part of the DirSet. This
+makes a DirSet equivalent to an <code><and></code> selector container.</p>
+<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">dir</td>
- <td valign="top">The root of the directory tree of this DirSet.</td>
- <td valign="top" align="center">Yes</td>
+ <td>dir</td>
+ <td>The root of the directory tree of this DirSet.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">A comma- or space-separated list of patterns of directories that
- must be included; all directories are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>Comma- or space-separated list of patterns of directories that must be included.</td>
+ <td>No; defaults to all directories</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.
- <b>Note:</b> if the file is empty and there are no other
- patterns defined for the fileset, all directories will be included.
- </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. <strong>Note:</strong> if the file is empty and there are no other patterns defined
+ for the fileset, all directories will be included.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">A comma- or space-separated list of patterns of directories that
- must be excluded; no directories are excluded when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>excludes</td>
+ <td>Comma- or space-separated list of patterns of directories that must be excluded.</td>
+ <td>No; defaults to none</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">casesensitive</td>
- <td valign="top">Specifies whether case-sensitivity should be applied
- (<code>true</code>|<code>yes</code>|<code>on</code> or
- <code>false</code>|<code>no</code>|<code>off</code>).</td>
- <td valign="top" align="center">No; defaults to true.</td>
+ <td>casesensitive</td>
+ <td>Specifies whether case-sensitivity should be applied (<q>true</q>, <q>yes</q>, <q>on</q>
+ or <q>false</q>, <q>no</q>, <q>off</q>).</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">followsymlinks</td>
- <td valign="top">Shall symbolic links be followed? Defaults to
- true. See <a href="fileset.html#symlink">fileset's documentation</a>.</td>
- <td valign="top" align="center">No</td>
+ <td>followsymlinks</td>
+ <td>Shall symbolic links be followed? See <a href="fileset.html#symlink">fileset's
+ documentation</a>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">erroronmissingdir</td>
- <td valign="top">
- Specify what happens if the base directory does not exist.
- If true a build error will happen, if false, the dirset
- will be ignored/empty.
- Defaults to true (for backward compatibility reasons).
- <em>Since Apache Ant 1.7.1</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>erroronmissingdir</td>
+ <td>Specify what happens if the base directory does not exist. If <q>true</q> a build error
+ will happen, if <q>false</q>, the dirset will be ignored/empty. <em>Since Apache Ant
+ 1.7.1</em></td>
+ <td>No; defaults to true (for backward compatibility reasons)</td>
</tr>
</table>
@@ -113,9 +98,8 @@ equivalent to an <code><and></code> selector container.</p>
<exclude name="apps/**/*Test*"/>
</dirset>
</pre>
-<p>Groups all directories named <code>classes</code> found under the
-<code>apps</code> subdirectory of <code>${build.dir}</code>, except those
-that have the text <code>Test</code> in their name.</p>
+<p>Groups all directories named <samp>classes</samp> found under the <samp>apps</samp> subdirectory
+of <samp>${build.dir}</samp>, except those that have the text <samp>Test</samp> in their name.</p>
<pre>
<dirset dir="${build.dir}">
@@ -125,27 +109,26 @@ that have the text <code>Test</code> in their name.</p>
</patternset>
</dirset>
</pre>
-<p>Groups the same directories as the above example, but also establishes
-a PatternSet that can be referenced in other
-<code><dirset></code> elements, rooted at a different directory.</p>
+<p>Groups the same directories as the above example, but also establishes a PatternSet that can be
+referenced in other <code><dirset></code> elements, rooted at a different directory.</p>
<pre>
<dirset dir="${debug_build.dir}">
<patternset refid="non.test.classes"/>
</dirset>
</pre>
-<p>Groups all directories in directory <code>${debug_build.dir}</code>,
-using the same patterns as the above example.</p>
+<p>Groups all directories in directory <samp>${debug_build.dir}</samp>, using the same patterns as
+the above example.</p>
<pre>
<dirset id="dirset" dir="${workingdir}">
<present targetdir="${workingdir}">
- <mapper type="glob" from="*" to="*/${markerfile}" />
+ <mapper type="glob" from="*" to="*/${markerfile}"/>
</present>
</dirset>
</pre>
-<p>Selects all directories somewhere under <code>${workingdir}</code>
-which contain a <code>${markerfile}</code>.</p>
+<p>Selects all directories somewhere under <samp>${workingdir}</samp> which contain
+a <samp>${markerfile}</samp>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/extension.html
----------------------------------------------------------------------
diff --git a/manual/Types/extension.html b/manual/Types/extension.html
index 12193e2..5cf94f7 100644
--- a/manual/Types/extension.html
+++ b/manual/Types/extension.html
@@ -23,62 +23,61 @@
<body>
<h2 id="fileset">Extension</h2>
-<p>Utility type that represents either an available "Optional Package"
- (formerly known as "Standard Extension") as described in the manifest
- of a JAR file, or the requirement for such an optional package.</p>
-<p>Note that this type
-works with extensions as defined by the "Optional Package" specification.
- For more information about optional packages, see the document
-<em>Optional Package Versioning</em> in the documentation bundle for your
-Java2 Standard Edition package, in file
-<code>guide/extensions/versioning.html</code> or the online
-<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">Package Versioning documentation.</a></p>
+<p>Utility type that represents either an available "Optional Package" (formerly known as
+ "Standard Extension") as described in the manifest of a JAR file, or the requirement for such
+ an optional package.</p>
+<p>Note that this type works with extensions as defined by the "Optional Package" specification.
+For more information about optional packages, see the document <em>Optional Package
+Versioning</em> in the documentation bundle for your Java Standard Edition package, in
+file <samp>guide/extensions/versioning.html</samp> or the
+online <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">Package
+Versioning documentation.</a></p>
<h3>Attributes</h3>
<p>The extension type supports the following attributes:</p>
-<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">extensionName</td>
- <td valign="top">The name of extension</td>
- <td valign="top" align="center">yes</td>
+ <td>extensionName</td>
+ <td>The name of extension</td>
+ <td>yes</td>
</tr>
<tr>
- <td valign="top">specificationVersion</td>
- <td valign="top">The version of extension specification (Must be in
- dewey decimal aka dotted decimal notation. 3.2.4)</td>
- <td valign="top" align="center">no</td>
+ <td>specificationVersion</td>
+ <td>The version of extension specification (must be in dewey decimal aka dotted decimal
+ notation, eg <q>3.2.4</q>)</td>
+ <td>no</td>
</tr>
<tr>
- <td valign="top">specificationVendor</td>
- <td valign="top">The specification vendor</td>
- <td valign="top" align="center">no</td>
+ <td>specificationVendor</td>
+ <td>The specification vendor</td>
+ <td>no</td>
</tr>
<tr>
- <td valign="top">implementationVersion</td>
- <td valign="top">The version of extension implementation (Must be in
- dewey decimal aka dotted decimal notation. 3.2.4)</td>
- <td valign="top" align="center">no</td>
+ <td>implementationVersion</td>
+ <td>The version of extension implementation (must be in dewey decimal aka dotted decimal
+ notation, eg <q>3.2.4</q>)</td>
+ <td>no</td>
</tr>
<tr>
- <td valign="top">implementationVendor</td>
- <td valign="top">The implementation vendor</td>
- <td valign="top" align="center">no</td>
+ <td>implementationVendor</td>
+ <td>The implementation vendor</td>
+ <td>no</td>
</tr>
<tr>
- <td valign="top">implementationVendorId</td>
- <td valign="top">The implementation vendor ID</td>
- <td valign="top" align="center">no</td>
+ <td>implementationVendorId</td>
+ <td>The implementation vendor ID</td>
+ <td>no</td>
</tr>
<tr>
- <td valign="top">implementationURL</td>
- <td valign="top">The url from which to retrieve extension.</td>
- <td valign="top" align="center">no</td>
+ <td>implementationURL</td>
+ <td>The url from which to retrieve extension.</td>
+ <td>no</td>
</tr>
</table>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/extensionset.html
----------------------------------------------------------------------
diff --git a/manual/Types/extensionset.html b/manual/Types/extensionset.html
index 4b1d444..d32c2f7 100644
--- a/manual/Types/extensionset.html
+++ b/manual/Types/extensionset.html
@@ -24,13 +24,12 @@
<body>
<h2><a>ExtensionSet</a></h2>
<p>Utility type that represents a set of Extensions.</p>
-<p>Note that this type
-works with extensions as defined by the "Optional Package" specification.
- For more information about optional packages, see the document
-<em>Optional Package Versioning</em> in the documentation bundle for your
-Java2 Standard Edition package, in file
-<code>guide/extensions/versioning.html</code> or online at
-<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">Package Versioning documentation.</a></p>
+<p>Note that this type works with extensions as defined by the "Optional Package" specification.
+For more information about optional packages, see the document <em>Optional Package
+Versioning</em> in the documentation bundle for your Java Standard Edition package, in
+file <samp>guide/extensions/versioning.html</samp> or online
+at <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">Package
+Versioning documentation.</a></p>
<h3>Nested Elements</h3>
@@ -38,14 +37,13 @@ Java2 Standard Edition package, in file
<p><a href="extension.html">Extension</a> object to add to set.</p>
<h4>fileset</h4>
- <p><a href="fileset.html">FileSet</a>s all files contained
- contained within set that are jars and implement an extension are added
- to extension set.</p>
+<p><a href="fileset.html">FileSet</a>s all files contained contained within set that are jars
+and implement an extension are added to extension set.</p>
<h4>LibFileSet</h4>
- <p>All files contained contained within set that are jars and implement
- an extension are added to extension set. However the extension information
- may be modified by attributes of libfileset</p>
+<p>All files contained contained within set that are jars and implement an extension are added
+to extension set. However, the extension information may be modified by attributes of
+libfileset.</p>
<h4>Examples</h4>
<pre>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/filelist.html
----------------------------------------------------------------------
diff --git a/manual/Types/filelist.html b/manual/Types/filelist.html
index 6a9eb62..638b382 100644
--- a/manual/Types/filelist.html
+++ b/manual/Types/filelist.html
@@ -26,79 +26,66 @@
<h2 id="filelist">FileList</h2>
-<p>FileLists are explicitly named lists of files. Whereas FileSets
-act as filters, returning only those files that exist in the file
-system and match specified patterns, FileLists are useful for
-specifying files that may or may not exist. Multiple files are
-specified as a list of files, relative to the specified directory,
-with no support for wildcard expansion (filenames with wildcards will be
-included in the list unchanged).
-FileLists can appear inside tasks that support this feature or as stand-alone
-types.
-</p>
-<table>
+<p>FileLists are explicitly named lists of files. Whereas FileSets act as filters, returning
+only those files that exist in the file system and match specified patterns, FileLists are
+useful for specifying files that may or may not exist. Multiple files are specified as a list
+of files, relative to the specified directory, with no support for wildcard expansion (filenames
+with wildcards will be included in the list unchanged). FileLists can appear inside tasks that
+support this feature or as stand-alone types.</p>
+<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">dir</td>
- <td valign="top">The base directory of this FileList.</td>
- <td valign="top" align="center">Yes</td>
+ <td>dir</td>
+ <td>The base directory of this FileList.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">files</td>
- <td valign="top">The list of file names. This is a list of
- file name separated by whitespace, or by commas.</td>
- <td valign="top" align="center">
- Yes, unless there is a nested file element</td>
+ <td>files</td>
+ <td>The list of file names. This is a list of file name separated by whitespace, or by
+ commas.</td>
+ <td>Yes, unless there is a nested file element</td>
</tr>
</table>
- <h4>Nested Element: file</h4>
- <p>
- This represents a file name. The nested element allows filenames containing
- white space and commas.
- </p>
- <p><em>Since Apache Ant 1.6.2</em></p>
- <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 file.</td>
- <td valign="top" align="center">Yes</td>
- </tr>
+<h4>Nested Element: file</h4>
+<p>This represents a file name. The nested element allows filenames containing white space and
+commas.</p>
+<p><em>Since Apache Ant 1.6.2</em></p>
+<table class="attr">
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>The name of the file.</td>
+ <td>Yes</td>
+ </tr>
</table>
<h4>Examples</h4>
<pre>
<filelist
id="docfiles"
dir="${doc.src}"
- files="foo.xml,bar.xml"/>
-</pre>
+ files="foo.xml,bar.xml"/></pre>
-<p>The files <code>${doc.src}/foo.xml</code> and
-<code>${doc.src}/bar.xml</code>. Note that these files may not (yet)
-actually exist.
-</p>
+<p>The files <samp>${doc.src}/foo.xml</samp> and <samp>${doc.src}/bar.xml</samp>. Note that
+these files may not (yet) actually exist.</p>
<pre>
<filelist
id="docfiles"
dir="${doc.src}"
files="foo.xml
- bar.xml"/>
-</pre>
+ bar.xml"/></pre>
<p>Same files as the example above.</p>
-<pre>
-<filelist refid="docfiles"/>
-</pre>
+<pre><filelist refid="docfiles"/></pre>
<p>Same files as the example above.</p>
@@ -108,8 +95,7 @@ actually exist.
dir="${doc.src}">
<file name="foo.xml"/>
<file name="bar.xml"/>
-</filelist>
-</pre>
+</filelist></pre>
<p>Same files as the example above.</p>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Types/fileset.html
----------------------------------------------------------------------
diff --git a/manual/Types/fileset.html b/manual/Types/fileset.html
index 920e85d..ea05ec5 100644
--- a/manual/Types/fileset.html
+++ b/manual/Types/fileset.html
@@ -25,101 +25,85 @@
<body>
<h2 id="fileset">FileSet</h2>
-<p>A FileSet is a group of files. These files can be found in a
-directory tree starting in a base directory and are matched by
-patterns taken from a number of <a
-href="patternset.html">PatternSets</a> and
-<a href="selectors.html">Selectors</a>.
-<p>PatternSets can be specified as nested
-<code><patternset></code> elements. In addition, FileSet holds
-an implicit PatternSet and supports the nested
-<code><include></code>, <code><includesfile></code>,
-<code><exclude></code> and <code><excludesfile></code>
-elements of PatternSet directly, as well as PatternSet's
+<p>A FileSet is a group of files. These files can be found in a directory tree starting in a
+base directory and are matched by patterns taken from a number
+of <a href="patternset.html">PatternSets</a> and <a href="selectors.html">Selectors</a>.</p>
+<p>PatternSets can be specified as nested q<code><patternset></code> elements. In
+addition, FileSet holds an implicit PatternSet and supports the
+nested <code><include></code>, <code><includesfile></code>, <code><exclude></code>
+and <code><excludesfile></code> elements of PatternSet directly, as well as PatternSet's
attributes.</p>
-<p>Selectors are available as nested elements within the FileSet.
-If any of the selectors within the FileSet do not select the file, the
-file is not considered part of the FileSet. This makes a FileSet
-equivalent to an <code><and></code> selector container.</p>
-<table>
+<p>Selectors are available as nested elements within the FileSet. If any of the selectors
+within the FileSet do not select the file, the file is not considered part of the FileSet. This
+makes a FileSet equivalent to an <code><and></code> selector container.</p>
+<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">dir</td>
- <td valign="top">the root of the directory tree of this FileSet.</td>
- <td valign="middle" align="center" rowspan="2">Exactly one of dir or file must be specified</td>
+ <td>dir</td>
+ <td>the root of the directory tree of this FileSet.</td>
+ <td rowspan="2">Exactly one of dir or file must be specified</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">shortcut for specifying a single-file fileset</td>
+ <td>file</td>
+ <td class="left">shortcut for specifying a single-file fileset</td>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether <a href="../dirtasks.html#defaultexcludes">default excludes</a> should be used or not
- (<code>yes | no</code>); default excludes are used when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether <a href="../dirtasks.html#defaultexcludes">default excludes</a> should
+ be used or not (<code>yes|no</code>).</td>
+ <td>No; defaults to <q>yes</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 files</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.<br/>
- <b>Note:</b> if the file is empty and there are no other
- patterns defined for the fileset, all files will be included.
+ <td>includesfile</td>
+ <td>name of a file; each line of this file is taken to be an include pattern.<br/>
+ <strong>Note</strong>: if the file is empty and there are no other patterns defined for
+ the fileset, all files will be included.
</td>
- <td valign="top" align="center">No</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">casesensitive</td>
- <td valign="top">Must the include and exclude patterns be treated in a case sensitive way?
- Defaults to true.</td>
- <td valign="top" align="center">No</td>
+ <td>casesensitive</td>
+ <td>Must the include and exclude patterns be treated in a case sensitive way?</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">followsymlinks</td>
- <td valign="top">Shall symbolic links be followed? Defaults to
- true. See the note <a href="#symlink">below</a>.</td>
- <td valign="top" align="center">No</td>
+ <td>followsymlinks</td>
+ <td>Shall symbolic links be followed? See the note <a href="#symlink">below</a>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">erroronmissingdir</td>
- <td valign="top">
- Specify what happens if the base directory does not exist.
- If true a build error will happen, if false, the fileset
- will be ignored/empty.
- Defaults to true.
- <em>Since Apache Ant 1.7.1 (default is true for backward compatibility
- reasons.)</em>
+ <td>erroronmissingdir</td>
+ <td>
+ Specify what happens if the base directory does not exist. If <q>true</q> a build error
+ will happen, if <q>false</q>, the fileset will be ignored/empty.
+ <em>Since Apache Ant 1.7.1</em>
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to <q>true</q> (for backward compatibility reasons)</td>
</tr>
</table>
-<p id="symlink"><b>Note</b>: All files/directories for which
-the canonical path is different from its path are considered symbolic
-links. On Unix systems this usually means the file really is a
-symbolic link but it may lead to false results on other
-platforms.</p>
+<p id="symlink"><strong>Note</strong>: All files/directories for which the canonical path is
+different from its path are considered symbolic links. On Unix systems this usually means the
+file really is a symbolic link but it may lead to false results on other platforms.</p>
<h4>Examples</h4>
<pre>
@@ -128,9 +112,8 @@ platforms.</p>
<exclude name="**/*Test*"/>
</fileset>
</pre>
-<p>Groups all files in directory <code>${server.src}</code> that are Java
-source files and don't have the text <code>Test</code> in their
-name.</p>
+<p>Groups all files in directory <samp>${server.src}</samp> that are Java source files and don't
+have the text <samp>Test</samp> in their name.</p>
<pre>
<fileset dir="${server.src}" casesensitive="yes">
@@ -140,17 +123,16 @@ name.</p>
</patternset>
</fileset>
</pre>
-<p>Groups the same files as the above example, but also establishes
-a PatternSet that can be referenced in other
-<code><fileset></code> elements, rooted at a different directory.</p>
+<p>Groups the same files as the above example, but also establishes a PatternSet that can be
+referenced in other <code><fileset></code> elements, rooted at a different directory.</p>
<pre>
<fileset dir="${client.src}" >
<patternset refid="non.test.sources"/>
</fileset>
</pre>
-<p>Groups all files in directory <code>${client.src}</code>, using the
-same patterns as the above example.</p>
+<p>Groups all files in directory <samp>${client.src}</samp>, using the same patterns as the
+above example.</p>
<pre>
<fileset dir="${server.src}" casesensitive="yes">
@@ -158,8 +140,8 @@ same patterns as the above example.</p>
<filename name="**/*Test*" negate="true"/>
</fileset>
</pre>
-<p>Groups the same files as the top example, but using the
-<code><filename></code> selector.</p>
+<p>Groups the same files as the top example, but using the <code><filename></code>
+selector.</p>
<pre>
<fileset dir="${server.src}" casesensitive="yes">
@@ -169,15 +151,13 @@ same patterns as the above example.</p>
</not>
</fileset>
</pre>
-<p>Groups the same files as the previous example using a combination of the
-<code><filename></code> selector and the <code><not></code>
-selector container.</p>
+<p>Groups the same files as the previous example using a combination of
+the <code><filename></code> selector and the <code><not></code> selector
+container.</p>
-<pre>
-<fileset dir="src" includes="main/" />
-</pre>
-<p>Selects all files in <i>src/main</i> (e.g. <i>src/main/Foo.java</i> or
-<i>src/main/application/Bar.java</i>).</p>
+<pre><fileset dir="src" includes="main/"/></pre>
+<p>Selects all files in <samp>src/main</samp> (e.g. <samp>src/main/Foo.java</samp>
+or <samp>src/main/application/Bar.java</samp>).</p>
</body>
</html>