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.

 

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 Help & Manual v3 and .hmx for Help & Manual v4).  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.

 

Do not log compiler output: If this option is unchecked (the default), the Help & Manual flag to generate a log file will be specified, and the log file's contents will be logged to the Visual Build Output pane (and log file if file logging is enabled).  To disable generating and logging of this information, check this checkbox.  Note: Help & Manual v5.3 and later log compiler output to the console, and checking this option will cause Visual Build to capture the console 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).

 

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.