系統是一種應用程式幫助技術,它可以在所有支持Java的平台和瀏覽器中運行,只要它是一個純粹的Java產品。通過applet和Java應用程式,在其他環境下,比如在網際網路或企業內部網際網路中,它是理想的使用對象。在本文中,我將回顧JavaHelp的主要作用,並闡明它的簡單使用方法。
基本介紹
- 中文名:JavaHelp
- 優點:JavaHelp通過使用Java基礎
- 概述:Sun微系統的JavaHelp系統是一
- 特性:JavaHelp有兩個主要版本
優點,特性,輕型組件,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句法:
<mapID target="fc_help" url="html/help/FileChooser.html" />
將檔案名稱(或URL)的規範從程式代碼分離為內容的作者提供了控制與話題ID相關的信息的自由。
工具提示是一個顯示給用戶的簡簡訊息,當游標停留在一個按鈕上的時間間隔長於閾值時它就會出現。您還可以將工具提示信息納入JavaHelp系統數據。
JavaHelp系統數據具有調用線上幫助的能力,能夠在應用程式GUI中描述圖形組件。用戶操縱激活語境敏感幫助,然後將組件以問題形式特定化。與組件相聯繫的ID被顯示。您可以從TOC、索引導航或主要視窗的內容窗格中顯示幫助話題。
輕型組件
輕型組件能夠向幫助話題添加功能。這些組件與Java的applet相似,但它們的載入和執行更為迅速。一個幫助的創作者能夠使用已經在JavaHelp中執行的輕型組件;這個組件執行彈出視窗和次級視窗。在HTML 話題檔案中使用輕型組件,您可以使用HTML <object>標記,正如列表A中的例子所顯示的。
在例子中,彈出的對象包括檔案../topicB/glossary_def.html,用戶點擊的對象(viewerActivator)是個連結,視窗類型屬於彈出型,視窗大小為300x400,用戶在連結中看到的內容是“Click here(點擊這裡)”。
Java開發商還可以創造新的輕型組件。例如,這樣的組件可能為幫助話題添加動畫和多媒體功能。
JavaHelp API
要求抽象查看的輕型組件必須執行javax.javahelp.impl.ViewAwareComponen。這些組件執行setViewData()方法。這個組件能夠根據抽象查看中的信息決定它所執行的環境。(注意:要訪問抽象查看,您應該使用。)在列表B中,文檔對象下面的編碼片斷來自於抽象查看。
需要更多關於創造Java輕型組件的信息,請參閱相關檔案。
JavaHelp編寫工具
有很多通過商業途徑可以得到的編寫工具能夠為您的應用程式編寫和維護一個完美的幫助系統。最有名的三個是Software7 Gmbh的Helen 1.5、Solutionsoft的HelpBreeze和Pivotonic的JawaHelpAuthor。所有這些第三方產品都支持Java 2 和Java 1.1標準。需要更多關於編寫工具的信息,請參閱Sun的幫助編寫工具頁面。