document types supporting references more extensively

https://bz.apache.org/bugzilla/show_bug.cgi?id=64603
4 years ago · 47a008ab33
--- a/manual/Types/dirset.html
+++ b/manual/Types/dirset.html
@@ -88,6 +88,14 @@ makes a DirSet equivalent to an <code>&lt;and&gt;</code> selector container.</p>
      1.7.1</em></td>
    <td>No; defaults to true (for backward compatibility reasons)</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>dirset</code>
      a <a href="../using.html#references">reference</a> to
      a <code>dirset</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h4>Examples</h4>
--- a/manual/Types/extension.html
+++ b/manual/Types/extension.html
@@ -79,6 +79,14 @@ target="_top">Package Versioning documentation.</a></p>
    <td>The url from which to retrieve extension.</td>
    <td>no</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>extension</code>
      a <a href="../using.html#references">reference</a> to
      an <code>extension</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h4>Examples</h4>
--- a/manual/Types/extensionset.html
+++ b/manual/Types/extensionset.html
@@ -31,6 +31,12 @@ 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"
 target="_top">Package Versioning documentation.</a></p>

 <p>The only supported attribute is <code>refid</code> which makes this
  <code>extensionset</code>
  a <a href="../using.html#references">reference</a> to
  an <code>extensionset</code> defined elsewhere. If specified no
  other attributes or nested elements are allowed.</p>

 <h3>Nested elements</h3>

 <h4>extension</h4>
--- a/manual/Types/filelist.html
+++ b/manual/Types/filelist.html
@@ -49,6 +49,14 @@ support this feature or as stand-alone types.</p>
    commas.</td>
    <td>Yes, unless there is a nested file element</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>filelist</code>
      a <a href="../using.html#references">reference</a> to
      a <code>filelist</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h4>Nested element: file</h4>
 <p><em>Since Apache Ant 1.6.2</em></p>
--- a/manual/Types/fileset.html
+++ b/manual/Types/fileset.html
@@ -99,6 +99,14 @@ makes a FileSet equivalent to an <code>&lt;and&gt;</code> selector container.</p
    </td>
    <td>No; defaults to <q>true</q> (for backward compatibility reasons)</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>fileset</code>
      a <a href="../using.html#references">reference</a> to
      a <code>fileset</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <p id="symlink"><strong>Note</strong>: All files/directories for which the canonical path is
--- a/manual/Types/filterchain.html
+++ b/manual/Types/filterchain.html
@@ -83,6 +83,12 @@ also.</p>
  &lt;/filterchain&gt;
 &lt;/loadfile&gt;</pre>

 <p>The only supported attribute is <code>refid</code> which makes this
  <code>filterchain</code>
  a <a href="../using.html#references">reference</a> to
  a <code>filterchain</code> defined elsewhere. If specified no other
  attributes or nested elements are allowed.</p>

 <p>The following built-in tasks support nested <code>&lt;filterchain&gt;</code> elements.<br/>
 <a href="../Tasks/concat.html">Concat</a>,<br/>
 <a href="../Tasks/copy.html">Copy</a>,<br/>
--- a/manual/Types/filterset.html
+++ b/manual/Types/filterset.html
@@ -91,6 +91,14 @@ being filtered are all text files.</p>
    <td><q>fail</q></td>
    <td>No</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>filterset</code>
      a <a href="../using.html#references">reference</a> to
      a <code>filterset</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h3>Filter</h3>
--- a/manual/Types/mapper.html
+++ b/manual/Types/mapper.html
@@ -75,6 +75,14 @@ attributes:</p>
    <td>the <code>to</code> attribute for the given implementation.</td>
    <td>Depends on implementation</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>mapper</code>
      a <a href="../using.html#references">reference</a> to
      a <code>mapper</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <p>Note that Ant will not automatically convert <q>/</q> or <q>\</q> characters in the <var>to</var>
 and <var>from</var> attributes to the correct directory separator of your current platform.  If you
--- a/manual/Types/patternset.html
+++ b/manual/Types/patternset.html
@@ -65,6 +65,14 @@ or <code>&lt;exclude&gt;</code> elements or the following attributes.</p>
      elements.</td>
    <td>See <var>excludes</var></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>patternset</code>
      a <a href="../using.html#references">reference</a> to
      a <code>patternset</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h3>Parameters specified as nested elements</h3>
 <h4><code>include</code> and <code>exclude</code></h4>
--- a/manual/Types/propertyset.html
+++ b/manual/Types/propertyset.html
@@ -47,6 +47,14 @@
    </td>
    <td>No; default is <q>false</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>propertyset</code>
      a <a href="../using.html#references">reference</a> to
      a <code>propertyset</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h3>Parameters specified as nested elements</h3>

--- a/manual/Types/regexp.html
+++ b/manual/Types/regexp.html
@@ -39,6 +39,14 @@ Regexp represents a regular expression.
    <td>regular expression pattern</td>
    <td>Yes</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>regexp</code>
      a <a href="../using.html#references">reference</a> to
      a <code>regexp</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h3>Examples</h3>
--- a/manual/Types/resources.html
+++ b/manual/Types/resources.html
@@ -92,6 +92,14 @@ collections</a>.
    <td>The size of this resource</td>
    <td>No</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>resource</code>
      a <a href="../using.html#references">reference</a> to
      a <code>resource</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h4 id="file">file</h4>
@@ -115,6 +123,14 @@ collections</a>.
      name of the resource will yield a path relative to this location.</td>
    <td>No</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>file</code>
      a <a href="../using.html#references">reference</a> to
      a <code>file</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h4 id="javaresource">javaresource</h4>
@@ -157,6 +173,14 @@ collections</a>.
      <em>Since Ant 1.8.0</em></td>
    <td>No; defaults to <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>javaresource</code>
      a <a href="../using.html#references">reference</a> to
      a <code>javaresource</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <p>The classpath can also be specified as nested classpath element,
@@ -181,6 +205,14 @@ loaded.</p>
      field name.</td>
    <td>Yes</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>javaconstant</code>
      a <a href="../using.html#references">reference</a> to
      a <code>javaconstant</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Examples</h5>
 <p>This loads the value of the constant <code>VERSION</code> of the <code>org.acme.Main</code>
@@ -234,6 +266,14 @@ file system resources as nested elements.</p>
    <td>The encoding of the zipfile</td>
    <td>No; defaults to default JVM character encoding</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>propertyresource</code>
      a <a href="../using.html#references">reference</a> to
      a <code>propertyresource</code> defined elsewhere. If specified
      no other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h4 id="tarentry">tarentry</h4>
@@ -313,6 +353,14 @@ more information.</p>
      <var>baseUrl</var></td>
    <td>If using <var>baseUrl</var></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>url</code>
      a <a href="../using.html#references">reference</a> to
      an <code>url</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h4 id="string">string</h4>
@@ -331,6 +379,14 @@ error to write to again.</p>
    <td>The value of this resource</td>
    <td>No</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>string</code>
      a <a href="../using.html#references">reference</a> to
      a <code>string</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <p>The resource also supports nested text, which can only be supplied if the <var>value</var>
@@ -442,6 +498,15 @@ duplicate resources (contrast with <a href="#union">union</a>).
      <td>Whether to cache results.  <em>since Ant 1.8.0</em></td>
      <td>No; default <q>false</q></td>
    </tr>
    <tr>
      <td>refid</td>
      <td>Makes this <code>resourcecollection</code>
        a <a href="../using.html#references">reference</a> to
        a <code>resourcecollection</code> defined elsewhere. If
        specified no other attributes or nested elements are
        allowed.</td>
      <td>No</td>
    </tr>
  </table>

 <h4 id="files">files</h4>
@@ -508,6 +573,14 @@ selection.
    <td>Whether to follow symbolic links (see note <a href="#symlink">below</a>)</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>files</code>
      a <a href="../using.html#references">reference</a> to
      a <code>files</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <p id="symlink"><a href="#followsymlinks"><strong>Note</strong></a>: All files/directories for which
@@ -529,6 +602,14 @@ platforms.</p>
      may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>restrict</code>
      a <a href="../using.html#references">reference</a> to
      a <code>restrict</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <p>A single resource collection is required.</p>
@@ -831,6 +912,14 @@ more nested <a href="#rcmp">resource comparators</a>:</p>
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>sort</code>
      a <a href="../using.html#references">reference</a> to
      a <code>sort</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <p>A single resource collection is required.</p>
@@ -933,6 +1022,14 @@ first few oldest, largest, etc. resources from a larger collection.</p>
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>first</code>
      a <a href="../using.html#references">reference</a> to
      a <code>first</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <p>A single resource collection is required.</p>
@@ -958,6 +1055,14 @@ last few oldest, largest, etc. resources from a larger collection.</p>
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>last</code>
      a <a href="../using.html#references">reference</a> to
      a <code>last</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <p>A single resource collection is required.</p>
@@ -984,6 +1089,14 @@ collection.</p>
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>allbutfirst</code>
      a <a href="../using.html#references">reference</a> to
      an <code>allbutfirst</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <p>A single resource collection is required.</p>
@@ -1010,6 +1123,14 @@ collection.</p>
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>allbutlast</code>
      a <a href="../using.html#references">reference</a> to
      an <code>allbutlast</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <p>A single resource collection is required.</p>
@@ -1036,6 +1157,14 @@ collection can implement equivalents for such Unix functions as <kbd>sort</kbd>,
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>tokens</code>
      a <a href="../using.html#references">reference</a> to
      a <code>tokens</code> defined elsewhere. If specified no other
      attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>
 <h5>Parameters specified as nested elements</h5>
 <ul>
@@ -1069,9 +1198,21 @@ collection can implement equivalents for such Unix functions as <kbd>sort</kbd>,
 <h4 id="union">union</h4>
 <p>Union of nested resource collections.</p>

 <p>The only supported attribute is <code>refid</code> which makes this
  <code>union</code>
  a <a href="../using.html#references">reference</a> to
  an <code>union</code> defined elsewhere. If specified no other
  attributes or nested elements are allowed.</p>

 <h4 id="intersect">intersect</h4>
 <p>Intersection of nested resource collections.</p>

 <p>The only supported attribute is <code>refid</code> which makes this
  <code>intersect</code>
  a <a href="../using.html#references">reference</a> to
  an <code>intersect</code> defined elsewhere. If specified no other
  attributes or nested elements are allowed.</p>

 <h4 id="difference">difference</h4>
 <p>Difference of nested resource collections.</p>

@@ -1087,6 +1228,14 @@ collection can implement equivalents for such Unix functions as <kbd>sort</kbd>,
    <td>Whether to cache results; disabling may seriously impact performance</td>
    <td>No; default <q>true</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>difference</code>
      a <a href="../using.html#references">reference</a> to
      a <code>difference</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h5>Examples</h5>
@@ -1144,6 +1293,14 @@ resources.</p>
      <em>since Ant 1.8.1</em></td>
    <td>No; defaults to <q>false</q></td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>mappedresources</code>
      a <a href="../using.html#references">reference</a> to
      a <code>mappedresources</code> defined elsewhere. If specified
      no other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h5>Parameters specified as nested elements</h5>
@@ -1194,7 +1351,11 @@ by <code>&lt;archives&gt;</code> are the contents of the nested archives.</p>
 of <a href="../Tasks/zip.html#zipgroupfileset">zipgroupfileset</a> which is only supported by
 the zip family of tasks.</p>

 <p><code>archives</code> doesn't support any attributes.</p>
 <p>The only supported attribute is <code>refid</code> which makes this
  <code>archives</code>
  a <a href="../using.html#references">reference</a> to
  an <code>archives</code> defined elsewhere. If specified no other
  attributes or nested elements are allowed.</p>

 <h5>Parameters specified as nested elements</h5>

@@ -1258,6 +1419,14 @@ of <a href="filelist.html"><code>&lt;filelist&gt;</code></a>.</p>
    </td>
    <td>No</td>
  </tr>
  <tr>
    <td>refid</td>
    <td>Makes this <code>resourcelist</code>
      a <a href="../using.html#references">reference</a> to
      a <code>resourcelist</code> defined elsewhere. If specified no
      other attributes or nested elements are allowed.</td>
    <td>No</td>
  </tr>
 </table>

 <h5>Parameters specified as nested elements</h5>