2. Проект довідкової системи

Перетворення файла довідкової інформації у файл довідкової системи виконує вхідний в склад Microsoft Help Workshop компілятор. Початковими даними для компілятора є довідкова інформація, представлена у вигляді rtf-файлів, і файл проекту довідкової системи.

Для того щоб перетворити довідкову інформацію, підготовлену в редакторі тексту, в довідкову систему, спочатку треба створити файл проекту довідкової системи. Для цього потрібно запустити Microsoft Help Workshop і в меню File вибрати команду New | Help Project (рис. 4). На екрані з'явиться діалогове вікно Project File Name. В цьому вікні (рис. 5) треба відкрити теку, в якій знаходиться файл довідкової інформації (rtf-файл), задати ім'я проекту і натиснути на кнопці Зберегти. В результаті цих дій буде створений файл проекту (hpj-файл) і стане доступним вікно проекту довідкової системи (рис. 6).

Рис. 4. Початок роботи над новим проектом

Перше, що треба зробити, — це додати в проект rtf-файл, в якому знаходиться довідкова інформація. Для цього потрібно спочатку натиснути на кнопці Files, потім у вікні Topic Files, що відкрилося — на кнопці Add (рис. 7).

На екрані з'явиться стандартне діалогове вікно Відкриття файла, використовуючи яке можна вибрати потрібний rtf-файл. Якщо довідкова інформації: розподілена по декількох файлах, то операцію додавання файла потрібно повторити.

Рис. 5. В полі Ім'я файлу треба ввести назву проекту

Рис. 6. Вікно проекту довідкової системи

Після того, як всі потрібні файли будуть вибрані, треба у вікні Topic Files натиснути на кнопці ОК. В результаті цих дій знов стане доступним вікно проекту, в розділі [FILES] якого будуть перераховані файли, в яких знаходиться довідкова інформація.

кнопці Add (рис. 8.8). На екрані з'явиться вікно Add Map Entry (рис. 8). В полі Topic ID цього вікна треба ввести ідентифікатор розділу довідки (ідентифікатори були призначені розділам під час створення rtf-файла), в полі Mapped numeric value — число, що ідентифікує розділ. В полі Comment можна ввести коментар — назва розділу довідки. Після того, як будуть призначені числові значення ідентифікаторам розділів довідки, вікно Map можна закрити.

Рис. 7. Щоб додати в проект rtf-файл, клацніть на кнопці Add

Рис. 8. Призначення ідентифікатору розділу числового значення

Останнє, що треба зробити, — це побудувати вид вікна довідкової інформації. Для цього треба у вікні проекту натиснути на кнопці Windows, в полі Create window named вікна Create window (рис. 9), що відкрилося ввести слово main і натиснути на кнопці ОК.

Рис. 9. Діалогове вікно Рис. 10. В полі Title bar text треба ввести Create window заголовок вікна довідкової системи

На екрані з'явиться вікно Window Properties, в полі Title bar text вкладк General якого потрібно ввести заголовок головного вікна створюваної спрг вочной системи (рис 10).

Рис. 11. Робота над проектом простої довідкової системи завершена; можна виконати компіляцію

На цьому процес створення проекту простої довідкової системи можна вважати завершеним (рис. 11). Тепер можна виконати компіляцію. Для цього треба в меню File вибрати команду Compile, в діалоговому вікні Compile Help File, що з'явилося встановити прапорець Automatically display Help file in WinHelp when done (Автоматично показувати створену довідкову систему після закінчення компіляції) і натиснути на кнопці Compile (рис. 12).

Рис. 12. Щоб виконати компіляцію, треба натиснути на кнопці Compile

Після закінчення компіляції на екрані з'явиться вікно з інформаційним повідомленням про результати компіляції і, якщо компіляція виконана успішно, вікно створеної довідкової системи. Файл довідкової системи (Hlp-файл) компілятор помістить в ту теку, в якій знаходиться файл проекту.

Вивід довідкової інформації

Звичайно вікно довідкової системи стає доступним в результаті натиснення клавіші <F1> або вибору в меню Довідка команди ?.

Для того щоб під час роботи програми користувач, натиснувши клавішу <F1>, міг отримати довідкову інформацію, треба щоб властивість HelpFile головного вікна додатку містила ім'я файла довідкової системи, а властивість HelpContext - числовий ідентифікатор потрібного розділу (рис. 13).

Для кожного компоненту форми можна задати свій розділ довідки. Роздягнув довідки, який з'являється, якщо фокус знаходиться на компоненті і користувач натискує клавішу <F1>, визначається значенням властивості HelpContext цього компоненту. Якщо значення властивості І sipContext елемента управління рівно нулю, то при натисненні клавіші <F1> з'являється той розділ довідки, який заданий для форми додатку.

Для того щоб довідкова інформація з'явилася на екрані в результаті вибору в меню ? команди Довідка, треба створити функцію обробки події Onclick для відповідної команди меню. Процес створення функції обробки події для команди меню нічим не відрізняється від процесу створення функції обробки події для елемента управління, наприклад, для командної кнопки: в списку об'єктів треба вибрати об'єкт типу Tmenuitem, для якого створюється функція обробки події, а у вкладці Events — подія.

Рис13. Властивість HelpFile повинна містити ім'я файла довідки, а властивість HelpContext — ідентифікатор розділу

Нижче приведена функція обробки події Onclick для команди Довідка меню ?.

// вибір в меню ? команди Довідка

void _fastcall TForml: :N3Click (TObject *Sender)

{

WinHelp(Form1->Handle, "saper.hlp", HELP_CONTEXT, 1) ;

}

Вивід довідкової інформації виконує функція winHelp, якій як параметра передається ідентифікатор вікна програми, яка запрошує вивід довідкової інформації, файл довідки, константу HELP_CONTEXT і ідентифікатор розділу, вміст якого повинен бути відображений.

2. HTML Help Workshop:

1.Підготовка довідкової інформації

Підготувати довідкову інформацію в Html-форматі можна за допомогою будь-якого редактора тексту. Найбільш швидко це можна зробити, якщо редактор дозволяє зберегти набраний текст як Html-документ. Можна скористатися і вбудованим редактором Microsoft HTML Help Workshop, але для цього треба знати мову HTML (принаймні, його основи).

В найпростішому випадку вся довідкова інформація може бути поміщена в один Html-файл. Проте якщо для навігації по довідковій системі передбачається використовувати вкладку Зміст (див. рис. 8.15), в якій будуть перераховані розділи довідкової інформації, то в цьому випадку інформацію кожного розділу потрібно помістити в окремий Html-файл.