Help System Preferences
The following preferences settings can be used with the help system:
- help_home: The page to show inn the content area when opening
help. Specify your html page as /pluginId/path/to/home.html. Currently,
the default home is /org.eclipse.help/doc/help_home.html.
- linksView: set to true or false to control the visibility of
the related links view. Note: this option has no effect in the infocenter.
- bookmarksView: set to true or false to control the visibility
of the bookmarks view. Note: this option has no effect in the infocenter.
- windowTitlePrefix: set to true or false to control the title
of the browser window. If true, the title will have a form "Help -
<PRODUCT_NAME>", otherwise the title will be "<PRODDUCT_NAME>",
where <PRODUCT_NAME> is the name of Eclipse product set in the primary
feature. Default is true.
- loadBookAtOnceLimit: the maximum number of topics
a book can have, for the navigation to be loaded by the browser as one document.
Navigation for larger books is loaded dynamically, few levels at a time.
More topics are downloaded as necessary, when branches are expanded. Default is 1000
- dynamicLoadDepthsHint: suggested number of levels in topic navigation
downloaded to the browser for large books. The value needs to be greater than 0.
The actual number of levels can differ for wide tree if suggested number of levels
contains large number of topics. Default is 3.
- baseTOCS: ordered list of help TOC's (books) as they would appear
on the bookshelf. All the other TOCS will be follow these books. Non-present
TOC's on this list will be ignored. Use the location of each TOC as /pluginId/path/to/toc.xml.
- imagesDirectory: directory containing images used in the help
view. Images must have the same name as those in the org.eclipse.help.webapp
plugin. Use the /pluginID/directory format. Default is "images".
- advanced.toolbarBackground: CSS background for toolbars.
Value is used in browsers that display advanced help UI. Default is
"ButtonFace"
- advanced.viewBackground: CSS background for navigation views.
Value is used in browsers that display advanced help UI. Default is
"Window"
- advanced.toolbarFont: CSS font for toolbars. Value is used
in browsers that display advanced help UI. Default is "icon"
- advanced.viewFont: CSS font for navigation views. Value
is used in browsers that display advanced help UI. Default is "icon"
- basic.toolbarBackground: background color for toolbars.
Value is used in browsers displaying basic help UI. Default is "#D4D0C8"
- basic.viewBackground: background color for navigation views.
Value is used in browsers displaying basic help UI. Default is "#FFFFFF"
- productIndex: plug-in ID of a plugin containing prebuilt documentation
index. If present, the index retrieved from the plug-in will be used
as a starting point in creation of documentation index for use by help search.
Default is ""
- locales: list of locales (space separated) that infocenter will recognize and provide a customized
content for. If locales (or languages) accepted by client browser are not matched with
any locales in this list, the browser will be served content for default locale - the server locale,
or locale specified by eclipse -nl command line option. If list is not specified, the browser will be
served contents for its preferred locale. Note: not providing this option may result in a large
memory and disk space requirements as navigations and indexes will be created for each distinct
preferred locale among browsers accessing the infocenter.
Thos preference can be overridden by command line option when launching infocenter.
Default is ""
