The options you have for implementing context-sensitive help depend on your output format, because different formats support different ways of making calls to your help files. This topic lists the different types of context help possible in the output formats supported by Help & Manual.
For more details on context-sensitive help, the available context-sensitive help technologies and implementation information for programmers see the Context-Sensitive Help & Popups chapter in the Reference section.
This is the standard Microsoft help format for Windows applications. It is used for help installed locally on the user's computer. Calls to HTML Help CHM files are made using the Microsoft HTML Help API (application programming interface), which is documented in the help file delivered with the free Microsoft HTML Help Workshop compiler and CHM authoring package. For details see Application calls to context-sensitive topics. Making the calls is up to your programmers; each programming language has different methods for doing this. You can download programming tutorials from our website. Supported context-sensitive help types•Calls to specific help topics •Calls to anchors in specific help topics •Field-level popups •Training card help |
One important thing to know about the CHM files generated by Help & Manual when making calls to them from your applications is that there are no internal folders. Help & Manual uses a "flat file" directory model inside the CHM, with everything on the root level. This means that all topics and other files inside the CHM can be accessed directly, without any path information. Some programming tips assume the use of folders -- for example a folder called "html" for the HTML topic files – and if they also include this path without alternatives in their call examples this will lead to failures. But that is really the only element of H&M CHM files that you need to be aware of. |
WebHelp is displayed in a normal web browser like Firefox, Safari, Opera or even Internet Explorer. It is used for help accessed on networks and the Internet. Calls to WebHelp are made with normal URLs. Supported context-sensitive help types•Calls to specific help topics •Calls to anchors in specific help topics |
These print-style formats do not support any real context-sensitive help features. A certain amount can be achieved with anchors in the PDF files called "named destinations", but what is possible is actually very limited and named destinations do not really work very well. |
See also: