将帮助系统作为信息中心安装

可以通过在服务器上安装信息中心和文档插件来允许用户通过因特网或内部网访问帮助系统。客户机通过导航至 URL 来查看帮助,而帮助系统会显示在它们的 Web 浏览器中。信息中心帮助系统可用于客户机应用程序和 Web 应用程序,对于每种应用程序,都可以远程方式访问其帮助。除弹出信息和活动帮助之外的帮助系统的所有功能部件都受支持。

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

安装/打包

这些步骤用于帮助系统集成器,但并不表示能解决所有可能的情况。假定如下:所有文档都是作为 Eclipse 插件交付的并且通常您熟悉 Eclipse 帮助系统。

  1. www.eclipse.org 下载“Eclipse 平台运行时二进制文件”驱动程序。
  2. d:\myApp 目录中安装(解压缩)该驱动程序。这将创建一个 Eclipse 子目录(d:\myApp\eclipse),它包含 Eclipse 平台(它包括帮助系统)所必需的代码。

如何从命令行启动或停止信息中心

org.eclipse.help.standalone.Infocenter 类有一个 main 方法,您可以使用该方法来从命令行启动信息中心。命令行自变量语法为:

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

要在端口 8081 上启动信息中心,通过运行以下命令发出启动命令

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

要关闭信息中心,通过运行以下命令发出关闭命令

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

使用信息中心

启动 Web 服务器。使 Web 浏览器指向在启动信息中心时指定的端口上 Web 应用程序运行的路径“help”。在安装了信息中心的机器上,这将是 http://localhost:8081/help/。

如何从 Java 启动或停止信息中心

当将信息中心包括为另一应用程序的一部分时,使用 Java API 而不是使用系统命令来启动或停止信息中心可能会更方便。如果是这种情况,则遵循下列步骤:

  1. 确保 d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar 在 app 类路径上。用来启动和关闭信息中心的类是 org.eclipse.help.standalone.Infocenter。
  2. 创建包含想要传递至信息中心的选项的“字符串”数组。通常需要 eclipsehome 和 port 选项。
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. 在应用程序中,通过传递这些选项来创建 Help 类的实例。
    Infocenter infocenter = new Help(options); 
  4. 要启动帮助系统:
    helpSystem.start();
  5. 要关闭信息中心:

    helpSystem.shutdown(); 

使信息中心在 Web 上可用

Eclipse 包含完整的信息中心并且不需要其它服务器软件就可运行。但是,在不安全环境(如因特网)中,建议不要通过客户机直接访问信息中心,而是通过 HTTP Server 或应用程序服务器来访问信息中心。大多数服务器附带有用于代理对其它 Web 资源的某个请求的模块或 servlet。例如,用户可配置 Apache HTTP Server 的代理模块来将对 http://mycompany.com/myproduct/infocenter 的请求重定向至运行信息中心的 http://internalserver:8081/help。将以下行

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

添加至运行 mycompany Web 站点的 Apache 服务器的 conf/httpd.conf 文件就行了。

某些版本的 Apache HTTP Server 可能包含在配置文件中已启用的 AddDefaultCharset 伪指令。除去伪指令或者替换为

AddDefaultCharset Off

以便让浏览器使用正确的字符集来显示文档。

运行信息中心的多个实例

可以在一台机器上通过一个安装来运行信息中心的多个实例。已启动的每个实例必须使用它自己的端口并为每个实例提供工作空间,因此,必须指定 -port-data 选项。通过使用 -configuration 选项提供有效的平台配置,实例可以从不同的插件集提供文档。

如果未使用 -configuration,并且配置目录被多个信息中心实例共享,具有重叠的语言环境集,则必须确保在一个信息中心实例创建了所有搜索索引之后才启动另一个实例。索引被保存在配置目录中,而写访问权在信息中心进程之间不同步。

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

信息中心不需要整个“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

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

使用从命令行更新正在运行的信息中心主题中说明的命令,用户可以在不重新启动信息中心的情况下更新信息中心插件。要使用此功能,最小组件集必须包括 org.eclipse.update.core 插件。

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