Giving the WebHelp API and Documentation to the Developer
Giving the WebHelp API and Documentation to the Developer
The WebHelp Application Programming Interface (API) includes a number of prepared functions, libraries, forms, and code appropriate for a number of platforms, including the following:
- Web pages with JavaScript
- C++
- Visual Basic
- Java applications
Most commonly, developers use the JavaScript file. By default, you can find it here:
C:Program FilesRoboHelp OfficeCSH APIRoboHelp_CSH.JS
Following the provided Builder Data Bank sample application, you must place RoboHelp_CSH.JS in the application path. Place a link to that file between the <head> tags of each application page:
<head>
<script src="RoboHelp_CSH.js"></script>
</head>
The developer calls the topic within the application’s page by creating a link, as follows:
<a href="javascript:RH_ShowHelp(0,'WebHelp/default.htm>
WithNavPane', HH_HELP_CONTEXT, 5)">Help
</a>
Documentation outlines the flexible choices available to the developer depending on which platform he or she uses to create the application.
Comments