Установив на сервере модули Infocenter и документации, вы можете предоставить пользователям доступ к справочной системе по Internet, либо в пределах внутренней сети организации. Клиенты просматривают справку в Web-браузере в соответствии с указанными URL. Справочная система Infocenter обеспечивает удаленный доступ к справке как приложений клиентов, так и Web-приложений. Поддерживаются все компоненты справочной системы, за исключением контекстной справки, активной справки, поддержки команд и панели Справка.
Справочная система Infocenter поддерживает передачу различных опций для дополнительной ее настройки. Ниже перечислены поддерживаемые опции:
osgi.instance.area
либо
osgi.instance.area.default
. -nl en -locales de en es fr it ja ko pt_BR zh_CN zh_TW
, то справочная система Infocenter будет
работать только с 10 локалями. Для всех остальных локалей будут использоваться параметры локали en
. -vmargs -Xmx256M
позволяют увеличить объем памяти, доступной для справочной системы
Infocenter, и обрабатывать наборы книг большего размера. Далее рассмотрена общая процедура интеграции справочной системы. Однако она подходит не для всех возможных сценариев. Предполагается, что документация поставляется в качестве модулей Eclipse, а также наличие у вас опыта работы со справочной системой Eclipse.
d:\myApp
. В результате будет создан подкаталог
d:\myApp\eclipse
с исходным кодом, необходимым для работы платформы Eclipse (в том числе с исходным кодом справочной системы).
Метод main()
, входящий в состав класса org.eclipse.help.standalone.Infocenter
, позволяет запустить справочную
систему Infocenter из командной строки. Аргументы командной строки следует указывать в следующем формате:
-command start | shutdown | [-eclipsehome установочный-каталог-eclipse] [-data папка-данных-экземпляров] [-host хост-сервера-справки] [-locales список-локалей] [-port порт-сервера-справки] [-dir rtl] [-noexec] [опции платформы] [-vmargs аргументы-виртуальной-машины-Java]
Команда start
позволяет запустить 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
Команда shutdown
позволяет завершить работу 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-браузере укажите "/help", после чего запустится Web-приложение,
работающее с портом, указанным при запуске Infocenter (например, 8081). В системе, где установлена справочная система Infocenter, укажите
http://localhost:8081/help/
.
Если справочная система Infocenter входит в состав другого приложения, рекомендуется для ее запуска и завершения вместо команд системы использовать API Java. Для этого выполните следующие шаги:
d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar
указан в переменной classpath приложения. Для
запуска и завершения работы Infocenter применяется класс org.eclipse.help.standalone.Infocenter
. String
, содержащий опции, передаваемые справочной системе Infocenter. В некоторых случаях
может потребоваться указать опции eclipsehome
и port
. String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
Help
, передав необходимые опции. Infocenter infocenter = new Help(options);
helpSystem.start();
helpSystem.shutdown();
В состав платформы Eclipse входит полная версия справочной системы Infocenter, для работы которой не требуется дополнительное программное
обеспечение. Однако в незащищенных средах, таких как Internet, не рекомендуется предоставлять к ней непосредственный доступ. В качестве
промежуточного звена используйте сервер 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.
Для каждого активного экземпляра следует указать собственный порт, а также предоставить отдельную рабочую среду (опции -port
и
-data
).
Экземпляры могут обрабатывать документы, принадлежащие разным модулям, предоставив допустимую конфигурацию платформы с помощью опции
-configuration
.
Если опция -configuration
не применяется, и каталог конфигурации совместно используется несколькими экземплярами Infocenter с
пересекающимся набором локалей, убедитесь, что все индексы поиска создаются одним из экземпляров перед запуском других экземпляров.
Индексы сохраняются в каталоге конфигурации, запись данных в который разными экземплярами Infocenter не синхронизирована.
В режиме 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
Некоторые модули документации могут зависеть от других модулей, которые как правило указаны в манифесте комплектов. Зависимые модули также необходимо установить в справочной системе Infocenter.
Обновление справочной системы Infocenter можно выполнить без ее перезапуска с помощью команд, описанных в разделе
Динамическое обновление Infocenter с помощью командной строки. Для применения этой
функции помимо минимального набора модулей должен быть установлен модуль org.eclipse.update.core
.
Дополнительная информация о настройке справочной системы приведена в разделе Настройка продукта.