Testing window-level Help with applications

You can use BugHunter to identify map numbers and window-level Help topics being called from the application. This is useful if you want to verify that the correct map numbers are assigned to your topics.

Note: The window-level Help topics you test must be compiled into a Microsoft HTML Help file (.CHM) and the application needs to be programmed to use the HTML Help.

Before you start, print a copy of the Map IDs report. Use this report as a check list for testing each window-level Help topic. It provides you with a list of all topic IDs in your project. Grouped with each topic ID is its map number, the name of the map file that uses it, and the name of the window-level Help topic (.HTM file).

To test window-level Help:

  1. Compile your HTML Help project so all the window-level Help topics and their aliases are included in the .CHM file. Copy this file into the same folder where the application resides.

  2. Enable BugHunter.

  3. Start the application you need to test.

  4. Arrange your work area and resize the windows so that you can see both the application and BugHunter.

  5. Open a dialog or window that you want to test.

  6. Click the Help button or press F1.

 

Tips:

  • The Duplicate Map IDs report can help you debug problems if the same map number is used with more than one topic.

  • BugHunter adds information about each topic you test and keeps it in the pane until you clear it.

  • Copy or save the information that BugHunter captures and use it to verify that you tested each window-level topic.

  • Customize the way information is displayed in the BugHunter pane to suit your preferences.

  • If the window-level topic is not displayed or the wrong topic is displayed, right-click the map number and update the alias to quickly fix the problem. You'll need to compile the project to retest the topic.