Navigation:  Actions > Help Authoring >

Flare Action

Previous pageReturn to chapter overviewNext page

This action creates a step to compile a MadCap Flare project file.  From the inputs, the Flare command-line is constructed and called when the action is built, and any log output is captured to the log view and file.

 

This action has been tested with versions 1, 2, and 3 of Flare and may also work with other versions.

 

Flare

 

Filename: Specifies the Flare project file to compile (required).

 

Targets: Indicates a specific target to generate (optional, all targets are built if blank).

 

Additional command-line options: This option can be used to specify additional flags to pass to the Flare compiler.  See 'Command line' in the Flare help index for the available options.

 

Override compiler executable filename: If this field is empty, the action automatically locates the Flare command-line executable by finding the executable associated with the Flare project filename extension (.flprj).  This can be overridden by specifying the executable filename here.

 

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