242
USING ROBOHELP HTML 9
Context-sensitive Help
Last updated 12/14/2011
Program Help for web pages
This information is for developers connecting context-sensitive Help topics to web pages.
1
Talk to the Help author to determine the following:
•
Who provides the map numbers.
•
If the project has context-sensitive Help.
•
Where the Help system resides (locally or on a server).
2
Open your web pages.
3
Link the pages to RoboHelp_csh.js.
4
Call the function contained in RoboHelp_csh.js wherever you call Help from the website.
Program Help for web pages (WebHelp/Pro)
Use the context-sensitive Help support files. These files allow developers to call built-in functionality.
The example below shows one way to declare a JavaScript function that displays a secondary dialog. The
ShowHelp
function shows the specified topic in a custom window with the attributes defined by the
strHelpOptions
variable.
var strHelpOptions = "location=no";
strHelpO= ",toolbar=no";
strHelpO= ",menubar=yes";
strHelpO= ",status=yes";
strHelpO= ",scrollbars=yes";
strHelpO= ",resizable=yes";
strHelpO= ",top=0";
strHelpO= ",left=0";
strHelpO= ",width=400";
strHelpO= ",height=400";
function ShowHelp(strUrl)
{
window.open(strUrl, "Help", strHelpOptions);
}
To use
ShowHelp
, place the above script between the </HEAD> and <BODY> tags in the HTML file. Include an
anchor tag like the following where users can get help:
Help!
This tag makes a hyperlink with the text Help! When an end user clicks the hyperlink, widget.htm opens in a secondary
browser.
Function calls from web pages
Note:
This information is for developers connecting context-sensitive WebHelp, WebHelp Pro, FlashHelp, or FlashHelp
Pro topics to web pages.
In the following examples, the API shares the same parameters regardless of output type. The only change made is the
location of the Help file.
RH_ShowHelp syntax
function RH_ShowHelp(hParent, a_pszHelpFile, uCommand, dwData)