用JavaHelp系统开发和交付更好的文档
来源:网络 更新时间:2014-12-2
在线帮助系统是任何软件系统整体不可或缺的一部分。帮助系统可提供直观的帮助信息,使用户可以轻松的浏览、查找和显示帮助信息,同时有助于用户学习系统的使用,如此一来,许多应用程序的学习周期就大大缩短。然而,从传统上讲,由于Java语言中没有集成帮助系统,那么Java开发人员不得不从零开始创建自己定制的帮助系统。这样不仅成本高,而且费时。
现在有了JavaHelp技术,Java开发人员就不再需要为应用程序所运行的每个平台构建自己的帮助系统。JavaHelp技术的目的是满足当今的工业强度的应用程序。
本文将详细介绍如何使用JavaHelp系统来为您的软件系统提供更好的帮助信息。内容包括:
帮助信息实现方法概述。JavaHelp技术介绍。JavaHelp技术的功能特点和优势的讨论。开发帮助信息所应用的风格。可用于您自己应用程序中的示例代码。 帮助系统的可选方案
Java开发人员可用以下几种方案来实现其应用程序的帮助系统:
无帮助系统:让用户自行判断和领会系统是如何工作的。然而,一个软系统如果没有文档、帮助信息系统、或者手册,那么该软件系统就是不完全的。而且还会影响到使用它的用户。设想一下没有使用手册的AdobePhotoshop会是什么一种情况!使用HTML:这是一个低成本的选项,但是其功能和导航受到限制。自定义系统:这是一个高成本的选项,耗费资源和时间。第三方私有方案:这是一个可替代自定义系统的可行的方案;然而,它也有自己的后果,包括:成本和长期支持。如果软件供应商破产,你能做些什么呢? 这就是为什么要设计JavaHelp技术的原因。
JavaHelp技术
JavaHelp是一个可扩展的、平台独立的帮助系统,可使作者和开发人员将在线帮助融合到Applet、应用程序、操作系统和设备之中。它也可用来Web上和公司内部Intranet上传递在线文档。它的设计理念之一就是以网络为中心,帮助数据和搜索功能既可以在客户端,也可以在服务器端,同时帮助数据可以通过Web进行更新。
JavaHelp系统是用Java语言所写,因此可以运行在任何支持JavaRuntimeEnvironment(JRE)的平台或者浏览器上。这说明,它可用于异构环境中,如Web或公司内部Intranet。此外,它还可以用来为任何软件应用程序开发和提供在线帮助,而不只是针对那些用Java语言开发而成的应用程序。而且,它也可以自我应用,而不需与任何软件相关联--正如以Web为中心的分类文档(如人力资源、技术支持、等)的传输机制。
JavaHelp1.0在1999年首次发布,经历了数年的发展和完善,该技术现在已经成熟。JavaHelp2.0技术由JavaCommunityProcess(JCP)设计成JSR-97。这说明和WinHelp不同,JavaHelp具有HTML内容的跨平台优势,因为它并不将公司局限于单一的平台。请务必注意:JavaHelp系统可以用来为部署在任何平台上的任何软件应用程序(而不仅仅是基于Java语言的应用程序)传递和提供在线帮助。
JavaHelp系统得到了来自行业和主要帮助写作工具供应商的广泛支持。
JavaHelp的功能和优势 JavaHelp提供了几个对文档写作十分有用的功能。此外,它所提供的几个可重用的组件可为Java开发人员节省大量的时间。JavaHelp的一些功能如下:
帮助导航器:内容目录(TOC)支持以可折叠和可扩展的方式显示主题、无限分级、多目录合并;一个索引支持多索引合并;和具有灵活和可配置特性的全文检索。压缩:基于JavaHelp的帮助系统可以压缩并封装到一个单一的JavaArchive(JAR)文件中。可扩展和可定制:JavaHelpAPI可用来定制或者扩展用户界面及其功能。Extensions可以自定义导航,甚至是语音和声音。这就使得作者在设计帮助系统时有更大的灵活性和控制力。上下文帮助:这是由Swing提供的。合并功能:在提供给用户之前可以对多个帮助组件进行合并。动态更新:许在线帮助系统在发布之后进行动态更新。适应性强:可使帮助系统适用于提供和显示信息。在最终部署环境事先未知的情况下,这将十分有用。可本地化:Java支持国际化(I18N),因此JavaHelp系统可以轻松进入国际市场。 部署和操作情况