6.
РАЗРАБОТКА СИСТЕМЫ ОПЕРАТИВНОЙ СПРАВКИ
Существует множество программных продуктов, предназначенных
для разработки собственной системы оперативной справки. Рассмотрим один из них
– HTML Help Workshop. Это самостоятельный продукт фирмы Microsoft. Его версия 1.1 входила в состав Visual FoxPro 6.0. Сейчас он не является составной
частью Visual FoxPro. Самую последнюю версию можно найти на Web-сервере
http://www.microsoft.com/workshop/author/htmlhelp.
В этом разделе рассмотрена работа с HTML Help Workshop 1.3. Обязательно прочтите файл ReadMe, входящий в состав продукта. До сих пор в
HTML Help Workshop имеется ряд проблем. В этом файле
разработчики разъясняют способы их решения.
Для отображения системы оперативной справки HTML Help Workshop использует Internet Explorer. После компиляции системы справки HTML Help Workshop создает файл с расширением .chm. Это
файл контекстно-зависимой справки. Находясь в любом месте программного комплекса,
пользователь может получить помощь, нажав клавишу F1.
Рассмотрим последовательно все этапы создания файла справки
к нашему приложению: RealEstate.chm.
Этап 1. Для каждой страницы оперативной справки
создайте отдельный HTML-файл. Все страницы поместите в отдельную
папку с именем HTML папки HELP. Для создания HTML-файлов можно использовать Microsoft Word. Побеспокойтесь о фоновом рисунке и
фоновом звуке каждой страницы. Это позволит качественно поднять уровень оформления
системы справки с минимальными затратами. Для назначения фона страницы в
главном меню Microsoft Word выберите пункт Формат, в появившемся меню – пункт Фон.
Появится окно. Выберите в нем второй пункт Способы заливки. Следующее окно даст
возможность назначить фоновый рисунок из коллекции Microsoft Word или выбрать из файлов рисунков, имеющихся в распоряжении
разработчика. Для назначения фонового звука страницы – мелодии, которая будет
звучать все время, пока пользователь видит ее содержимое - в главном меню Microsoft Word выберите пункт Вид, в появившемся меню – пункт Панели
инструментов. В раскрывшемся списке панелей сделайте щелчок по пункту Web-компоненты. Панель появится на экране (рис. 6.1). Выберите
пиктограмму Фоновый звук. В появившемся окне назначьте файл.
Созданную страницу сохраните в формате HTML. Для этого в главном меню Microsoft Word выберите пункт Файл, в появившемся меню – пункт Сохранить как Веб-страницу.
Укажите тип файла: Веб-страница. Обратите внимание!
По умолчанию в окне указан тип: Веб-страница в одном
файле. Выполните правильное назначение. Установите гиперссылки между HTML-файлами. Ссылок должно быть столько, сколько
необходимо для толковой работы.
Этап 2. Запустите HTML Help Workshop.
В его главном окне
выберите пункт File. В открывшемся меню пункт New. Появится окно New. Выберите в нем первый пункт Project и щелкните по кнопке OK. HTML Help Workshop предложит ввести имя проекта и включить в
него уже имеющиеся у разработчика компоненты проекта. У нас пока ничего нет. Ограничимся именем:
RealEstate.hhp.
Этап 3.
Откройте файл проекта RealEstate.hhp. На первой вкладке с именем Project увидите семь пиктограмм (рис. 6.2).
Выберите вторую пиктограмму Add/Remove topic files
(включение в проект HTML-страниц).
Добавьте в проект все созданные на первом этапе HTML-страницы.
Определимся с первой пиктограммой Change project options (Определение параметров проекта).
Щелчок по ней откроет окно Options с четырьмя вкладками. На вкладке General (Общие)
определите:
· заголовок окна справки;
· файл страницы, которая будет отображена в
окне при первом запуске системы оперативной справки;
· язык и шрифт.
На вкладке Files укажите название и расположение файла скомпилированной справки, а также
файлов с содержанием тем справки и с указателями.
Вид вкладки Compiler (Компилятор) показан на рис. 6.3. Отметьте флажками необходимые
объекты и действия.
Рис. 6.3 Вкладка опций компилятора.
Этап 4. Для создания содержания справочной
системы перейдем на вторую вкладку HTML Help Workshop с названием Contents (Содержание). Она содержит 11 пиктограмм
(рис. 6.4). Первая пиктограмма Contents properties предназначена для выбора внешнего вида вкладки содержания
справочной системы. Выберите тип заголовка (значок папки или раскрытой книги).
Можно также назначить свои значки.
Для добавления заголовка щелкните по второй пиктограмме Insert a heading. Для добавления страницы предназначена
третья пиктограмма
Insert a page. Содержание тем справочной системы можно
расположить в иерархическом виде. Допускается добавление заголовков нескольких
уровней вложенности.
Для изменения уровня заголовка или страницы воспользуйтесь
пиктограммами со стрелками.
Рис. 6.4. Вторая вкладка HTML Help Workshop с названием Contents (Содержание).
После четырех этапов мы создали все основные компоненты
справки. Отсутствует только средства контекстно-зависимой справочной системы.
Однако даже в таком виде наша оперативная справка работоспособна. Откомпилируйте
ее, щелкнув по последней пиктограмме Save all files and compile первой вкладки
Project продукта HTML Help Workshop. При запуске на выполнение файла RealEstate.chm всегда будет отображаться назначенная стартовой HTML-страница Introduction (Введение).
Для создания справочной системы, работающей совместно с
приложением, необходимо связать объекты Visual FoxPro нашего приложения с файлами HTML-страниц.
Как правило, это сами формы и объекты, расположенные в них. Посредниками в этом
деле выступают псевдонимы тем, константы HelpContextID (индексы тем) и
файл связи RealEstate.h. Вид цепочки связи показан на рис. 6.5.
Рис. 6.5. Связь между нажатием клавиши F1 и запуском нужной HTML-страницы
Этап 5. Для назначения псевдонимов тем, необходимых для
создания контексно-зависимой справочной системы, откройте
окно HtmlHelp API information (рис. 6.6), выбрав четвертую пиктограмму первой вкладки Project продукта HTML Help Workshop. Перейдите на вторую вкладку Alias (Псевдоним). После нажатия Add (Добавить) откроется окно Alias. Укажите в нем Псевдоним, имя файла и
комментарий. Имя псевдонима вводится с клавиатуры. Имя HTML-файла выбирается из списка. Если файла в
списке нет, вернитесь к третьему этапу и добавьте в список файлов
отсутствующий.
Рис. 6.6. Диалоговое окно HtmlHelp API information.
Имя псевдонима HTML-файла лучше всего назначать осмысленно. Лениться не
следует. Даже в небольшом файле справки можно запутаться с именами объектов и
соответствующими им файлами. Про имена типа A1 или Ааа следует забыть. Два примера имени псевдонима:
Form_Building
(Форма просмотра списка зданий)
Form_Building_Combo1_Street
(Список улиц в форме зданий)
Этап 6. Разберемся с индексами тем (свойство HelpContextID объекта
Visual FoxPro). Запустите
Microsoft Visual FoxPro. Выберите объект. Это может
быть Form, CheckBox, ComboBox, CommandButton, EditBox, Grid, Image, Label, ListBox, Page
и др. Установите в качестве значения
этого свойства выбранного объекта уникальное число. Сколько объектов вы хотите
связать с файлами страниц – столько чисел. Каких – не
важно, главное, чтобы они не повторялись. В примере RealEstate они
пронумерованы по порядку, начиная с сотни.
Этап 7. Назначим связи между псевдонимами и индексами тем. Информация
об этом хранится в Map-файле. Это простой текстовый
файл с расширением .h. В
нашем примере – RealEstate.h. Для его создания применим стандартную программу Windows – Блокнот.
Несколько строчек из файла RealEstate.h:
#define Form_Login 100
//Форма Login связана с Файлом HTML\Part 04_2_1.htm
#define Form_Access
101 //Форма
Access связана с файлом
HTML\Part 04_2_2.htm
#define Form_Street
104 //Форма
Street связана с файлом
HTML\Part 04_3_3.htm
Комментарий
после числа, который начинается со знака //, можно вообще не писать.
Осталось включить имя этого файла в проект RealEstate.hhp. Запустите HTML Help Workshop. Откройте
проект. Выберите четвертую пиктограмму первой вкладки Project. Появится
окно HtmlHelp API information (рис. 6.7). Добавьте Map-файл RealEstate.h.
Рис. 6.7. Первая вкладка окна HtmlHelp API Information
Этап
8. Откомпилируйте файл справки. щелкнув по последней
пиктограмме Save all files and compile первой вкладки Project .