安装帮助独立系统

如果正在创建并非基于 Eclipse 框架的应用程序,仍可使用 Eclipse 帮助系统。应用程序可以打包和安装独立帮助系统,它是一个非常小的 Eclipse 版本,包括除帮助系统之外的所有内容。然后,应用程序可从它的“帮助”菜单或用户界面对象进行 API 调用以启动帮助浏览器。帮助独立系统具有集成帮助系统的所有功能部件,但弹出信息和活动帮助除外。当应用程序不是基于 Java 的,或者应用程序未运行时需要帮助,则可能要从系统 shell、shell 脚本或桌面快捷方式使用独立的帮助,并提供命令行选项而不是调用 Java API。

帮助独立系统允许传递可用来定制帮助系统的各个方面的许多选项。下列选项是受支持的:

安装/打包

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

如何从 Java 调用帮助类

  1. 确保 d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar 在 app 类路径上。用来启动(start)、启动(launch)和关闭帮助系统的类是 org.eclipse.help.standalone.Help。
  2. 创建包含想要传递至帮助系统支持的选项的“字符串”数组。通常需要 eclipsehome 选项。
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. 在应用程序中,通过传递这些选项来创建 Help 类的实例。此对象应保留到应用程序结束为止。
    Help helpSystem = new Help(options); 
  4. 要启动帮助系统:
    helpSystem.start(); 
  5. 要调用帮助(在必要时):
    helpSystem.displayHelp(); 

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

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. 要启动上下文相关帮助,可调用 helpSystem.displayContext(contextId, x, y),其中 contextId 是标准上下文标识。当前不使用屏幕坐标 x 和 y。
  7. 在应用程序结束时,要关闭帮助系统:

    helpSystem.shutdown(); 

如何从命令行调用帮助

org.eclipse.help.standalone.Help 类具有一个 main 方法,该方法可用来从命令行启动独立帮助。命令行自变量语法为:

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

用来显示帮助的简单方法是从 d:\myApp\eclipse 目录中调用以下命令:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

。要显示特定 TOC 文件或主题,使用

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

用于显示帮助的上面两个调用将导致帮助系统启动、显示帮助并保持运行以允许用户在执行命令之后继续浏览帮助。要控制帮助系统的生命周期,除了 displayHelp 命令之外,还可使用 start 和 shutdown 命令。例如,可调用

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

[可选] 安装最小一组插件

独立帮助不需要整个“Eclipse 平台”包。可使用下列插件(它们位于 eclipse\plugins 目录中)运行独立帮助:

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

在 Windows 和 Linux 上,在最低配置基础上需要下列插件和段来提供健壮的浏览器支持(在 Windows 系统上需要嵌入了 SWT 的 Internet Explorer,在 Linux 上需要 Mozilla,或者在 Windows 上需要单机系统浏览器)。

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 或 org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

有些文档插件可能具有针对其它插件的依赖项,通常通过在它们的 plugin.xml 中指定必需的插件。同时还需要在信息中心上安装从属的插件。此外,设计用于 Eclipse 3.0 以前版本的插件以隐式方式要求具有 org.eclipse.core.runtime.compatibility 才能使插件正常工作。

有关定制帮助系统的更多信息,请参阅帮助系统首选项

org.eclipse.help.base 首选项