I finally got around to writing decent docs, in the style of the rest
of the ant docs, to match the native2ascii task. The patch is below.
Changes:
Document all attributes (including implicit ones from Matching task).
Neaten up the style for consistancy with other docs.
Drew Sudell
Index: docs/native2ascii.html
===================================================================
RCS file: /home/cvspublic/jakarta-ant/docs/native2ascii.html,v
retrieving revision 1.1
diff -c -r1.1 native2ascii.html
*** docs/native2ascii.html 2000/09/20 15:53:27 1.1
--- docs/native2ascii.html 2000/10/23 04:35:33
***************
*** 1,58 ****
<html>
! <head><title>Native2Ascii</title></head>
! <body>
! <h2>Native2Ascii</h2>
!
! <h3>Description:</h3>
!
! <p>Converts files from native encodings to ascii with escaped Unicode.
! A common usage is to convert source files maintained in a native
! operating system encoding, to ascii prior to compilation.</p>
!
! <p>All matching files in the source directory are converted from a
! native encoding to ascii. If no encoding is specified, the default
! encoding for the JVM is used. If ext is specified, then output
! files are renamed to use it as a new extension. If dest and
! src point to the same directory, ext is required.</p>
!
! <p>This is a directory based task, and supports includes, includesfile,
! excludes, excludesfile, and defaultexcludes along with its specific
! attributes.</p>
! <pre>
! Attribute Description Required
! -----------------------------------------------------------
! reverse Reverse the sense of the conversion, No
! i.e. convert from ascii to native
!
! encoding The native encoding the files are in No
!
! src The directory to find files in No
!
! dest The directory to output file to Yes
!
! ext File extension to use in renaming No
! output files
! </pre>
!
! <h3>Examples</h3>
!
! <pre>
<native2ascii encoding="EUCJIS" src="srcdir"
dest="srcdir"
includes="**/*.eucjis" ext=".java" />
! </pre>
! <p>Converts all files in the directory srcdir ending in eucjis
! from the EUCJIS encoding to ascii and renames the to end in
! .java.</p>
<pre>
<native2ascii encoding='EUCJIS" src="native/japanese"
dest="src"
includes="**/*.java />
</pre>
! <p>Converts all the files ending in .java in the directory native/japanese
! to ascii, placing the results in the directory src. The names of
! the files remain the same.</p>
! </body>
! </html>
\ No newline at end of file
--- 1,131 ----
<html>
! <head><title>Native2Ascii</title></head>
! <body>
! <h2>Native2Ascii</h2>
!
! <h3>Description:</h3>
!
! <p>
! Converts files from native encodings to ASCII with escaped Unicode.
! A common usage is to convert source files maintained in a native
! operating system encoding, to ASCII prior to compilation.
! </p>
!
! <p>
! Files in the directory <em>src</em>
! are converted from a native encoding to ASCII.
! By default, all files in the directory are converted.
! However, conversion may be limited to selected files using
! <em>includes</em> and <em>excludes</em> attributes.
! For more information on file matching patterns,
! see the section on
! <a href="index.html#directorybasedtasks">directory based tasks</a>.
! If no <em>encoding</em> is specified,
! the default encoding for the JVM is used.
! If <em>ext</em> is specified, then output files are renamed
! to use it as a new extension.
! If <em>dest</em> and <em>src</em> point to the same directory,
! the <em>ext</em> attribute is required.
! </p>
!
! <p>
! This task forms an implicit <a href="index.html#fileset">File Set</a>,
! and supports all attributes of <code><fileset></code>
! (<code>dir</code> becomes <code>src</code>) as well as
! nested <code><include></code>, <code><exclude></code>,
! and <code><patternset></code> elements.
! </p>
!
! <table border="1" cellpading="2" cellspacing="0">
! <tr>
! <td><b>Attribute</b></td>
! <td><b>Description</b></td>
! <td><b>Required<b></td>
! </tr>
! <tr>
! <td>reverse</td>
! <td>Reverse the sense of the conversion,
! i.e. convert from ASCII to native</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>encoding</td>
! <td>The native encoding the files are in
! (default is the default encoding for the JVM)</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>src</td>
! <td>The directory to find files in (default is <em>basedir</em>)</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>dest</td>
! <td>The directory to output file to</td>
! <td align="center">Yes</td>
! </tr>
! <tr>
! <td>ext</td>
! <td>File extension to use in renaming output files</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>defaultexcludes</td>
! <td>indicates whether default excludes should be used or not
! ("yes"/"no").
! Default excludes are used when omitted.
! </td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>includes</td>
! <td>comma separated list of patterns of files that must be
! included. All files are included when omitted.</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>includesfile</td>
! <td>the name of a file. Each line of this file is
! taken to be an include pattern</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>excludes</td>
! <td>comma separated list of patterns of files that must be excluded.
! No files (except default excludes) are excluded when omitted.</td>
! <td align="center">No</td>
! </tr>
! <tr>
! <td>excludesfile</td>
! <td>the name of a file. Each line of this file is
! taken to be an exclude pattern</td>
! <td align="center">No</td>
! </tr>
! </table>
!
! <h3>Examples</h3>
! <pre>
<native2ascii encoding="EUCJIS" src="srcdir"
dest="srcdir"
includes="**/*.eucjis" ext=".java" />
! </pre>
! <p
! Converts all files in the directory <em>srcdir</em>
! ending in <code>.eucjis</code> from the EUCJIS encoding to ASCII
! and renames the to end in <code>.java</code>.
! </p>
<pre>
<native2ascii encoding='EUCJIS" src="native/japanese"
dest="src"
includes="**/*.java />
</pre>
! <p>
! Converts all the files ending in <code>.java</code>
! in the directory <em>native/japanese</em> to ASCII,
! placing the results in the directory <em>src</em>.
! The names of the files remain the same.
! </p>
! </body>
! </html>
--
Drew Sudell [EMAIL PROTECTED] http://www.op.net/~asudell
