Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

HTMLHelpWorkShopHelper

Contains a task which allows to use HTML Help Workshop in order to compile a help project.

Functions and values

Function or valueDescription
CompileHTMLHelpProject(...)
Signature: helpCompiler:string -> projectFile:string -> string list
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Uses the HTML Help Workshop to compile a help project and returns the generated file names of the generated files.

Parameters

  • helpCompiler - The filename of the HTML Help WorkShop tool.
  • projectFile - The fileName of the help project.