Тема содержания
Тема определяет узел в древовидной структуре оглавления. При выборе этого элемента можно раскрыть или свернуть подчиненную ему структуру содержания.
Title – название темы, которое отображается в оглавлении, не более 127 символов.
Раздел справочной системы
Радел является конечным элементом в структуре оглавления. При его активизации мышью открывается окно справочной системы с содержанием раздела.
Title – название раздела (127 символов).
Topic ID – идентификатор раздела, который определен в текстовом файле.
Help file – имя и путь к файлу справочной системы, который содержит этот раздел.
Window type – тип вторичного окна справочной системы, в котором отображается информация из раздела.
Макрокоманда
Макрокоманда является конечным элементом в структуре оглавления. При активизации ее мышью выполняется соответствующая макрокоманда.
Title – название макрокоманды (127 символов).
Macro – выполняемая макрокоманда.
Включаемое оглавление
Этот элемент позволяет использовать в создаваемом содержании уже созданную структуру, размещенную в другом файле. При отображении в макете этот элемент представляется именем этого файла, а при работе со справочной системой он заменяется содержимым этого файла.
Include File – имя и путь к включаемому файлу содержания справочной системы.
Создание иерархии содержания.
Структура содержания представляет собой не только набор, но иерархию тем, разделов и макрокоманд. Обычно, у темы имеются подчиненные разделы, макрокоманды и, возможно, другие подчиненные темы, которые отображаются при ее выборе. Сначала содержание формируется на верхних уровнях. Все темы содержания установлены у левого края окна макета. Чтобы определить для выбранного в макете элемента более глубокий уровень иерархии, требуется нажать кнопку Move Right (Перемещение вправо). Максимальное количество уровней в содержании – 9. Чтобы, наоборот приблизить выделенный элемент содержания к верхнему уровню, требуется нажать кнопку Move Left (Перемещение влево).
Чтобы удалить элемент из макета содержания справочной системы, нужно нажать кнопку Remove (Удалить). Для редактирования параметров выделенного элемента макета нужно нажать кнопку Edit (Редактирование).
В редакторе содержания справочной системы можно также определить характеристики, связанные с подключением к справочной системе дополнительных текстовых файлов и DLL-библиотек. Эти файлы требуются при разработке сложной справочной системы, включающей несколько файлов.
После нажатия кнопки Tabs (Страницы) появляется окно Custom Tabs (Дополнительные страницы), в котором можно определить использование дополнительных страниц с закладками в основном окне справочной системы. Для этого требуется специально созданная DLL-библиотека.
При нажатии на кнопку Link Files (Файлы связи) в появляющемся окне Help Link Files (Файлы связи справочной системы) нужно определить список файлов, которые будут использоваться для поиска основных и альтернативных ключевых слов.
Нажатие на кнопку Index Files (Индексные файлы) приводит к появлению окна Index Files (Индексные файлы). В нем определяются справочные файлы, в которых ключевые слова отображаются на странице Index (Индекс) основного окна программы Winhlp32.
Пример № 3: Создание содержания справочной системы для приложения, работающего с БД «Телефонная книжка».
Создадим содержание справочной системы на основе существующего текстового файла.
Откроем редактор содержания справочной системы. Для этого запустим утилиту Microsoft Help Workshop, как сказано выше. Затем выполним команду меню File|New. В появившемся окне New выберем из списка действий значение Help Contents и нажмем кнопку ОК. После этого будет открыто главное окно редактора файла содержания справочной системы.
Зададим имя справочного файла, используемое по умолчанию. Для этого нажмем кнопку Edit в верхней части, справа, главного окна редактора файла содержания. В появившемся окне Default Help Information в строке ввода Default Help filename запишем путь и имя файла Help.hlp, после чего нажмем кнопку ОК. В главном окне редактора файла содержания в строке Default filename (and window) отобразиться введенное значение.
Зададим заголовок, который будет у основного окна программы Winhlp32. Для этого снова нажмем кнопку Edit и в появившемся окне Default Help Information в строке ввода Default Title запишем текст - “Справочная система “Телефонной книжки””, после чего нажмем кнопку ОК. В главном окне редактора файла содержания в строке Default title отобразиться введенное значение.
Создадим элемент содержания – тему “О программе”. Для этого нажмем кнопку Add Above. В появившемся окне Edit Contents Tab Entry выберем переключатель Heading. Затем введем в строку Title (она окажется единственной доступной строкой ввода) текст “О программе” и нажмем кнопку ОК.
Создадим элемент содержания – раздел “Назначение, состав и возможности”. Для этого нажмем кнопку Add Below. В появившемся окне Edit Contents Tab Entry выберем переключатель Topic. Затем введем в строку Title текст “Назначение, состав и возможности”, в строку Topic ID – текст “MainTopic” и нажмем кнопку ОК.
Аналогично п.3 создадим элемент содержания – тему “Основные элементы программы”, отличием будет то, что в строке ввода Title нужно будет ввести текст “Основные элементы программы”.
Аналогично п.3 создадим элемент содержания – тему “Элементы отображения информации”, отличием будет то, что мы сдвинем его вправо кнопкой Move Right, т.к. это будет следующей ступенью иерархии (более глубокий уровень).
Аналогично п.4 создадим элемент содержания – раздел “Строки ввода” (Topic ID = “Edit”), который будет принадлежать теме “Элементы отображения информации”.
Аналогичным образом создадим элемент содержания – раздел “Таблица” этой же темы (Topic ID = “Grid”).
Создадим следующий элемент содержания – тему “Меню”, которая будет того же уровня иерархии, что и тема “Элементы отображения информации”, для этого после ее создания нажмем кнопку Move Left, чтобы приблизить этот элемент к вершине иерархии.
Создадим элементы содержания – разделы “Пункт меню “Файл””, “Пункт меню “Поиск”” и “Пункт меню “Сортировка”” с идентификаторами (Topic ID) File, Seek и Sort соответственно, причем они будут входить в тему “Меню”.
Создадим последовательно следующие разделы содержания – “Навигаторы” (Topic ID = “Navigator”) и “Завершение работы” (Topic ID = “Close”), которые будут входить в тему “Основные элементы программы”, для чего воспользуемся кнопкой Move Left.
В результате всех произведенных действий должна получиться следующая структура содержания:
Сохраним файл содержания под именем Help.cnt. Для этого зададим команду меню File|Save.
Создание файла проекта справочной системы:
На этом этапе также используется утилита Microsoft Help Workshop.
Файл описания проекта справочной системы.
При создании справочной системы программы необходимо определить состав входящих в нее файлов. Можно также определить параметры, которые используются при отображении и использовании справочной информации. Все эти настройки устанавливаются в файле описания проекта, который необходим для компиляции справочного файла.
Файл описания проекта является текстовым файлом в формате ASCII с расширением .hpj. Информация в нем содержится в нескольких секциях.
Для создания файла описания проекта требуется выполнить следующие действия: задать команду меню File|New, затем в появившемся окне New нужно выбрать в списке действий значение Help Project (Описание проекта справочной системы) и нажать кнопку ОК.
Окно редактора содержит строку ввода Help File (Файл описания) с именем создаваемого файла, которое можно изменять. Целесообразно менять это имя файла проекта при внесении в работающий вариант изменений, чтобы получать различные версии справочной системы.
При определении многих параметров справочной системы в файле описания проекта создается список их однотипных значений. Непосредственно исправлять этот список нельзя. Чтобы изменить содержимое списка значений, нужно воспользоваться следующими кнопками, находящимися в правой части окна определения параметров:
Add – предназначена для добавления нового элемента в список.
Remove – удаление выбранного параметра из списка.
Include – включение в список файла, в котором содержится подготовленный соответствующим образом список значений параметров.
Edit – редактирование выбранного элемента из списка.
ОК и Cancel.
Определение параметров создания справочной системы.
При создании справочной системы требуется определить ряд ее характеристик, которые будут управлять процессом компиляции справочного файла и определять его состав. Для этого требуется нажать кнопку Options (Характеристики) в основном окне редактора файла описания проекта.