以离线方式查看文档

您可将在线显示的产品文档下载到计算机,然后以离线方式查看。

准备工作

查找并下载您要查看的产品文档。 可以从 https://public.dhe.ibm.com/software/webserver/appserv/library/ 服务器下载 WebSphere® Application Server 文档。 9.0.x 文档位于 v90 目录 https://public.dhe.ibm.com/software/webserver/appserv/library/v90/中。

服务器上还提供了其他 WebSphere Application Server 版本和产品的文档。

服务器还支持 FTP 和 FTPS,例如 ftp://public.dhe.ibm.com/software/webserver/appserv/library/。 您可以使用 FTP 下载软件来下载文件,而不是从浏览器下载文件。

有关此任务

对于 PDF 格式的文档,您可以在 PDF 阅读器中查看文件。

对于以压缩(.zip.jar)文件格式存储的 HTML 文件中的文档,您可以采用多种方式查看所下载的文档:

  • 在浏览器中查看各个 HTML 文件。

    可以从服务器下载产品文档,将下载的压缩 ZIP 或 JAR 文件解压缩,然后查看各个 HTML 文件。

    提示: 扩展名为 .jar 的文档文件 (例如 com.ibm.websphere.base.doc_9.0.0.jar ) 是扩展名为 .jar 的 ZIP 文件。 可以使用 unzip 实用程序来解压缩 .jar 文件内容,以直接访问和查看 HTML 文件。 或者,将 .jar 扩展名更改为 .zip,以访问 HTML 文件,而无需将压缩文件内容解压缩。

    某些产品文档文件包含站点地图或目录。 例如,com.ibm.websphere.express.doc_7.0.0.zip 文件在其 doc.zip 文件中的 htmlnav.html 文件中包含站点地图。 在解压缩 doc.zip 文件内容之后,您可以在浏览器中查看 htmlnav.html 文件,以查看 Express 7.0 文档目录以及指向各个 HTML 文件的链接。

  • 查看产品文档 在 Eclipse 或 WebSphere Developer Tools 中针对 Eclipse的所有 HTML 文件。
  • 在 IBM Knowledge Center Customer Installed (KCCI) 中查看产品文档的所有 HTML 文件。

    KCCI 是在 Liberty 或 WebSphere Application Server 服务器上运行的 Web 应用程序归档 (WAR 文件)。 对于此选项,您必须具有 Liberty 或 WebSphere Application Server 的许可证才能获取 KCCI WAR 文件,并且必须将 KCCI WAR 文件部署到服务器。

  • 查看产品文档的所有 HTML 文件 在 z/OS 的 Knowledge Center 中 (如果有 z/OS 2.2 或更高版本)。

在 Eclipse 或 WebSphere Developer Tools 中以本地方式查看文档

要查看 WebSphere Application Server V 9.0.0 和 Liberty 文档,可以使用最新发行版的 Eclipse 或 WebSphere Developer Tools。 本过程描述如何在 Windows 上使用 Eclipse for Java EE Developers (Oxygen) 来显示文档。 要查看 V 8.5.5 和更低版本的文档,您可能需要使用 Eclipse Classic

过程

  1. 安装 Eclipse 或 WebSphere Developer Tools for Eclipse。 您可以从 http://www.eclipse.org/downloads/获取 Eclipse 。 您可以使用 Eclipse 或 WebSphere Developer Tools 以本地方式查看文档。
    例如,完成以下步骤,以在 Windows 上安装 Eclipse for Java EE Developers (Oxygen)。
    1. 转至 https://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/oxygen2 ,并将 Eclipse IDE 下载到计算机上的临时目录。 IDE 具有诸如 eclipse-jee-oxygen-2-win32-x86_64.zip的名称。
    2. 在计算机上创建两个目录 eclipse_oxygeneclipse_workspace
    3. 将 Eclipse 氧气安装到 C:\eclipse_oxygen。 将 IDE eclipse-jee-oxygen-2-win32-x86_64.zip 文件解压缩到 C:\eclipse_oxygen 目录中。
  2. 在您的计算机上安装 Java SDK 8。
    提示: 如果您的计算机安装了 WebSphere Application Server V 9.0 或 V 8.5.5 ,那么可能已安装 Java SDK 8。 这些产品使用 Java SDK 8。 例如, Windows 上的 Java SDK 8 安装是 IBM 64 位 SDK for Windows , Java Technology Edition V 8。 如果已安装 Java SDK 8 ,请写下 javaw.exe 文件的路径。

    以下页面包含 IBM Java SDK 8 下载或安装指示信息:

  3. 如果从服务器下载了包含多个文档 ZIP , JAR 或目录的 ZIP 文件,请将下载的 ZIP 文件解压缩到临时目录中。 解压缩的 ZIP、JAR 或目录是插件

    例如,服务器 v90 目录上的 com.ibm.websphere.base.doc.zip 文件主要包含 .jar 文件。 com.ibm.websphere.base.doc_9.0.0.jar 文件是英语 WebSphere Application Server V 9.0 文档插件。 com.ibm.websphere.base.doc.nl1_9.0.0.jar 是本地语言或已翻译的 WebSphere Application Server V 9.0 文档插件。 这些插件用于先前版本的文档 ( https://www.ibm.com/docs/SSEQTP_9.0.5)。 其他解压缩文件提供 Javadoc、词汇表、OSGi、消息、安装、迁移、WIM 和服务映射 (SM) 文档插件。

    插件名称类似于您在联机文档 URL 中所看到的名称。 例如, WebSphere Application Server Javadoc https://www.ibm.com/docs/SSEQTP_9.0.5/com.ibm.websphere.javadoc.doc/web/apidocs/overview-summary.html 位于 com.ibm.websphere.javadoc.doc_9.0.0.jar 文件中,其插件名称为 com.ibm.websphere.javadoc.doc

  4. 将要查看的解压缩插件复制到 Eclipse 或 WebSphere Developer Tools 安装的 eclipse\plugins 目录中。

    例如,将 com.ibm.websphere.base.doc_9.0.0.jar 复制到 C:\eclipse_oxygen\eclipse\plugins。 至少需要将英语版 com.ibm.websphere.base.doc_9.0.0.jar 插件复制到 eclipse\plugins 目录。

    要获取翻译版,您还需要 com.ibm.websphere.base.doc.nl1_9.0.0.jar。 如果要查看 Javadoc、词汇表、OSGi、消息、安装、迁移、WIM 和服务映射 (SM) 文档,那么还需要将 com.ibm.websphere.base.doc.zip 中的其他插件复制到 eclipse\plugins 目录。

    Eclipse 或 WebSphere Developer Tools 不需要 .properties 文件。 请勿将 .properties 复制到 eclipse\plugins 目录中。 .properties 文件适用于 KCCI。

  5. 启动 Eclipse 或 WebSphere Developer Tools。

    例如,如果将 IBM SDK for Java 8.0.5.10 安装在 c:\jdk_80510 中,那么您可以从命令行搭配该 Java 8 和 -clean 选项运行 Eclipse Oxygen。

    1. 打开命令行,并转到 Eclipse 安装目录。
      cd C:\eclipse_oxygen\eclipse
    2. 从 Eclipse 安装目录中的命令行,使用 -vm-clean 选项启动 Eclipse 。
      eclipse -vm c:\jdk_80510\jre\bin\javaw.exe -clean
  6. 当 Eclipse 启动时,选择要使用的工作空间,然后单击 启动

    例如,选择 C:\eclipse_oxygen_workspace 或者您为该工作空间创建的任何目录。 然后,单击 启动

  7. 在 Eclipse中,单击 帮助> 帮助内容。 复制到 eclipse\plugins 目录的文档显示在内容中。

    例如,目录下的 WebSphere Application Server(分布式操作系统和 IBM i)V9.0com.ibm.websphere.base.doc_9.0.0.jar 插件。

    Eclipse 中的文档
  8. 要在浏览器中查看文档,请右键单击文档中 内容 下的文件,然后选择在新窗口中打开。

    例如,右键单击 WebSphere Application Server(分布式操作系统和 IBM i)V9.0 > 在新窗口中打开

    如果 Eclipse 安装架构是在可供其他人员访问的服务器上运行,您可以将浏览器 URL 发送给他们,这样他们也可以查看该文档。

    要查看翻译版本,请在 URL 末尾添加 &lang=**?lang=**,并按 Enter 键。 例如,要查看法语版,请使用 &lang=fr?lang=fr。 有关如何查看翻译版本的具体信息,请参阅 Eclipse 文档。

    如果翻译版本没有显示在 Eclipse 帮助中,请使用命令文件来打开和关闭文档。

    1. C:\eclipse_oxygen\eclipse\plugins 目录中找到 org.eclipse.help.base_N.N.N.vNNN.jar 文件,其中 N.N.N.vNNN 引用您下载的 Eclipse 版本。 对于 Eclipse Oxygen,文件名为 org.eclipse.help.base_4.2.102.v20171130-0510.jar
    2. C:\eclipse_oxygen 目录中,创建一个文件,并将其命名为 ic_start.cmd。 使用文本编辑器,在该文件中添加以下命令。 请确保 -classpath 值指定安装架构中 org.eclipse.help.base_N.N.N.vNNN.jar 文件的路径。 并且,请指定 Eclipse 的侦听器端口。 在此示例中,端口号为 8680。
      java -classpath eclipse\plugins\org.eclipse.help.base_4.2.102.v20171130-0510.jar  org.eclipse.help.standalone.Infocenter -eclipsehome eclipse -port 8680 -command start -noexec -clean
    3. C:\eclipse_oxygen 目录中,创建一个文件,并将其命名为 ic_stop.cmd。 使用文本编辑器,在该文件中添加以下命令。 请确保 -classpath 值指定安装架构中 org.eclipse.help.base_N.N.N.vNNN.jar 文件的路径。
      java -classpath eclipse\plugins\org.eclipse.help.base_4.2.102.v20171130-0510.jar  org.eclipse.help.standalone.Infocenter -eclipsehome eclipse -command shutdown
    4. 通过双击文件名或者从命令行运行命令,运行 ic_start.cmd 文件。 这将打开命令窗口,该窗口会保持打开,直至您运行 ic_stop.cmd 文件为止。
    5. ic_start.cmd 文件运行时,请使用浏览器访问 http://localhost:port_number/help/index.jsp,以打开计算机上的文档。 在本例中,URL 如下所示:http://localhost:8680/help/index.jsp
    6. 要查看翻译版本,请在 URL 中指定语言参数。
      1. 从文档中选择要查看的主题。
      2. 右键单击该主题,并选择在新窗口或选项卡中打开链接。 新窗口或选项卡的 URL 会指向特定的文档主题。
      3. 请在 URL 末尾添加 &lang=**?lang=**,并按 Enter 键。 例如,要在 Eclipse Oxygen 中查看法语版,请将 &lang=fr 添加到主题 URL 末尾,然后按 Enter 键。
      Eclipse 中的法语文档

    您可以搜索文档。 请在搜索字段中输入搜索字符串,并单击执行。 第一次执行搜索时,建立索引的过程要花费几分钟才能完成。 建立索引后,搜索通常只需几秒即可完成。

使用 Eclipse Classic 查看旧文档

如果 WebSphere Application Server V 8.5.5 和更低版本的文档未显示在 Eclipse 安装中,请考虑安装 Eclipse Classic 版本。 Eclipse Classic 是提供有集成 Eclipse 帮助系统 (IEHS) 的最新 Eclipse 版本。

  1. 下载 Eclipse Classic 4.2.2 (Juno)。 此示例使用 Windows 64 位文件。
  2. 创建 c:\eclipse_classic_422 目录,并将下载的 eclipse-SDK-4.2.2-win32-x86_64.zip 文件解压缩到该目录中。
  3. 创建 c:\eclipse_classic_juno_workspace 目录。
  4. 从服务器下载文档文件。 将文档插件放到 c:\eclipse_classic_422\eclipse\plugins 目录中。 请勿将 .properties 文件放在 eclipse\plugins 目录中。 有关更多信息,请参阅有关 插件将文件复制到 eclipse\plugins 目录的步骤。
  5. 打开命令窗口并移至 c:\eclipse_classic_422 directory\eclipse 目录。
  6. 从命令行,运行使用 Eclipse Classic 所需的 JDK 的命令。 对于此示例, c:\jdk 目录中的 JDK 是 IBM 64 位 SDK for Windows AMD64/EM64T 体系结构 Java Technology Edition V 6。
    eclipse -vm c:\jdk\jre\bin\javaw.exe -clean
  7. 选择将 c:\eclipse_classic_juno_workspace 目录用于工作空间。
  8. 在 Eclipse 中,选择帮助 > 帮助内容
  9. 要查看翻译版,请将 &lang=** 添加到 URL 末尾,然后按 Enter 键。 例如,要查看法语版,请使用 &lang=fr

    文档的本地语言 (nl) 或翻译版插件必须与英语版插件一起位于 eclipse\plugins 目录中。

在 Knowledge Center for z/OS 中以本地方式查看文档

过程

  1. 配置 Knowledge Center for z/OS
  2. WebSphere Application Server 文档创建 /global/kc4z/data/content 的子目录。 例如,对于 WebSphere Application Server for z/OS Version 9.0 文档,创建 /global/kc4z/data/content/waszos900 目录。 有关更多信息,请参阅 在 Knowledge Center for z/OS中管理产品文档内容
  3. 从服务器下载您想要查看的文档。 可下载的 ZIP 文件包含多个文档 ZIP、JAR 或目录。 请将下载的 ZIP 文件解压缩到您创建的 /global/kc4z/data/content 子目录中。 解压缩的 ZIP、JAR 或目录是插件

    例如,将位于 https://public.dhe.ibm.com/software/webserver/appserv/library/v90/ 的服务器 v90 目录中 com.ibm.websphere.zseries.doc.zip 文件的内容解压缩到 /global/kc4z/data/content/waszos900 目录中。

    com.ibm.websphere.zseries.doc.zip 文件主要包含 .jar 文件。 com.ibm.websphere.zseries.doc_9.0.0.jar 文件是英语 WebSphere Application Server for z/OS V 9.0 文档插件。 com.ibm.websphere.zseries.doc.nl1_9.0.0.jar 是本地语言或翻译的 WebSphere Application Server for z/OS V 9.0 文档插件。 这些插件用于先前版本的文档 ( https://www.ibm.com/docs/SS7K4U_9.0.5)。 其他解压缩文件提供 Javadoc、词汇表、OSGi、消息、安装、迁移、WIM 和服务映射 (SM) 文档插件。

    插件名称类似于您在联机文档 URL 中所看到的名称。 例如, WebSphere Application Server Javadoc https://www.ibm.com/docs/SS7K4U_9.0.5/com.ibm.websphere.javadoc.doc/web/apidocs/overview-summary.html 位于 com.ibm.websphere.javadoc.doc_9.0.0.jar 文件中,其插件名称为 com.ibm.websphere.javadoc.doc

  4. 为文档配置 .properties 文件。 将 .properties 文件放在 /global/kc4z/data/content 目录中。 请参阅 在 Knowledge Center for z/OS中管理产品文档内容

    com.ibm.websphere.zseries.doc.zip 文件包含 2 个 .properties 文件,这些文件可供您编辑并用于 Knowledge Center for z/OS。 比较容易使用的 .properties 文件是 no_ditamap.properties。 对于 WebSphere Application Server for z/OS V 9.0 文档,请将 product 值设置为 SS7K4U_9.0.0 ,并将 path 值设置为包含插件的目录 /global/kc4z/data/content/waszos900

    提示: 您可以将所有 WebSphere Application Server 文档的插件放在 /global/kc4z/data/content/waszos900 目录中,并使用 no_ditamap.properties 文件来查看许多产品的文档。

    另一个属性文件 SS7K4U_9.0.0.properties 要求 /global/kc4z/data/content/waszos900 目录包含 as_ditamaps 子目录,该子目录提供产品 .ditamap 文件。 您可以从 900_WAS_as_ditamaps.zip 文件或服务器上的 900_WAS_all_product_doc.zip 文件获取 as_ditamaps 子目录的文件。 确保 SS7K4U_9.0.0.properties 文件将 path 值设置为插件所在的目录。 toc 值已设置为主地图。

  5. 为文档配置 KC_taxonomy.ditamap 。 请参阅 在 Knowledge Center for z/OS中管理产品文档内容

    确保 KC_taxonomy.ditamap 包含对应于 SS7K4U_9.0.0subjectdef 元素。 对于所有 WebSphere Application Server 产品,服务器 v90 目录中的 900_WAS_properties_files.zip 文件具有带有 subjectdef 元素的 KC_taxonomy.ditamap 文件。

  6. 停止并重新启动 Knowledge Center for z/OS 服务器。
  7. 将 Web 浏览器指向 http://host_name:9080/zos/knowledgecenter/ URL。