Batch processing

HelpSetMaker allows to perform export actions via a command line interface. This is especially useful for scripts or similar environments where automatic creation of HelpSetMaker documents is performed.

In batch mode, HelpSetMaker does not open any window. The program stops immediately after finishing the exporting task.

Target creation.

You can run an export via the command line. You give root directory and output mode as comma-seperated parameters to the “--make” or “-m” option:

java -jar helpsetmaker.jar --make /home/dh/helpsetmaker/doc/online,HTML4

Known modes are:

• HELPSET - Java HelpSet

• HTML4 - Hierarchy of HTML files to be presented in a browser

• HTML4BIGPAGE - One single HTML page containing all pages

• LATEX - LaTeX source file with pictures directory

• ECLIPSE - Eclipse HelpSet

Default setting is HELPSET, detection is case insensitive. If an unknown mode is given, nothing is produced.

LaTeX processing

It is also possible to perform the LaTeX processing through the command line so that a PDF file is created. The option is “--runlatex”, “-l” or “-r”, followed by the project's root directory:

java -jar helpsetmaker.jar --runlatex /home/dh/helpsetmaker/doc/online

For this to work, HelpSetMaker must have been configured for the user who is executing the program. Namely, the pdfLaTeX binary name must have been set. Otherwise, the call will not succeed.

LaTeX processing works similar as in the graphical user interface, including pass control and multiple LaTeX passes if needed. Any output, however, is printed directly to the standard output.