安裝獨立式說明系統

如果您正在建立未依據 Eclipse 組織架構的應用程式,您仍可以使用 Eclipse 說明系統。 您的應用程式可以套裝並安裝獨立式說明系統,它是 Eclipse 的較小版本,除了說明系統以外,所有的功能都有。 然後,您的應用程式可以從它的說明功能表或 UI 物件製作 API 呼叫,來啟動說明瀏覽器。 獨立式說明系統擁有整合性說明系統的所有特性,除了蹦現資訊和作用中的說明之外。

安裝/包裝

這些步驟為說明系統整合器的步驟而不是要解釋所有可能的情況。 假設啟動應用程式是在 Java 中,而您所有的文件傳遞為 Eclipse 外掛程式, 一般來說,您熟悉 Eclipse 說明系統。
  1. www.eclipse.org 下載 Eclipse 2.0 版次平台執行時期驅動程式。
  2. 在您的應用程式目錄中安裝(解壓縮)驅動程式,例如 d:\myApp。這將建立 Eclipse 子目錄,d:\myApp\eclipse,其中包含 Eclipse 平台所需的程式碼(包括說明系統)。

如何呼叫說明類別

  1. 請確定 d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar 在您的 app 類別路徑中。您所用來開始、啟動和關閉說明系統的類別為 org.eclipse.help.standalone.Help。
  2. 在應用程式中,利用傳遞外掛程式目錄建立說明類別實例。這個物件應該保留至應用程式結束為止。
    Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins"); 
  3. 要啟動說明系統:
    helpSystem.start(); 

    在應用程式結束時,要關閉說明系統:

    helpSystem.shutdown(); 
  4. 在需要時要呼叫說明:
    helpSystem.displayHelp(); 

    您也可以在特定的主要 TOC 檔案或主題上呼叫說明:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  5. 要啟動內容相關輔助說明,呼叫 helpSystem.displayContext(contextId, x, y), 其中 contextId 是完整的環境定義 ID。 畫面座標,x 和 y,目前未使用。

測試獨立式說明

org.eclipse.help.standalone.Help 類別有您可以啟動的簡單主要程式,您也可以從中瞭解獨立式說明在方框外如何作用。從指令行,執行下列指令:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar 
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins
Copyright IBM Corp. and others 2000, 2002.