如果您正在建立未依據 Eclipse 組織架構的應用程式,您仍可以使用 Eclipse 說明系統。 您的應用程式可以包裝並安裝獨立式說明系統,它是 Eclipse 的較小版本,除了說明系統以外,所有的功能都有。 然後,您的應用程式可以從它的說明功能表或 UI 物件製作 API 呼叫,來啟動說明瀏覽器。 獨立式說明系統擁有整合性說明系統的所有特性,除了蹦現資訊和作用中的說明之外。 如果應用程式不是以 Java 為基礎,或在應用程式不執行時需要說明, 則可以從系統 Shell、Shell Script 或桌面捷徑使用獨立式說明, 而且可以提供指令行選項來代替呼叫 Java API。
獨立式說明系統容許傳遞若干可用來自訂說明系統各種層面的選項。下列是支援的選項:
-nl fr_FR
將啟動法文版本的說明系統,而不是機器語言環境所指定的語言版本。String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Help helpSystem = new Help(options);
helpSystem.start();
helpSystem.displayHelp();
您也可以在特定的主要 TOC 檔案或主題上呼叫說明:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
在應用程式結束時,要關閉說明系統:
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]
顯示說明的簡單方法就是從 d:\myApp\eclipse 目錄內呼叫
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp
。如果要顯示特定的 TOC 檔或主題,請使用
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.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_3.1.0.jar org.eclipse.help.standalone.Help -command start
獨立式說明不需要整個「Eclipse 平台」套件。
只要具有下列外掛程式(位於 eclipse\plugins 目錄),就可以執行獨立式說明:
org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator
在 Windows 和 Linux 上,下列外掛程式和片段必須置於最小配置上面, 才能提供健全的瀏覽器支援(Windows 上的 SWT 內含 Internet Explorer,以及 Linux 上的 Mozilla, 或是 Windows 上的獨立式系統瀏覽器)。
org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 or org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench
部分說明文件外掛程式可能與其他外掛程式有相依關係,通常會在其 plugin.xml 中指定需要的外掛程式。
InfoCenter 中也需要安裝相依的外掛程式。
此外,為 Eclipse 3.0 版之前版本所設計的外掛程式,需要 org.eclipse.core.runtime.compatibility
才能使用外掛程式。
如果需要自訂說明系統的詳細資訊,請參閱說明系統喜好設定。
org.eclipse.help.base 喜好設定