Imagine that this is a page on your web-based application. You have put useful prompts on the page, but sometimes you need to supply much information. With context-sensitive help, the users click a link to view a help topic that is related to the web page.
Your application is browser-based and it is for cross-platform use. Therefore, you need cross-platform help. Here we supply a WebHelp sample. The WebHelp was created using RoboHelp from Adobe, www.adobe.com).
Possibly, after you click a link, you must wait some seconds for the help to open.
This is a link to the WebHelp file (opens in a new window). The link is not context-sensitive.
For the context-sensitive help, only one web browser window opens, no matter which links you click.
With old versions of Internet Explorer, the Back button does not operate as expected.
Calling a help page
RoboHelp_CSH.js that must be referenced (or included) in each calling page.
RoboHelp_CSH.js defines a function
RH_ShowHelp that has the following syntax:
RH_ShowHelp(hParent, a_pszHelpFile, uCommand, dwData)
|hParent||Always use zero.|
|a_pszHelpFile||The path to the starting page of the help project. To make sure that the help opens correctly, specify the name of the window using the parameter WindowName (in our examples, the name of the window is
|dwData||The map ID of the topic to be displayed. Map IDs are defined in the help project. They can be supplied by the software developers or by the help author.|
The following code calls the WebHelp Basic topic 1:
Download the WebHelp files: context-WebHelp.zip, 444 KB.