sun微系统的javahelp系统是一种应用程序帮助技术,它可以在所有支持java的平台和浏览器中运行??只要它是一个纯粹的java产品。通过applet和java应用程序,在其他环境下,比如在互联网或企业内部互联网中,它是理想的使用对象。在本文中,我将回顾javahelp的主要作用,并阐明它的简单使用方法。
优点
javahelp通过使用java基础类(jfc) 软件组件来实现,这使得开发户自定义界面和功能变得灵活轻松。您可以轻而易举地将应用程序的帮助信息嵌入到应用程序之中,或者嵌入到另一个独立的窗口里。jfc 还具有通过自定义导航控件拓展帮助功能的能力。
javahelp使动态更新帮助数据或将其存储在一个便利的位置变得简单易行,不管是在客户端还是服务器端。内容窗口使用html 3.2格式显示话题,使内容设计变得简单。标准导航提供内容表单(toc)、索引和全文搜索。(toc和索引都遵循w3c标准。)
javahelp data sheet提供以下信息:toc提供层叠式和扩展式话题展示,无限量等级层次和多重toc的合并。toc与内容阅读器同步显示,也就是说显示的话题在toc中被突出。索引支持多重索引的合并。全文搜索被设计得很灵活,并且可以配置。搜索引擎也可置于用户或服务器中的任一方。
帮助内容和搜索引擎被压缩成一个使用标准jar格式的单个文件。尽管为了使存储和访问更具灵活性,推荐将所有文件压缩成一个单独的文件,但是您仍然可以将所有文件以扩展的格式保存在目录中。您可以在自定义编写的导航器、搜索引擎、标准javahelp阅读器或在任何html显示中,包括标准web浏览器中,查看和导航内容。
javahelp api提供一个上下文敏感帮助和id映射的机制。您可以将多重组件的帮助信息用javahelp api合并,这样用户就看到一个单独的完整文档。合并机制可以应用于toc、索引和搜索数据库。
特性
javahelp有两个主要版本:1.1.3和2.0版。最早支持javahelp 2.0的java版本是j2se 1.2.2,因此您无需担心自己的代码是否支持javahelp。javahelp系统由一个特性完整的、可扩展的规范、api以及一个参考执行组成。
标准javahelp系统的主窗口:有三个显示窗口,在您退出窗口时并未被关闭,依然可配置。在默认情况下,一个主要窗口有以下三个窗格:工具栏、导航窗口和内容窗口。见图表1。
用户可以应用多种方式通过内部应用程序调用在线帮助,例如,当一个用户从帮助菜单中选择一项,或在应用程序gui中点击帮助按钮,javahelp系统提供一个简便的界面,通过这个界面,应用程序要求话题的id 得以显示。然后javahelp系统将话题id与相应的url相连接并将其显示出来。
id被映射到一个被称作映射文件的javahelp系统元数据文件中的url上。例如,当为文件选择对话框编码时,开发人员要求话题id fc_help在当对话框底部的帮助按钮被点击时显示。在映射文件中,id fc_help被定义为名为 filechooser.html的文件,使用以下xml句法:
将文件名(或url)的规范从程序代码分离为内容的作者提供了控制与话题id相关的信息的自由。
工具提示是一个显示给用户的简短信息,当光标停留在一个按钮上的时间间隔长于阈值时它就会出现。您还可以将工具提示信息纳入javahelp系统数据。
javahelp系统数据具有调用在线帮助的能力,能够在应用程序gui中描述图形组件。用户操纵激活语境敏感帮助,然后将组件以问题形式特定化。与组件相联系的id被显示。您可以从toc、索引导航或主要窗口的内容窗格中显示帮助话题。
轻型组件
轻型组件能够向帮助话题添加功能。这些组件与java的applet相似,但它们的加载和执行更为迅速。一个帮助的创作者能够使用已经在javahelp中执行的轻型组件;这个组件执行弹出窗口和次级窗口。在html 话题文件中使用轻型组件,您可以使用html
闽公网安备 35060202000074号