13.Создание файлов помощи
Качественное приложение обеспечивает пользователя справочной системой. Для этого оно включает в свой состав справочный файл с расширением HLP, который автоматически вызывается при нажатии клавиши <F1> или при выборе соответствующего пункта меню, например, с названием Помощь (Help). Пример окна справочной системы можно увидеть на Рис. 22.
Рис. 22. Компоненты документа справочной системы
Для создания таких справочных систем существует несколько приложений: HTML Help WorkShop, Help&Manual, Microsoft Help Workshop. Сравнительный анализ возможностей данных редакторов вы можете прочитать в документе Редакторы справочных систем.htm.
В рамках данной лабораторной работы мы рассмотрим создание справочной системы с помощью редактора Microsoft Help Workshop по двум причинам:
Данное приложение входит в состав практически всех инструментальных сред разработки и поэтому нет необходимости предпринимать какие-либо действия для получения данного приложения;
Все приложения, работающих под управлением семейства ОС Windows, настроены на работу со стандартным приложением ОС Windows WinHelp, которая работает с файлами *.hlp, а не *.html (формат документов HTML Help WorkShop и HTML2CHM).
В этом случае технология создания справочной системы следующая:
Подготовка текстового файла в формате RTF;
Назначение атрибутов разделам справочной системы, чтобы было понятно, что является разделом, где начинается список ключевых слов и. т. д.;
Указание ссылок, чтобы будущий документ работал как гипертекстовый документ;
Преобразование файла RTF в формат HLP, называемое компиляцией справочного файла помощью программы MS Help Workshop.
Создание файла структуры справочной системы;
Для демонстрации данной технологии решим следующую задачу: снабдим приложение First.exe справочным файлом.
Реализация первого этапа – создание RTF документа1, не составит труда, поэтому мы приступим к подробному изложению со второго пункта.
Назначение атрибутов разделам справочной системы
Текстовый документ сначала необходимо разделить на разделы, так как каждый раздел справки оформляется отдельным разделом документа (см. Рис. 23).
Рис. 23. Раздел документа, соответствующего разделу справки
Задание 2
Разбейте подготовленный RTF документ First_help.rtf на разделы.
Сохраняйте созданные файлы во вложенную папку папки проекта.
В конце каждого раздела поместите строку с перечислением через точку с запятой ключевых слов раздела2. Например, в конце раздела «Назначение проекта» можно указать слова ИМЯ и ПОЛЕ ВВОДА.
Далее необходимо установить атрибуты каждого раздела, т. е. указать, где его заголовок, а где ключевые слова. Существует несколько типов атрибутов, указанных в Табл. 2.
Табл. 2Атрибуты разделов
-
Атрибут
Значение
#
Контекст – текстовая строка, однозначно идентифицирующая раздел (чаще всего это порядковый номер раздела)
$
Заголовок – название, под которым раздел появляется при поиске в конце справки
K
Список ключевых слов – слова для поиска в окне справки
Атрибуты назначаются с помощью сносок в виде специального символа, соответствующего атрибуту.
Задание 3
Вставьте обычные сноски контекста и заголовка, соответствующие заголовкам каждого раздела. В значении сноски контекста укажите номер раздела;
Вставьте обычные сноски списка ключевых слов для каждого раздела, перечисляя их через точку с запятой;
Сравните первый раздел Вашего документа с Рис. 24.
Рис. 24. Результат вставок сносок