AurigaDoclet is a Javadoc doclet which can generate Java API document in fo, pdf, postscript, pcl, and svg format. AurigaDoclet accepts command line options which can be used to further customize the generated output.

AurigaDoclet generates javadoc as an XML tree which is then transformed into FO. This FO stream is then serialized using Apache FOP to generate pdf, postscript, pcl and svg output.

• Download the latest AurigaDoclet version from http://sourceforge.net/projects/aurigadoclet/
  
  
• Extract the distribution. This will create a directory called aurigadoclet. This directory has all the source and binary files.

Command Line: AurigaDoclet can be invoked from javadoc command line program by using the -doclet parameter like this.
javadoc -doclet com.aurigalogic.doclet.core.Doclet -docletpath docletpath ...

docletpath

is the absolute path of AurigaDoclet.jar file in the AurigaDoclet bin directory

Apache ANT: AurigaDoclet can used from ANT using the javadoc task like this.

<javadoc packagenames="package-names"
		sourcepath="source-path"
		doclet="com.aurigalogic.doclet.core.Doclet"
		docletpath="aurigadoclet-path"
		additionalparam="options"
	>
	<classpath refid="aurigadoclet.class.path" />
</javadoc>

package-names

package names

source-path

path of the java source files

aurigadoclet-path

path to the AurigaDoclet.jar file in AurigaDoclet's bin directory

options

AurigaDoclet options. See Supported Options

-format

The output format.
Supported values: fo,pdf,ps,pcl,svg.

-out

Output file path.

-notoc

Do not generate TOC page.

-nonavigation

Do not generate navigation tree.

-nolinks

Do not use hyperlinks.

-noindex

Do not generate a keyword index.

-leftmargin

Left margin in points. Default is 30.

-rightmargin

Right margin in points. Default is 30.

-topmargin

Top margin in points. Default is 10.

-bottommargin

Bottom margin in points. Default is 10.

-headertext

XHTML text to be used as page header.

-headerfile

XHTML file to be used as page header.

-footertext

XHTML text to be used as page footer.

-footerfile

XHTML file to be used as page footer.

-headerheight

Height of page headers in points. Default is 50.

-footerheight

Height of page footer in points. Default is 20.

-coverfile

XHTML file to be used a cover page.

-cssfile

CSS file to used for formatting the output.
Default css file is located in src/com/aurigalogic/doclet/resources/default.css

-xslfile

Custom xsl file to be used for formatting the output.
Default xsl is located in src/com/aurigalogic/doclet/resources/xml2fo.xsl

AurigaDoclet will try to cleanup the XHTML content in the header, footer, cover and also the javadoc comments to make it XML compliant. But if the content could not be cleaned up, it will use the original contant which may cause XML parser errors.

This error is usually encountered with JDK 1.4 or above. This error is caused by xalan library shipped with the JDK. In order to resolve this copy the xerces and xalan jars from AurigaDoclet's lib directory to your jre's endorsed folder. The exact path of the endorsed folder can be determined by the system property java.endorsed.dirs.

Make sure you have specified the correct path to AurigaDoclet.jar in the -docletpath argument. Also make sure that the AurigaDoclet.jar is located in AurigaDoclet's bin directory. This is so that AurigaDoclet.jar can find the additional jars which are located in AurigaDoclet's lib directory.