cleaning preference documentation

1 files changed, 58 insertions, 10 deletions

diff --git a/org.eclipse.help.base/preferences.ini b/org.eclipse.help.base/preferences.ini
index 63677efee..8cf23249d 100644
--- a/org.eclipse.help.base/preferences.ini
+++ b/org.eclipse.help.base/preferences.ini
@@ -1,47 +1,95 @@
-#banner=/org.eclipse.help.webapp/advanced/banner.html
-#banner_height=45
+###################
+# Help view layout 
+###################
+
+# Location of the banner to display in the top frame.
+# Example: banner=/org.eclipse.help.webapp/advanced/banner.html
+banner=
+
+# Hight of the banner frame
+# Example: banner_height=45
+banner_height=
+
+# 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.
 help_home=/org.eclipse.help.base/doc/help_home.html
+
+# Set to true or false to control the visibility of the related links view.
+# Note: this option has no effect in the infocenter.
 linksView=true
+
+# Set to true or false to control the visibility of the bookmarks view.
+# Note: this option has no effect in the infocenter.
 bookmarksView=true
+
+# 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.
 windowTitlePrefix=true
 
+
 ########################################
 # Customization for handling large books
 ########################################
 
-# number of topics in a book, above which topics in navigation will be loaded dynamically downloaded 
+# 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.
 loadBookAtOnceLimit=1000
-# suggested number of children levels dynamically loaded when a topic is expanded, value must be > 1
+
+# 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.
 dynamicLoadDepthsHint=3
 
+
 ##############################
 # Customization for jsp pages
 ##############################
 
-# /pluginid/dir or directory relative to directories inside org.eclipse.help.webapp plugin
+# 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.
 imagesDirectory=images
 
-# colors for advanced web UI implementation
+# CSS background for toolbars.
+# Value is used in browsers that display advanced help UI.
 advanced.toolbarBackground=ButtonFace
+
+# CSS background for navigation views.
+# Value is used in browsers that display advanced help UI.
 advanced.viewBackground=Window
 
-# fonts for advanced web UI implementation
+# CSS font for toolbars.
+# Value is used in browsers that display advanced help UI.
 advanced.toolbarFont=icon
+
+# CSS font for navigation views.
+# Value is used in browsers that display advanced help UI.
 advanced.viewFont=icon
 
-# colors for basic web UI implementation
+# Background color for toolbars.
+# Value is used in browsers displaying basic help UI.
 basic.toolbarBackground=#D4D0C8
+
+# background color for navigation views.
+# Value is used in browsers displaying basic help UI.
 basic.viewBackground=#FFFFFF
 
 ########################################
 # Customization for infocenter languages
 ########################################
 
-# list of locales that infocenter will recognize and provide a customized content for; if locales
+# List of locales 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.
-# locales=en ja zh_CN zh_TW
\ No newline at end of file
+# Example: locales=en ja zh_CN zh_TW
+locales=
\ No newline at end of file