To provide custom help for the steps in a wizard, you create HTML files, which you
then store in a folder inside the extension. In each <step>
block in the extension's XML definition file, you use the attribute
helpFile 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 directory wizardhelp within the extension.
<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 can
automatically find and display the appropriate help file for each step.
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.
If you choose to create HTML files for properties, you must give them the same name
as the step and the property, separated by an underscore. For example, assume that
MeshingStep is the step name and
MeshResolution is the property name. The help file for the
step must be named MeshingStep, and the help file for the
property must be named MeshingStep_MeshResolution. When you use
these file-naming conventions, you do not need to use the attribute
helpFile to explicitly reference the HTML file for a step. The
extension can automatically find and display the custom help for steps and their properties.
Note: For HTML files for properties, the recommended practice is to avoid images and to limit the text to no more than 200 characters.
If you choose to define help text for properties directly in the extension’s
XML file, you use child <help> blocks in the property
definitions. For example, assume that a step has a property named
geometryfile. You might define custom help for it as
follows:
<property name="geometryfile" caption="Geometry file" control="fileopen" default="">
<help>Select a geometry source file to import into AIM. Note the geometry should contain
the flow volume in addition to the structure.</help>
<callbacks>
<isvisible>isVisibleGeometryFile</isvisible>
<isvalid>isValidGeometryFile</isvalid>
</callbacks>
</property>
For non-AIM wizard examples, see:
For AIM wizard examples, see:
When a non-AIM wizard is executed, the custom help for a step displays by default in a help panel at the bottom of the wizard interface.

You can change the location of this panel by customizing the layout of the wizard. For more information, see Customizing the Layout of a Wizard.
When an AIM wizard is executed, the following occurs:
Custom help for steps is shown in AIM's context-sensitive help panel. To access the help for a step, you click the question mark icon at the top of the step.
Note: After moving to a new step, you must click this icon to refresh the help panel with the new content.
Custom help for properties (field-level help) is shown when you click the question mark icon that appears when you place the mouse cursor over a property.
