AurigaDoc converter utility can be used from the command line by executing the
script
aurigadoc.sh(for unix) or
aurigadoc.bat(for windows) with the appropriate arguments.
Usage: aurigadoc.sh(or aurigadoc.bat) COMMAND OPTIONS PARAMETERS
COMMAND:
- -h: Display this help and exit successfully.
- -v: Display version information and exit successfully.
- -pdf: Convert input file to pdf.
- -ps: Convert input file to ps(postscript).
- -fo: Convert input file to fo.
- -awt: View pdf output of input file in awt viewer.
- -html: Convert input file to output html file.
- -mht: Convert input file to single html file and compile it into a MIME multipart/related message format.
- -mhtml: Convert input file to multiple html files in specified output directory.
- -dhtml: Convert input file to multiple html files with a toc tree in specified output directory.
- -chm: Convert input file to multiple html files with the html help content file(.hhc) and html help project file (.hhp).
If HTML Help Compiler is installed on the system and the compiler path is specified in aurigadoc.properties a compiled chm file is also generated.
- -jhelp: Convert input file to multiple html files with supporting files to make a java help.
If indexing option is set to y an index is created.
If view options is set to yes then the output is launched in a java help viewer.
- -ohj: Convert input file to multiple html files with supporting files needed by Oracle Help For Java (OHJ).
If indexing option is set to y an index is created.
If view options is set to yes then the output is launched in a java help viewer.
This options requires OHJ jars to be installed in AurigaDoc lib directory. OHJ can be downloaded from http://otn.oracle.com/software/tech/java/help/index.html.
- -jhview: View the helpset specified by helpset name and the helpset dir in a java help viewer.
- -man: Convert input file to unix man source file.
OPTIONS:
- -XML <file-name>: The input xml file.
- -OUT <path>: The path of output file or directory.
- -HSNAME helpset-name: The helpset name without the extension. Required for -jhview option.
- -HSDIR <path>: The dir path where the helpset is located. Required for -jhview option.
PARAMETERS:
-PARAM name=value: Additional parameter to be passed to the converter.
The foll parameters are supported
- xsl=<xsl-path>: the xsl for generating html, pdf, fo, rtf, awt, etc.
- frameset_xsl=<xsl-path>: the xsl for generating the frameset page in dhtml output.
- tree_xsl=<xsl-path>: the xsl for generating the toc tree in dhtml output.
- hhc_xsl=<xsl-path>: the xsl for generating the html help content file when converting to chm.
- hhp_xsl=<xsl-path>: the xsl for generating the html help project file when converting to chm.
- helpset_xsl=<xsl-path>: the xsl for generating the help set file while converting to Java Help.
- toc_xsl=<xsl-path>: the xsl for generating the toc file while converting to Java Help.
- map_xsl=<xsl-path>: the xsl for generating the map file while converting to Java Help.
- index_files=[y|n]: whether to create an index of the html files while converting to Java Help.
- launch_viewer=[y|n]: whether to launch the output in a java help viewer while converting to Java Help.
- send_mail=[y|n]: param indicating whether to also send the composed MHT as mail. If this is set to y, the following parameters may also be specified.
- subject: the subject for the mail.
- to: the email address of the recipient. multiple emails should be separated by comma.
- from: the email address of the sender.
- cc: the email address for the Cc list. multiple emails should be separated by comma.
- bcc: the email address for the Bcc list. multiple emails should be separated by comma.
EXAMPLES:
- html conversion:
aurigadoc.sh -html -XML foo.xml -OUT foo.html
- html conversion using a custom xsl:
aurigadoc.sh -html -XML foo.xml -OUT foo.html -PARAM xsl=path-to-xsl
- java help conversion with indexing and view option:
aurigadoc.sh -jhelp -XML foo.xml -OUT foo-jhelp-files -PARAM index_files=y -PARAM launch_viewer=y
- chm conversion with a custom xsl for generating the html help content file.
aurigadoc.sh -chm -XML foo.xml -OUT foo-chm-files -PARAM hhc_xsl=path-to-xsl