Справочную систему Eclipse можно использовать даже для приложений, созданных не на основе платформы Eclipse. Такое приложение выполняет все операции, связанные с упаковкой и установкой автономной справочной системы (компактная версия Eclipse, из которой удалены все компоненты, за исключением справочной системы). Браузер справки запускается приложением из меню Справка и объектов пользовательского интерфейса с помощью вызовов API. Автономная справочная система обладает всеми функциями интегрированной справочной системы за исключением встроенных в рабочую среду контекстной справки, панели справки и активной справки. Если приложение создано без применения технологии Java или справочная информация требуется в момент, когда приложение не запущено, автономную справочную систему можно вызвать с помощью системной оболочки, сценария оболочки или ярлыка на рабочем столе, указав вместо вызова API Java опции командной строки.
Автономная справочная система поддерживает передачу различных опций для дополнительной настройки. Ниже перечислены поддерживаемые опции:
-nl fr_FR
позволяет переопределить язык, указанный в локали системы, и запустить справочную систему
на французском языке. d:\myApp\eclipse\plugins\org.eclipse.help.base_[версия].jar
, где
[версия]
- это версия модуля, например, org.eclipse.help.base_3.2.0.jar
. Для запуска и завершения работы справочной системы применяется класс
org.eclipse.help.standalone.Help
. String
, содержащий опции, передаваемые справочной системе. В некоторых случая может
потребоваться указать опцию eclipsehome
.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Help
, передав необходимые опции. Этот объект следует сохранять до завершения
приложения. Help helpSystem = new Help(options);
helpSystem.start();
helpSystem.displayHelp();
Кроме того, можно просмотреть справку по конкретным основным файлам оглавлений или разделам:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
Перед закрытием приложения следует завершить справочную систему с помощью следующего метода:
helpSystem.shutdown();
Метод main, входящий в состав класса org.eclipse.help.standalone.Help
, позволяет запустить автономную справочную систему из
командной строки. Аргументы командной строки следует
указывать в следующем формате:
-command start | shutdown | (displayHelp [href]) [-eclipsehome установочный-каталог-eclipse] [-data папка-данных-экземпляров] [-host хост-сервера-справки] [-port порт-сервера-справки] [-dir rtl] [опции платформы] [-vmargs аргументы-виртуальной-машины-Java]
Например, для просмотра справки можно выполнить команду
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[версия].jar org.eclipse.help.standalone.Help -command displayHelp
в каталоге d:\myApp\eclipse, где версия
- это версия модуля. Для просмотра конкретного файла TOC или раздела применяется
команда
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[версия].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm
В результате выполнения приведенных выше команд справочная система запускается, отображает справку и продолжает работать. Таким образом, после выполнения команды пользователь может и дальше работать со справочной системой. Команды start и shutdown, применяемые совместно с displayHelp, позволяют управлять жизненным циклом справочной системы. Например,
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[версия].jar org.eclipse.help.standalone.Help -command start
Для работы автономной справочной системы не требуется устанавливать пакет платформы Eclipse целиком.
Для работы автономной справочной системы с RCP Runtime Binary необходимо в каталог eclipse/plugins
добавить следующие
модули:
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
Некоторые модули документации могут зависеть от других модулей, которые обычно указаны в манифесте. Зависимые модули также подлежат
установке.
Кроме того, для поддержки модулей, созданных до выхода Eclipse 3.0, необходимо установить модуль
org.eclipse.core.runtime.compatibility
.
Дополнительная информация о настройке справочной системы приведена в разделе Настройка продукта.