第20章 帮助系统.ppt

第20章 制作帮助内容 一个完整的软件产品除了要有完善的功能外，随时为用户提供适当的帮助也是必要的。很多产品都提供了帮助系统来帮助用户学习使用产品。帮助系统除了提供完整的入门教程、操作手册外，还提供在线帮助功能，根据用户当前应用的功能，随时提供帮助。 20.1 Eclipse的帮助系统 Eclipse 平台中有其自己的帮助系统，这个系统基于一个引用 HTML 文件的 XML 目录表。不必去编写 Eclipse 插件就可以使用它。任何项目都可以使用一个简化版的平台来提供专业的、易用的和方便搜索的文档。 20.1.1 帮助系统是一个Web应用 当访问 Eclipse 帮助系统时（通过 Help Help Contents），实际上启动了一个嵌入式的 Apache Tomcat 服务器。然后打开了一个基于 Web 浏览器的窗口，定位到服务器上适当的页。 20.1.2 帮助系统是插件 不要忘了这句话：“Eclipse中一切都是插件”。帮助系统也是一个插件（或者可以称为一组插件）。帮助系统包含或者依赖以下插件： org.apache.lucene org.apache.xerces org.eclipse.core.boot org.eclipse.core.resources org.eclipse.core.runtime org.eclipse.help org.eclipse.help.appserver org.eclipse.help.webapp org.eclipse.tomcat org.eclipse.update.core 20.2 建立帮助项目 继续以Company插件为例，为这个插件添加帮助文档。首先第一步，就是添加帮助系统所需要的插件。 20.2.1 添加帮助系统的依赖插件 选择pany项目，打开plugin.xml文件，选择PDE编辑器中的Dependencies标签页。 20.2.2 建立Fragment项目 选择菜单New-Project。打开新建项目向导。 20.2.2 建立Fragment项目 20.2.3 Fragment项目的文件结构 如图是Fragment项目的文件结构。和一般插件项目不同的是，这里的不是plugin.xml而是fragment.xml。 20.3.1 帮助文档的文件结构 如何编写、制作HTML文档这里就不详细讲了，主要关注的是如何组织已经编写好的HTML文档。假设HTML都已经完成。 20.3.2 添加帮助扩展 PDE工具已经准备好了一个建立帮助文件内容的向导。首先打开fragment.xml文件，选择Extensions标签页。 20.3.3 org.eclipse.help.toc扩展点 在这些文件中，最关键的是TOC文件。稍后再来认识一下TOC文件。先来看一下向导新增的org.eclipse.help.toc扩展。 20.3.4 编辑TOC文件 TOC是Tables of Contents的缩写，就是内容列表。TOC文件是XML文件，定义了帮助内容的章节层次、章节的标题名称、并映射到对应的HTML文件。先打开toc.xml。如图20-11，是PDE的TOC可视化编辑器，选择编辑器下方的Source标签可以查看toc.xml的源代码。 20.3.4 编辑TOC文件 20.3.5 修改内容章节 tocgettingstarted.xml中定义的内容都是向导自动建立的示例内容，现在定义为自己建立的帮助内容。首先把Getting Started下面节点全部删除。 20.3.5 修改内容章节 20.3.6 运行测试帮助内容 下面来试运行一下，看一下帮助内容的效果。选择菜单Run-Run Configuration。打开运行设置对话框。 20.4 实现动态帮助 Eclipse帮助系统另外一项功能是动态帮助。所谓动态帮助，就是在界面的（包括对话框和透视图）的右侧会显示一个“动态帮助视图”。这个“动态帮助视图”根据当前用户的操作，显示相关的帮助内，实时地为用户提供帮助内容。 20.4.1 添加org.eclipse.help.contexts扩展 要实现动态帮助，首先要定义帮助内容的Contexts。可以把Contexts理解为帮助内容“关键词”，对HTML文件赋予指定的“关键词”。然后在Handler、Command、或者View的扩展中，定义HelpContextId属性。 20.4.2 关联context配置文件 添加了org.eclipse.help.contexts扩展后，需要添加在org.eclipse.help.contexts扩展点下面添加context配置文件。 20.4.3 建立context配置文件 这里关联的he