Установка автономной справочной системы

Справочную систему Eclipse можно использовать даже для приложений, созданных не на основе платформы Eclipse. Такое приложение выполняет все операции, связанные с упаковкой и установкой автономной справочной системы (компактная версия Eclipse, из которой удалены все компоненты, за исключением справочной системы). Браузер справки запускается приложением из меню Справка и объектов пользовательского интерфейса с помощью вызовов API. Автономная справочная система обладает всеми функциями интегрированной справочной системы за исключением контекстной и активной справки. Если приложение создано без применения технологии Java или справочная информация требуется в момент, когда приложение не запущено, автономную справочную систему можно вызвать с помощью системной оболочки, сценария оболочки или ярлыка на рабочем столе, указав вместо вызова API Java опции командной строки.

Автономная справочная система поддерживает передачу различных опций для дополнительной настройки. Ниже перечислены поддерживаемые опции:

Установка/упаковка

Далее рассмотрена общая процедура интеграции справочной системы. Однако она подходит не для всех возможных сценариев. Предполагается, что документация поставляется в качестве модулей Eclipse, а также наличие у вас опыта работы со справочной системой Eclipse.
  1. Загрузите драйвер Eclipse Platform Runtime Binary с Web-сайта www.eclipse.org.
  2. Установите (распакуйте) драйвер в каталог приложений (например, d:\myApp). В результате будет создан подкаталог d:\myApp\eclipse с исходным кодом, необходимым для работы платформы Eclipse (в том числе исходный код справочной системы).

Вызов классов справки с помощью Java

  1. Убедитесь, что в пути к классам приложения указан файл d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.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(); 

    Кроме того, можно просмотреть справку по конкретным основным файлам оглавлений или разделам:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Для того чтобы просмотреть контекстную справка, вызовите helpSystem.displayContext(ИД-контекста, x, y), где ИД-контекста - это полный ИД контекста. Координаты x и y в настоящее время не поддерживаются.
  7. Перед закрытием приложения следует завершить справочную систему с помощью следующего метода:

    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_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

в каталоге d:\myApp\eclipse. Для просмотра конкретного файла 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

В результате выполнения приведенных выше команд справочная система запускается, отображает справку и продолжает работать. Таким образом, после выполнения команды пользователь может и дальше работать со справочной системой. Команды start и shutdown, применяемые совместно с displayHelp, позволяют управлять жизненным циклом справочной системы. Например,

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 для обеспечения эффективной поддержки браузера (Internet Explorer, встроенный в SWT, в Windows и Mozilla в Linux или автономный браузер системы в 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 preferences