Javadoc2Help: User Guide
Creator: Auriga Logic Pvt. Ltd.
Version: $Revision: 1.5 $
Last Modified: Friday, March 12 2004
|Javadoc2Help: User Guide|
Javadoc2Help is a java based tool for converting the javadoc generated html ouput into Java Help, HTMl Help(CHM) and Oracle Help For Java(OHJ) format.
Javadoc2Help will generate the necessary support map, toc, helpset, etc for Java Help, HTML Help and Oracle Help for Java. If Microsoft HTML Help workshop is installed and the CHM compiler path is provided in bin/javadoc2help.properties, a CHM file is also created automatically in the specified destination directory.
The Oracle Help for Java (OHJ) jars are not shipped with Javadoc2Help anymore. This is due to licensing restrictions. Read tips for using Oracle Help for Java with Javadoc2Help
Javadoc2Help can be invoked from the command line using the following command
java -jar path-to-javadoc2help/lib/Javadoc2Help.jar COMMAND [OPTIONS] [PARAMETERS]..
COMMANDS -h : Display this help and exit successfully. -v : Display version information and exit successfully. -chm : Generate the html help content file(.hhc) and html help project file (.hhp). If HTML Help Compiler is installd on the system and the compiler path is specified in javadoc2help.properties a compiled chm file is also generated. -jhelp : Convert javadoc to java help. If -param index_files=y is passed an index is created. If -param launch_viewer=y is passed then the output is launched in a java help viewer. -ohj : Convert javadoc to oracle help for java (OHJ). If -param index_files=y is passed an index is created. If -param launch_viewer=y is passed then the output is launched in a java help viewer. OPTIONS: -src <file-name> : The src(javadoc) dir path. -dest <path> : The output directory path. PARAMETERS: -param name=value : Additional parameter to be passed to the converter.
java -jar lib/Javadoc2Help.jar -jhelp -src input-dir -dest output-dir -param "index_files=y" -param "launch_viewer=y"
java -jar lib/Javadoc2Help.jar -ohj -src input-dir -dest output-dir -param "index_files=y" -param "launch_viewer=y"
java -jar lib/Javadoc2Help.jar -chm -src input-dir -dest output-dir
Compiling CHM on Unix:
The HTML Help Compiler can be installed and configured even on unix/linux so that the CHM file is created automatically. Follow these steps to install and configure the HTML Help Compiler.
path-to-wine-program 'C:\Program Files\HTML Help Workshop\hhc.exe' $@
OHJ - Creating Index Files and Viewing Helpset:
Javadoc2Help is not shipped with the Oracle Help for Java(OHJ) jars any more due to licensing restrictions. Inorder to use the OHJ indexing and viewing functionality install the OHJ jars as follows: