JavaHelp 是 Sun 純 Java 實現的線上幫助系統,跨平台、可嵌入 Applet/應用程式、支援動態更新、標準導航(TOC/索引/全文搜尋),是企業級應用內建幫助的首選方案。
核心優勢
- JFC/Swing 基礎:界面與功能高度可定製,可內嵌應用視窗或獨立視窗。
- 動態內容部署:客戶端/服務端均可更新幫助數據,無需重新發布主程式。
- HTML 3.2 內容格式:技術寫作門檻低,支援標準導航組件(TOC 無限層級、多 TOC 合併、索引合併、可配置搜尋引擎)。
- JAR 打包分發:單一壓縮檔便於版本管理與傳輸,亦可目錄展開模式訪問。
- 多視圖訪問:自定義導航器、標準閱讀器、任意 HTML 瀏覽器均可查看。
- 上下文敏感幫助:API 提供 ID→URL 映射,多組件幫助可合併為單一文檔集。
- 輕量級組件:
<object> 標籤嵌入彈出視窗/次級視窗,開發者可自行擴展多媒體/動畫組件(實作 ViewAwareComponent)。
架構組件
- 主視窗:工具列、導航窗格(TOC/索引/搜尋)、內容窗格(HTML 渲染)。
- 映射文件:XML 定義
mapID → URL,解耦程式碼與內容。
- 工具提示整合:游標懸停顯示簡短資訊,可納入幫助數據集。
主流編寫工具
- Helen 1.5 (Software7 GmbH)
- HelpBreeze (Solutionsoft)
- JavaHelpAuthor (Pivotonic)
均支援 Java 2 / 1.1 標準,提供可視化編輯、TOC/索引/搜尋資料庫生成、JAR 打包。
快速上手
- 下載 JavaHelp 2.0(需 J2SE 1.2.2+)。
- 編寫 .hs(幫助集)、.map(映射)、.toc(目錄)、.idx(索引)檔案。
- 使用
jhindexer 生成全文搜尋資料庫。
- 打包為 .jar,應用中啟動
HelpSet → HelpBroker 顯示。
💡 現代替代方案:Web-based 幫助中心(Markdown + 靜態站點生成器如 Docsify/VitePress/VuePress)部署於內部網關,支援版本控制、全文搜尋、響應式佈局,維護成本更低。