獨立式說明

如果您正在建立未依據 Eclipse 架構的應用程式,您仍可以使用 Eclipse 說明系統。 您的應用程式可以包裝並安裝獨立式說明系統,它是 Eclipse 的較小版本,除了說明系統以外,所有的功能都有。 然後,您的應用程式可以從它的說明功能表或 UI 物件製作 API 呼叫,來啟動說明瀏覽器。 除了工作台整合環境定義說明、說明視圖和作用中的說明之外,獨立式說明系統有整合說明系統的所有特性。 如果應用程式不是以 Java 為基礎,或在應用程式不執行時需要說明, 則可以從系統 Shell、Shell Script 或桌面捷徑使用獨立式說明, 而且可以提供指令行選項來代替呼叫 Java API。

獨立式說明系統容許傳遞若干可用來自訂說明系統各種層面的選項。下列是支援的選項:

安裝/套裝

這些步驟為說明系統整合器的步驟而不是要解釋所有可能的情況。 它假設所有的文件都是以 Eclipse 外掛程式的形式來分送,一般而言,您會熟悉 Eclipse 說明系統。
  1. eclipse.org 中,下載 eclipse Platform Runtime Binary 驅動程式。
  2. 在您的應用程式目錄中安裝(解壓縮)驅動程式,例如 d:\myApp。這會建立一個 eclipse 子目錄 (d:\myApp\eclipse),其中含有 Eclipse 平台(包括說明系統)所需要的程式碼。

如何從 Java 呼叫說明類別

  1. 確定 d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar 在您的類別路徑中,其中 [version] 是您在使用的外掛程式版本(如 org.eclipse.help.base_3.2.0.jar)。 您用來啟動和關閉說明系統的類別是 org.eclipse.help.standalone.Help
  2. 建立 String 物件的陣列,物件中含有要傳給說明系統支援的選項。 通常會需要 eclipsehome 選項。
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. 在應用程式中,傳入引數來建立 Help 類別的實例。 這個物件應該是保留到應用程式結束之時。
    Help helpSystem = new Help(options);
  4. 如果要啟動說明系統:
    helpSystem.start(); 
  5. 在需要時要呼叫說明:
    helpSystem.displayHelp(); 

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

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

    helpSystem.shutdown(); 

如何從指令行呼叫說明

org.eclipse.help.standalone.Help 類別有一個 main 方法,供您用來從指令行啟動獨立式說明。 指令行引數語法如下:

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

顯示說明的簡單方法是呼叫

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp

這是從 d:\myApp\eclipse 目錄內呼叫,其中 version 是外掛程式的版本。 如果要顯示特定 TOC 檔或主題,請使用

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

上述顯示說明的呼叫將導致說明系統啟動、顯示說明,以及保持執行, 以容許使用者在指令執行後能夠繼續瀏覽說明。如果要控制說明系統的生命週期, 除了 displayHelp 指令外,請使用 start 和 shutdown 指令。例如,您可以呼叫

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command start

[選用] 安裝最小的獨立式說明系統

獨立式說明不需要整個 Eclipse 平台套件。 您可以將下列外掛程式加到 eclipse/plugins 目錄中,以利用「RCP 執行時期二進位」來執行獨立式說明:

org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms

附註:您必須確定 eclipse/configuration/config.ini 檔含有下面這一行:

osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start

有些文件外掛程式可能會相依於其他外掛程式,通常是在 Manifest 中指定所需要的外掛程式。 相依的外掛程式也必須安裝好。 另外,為了 3.0 版之前的 Eclipse 而設計的外掛程式,隱含地需要 org.eclipse.core.runtime.compatibility 外掛程式存在,才能運作。

請參閱產品自訂作業,以取得自訂說明系統的詳細資訊。