It does not matter what tool you are using for this method, as long as the application is a Web application (rather than a Winform application).
Writers must follow these steps to deliver the context-sensitive help:
Obviously you need to replace the path in red with the path of your actual help button file.
That's it. Now when the user clicks the help button, the page with the same file name in your help files will appear.
<script src="http://samplewebpath/acmeapplication/showhelp.js"> </script>
Open Notepad and insert the script, but remove the <script> tags from the beginning and end. Save the file with a .js extension.
Code the help button the same way as before.
Here's a little trick I learned a while ago with RoboHelp.
What's the difference between these two web paths?
The first calls the topic Contact and also shows the navigation pane (table of contents).
The second shows the topic Contact without the navigation pane.
var pagePrefix = "http://samplewebpath/acmeapplication/webhelp/index.htm#"
If you don't want the navigation pane to show, you would write it like this:
var pagePrefix = "http://samplewebpath/acmeapplication/webhelp/"
In RoboHelp, if you hide the table of contents, you're left with a little link that says (quite nebulously) "show." Show what? Where? To whom?
You can change this Show text. I don't have RoboHelp open and in front of me, but if I remember correctly, go to File > Project Settings. Click the Advanced button. Click the LNG tab. Scroll until you see show=show. Select that and click the Edit button. Customize the text after the equals sign, like this: show=Show Table of Contents.
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.