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:45 UTC
[30/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/loadproperties.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/loadproperties.html b/manual/Tasks/loadproperties.html
index a3a2479..a0de30d 100644
--- a/manual/Tasks/loadproperties.html
+++ b/manual/Tasks/loadproperties.html
@@ -25,66 +25,58 @@
<h2 id="loadproperties">LoadProperties</h2>
<h3>Description</h3>
-<p>
-Load a file's contents as Apache Ant properties. This is equivalent
-to <code><property file|resource="..."/></code> except that it
-supports nested <code><filterchain></code> elements.
-Also if the file is missing, the build is halted with an error, rather
-than a warning being printed.
-</p>
-
-<p><strong>Note</strong>: the default value of this
-task's <code>prefixValues</code> attribute is different from the
-default value of the same attribute in
-the <a href="property.html"><code><property></code></a>
-task.</p>
+<p>Load a file's contents as Apache Ant properties. This is equivalent to <code><property
+file|resource=<q>...</q>/></code> except that it supports nested <code><filterchain></code>
+elements. Also if the file is missing, the build is halted with an error, rather than a warning
+being printed.</p>
+
+<p><strong>Note</strong>: the default value of this task's <var>prefixValues</var> attribute is
+different from the default value of the same attribute in
+the <a href="property.html"><code><property></code></a> task.</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">srcFile</td>
- <td valign="top">source file</td>
- <td valign="top" rowspan="2" align="center">One of these or a
- nested resource</td>
+ <td>srcFile</td>
+ <td>source file</td>
+ <td rowspan="2">One of these or a nested resource</td>
</tr>
<tr>
- <td valign="top">resource</td>
- <td valign="top">the resource name of the property file</td>
+ <td>resource</td>
+ <td class="left">the resource name of the property file</td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">encoding to use when loading the file</td>
- <td align="center" valign="top">No</td>
+ <td>encoding</td>
+ <td>encoding to use when loading the file</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">the classpath to use when looking up a resource.</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>the classpath to use when looking up a resource.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">the classpath to use when looking up a resource,
- given as <a href="../using.html#references">reference</a>
- to a <code><path></code> defined elsewhere..</td>
- <td align="center" valign="top">No</td>
+ <td>classpathref</td>
+ <td>the classpath to use when looking up a resource, given
+ as <a href="../using.html#references">reference</a> to a <code><path></code> defined
+ elsewhere.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td valign="top">Prefix to apply to loaded properties;
- a "." is appended to the prefix if not specified. <em>Since Ant 1.8.1</em></td>
- <td align="center" valign="top">No</td>
+ <td>prefix</td>
+ <td>Prefix to apply to loaded properties. <em>Since Ant 1.8.1</em></td>
+ <td>No; default is <q>.</q></td>
</tr>
<tr>
- <td valign="top">prefixValues</td>
- <td valign="top">Whether to apply the prefix when expanding the
- right hand side of the properties.
- <em>Since Ant 1.8.2</em></td>
- <td align="center" valign="top">No (default=<tt>true</tt>)</td>
+ <td>prefixValues</td>
+ <td>Whether to apply the prefix when expanding the right hand side of the properties. <em>Since
+ Ant 1.8.2</em></td>
+ <td>No; default is <q>true</q></td>
</tr>
</table>
@@ -99,40 +91,36 @@ resource collection</h4>
<h4>classpath</h4>
-<p>for use with the <i>resource</i> attribute.</p>
+<p>for use with the <var>resource</var> attribute.</p>
<h3>Examples</h3>
-<pre> <loadproperties srcFile="file.properties"/>
-</pre>
-or
+<pre><loadproperties srcFile="file.properties"/></pre>
+<p>or</p>
+<pre>
+<loadproperties>
+ <file file="file.properties"/>
+</loadproperties></pre>
+<p>Load contents of file.properties as Ant properties.</p>
+
<pre>
- <loadproperties>
- <file file="file.properties"/>
- </loadproperties>
-</pre>
-Load contents of file.properties as Ant properties.
-
-<pre> <loadproperties srcFile="file.properties">
- <filterchain>
+<loadproperties srcFile="file.properties">
+ <filterchain>
<<a href="../Types/filterchain.html#linecontains">linecontains</a>>
- <contains value="import."/>
+ <contains value="import."/>
</linecontains>
- </filterchain>
- </loadproperties>
-</pre>
-Read the lines that contain the string "import."
-from the file "file.properties" and load them as
-Ant properties.
+ </filterchain>
+</loadproperties></pre>
+<p>Read the lines that contain the string <q>import.</q> from the file <samp>file.properties</samp>
+and load them as Ant properties.</p>
<pre>
- <loadproperties>
- <<a href="../Types/resources.html#gzipresource">gzipresource</a>>
+<loadproperties>
+ <<a href="../Types/resources.html#gzipresource">gzipresource</a>>
<<a href="../Types/resources.html#url">url</a> url="http://example.org/url.properties.gz"/>
- </gzipresource>
- </loadproperties>
-</pre>
-Load contents of http://example.org/url.properties.gz, uncompress it
-on the fly and load the contents as Ant properties.
+ </gzipresource>
+</loadproperties></pre>
+<p>Load contents of <samp>http://example.org/url.properties.gz</samp>, uncompress it on the fly and
+load the contents as Ant properties.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/loadresource.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/loadresource.html b/manual/Tasks/loadresource.html
index 0e4ad77..2c8efa7 100644
--- a/manual/Tasks/loadresource.html
+++ b/manual/Tasks/loadresource.html
@@ -28,62 +28,54 @@
<p><em>Since Apache Ant 1.7</em></p>
<h3>Description</h3>
-<p>
-Load a text resource into a single property. Unless an encoding is
-specified, the encoding of the current locale is used. Resources to
-load are specified as nested <a
-href="../Types/resources.html">resource</a> elements or single
-element resource collections. If the resource content is empty (maybe after
-processing a filterchain) the property is not set.
-</p>
+<p>Load a text resource into a single property. Unless an encoding is specified, the encoding of the
+current locale is used. Resources to load are specified as
+nested <a href="../Types/resources.html">resource</a> elements or single element resource
+collections. If the resource content is empty (maybe after processing a <code>filterchain</code>)
+the property is not set.</p>
-<p>Since properties are immutable, the task will not change the value
- of an existing property.</p>
+<p>Since properties are immutable, the task will not change the value of an existing property.</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">property</td>
- <td valign="top">property to save to</td>
- <td valign="top" align="center">Yes</td>
+ <td>property</td>
+ <td>property to save to</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">encoding to use when loading the resource</td>
- <td align="center" valign="top">No</td>
+ <td>encoding</td>
+ <td>encoding to use when loading the resource</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">Whether to halt the build on failure</td>
- <td align="center" valign="top">No, default "true"</td>
+ <td>failonerror</td>
+ <td>Whether to halt the build on failure</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">quiet</td>
- <td valign="top">Do not display a diagnostic message (unless Ant has been
- invoked with the <code>-verbose</code> or <code>-debug</code>
- switches) or modify the exit status to reflect an error. Setting this to
- "true" implies setting failonerror to "false".
- </td>
- <td align="center" valign="top">No, default "false"</td>
+ <td>quiet</td>
+ <td>Do not display a diagnostic message (unless Ant has been invoked with
+ the <code>-verbose</code> or <code>-debug</code> switches) or modify the exit status to
+ reflect an error. Setting this to <q>true</q> implies setting <var>failonerror</var>
+ to <q>false</q>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
-<p>
-The LoadResource task supports nested <a href="../Types/filterchain.html">
-FilterChain</a>s.
+<p>The LoadResource task supports nested <a href="../Types/filterchain.html"> FilterChain</a>s.</p>
<h3>Examples</h3>
<pre>
<loadresource property="homepage">
- <url url="http://ant.apache.org/index.html"/>
-</loadresource>
-</pre>
-Load the entry point of Ant's homepage into property "homepage"; an
-<tt><echo></tt> can print this.
+ <url url="http://ant.apache.org/index.html"/>
+</loadresource></pre>
+<p>Load the entry point of Ant's homepage into property <code>homepage</code>;
+an <code><echo></code> can print this.</p>
<p>For more examples see the <a href="loadfile.html">loadfile</a> task.</p>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/local.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/local.html b/manual/Tasks/local.html
index cc1f648..c6c3165 100644
--- a/manual/Tasks/local.html
+++ b/manual/Tasks/local.html
@@ -26,30 +26,29 @@
<h2>Local</h2>
<h3>Description</h3>
-<p>Adds a local property to the current scope. Property scopes exist at Apache Ant's
-various "block" levels. These include targets as well as the
-<a href="parallel.html">Parallel</a> and <a href="sequential.html">Sequential</a>
-task containers (including <a href="macrodef.html">Macrodef</a> bodies). A local
-property at a given scope "shadows" properties of the same name at higher scopes,
-including the global scope. Note that using the Local task at the global
-level effectively makes the property local to the "anonymous target" in which
-top-level operations are carried out; it will not be defined for other targets
-in the buildfile. <em>Since Ant 1.8</em></p>
+<p>Adds a local property to the current scope. Property scopes exist at Apache Ant's various "block"
+levels. These include targets as well as the <a href="parallel.html">Parallel</a>
+and <a href="sequential.html">Sequential</a> task containers
+(including <a href="macrodef.html">Macrodef</a> bodies). A local property at a given scope "shadows"
+properties of the same name at higher scopes, including the global scope. Note that using
+the <code>Local</code> task at the global level effectively makes the property local to the
+"anonymous target" in which top-level operations are carried out; it will not be defined for other
+targets in the buildfile. <em>Since Ant 1.8</em></p>
<p>A property is made local if the <code><local></code> task
precedes its definition. See the examples section.</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">name</td>
- <td valign="top">The property to declare in the current scope</td>
- <td valign="top" align="center">Yes</td>
+ <td>name</td>
+ <td>The property to declare in the current scope</td>
+ <td>Yes</td>
</tr>
</table>
@@ -58,19 +57,18 @@ in the buildfile. <em>Since Ant 1.8</em></p>
<h4>Temporarily shadow a global property's value</h4>
<pre>
- <property name="foo" value="foo"/>
+<property name="foo" value="foo"/>
- <target name="step1">
- <echo>Before local: foo is ${foo}</echo>
- <local name="foo"/>
- <property name="foo" value="bar"/>
- <echo>After local: foo is ${foo}</echo>
- </target>
+<target name="step1">
+ <echo>Before local: foo is ${foo}</echo>
+ <local name="foo"/>
+ <property name="foo" value="bar"/>
+ <echo>After local: foo is ${foo}</echo>
+</target>
- <target name="step2" depends="step1">
- <echo>In step2: foo is ${foo}</echo>
- </target>
-</pre>
+<target name="step2" depends="step1">
+ <echo>In step2: foo is ${foo}</echo>
+</target></pre>
<p>outputs</p>
@@ -80,106 +78,97 @@ step1:
[echo] After local: foo is bar
step2:
- [echo] In step2: foo is foo
-</pre>
+ [echo] In step2: foo is foo</pre>
-<p>here the local-task shadowed the global definition
- of <code>foo</code> for the remainder of the target step1.</p>
+<p>here the <code>local</code> task shadowed the global definition of <code>foo</code> for the
+remainder of the target <q>step1</q>.</p>
<h4>Creating thread local properties</h4>
<pre>
- <property name="foo" value="foo"/>
-
- <parallel>
- <echo>global 1: foo is ${foo}</echo>
- <sequential>
- <local name="foo"/>
- <property name="foo" value="bar.1"/>
- <echo>First sequential: foo is ${foo}</echo>
- </sequential>
- <sequential>
- <sleep seconds="1"/>
- <echo>global 2: foo is ${foo}</echo>
- </sequential>
- <sequential>
- <local name="foo"/>
- <property name="foo" value="bar.2"/>
- <echo>Second sequential: foo is ${foo}</echo>
- </sequential>
- <echo>global 3: foo is ${foo}</echo>
- </parallel>
-</pre>
+<property name="foo" value="foo"/>
+
+<parallel>
+ <echo>global 1: foo is ${foo}</echo>
+ <sequential>
+ <local name="foo"/>
+ <property name="foo" value="bar.1"/>
+ <echo>First sequential: foo is ${foo}</echo>
+ </sequential>
+ <sequential>
+ <sleep seconds="1"/>
+ <echo>global 2: foo is ${foo}</echo>
+ </sequential>
+ <sequential>
+ <local name="foo"/>
+ <property name="foo" value="bar.2"/>
+ <echo>Second sequential: foo is ${foo}</echo>
+ </sequential>
+ <echo>global 3: foo is ${foo}</echo>
+</parallel></pre>
<p>outputs something similar to</p>
<pre>
- [echo] global 3: foo is foo
- [echo] global 1: foo is foo
- [echo] First sequential: foo is bar.1
- [echo] Second sequential: foo is bar.2
- [echo] global 2: foo is foo
-</pre>
+ [echo] global 3: foo is foo
+ [echo] global 1: foo is foo
+ [echo] First sequential: foo is bar.1
+ [echo] Second sequential: foo is bar.2
+ [echo] global 2: foo is foo</pre>
-<h4>Use inside macrodef</h4>
+<h4>Use inside <code>macrodef</code></h4>
-<p>This probably is where local can be applied in the most useful
- way. If you needed a "temporary property" inside a macrodef in Ant
- prior to Ant 1.8.0 you had to try to come up with a property name
- that would be unique across macro invocations.</p>
+<p>This probably is where <code>local</code> can be applied in the most useful way. If you needed a
+"temporary property" inside a <code>macrodef</code> in Ant prior to Ant 1.8.0 you had to try to come
+up with a property name that would be unique across macro invocations.</p>
-<p>Say you wanted to write a macro that created the parent directory
- of a given file. A naive approach would be:</p>
+<p>Say you wanted to write a macro that created the parent directory of a given file. A naive
+approach would be:</p>
<pre>
- <macrodef name="makeparentdir">
- <attribute name="file"/>
- <sequential>
- <dirname property="parent" file="@{file}"/>
- <mkdir dir="${parent}"/>
- </sequential>
- </macrodef>
- <makeparentdir file="some-dir/some-file"/>
-</pre>
-
-<p>but this would create a global property "parent" on the first
- invocation - and since properties are not mutable, any subsequent
- invocation will see the same value and try to create the same
- directory as the first invocation.</p>
-
-<p>The recommendation prior to Ant 1.8.0 was to use a property name
- based on one of the macro's attributes, like</p>
+<macrodef name="makeparentdir">
+ <attribute name="file"/>
+ <sequential>
+ <dirname property="parent" file="@{file}"/>
+ <mkdir dir="${parent}"/>
+ </sequential>
+</macrodef>
+<makeparentdir file="some-dir/some-file"/></pre>
+
+<p>but this would create a global property <code>parent</code> on the first invocation—and
+since properties are not mutable, any subsequent invocation will see the same value and try to
+create the same directory as the first invocation.</p>
+
+<p>The recommendation prior to Ant 1.8.0 was to use a property name based on one of the macro's
+attributes, like</p>
<pre>
- <macrodef name="makeparentdir">
- <attribute name="file"/>
- <sequential>
- <dirname property="parent.@{file}" file="@{file}"/>
- <mkdir dir="${parent.@{file}}"/>
- </sequential>
- </macrodef>
-</pre>
-
-<p>Now invocations for different files will set different properties
- and the directories will get created. Unfortunately this "pollutes"
- the global properties space. In addition it may be hard to come up
- with unique names in some cases.</p>
+<macrodef name="makeparentdir">
+ <attribute name="file"/>
+ <sequential>
+ <dirname property="parent.@{file}" file="@{file}"/>
+ <mkdir dir="${parent.@{file}}"/>
+ </sequential>
+</macrodef></pre>
+
+<p>Now invocations for different files will set different properties and the directories will get
+created. Unfortunately this "pollutes" the global properties space. In addition, it may be hard to
+come up with unique names in some cases.</p>
<p>Enter <code><local></code>:</p>
<pre>
- <macrodef name="makeparentdir">
- <attribute name="file"/>
- <sequential>
- <local name="parent"/>
- <dirname property="parent" file="@{file}"/>
- <mkdir dir="${parent}"/>
- </sequential>
- </macrodef>
-</pre>
-
-<p>Each invocation gets its own property name "parent" and there will
- be no global property of that name at all.</p>
+<macrodef name="makeparentdir">
+ <attribute name="file"/>
+ <sequential>
+ <local name="parent"/>
+ <dirname property="parent" file="@{file}"/>
+ <mkdir dir="${parent}"/>
+ </sequential>
+</macrodef></pre>
+
+<p>Each invocation gets its own property named <code>parent</code> and there will be no global
+property of that name at all.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/macrodef.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/macrodef.html b/manual/Tasks/macrodef.html
index adf6869..9bb61ef 100644
--- a/manual/Tasks/macrodef.html
+++ b/manual/Tasks/macrodef.html
@@ -26,267 +26,204 @@
<h2 id="macrodef">MacroDef</h2>
<h3>Description</h3>
- <p>
- This defines a new task using a <code><sequential></code>
- nested task as a template. Nested elements <code><attribute></code> and
- <code><element></code> are used to specify attributes and elements of
- the new task. These get substituted into the <code><sequential></code>
- task when the new task is run.
- </p>
+ <p>This defines a new task using a <code><sequential></code> nested task as a
+ template. Nested elements <code><attribute></code> and <code><element></code> are
+ used to specify attributes and elements of the new task. These get substituted into
+ the <code><sequential></code> task when the new task is run.</p>
<h3>Note</h3>
- <p>
- You can also use <i>prior defined</i> attributes for default-values in
- other attributes. See the examples.
- </p>
- <p>
- <em>since Apache Ant 1.6</em>
- </p>
+ <p>You can also use <em>prior defined</em> attributes for <var>default</var> values in other
+ attributes. See the examples.</p>
+ <p><em>since Apache Ant 1.6</em></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">name</td>
- <td valign="top">The name of the new definition.</td>
- <td valign="top" align="center">Yes</td>
+ <td>name</td>
+ <td>The name of the new definition.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">uri</td>
- <td valign="top">
+ <td>uri</td>
+ <td>
The uri that this definition should live in.
</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">description</td>
- <td valign="top">A description of the macrodef
+ <td>description</td>
+ <td>A description of the macrodef
(for documentation purposes only).
</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">backtrace</td>
- <td valign="top">
- This controls the error traceback if there is an
- error detected when running the macro. If this is
- set to true, there will be an error trackback, if false
- there will not be one. <em>Since Ant 1.7</em>.
- </td>
- <td valign="top" align="center">No; default <em>true</em></td>
+ <td>backtrace</td>
+ <td>This controls the error traceback if there is an error detected when running the
+ macro. If this is set to <q>true</q>, there will be an error trackback, if <q>false</q>
+ there will be none. <em>Since Ant 1.7</em>.</td>
+ <td>No; default <q>true</q></td>
</tr>
</table>
- <h3>Parameters specified as nested elements</h3>
+ <h3>Parameters specified as nested elements</h3>
<h4>attribute</h4>
- <p>
- This is used to specify attributes of the new task. The values
- of the attributes get substituted into the templated task.
- The attributes will be required attributes unless a default
- value has been set.
- </p>
- <p>
- This attribute is placed in the body of the templated
- task using a notation similar to the Ant property notation
- - @{attribute name}. (May be remembered as "put the substitution
- AT this location").
- </p>
- <p>
- The escape sequence @@ is used to escape @. This allows @{x} to be
- placed in the text without substitution of x by using @@{x}.
- This corresponds to the $$ escape sequence for properties.
- </p>
- <p>
- The case of the attribute is ignored, so @{myAttribute} is treated the
- same as @{MyAttribute}.
- </p>
+ <p>This is used to specify attributes of the new task. The values of the attributes get
+ substituted into the templated task. The attributes will be required attributes unless a
+ default value has been set.</p>
+ <p>This attribute is placed in the body of the templated task using a notation similar to the
+ Ant property notation—<code>@{attribute name}</code>. (May be remembered as "put the
+ substitution AT this location").</p>
+ <p>The escape sequence <code>@@</code> is used to escape <code>@</code>. This
+ allows <code>@{x}</code> to be placed in the text without substitution of <code>x</code> by
+ using <code>@@{x}</code>. This corresponds to the <code>$$</code> escape sequence for
+ properties.</p>
+ <p>The case of the attribute is ignored, so <code>@{myAttribute}</code> is treated the same
+ as <code>@{MyAttribute}</code>.</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">name</td>
- <td valign="top">The name of the new attribute</td>
- <td valign="top" align="center">Yes</td>
+ <td>name</td>
+ <td>The name of the new attribute</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">default</td>
- <td valign="top">
- The default value of the attribute.
- </td>
- <td valign="top" align="center">No</td>
+ <td>default</td>
+ <td>The default value of the attribute.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">description</td>
- <td valign="top">
- This contains a description of the attribute.
- <em>Since Ant 1.6.1</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>description</td>
+ <td>This contains a description of the attribute. <em>Since Ant 1.6.1</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">doubleexpanding</td>
- <td valign="top">
- Controls whether or not property references in the attribute are expanded twice or just once.
- See the <a href="http://ant.apache.org/faq.html#macrodef-property-expansion">FAQ</a> for details.
- <em>Since Ant 1.8.3</em>
- </td>
- <td valign="top" align="center">No; default true</td>
+ <td>doubleexpanding</td>
+ <td>Controls whether or not property references in the attribute are expanded twice or just
+ once. See
+ the <a href="https://ant.apache.org/faq.html#macrodef-property-expansion">FAQ</a> for
+ details. <em>Since Ant 1.8.3</em></td>
+ <td>No; default is <q>true</q></td>
</tr>
</table>
<h4>element</h4>
- <p>
- This is used to specify nested elements of the new task.
- The contents of the nested elements of the task instance
- are placed in the templated task at the tag name.
- </p>
- <p>
- The case of the element name is ignored.
- </p>
+ <p>This is used to specify nested elements of the new task. The contents of the nested elements
+ of the task instance are placed in the templated task at the tag name.</p>
+ <p>The case of the <code>element</code> name is ignored.</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">name</td>
- <td valign="top">The name of the element</td>
- <td valign="top" align="center">Yes</td>
+ <td>name</td>
+ <td>The name of the element.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">optional</td>
- <td valign="top">
- If true this nested element is optional. Default is
- false - i.e the nested element is required in
- the new task.
- </td>
- <td valign="top" align="center">No</td>
+ <td>optional</td>
+ <td>If <q>true</q> this nested element is optional.</td>
+ <td>No; default is <q>false</q>—the nested element is required in the new task</td>
</tr>
<tr>
- <td valign="top">implicit</td>
- <td valign="top">
- If true this nested element is implicit. This means that
- any nested elements of the macrodef instance will be placed
- in the element indicated by the name of this element.
- There can only be one element if an element is implicit.
- The default value is false. <em>Since Ant 1.6.2</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>implicit</td>
+ <td>If <q>true</q> this nested element is implicit. This means that any nested elements of
+ the <code>macrodef</code> instance will be placed in the element indicated by the name of
+ this element. There can only be one element if an element is implicit. <em>Since Ant
+ 1.6.2</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">description</td>
- <td valign="top">
- This contains a description
- informing the user what the contents of the element are expected to be.
- <em>Since Ant 1.6.1</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>description</td>
+ <td>This contains a description informing the user what the contents of the element are
+ expected to be. <em>Since Ant 1.6.1</em></td>
+ <td>No</td>
</tr>
</table>
<h4>text</h4>
- <p>
- This is used to specify the treatment of text contents of the macro invocation.
- If this element is not present, then any nested text in the macro invocation
- will be an error. If the text element is present, then the name
- becomes an attribute that gets set to the nested text of the macro invocation.
- <em>Since Ant 1.6.1</em>.
- </p>
- <p>
- The case of the text name is ignored.
- </p>
+ <p>This is used to specify the treatment of text contents of the macro invocation. If this
+ element is not present, then any nested text in the macro invocation will be an error. If
+ the <code>text</code> element is present, then the name becomes an attribute that gets set to
+ the nested text of the macro invocation. <em>Since Ant 1.6.1</em>.</p>
+ <p>The case of the <code>text</code> name is ignored.</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">name</td>
- <td valign="top">The name of the text attribute</td>
- <td valign="top" align="center">Yes</td>
+ <td>name</td>
+ <td>The name of the text attribute.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">optional</td>
- <td valign="top">
- If true nested text in the macro is optional, default is "false".
- </td>
- <td valign="top" align="center">No</td>
+ <td>optional</td>
+ <td>If <q>true</q> nested text in the macro is optional.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">trim</td>
- <td valign="top">
- If true, the nested text is trimmed of white space,
- default is "false".
- </td>
- <td valign="top" align="center">No</td>
+ <td>trim</td>
+ <td>If <q>true</q>, the nested text is trimmed of white space.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">description</td>
- <td valign="top">
- This contains a description
- informing the user what the nested text of the macro is expected
- to be.
- </td>
- <td valign="top" align="center">No</td>
+ <td>description</td>
+ <td>This contains a description informing the user what the nested text of the macro is
+ expected to be.</td>
+ <td>No</td>
</tr>
</table>
<h3>Examples</h3>
- <p>
- The following example defined a task called testing and
- runs it.
- </p>
-<pre class=code>
+ <p>The following example defined a task called testing and runs it.</p>
+ <pre class="code">
<macrodef name="testing">
- <attribute name="v" default="NOT SET"/>
- <element name="some-tasks" optional="yes"/>
- <sequential>
- <echo>v is @{v}</echo>
- <some-tasks/>
- </sequential>
+ <attribute name="v" default="NOT SET"/>
+ <element name="some-tasks" optional="yes"/>
+ <sequential>
+ <echo>v is @{v}</echo>
+ <some-tasks/>
+ </sequential>
</macrodef>
<testing v="This is v">
- <some-tasks>
- <echo>this is a test</echo>
- </some-tasks>
-</testing>
-</pre>
- <p>
- The following fragment defines a task called <code><call-cc></code> which
- take the attributes "target", "link" and "target.dir" and the
- nested element "cc-elements". The body of the task
- uses the <code><cc></code> task from the
- <a href="http://ant-contrib.sourceforge.net/">ant-contrib</a> project.
- </p>
-<pre class="code">
+ <some-tasks>
+ <echo>this is a test</echo>
+ </some-tasks>
+</testing></pre>
+ <p>The following fragment defines a task called <code><call-cc></code> which take the
+ attributes <var>target</var>, <var>link</var> and <var>target.dir</var> and the nested
+ element <code>cc-elements</code>. The body of the task uses the <code><cc></code> task
+ from the <a href="http://ant-contrib.sourceforge.net/">ant-contrib</a> project.</p>
+ <pre class="code">
<macrodef name="call-cc">
- <attribute name="target"/>
- <attribute name="link"/>
- <attribute name="target.dir"/>
- <element name="cc-elements"/>
- <sequential>
- <mkdir dir="${obj.dir}/@{target}"/>
- <mkdir dir="@{target.dir}"/>
- <cc link="@{link}" objdir="${obj.dir}/@{target}"
- outfile="@{target.dir}/@{target}">
+ <attribute name="target"/>
+ <attribute name="link"/>
+ <attribute name="target.dir"/>
+ <element name="cc-elements"/>
+ <sequential>
+ <mkdir dir="${obj.dir}/@{target}"/>
+ <mkdir dir="@{target.dir}"/>
+ <cc link="@{link}" objdir="${obj.dir}/@{target}"
+ outfile="@{target.dir}/@{target}">
<compiler refid="compiler.options"/>
<cc-elements/>
- </cc>
- </sequential>
-</macrodef>
-</pre>
- <p>
- This then can be used as follows:
- </p>
-<pre class="code">
+ </cc>
+ </sequential>
+</macrodef></pre>
+ <p>This then can be used as follows:</p>
+ <pre class="code">
<call-cc target="unittests" link="executable"
target.dir="${build.bin.dir}">
<cc-elements>
@@ -296,14 +233,10 @@
<fileset dir="${gen.dir}" includes = "*.cpp"/>
<linker refid="linker-libs"/>
</cc-elements>
-</call-cc>
-</pre>
- <p>
- The following fragment shows <call-cc>, but this time
- using an implicit element and with the link and target.dir arguments
- having default values.
- </p>
-<pre class="code">
+</call-cc></pre>
+ <p>The following fragment shows <call-cc>, but this time using an implicit element and
+ with the <var>link</var> and <var>target.dir</var> arguments having default values.</p>
+ <pre class="code">
<macrodef name="call-cc">
<attribute name="target"/>
<attribute name="link" default="executable"/>
@@ -314,17 +247,13 @@
<mkdir dir="@{target.dir}"/>
<cc link="@{link}" objdir="${obj.dir}/@{target}"
outfile="@{target.dir}/@{target}">
- <compiler refid="compiler.options"/>
- <cc-elements/>
+ <compiler refid="compiler.options"/>
+ <cc-elements/>
</cc>
</sequential>
-</macrodef>
-</pre>
- <p>
- This then can be used as follows, note that <cc-elements>
- is not specified.
- </p>
-<pre class="code">
+</macrodef></pre>
+ <p>This then can be used as follows, note that <cc-elements> is not specified.</p>
+ <pre class="code">
<call-cc target="unittests">
<includepath location="${gen.dir}"/>
<includepath location="test"/>
@@ -332,11 +261,9 @@
<fileset dir="${gen.dir}" includes = "*.cpp"/>
<linker refid="linker-libs"/>
</call-cc>
-</pre>
- <p>
- The following shows the use of the <code>text</code> element.
- </p>
-<pre class="code">
+ </pre>
+ <p>The following shows the use of the <code>text</code> element.</p>
+ <pre class="code">
<macrodef name="echotest">
<text name="text"/>
<sequential>
@@ -346,25 +273,20 @@
<echotest>
Hello world
</echotest>
-</pre>
- <p>
- The following uses a prior defined attribute for setting the
- default value of another. The output would be
- <tt>one=test two=test</tt>. If you change the order of lines
- *1 and *2 the output would be <tt>one=test two=@{one}</tt>,
- because while processing the <i>two</i>-line the value for
- <i>one</i> is not set.
- </p>
-<pre class="code">
+ </pre>
+ <p>The following uses a prior defined attribute for setting the default value of another. The
+ output would be <code>one=test two=test</code>. If you change the order of lines *1 and *2 the
+ output would be <code>one=test two=@{one}</code>, because while processing
+ the <var>two</var>-line the value for <var>one</var> is not set.</p>
+ <pre class="code">
<macrodef name="test">
- <attribute name="one"/> <b>*1</b>
- <attribute name="two" default="@{one}"/> <b>*2</b>
+ <attribute name="one"/> <strong>*1</strong>
+ <attribute name="two" default="@{one}"/> <strong>*2</strong>
<sequential>
<echo>one=@{one} two=@{two}</echo>
</sequential>
</macrodef>
-<test one="test"/>
-</pre>
+<test one="test"/></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/mail.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/mail.html b/manual/Tasks/mail.html
index c702b83..73bb13c 100644
--- a/manual/Tasks/mail.html
+++ b/manual/Tasks/mail.html
@@ -26,282 +26,247 @@
<h2 id="mail">Mail</h2>
<h3>Description</h3>
- <p>
- A task to send SMTP email.
- </p>
- <p>
- This task can send mail using either plain
- text, UU encoding, or MIME format mail, depending on what is available.
- </p>
- <p>
- SMTP auth and SSL/TLS require JavaMail and are only available in MIME format.
- </p>
- <p>
- Attachments may be sent using nested
- <code><attachments></code> elements, which are <a
- href="../using.html#path">path-like structures</a>. This means
- any filesystem based <a
- href="../Types/resources.html">resource</a> or resource
- collection can be used to point to attachments. Prior to Apache Ant 1.7
- only <code><fileset></code> has been supported as a nested
- element, you can still use this directly without an
- <code><attachments></code> container.
- </p>
- <p>
- <strong>Note</strong>: This task may depend on external libraries
- that are not included in the Ant distribution.
- See <a href="../install.html#librarydependencies">Library Dependencies</a>
- for more information.
- </p>
+<p>A task to send SMTP email.</p>
+<p>This task can send mail using either plain text, UU encoding, or MIME format mail, depending on
+what is available.</p>
+<p>SMTP auth and SSL/TLS require JavaMail and are only available in MIME format.</p>
+<p>Attachments may be sent using nested <code><attachments></code> elements, which
+are <a href="../using.html#path">path-like structures</a>. This means any filesystem
+based <a href="../Types/resources.html">resource</a> or resource collection can be used to point to
+attachments. Prior to Apache Ant 1.7 only <code><fileset></code> has been supported as a
+nested element, you can still use this directly without an <code><attachments></code>
+container.</p>
+<p><strong>Note</strong>: This task may depend on external libraries that are not included in the
+Ant distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a> for
+more information.</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">from</td>
- <td valign="top">Email address of sender.</td>
- <td align="center" valign="top">Either a <code>from</code> attribute, or a <code><from></code>
- element.</td>
+ <td>from</td>
+ <td>Email address of sender.</td>
+ <td>Either a <var>from</var> attribute, or a <code><from></code> element.</td>
</tr>
<tr>
- <td valign="top">replyto</td>
- <td valign="top">Replyto email address.</td>
- <td align="center" valign="top">No</td>
+ <td>replyto</td>
+ <td>Reply-to email address.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">tolist</td>
- <td valign="top">Comma-separated list of recipients.</td>
- <td align="center" valign="middle" rowspan="3">At least one of these, or the
- equivalent nested elements</td>
+ <td>tolist</td>
+ <td>Comma-separated list of recipients.</td>
+ <td rowspan="3">At least one of these, or the equivalent nested elements</td>
</tr>
<tr>
- <td valign="top">cclist</td>
- <td valign="top">Comma-separated list of recipients to carbon copy</td>
+ <td>cclist</td>
+ <td class="left">Comma-separated list of recipients to carbon copy</td>
</tr>
<tr>
- <td valign="top">bcclist</td>
- <td valign="top">Comma-separated list of recipients to blind carbon copy
+ <td>bcclist</td>
+ <td class="left">Comma-separated list of recipients to blind carbon copy
</td>
</tr>
<tr>
- <td valign="top">message</td>
- <td valign="top">Message to send in the body of the email.</td>
- <td align="center" valign="middle" rowspan="2">One of these or a
- <code><message></code> element.</td>
+ <td>message</td>
+ <td>Message to send in the body of the email.</td>
+ <td rowspan="2">One of these or a <code><message></code> element.</td>
</tr>
<tr>
- <td valign="top">messagefile</td>
- <td valign="top">File to send as the body of the email. Property
- values in the file will be expanded.</td>
+ <td>messagefile</td>
+ <td class="left">File to send as the body of the email. Property values in the file will be
+ expanded.</td>
</tr>
<tr>
- <td valign="top">messagefileinputencoding</td>
- <td valign="top">
- Specifies the encoding of the input file. Please see
- <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">
- Supported Encodings</a> for a list of possible
- values. Defaults to the platform's default character
- encoding. <em>Since Ant 1.9.4</em>
+ <td>messagefileinputencoding</td>
+ <td>Specifies the encoding of the input file. Please
+ see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Supported
+ Encodings</a> for a list of possible values. <em>Since Ant 1.9.4</em>
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
- <td valign="top">messagemimetype</td>
- <td valign="top">The content type of the message. The default is
- <code>text/plain</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>messagemimetype</td>
+ <td>The content type of the message.</td>
+ <td>No; default is <q>text/plain</q></td>
</tr>
<tr>
- <td valign="top">files</td>
- <td valign="top">Files to send as attachments to the email. Separate multiple
- file names using a comma or space. You can also use <code><fileset></code>
- elements to specify files.</td>
- <td align="center" valign="top">No</td>
+ <td>files</td>
+ <td>Files to send as attachments to the email. Separate multiple file names using a comma or
+ space. You can also use <code><fileset></code> elements to specify files.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">flag to indicate whether to halt the build on
- any error. The default value is <code>true</code>.</td>
- <td align="center" valign="top">No.</td>
+ <td>failonerror</td>
+ <td>flag to indicate whether to halt the build on any error.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">includefilenames</td>
- <td valign="top">Include filename(s) before file contents.
- Valid only when the <code>plain</code> encoding is used. The default
- value is <code>false</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>includefilenames</td>
+ <td>Include filename(s) before file contents.</td>
+ <td>No; default is <q>false</q>, ignored unless <q>plain</q> encoding is used</td>
</tr>
<tr>
- <td valign="top">mailhost</td>
- <td valign="top">Host name of the SMTP server. The default value is
- <code>localhost</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>mailhost</td>
+ <td>Host name of the SMTP server.</td>
+ <td>No; default is <q>localhost</q></td>
</tr>
<tr>
- <td valign="top">mailport</td>
- <td valign="top">TCP port of the SMTP server. The default value is 25.</td>
- <td align="center" valign="top">No</td>
+ <td>mailport</td>
+ <td>TCP port of the SMTP server.</td>
+ <td>No; default is <q>25</q></td>
</tr>
<tr>
- <td valign="top">user</td>
- <td valign="top">user name for SMTP auth</td>
- <td valign="center">Yes, if SMTP auth is required on your SMTP server<br>
- the email message will be then sent using Mime and requires JavaMail</td>
+ <td>user</td>
+ <td>user name for SMTP auth</td>
+ <td>Yes, if SMTP auth is required on your SMTP server;<br/>the email message will be then sent
+ using MIME and requires JavaMail</td>
</tr>
<tr>
- <td valign="top">password</td>
- <td valign="top">password for SMTP auth</td>
- <td valign="center">Yes, if SMTP auth is required on your SMTP server<br>
- the email message will be then sent using Mime and requires JavaMail</td>
+ <td>password</td>
+ <td>password for SMTP auth</td>
+ <td>Yes, if SMTP auth is required on your SMTP server;<br/>the email message will be then sent
+ using MIME and requires JavaMail</td>
</tr>
<tr>
- <td valign="top">ssl</td>
- <td valign="top">"true", "on" or "yes" accepted here<br>
- indicates whether you need TLS/SSL</td>
- <td align="center" valign="top">No</td>
+ <td>ssl</td>
+ <td><q>true</q>, <q>on</q>, or <q>yes</q> accepted here<br/>indicates whether you need
+ TLS/SSL</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">Specifies the encoding to use for the content of the email.
- Values are <code>mime</code>, <code>uu</code>, <code>plain</code>, or
- <code>auto</code>. The default value is <code>auto</code>.
- <code>uu</code> or <code>plain</code> are not compatible with SMTP auth</td>
- <td align="center" valign="top">No</td>
+ <td>encoding</td>
+ <td>Specifies the encoding to use for the content of the email. Values
+ are <q>mime</q>, <q>uu</q>, <q>plain</q>, or <q>auto</q>. <q>uu</q> or <q>plain</q> are not
+ compatible with SMTP auth</td>
+ <td>No; default is <q>auto</q></td>
</tr>
<tr>
- <td valign="top">charset</td>
- <td valign="top">Character set of the email.<br>
- You can also set the charset in the message nested element.<br>
- These options are mutually exclusive.</td>
- <td align="center" valign="top">No</td>
+ <td>charset</td>
+ <td>Character set of the email.<br/>You can also set the <var>charset</var> in
+ the <code>message</code> nested element.<br> These options are mutually exclusive.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">subject</td>
- <td valign="top">Email subject line.</td>
- <td align="center" valign="top">No</td>
+ <td>subject</td>
+ <td>Email subject line.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">ignoreInvalidRecipients</td>
- <td valign="top">Boolean. Whether the task should try to send
- the message to as many recipients as possible and should only
- fail if neither is reachable. <em>Since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">No, default is false</td>
+ <td>ignoreInvalidRecipients</td>
+ <td>(boolean) Whether the task should try to send the message to as many recipients as possible
+ and should only fail if neither is reachable. <em>Since Ant 1.8.0</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">enableStartTLS</td>
- <td valign="top">"true", "on" or "yes" accepted here<br>
- whether the STARTTLS command used to switch to an encrypted
- connection for authentication should be supported. Requires
- JavaMail. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No</td>
+ <td>enableStartTLS</td>
+ <td>(boolean) Whether the <code>STARTTLS</code> command used to switch to an encrypted
+ connection for authentication should be supported. Requires JavaMail. <em>Since Ant
+ 1.8.0</em></td>
+ <td>No</td>
</tr>
</table>
<h3>Note regarding the attributes containing email addresses</h3>
-Since Ant 1.6, the attributes from, replyto, tolist, cclist, bcclist
-can contain email addresses of the form :
+<p><em>Since Ant 1.6</em>, the
+attributes <var>from</var>, <var>replyto</var>, <var>tolist</var>, <var>cclist</var>, <var>bcclist</var>
+can contain email addresses of the form:</p>
<ul>
-<li>address@xyz.com</li>
-<li>name <address@xyz.com></li>
-<li><address@xyz.com> name</li>
-<li>(name) address@xyz.com</li>
-<li>address@xyz.com (name)</li>
+ <li><samp>address@xyz.com</samp></li>
+ <li><samp>name <address@xyz.com></samp></li>
+ <li><samp><address@xyz.com> name</samp></li>
+ <li><samp>(name) address@xyz.com</samp></li>
+ <li><samp>address@xyz.com (name)</samp></li>
</ul>
-<p>You need to enter the angle brackets as XML entities
-<code>&gt;</code> and <code>&lt;</code>.</p>
+<p>You need to enter the angle brackets as XML entities <q>&gt;</q> and <q>&lt;</q>.</p>
<h3>Parameters specified as nested elements</h3>
<h4>to / cc / bcc / from/ replyto</h4>
<p>Adds an email address element. It takes 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">name</td>
- <td valign="top">The display name for the address.</td>
- <td align="center" valign="top">No</td>
+ <td>name</td>
+ <td>The display name for the address.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">address</td>
- <td valign="top">The email address.</td>
- <td align="center" valign="top">Yes</td>
+ <td>address</td>
+ <td>The email address.</td>
+ <td>Yes</td>
</tr>
</table>
<h4>message</h4>
-<p>Specifies the message to include in the email body. It takes the following
-attributes:</p>
+<p>Specifies the message to include in the email body. It takes 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">src</td>
- <td valign="top">The file to use as the message.</td>
- <td align="center" valign="top">No</td>
+ <td>src</td>
+ <td>The file to use as the message.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">mimetype</td>
- <td valign="top">The content type to use for the message.</td>
- <td align="center" valign="top">No</td>
+ <td>mimetype</td>
+ <td>The content type to use for the message.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">charset</td>
- <td valign="top">Character set of the message<br>
- You can also set the charset as attribute of the enclosing mail task.<br>
- These options are mutually exclusive.</td>
- <td align="center" valign="top">No</td>
+ <td>charset</td>
+ <td>Character set of the message<br/>You can also set the <var>charset</var> as attribute of the
+ enclosing <code>mail</code> task.<br> These options are mutually exclusive.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">inputencoding</td>
- <td valign="top">
- Specifies the encoding of the input file. Please see
- <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">
- Supported Encodings</a> for a list of possible
- values. Defaults to the platform's default character
- encoding. <em>Since Ant 1.9.4</em>
+ <td>inputencoding</td>
+ <td>
+ Specifies the encoding of the input file. Please
+ see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Supported
+ Encodings</a> for a list of possible values. <em>Since Ant 1.9.4</em>
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
</table>
-<p>If the <code>src</code> attribute is not specified, then text can be added
-inside the <code><message></code> element. Property expansion will occur
-in the message, whether it is specified as an external file or as text within
-the <code><message></code> element.</p>
+<p>If the <var>src</var> attribute is not specified, then text can be added inside
+the <code><message></code> element. Property expansion will occur in the message, whether it
+is specified as an external file or as text within the <code><message></code> element.</p>
<h4>header</h4>
-<p><em>Since Ant 1.7</em>, arbitrary mail headers can be added by
- specifying these attributes on one or more nested header elements:</p>
+<p><em>Since Ant 1.7</em>, arbitrary mail headers can be added by specifying these attributes on one
+or more nested header elements:</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">name</td>
- <td valign="top">The name associated with this mail header.</td>
- <td align="center" valign="top">Yes</td>
+ <td>name</td>
+ <td>The name associated with this mail header.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">The value to assign to this mail header.</td>
- <td align="center" valign="top">Yes</td>
+ <td>value</td>
+ <td>The value to assign to this mail header.</td>
+ <td>Yes</td>
</tr>
</table>
@@ -313,12 +278,10 @@ the <code><message></code> element.</p>
<mail from="me"
tolist="you"
subject="Results of nightly build"
- files="build.log"/>
-</pre>
+ files="build.log"/></pre>
-<p>Sends an email from <i>me</i> to <i>you</i> with a subject of
-<i>Results of nightly build</i> and includes the contents of the file
-<i>build.log</i> in the body of the message.</p>
+<p>Sends an email from <q>me</q> to <q>you</q> with a subject of <q>Results of nightly build</q> and
+includes the contents of the file <samp>build.log</samp> in the body of the message.</p>
<pre>
<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
@@ -331,15 +294,14 @@ the <code><message></code> element.</p>
<include name="**/*.zip"/>
</fileset>
</attachments>
-</mail>
-</pre>
+</mail></pre>
-<p>Sends an eMail from <i>config@myisp.com</i> to <i>all@xyz.com</i> with a subject of
-<i>Test Build</i>. Replies to this email will go to <i>me@myisp.com</i>.
-Any zip files from the dist directory are attached. The
-task will attempt to use JavaMail and fall back to UU encoding or no encoding in
-that order depending on what support classes are available. <code>${buildname}</code>
-will be replaced with the <code>buildname</code> property's value.</p>
+<p>Sends an eMail from <q>config@myisp.com</q> to <q>all@xyz.com</q> with a subject of <q>Test
+Build</q>. Replies to this email will go to <q>me@myisp.com</q>. Any zip files from
+the <samp>dist</samp> directory are attached. The task will attempt to use JavaMail and fall back to
+UU encoding or no encoding in that order depending on what support classes are
+available. <samp>${buildname}</samp> will be replaced with the <code>buildname</code> property's
+value.</p>
<pre>
<property name="line2" value="some_international_message"/>
@@ -349,11 +311,10 @@ will be replaced with the <code>buildname</code> property's value.</p>
<from address="me@myist.com"/>
<to address="all@xyz.com"/>
<message>some international text:${line2}</message>
-</mail>
-</pre>
+</mail></pre>
-<p>Sends an eMail from <i>me@myisp.com</i> to <i>all@xyz.com</i> with a subject of
-<i>Test Build</i>, the message body being coded in UTF-8
+<p>Sends an eMail from <q>me@myisp.com</q> to <q>all@xyz.com</q> with a subject of <q>Test
+Build</q>, the message body being coded in UTF-8.
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/makeurl.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/makeurl.html b/manual/Tasks/makeurl.html
index f00b17b..f4275ba 100644
--- a/manual/Tasks/makeurl.html
+++ b/manual/Tasks/makeurl.html
@@ -26,98 +26,57 @@
<h2>Makeurl Task</h2>
<h3 id="description">Description</h3>
-This task takes one or more filenames and turns them into URLs, which it then assigns to a property.
-Useful when setting up RMI or JNLP codebases, for example.
-Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them (default: space).
-<p>Examples:</p>
-<pre>
-<makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/>
-</pre>
-Sets the property <code>m2.repository.url</code> to the file: URL of the local Maven2 repository.
-<pre>
-<makeurl property="codebase"><fileset dir="lib includes="*.jar"/></makeurl>
-</pre>
-Set the property <code>codebase</code> to the three URLs of the files provided as nested elements.
+<p>This task takes one or more filenames and turns them into URLs, which it then assigns to a
+property. Useful when setting up RMI or JNLP codebases, for example. Nested filesets are
+supported; if present, these are turned into the URLs with the supplied <var>separator</var> between
+them.</p>
<h3 id="attributes">Parameters</h3>
<table>
<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">
- file
- </td>
- <td valign="top" align="left">
- name of a file to be converted into a URL
- </td>
- <td valign="top" align="left">
- File
- </td>
- <td valign="top" align="left">
- optional, if a nested fileset or path is supplied
- </td>
+ <td>file</td>
+ <td>name of a file to be converted into a URL</td>
+ <td>File</td>
+ <td>No, if a nested fileset or path is supplied</td>
</tr>
<tr>
- <td valign="top" align="left">
- property
- </td>
- <td valign="top" align="left">
- name of a property to set to the URL
- </td>
- <td valign="top" align="left">
- String
- </td>
- <td valign="top" align="left">
- required
- </td>
+ <td>property</td>
+ <td>name of a property to set to the URL</td>
+ <td>String</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top" align="left">
- separator
- </td>
- <td valign="top" align="left">
- separator for the multi-URL option
- </td>
- <td valign="top" align="left">
- String
- </td>
- <td valign="top" align="left">
- optional
- </td>
+ <td>separator</td>
+ <td>separator for the multi-URL option</td>
+ <td>String</td>
+ <td>No; default is space</td>
</tr>
<tr>
- <td valign="top" align="left">
- validate
- </td>
- <td valign="top" align="left">
- validate that every named file exists
- </td>
- <td valign="top" align="left">
- boolean
- </td>
- <td valign="top" align="left">
- optional; default: true
- </td>
+ <td>validate</td>
+ <td>validate that every named file exists</td>
+ <td>boolean</td>
+ <td>No; default is <q>true</q></td>
</tr>
</table>
<h3 id="elements">Parameters as nested elements</h3>
<h4><strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</h4>
-A fileset of JAR files to include in the URL list, each separated by the separator.
+<p>A fileset of JAR files to include in the URL list, each separated by the separator.</p>
<h4><strong>path</strong> (org.apache.tools.ant.types.Path)</h4>
-Add a path to the URL. All elements in the path will be converted to individual URL entries.
+<p>Add a path to the URL. All elements in the path will be converted to individual URL entries.</p>
+<h3>Examples</h3>
+<pre><makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/></pre>
+<p>Sets the property <code>m2.repository.url</code> to the file: URL of the local Maven2
+repository.</p>
+<pre><makeurl property="codebase"><fileset dir="lib includes="*.jar"/></makeurl></pre>
+<p>Set the property <code>codebase</code> to the three URLs of the files provided as nested
+elements.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/manifest.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/manifest.html b/manual/Tasks/manifest.html
index f020c92..8ecd37e 100644
--- a/manual/Tasks/manifest.html
+++ b/manual/Tasks/manifest.html
@@ -28,151 +28,136 @@
<h3>Description</h3>
<p>Creates a manifest file.</p>
-<p>This task can be used to write a Manifest file, optionally
-replacing or updating an existing file.</p>
-
-<p>Manifests are processed according to the
-<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html">Jar
-file specification.</a>. Specifically, a manifest element consists of
-a set of attributes and sections. These sections in turn may contain
-attributes. Note in particular that this may result in manifest lines
-greater than 72 bytes being wrapped and continued on the next
-line.</p>
-
-<p>
- The Apache Ant team regularly gets complaints that this task in generating invalid
- manifests. By and large, this is not the case: we believe that we are following
- the specification to the letter. The usual problem is that some third party
- manifest reader is not following the same specification as well as they think
- they should; we cannot generate invalid manifest files just because one
- single application is broken. J2ME runtimes appear to be particularly troublesome.
-</p>
-
-<p>
- If you find that Ant generates manifests incompatible with your runtime, take
- a manifest it has built, fix it up however you need and switch to using the <a href="zip.html">zip</a>
- task to create the JAR, feeding in the hand-crafted manifest.
-</p>
-
-
+<p>This task can be used to write a Manifest file, optionally replacing or updating an existing
+file.</p>
+
+<p>Manifests are processed according to
+the <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/jar/jar.html">Jar file
+specification</a>. Specifically, a manifest element consists of a set of attributes and
+sections. These sections in turn may contain attributes. Note in particular that this may result in
+manifest lines greater than 72 bytes being wrapped and continued on the next line.</p>
+
+<p>The Apache Ant team regularly gets complaints that this task in generating invalid manifests. By
+and large, this is not the case: we believe that we are following the specification to the
+letter. The usual problem is that some third party manifest reader is not following the same
+specification as well as they think they should; we cannot generate invalid manifest files just
+because one single application is broken. Java ME runtimes appear to be particularly
+troublesome.</p>
+
+<p>If you find that Ant generates manifests incompatible with your runtime, take a manifest it has
+built, fix it up however you need and switch to using the <a href="zip.html">zip</a> task to create
+the JAR, feeding in the hand-crafted manifest.</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">file</td>
- <td valign="top">the manifest-file to create/update.</td>
- <td valign="top" align="center">Yes</td>
+ <td>file</td>
+ <td>the manifest-file to create/update.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">mode</td>
- <td valign="top">One of "update" or "replace", default is "replace".</td>
- <td valign="top" align="center">No</td>
+ <td>mode</td>
+ <td>One of <q>update</q> or <q>replace</q>.</td>
+ <td>No; default is <q>replace</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">The encoding used to read the existing manifest
- when updating. The task will always use UTF-8 when writing the
- manifest.</td>
- <td valign="top" align="center">No, defaults to UTF-8 encoding.</td>
+ <td>encoding</td>
+ <td>The encoding used to read the existing manifest when updating. The task will always use
+ UTF-8 when writing the manifest.</td>
+ <td>No; defaults to UTF-8 encoding</td>
</tr>
<tr>
- <td valign="top">mergeClassPathAttributes</td>
- <td valign="top">Whether to merge the Class-Path attributes found
- in different manifests (if updating). If false, only the
- attribute of the most recent manifest will be preserved.
- <em>Since Ant 1.8.0</em>.
- <br/>Unless you also set flattenAttributes to true this may
- result in manifests containing multiple Class-Path attributes
- which violates the manifest specification.</td>
- <td align="center" valign="top">No, default is false</td>
+ <td>mergeClassPathAttributes</td>
+ <td>Whether to merge the <code>Class-Path</code> attributes found in different manifests (if
+ updating). If <q>false</q>, only the attribute of the most recent manifest will be
+ preserved. <em>Since Ant 1.8.0</em>.<br/>Unless you also set <var>flattenAttributes</var>
+ to <q>true</q> this may result in manifests containing multiple <code>Class-Path</code>
+ attributes which violates the manifest specification.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">flattenAttributes</td>
- <td valign="top">Whether to merge attributes occurring more than
- once in a section (this can only happen for the Class-Path
- attribute) into a single attribute.
- <em>Since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">No, default is false</td>
+ <td>flattenAttributes</td>
+ <td>Whether to merge attributes occurring more than once in a section (this can only happen for
+ the <code>Class-Path</code> attribute) into a single attribute. <em>Since Ant
+ 1.8.0</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h3>Nested elements</h3>
<h4 id="attribute">attribute</h4>
-<p>One attribute for the manifest file. Those attributes that are
-not nested into a section will be added to the "Main" section.</p>
-<table>
+<p>One attribute for the manifest file. Those attributes that are not nested into a section will be
+added to the main section.</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">name</td>
- <td valign="top">the name of the attribute, <br>
- must match the regexp <tt>[A-Za-z0-9][A-Za-z0-9-_]*</tt>.
+ <td>name</td>
+ <td>the name of the attribute, must match the regexp <q>[A-Za-z0-9][A-Za-z0-9-_]*</q>.
</td>
- <td valign="top" align="center">Yes</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">the value of the attribute.</td>
- <td valign="top" align="center">Yes</td>
+ <td>value</td>
+ <td>the value of the attribute.</td>
+ <td>Yes</td>
</tr>
</table>
-
<h4>section</h4>
-<p>A manifest section - you can nest <a
-href="#attribute">attribute</a> elements into sections.</p>
+<p>A manifest section—you can nest <a href="#attribute">attribute</a> elements into
+sections.</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">name</td>
- <td valign="top">the name of the section.</td>
- <td valign="top" align="center">No, if omitted it will be assumed
- to be the main section.</td>
+ <td>name</td>
+ <td>the name of the section.</td>
+ <td>No, defaults to the main section</td>
</tr>
</table>
<h3>Examples</h3>
<pre>
- <manifest file="MANIFEST.MF">
- <attribute name="Built-By" value="${user.name}"/>
- <section name="common">
- <attribute name="Specification-Title" value="Example"/>
- <attribute name="Specification-Version" value="${version}"/>
- <attribute name="Specification-Vendor" value="Example Organization"/>
- <attribute name="Implementation-Title" value="common"/>
- <attribute name="Implementation-Version" value="${version} ${TODAY}"/>
- <attribute name="Implementation-Vendor" value="Example Corp."/>
- </section>
- <section name="common/class1.class">
- <attribute name="Sealed" value="false"/>
- </section>
- </manifest>
-</pre>
-
-<p>Creates or replaces the file MANIFEST.MF. Note that the Built-By
-attribute will take the value of the Ant property ${user.name}. The
-same is true for the ${version} and ${TODAY} properties. This example
-produces a MANIFEST.MF that contains
-<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">package
-version identification</a> for the package <code>common</code>.</p>
+<manifest file="MANIFEST.MF">
+ <attribute name="Built-By" value="${user.name}"/>
+ <section name="common">
+ <attribute name="Specification-Title" value="Example"/>
+ <attribute name="Specification-Version" value="${version}"/>
+ <attribute name="Specification-Vendor" value="Example Organization"/>
+ <attribute name="Implementation-Title" value="common"/>
+ <attribute name="Implementation-Version" value="${version} ${TODAY}"/>
+ <attribute name="Implementation-Vendor" value="Example Corp."/>
+ </section>
+ <section name="common/class1.class">
+ <attribute name="Sealed" value="false"/>
+ </section>
+</manifest></pre>
+
+<p>Creates or replaces the file <samp>MANIFEST.MF</samp>. Note that the <code>Built-By</code>
+attribute will take the value of the Ant property <code>${user.name}</code>. The same is true for
+the <code>${version}</code> and <code>${TODAY}</code> properties. This example produces
+a <samp>MANIFEST.MF</samp> that
+contains <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">package
+version identification</a> for the package <samp>common</samp>.</p>
<p>The manifest produced by the above would look like this:</p>
-<pre>Manifest-Version: 1.0
+<pre>
+Manifest-Version: 1.0
Built-By: bodewig
Created-By: Apache Ant 1.9
@@ -185,9 +170,7 @@ Implementation-Version: 1.2 September 10, 2013
Implementation-Title: common
Name: common/class1.class
-Sealed: false
-
-</pre>
+Sealed: false</pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/manifestclasspath.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/manifestclasspath.html b/manual/Tasks/manifestclasspath.html
index 3c09d5c..6f33a43 100644
--- a/manual/Tasks/manifestclasspath.html
+++ b/manual/Tasks/manifestclasspath.html
@@ -27,87 +27,73 @@
<h2 id="manifestclasspath">Manifestclasspath</h2>
<h3>Description</h3>
-<p>Converts a <a href="../using.html#path">Path</a> into a property
-whose value is appropriate for a <a href="manifest.html">Manifest</a>'s
-<code>Class-Path</code> attribute.</p>
+<p>Converts a <a href="../using.html#path">Path</a> into a property whose value is appropriate for
+a <a href="manifest.html">Manifest</a>'s <code>Class-Path</code> attribute.</p>
-<p>This task is often used to work around command line limitations on Windows
-when using very long class paths when launching an application. The long class
-path normally specified on the command line is replaced by a single (possibly
-empty) jar file which an in-manifest Class-Path attribute whose value lists
-all the jar and zip files the class path should contain. The files referenced
-from this attribute must be found relatively to the jar file itself, usually
-in the same directory. The Java VM automatically uses all file entries listed
-in the Class-Path attributes of a jar to locate/load classes. Note though that
-it silently ignores entries for which it cannot find any corresponding file.</p>
+<p>This task is often used to work around command line limitations on Windows when using very long
+class paths when launching an application. The long class path normally specified on the command
+line is replaced by a single (possibly empty) jar file which an in-manifest <code>Class-Path</code>
+attribute whose value lists all the jar and zip files the classpath should contain. The files
+referenced from this attribute must be found relatively to the jar file itself, usually in the same
+directory. JVM automatically uses all file entries listed in the <code>Class-Path</code> attributes
+of a jar to locate/load classes. Note though that it silently ignores entries for which it cannot
+find any corresponding file.</p>
-<p>Note that the property value created may be longer than a manifest's maximum
-72 characters per line, but will be properly wrapped as per the Jar
-specification by the <code><manifest></code> element, where the
-defined property is re-referenced.</p>
+<p>Note that the property value created may be longer than a manifest's maximum 72 characters per
+line, but will be properly wrapped as per the Jar specification by the <code><manifest></code>
+element, where the defined property is re-referenced.</p>
-<p>For this task to work properly the relative path from the file
- given in the <code>jarfile</code> attribute to the elements of the
- nested <code>classpath</code> must be the same as you expect them to
- be when deploying the jar.</p>
+<p>For this task to work properly the relative path from the file given in the <code>jarfile</code>
+attribute to the elements of the nested <code>classpath</code> must be the same as you expect them
+to be when deploying the jar.</p>
<p><em>since Apache Ant 1.7</em></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">property</td>
- <td valign="top">the name of the property to set. This property must
- not already be set.</td>
- <td valign="top" align="center">Yes</td>
+ <td>property</td>
+ <td>the name of the property to set. This property must not already be set.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">jarfile</td>
- <td valign="top">
- the filename for the Jar which will contain the manifest that will
- use the property this task will set. This file need not exist yet,
- but its parent directory must exist.
- </td>
- <td valign="top" align="center">Yes</td>
+ <td>jarfile</td>
+ <td>the filename for the Jar which will contain the manifest that will use the property this
+ task will set. This file need not exist yet, but its parent directory must exist.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">maxParentLevels</td>
- <td valign="top">
- The maximum number of parent directories one is allowed to traverse
- to navigate from the jar file to the path entry. Put differently, the
- maximum number of .. which is allowed in the relative path from the
- jar file to a given class path entry. Specify 0 to enforce a path
- entry to be in the same directory (or one of its sub-directories)
- as the jar file itself. Defaults to 2 levels.</td>
- <td valign="top" align="center">No</td>
+ <td>maxParentLevels</td>
+ <td>The maximum number of parent directories one is allowed to traverse to navigate from the jar
+ file to the path entry. Put differently, the maximum number of <q>..</q> which is allowed in
+ the relative path from the jar file to a given class path entry. Specify <q>0</q> to enforce a
+ path entry to be in the same directory (or one of its sub-directories) as the jar file
+ itself.</td>
+ <td>No; defaults to <q>2</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>classpath</h4>
-<p>A <a href="../using.html#path">Path-like</a> element, which can be
-defined in-place, or refer to a path defined elsewhere using the
-<code><classpath refid="<em>pathid</em>" /></code> syntax.
+<p>A <a href="../using.html#path">path-like</a> element, which can be defined in-place, or refer to
+a path defined elsewhere using the <code><classpath refid="pathid"/></code> syntax.
This classpath must not be empty, and is required.</p>
<h3>Examples</h3>
- <pre>
- <manifestclasspath property="jar.classpath"
- jarfile="build/acme.jar">
- <classpath refid="classpath" />
- </manifestclasspath>
- </pre>
- <p>Assuming a path of id "classpath" was already defined, convert this
- path relatively to the build/ directory that will contain acme.jar, which
- can later be created with <code><jar></code> with a nested
- <code><manifest></code> element that lists an
- <code><attribute name="Class-Path" value="${jar.classpath}"/></code>.
- </p>
+<pre>
+<manifestclasspath property="jar.classpath"
+ jarfile="build/acme.jar">
+ <classpath refid="classpath"/>
+</manifestclasspath></pre>
+<p>Assuming a path of id <q>classpath</q> was already defined, convert this path relatively to
+the <samp>build/</samp> directory that will contain <samp>acme.jar</samp>, which can later be
+created with <code><jar></code> with a nested <code><manifest></code> element that lists
+an <code><attribute name="Class-Path" value="${jar.classpath}"/></code>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/mimemail.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/mimemail.html b/manual/Tasks/mimemail.html
index 44b0e8b..9554d00 100644
--- a/manual/Tasks/mimemail.html
+++ b/manual/Tasks/mimemail.html
@@ -26,83 +26,82 @@
<h2 id="mimemail">MimeMail</h2>
-<h3><i>Deprecated</i></h3>
-<p><i>This task has been deprecated. Use the <a href="../Tasks/mail.html">mail</a> task instead.</i></p>
+<h3><em><u>Deprecated</u></em></h3>
+<p><em>This task has been <u>deprecated</u>. Use the <a href="../Tasks/mail.html">mail</a> task instead.</em></p>
<h3>Description</h3>
-<p>Sends SMTP mail with MIME attachments.
-<a href="http://www.oracle.com/technetwork/java/index-138643.html">JavaMail</a>
-and <a href="http://www.oracle.com/technetwork/java/javase/jaf-135115.html">Java
-Activation Framework</a> are required for this task.</p>
+<p>Sends SMTP mail with MIME
+attachments. <a href="https://www.oracle.com/technetwork/java/index-138643.html">JavaMail</a>
+and <a href="https://www.oracle.com/technetwork/java/javase/jaf-135115.html">Java Activation
+Framework</a> are required for this task.</p>
<p>Multiple files can be attached using <a href="../Types/fileset.html">FileSets.</a></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">message</td>
- <td valign="top">The message body</td>
- <td valign="top" align="center" rowspan="2">Exactly one of these, or a nested fileset</td>
+ <td>message</td>
+ <td>The message body</td>
+ <td rowspan="2">Exactly one of these, or a nested fileset</td>
</tr>
<tr>
- <td valign="top">messageFile</td>
- <td valign="top">A filename to read and used as the message body</td>
+ <td>messageFile</td>
+ <td class="left">A filename to read and used as the message body</td>
</tr>
<tr>
- <td valign="top">messageMimeType</td>
- <td valign="top">MIME type to use for 'message' or 'messageFile' when
- attached.</td>
- <td align="center" valign="top">No, defaults to "text/plain"</td>
+ <td>messageMimeType</td>
+ <td>MIME type to use for <var>message</var> or <var>messageFile</var> when attached.</td>
+ <td>No; defaults to <q>text/plain</q></td>
</tr>
<tr>
- <td valign="top">tolist</td>
- <td valign="top">Comma-separated list of To: recipients</td>
- <td valign="top" align="center" rowspan="3">Yes, at least one of these</td>
+ <td>tolist</td>
+ <td>Comma-separated list of <code>To:</code> recipients</td>
+ <td rowspan="3">Yes, at least one of these</td>
</tr>
<tr>
- <td valign="top">cclist</td>
- <td valign="top">Comma-separated list of CC: recipients</td>
+ <td>cclist</td>
+ <td class="left">Comma-separated list of <code>CC:</code> recipients</td>
</tr>
<tr>
- <td valign="top">bcclist</td>
- <td valign="top">Comma-separated list of BCC: recipients</td>
+ <td>bcclist</td>
+ <td class="left">Comma-separated list of <code>BCC:</code> recipients</td>
</tr>
<tr>
- <td valign="top">mailhost</td>
- <td valign="top">Host name of the mail server.</td>
- <td valign="top" align="center">No, default to "localhost"</td>
+ <td>mailhost</td>
+ <td>Host name of the mail server.</td>
+ <td>No; default to <q>localhost</q></td>
</tr>
<tr>
- <td valign="top">subject</td>
- <td valign="top">Email subject line.</td>
- <td valign="top" align="center">No</td>
+ <td>subject</td>
+ <td>Email subject line.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">from</td>
- <td valign="top">Email address of sender.</td>
- <td valign="top" align="center">Yes</td>
+ <td>from</td>
+ <td>Email address of sender.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">Stop the build process if an error occurs sending the
- e-mail.</td>
- <td valign="top" align="center">No, default to "true"</td>
+ <td>failonerror</td>
+ <td>Stop the build process if an error occurs sending the e-mail.</td>
+ <td>No; default to <q>true</q></td>
</tr>
</table>
<h3>Examples</h3>
-<p><b>Send a single HTML file as the body of a message</b></p>
-<pre> <mimemail messageMimeType="text/html" messageFile="overview-summary.html"
- tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/></pre>
-<p><b>Sends all files in a directory as attachments</b></p>
-<pre> <mimemail message="See attached files" tolist="you" subject="Attachments" from="me">
- <fileset dir=".">
- <include name="dist/*.*"/>
- </fileset>
- </mimemail>
-</pre>
+<p><strong>Send a single HTML file as the body of a message</strong></p>
+<pre>
+<mimemail messageMimeType="text/html" messageFile="overview-summary.html"
+ tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/></pre>
+<p><strong>Sends all files in a directory as attachments</strong></p>
+<pre>
+<mimemail message="See attached files" tolist="you" subject="Attachments" from="me">
+ <fileset dir=".">
+ <include name="dist/*.*"/>
+ </fileset>
+</mimemail></pre>
</body>
</html>