WEB开发网
开发学院软件开发Java 使用定制 Eclipse 信息中心为 IT 解决方案编制文档... 阅读

使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更

 2010-03-11 00:00:00 来源:WEB开发网   
核心提示:概述Toolkit for Custom and Reusable Solution Information 支持收集几种不同类型的内容来在一个定制的解决方案信息中心发表,内容可以包括 Web 页;本地文件,使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更,比如办公

概述

Toolkit for Custom and Reusable Solution Information 支持收集几种不同类型的内容来在一个定制的解决方案信息中心发表。内容可以包括 Web 页;本地文件,比如办公文档;RSS 和 ATOM 提要;导出的 Lotus Notes® 文档;以及 Eclipse 文档插件(即工具箱内的 “books”)。

对于某些内容类型,您可以包括进内容的一个副本或对内容所在位置(比如 Web 站点或 wiki)的链接。下表总结了每个内容类型各支持哪些方式。

内容的类型可否包括一个对内容的链接可否包括内容的一个副本
Web 页面
文件(演示、展示、示例)
提要
Notes(导出了的 Lotus Notes 文档)
Books(Eclipse 文档插件)

包括对 Web 页的链接

在本系列之前的部分中,在为一个 Web 页面提供一个链接时,可以给这个页面配置一个描述,例如页面的标题、URL、摘要和关键字。这个描述用来为解决方案信息中心生成一个 HTML 页面。所生成的这个页面提供对托管在别处的 Web 页面的链接。

例如,图 1 中展示了这样一个生成的页面,它提供了对 Rational® Edge 杂志最新版本的链接。第二个浏览器窗口则显示了当用户单击这个 URL 格式的链接时页面的样子。

图 1. 链接到一个 Web 页面
使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更

所生成的这个页面很直白,这是因为工具箱用户只需极少的时间就能提供对这个 Rational Edge 的描述。但是,链接到 Web 页面的一个优势就是您可以个性化这个描述以满足您的信息中心用户的需求。例如,如果要把这个信息中心交付给一个特定的用户,您就可以预先设计您所链接到的这个页面如何适应该用户的 IT 项目。

配置一个 Web 页面的链接

可以使用如下说明来包括对 Web 页面的链接,以使您的信息中心总能引用 Internet 或您公司或客户的内部网上的最新内容。请确保您的信息中心的接收者具有对您所链接到的那些站点的访问权。

浏览到一个在线的 Web 页面。

从菜单栏选择 Window > Show View > Web Pages。这个 Web Pages 选项卡页会被显示到最前面。

单击 Add Web Pages 图标。

在 Add Web Pages 向导中,选择一个用来管理内容的组,例如 Default。

指定一个在导航中显示的名称,例如 “IBM home page”。

指定或浏览到一个 URL,例如 http://www.ibm.com。

请确保选中 Create link to page。

单击 Add Web Pages 向导中的 Next。

可选地,也可以为将这个 Web 页介绍给用户的页面指定信息。

指定一个标题以显示在页面上。

指定一个描述以帮助用户决定是否要查看这个 Web 页面。

指定发布者信息。

指定信息中心搜索可以用到的关键字。

单击 Finish。

在工具箱中找到这个 Web 页面并将它拖入导航模板中。

返回到 Web Pages 选项卡页面。

双击灰色栏进入 Web 页面被分配到的组。

通过指定的标题找到这个 Web 页面。

选择这个 Web 页面。

将这个 Web 页面拖放到导航模板内的一个位置。

包含 Web 页面的副本

当提供 Web 页面的一个副本时,这个页面的内容将被直接显示在解决方案信息中心的内容框架内,如图 2 所示。当用户单击这个页面上的一个链接时,页面行为取决于您在保存这个页面时指定的深度,正如此系列文章的 使用定制 Eclipse 信息中心为 IT 解决方案编制,第 2 部分:提升您捕捉和重用内容的能力 中所描述的一样。如果您在一个单一深度捕捉到了页面,那么这个页面上的链接将会指向从中捕捉到该页面的那个活动站点。这样,用户将会导航这个 Web 站点,而不是导航来自这个站点的某个页面的副本。

图 2. 包含 Web 页面的一个副本
使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更

配置 Web 页面的一个副本

可以使用如下说明保存 Web 页面的本地副本,当您的信息中心需要被离线使用或当您想要保留一个内容的快照来确保它仍能与您的 IT 解决方案中所使用的规范相匹配时,这是一个很好的方法。

浏览到一个在线的 Web 页面以便保存它的一个本地副本。

从菜单栏选择 Window > Show View > Web Pages。这个 Web Pages 选项卡页面就被显示到了最前面。

单击 Add Web Pages 按钮。

在这个 Add Web Pages 向导中,选择一个用来管理内容的组,比如 Default。

指定一个在导航内显示的名字,比如 “IBM home page”。

指定或浏览到一个 URL,比如 http://www.ibm.com。

选择 Download page content。

指定一个深度,比如:

深度 1 保存此页面、它的图像及样式信息。

深度 2 保存此页面以及它链接到的那层页面。

深度 3 表示保存页面、该页面链接到的那层页面以及该层页面链接到的那些页面。

单击 Add Web Pages 向导内的 Finish。

在工具箱内找到这个 Web 页面并将它拖入导航模板。

返回到 Web Pages 选项卡页面。

双击这个 Web 页面被分配到的那个组的灰色栏。

通过为它指定的标题找到这个 Web 页面。

选定这个 Web 页面。

将这个 Web 页面拖放到导航模板内的一个位置。

选择是否包括链接、副本或二者都包括

如果您熟悉面向对象的编程,那么包含一个对内容的链接与为变量使用 “通过引用传递(pass by reference)” 很类似。只不过这里提供的是一个对原始内容的指针。每当用户通过这个指针(链接)连接到内容时,用户很可能会发现内容已经变了。提供内容的一个副本与使用 “通过值传递(pass by value)” 很相似。副本与对原始内容的改变并不保持同步。然而,与原始内容相比,副本可以针对使用它的上下文被定制。

下面的表格总结了使用内容链接或内容副本的利弊。这些选项并不是互斥的。假设您要包含内容的一个副本作为一个实时快照,特别是对于类似编程规范级别的内容。您可能还想要包括一个对此规范的链接以便让用户可以很容易地访问最新版本。

利弊链接到其他地方的内容包含内容的副本
好处  将用户导航到内容的最新版本

让您可以提供一个对内容的个性化介绍

  捕捉内容的一个精确版本

为信息中心搜索提供全文索引

支持离线使用

顾虑  不必匹配用户需要的版本

提供有限的搜索索引(只有标题、摘要、关键字)

不支持离线使用

  内容的副本有可能过时

用 RSS 提要保持站点常新

在提供 RSS 提要时,信息中心用户就会收到一个对 Web 页面或其他在线文档的链接列表,如图 3 所示。这个列表会不断更新,基于的是在其中订阅了提要的那个 Web 站点上的发布行为。这样一来,即使您将一个信息中心交付给其接收者并且不再对之进行更新,它都将得到最新的内容补充,包括对在交付解决方案信息中心时尚未发布的内容的链接。

图 3. 包括一个 RSS 提要
使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更

配置一个 RSS 提要

配置一个提要最困难的部分也许就是确定这个提要的 URL。(顺便说一下,图 3 内所示提要的 URL 是 http://www.redbooks.ibm.com/rss/rational.xml。)

很多提供 RSS 提要的 Web 站点使提要配置变得非常简单。比如,IBM® developerWorks® 就提供了一个页面,其上列出了 现成的 RSS 提要,包括为刚接触 RSS 提要的那些人准备的简介。如果单击了一个提要的链接,例如 developerWorks 主页,这个提要就会在另外一个单独的浏览器窗口内启动,从这个窗口的地址栏,就能够获得此提要的 URL。

确定了 URL 后,在工具箱内配置一个提要与配置一个 Web 页面非常类似,只不过要使用 Feeds 选项卡页面。

从菜单选择 Window > Show View > Feeds。

在 Feeds 选项卡页面单击 Add RSS feeds 图标。

为这个提要指定组、名称和地址,然后单击 Next。

为显示提要结果的页面指定标题、作者和描述。

单击 Finish。

在 Feeds 选项卡页面,在提要被分配到的组中选择提要。

将提要拖放到导航模板内的一个位置。

用查询保持站点常新

也许,您会认为对一个 Web 页面的链接并不必须是对一个特定页面的链接,而可以是一个能启动对站内多个页面的搜索的 http:// 链接。比如,如图 4 所示,您可以配置对 IBM developerWorks 教程库的搜索。这个搜索寻找目前与在这个 Web 页面链接内建立的原始搜索条件相匹配的所有可用教程。

图 4. 包括一个能启动搜索的链接
使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更

配置一个搜索

寻找能执行搜索的 URL 要比为一个 RSS 提要寻找 URL 需要更多技巧。由于 Web 站点间差异太大,很难一言蔽之,但是有一种方式是在站点上直接执行搜索,然后再看看是否能从地址栏捕捉到结果 URL。确定了结果 URL 之后,再在工具箱内配置一个搜索,所需步骤与之前所描述的配置其他的 Web 页面的步骤相同。图 5 显示了在工具箱内对图 4 的配置。

图 5. 配置能够启动一个搜索的链接
使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 3 部分: 预见并管理重用内容的变更

决定使用直接链接、查询还是提要

直接链接到一个页面提供查询提供提要
  每次提供相同的结果(一个特定的页面)

捕捉对单个页面内容的更新

结果的质量取决于站点维护单个页面的程度

  提供一个详尽的、可随时间变化的结果集

捕捉满足您搜索条件的所有页面,包括新添加的页面

结果的质量取决于站点为了获得可搜索性而对页面进行分类的程度

  只提供最新结果

捕捉最新发布的新页面(忽略较老的页面)

结果的质量取决于提供提要的这个站点的编辑判断

法律考虑

这个工具箱提供了一种简便的方式来组装一个包含原始和重用内容的 Web 站点,供在桌面、公司内部网或是互联网上使用。但是,请首先明确您是否有重用和传播这些内容的合法授权以及如何获得合法授权。若对重用内容有任何疑问,请咨询您的法律顾问。若从某些网站捕捉了内容,尤其是打算将这些内容再转发给您的客户,请务必先查阅该网站的使用条款。若您想要对从他处得来的内容向客户收取费用,那么您很可能需要先得到对方的书面许可。

Tags:使用 定制 Eclipse

编辑录入:爽爽 [复制链接] [打 印]
赞助商链接