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.

 

HelpManOpt

 

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 enable the Help & Manual flag to generate a log file of the operation, and that file's contents will be logged to the Visual Build Pro Output pane (and log file if file logging is enabled).  To disable generating and logging of this information, check this checkbox.

 

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.

 

Log the compiler command-line: Logs the command-line used to compile the help project. This can be useful for debugging purposes.