帮助系统打包为部署在应用程序服务器上的 Web 归档 (WAR) 文件。当启动或停止产品时,它会启动和停止。帮助系统包含可以手动更新的帮助内容。还可以将帮助系统配置为提供来自
ibm.com Web 站点的帮助内容,因此该内容始终是最新的。第三个选择是拥有内部网服务器提供的帮助内容。
定义
在帮助内容交付时使用了下列定义:
- 本地帮助
- 从主管产品的本地服务器或内部网服务器访问的帮助内容。还可以从计算机访问帮助。
- 远程帮助
- 从 ibm.com Web 站点访问或下载的帮助内容。
- 内部网帮助
- 从内部网服务器访问的帮助内容。该内容最初从 Web 下载到内部网服务器。
- 本地帮助更新程序
- 使用本地或内部网帮助时,此实用程序帮助您从 Web 下载最初的内容或更新的内容。
- 帮助更新程序站点
- 主管产品信息中心的 ibm.com 站点。可以使用浏览器或从产品帮助系统访问此站点。此站点也是本地帮助更新程序的源。
- 帮助下载站点
- Web 站点(http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/)包含用于填充本地或内部网帮助的产品帮助内容的压缩文件。此文件的格式为 prod_coden.n_updateSite.zip,其中
prod_code 是产品代码,而 n.n 是版本号。
简介
此产品提供可以独立于产品更新进行更新的帮助内容。缺省情况下,产品配置为对帮助内容进行本地访问,这意味着,帮助
Web 归档 (WAR) 文件包含所有帮助内容并且会在产品安装时安装。以下三个选项用于进行帮助内容访问(包括本地访问):
- 可以从主管产品的服务器访问内容。
- 可以从 Web 访问帮助内容。
- 可以从内部网服务器访问帮助内容。
在产品服务器上访问帮助内容
缺省选项会将帮助内容安装在主管产品的服务器上。
管理员:安装和配置:安装产品。不需要执行任何其他操作。
管理员:更新内容:通过使用帮助更新程序站点或帮助下载站点来手动更新内容。
用户:访问帮助:浏览至产品并开始使用该产品。在需要帮助时,请单击以在窗口中打开“帮助”。不需要执行任何其他操作。
从 Web 访问帮助内容
如果管理员已配置此选项,那么将通过 ibm.com Web
站点链接至产品信息中心。仅当与因特网连接之后,才能访问基于
Web 的产品帮助。在断开连接的情况下,可以访问有限数目的帮助主题。有关更多详细信息,请参阅“参考”下的“帮助内容”主题。
管理员:安装和配置:- 安装产品。
- 启动该产品和帮助。
- 删除帮助 WAR 文件中的现有帮助内容。
- 将远程帮助配置为指向该产品的公共信息中心。
管理员:更新内容:此内容始终是可用的最新信息。
用户:访问帮助:浏览至产品并开始使用该产品。在需要帮助时,请单击 以在窗口中打开“帮助”。
从内部网服务器访问帮助内容(企业解决方案)
根据公司的支持情况,也许您可以从内部的内部网服务器访问帮助内容。此方法假定内部网管理员已在防火墙后面建立指向安装有产品帮助内容的服务器的链接。通过选择此选项,您必须指定与内部网服务器的链接。管理员必须对帮助内容进行定期更新。
管理员:安装和配置:- 将产品安装在产品服务器上。
- 安装并配置内部网帮助。
- 启动该产品。
- 从帮助中删除现有内容。
- 通过使用在步骤 2 中使用的信息来将远程帮助配置为使用内部网服务器。
管理员:更新内容:通过使用帮助更新程序站点或帮助下载站点来在内部网服务器上手动更新内容。
用户:访问帮助:浏览至产品并开始使用该产品。在需要帮助时,请单击 以在窗口中打开“帮助”。不需要执行任何其他操作。