站内搜索: 请输入搜索关键词

当前页面: 开发资料首页 → Eclipse 专题 → 通过扩展 WebSphere Studio 工具的 Eclipse 帮助系统来添加自助支持

通过扩展 WebSphere Studio 工具的 Eclipse 帮助系统来添加自助支持

摘要: IBM WebSphere Studio 系列工具提供了广阔而有时又比较复杂的开发环境。在使用它的时候，您可能会遇到联机帮助中没有描述过的错误，或者需要执行联机帮助中没有提到过的任务。这时您可以向服务和支持中心寻求帮助，但经常是您所遇到的问题的答案已经存在于 Web 上的常见问题解答列表中了。您遇到的问题类型和使用的产品会影响您对于要到 Web 上的哪些地方去寻找这些常见问题解答的决定。

（C）Copyright International Business Machines Corporation 2003. All rights reserved.

引言

IBM? WebSphere? Studio 系列工具提供了一个广阔而有时又比较复杂的开发环境。在使用它的时候，您可能会遇到联机帮助中没有描述过的错误，或者需要执行联机帮助中没有提到过的任务。这时您可以向服务和支持中心寻求帮助，但经常是您所遇到的问题的答案已经存在于 Web 上的常见问题解答列表中了。您遇到的问题类型和使用的产品会影响您对于要到 Web 上的哪些地方去寻找这些常见问题解答的决定。

本文讨论的是 WebSphere Studio 工具的一个扩展，它能通过为您提供信息和一些工具来帮助您使用 WebSphere Studio Application Developer（以下称为“Application Developer”）和其他的 WebSphere Studio 工具。由于所有的 WebSphere Studio 工具都是基于 WebSphere Studio 工作台（WebSphere Studio Workbench）的，而该工作台又是基于开放性源代码的 Eclipse 框架的，所以通过使用 Eclipse 帮助的扩展功能部件很容易扩展该产品的文档。结果就是出现了一个不含代码的简单 Eclipse 插件，它不仅添加了支持信息主要来源的直接链接，而且还添加了一些当前产品常见问题解答的本地副本。因为它可以使用内置的 Eclipse Update Manager，所以您不用花什么力气就能定期更新它。

您可以 下载文中描述的代码样本 com.ibm.faq zip 。它已经用 Application Developer 版本 5.0 和其他的 WebSphere Studio 工具测试过，运行情况正如描述的那样，但是可能还不能用于该产品以后的版本。这个代码样本现在还不属于 Application Developer，而只是对将来版本所考虑的功能的一个技术预览。如果您有什么建议或是遇到什么问题，请给 Barry Searle 发电子邮件至 searle@ca.ibm.com。

虽然文中提到的 Update Manager 的一些方面目前只对 Application Developer 可用，但是可下载的代码样本却适用于所有基于 Eclipse 版本 2 的工具（Site Developer、Application Developer 集成版等等）。目前，您还不能用其他产品的 Update Manager 来访问产品的更新（将来您 可能会做到）。虽然本文也提供关于怎样下载和安装其他 WebSphere Studio 产品插件的信息，但它主要描述的还是如何使用 Application Developer 的插件。


<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

产品支持信息的来源

产品的支持站点

Application Developer 的联机帮助是搜索该产品支持信息的首选。如果您在那里没有获得您想要的答案，可以接下来试试个别产品支持站点：

常见问题解答和其他支持文档

其中每个支持站点都提供常见问题解答的搜索工具，例如 Application Developer 常见问题解答搜索。某些产品的支持站点，例如 WebSphere Application Server 的支持站点，还提供搜索其他类型文档的工具，这些文档包括提示和 技巧、技术说明、解决方案、白皮书和红皮书。某些产品将支持文档用一个小钥匙图标作标记 ，这表明您必须是一个有权享受 IBM 优惠促销的用户才能查看该文档。

产品中的“俄罗斯套娃”产品模型

假如您遇到了有关 Site Developer 的问题，并且在搜索 Site Developer 的常见问题解答时没有成功。由于 Site Developer 是包含在 Application Developer 中的，您的问题很可能在 Application Developer 中已经被报告并得到了解决，所以您还应该搜索更高级别的产品。同样，Enterprise Developer 包含集成版，而集成版又包含 Application Developer，所以您也应该针对较高级别的产品中遇到的问题来搜索较低级别的产品。

新闻组

如果还是找不到答案怎么办？对等信息的最佳来源是 WebSphere Studio 新闻组。有一些特定于产品的新闻组，例如：

和特定于主题的新闻组，例如：

要使用所有这些参考资料，您可以把本文加入书签，这样每当您有问题的时候就可以回过来查找各种支持文档来源。但是这种方法有些麻烦。如果 Application Developer 和其他 WebSphere Studio 工具可以集成这些信息以便从文档进行快速访问，那么您的搜索速度将会大大提高。我们的支持插件就为您完成了这个集成过程。


<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

获得该支持插件

下面的 可下载文件包含了该核心支持插件的一个副本 com.ibm.faq.zip 。下面的步骤将告诉您如何获得该插件，以便您能在任何相关产品中使用它：

  1. 关闭 WebSphere Studio。
  2. 下载该插件并将其解压缩至下面的 WebSphere Studio 产品目录： X:\ ws_Installdir\eclipse\plugins 中，其中 ws_Installdir 是您的 WebSphere Studio 的安装目录。
  3. 重新启动 WebSphere Studio。
  4. 该插件将自动被检测，并作为一本新的 支持信息书添加到该产品的联机帮助中。

如果您使用的是 Application Developer，那么还有另一个更好的方法获得该插件。您可以使用内置的 Update Manager，它将确保您能获得该支持插件的最新版本，同时也将安装您所选择的常见问题解答的副本作为您的本地文档的一部分。

Update Manager：背景信息

每当 Application Developer 运行的时候，您都能通过单击 Help => Software Updates => Update Manager来调用 Update Manager：

随即 Update Manager 透视图中的几个视图就会打开。Feature Updates 视图向您展现了 Update Manager 为查找产品更新将搜索的站点：

其中的一个站点就是 Application Developer Discovery 站点，通过它能获得产品更新和新技术预览（我们的支持插件就是一个例子）。您可以添加其他站点，诸如提供第三方独立软件供应商（Independent Software Vendor，ISV）工具的站点，但在本文中我们将仅使用缺省的 Application Developer 站点。

使用 Update Manager 来安装该支持插件

在 Feature Updates 视图中，右键单击 WebSphere Studio Application Developer 5.0 Support Information并选择 Show Details。Preview 视图被更新来显示关于 Support Information（Tech Preview）插件的信息：

单击 Install，Support information（Tech Preview）功能部件的安装就会开始进行：

单击 Next，接受许可条件，然后单击 Next => Finish => Install。该支持插件就会被安装，同时系统会提醒您重新启动 Application Developer，以便它能动态地检测和激活新插件。

一旦您重新启动了 Application Developer 并激活了该支持插件，那么如果您打开 Plug-in Registry 视图的话，您就会看到该支持核心插件已经被加载了，同时您将获得 WebSphere Studio 工具的支持信息（包含我们的搜索和问题的报告信息），以及 Application Developer 的支持信息（包含当前的常见问题解答）。


<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

使用该支持插件

  1. 在 Application Developer 的主菜单中，单击 Help => Help Contents：

    一本新的支持信息书被添加到了产品文档中：

  2. 查看这本支持信息书，请单击 Support information：

以上示例展示了带有各自支持内容的 WebSphere Studio 工具插件以及 WebSphere Application Server 插件。随着时间的推移，其他的 IBM 产品 可能会采用和实现这个支持插件技术预览，虽然它既不是一个计划声明也不是一种承诺。

问题的搜索和报告

选择第一个文档， Researching and reporting problems，显示关于自助支持信息的细节以及关于如何向 IBM Support 报告问题的信息：

来自 Web 的支持

选择第二个文档， Support on the Web，显示一个带有主要支持信息站点链接的页面，其中还包括一张提供 WebSphere Studio 工具的常见问题解答的搜索表单。

输入您的搜索词，选择一个具体的产品或版本号（可选），然后单击 Go。搜索结果就会在浏览器中列出：

Web 上的 WebSphere Application Server 支持

还有一个带有支持信息的 Application Server 插件。单击 WebSphere Application Server来访问它。这张 Support on the Web搜索页面如下：


<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

支持插件如何扩展 Eclipse 帮助系统

我们曾经提到过支持插件是不用代码实现的，您可能会对它的工作方式感到好奇。相当简单 － Eclipse 在启动时能动态地检测和激活插件。因此，如果您需要的话，只需在 Eclipse 的 plugins 目录中创建包含您自己的文档扩展（ com. mycompany.myfeature ）的插件就可以了。Websphere Studio 工具提供了一个完整的插件开发和测试环境，但即便如此，对于文档插件来说也不需要。要了解更多的详细信息，请参阅 eclipse.org 中的文章 Help -- Part 1: Contributing a Little Help (Revised for Eclipse 2.0)。


<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

结束语

本文描述了一个扩展 Eclipse 帮助系统（该系统支持所有的 WebSphere Studio 工具）的插件。该支持插件提供关于支持的常见问题解答的本地副本，以及关于问题确定、报告和远程搜索的信息。它能使相关的自助信息和其他开发信息的定位更加容易。本文还描述了如何使用新的 WebSphere Studio 工具，Update Manager。



<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

下载

<table width="100%" class="data-table-1" cellspacing="0" cellpadding="0" border="0"><tr><th>名字</th><th style="text-align:right;">大小</th><th>下载方法</th></tr><tr><td nowrap="nowrap">com.ibm.faq.zip</td><td style="text-align:right;" nowrap="nowrap">0.1 MB</td><td nowrap="nowrap">HTTP</td></tr></table><table cellspacing="0" cellpadding="0" border="0"><tr valign="top"><td colspan="5"></td></tr><tr><td></td><td>关于下载方法的信息</td><td></td><td></td><td>Get Adobe® Reader®</td></tr></table>
<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>


<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>

作者简介<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td colspan="3"></td></tr><tr align="left" valign="top"><td></td><td></td><td width="100%">

Barry Searle是 WebSphere Studio Application Developer Migration Team 的主管。他是一名专业的工程师，并在 IBM 加拿大实验室研究各种应用程序开发工具已有十多年。此前，他已有多年开发命令和控制系统以及领导复杂通信开发项目的专业经验。您可以通过 searle@ca.ibm.com与 Barry 联系。

</td></tr></table>
<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td colspan="3"></td></tr><tr align="left" valign="top"><td>

</td><td></td><td width="100%">

Ellen McKay 是 IBM 加拿大公司的一名信息开发人员。她编写了 WebSphere Studio Application Developer 的联机帮助和出版物。您可以通过 ecmckay@ca.ibm.com与 Ellen 联系。

</td></tr></table>

<table border="0" cellspacing="0" cellpadding="0" width="100%"><tr><td>
</td></tr></table><table class="no-print" cellspacing="0" cellpadding="0" align="right"><tr align="right"><td>
<table border="0" cellpadding="0" cellspacing="0"><tr><td valign="middle">
</td><td valign="top" align="right"></td></tr></table></td></tr></table>


↑返回目录
前一篇: 将 JUnit 插件集成到 WebSphere Studio 中
后一篇: Eclipse Voice Tools Project