Администрирование справочных материалов для веб-продуктов

Справочная система поставляется в виде веб-архива (файл WAR), который развертывается на сервере сервер справки. Файл WAR содержит базовую структуру справки, справку по работе со справочной системой, а также контекстную справку.
В ходе настройки файла WAR справки можно выбрать следующие способы доступа к справке:
  1. Веб-справка с сайта ibm.com (удаленная справка): справочные материалы размещены на сервере ibm.com, на котором всегда опубликована последняя версия. Другое название этого варианта - удаленная справка.
  2. Загруженные справочные материалы (локальная справка): справочные материалы можно загрузить на сервер справки. Другое название этого варианта - локальная справка.
  3. Веб-справка из справочной системы Information Center во внутренней сети (справка во внутренней сети): справочные материалы можно разместить на сервере во внутренней сети. Внутренняя справочная система Information Center настраивается в качестве удаленной справки. Другое название этого варианта - справка во внутренней сети. В корпоративной среде можно настроить справку во внутренней сети для нескольких продуктов.

Три варианта доставки справочных материалов

Следующая таблица содержит сведения об администрировании и использовании трех вариантов размещения справки.
Табл. 1. Варианты доступа к справке
Вариант справки 1. Веб-справка с сайта ibm.com (удаленная справка) 2. Загруженные справочные материалы (локальная справка) 3. Веб-справка из справочной системы Information Center во внутренней сети (справка во внутренней сети)
Описание

Справочные материалы опубликованы на веб-сайте ibm.com. сервер справки должен обладать доступом к Интернету.

Справочные материалы размещаются на локальном сервере сервер справки.

Справочные материалы размещаются на сервере во внутренней сети. Во внутренней сети должна быть настроена справочная система Information Center и сервер справки доступ обладать доступом к серверу, на котором она установлена.

Этот вариант можно использовать в корпоративных средах.

Администрирование Эта конфигурация справки применяется по умолчанию. Для настройки удаленной справки выполните следующие действия:
  1. На сервере сервер справки откройте страницу удаленной справочной системы Information Center для продукта.
  2. Настройте справку для применения справочной системы Information Center с веб-сайта ibm.com.
Для настройки локальной справки выполните следующие действия:
  1. На сервере сервер справки откройте страницу обновления.
  2. Загрузите справку с веб-сайта ibm.com на локальный сервер сервер справки. Дополнительные сведения содержатся в разделе Загрузка справочных материалов.
  3. Настройте справку для применения локальной справочной системы.
Для настройки справки во внутренней сети выполните следующие действия:
  1. На сервере во внутренней сети создайте справочную систему Information Center для продукта.
  2. На сервере сервер справки откройте страницу удаленной справочной системы Information Center для продукта.
  3. Настройте справку для применения справочной системы Information Center из внутренней сети.
Обновление содержимого Обновления не требуются. Всегда доступна последняя версия справочных материалов. Для обновления локальных справочных материалов выполните следующие действия:
  1. На сервере сервер справки откройте страницу загрузки локальной справки.
  2. Обновите содержимое. Дополнительная информация приведена в разделе Обновление справочных материалов.
Прим.: Если настроено автоматическое обновление, то справочные материалы обновляются каждый раз при перезапуске справки, если сервер справки может обратиться к сайту ibm.com. Сайты из списка Избранные сайты проверяются на наличие обновлений. В списке Доступное содержимое можно включить фильтр, отображающий только избранные сайты.
Для обновления справочных материалов на сервере во внутренней сети выполните инструкции по загрузке справки; вместо сервер справки следует использовать сервер во внутренней сети.
Для просмотра справки по продукту в правом верхнем углу выберите ? > Оглавление справки.
Прим.: В случае применения сервера приложений Tomcat справка запускается и останавливается вместе с продуктом. В случае применения IBM WebSphere Application Server файл WAR справки следует запускать и останавливать вручную.