安装独立帮助系统

如果正在创建并非基于 Eclipse 框架的应用程序,仍可使用 Eclipse 帮助系统。应用程序可以封装和安装独立的帮助系统,它是一个非常小的 Eclipse 版本,包括除帮助系统之外的所有内容。然后,应用程序可从它的“帮助”菜单或 UI 对象进行 API 调用以启动帮助浏览器。独立帮助系统具有集成帮助系统的所有功能部件,但弹出信息和活动帮助除外。

安装/封装

这些步骤用于帮助系统集成器,但并不代表能解决所有可能的情况。假定启动应用程序是用 Java 编写的,且所有文档都是作为 Eclipse 插件交付的,通常您很熟悉 eclipse 帮助系统。
  1. 从以下网址下载“Eclipse 2.0 发行等级平台运行时二进制文件”驱动程序:www.eclipse.org
  2. 将该驱动程序安装(解压缩)到应用程序目录下面,例如,d:\myApp。这将创建一个 eclipse 子目录 d:\myApp\eclipse,它包含 Eclipse 平台(它包括帮助系统)所需的代码。

如何调用帮助类

  1. 确保 d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar 位于应用程序类路径中。用来启动(start)、启动(launch)和关闭帮助系统的类是 org.eclipse.help.standalone.Help。
  2. 在应用程序中,通过传送插件目录创建“帮助”类的实例。此对象应保留到应用程序结束为止。
    Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins"); 
  3. 要启动帮助系统:
    helpSystem.start(); 

    在应用程序结束时,要关闭帮助系统:

    helpSystem.shutdown(); 
  4. 要调用帮助(在必要时):
    helpSystem.displayHelp(); 

    还可以调用有关特定主要 TOC 文件或主题的帮助:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  5. 要启动上下文相关帮助,可调用 helpSystem.displayContext(contextId, x, y),其中 contextId 是全限定上下文标识。当前不使用屏幕坐标 x 和 y。

测试独立帮助

org.eclipse.help.standalone.Help 类有一个简单的主程序,您可以启动该程序并查看独立帮助如何出现在屏幕上。从命令行运行以下命令:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins
Copyright IBM Corp. and others 2000, 2002.