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

Установив на сервере модули Infocenter и документации, вы можете предоставить пользователям доступ к справочной системе по Internet, либо в пределах внутренней сети организации. Клиенты просматривают справку в Web-браузере в соответствии с указанными URL. Справочная система Infocenter обеспечивает удаленный доступ к справке как приложений клиентов, так и Web-приложений. Реализована поддержка всех функций справочной системы, за исключением контекстной и активной справки.

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

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

Далее рассмотрена общая процедура интеграции справочной системы, которая однако применима не для всех возможных сценариев. Предполагается, что документация поставляется в качестве модулей Eclipse, а также у вас есть опыт работы со справочной системой Eclipse.

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

Запуск и завершение Infocenter с помощью командной строки

Метод main, входящий в состав класса org.eclipse.help.standalone.Infocenter, позволяет запустить справочную систему Infocenter из командной строки. Аргументы командной строки следует указывать в следующем формате:

-command start | shutdown | [-eclipsehome установочный-каталог-eclipse] [-data папка-данных-экземпляров] [-host хост-сервера-справки] [-locales список-локалей] [-port порт-сервера-справки] [-dir rtl] [-noexec] [опции платформы] [-vmargs аргументы-виртуальной-машины-Java]

Следующая команда позволяет запустить Infocenter для работы с портом 8081

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

Следующая команда позволяет завершить работу Infocenter

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Работа со справочной системой infocenter

Запустите Web-сервер. В Web-браузере укажите путь к каталогу "help" (Web-приложение, работающее с портом, заданным при запуске Infocenter).Если в системе установлена справочная система, укажите адрес http://localhost:8081/help/.

Запуск и завершение Infocenter с помощью Java

Если справочная система Infocenter входит в состав другого приложения, рекомендуется для ее запуска и завершения вместо команд системы использовать API Java. Для этого выполните следующие действия:

  1. Убедитесь, что в пути к классам приложения указан файл d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar. Для запуска и завершения работы справочной системы применяется класс org.eclipse.help.standalone.Infocenter.
  2. Создайте массив данных типа String, содержащий опции, передаваемые справочной системе Infocenter. В некоторых случая может потребоваться указать опции eclipsehome и port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. В приложении создайте экземпляр класса Help, передав необходимые опции.
    Infocenter infocenter = new Help(options); 
  4. Следующий метод позволяет запустить справочную систему:
    helpSystem.start();
  5. Для того чтобы завершить работу справочной системы infocenter, выполните следующие действия:

    helpSystem.shutdown(); 

Предоставление доступа к Infocenter по сети Internet

В состав платформы Eclipse входит полная версия справочной системы Infocenter, для работы которой не требуется дополнительное программное обеспечение. Однако в незащищенных средах, таких как Интернет, не рекомендуется предоставлять к ней непосредственный доступ. В качестве промежуточного звена используйте сервер HTTP или сервер приложений. Как правило в состав серверов входят модули или сервлеты, передающие запросы другим Web-ресурсам. Например, можно настроить модуль Proxy сервера Apache HTTP Server, перенаправляющий запросы к http://mycompany.com/myproduct/infocenter на адрес http://internalserver:8081/help. Для этого следующие строки

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

следует добавить в файл conf/httpd.conf сервера Apache, управляющего Web-сайтом организации.

В файлах конфигурации некоторых версий сервера HTTP Apache может быть указана директива AddDefaultCharset. Удалите ее или замените на

AddDefaultCharset Off

, чтобы браузеры могли выбирать для отображения документов правильный набор символов.

Запуск нескольких экземпляров справочной системы Infocenter

В одной системе под управлением одной установки могут работать несколько экземпляров Infocenter. Для каждого активного экземпляра следует указать собственный порт, а также предоставить отдельную рабочую среду (опции -port и -data). Экземпляры могут обрабатывать документы, принадлежащие разным модулям, предоставив допустимую конфигурацию платформы с помощью опции -configuration.

Если опция -configuration не применяется и каталог конфигурации совместно используется несколькими экземплярами Infocenter с пересекающимся набором локалей, убедитесь, что все индексы поиска создаются одним из экземпляров перед запуском других экземпляров. Индексы сохраняются в каталоге конфигурации, запись данных в который разными процессами Infocenter не синхронизирована.

[Необязательно] Установка минимального набора модулей

Для работы справочной системы Infocenter не требуется устанавливать пакет платформы Eclipse целиком. Ниже перечислены модули, необходимые для Infocenter (каталог 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

Некоторые модули документации могут зависеть от других модулей, которые как правило указаны в соответствующих файлах plugin.xml. Зависимые модули также подлежат установке в справочной системе Infocenter. Кроме того, для поддержки модулей, созданных до выхода Eclipse 3.0, необходимо установить модуль org.eclipse.core.runtime.compatibility.

Обновление справочной системы Infocenter можно выполнить без ее перезапуска с помощью команд, описанных в разделе Динамическое обновление Infocenter с помощью командной строки. Для применения этой функции помимо минимального набора модулей должен быть установлен модуль org.eclipse.update.core.

Дополнительная информация о настройка справочной системы приведена в разделе Параметры справочной системы.