Output to multiple formats

You can generate output to more than one format with a single command line. The output files are then generated one after another, in the order entered. This is OK if you want to do a single multiple compile quickly but if you want to automate the process it is best to use INI and batch files so that you don't have to type complex command lines every time.

Basic syntax:

helpman.exe <path>\projectfile.hmxz /<format1> /<switches> /<format2> /<switches> ...

Each format switch must be directly followed by all the switches you want to apply to that format. Each format must have its own set of switches, they are not applied to multiple formats.

Local and Global Switches for Multiple Output

Local switches

The following switches are "local". They must be applied to each output format individually by inserting them after the format switch for which they should apply and before the next format switch.

/I=<include options>

The include options you want to use for the output format.

/Template=<template>

The PDF template to be used for PDF output (only for PDF output).

/V=<filename>

This switch specifies an external file to redefine the values of variables in your project file. Can be used multiple times per output format, the last file called has priority.

/O=<filename>

This switch specifies an external .hmskin HTML skin file to apply to your output. Can be used multiple times per output format, the last skin file called has priority.

/S=complete

Only output topics with the status "complete".

Global switches

These switches can only be used once per command line and they apply from the point in the command line at which they are inserted.

/keeptemp

Doesn't delete the temporary directories and source files generated for Winhelp and HTML Help output. (Applies to Winhelp and HTML Help only.)

/E=<compiler log file>

Outputs the compiler log to the specified file.

/debug

Displays debug information for each output format before compiling.

/noclose

Leaves Help & Manual open after compiling. Only use at the end of the command line.

If you have multiple output formats in a single command line you must insert these switches directly after the first output format to apply them to all output formats. To apply them only to some output formats insert the switches after the first output format for which you wish them to apply.

Examples:

1) helpman.exe project.hmxz /CHM /keeptemp /HLP

2) helpman.exe project.hmxp /CHM /HLP /keeptemp

Example 1) above keeps the temporary files for both the CHM and HLP output. Example 2) only keeps the temporary files for the HLP output. The same applies for log files and debug information.

The /noclose switch should only be used at the end of the command line, otherwise you will open multiple instances of Help & Manual.

See Syntax reference for more information on the individual switches and parameters.

Example 1:

The following example compiles a project file to HTML Help and PDF, using conditional output include options for the HTML Help file and selecting a specific PDF print manual template for the PDF output file. The template is assumed to be in the project directory; if it is stored somewhere else you must include its path.

helpman.exe D:\Projects\widget.hmxz /CHM=widgethelp.chm /I=CHM,DEMO /PDF=manual.pdf /Template=manual.mnl

Example 2:

The following example compiles to Webhelp and Winhelp using include options. The /noclose switch at the end of the command line leaves the program open when compiling is finished.

helpman.exe D:\Projects\widget.hmxp /HLP /I=HLP,FINAL /HTML=D:\HTML\index.html /I=HLP,FINAL /noclose