The Eclipse help system can be configured and branded to suit your
product by
specifying custom defaults for number of help preferences.
The Help system itself is divided up into a number of separate plug-ins. These tables shows available preferences, and which plug-in defines them.
Preference key | Usage |
Default |
HELP_DATA |
Specifies a plug-in-relative path to an XML file containing help data, such
as the order in which the table of contents should be displayed, and which books
and index contributions should be hidden from the user. For example,
"helpData.xml ". Consult the
schema documentation for details. |
|
baseTOCS (deprecated; use HELP_DATA instead) |
Toc ordering. Ordered list of help TOC's (books) or TOC categories as they would appear on the bookshelf. All the other TOCS and categories will follow these. Non-present TOCs or categories on this list will be ignored. For TOCs, use the location of the TOC as /pluginId/path/to/toc.xml. For categories, use the category id. | /org.eclipse.platform.doc.user/toc.xml, |
ignoredTOCS (deprecated; use HELP_DATA instead) |
Disabling TOCs. List of help TOCs (books) or TOC categories that will be ignored by the help system. The disabled TOCs/categories will not appear in the list of books, cannot be linked. Topics defined by disabled TOCs will not be available from search. Non-present TOCs or categories in this list will be ignored. For TOCs, use the location of the TOC as /pluginId/path/to/toc.xml. For categories, use the category id. | |
ignoredIndexes (deprecated; use HELP_DATA instead) |
Disabling keyword indexes. List of help keyword index contributions that will be ignored by the help system. Keywords from the disabled indexes will not appear in the index view. For index XML files, use the path to the file in the form /pluginId/path/to/index.xml. |
Preference key | Usage | Default |
port (deprecated) |
The port number on which the sever listens for http requests. If port is not given, an arbitrary port is picked by the system. Start Eclipse with "-vmargs -Dserver_port=<port>" instead |
|
host (deprecated) |
The host address or name to use for connecting to the server. The default is nothing, and eclipse will pick up an available local address. Products using help in local mode (workbench or stand-alone, not infocenter),
can set this preference to " Start Eclipse with "-vmargs -Dserver_host=<host>" instead |
Preference key | Usage | Default |
acceptCount (deprecated) |
The maximum queue length for incoming connection requests when all possible request processing threads are in use. Any requests received when the queue is full will be refused. | 100 |
maxProcessors (deprecated) |
The maximum number of request processing threads to be created by this Connector, which therefore determines the maximum number of simultaneous requests that can be handled. | 75 |
minProcessors (deprecated) |
The number of request processing threads that will be created when this Connector is first started. This attribute should be set to a value smaller than that set for maxProcessors. | 5 |