Skip to main content
Participant
January 3, 2013
Question

How Do RoboHelp 9 WebHelp Generated Files Handle Map IDs and Aliases?

  • January 3, 2013
  • 1 reply
  • 2104 views

The text below was written by our team's developer/architect. I am the help author who uses RoboHelp to write content and generate the help files, but I am clueless how it all gets generated and is deployed. Please help. We use RoboHelp 9. I use it in Windows XP and our app and help run on IE 7, 9, and Firefox (multiple versions).

"Our application uses the numeric identifiers associated with the Map ID. For example, to get to the <appname>_home_page.htm file, we use the number 1053. <appname> = pecs, in this example.

All of this is used in a call to a RoboHelp method defined in the RoboHelp_CSH.js file. The mehtod we are calling is the RH_ShowHelp() JavaScript method and the code to perform the call, when you click on Page Help, is this:

RH_ShowHelp(0, ''/pecsHelp/index.htm>pecsHelp',HH_HELP_CONTEXT,topic);

Topic is translated to the Map ID number for the page help. HH_HELP_CONTEXT is defined in the RoboHelp_CSH.js file. This method translates into a URL and from what I have seen, the URL that gets generated is this:

http://{server}[:port]/pecsHelp/index.htm/{server}[:port]/pecsHelp/index.htm#<id=1053>>pecsHelp

Server and port get replaced with the appropriate values. I have no clue how id=1053 is supposed to get translated to mean "pecs_home_page.htm". If you check the PECS_help.h file, you will see the following entry:

#define PECS_Home_Page1 1053

Then in the RoboHelp alias file (PECS 3.0.ali), the following line is in the file:

<alias name="PECS_Home_Page1" link="pecs_home_page.htm"> </alias>

But both of these files are used during the WebHelp generation process and I don't know how the WebHelp generated files handle the Map ID and aliases."

This topic has been closed for replies.

1 reply

Community Expert
January 4, 2013

You need to assign the numbers you find in the pecs_help.h file to topics in your help. You do this in Context Sensitive Help > Map Files > All Map IDs. (From RH7, but I assume the location is similar in RH9.) This creates the entries in the .ali file.

Peter Grainge suggests a couple of sites to read for a greater understanding here:

http://www.grainge.org/pages/authoring/calling_webhelp/using_map_ids.htm

(Although the second  site is based on RH X5, the basic concepts and procedures should be very similar. )

HTH,

Amber

Willam van Weelden
Inspiring
January 4, 2013

If you want to know how the generated files handle it, see the file whcshdata.htm.

But I don't think you need to know how the scripts handle the call. You can set the CSH within RoboHelp and let RoboHelp handle the rest.

FYI: Peter's article on calling WebHelp is still up to date.

Greet,

Willam