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 through 19 (2023) of Flare and may also work with other versions.

 

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

 

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

 

Build target: Indicates a batch target to generate (requires v6 or later).  Mutually exclusive with Target field.

 

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.

 

Note: If Visual Build doesn't detect that this product is installed when first run, this action will not be displayed (existing steps will still be displayed in the Step panes and will build normally).  To show all hidden actions, right-click in the Actions pane and choose Show Hidden.