帮助系统打包为部署在应用程序服务器上的 Web 归档 (WAR) 文件。当启动或停止产品时,它会启动和停止。帮助系统包含可以手动更新的帮助内容。还可以将帮助系统配置为提供来自 ibm.com® Web 站点的帮助内容,以使该内容始终是最新的。第三个选择是拥有内部网服务器提供的帮助内容。
定义
在帮助内容交付时使用了下列定义:
- 本地帮助
- 位于主管产品的本地服务器上或位于内部网服务器上的帮助内容。还可以从计算机访问帮助。
- 远程帮助
- 位于 ibm.com Web 站点或其他正式信息中心站点(如 jazz.net)上的帮助内容。
- 内部网帮助
- 位于内部网服务器上的帮助内容。该内容最初从 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 中使用的信息来将远程帮助配置为使用内部网服务器。
管理员:更新内容:通过使用帮助更新程序站点或帮助下载站点来在内部网服务器上手动更新内容。
用户:访问帮助:浏览至产品并开始使用该产品。当您需要帮助时,请单击 以在窗口中打开“帮助”。不需要执行任何其他操作。