帮助系统首选项

Eclipse 帮助系统可通过指定若干帮助首选项的定制缺省值来进行配置和提供品牌信息以适合于您的产品。

帮助系统本身分为若干独立插件。这些表显示可用首选项以及定义它们的插件。参阅定制产品以了解如何覆盖其中某些首选项。
 

org.eclipse.help 插件:

首选项键 用法
缺省值
baseTOCS 目录排序。出现在书架上的帮助目录(书籍)的有序列表。所有其它目录将在这些书籍后面。此列表上未提供的目录将被忽略。将每个目录的位置用作 /pluginId/path/to/toc.xml。 /org.eclipse.platform.doc.user/toc.xml,
/org.eclipse.jdt.doc.user/toc.xml,
/org.eclipse.platform.doc.isv/toc.xml,
/org.eclipse.jdt.doc.isv/toc.xml,
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS 禁用目录。帮助系统将忽略帮助目录(手册)列表。禁用的目录将不会显示在手册的目录列表中,也不能进行链接。无法搜索禁用目录定义的主题。此列表上未提供的目录将被忽略。将每个目录的位置用作 /pluginId/path/to/toc.xml。

org.eclipse.help.base 插件:

首选项键 用法
缺省值
banner 将显示在顶部框架中的条幅页的位置
示例:banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height 条幅框架的高度
示例:banner_height=60

help_home 要在打开帮助时显示在内容区域中的页面。将 HTML 页指定为 /pluginId/path/to/home.html /org.eclipse.help.base/doc/help_home.html
linksView 设置为 truefalse 以控制相关链接视图的可视性。
注意:此选项在信息中心中不起作用。
true
bookmarksView 设置为 truefalse 以控制书签视图的可视性。
注意:此选项在信息中心中不起作用。
true
windowTitlePrefix 设置为 truefalse 以控制浏览器窗口的标题。如果为 true,则标题的形式将会是“帮助 - <PRODUCT_NAME>”,否则标题将会是 “<PRODUCT_NAME>”,其中 <PRODUCT_NAME> 是在主要功能部件中设置的 Eclipse 产品的名称。 true
loadBookAtOnceLimit 一本书所能具有的由浏览器作为一个文档装入的用于导航的最大标题数。用于较大的书籍的导航是动态装入的,一次几层。其它主题是在展开分支时根据需要下载的。 1000
dynamicLoadDepthsHint 针对大型书籍下载至浏览器的主题导航中的建议层数。该值必须大于 0。如果建议的层数包含大量主题,实际层数可能会因为树的广度而不同。
3
imagesDirectory 包含在帮助视图中使用的图像的目录。图像必须与 org.eclipse.help.webapp 插件中的图像同名。使用 /pluginID/directory 格式。 images
advanced.toolbarBackground 工具栏的 CSS 背景。值在浏览器中用于显示高级帮助用户界面。 ButtonFace
advanced.viewBackground 导航视图的 CSS 背景。值在浏览器中用于显示高级帮助用户界面。 Window
advanced.toolbarFont 工具栏的 CSS 字体。值在浏览器中用于显示高级帮助用户界面。 icon
advanced.viewFont 导航视图的 CSS 字体。值在浏览器中用于显示高级帮助用户界面。 icon
basic.toolbarBackground 工具栏的背景色。值在浏览器中用于显示基本帮助用户界面。 #D4D0C8
basic.viewBackground 导航视图的背景色。值在浏览器中用于显示基本帮助用户界面。 #FFFFFF
locales 信息中心识别并为其提供定制内容的语言环境的列表;如果客户机浏览器接受的语言环境(或语言)与此列表中的任何语言环境不匹配,则会向浏览器提供缺省语言环境(服务器语言环境)的内容,或者 eclipse -nl 命令行选项指定的语言环境;如果未指定列表,将向浏览器提供其首选语言环境的内容;注意:如果未提供此选项,在为访问信息中心的各个浏览器中的每个不同首选语言环境创建导航和索引时将需要大量内存和磁盘空间。
示例:locales=en ja zh_CN zh_TW

productIndex 如果产品附带提供了预先构建的完整产品文档索引,则必须在此处对帮助系统指定提供索引的插件的标识。
always_external_browser
尽可能使用嵌入式浏览器(在 Windows 或 Linux 上),或者始终使用外部浏览器。设置为 true 将强制使用外部浏览器。如果在给定平台上未提供嵌入式浏览器,则此选项不可用。
false
default_browser

缺省外部浏览器。提供给 org.eclipse.help.base.browser 扩展点而且帮助系统将会使用的外部 Web 浏览器之一的标识。浏览器的适配器 available() 方法在当前系统上必须返回 true。

此首选项控制独立帮助方式下的外部浏览器。在工作台方式下,帮助功能使用工作台浏览器支持提供的浏览器。

根据给定系统上提供的浏览器动态设置的缺省值
custom_browser_path

定制浏览器的可执行文件路径

此首选项控制独立帮助方式下的外部浏览器。在工作台方式下,帮助功能使用工作台浏览器支持提供的浏览器。

在 Windows 上为 C:\Program Files\Internet Explorer\IEXPLORE.EXE" %1
"konqueror %1" - 在 Linux 上
在其它平台上为 "mozilla %1"
showDisabledActivityTopics 帮助系统过滤来自禁用功能的主题。此选项控制这一行为以及“显示所有主题”按钮的存在与否。
接受的值包括:neveroffonalways
 never - 来自禁用功能的主题不会显示出来
 off - 用户可选择显示所有主题,一开始会隐藏禁用主题
 on - 用户可选择显示所有主题,一开始会显示所有主题
 always - 来自禁用功能的主题会显示出来(过滤功能被禁用)
off
activeHelp 允许启用和禁用活动帮助的执行。该选项在信息中心设置中不起作用,其中活动帮助将被禁用。
接受的值包括:
 true - 启用缺省活动帮助操作
 false - 禁用活动帮助框架
true
window_infopop 允许在工作台窗口中按帮助键时启用旧样式的弹出信息。如果为 false,则打开新建动态帮助视图。 false
dialog_infopop
允许在对话框中按帮助键时启用旧样式的弹出信息。如果为 false,则打开新建动态帮助窗口。
false

org.eclipse.help.appserver plug-in:

首选项键 用法
缺省值
port 服务器在其上侦听 HTTP 请求的端口号。如果未指定端口,系统将使用任意端口。  
host

要用于连接至服务器的主机地址或名称。缺省值为无,而 Eclipse 将选择可用本地地址。

以本地方式使用帮助的产品(工作台或独立方式,而不是信息中心)可以将此首选项设置为“127.0.0.1”以确保不提供帮助服务器给网络中的其他用户使用。


org.eclipse.tomcat 插件:

首选项键 用法
缺省值
acceptCount 处理线程的所有可能请求都在使用时传入连接请求的最大队列长度。队列已满后接收到的所有请求都会被拒绝。 100
maxProcessors
要由此连接器创建的最大请求处理线程数,因而将由它确定可同时处理的最大请求数。
75
minProcessors
第一次启动此连接器时将创建的请求处理线程数。此属性应设置为小于对 maxProcessors 设置的值。
5