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<object>標記,正如列表A中的例子所顯示的。
在例子中,彈出的對象包括文件../topicB/glossary_def.html,用戶點擊的對象(viewerActivator)是個鏈接,窗口類型屬於彈出型,窗口大小為300x400,用戶在鏈接中看到的內容是“Click here(點擊這裡)”。
Java開發商還可以創造新的輕型組件。例如,這樣的組件可能為幫助話題添加動畫和多媒體功能。
要求抽象查看的輕型組件必須執行javax.javahelp.impl.ViewAwareComponen。這些組件執行setViewData()方法。這個組件能夠根據抽象查看中的信息決定它所執行的環境。(注重:要訪問抽象查看,您應該使用JavaHelp API。)在列表B中,文檔對象下面的編碼片斷來自於抽象查看。
需要更多關於創造Java輕型組件的信息,請參閱相關文件。
JavaHelp編寫工具
有很多通過商業途徑可以得到的編寫工具能夠為您的應用程序編寫和維護一個完美的幫助系統。最有名的三個是Software7 Gmbh的Helen 1.5、Solutionsoft的HelpBreeze和Pivotonic的JawaHelpAuthor。所有這些第三方產品都支持Java 2 和Java 1.1標准。需要更多關於編寫工具的信息,請參閱Sun的幫助編寫工具頁面。
試試看吧
假如JavaHelp聽起來像是一個您認為您的用戶和伙伴開發商都喜歡的系統的話,那麼從Sun Microsystem公司的網站上馬上下載吧。這個地址提供了安裝過程所需要的所有信息。