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