帮助系统
“帮助系统”插件 org.eclipse.help 定义了两个扩展点(“上下文” 和“toc”),这些扩展点允许个别插件为它们的组件添加上下文相关帮助和联机帮助。提供文档的典型插件将使用这些扩展点。
其它扩展点提供帮助系统的扩展功能。
对于更高级的应用程序,还有一个扩展点(“支持”)用于插入帮助系统 UI。
扩展点
可以使用下列扩展点来扩展帮助系统:
首选项
下列首选项设置可与帮助系统配合使用:
-
log_level:指示将哪种信息写入到帮助日志中。使用下列三个值之一。
- 0:仅写入日志错误
- 1:写入日志错误和警告
- 2:写入日志错误、警告和信息性(调试)消息
- banner:帮助视图允许应用程序设置品牌。如果想要在帮助视图顶部显示公司徽标或其它任何内容,则将 html 页面指定为 /pluginId/path/to/banner.html。目前,缺省条幅为 /org.eclipse.help.webapp/banner.html。如果将此名称设置为空白字符串,则不会显示任何条幅。
- banner_height:条幅区的高度。目前缺省值为 45。
- help_home:打开帮助时要在内容区中显示的页面。将 html 页面指定为 /pluginId/path/to/home.html。当前缺省主页是 /org.eclipse.help/doc/help_home.html。
- linksView:将它设置为 true 或 false,以控制相关链接视图的可视性。
- baseTOCS:帮助 TOC(书籍)的已排序列表,就象它们摆放在书架上一样。所有其它 TOCS 将在这些书籍后面。将忽略此列表上不存在的 TOC。将每个 TOC 的位置用作 /pluginId/path/to/toc.xml。