Package org.eclipse.help.standalone

package org.eclipse.help.standalone
Provides access to information center and 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 to run an information center or as a stand alone help system for use by other products.  Access to the help system is provided org.eclipse.help.standalone.Infocenter and org.eclipse.help.standalone.Help classes.

To start or stop the information center, use the Infocenter class. The class can be used as a stand alone program, launched from a command line, or can be instantiated and used from a Java program.

To start, stop the stand alone help system or cause it to display help on a user machine, use the Help class. The class can be used as a stand alone program, launched from a command line, or can be instantiated and used from a Java program.

There is a general mechanism (defined at the plug-in level) by which individual plug-ins contribute on-line help and context-sensitive help for their component. This Eclipse mechanism for contributing help content needs to be used.  The stand alone help system is responsible for accessing this information and displaying it to the user. The information center, unlike the stand alone help system, does not launch UI on the machine that it is running on. When infocenter is started the help content can be obtained by connecting to a help server (port specified in Tomcat plugin preferences) using HTTP connection.

  • Classes
    Class
    Description
    Help
    This is a standalone help system.
    Infocenter
    This is a standalone infocenter.