3.4. Лекция №16. Разработка справочной системы
Каждый приличный программный продукт должен иметь справочную систему, которая дает возможность пользователям понять как работает и какие возможности имеет определенная программа. Справочная система или просто справка может быть разработана в двух форматах: .hlp и .chm. Данные форматы созданы компанией Microsoft. Формат .hlp уже не является актуальным, но все равно иногда встречается. В настоящее время большей популярностью пользуется формат .chm [30].
Справка, которая имеет формат .chm, представляет собой набор веб-страниц, написанных с помощью языка HTML. Такая справка может содержать помимо текста, также таблицы, рисунки и ссылки.
Перед тем, как начинать разрабатывать CHM-справку, необходимо скачать программу, которая называется HTML Help Workshop. Данная программа распространяется бесплатно и ее можно найти на официальном сайте компании Microsoft. С помощью возможностей программы HTML Help Workshop набор HTML-файлов, в которых содержится справочный материал, компилируется в итоговую CHM-справку [30].
Сама по себе CHM-справка очень похожа на электронную книгу, которая имеет различные интерактивные возможности, например, гиперссылки, поиск. CHM-справка содержит в себе дерево каталогов, которое является также и содержанием, список идентификаторов тем и функцию поиска по всему содержанию справки [30].
Создание справки имеет смысл выполнять по следующему плану:
– спроектировать общую структуру справки, то есть определить темы, которые будут содержаться в справке;
– используя любой текстовый редактор необходимо составить справочный материал по каждой теме справки;
– текстовые файлы со справочным материалом следует преобразовать в файлы формата .html; чтобы конвертировать текстовый файл в HTML-файл необходимо, во-первых, открыть программу Microsoft Word 2010 или выше, во-вторых, в диалоговом окне сохранения файла в выпадающем списке типов файлов выбрать строчку с надписью «Документ HTML»;
– запустить программу HTML Help Workshop, создать новый проект справки и добавить в него HTML-файлы со справочным материалом [30].
После открытия программы HTML Help Workshop необходимо создать проект. Делается это следующим образом: в главном меню нужно выбрать «File», а затем «New»; откроется окно создания различных объектов; выделить строчку с надписью «Project»; нажать кнопку «OK». В итоге создастся файл проекта, который будет иметь расширение .hhp. Окно создания новых объектов представлено на рисунке 3.6.
Рисунок 3.6 – Окно создания нового объекта в HTML Help Workshop
Помимо нового проекта в окне создания можно выбрать следующие объекты, которые являются элементами единой справки:
– «Text» – обычный текстовый файл;
– «HTML File» – веб-страница с базовой разметкой;
– «Table of Contents» – файл, в котором находится содержание справки;
– «Index» – файл с указателями на темы справочного материала [30].
После того, как был создан главный файл проекта нужно создать файл содержания справки, для этого нужно создать объект «Table of Contents». Окно, в котором создается дерево каталогов или содержание справки, продемонстрировано на рисунке 3.7.
Рисунок 3.7 – Окно создания содержания в HTML Help Workshop
После создания файла с содержанием справки, который имеет расширение .hhc, необходимо создать объект «Index», который содержит список идентификаторов тем. Данный файл будет иметь расширение .hhk [30]. Окно, в котором создаются идентификаторы тем справочного материала, представлено на рисунке 3.8.
Рисунок 3.8 – Окно создания индекса тем в HTML Help Workshop
Как только созданы основные объекты справки необходимо перейти к настройке CHM-файла. Завершим настройку CHM-файла, нужно сохранить проект при помощи меню, в котором нужно выбрать «File» и «Save Project».
Последним шагом в процессе создания справочной системы будет компиляция CHM-файла. Для этого необходимо в главном меню выбрать «File», а после «Compile». Если до этого момента все было сделано верно, то на экране появится отчет об успешно выполненной компиляции.
Наконец необходимо подключить CHM-справку к программному продукту. Для начала следует файл справки поместить в папку с программой. Затем нужно создать новый TMenuItem, у которого в событии OnClick прописать следующий код: shellexecute (handle, 'open', 'help.chm', nil, nil, sw_shownormal). В завершении всего нужно прописать функцию SHELLAPI в разделе USES. Это нужно для того, чтобы функция shellexecute работала.