内容


使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 2 部分

提升您捕捉和重用内容的能力

Comments

系列内容:

此内容是该系列 # 部分中的第 # 部分: 使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 2 部分

敬请期待该系列的后续内容。

此内容是该系列的一部分:使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 2 部分

敬请期待该系列的后续内容。

概述

使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 1 部分:创建您的第一个信息中心 中,您创建了自己的第一个解决方案信息中心,内含一个文件。在掌握了基础知识后,您就可以开始学习加速内容库内的文档的积累的技巧了,首先要做的是导入一个满载内容的示例解决方案信息项目。

从另外一个工具箱的用户导入内容

积累内容的第一种快捷途径是导入由其他用户创建的解决方案信息项目。若您的团队中有任何人捕捉到内容,那么团队中的所有人均可重用此内容。导入一个解决方案信息项目的好处是通过一个操作就可以向内容库添加各种类型的多个文档。内容在您的新的和已有的解决方案信息中心项目内均可重用。您还可以获得其他用户的解决方案导航视图,您可以重用或不使用这个视图。

要练习如何导入一个解决方案信息项目:

  1. 从本文的 下载 部分下载 TKCARSI-SAMPLE.zip 文件。
  2. 在工具箱内,从菜单栏选择 File > Import project。出现 Import Solution information project 对话框。
  3. 找到要下载的这个示例解决方案信息项目 TKCARSI-SAMPLE.zip。
  4. 返回到 Import Solution information project 对话框,单击 Finish。工具箱将会报告说它正在扫描这个项目。
  5. 当工具箱显示一个对话框,列出将被包含或覆盖的内容时,查阅这个列表,然后单击 OK
  6. 查看进度条。通常,可以不理会所显示的任何错误消息。

如图 1 所示,在项目导入后,工具箱将会打开它的导航树。如果您不想现在就开始处理这个项目,也可以关闭这个导航树(File > Close project)。项目的内容已经添加到您的内容库以便在任何解决方案信息项目中都可使用。所导入的项目现在可以通过 File > Open project 获得。

图 1. 示例解决方案信息项目预览
示例解决方案信息项目预览
示例解决方案信息项目预览

搜索并捕捉 IBM.com 内容

积累内容的第二种快捷途径是使用该工具箱的内置 IBM® Support Assistant,以从 IBM 站点大批量地搜索和捕捉内容。您可以捕捉 Web 页面的副本或到这些页面的链接。

要用来自 IBM.com 的内容填充工具箱内容库,可以执行下面的操作:

  1. 获取一组搜索结果。
    1. 在工具箱菜单栏中,单击 Search > Search the Internet
    2. 当出现 Search Wizard 对话框时,在其中选择您的搜索目标。这个工具栏将要搜索的内容是 IBM Web 站点的一部分。在默认状态下,所有可能的目标都会选中。不过,选择的搜索目标越少,搜索速度就越快。因此,取消除 IBM developerWorks 之外的所有其他的搜索目标。
      图 2. 搜索目标
      显示搜索目标的图像
      显示搜索目标的图像
    3. 在搜索框中,输入想要搜索的关键词。请注意 Advanced Search 选项,它可以让您细化对每个目标的搜索,例如将搜索限定在 IBM 产品的某个特定品牌。作为尝试,输入 “cloud computing” (不带引号)作为搜索关键词。
      图 3. 搜索对话框
      显示搜索对话框的图像
      显示搜索对话框的图像
    4. 单击 Go! 按钮。工具箱会报告搜索结果,请留意查看。
  2. 选中您可能 想要保留在工具箱中的那些搜索结果。在后续的这个步骤中,将要正式地进行选择。
    1. 在 Search Results 区域,单击一个品牌的名字,例如 Information Management。
      图 4. 搜索结果
      显示搜索结果的图像
    2. 浏览这些搜索结果,选择您想要为您的解决方案信息中心捕捉的那些文章。练习一下,单击 Select All 来获取前 10 个结果。
      图 5. 搜索结果的选择
      显示搜索结果的选择的图像
      显示搜索结果的选择的图像
    3. 结束搜索结果的浏览和选择后,单击 Next。所选择的这些结果被显示在 Search Wizard 对话框的内容库页面的 Save 搜索结果中。
  3. 根据明确 希望保留的搜索结果,缩小选择范围。
    1. 在 Search Results Selected 区域中,选择确实想要保留的几个搜索结果。要想一次选中多个结果,请在单击每个结果时,同时按住 Control 键。
      图 6. Search Results Selected 区域
      显示 Search Results Selected 区域的图像
      显示 Search Results Selected 区域的图像
    2. 根据需要,可以在 Search Results to Save 区域中选择想要在其中保存结果的那个内容组。内容组类似于用来分类存放可重用内容的小抽屉。
    3. 准备好后,单击 Add > 将选中的结果保存在所选中的这个内容组中。
      图 7. Search Results to Save 区域
      显示 Search Results to Save 区域的图像
      显示 Search Results to Save 区域的图像
  4. 对于想要保存的结果,可以保存这些 Web 页的副本,也可保存指向 Web 页的链接。

    使用 Search Results Selected 区域下的单选按钮。

    • 要想保存指向这些页面的链接,单击 Create a link to the Web page。
    • 要想保存副本,选择 Download the Web page content 并指定一个页面深度。例如:
      • 深度 1 表示保存的页面包括页面的图片和样式信息。
      • 深度 2 表示保存页面及其所链接的那层页面。
      • 深度 3 表示保存页面、该页面链接到的那层页面以及该层页面链接到的那些页面。
  5. 最终完成搜索结果的捕捉。
    1. 单击 Finish。Retrieving Web Pages 对话框将会告知您进展的情况。
    2. 在捕捉结束后,查看内容库针对这些新页面的 Web Pages 选项卡页面。您现在可以将它们拖放进解决方案信息项目的导航树内了。
      图 8. 搜索结果显示在内容库中
      表明搜索结果显示在内容库中的图像
      表明搜索结果显示在内容库中的图像

      根据搜索目标,有时除 Web 页的标题和链接之外,工具箱还可以捕捉到一些细节。例如,如果单击编辑 Web 页面属性,就会注意到描述已被从 IBM developerWorks 文章中捕捉到,并且关键字字段反映了您的搜索关键词。
      图 9. 搜索结果的细节已被填充
      显示搜索结果的细节已被填充的图像
      显示搜索结果的细节已被填充的图像

添加包含 IBM 产品文档的插件

积累可重用内容的第三个快捷途径是导入一个 Eclipse 编制文档插件。一个 Eclipse 文档插件是一个标准的打包格式,可用来显示 Eclipse 帮助系统(比如一个信息中心)中的内容。此插件的格式是一个文档文件,例如 ZIP 或 TAR 格式。在很多 IBM 产品库的页面都可以找到此插件,有时它也可能会与产品的帮助系统一同安装。要想找到这个文档插件,我们可以用命名模式 “com.ibm.*.doc*” 来寻找文件或目录,其中的 * 是通配符。

下面的步骤基于的是 IBM WebSphere Help System 插件:Virtual Enterprise(即之前的 Operations Optimization) 插件,该插件可以从 WebSphere Extended Deployment 库 下载得到。

将这个插件添加到内容库:

  1. 从一个 Web 站点下载一个文档插件并将这个插件的内容解压缩到文件系统。
  2. 浏览找到所下载的或是同产品一同安装的一个文档插件。
    1. 从菜单栏中选择 Window > Show View > Books。Books 的选项卡页面就会被显示到最前面。
    2. 单击 Add Books 按钮显示 New Books 向导。
    3. 在这个 New Books 向导中,单击名为 Directory: Browse 的单选按钮导向这个插件的根目录。
    4. 单击 Browse,导航到在文件系统上的那个插件。这稍微有些复杂:若 com.ibm 目录嵌套,那么请选择最内层的目录,如图 10 中所示。
      图 10. 选择插件目录
      显示选择插件目录的图像
      显示选择插件目录的图像
    5. 当返回到 New Books 向导时,依据图 11 仔细核对设置,然后单击 OK
      图 11. New Books 向导设置
      显示 New Books 向导设置的图像
      显示 New Books 向导设置的图像
    6. 当出现 “Do you want to copy the content from the original directory into the toolkit?”(您是否想要将内容从原始目录复制到工具箱中?)的提问时,单击 Yes
    7. 若出现一个对话框,提示您一些导航文件作为主导航文件的角色将被转变,单击 OK。这就是说,文档插件中的任何导航视图的级别都将低于解决方案信息项目的主导航视图。
  3. 将这些导航区段从插件中拖放进导航模板中。
    1. 查看您工具箱中的 Books 选项卡页面。
    2. 单击适当的内容组来查看这个插件中可用的导航文件。在本示例中,这个内容组名为 WebSphere® Virtual Enterprise Edition Version 6.1,并且这些导航文件也会有各自的名字,例如 prodovr.xml。
      图 12. 添加到内容库的插件内容
      显示添加到内容库的插件内容的图像
      显示添加到内容库的插件内容的图像
    3. 将部分或全部导航文件拖放到这个导航模板的相关位置。
      图 13. 包含在解决方案导航视图内的插件内容
      显示包含在解决方案导航视图内的插件内容的图像
      显示包含在解决方案导航视图内的插件内容的图像
  4. 预览信息中心以便检查和调整这些结果。
    图 14. 在信息中心内显示的插件内容
    在信息中心内显示的插件内容
    在信息中心内显示的插件内容

显示在很多在线 IBM 信息中心的文档和一些基于 Eclipse 的开源项目的文档被打包成 Eclipse 文档插件的形式。若 IBM 产品库页面并没有提供所需插件的下载,那么您可以直接联系 IBM 寻求帮助。

自动地合并插件内容

在向工具箱中添加了一个文档插件后,必须将它的内容拖入解决方案信息项目的导航内。若想只用一个工具条按钮就能让工具箱将插件的内容分散到解决方案导航中适当的位置,可否实现呢?这可以实现,只要启用插件的 Automatic Merge Links 特性即可。本文包括了一个 TKCARSI-TEMPLATE.zip 文件,可用来供您尝试 Automatic Merge Links 特性,此外还有一个能供插件作者启用他们自己的插件的说明和参考实现。

要尝试 Automatic Merge Links 特性:

  1. 获取 com.ibm.soln.TEMPLATE.enabled.doc_1.0.0 插件。
    1. 从本文的 下载 部分下载 TKCARSI-TEMPLATE.zip 文件。
    2. 解压缩这些内容,需要一个名为 com.ibm.soln.TEMPLATE.enabled.doc_1.0.0 的目录。
  2. 将这个文档插件添加到工具箱中。
    1. 在工具箱中,从菜单栏里选择 Window > Show View > Books。Books 选项卡页面将被显示到最前面。
    2. 单击 Add Books 按钮来显示 New Books 向导。
    3. 在 New Books 向导中,单击名为 Directory: Browse 的单选按钮导向插件的根目录。
    4. 单击 Browse,然后导航到文件系统上的 com.ibm.soln.TEMPLATE.enabled.doc_1.0.0 文件夹。
    5. 当返回到 New Books 向导时,单击 OK
    6. 当出现 “Do you want to copy the content from the original directory into the toolkit?”(您是否想要将内容从原始目录复制到工具箱中?)的提问时,单击 Yes
  3. 创建一个新的或打开一个现有的解决方案信息项目。建议您创建一个新的项目,如若已经删除或修改了解决方案信息项目默认导航中的某些区段,就更应如此。如果您正在预览一个解决方案信息项目,那么在此项目上执行 Automatic Merge Links 前,务必先将预览关掉。
  4. 单击 Automatic Merge Links 按钮。图 15 突出显示了它的位置。如果已经打开了一个解决方案信息项目导航树并且已经为 Automatic Merge Links 特性选中了一个 Book(文档插件),那么这个按钮应该是激活状态。否则,这个 Automatic Merge Links 按钮仍然会是灰色的。
    图 15. Automatic Merge Links 按钮的位置
    显示 Automatic Merge Links 按钮位置的图像
    显示 Automatic Merge Links 按钮位置的图像
  5. 确认和观察合并操作。若出现提示,要求确认,单击 Yes。工具箱将报告有多少导航区段正在被插件内容填充。对 TKCARSI-TEMPLATE 插件来说,大约有 100 个导航区段收到了来自插件的一个或多个文档。要想查看结果,可以展开这个解决方案信息项目的导航树。
    图 16. 合并到导航树的模板内容
    显示合并到导航树的模板内容的图像
    显示合并到导航树的模板内容的图像
  6. 预览这个信息中心来进一步研究这些结果,如图 17 所示。特别要注意一个导航区段是如何能从内容插件接收多个文档的。例如,有三个导航条目被添加到了 Demonstrate the template > Solution overview > Business context > Overview 区段。
    图 17. 预览中的模板内容
    显示预览中的模板内容的图像
    显示预览中的模板内容的图像

要启用文档插件的 Automatic Merge Links 特性,插件的作者需要向插件添加特殊的注释行。TKCARSI-TEMPLATE.zip 文件为插件作者提供了一个说明和一个参考实现。

可以查看 TKCARSI-TEMPLATE.zip 插件内的这些特殊的注释行。

  1. 如果向工具箱添加了这个插件,那么请导航到目录: tkcarsi1.5\bigeasy\workspace\content\com.ibm.soln.TEMPLATE.enabled.doc_1.0.0。否则,请导航到文件系统上插件内容被下载和解压缩到的那个目录。这个目录包括了为插件内可用的文档定义导航条目的 XML 文件。TKCARSI-TEMPLATE.zip 插件提供了一个 XML 文件,该文件对应于在启动一个新的解决方案信息项目时由工具箱显示出来的默认导航内的每个位置。
  2. 在一个文本编辑器中查看 Soln_Business_context_OVERVIEW.xml 文件。请注意以 <--Target= 开始的第二行。在每个 XML 文件中,都能发现一个类似的区分大小写的目标语句,这个语句指定了内容属于解决方案信息项目导航中的哪个位置。只要有注释出现,这个 XML 文件的名字就无关紧要。
清单 1. Soln_Business_context_OVERVIEW.xml 文件
<?xml version="1.0" encoding="utf-8"?>
<!-- Target=Soln_Business_context_OVERVIEW -->
<!--Arbortext, Inc., 1988-2005, v.4002-->
<?APT Element gi="toc" attrs="label topic link_to"?>
<?APT Element gi="topic" attrs="label href"?>
<?APT Element gi="anchor" empty="yes" attrs="id"?>
<?NLS TYPE="org.eclipse.help.toc"?><!--Nav fragment example-->

<toc label="This will not show" topic="This will not show">
<topic label="BUSINESS CONTEXT OVERVIEW" href="topics/Business context overview.html">
</topic>
<topic label="VALUE PROPOSITION" href="topics/Value-proposition.html">
</topic>
<topic label="WHO BENEFITS FROM THIS SOLUTION" href="topics/Who-benefits.html">
</topic>
</toc>

从 IBM Lotus Notes 数据库导入视图

第四个也是最后一个积累内容的快捷途径就是导入一组 Domino® XML 格式 (DXL) 的 IBM Lotus Notes® 文档。您可以从 Lotus Notes 数据库中的一个视图中导出一整套文件,例如邮件数据库中的一个特定文件夹。您可以导入一整套文件供在解决方案信息中心中重用。请注意这样一个限制,即工具箱只导入 Lotus Notes 文档的内容,并不导入它们的附件。

要将一组 Lotus Notes 文档导入到工具箱:

  1. 浏览找到一个内含被导出的 Lotus Notes 文档的本地 DXL 文件。
    1. 从菜单栏选择 Window > Show View > Notes。Notes 选项卡页面将被显示到最前面。
    2. 单击 Add Lotus Notes 内容图标(图标的图片)。
    3. 在 Notes Content 向导中,选择一个内容组来管理内容,例如默认值。
    4. 选择 From DXL
    5. 指定一个在导航内显示的名称,例如 “Identity management project plan”。
    6. 单击 Browse,然后导航到 Notes 文档的在线地址。
    7. 单击 OK 关闭文件浏览对话框。
    8. 在返回到 Notes Content 向导时,单击 Next
  2. 找到工具箱中的 Notes 文档组并将其拖放进导航模板中。
    1. 返回到 Notes 选项卡页面。
    2. 双击文档被分配到的那个内容组的灰色条形图标。
    3. 通过您为这组文档提供的标题找到这组 Notes 文档。
    4. 选中这些文档。
    5. 将这些文档拖放到导航模板中的一个位置。

有关如何编写一个能导出 DXL 文档格式的 Notes 文档的 LotusScript 例程的介绍超出了本文的讨论范围,但在 Internet 上可以找到关于 Lotus Notes 编程和 DXL 格式的参考信息。对于那些已经很熟悉 Lotus Notes 编程的人,可以参考下面所示的方法导出一组文件:

  1. 如果您只被允许在 Notes 数据库创建新的视图,那么必须在本地复制您的 Notes 数据库。
  2. 从 Lotus Notes 内的菜单栏选择 Create > View 。指定一个 SELECT 语句来定义哪个文档将被显示在这个视图中。
  3. 选择 Save and Customize,打开 Lotus Notes 程序员的面板。
  4. 在这个程序员面板中,选择 Create > Action 并配置一个新的 ExportDXL 动作。
  5. 编辑这个 ExportDXL 动作以便包括一个 LotusScript,由它将视图内的文档导出到系统上指定位置的一个 .dxl 文件。
  6. 保存此动作并退出程序员面板。
  7. 查找这个在顶部包括了一个 ExportDXL 按钮的新视图。
  8. 通过单击 ExportDXL 按钮测试 LotusScript,然后再查看有可能包含 .dxl 文件的那个目录。

结束语

在本文中,您学习了通过一个解决方案信息中心(用 Toolkit for Custom and Reusable Solution Information 得到)积累可重用内容以为您的 IT 解决方案编制文档的四个技巧。当然,一旦您捕捉到内容,就意味着内容会过期。“使用定制 Eclipse 信息中心为 IT 解决方案编制文档” 系列的下一篇文章将会介绍如何管理重用内容内的变更。


下载资源


相关主题


评论

添加或订阅评论,请先登录注册

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Open source
ArticleID=472617
ArticleTitle=使用定制 Eclipse 信息中心为 IT 解决方案编制文档,第 2 部分: 提升您捕捉和重用内容的能力
publish-date=03092010