Custom Wizard Help Files

To provide custom help for a wizard, you create HTML files that you then store in a child folder in the extension's folder. In the XML file, the element <step> has the attribute helpFile. You use this attribute to reference the relative path for the HTML file to display in the step's help panel.

Custom help files can contain any valid HTML5 syntax and supported media, such as images and graphs. You simply place the supported media files in the same folder as the HTML files.

In the following example, the help file step1.html is located in the folder wizardhelp within the extension folder.

<step name="Geometry" caption="Geometry" version="1" helpFile="wizardhelp/step1.html">

If you give the help files for steps the same names as the steps themselves and then store these files in a folder named help, you do not need to use the attribute helpFile to reference them. The extension automatically finds and displays the appropriate help file for each step.

The custom help for a Workbench-based wizard displays by default in a help panel at the bottom of the wizard. However, you can customize the wizard interface. For example, you could change the location of this panel.

To provide custom help for the properties that are defined within a step, you can either create HTML files or define help text directly in the extension's XML file: