Invoking the action from HTML
To include active help links in your documentation, you must first declare the
use of the supporting JavaScript code. The live help JavaScript is located in the org.eclipse.help
plug-in. You refer to it using the help system's
crossplug-in referencing technique. This script reference should be placed in the HEAD section of your HTML:
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"> </script>
In the body of your documentation, you invoke the liveAction script.
<a href='javascript:liveAction(
"org.eclipse.platform.doc.isv",
"org.eclipse.platform.doc.isv.activeHelp.ActiveHelpOpenDialogAction",
"")'>Click here for a Message.</a>
The parameters for liveAction are
- the ID of the plug-in that
contains the action
- the name of the class that implements the action
- the String that will be passed to the live help action using setInitializationString.
We don't need to pass any information from the HTML page, so we just
pass an empty string.