Provides access to stand alone help system.
Classes in this package are not supposed to be called by Eclipse plugins,
they are intended to be called from outside of Eclipse environment.
Package Specification
The help system in Eclipse can be used by other products. Access
to this help system is provided through org.eclipse.help.standalone.Help
class.
This Help class should be placed on the application class path, and
methods of the Help class provide means or launching help. There
is a general mechanism (defined at the plug-in level) by which individual
plug-ins contribute online help and context-sensitive help for their component.
This Eclipse mechanism for contributing help content need to be used.
The stand alone help system is responsible for accessing this information
and displaying it to the user.
The use of the stand-alone help system involves:
-
Placing the Help class from this package on the application class
path.
-
Instantiation of the Help class, providing name of the directory
where Eclipse and documentation plugins reside.
-
Calling methods of Help class to start help.
-
Calling methods of Help class to display help. The call
can be repeated multiple times as needed.
-
Calling methods of Help class to shut down help.