Open topic with navigation

Testing Context-Sensitive Help

After you create context-sensitive Help (CSH), you should test it to verify that it works. You can do this a couple of different ways, and it is not a bad idea to do both.

First, you can test your CSH identifiers from inside your project—using the Context-Sensitive Help API Tester dialog. Second, you can test the CSH using a new build of the software application. The following steps show you how to do both.

How to test context-sensitive Help from inside your project

1. Do one of the following:

   • If you want to test the CSH for the primary target, select Build>Test CSH API Calls - Primary.

     OR

   • If you want to test the CSH for a specific target, open the Project Organizer, right-click a target under the Targets folder, and select Test CSH API Calls.

   The Context-Sensitive Help API Tester dialog opens.
   

2. Next to each identifier, click .

   If the correct Help topic opens, the CSH link works.

3. Click Close.

Note: You can also see how each topic looks in a different skin by select a skin from the drop-down menu in the row and then clicking Test.

How to test context-sensitive Help using a build from the application

1. After the developer finishes "hooking" the identifiers in the application, obtain a new build from the developer.
2. Launch the application build that you obtained from the developer.
3. Open a dialog or window that should be tied to a CSH topic.

4. Click the Help button in the dialog or window, or press F1 on your keyboard.

   The Help topic associated with the dialog or window should open accordingly.
   

5. Test all of the CSH-related dialogs or windows in this same way.

See Also

Open topic with navigation