Установка пользовательской документации в z/OS Explorer

Если в организации используются процессы и процедуры работы системы, может потребоваться включить их в оглавление справки z/OS® Explorer, чтобы пользоваться ими во время работы с z/OS Explorer. Можно создать собственный модуль документации и полностью интегрировать его с оглавлением справки z/OS Explorer или временно интегрировать имеющиеся HTML-файлы и текстовые файлы для работы с функцией поиска по справке z/OS Explorer.

Создание модуля

z/OS Explorer создан на основе платформы с открытым исходным кодом Eclipse, которая представляет собой расширяемую среду разработки. С помощью платформы Eclipse можно создать инструменты, которые беспрепятственно интегрируются со средой и другими инструментами. Ключом к беспрепятственной интеграции инструментов с Eclipse является модуль. За исключением небольшого ядра времени выполнения, все остальное в Eclipse - модули. Это значит, что разработанный вами модуль интегрируется с Eclipse, а поэтому и с z/OS Explorer, таким же самым образом, как и другие модули.

Когда создается модуль документации, он полностью интегрируется с z/OS Explorer и содержимое выводится в справке.

Создать собственный модуль документации можно с помощью среды разработки модулей Eclipse (PDE), которая встроена в интегрированную среду разработки (IDE) Eclipse. Исходный код Eclipse IDE открыт, его можно загрузить с веб-сайта Eclipse http://www.eclipse.org. В документации объяснено, как приступить к работе, а в памятке приведены пошаговые инструкции по созданию модуля.

Интеграция HTML-файлов и текстовых файлов с поиском по справочной системе z/OS Explorer

Если модуль документации еще не создан, а у вас есть HTML-файлы или текстовые файлы, к которым требуется обращаться из z/OS Explorer, то можно поместить их в специальную папку, чтобы они были включены в индекс поиска z/OS Explorer. Во время поиска справочной информации все совпадения, найденные в документации, выводятся наряду с результатами поиска z/OS Explorer. Однако при просмотре оглавления справки документы не выводятся.

Этот способ интеграции HTML-файлов и текстовых файлов является лишь временным решением, которое можно использовать до создания модуля документации.

Для включения HTML-файлов или текстовых файлов в индекс поиска z/OS Explorer требуется выполнить следующие действия:

  1. Откройте меню рабочей среды Справка > Управление пользовательской документацией. Откроется окно администратора файлов с содержимым папки mydocs z/OS Explorer.
  2. Скопируйте все HTML-файлы или текстовые файлы, которые требуется добавить в z/OS Explorer, и вставьте их в папку mydocs.
  3. Закройте окно mydocs.
  4. Откройте меню рабочей среды Справка > Перестроить индекс поиска. Откроется окно с запросом подтверждения. Для этой операции требуется перезапустить z/OS Explorer.
  5. Нажмите кнопку OK для продолжения или кнопку Отмена, если в данный момент не требуется перезапускать z/OS Explorer. Шаг повторного создания необходимо повторить для файлов, которые требуется включить в поиск по справочной системе.

После перезапуска z/OS Explorer функция поиска по справочной системе будет учитывать вашу собственную документацию наряду с документацией z/OS Explorer. Все результаты, найденные в вашей документации, будут выведены перед результатами, найденными в документации z/OS Explorer.

Примечание: Если результаты будут найдены в HTML-файлах, то будет выводиться имя файла из пары тегов <Title></Title>. Однако в текстовых файлах нет тега title, поэтому результаты поиска по текстовым файлам будут выводиться в виде путей к файлам, как показано на снимке экрана Снимок экрана с результатами поиска, на котором результаты поиска по документации заказчика выведены перед остальными результатами. У двух первых результатов - надлежащие заголовки, потому что это HTML-файлы. Следующие 3 результата показаны в виде путей к файлам, поскольку это текстовые файлы..

Родительский раздел: Задачи