快速业务通道

用JavaHelp 2.0构建下一个Java应用程序的帮助系统 - 编程入门网

作者 佚名技术 来源 NET编程 浏览 发布时间 2012-07-04

用JavaHelp 2.0构建下一个Java应用程序的帮助系统

时间:2011-09-07 ibm

简介:即使是帮助系统设计师有时也可能需要帮助,有了 JavaHelp 2.0,终 于可以提供帮助了。在本文中,将介绍如何使用 Java 平台特有的帮助系统 API 构建一个标准的、全功能的、容易使用的系统,以向 Java 应用程序用户展 示 在线信息。

从开发者的角度看,自动化的帮助组件,或者帮助系统,通常是在构建一个 Java 应用程序时最后考虑的事情。不过对于用户来说,帮助系统是学习新应用 程序时非常有价值的资源。随着对功能更全和更可靠的应用程序帮助系统的需求 增加,应用程序开发人员的时间和生产率负担也随之增加。幸运的是,Java 平 台包括了一个专门构建应用程序帮助系统的 API。

在本文中,将介绍如何使用 JavaHelp 2.0 API 为一个简单的 Java 应用程 序构建一个标准的、全功能的帮助系统。首先将构建一个基本的应用程序帮助系 统,它包括一组主题文件、一组导航文件和一组数据文件。然后将介绍如何使这 个帮助系统可以被 Java 应用程序使用,并用基于文字或者图形的导航、预先设 置的字体、分层的展示窗口和可搜索的数据库定制它。还将介绍如何实现上下文 敏感的功能、将帮助系统直接加入到应用程序中、合并多个帮助系统以及为帮助 系统创建自定义的轻量级组件。在本文最后,我将快速回顾 JavaHelp 2.0 的服 务器端帮助系统框架。

注意:本文假定读者熟悉构建帮助系统的设计考虑并熟悉在 Java 平台上开 发企业应用程序。如果有一些 Swing GUI 开发的经验也会有帮助。

入门

在本文中,将为一个 Tax Calculator 应用程序构建一个 JavaHelp 系统。 图 1 显示了这个 Tax Calculator。可以在本文最后的 参考资料中找到这个例 子的源代码。运行 FirstLook 以显示 Tax Calculator。

图 1. Tax Calculator 的 About 页

用JavaHelp 2.0构建下一个Java应用程序的帮助系统 - 编程入门网

在图 2 中您会看到 Tax Calculator 帮助系统的导航设置。注意突出显示了 后面将要讨论的一些导航图标。

图 2. 导航帮助系统

用JavaHelp 2.0构建下一个Java应用程序的帮助系统 - 编程入门网

用JavaHelp 2.0构建下一个Java应用程序的帮助系统(2)

时间:2011-09-07 ibm

安装 JavaHelp 2.0可以在 JavaHelp 主页中找到 JavaHelp 2.0 二进制发布 。在将下载的 zip 文件解压缩到所选的目录中以安装 JavaHelp 软件之前,在 开发计算机上必须已安装版本 1.2.2 或者是更高的 J2SE SDK。应当创建一个像 JAVAHELP_HOME这样的环境变量以包含到安装 JavaHelp 2.0 的文件夹的路径。 应当在 classpath 中加入 %JAVAHELP_HOME%\javahelp\lib\jhall.jar。

注意在安装版本 2.0 之前,必须删除所有以前版本的 JavaHelp。

使用 HelpSet

每一个 JavaHelp 帮助系统都包含一组称为 HelpSet 的文件。这些文件共同 提供了应用程序帮助系统的工作基础。JavaHelp HelpSet 包括三种类型的文件 :

HelpSet 数据文件

导航文件

主题文件

可以在 参考资料中找到示例 Tax Calculator 的帮助系统的 HelpSet 文件 。HelpSet 数据文件是 TaxCalculatorHelpSet.hs 和 TaxCalculatorMap.jhm。 导航文件是 TaxCalculatorIndex.xml、TaxCalculatorTOC.xml 和 TaxCalculatorGlossary.xml。主题文件位于文件夹 TaxCalculator中。请使用 这些文件以跟随下面几节中的讨论。

HelpSet 数据文件

有两种 HelpSet 数据文件,分别是 helpset 文件和 map 文件。 helpset 文件是帮助系统的主控制文件。它必须有文件扩展名 .hs。 map 文件用于为每 一个帮助主题关联一个 map ID 以进行导航。map 文件的文件扩展名是 .jhm。 我将详细介绍每一种 HelpSet 文件类型。

helpset 文件

helpset 文件提供了应用程序帮助系统的工作基础。一个典型的 helpset 文 件的结构类似清单 1。

清单 1. helpset 文件

<helpset version="2.0&

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务,公司网站:http://www.lingzhong.cn 为了给广大客户了解更多的技术信息,本技术文章收集来源于网络,凌众科技尊重文章作者的版权,如果有涉及你的版权有必要删除你的文章,请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢!

分享到: 更多

Copyright ©1999-2011 厦门凌众科技有限公司 厦门优通互联科技开发有限公司 All rights reserved

地址(ADD):厦门软件园二期望海路63号701E(东南融通旁) 邮编(ZIP):361008

电话:0592-5908028 传真:0592-5908039 咨询信箱:web@lingzhong.cn 咨询OICQ:173723134

《中华人民共和国增值电信业务经营许可证》闽B2-20100024  ICP备案:闽ICP备05037997号