Contents - Adobe 65030089 - Robohelp - PC Using Manual

USING ROBOHELP HTML 9
Context-sensitive Help
Parameter
hParent
a_pszHelpFile
uCommand
dwData
RH_OpenHelpTopic Syntax
Call the "RH_OpenHelpTopic" function to open a WebHelp/FlashHelp topic.
function RH_OpenHelpTopic(a_pszHelpMainPage, a_pszRelTopicUrl)
Parameter
a_pszHelpMainPage
a_pszRelTopicUrl
To launch the entire Help system (open to the default topic), make a Help call that sets
,
HH_DISPLAY_INDEX HH_DISPLAY_SEARCH
default window settings for default navigation buttons override the
Call a context-sensitive function for WebHelp Pro
Call the following API for getting the context-sensitive information from the server.
1
The following example assumes that you have stored the full path to your RoboHelp server and a window name
(optional) in a string variable called StrPathAndWindow. The project name is required if the Auto-Merge option
is set to Off in the RoboEngine Configuration Manager. Examples of the value of this string are "http://RoboHelp
Server:port/robohelp/server" or "http://RoboHelp Server:port/robohelp/server?project=MyProject>MyWindow."
Note: Ask your technical writer which windows to call. Also, if the writer creates the map files, ask the writer to export
the map files to the location.
For example:
To open the topic mapped as number 1:
<p>Click for Help (map number 1)</p>
2 Run the application and test the Help call.
Note: In WebHelp Pro projects, the new context-sensitive Help API is supported only in RoboEngine 3.0 or later.
Data Type Description
var Reserved for future versions of API. Use "0."
var Help source For WebHelp: "<Path to project start page>" (Can be local or
on a server) For WebHelp Pro: "http://[server name]/roboapi.asp"
*Optional: To specify a window, use ">WindowName" at the end of this
parameter
var Constants:
HH_DISPLAY_INDEX
HH_DISPLAY_SEARCH
HH_DISPLAY_TOC
HH_HELP_CONTEXT
parameter.
var Map ID of the topic displayed. To obtain the map ID, the author can export
the map file for a programming language using
uCommand
Data Type Description
var Help source for WebHelp/FlashHelp: "Path to project start page". To
specify a window, append ">WindowName" at the end Path to the project
start page.
var Relative path of the topic corresponding to the main page.
, or
HH_DISPLAY_TOC
Last updated 12/14/2011
Displays Index pane and default topic.
Displays Search pane and default topic.
Displays Contents pane and default topic.
Opens topic associated with map ID in
parameter.
uCommand
, and to "0". In WebHelp Pro systems,
dwData
constant.
HH_DISPLAY
243
dwData
HH_HELP_CONTEXT in the
to