org.w3c.tidy.ant
Class JTidyTask
Task
org.w3c.tidy.ant.JTidyTask
public class JTidyTask
extends Task
JTidy ant task.
Parameters
Attribute | Description | Required |
---|
srcfile | source file | Yes, unless a nested <fileset> element is used. |
destfile | destination file for output | With the srcfile attribute, either destfile or destdir
can be used. With nested <fileset> elements only destdir is allowed. |
destdir | destination directory for output |
properties | Path to a valid tidy properties file | No |
flatten | Ignore the directory structure of the source files, and copy all files into the directory specified by the
destdir attribute. | No; defaults to false. |
failonerror | boolean to control whether failure to execute should throw a BuildException or just print an error. If set to
true errors in input files which tidy is enable to fix will cause a failure. | No; defaults to false. |
Nested elements
- Fileset : if you need to run tidy on more than one file, you can specify nested filesets.
- Parameter : you can specify any tidy configuration option directly using a nested
parameter
element.
Setup
Adds the following
typedef
to setup the JTidy task in your build.xml:
<taskdef name="tidy" classname="org.w3c.tidy.ant.JTidyTask"/>
This will work if JTidy jar is copied to ant lib directory. If you need to reference the jar elsewhere on the
filesystem you can add a nested classpath element:
<taskdef name="tidy" classname="org.w3c.tidy.ant.JTidyTask">
<classpath>
<pathelement location="${lib.dir}/jtidy.jar"/>
</classpath>
</taskdef>
Examples
<tidy destdir="out" properties="/path/to/tidy.properties">
<fileset dir="inputdir" />
<parameter name="drop-font-tags" value="true" />
</tidy>
$Revision: 807 $ ($Author: fgiust $)
addConfiguredParameter
public void addConfiguredParameter(Parameter prop)
Setter method for any property using the ant type Parameter.
prop
- Ant type Parameter
addFileset
public void addFileset(FileSet fileSet)
Adds a fileset to be processed Fileset
execute
public void execute()
throws BuildException
Run the task.
executeSet
protected void executeSet()
Run tidy on filesets.
executeSingle
protected void executeSingle()
A single file has been specified.
init
public void init()
Initializes the task.
processFile
protected void processFile(File inputFile,
File outputFile)
Run tidy on a file.
inputFile
- input fileoutputFile
- output file
setDestdir
public void setDestdir(File destdir)
destdir
- The destdir to set.
setDestfile
public void setDestfile(File destfile)
destfile
- The destfile to set.
setFailonerror
public void setFailonerror(boolean failonerror)
failonerror
- The failonerror to set.
setFlatten
public void setFlatten(boolean flatten)
flatten
- The flatten to set.
setProperties
public void setProperties(File properties)
properties
- The properties to set.
setSrcfile
public void setSrcfile(File srcfile)
srcfile
- The srcfile to set.
validateParameters
protected void validateParameters()
throws BuildException
Validates task parameters.