Программирование: Разработка и отладка программ

Создание справки по новой задаче SMIT

Справка Инструмента управления системой (SMIT) представляет собой расширение программы SMIT. С помощью справочной системы пользователь может получать информацию о компонентах SMIT, используемых для создания окон диалогов и меню. Разделы справки SMIT хранятся в базе данных аналогично исполняемым кодам программ SMIT. В SMIT предусмотрено три способа получения справочной информации:

• Разделы справки man
• Каталог сообщений
• Электронные библиотеки.

Каждому из этих способов соответствует своя процедура получения информации из справочной базы данных SMIT.

Разделы справки man

Предварительные требования

Необходимо заранее создать новую задачу SMIT, для которой требуется справочная информация.

Процедура

1. С помощью любого редактора создайте файл и введите справочную информацию. Формат файла должен соответствовать команде man. В файле должен находиться один раздел справки.
2. Укажите заголовок файла с текстом справки в соответствии с правилами команды man.
3. Поместите файл с текстом справки в подкаталог manual.
4. Протестируйте созданный файл и убедитесь, что он работает с командой man.
5. Найдите файл ASCII, в котором хранится объект настройки новой задачи SMIT.
6. В этом файле найдите поля дескрипторов справки.
7. В качестве значения поля help_msg_loc укажите заголовок файла с текстом справки. Заголовок будет также передаваться в виде параметра команды man. Например:

   help_msg_loc = "xx", где "xx" = строка заголовка
   

   В этом примере команда man выполняется со строкой заголовка xx.

8. Остальные поля дескриптора справки оставьте пустыми.

Каталог сообщений

Предварительные требования

Необходимо заранее создать новую задачу SMIT, для которой требуется справочная информация.

Процедура

1. С помощью любого редактора создайте файл и введите сообщения справки. Формат файла .msg должен соответствовать правилам, описанным в разделе Средства работы с сообщениями - Информация для программистов.

   Примечание: Можно использовать существующий файл .msg.

2. Для каждого сообщения задайте номер набора (Set #) и номер сообщения (MSG#). Они будут использоваться системой для поиска нужного пункта справки.
3. С помощью команды gencat преобразуйте файл .msg в файл .cat. Поместите файл .cat в каталог, который указан в переменной среды NLSPATH.
4. Протестируйте сообщения с помощью команды dspmsg.
5. Найдите файл ASCII, в котором хранится объект настройки новой задачи SMIT.
6. В этом файле найдите поля дескрипторов справки.
7. В каждом разделе найдите поле дескриптора справки help_msg_id. Укажите значения Set# и Msg# для сообщения из файла .msg. Формат этих значений должен соответствовать формату, определенному в Средствах работы с сообщениями. Например, для того чтобы получить сообщение #14 для набора #2, задайте:

   help_msg_id - "2,14"
   

8. Укажите в поле help_msg_loc дескриптора справки имя файла с текстом справки.
9. Остальные поля дескриптора справки оставьте пустыми.

Электронные библиотеки

Предварительные требования

Необходимо заранее создать новую задачу SMIT, для которой требуется справочная информация.

Для создания файлов электронной библиотеки в системе должна быть установлена программа InfoCrafter.

Процедура

1. Создайте файл базы данных с тегами идентификаторов SMIT для текста справки. Идентификаторы SMiT - это скрытые строки поиска, которые ставятся в соответствие тексту в базе данных электронной справки. Формат тегов SMIT следующий: SMiTtopic#tag#, где topic#tag# - строка, содержащая от 4 до 8 цифр. Например:

   SMiT0822369 - это идентификатор SMIT для TCP/IP
   

2. Для того чтобы задать указатель на файл базы данных электронной библиотеки, сначала создайте файл электронной библиотеки. Подробную информацию о формате файла библиотеки можно найти в разделе ispaths.
3. В поле help_msg_id дескриптора справки укажите числовой тег идентификатора SMIT. Например, если тег идентификатора SMIT равен SMiT0822369, введите:

   help_msg_id = "0822369"
   

4. В поле help_msg_base дескриптора справки укажите полное имя файла ispaths, созданного на шаге 2. Программа SMIT считывает файл электронной библиотеки, связанный с нужным томом справки.
5. В поле help_msg_book дескриптора справки укажите то же значение, что и в поле name файла, заданного в поле help_msg_base.

Связанная информация

Глава 25, Инструмент управления системой (SMIT)

Средства работы с сообщениями - Информация для программистов

Типы окон SMIT , Классы объектов SMIT , Псевдонимы и команды быстрого доступа SMIT , Дескрипторы информационных команд SMIT и Создание и выполнение команд SMIT

Добавление задач в базу данных SMIT и Отладка расширений базы данных SMIT

Команды dspmsg, gencat, man, smit

Файл ispaths