The alias file that is created and saved in the project folder when aliases are created for window-level Help topics. This .ALI file is included in the .CHM file when the HTML Help project is compiled. It shows the topic ID/window-level Help topic match (for example, ID_PizzaDeliveryForm=Pizza_Delivery_Form.htm). You do not have access to this file from the Project Manager. It is generated behind the scenes and you make changes to it whenever you open the Context-Sensitive Aliases dialog and add, update or remove aliases.
In HTML Help, an alias is the relationship between a window-level topic and a topic ID. For an application to call window-level context-sensitive Help topics, an alias is required. Authors create aliases in RoboHELP after creating the window-level Help topics.
The software program the developer is creating that will use the context-sensitive Help topics.
HTML Help specifically intended for use with an application and not as a standalone product. Users can only access application Help from within the active application by pressing F1, clicking Help buttons, selecting Help from menus and by using What’s This? Help at dialogs.
Using an option in RoboHELP to automatically generate map files (.H) when context-sensitive Help topics are created. When authors generate map files, the map numbers are automatically assigned to the topic IDs. Developers need copies of these map files after they are generated (they need to do some coding in the application to identify the context-sensitive topics based on their map numbers). The map numbers in these files can be manually changed. If developers supply the map files, authors do not auto-generate them in RoboHELP.
Using an option in RoboHELP to automatically generate map numbers when context-sensitive Help topics are created. Map numbers start with 1 and the program tracks all numbers used in all .H files so duplicate map numbers are not created. Developers need copies of these map files after they are generated because they need to do some coding in the application to identify the context-sensitive topics based on their map numbers. (If developers supply the map files, authors do not auto-generate them in RoboHELP.)
A tool included with RoboHELP Office used to test context-sensitive Help topics. BugHunter can test both window-level and text-only (or What’s This? Help) topics used with Microsoft HTML Help. BugHunter offers time-saving ways to test context-sensitive Help because it enables authors to monitor calls to HTML Help and diagnose problems (it indicates what map numbers the application is calling for each topic).
An action that takes place in an active application when users request help. This action sends the map number and .CHM file name to the HTML Help Translator where the map number is matched to a topic ID, alias and .HTM file name so the correct Help topic can be displayed in a window.
The file created whenever authors compile a Microsoft HTML Help project. All the files in the project — including context-sensitive Help topics, map files and .ALI files (for aliases), are compressed and saved in this file. Authors should update this file whenever they make changes to context-sensitive Help topics. This is the file that is distributed with the application (authors provide developers with copies of .CHM files).
Help topics intended for use with applications that run on non-Windows platforms such as UNIX or Mac. These topics are created in the WYSIWYG Editor and saved in .HTM format. With cross-platform Help, authors do not work with map files, aliases or map numbers. Instead, authors generate WebHelp output files. Then, authors provide developers with the files so they can code the context-sensitive Help functionality into the application.
A window authors create that is specifically intended to display window-level Help topics for Microsoft HTML Help. If a custom window is not included with the application Help, the context-sensitive topics are displayed in the HTML Help viewer.
Help intended to provide information about a window, dialog or message in an application. In RoboHELP, dialog Help is referred to as window-level Help.
An instance where the same map number is assigned to more than one topic ID. The duplicate map numbers can reside in a single map file (.H) or in any number of map files that are part of the project. For context-sensitive Help functionality, all map numbers must be unique. When authors find duplicate map IDs, they should notify their developer because the duplicate IDs must be replaced with unique numbers.
Help intended to provide information about a window, dialog or message in an application. In RoboHELP, F1 Help is referred to as window-level Help.
Help intended to provide information about a specific control at a window or dialog. In RoboHELP, field-level Help is referred to as What’s This? Help.
File extensions used with map files (which are in text format). They can be generated in application development tools, text editors and in RoboHELP when authors are creating text-only topics or aliases (for window-level Help).
A common developer’s term used to refer to map files. Development tools such as C and C++ generate header files. These header files are text files containing a list of topic IDs and their corresponding map numbers. Header files use the .H or .HH extension. When developers provide authors with header files, they need to be imported into the HTML Help project.
Term used to describe the function where the application calls a Help topic. The developer writes code that calls a topic in a .CHM file. The call is made in response to the user’s request for help — initiated when users press F1, click Help buttons or menus, and use What’s This? Help. The code uses a command from the HtmlHelp API (the command used depends on the type of Help).
The Microsoft ActiveX control that contains the HtmlHelp() APIs. Developers do some coding so HHCTRL.OCX is invoked when users request help.
One of the HtmlHelp API commands available for context-sensitive Help. Authors create window-level topics that use aliases. The aliases are included in the compiled .CHM file that authors distribute to developers. Developers work with the command to call the HtmlHelp() function with the HH_HELP_CONTEXT command and pass the topic’s numeric value as the data parameter of the function. (Using this command, calls are made to the application using the map number.)
The programming interface for Microsoft HTML Help that makes it possible to display a Help window from an application. It is used by developers to integrate HTML Help projects with Windows applications. HtmlHelp API contains numerous commands for specifying the type, style and position of Help windows.
A mechanism in Microsoft HTML Help that looks up context-sensitive Help topics when users request help in applications.
The default window (based on Internet Explorer browser components) used to display compiled Microsoft HTML Help (.CHM files). Authors can design a separate custom window to display context-sensitive Help topics, rather than displaying them in the viewer.
Prefixes used with topic IDs in map files. Development tools that generate header files (map files) automatically use a default prefix. When authors generate map files in RoboHELP, they manually enter topic IDs which may or may not use prefixes (they are not required).
The process where existing map files are integrated into an HTML Help project in RoboHELP. After map files are imported, they can be used to create aliases for window-level Help topics or they can be used to create text-only topics for What’s This? Help.
A text file containing a list of topic IDs and map numbers that are related to the interface in an application. Map files are generated in development tools such as C and C++ and in RoboHELP. Map files use the extensions .H, .HH and .HM. They are required for context-sensitive Help topics used with Microsoft HTML Help.
The string in a map file that pairs a map number and topic ID together. (Map number + topic ID = map ID.)
A numeric value associated with a topic ID. Both map numbers and topic IDs are saved in map files (.H, .HH, .HM). Map numbers are used with applications to specify a topic when calling context-sensitive Help.
A mechanism that maps fields and controls at dialogs to map numbers. It is programmed into applications to provide context-sensitive Help functionality.
Help that is compiled and saved in a .CHM file for distribution. All files in an HTML Help project are compiled and compressed into a .CHM file. Some projects include multiple .CHM files used in combination with each other through links, merged indexes and merged tables of contents. Microsoft HTML Help projects can only be used on Windows systems that have Internet Explorer 4.x or later, or the required Microsoft HTML Help display files. CHM files are displayed in a special HTML Help viewer that is part of Microsoft HTML Help and based on Internet Explorer browser functionality.
The default window that displays What’s This? Help. In HTML Help, popup windows can only display text (text formatting, links, images, etc. are not supported). Clicking the mouse closes the window.
Characters affixed to the beginning of topic IDs as part of their syntax. Typical prefixes include ID_, IDD_ and IDH_. They are not mandatory components of topic IDs, although they are often used with them.
A custom window designed in RoboHELP to display topic content in a window that is separate from the HTML Help viewer. Frequently, secondary windows are designed for window-level Help topics.
A context-sensitive topic created and authored at a dialog in RoboHELP. These topics are in text-only format and are used as What’s This? Help in applications. (These kinds of topics can also be created in What’s This? Help Composer.)
The file saved in the project folder when text-only topics are created in RoboHELP.
A name used by Microsoft HTML Help to uniquely identify a context-sensitive Help topic. Topic IDs are associated with map numbers and both are saved in map files (.H, .HH).
A file created and saved in the project folder when text-only topics are created. These files are paired up with map files to provide context-sensitive support for What’s This? Help. The .TXT file is included in the .CHM file when the HTML Help project is compiled.
Text-only Help topics that provide brief descriptions of controls and fields in a dialog. To access What’s This? Help, users click the question mark in the upper-right corner of the dialog, and then click the field or control they want help for. The Help topic is displayed in a popup window that closes by clicking the mouse.
A eHelp tool that automates the process of creating What’s This? Help topics. It is copied on authoring systems when RoboHELP is installed. What's This? Help Composer HTML Help projects are only compatible with applications created in C and C++.
Context-sensitive Help topics created in the WYSIWYG Editor and intended to describe windows, dialogs and messages. Each topic is a separate .HTM file and it can use text formatting, links, images, and other HTML formats. These topics are more detailed than What’s This? Help because they describe all the UI components that are displayed from a dialog or window in the application. Users access this Help by pressing F1, clicking Help buttons and selecting Help from menus. The Help is displayed in a custom window (designed by the author) or in the HTML Help viewer (if a custom window is not created for this purpose).
If you’re new to context-sensitive Help, it’s a good idea to familiarize yourself with relevant terms so you can have a clear understanding of all the parts that comprise context-sensitive Help.