Context sensitive help is help set up to open at a topic relevant to the field or screen that the user is viewing. This article provides an overview of the way context sensitivity works in browser based AIR help generated by RoboHelp. This article shows you how you can create URLs to call your help context sensitive. This allows you to create your own context sensitive help calls and allows you to create your own API. I focus on developers and others who want to know what options are available to them. I assume you have some experience with RoboHelp and browser based AIR help as I will be using default RoboHelp terminology.
- Not all methods may work on RoboHelp 8.
- This article is only about Browser based AIR help. If you are looking for more information on locally installed AIR Help, see http://www.grainge.org/pages/authoring/air/air.htm.
- If you have opened a browser based AIR help project in your browser and you feed a context sensitive URL into the address bar, the call may fail. There are two solutions to this:
- First navigate to another URL such as http://www.google.com and then try the URL again.
- Amend the call to avoid conflict. See the table at the start of http://www.grainge.org/pages/authoring/calling_webhelp/using_urls.htm for more information.
Calling Browser based AIR help
You call the help context sensitive through the start file of the project. You add the options you want to use to the URL to control how the help opens your topic. Browser based AIR help supports the following options:
- Map numbers.
- Topic ids.
- Relative path to a file in the project.
Say that we have a fictitious context sensitive browser based AIR help project published on http://localhost/newproject.htm. The file newproject.htm is the start file of the project. You can call the help in two ways:
- Specify the path to the topic.
- Using options to make the help open the correct topic.
Specify the path to the topic
When you specify the path to the topic, simply add
#after the URL and add the relative path to the topic you want to open:
The help will now open the specified topic. The help will open in the same browser window, no popup is used. After the URL you can use several options to control how the help works. You have to separate multiple options with
>>. You can use the following options:
|cap||String||The title of the help project.|
|pan||0 or 1||Show the skin or show only the topic.
For instance, if you want the help to show the skinOnly works on RoboHelp 8! and you want to title of the help to “My help project”, use the following URL:
http://localhost/newproject.htm#folder/mytopic.htm>>pan=0>>cap=My help project
Using options to make the help open the correct topic
If you want to use options to make the help open the correct topic, you can use all the options that browser based AIR help provides. To trigger the context sensitivity, add
#< after the path of the project start file:
After these characters, you can specify the options. You have to separate multiple options with
>>. You can use the following options:
|cmd||String||Decide which pane you want to show on opening. If you use this, you can’t use map numbers or topic ids. Available values:
|helpid||DUCC name||The name of the content category you want to open. This must exactly the same as the name defined in the AIR SSL dialog.|
|id||Map number||Call using a map number. If you specify both a map number and a topic id, the help shows the topic corresponding with what is listed first in the URL.|
|str||Topic id||Call using a topic id. The topic id is case sensitive. If you specify both a map number and a topic id, the help shows the topic corresponding with what is listed first in the URL.|
|wnd||Window name||The name of the window you want to use. The window name is case sensitive. You need to create the window in the RoboHelp project.|
For example, if you want to call the topic with map number 3, use the following URL:
Another example: if you want to call the topic with topic id MyTopic and use the window MyWindow, use the following URL:
The help will always open a popup when you use any of these options. Since most of the context sensitivity is handled through a flash file, there is no way of changing this behaviour. If you don’t want a popup, don’t use these options.