Способы доступа к содержимому справки

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

Определения

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

Вступление

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

Во время установки продукта укажите следующие опции доступа к справочной системе. В дальнейшем эти опции можно будет изменить.
  • Доступ к справочным материалам через Интернет.
  • Доступ к справочным материалам на локальном компьютере.
  • Доступ к справочным материалам по внутренней сети.
Три способа доступа к содержимому справки.

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

Справочная информация доступна через Интернет с помощью функции Удаленная справка. В этом случае при установке требуется меньше всего дискового пространства, а получая справочную информацию непосредственно из Information Centre, вы можете быть уверенны, что это самая свежая информация. Этот метод выбирается по умолчанию во время установки.

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

Прим.: Для использования этой опции необходимо настроить подключение к Интернету.
Установка:
  1. Установите продукт с параметрами справки по умолчанию и запустите его.
  2. Перед первым обращением к справке выберите Справка > Справочные материалы. Дополнительные действия не требуются.

Обновление справочных материалов: Справочные материалы будут обновляться автоматически.

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

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

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

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

Установка:
  1. Установка продукта с помощью опции Локальная справка.
  2. Запустите продукт и загрузите справочные материалы. См. один из следующих разделов:Загрузка справочных материалов с сайта Сайт утилиты обновления справочных материалов и Загрузка справочных материалов с сайта Сайт загрузки справочных материалов.

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

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

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

Установка:

Администратор должен выполнить следующие действия:
  1. Настройка локального сервера для работы с сетевой справкой
  2. На локальном сервере перейти по ссылке Загрузка справочных материалов с сайта Сайт утилиты обновления справочных материалов илиЗагрузка справочных материалов с сайта Сайт загрузки справочных материалов
  3. Предоставить пользователям следующую информацию для подключения к серверу справки:
    • Имя, например имя-продукта Справка. Можно ввести любое имя.
    • Хост
    • Путь
    • Порт
Пользователь должен выполнить одно из следующих действий:

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

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


Комментарии