You can create context-sensitive calls to WebHelp (web HTML) from your application or web pages with normal URLs using the syntax explained below. These calls can be made locally, across networks or across the Internet.
If you want your WebHelp to be opened locally without a server (for example WebHelp on CDs and DVDs), Help+Manual has a special mini server that you can distribute with your help for better performance. See HM2Go - mini server for local WebHelp for details.
Calls to WebHelp must be normal URLs, made in the same way as any other URL link that opens a browser with a specific web location or local HTML file, using exactly the same syntax:
This example uses the standard file names and extensions and accesses an anchor in the referenced topic:
The following example shows a call to a project that was published with both a non-standard index file name and a non-standard extension for the topic files (see below). There is no reference to an anchor in this example.
Elements of the calls:
Normally, context IDs or context numbers are only used in Microsoft CHM/HTML Help files. However, Help+Manual also exports a scripted map file of all the context IDs in your project in your WebHelp output and allows you to link to them with a URL switch, in the same way as you link to normal topic IDs. This makes it easier for programmers who are using context IDs for making their CHM files to remap their calls to WebHelp.
Where xxxxxx is the context number/context ID. This works both for normal topic context IDs and context IDs attached to anchors. If you are using standard templates or skins the anchor must not be inside hidden text (i.e. not inside a toggle that is not open when the topic is opened). If you are use a Premium Pack skin the ToggleJump feature implemented there allows you to link to anchors inside toggles as well.
That is really all there is to it.
Where this is implemented:
Premium Pack Skins:
Adding support in your own skins:
Normally, a link to a topic file will automatically display the entire help with the TOC even if you don't include the index.html part of the URL. This is achieved with a redirect script in every topic page. However, It is also possible to call just the topic without the TOC if you want. You do this by adding a simple switch to your URL.
Calling syntax for topic only:
topicname.htm?toc=0#anchorname (with an anchor)
topicname.htm?toc=0 (without an anchor)
Theoretically you don't actually need to include the index.html file in the URL. If you make a direct call with the format topicname.htm or topicname.htm#anchorname this will automatically display the entire help system with the Table of Contents.
This is not a good idea, however: Under some circumstances it can confuse the browser history, making it impossible for users to navigate with the Back and Next buttons.
It is thus always advisable to use the full call including the index file, using the standard syntax: