本节包含的主题阐述如何安装、配置和定制帮助系统,以使其在不同的环境和产品中工作。
帮助系统可以三种方式运行:工作台方式(正常)、信息中心方式和独立方式。工作台方式用于提供与产品集成的帮助,这通常是通过“帮助”菜单进行的。此方式还提供了上下文帮助和“帮助”视图,在另外两种方式下,未提供它们。独立方式的目标与工作台方式相同,但用于并非基于 Eclipse 的产品(帮助的集成程度较低)。信息中心方式用于向 Web 上的用户提供帮助内容。请参阅以上链接以了解详细信息。
帮助系统是可选的富客户机平台(RCP)组件。即,它不是最小 RCP 的组成部分,但可以将其添加至 RCP 以在 RCP 应用程序中提供帮助。
帮助提供了首选项,产品可以通过首选项来根据需要定制帮助系统。这包括定制品牌、外观以及打开/关闭功能等等。
对于提供了大量帮助文档的产品来说,在第一次执行搜索时发生的初始建立索引阶段可能会非常长。为了避免这种延迟,可以对帮助内容预先建立索引并随文档一起交付预先构建的索引。这样做能提高性能(避免了建立索引阶段),但会增加用于存储索引的空间。