середу, 27 березня 2019 р.

Практика створення довідкової системи

Будь-який серйозний проект повинен бути забезпечений докладною довідковою системою, що дозволяє користувачеві розібратися з тим, як працює ваша програма.
Довідка може бути двох форматів: * .hlp і * .chm. Обидва формати розроблені корпорацією Microsoft. Формат HLP є застарілим, хоча і зустрічається до сих пір, але зараз найбільш поширеним форматом довідки в середовищі Windows є CHM, його і розглянемо.
CHM (Microsoft Compressed HTML Help, Microsoft Compiled HTML Help, CHM) - формат файлів контекстної довідки, розробленої Microsoft в 1997 році в якості заміни формату WinHelp - HLP. Файл CHM є стислим набором HTML-сторінок, свого роду, електронною книгою, і може містити весь набір Web-сторінок: текст, таблиці, малюнки, посилання, медіа-файли, та інше, що робить таку довідкову систему потужним інструментом.
Розглянемо інструмент - Microsoft HTML Help Workshop. Як видно з назви, програма розроблена корпорацією Microsoft, є безкоштовним, вільно поширюваним продуктом.
HTML Help Workshop (hhw.exe) - програма дозволяє створювати всі необхідні файли довідки, з яких потім компілюється єдиний проект.
Завантажити програму HTML Help Workshop

Практична робота


1. Створимо проект в Lazarus
Форма буде містити тільки один об'єкт

І зробимо наступні налаштування для меню:


І для пункту підменю:

Зберігаємо проект і перевіряємо як працює (поки що):


2. Створимо для проби простий html-документ:


Назву дамо відповідно до назви проекту Lazarus з розширенням .htm

3. Запускаємо програму HTML Help Workshop

Виконуємо покроково інструкцію
а) створюємо новий проект


б) пропускаємо крок

в) обираємо папку з проектом і даємо назву відповідно до проекту Lazarus



г) так як html-файл у нас створений, то відповідно ставимо галочку


д) додаємо цей html-файл до проекту



е) проект створено



ж) скомпілюємо довідку


 це результат компіляції
 програму закриваємо.

4. Перевіримо папку з проектом:


5. Під'єднаємо довідку до проекту Lazarus:


procedure TForm1.HelpHelpClick(Sender: TObject);
begin
   WinExec('hh.exe project.chm',SW_SHOW);
end;

І останній крок, дописати системну бібліотеку:


6. Зберігаємо, запускаємо і маємо результат:



Немає коментарів:

Дописати коментар