Adding user assistance to a page

The CSV_Include project includes a Help button on the Navigation toolbar. As you create your pages, you can configure this button to provide information to the user about the content of a page, and its supported functionality.

The information provided to your operators needs to be be created as individual HTML pages and compiled into a HTML help file (.chm). The compiler necessary to create a .chm file is available for download from the Microsoft Developer Network (MSDN). Go to http://msdn.microsoft.com and search for "HTML Help Workshop". An SDK is available that includes the necessary downloads and information about creating an HTML help project.

Once you have created a .CHM file, it is recommended you place it in the project directory.

1. Select the project you've created in Project Explorer.
2. Go to Project Editor and select Parameters from the System menu. The Parameters dialog will appear.
3. In the Section Name field, type in "HelpButton".
4. In the Name field, identify the page you would like to add help to using the following format:

5. SetTopic:<PageName>
   

   where <PageName> is the name of the page included in your CitectSCADA project. Do not include a space after the colon.

5. In the Value field, identify the associated HTML Help file and topic using the following format:

6. <HelpFileName>|<HTMLPageName>
   

   where:

   • <HelpFileName> is the name of the compiled HTML Help file you've created (for example MyHelpFile.chm)
   • <HTMLPageName> is the name of the compiled HTML page you'd like displayed as a help topic (for example Help_Topic.html).
6. If necessary, add a Comment.
7. Click Add.

The help button will now launch the identified HTML file with the selected topic showing.

1. Select the project you've created in Project Explorer.
2. Go to Project Editor and select Parameters from the System menu. The Parameters dialog will appear.
3. In the Section Name field, type in "HelpButton".
4. In the Name field, identify the page you would like to disable the help button for using the following format:

5. SetTopic:<PageName>
   

   where <PageName> is the name of the page included in your CitectSCADA project. Do not include a space after the colon.

5. In the Value field, type in DISABLED.
6. If necessary, add a Comment.
7. Click Add.

The help button on the identified page will now be unavailable during runtime.

See Also