Настройка содержимого справки для веб-продуктов

Справочная система упаковывается в веб-архив (WAR-файл), который развертывается на сервере приложений. Справка запускается и прекращает работу вместе с запуском и остановкой продукта. Содержимое справочной системы можно обновлять вручную. Справочную систему можно также настроить для обновления содержимого на веб-сайте ibm.com.  Третий способ - это работа со справкой через сервер внутренней сети.

Определения

Применяются следующие определения, связанные с содержимым справки.

Локальная справка
Содержимое справки находится на локальном сервере, на котором размещен продукт, или на сервере внутренней сети. Доступ к справке можно также получить со своего компьютера.
Удаленная справка
Содержимое справки находится на веб-сайте ibm.com или другом официальном сайте справочной системы Information Center, например, jazz.net.
Сетевая справка
Содержимое справки находится на сервере внутренней сети. Содержимое справки будет предварительно загружено из сети Интернет на локальный сервер.
Утилита Local Help System Updater
Если продукт настроен для использования локальной справки или справки во внутренней сети, этот инструмент помогает загрузить начальное либо обновить существующее содержимое либо с сайта обновления справки, либо из загруженного сжатого файла обновления (см. следующие определения).
Сайт утилиты обновления справочных материалов
На сайте ibm.com размещена справочная система Information Center для продукта. К этому сайту можно обратиться с помощью браузера, или, если если настроено использование удаленной справки, из справочной системы продукта. Данный сайт также может являться источником материалов для утилиты обновления локальной справки.
Сайт загрузки справочных материалов
На веб-сайте (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) содержатся сжатые файлы справочных материалов для продукта, которые можно использовать для обновления локальной справки либо справки во внутренней сети. Файл справочных материалов имеет формат код-продуктаn.n_updateSite.zip, где код-продукта - это код продукта, n.n - номер версии.

Вступление

Содержимое справки по этому продукту обновляется независимо от самого продукта. По умолчанию в продукте настроен локальный доступ к содержимому справки.Это означает, что в веб-архиве со справкой (WAR-файле) находится все содержимое справки, и что справка устанавливается вместе с продуктом. Существует три варианта доступа к содержимому справки, включая локальный доступ.
  • Доступ к содержимому предоставляется на сервере, на котором размещен продукт.
  • Справочная информация доступна через сеть Интернет.
  • Доступ к справочным материалам по внутренней сети.

Три способа доступа к содержимому справки.

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

Если администратор настроил соответствующую функцию (или эта функция была уже настроена при поставке), справочные материалы находятся на сервере продукта.

Администратор: установка и настройка: установка продукта. Если справка включает все материалы локально или настроена для доступа к удаленной справочной системе, то больше ничего не требуется.

Администратор: обновление материалов: Если удаленная справочная система не настроена, то материалы обновляются вручную с помощью Сайт утилиты обновления справочных материалов или Сайт загрузки справочных материалов.

Пользователь: доступ к справке:  ознакомление с продуктом и работа с ним. Если нужна справка, выберите пункт Справка (?), чтобы открыть окно справки. Дополнительные действия не требуются.

Доступ к справочным материалам через Интернет

Если эта опция настроена администратором или уже была настроена в продукте при поставке, то доступ к справочным материалам по продукту осуществляется с помощью подключения к системе Information Center на веб-сайте ibm.com. При этом справка доступна только при наличии подключения к сети Интернет. Без подключения к сети доступ предоставляется к ограниченному количеству разделов справки. Дополнительные сведения приведены в подразделах справки в разделе Ссылки.

Прим.: Для использования этой опции необходимо настроить подключение к сети Интернет.
Администратор: установка и настройка:
  1. установка продукта.
  2. Запустите продукт и справку.
  3. Удалите имеющиеся справочные материалы в файле WAR с помощью локальной программы обновления справки.
  4. Настройте в удаленной справке ссылку на общедоступный Information Center продукта.

Администратор: обновление материалов: Никакие действия не требуются; всегда доступны самые свежие справочные материалы.

Пользователь: доступ к справке:  ознакомление с продуктом и работа с ним. Если нужна справка, выберите пункт Справка (?), чтобы открыть окно справки.

Доступ к справочным материалам по внутренней сети (решение Enterprise)

Если производитель поддерживает эту опцию, то можно организовать доступ с справочным материалам через локальный сервер. Предполагается, что Information Center установлен на внутреннем сервере. При выборе этого метода необходимо указать ссылку на внутренний Information Center. Также необходимо настроить регулярное обновление Information Center.

Администратор: установка и настройка:
  1. Установите продукт на сервере продукта.
  2. Установите и настройте внутреннюю справку, как описано в разделе Получение справочных материалов с внутреннего сервера.
  3. Запустите продукт.
  4. Удалите имеющиеся справочные материалы с помощью локальной программы обновления справки.
  5. Настройте в удаленной справке доступ к серверу внутренней сети с помощью данных, которые использовались при выполнении пункта 2.

Администратор: обновление содержимого: содержимое обновляется вручную на сервере внутренней сети с помощью Сайт утилиты обновления справочных материалов или Сайт загрузки справочных материалов.

Пользователь: доступ к справке:  ознакомление с продуктом и работа с ним. Если нужна справка, выберите пункт Справка (?), чтобы открыть окно справки. Дополнительные действия не требуются.


Комментарии