Table of Contents
Advertisement
USING ROBOHELP HTML 10
Context-sensitive Help
Author and developer roles in creating context-
sensitive Help
Author
Writes the Help topics that describe how to use application
components such as windows, dialog boxes, fields, and controls.
Imports map files and assigns map IDs to each context-sensitive Help
topic. Communicates to the developer any unclear assignments or
changes in assignments.
or
Creates map files and assigns map IDs to each context-sensitive Help
topic. Exports map files to the development environment when
complete and notifies the developer of any changes.
Generates the project to include the context-sensitive Help topics
with the output.
Tests the context-sensitive topics in the application. Repairs errors in
the Help system.
On the
Authoring home page of Peter Grainge's
WebHelp:
• Using URLs
• Using map IDs
• Using map IDs in merged WebHelp
• Using topic IDs
Map files and map IDs
More Help topics
"Author and developer roles in creating context-sensitive
"Information for
developers" on page 244
About map numbers, map files, and map IDs
A numeric value associated with a topic ID. Map numbers and topic IDs are saved in map files. Map
Map number
numbers are used with applications to specify a topic for calling context-sensitive Help. Whether application
developers use map numbers, topics IDs, or both depends on the programming language they use.
A text file containing topic IDs and map numbers. You associate map IDs and map files with topics. As
Map file
author, if you receive a map file from your developer, assign a map ID from the map file. If you manually create a map
file, either auto-generate or manually create the map ID. A project can include multiple map files. Map files use the
extensions .h, .hh, and .hm. The default map file is BSSCDefault.h.
A string that pairs a topic ID with a map number. For example:
Map ID
Developer
Builds the components (windows, dialogs, fields, controls) that make
up the application.
Generates the map files that contain the map IDs and gives them to
the author.
or
Obtains map files that contain the map IDs from the author.
Writes code that calls the correct Help topics from within the
application (based on map IDs included in the map files).
Notifies the author when changes are made to the application (or map
files) so that the Help project can be updated and regenerated. Repairs
errors in the application code.
website, you can find information about four methods of calling
Help" on page 237
Last updated 7/13/2012
237
Advertisement
Table of Contents
