安装帮助独立系统

如果正在创建并非基于 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_2.1.0\help.jar 位于应用程序类路径中。用来启动(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] [-host helpServerHost] [-port helpServerPort] [-servertimeout timeout] [platform options] [-vmargs JavaVMarguments]

显示帮助的一个简单方法是从 d:\myApp\eclipse 目录中调用

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

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

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.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_2.1.0\help.jar org.eclipse.help.standalone.Help -command start

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

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

org.apache.lucene
org.apache.xerces
org.eclipse.core.boot
org.eclipse.core.resources
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.update.core

除了这些插件之外,视操作系统或机器体系结构的不同,您可能还需要为上述插件(当它们存在时)安装相应的段。例如,在 Windows 上,需要添加下列段(它们也位于 eclipse\plugins 目录中):

org.eclipse.core.resources.win32
org.eclipse.update.core.win32

在 Windows 上,可通过在最小配置基础上添加下列插件和段来提供另一个帮助浏览器(SWT 嵌入式 Internet Explorer Web 浏览器):

org.eclipse.help.ui.win32
org.eclipse.help.ui
org.eclipse.jface.text
org.eclipse.jface
org.eclipse.search
org.eclipse.swt.win32
org.eclipse.swt
org.eclipse.text
org.eclipse.ui.editors
org.eclipse.ui.views
org.eclipse.ui.win32_2.1.0 org.eclipse.ui.workbench.texteditor
org.eclipse.ui.workbench
org.eclipse.ui

Copyright IBM Corporation and others 2000, 2003.