Starting from version 1.3b, AurigaDoc is distributed with an ant task which can be used from an ant target. The following steps should be followed to install and run the aurigadoc task.
Installation:
Task Description:
Parameters
Attribute |
Description |
Required |
format |
The output format required. Valid values are: html, dhtml, mhtml, mht,fo, pdf, ps, awt, rtf, man, chm, jhelp. |
Yes |
input |
The path of the input file. |
Yes |
output |
The path of the output file/directory. |
Yes, unless the format is awt. |
force |
Force conversion even if the output file(s) are upto date. |
No; defaults to false. |
Parameters specified as nested elements:
param: aurigadoc task supports the nested param element(s) with the following attributes.
Attribute |
Description |
Required |
name |
The parameter name. |
Yes |
value |
The parameter value. |
Yes |
Examples:
- Converting a document to html
<aurigadoc format="html" input="src.xml" output="out.html" />
- Converting a document to pdf with a custom xsl option
<aurigadoc format="pdf" input="src.xml" output="out.pdf">
<param name="xsl" value="custom.xsl" />
</aurigadoc>
- Converting a document to jhelp with index option
<aurigadoc format="jhelp" input="src.xml" output="out-dir">
<param name="index_files" value="y" />
</aurigadoc>
Note:
The aurigadoc ant task will do the conversion only if the output files generated by a conversion are older then the source xml file or the output file(s) are deleted. The output files that are monitored include only text, xml and html and not any images/javascript files generated while building the dhtml output.