Navigation:  Actions > Help Authoring > Help & Manual >

Help & Manual Action Options Tab

Previous pageReturn to chapter overviewNext page

This tab of the Help & Manual action configures additional Help & Manual options.


Publishing tasks to execute: Specifies one or more tasks/actions to execute, one per line (requires v6+).


Override the Help & Manual executable filename: If this field is empty, the action automatically locates the H&M command-line executable by finding the executable associated with the Help & Manual project filename extension (.hm3 for v3 and .hmx, for v4, and .hmxz or .hmxp for v5 and later).  This can be overridden by specifying the executable filename here.


Enter any additional options: This action invokes the Help & Manual application to compile the help file outputs, and this option can be used to specify additional flags to pass it.  See Command line options in the Help & Manual help index for the available options.


Log console output: If this option is checked (the default), any output written to the console by the Help & Manual executable will be captured and logged to the Output pane (and log file if file logging is enabled). If this option is unchecked, the Help & Manual flag to generate a log file will be specified, and the log file's contents will be logged. Note: Help & Manual v5.3 and later log compiler output to the console; uncheck this option for previous versions to capture the log file output.


Parse output and fail step if warnings found: If checked, after the step completes, the Help & Manual log file will be loaded and examined, and if any [Warning] lines are found, the step will be marked as failed.


Show debug info: Display a message window before outputting showing the batch commands and whether they have been recognized properly. Use for troubleshooting if your command line doesn't work as expected (requires Help & Manual v5 or later).


Don't delete temporary files: Don't delete the temporary source directories and files generated when compiling HTML Help, Winhelp, and Visual Studio Help / MS Help 2.