Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Plug-in Developer Guide
Previous Page Home Next Page

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.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire