| <!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> |
| <html> |
| <head> |
| |
| <meta http-equiv="Content-Type" |
| content="text/html; charset=iso-8859-1"> |
| |
| <meta name="GENERATOR" |
| content="Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]"> |
| <title>Help System Extension Points</title> |
| </head> |
| <body text="#000000" bgcolor="#ffffff" link="#0000ff" vlink="#800080" |
| alink="#ff0000"> |
| <center> |
| <h1>Help System Preferences</h1> |
| </center> |
| |
| The following preferences settings can be used with the help system: |
| <ul> |
| <li><b>log_level</b>: denotes what kind of information gets written to the |
| help log. Use one of the following tree values.</li> |
| |
| <ul> |
| <li>0: log errors only</li> |
| <li>1: log errors and warnings</li> |
| <li>2: log errors, warnings and information (debug) messages</li> |
| |
| </ul> |
| <li><b>help_home</b>: The page to show inn the content area when opening |
| help. Specify your html page as <i>/pluginId/path/to/home.html</i>. Currently, |
| the default home is /org.eclipse.help/doc/help_home.html.</li> |
| <li><b>linksView</b>: set to true or false to control the visibility of |
| the related links view. Note: this option has no effect in the infocenter.</li> |
| <li><b>bookmarksView</b>: set to true or false to control the visibility |
| of the bookmarks view. Note: this option has no effect in the infocenter.</li> |
| <li><b>baseTOCS</b>: 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 <i>/pluginId/path/to/toc.xml</i>.</li> |
| <li><b>imagesDirectory</b>: 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".</li> |
| <li><b>advanced.toolbarBackground</b>: CSS background for toolbars. |
| Value is used in browsers that display advanced help UI. Default is |
| "ButtonFace"</li> |
| <li><b>advanced.viewBackground</b>: CSS background for navigation views. |
| Value is used in browsers that display advanced help UI. Default is |
| "Window"</li> |
| <li><b>advanced.toolbarFont</b>: CSS font for toolbars. Value is used |
| in browsers that display advanced help UI. Default is "icon"</li> |
| <li><b>advanced.viewFont</b>: CSS font for navigation views. Value |
| is used in browsers that display advanced help UI. Default is "icon"</li> |
| <li><b>basic.toolbarBackground</b>: background color for toolbars. |
| Value is used in browsers displaying basic help UI. Default is "#D4D0C8"</li> |
| <li><b>basic.viewBackground</b>: background color for navigation views. |
| Value is used in browsers displaying basic help UI. Default is "#FFFFFF"</li> |
| <li><b>productIndex</b>: 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 ""<br></li> |
| <li><b>locales</b>: 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 ""<br></li> |
| </ul> |
| <p><br> |
| <a href="hglegal2003.htm"><img src="ngibmcpy2003.gif" |
| alt="(c) Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." |
| border="0"></a></p> |
| <br> |
| <br> |
| </body> |
| </html> |
