A context-sensitive help topic provides information about the user interface of an application relative to the task your user performs. For example, context-sensitive help topics provide details about fields and controls in dialog boxes, descriptions of windows or screen objects, and explanations of messages. Your users access a context-sensitive help topic by pressing F1, clicking a Help button, selecting from a menu, or clicking a question-mark icon.
In RoboHelp, you work with context-sensitive help topics through map files in Output view. You can create, assign, unassign, edit, import, and export map files. A pairing of a map ID and map number for each topic is saved in map files.
Map ID Assign a unique map ID to each topic to display it in the CSH. For example, ID_SetupScreen.
Map number A numeric value associated with a topic. Map numbers are used with applications to specify a topic for calling context-sensitive help. For example, 101.
Whether application developers use map numbers, map IDs, or both depends on the programming language they use.
Topic You can assign or unassign a topic against a map ID and number. For example, SetupScreen.
Map files are used by authors and developers to build a context-sensitive help for an application.
- Author Writes the Help topics that describe how to use application components such as windows, dialog boxes, fields, and controls.
- Developer Builds the components (windows, dialogs, fields, controls) that make up the application.
An author can generate map files containing map IDs and give them to the developer. Or, an author can obtain map files from the developer.
To share map files, you can export a map file as a .h file in this format:
#define ID_SetupScreen 101
To map topics, you can follow two approaches.
Approach 1: To let RoboHelp automatically assign map IDs and map numbers, from the Contents panel, drag a topic and drop it below the field names in the map file editor.
RoboHelp automatically maps the topic name as map ID. For the first topic, the default map number is 1. You can edit the map ID and map numbers.
Map file settings, if specified, are applicable to all topics that are dragged and dropped.
Approach 2: If you want to specify a custom map ID or map number and separately assign a topic, do the following:
The topic is assigned to the map ID and number, and the topic filename appears under the Topic field.
To unassign a topic, click next to the topic name.
To delete an entire row of map ID, map number, and topic, click in that row.
Map file settings, if specified, are not applicable to topics that are assigned separately or to mappings defined before the settings were specified.
Map file settings apply to topics that are dragged and dropped in the map file editor. To specify map file settings:
In the Mapping Options dialog box, do the following:
- Prefix Map ID With To automatically add a prefix to all new map IDs, specify the prefix in this field.
- Start Map Number From To automatically start map numbers from a specific number, specify the number in this field.
- Create Map ID in uppercase Select this field to automatically create map IDs in uppercase.
You can import a map file received from an author or a developer. To import a map file:
You can export a map file to share it with an author or a developer. To export a map file: