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 **** ! Native2Ascii ! !

Native2Ascii

! !

Description:

! !

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.

! !

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.

! !

This is a directory based task, and supports includes, includesfile, ! excludes, excludesfile, and defaultexcludes along with its specific ! attributes.

!
! 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 
! 
! !

Examples

! !
  <native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir"
     includes="**/*.eucjis" ext=".java" />
! 
!

Converts all files in the directory srcdir ending in eucjis ! from the EUCJIS encoding to ascii and renames the to end in ! .java.

  <native2ascii encoding='EUCJIS" src="native/japanese" dest="src"
     includes="**/*.java />
  
!

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.

! ! \ No newline at end of file --- 1,131 ---- ! Native2Ascii ! !

Native2Ascii

! !

Description:

! !

! 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. !

! !

! Files in the directory src ! 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 ! includes and excludes attributes. ! For more information on file matching patterns, ! see the section on ! directory based tasks. ! 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, ! the ext attribute is required. !

! !

! This task forms an implicit File Set, ! and supports all attributes of <fileset> ! (dir becomes src) as well as ! nested <include>, <exclude>, ! and <patternset> elements. !

! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
AttributeDescriptionRequired
reverseReverse the sense of the conversion, ! i.e. convert from ASCII to nativeNo
encodingThe native encoding the files are in ! (default is the default encoding for the JVM)No
srcThe directory to find files in (default is basedir)No
destThe directory to output file toYes
extFile extension to use in renaming output filesNo
defaultexcludesindicates whether default excludes should be used or not ! ("yes"/"no"). ! Default excludes are used when omitted. ! No
includescomma separated list of patterns of files that must be ! included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is ! taken to be an include patternNo
excludescomma separated list of patterns of files that must be excluded. ! No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is ! taken to be an exclude patternNo
! !

Examples

!
  <native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir"
     includes="**/*.eucjis" ext=".java" />
!     
!

srcdir ! ending in .eucjis from the EUCJIS encoding to ASCII ! and renames the to end in .java. !

  <native2ascii encoding='EUCJIS" src="native/japanese" dest="src"
     includes="**/*.java />
  
!

! 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. !

! ! -- Drew Sudell asudell@acm.org http://www.op.net/~asudell