2 Створення систем електронної підтримки

2.1 Мета заняття

Навчитися створювати довідкові системи, які є одним з ефективніших засобів підтримки користувача програмного продукту (ПП) та являються однією із складових поняття інтерфейс. Ознайомитися на практиці з HTML Help Workshop (hhw.exe) – утилітою для перетворення необхідної інформації, що представлена у форматі .html, у вигляд стандартної довідки з розширенням .chm.

2.2 Методичні вказівки з організації самостійної роботи студентів

2.2.1 Електрона підтримка як засіб зменшення витрат на підтримку ПП та засіб, що спрощує користувачеві процес створення концептуальної моделі роботи з ПП

Розробники інтерфейсів ПП в своєї роботі все більше орієнтуються на користувачів, які навчаються в процесі взаємодії з програмою. І дійсно, більшість людей, користуючись ПП, отримують та аналізують нову інформацію та згодом перетворюють її в свій досвід. Тобто навчаються.

В сучасному світі важко відділити процес роботи з ПП від процесу навчання, тому ПП самі мають пропонувати користувачам різні способи та засоби їх вивчення вже у процесі роботи з ними.

ПП, які Ви будете купувати або розроблювати у майбутньому, мають пропонувати навчаючі допоміжні елементи: візуальний зворотний зв’язок, систему електронної допомоги, Майстрів (Wizards) тощо. Усі ці аспекти програмної системи підпадають під загальне поняття електронної підтримки.

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

За звичай користувачі при роботі з ПП ставлять такі запитання:

• що я можу зробити за допомогою цієї програми?

• що це таке?

• що воно робить?

• де я зараз, куди можу перейти?

• що трапилось, що це означає?

• що я може зробити зараз?

Довідкова система та контекстна допомога мають відповідати саме на такі запитання. Інформація надається ними за запитом користувача, саме тоді, коли він її потребує ( а не заздалегідь, що буває на тренінгах), саме в тій формі, яка йому підходить.

2.2.2 Створення довідкових систем

Microsoft HTML Help є стандартною довідковою системою для платформи Windows. Довідка у форматі HTML Help підходить для широкого спектра додатків, в тому числі навчальних посібників, інтерактивних книг і електронних газет, а також програмних додатків.

Розробники можуть використовувати HTML Help API для підключення такої довідки до програми.

Довідка у форматі HTML Help надає можливість використання змісту, індексу(покажчика) і ключових слів для просунутих можливостей пошуку інформації в неї. Компілятор HTML Help (який є частиною HTML Help Workshop) дозволяє стискати HTML-, графічні та інші файли у відносно невеликий файл довідки (.chm), який потім може поставлятися разом з програмним додатком або завантажуватися з Інтернету.

HTML Help Workshop є засобом розробки довідкової системи, який забезпечує створення проекту довідки і управління пов'язаних з нею файлів.

За допомогою утиліти HTML Help Workshop (hhw.exe) створюється файл проекту довідки .hhp (Help HTML Project Fіle), що містить набор параметрів і змінних для компілятора довідки. Компіляція проводиться тією же утилітою. Далі створюється файл-змісту .hhc(Help HTML Contents Fіle) та файл индексу .hhk(Help HTML Kewwords Fіle).

2.2.2.1 Підготовка тексту довідки у вигляді файлів формату .html

Вважається, що всі .html сторінки, які ви хочете включити в довідку формату .chm, вже підготовлені: в них працюють всі внутрішні посилання і відображаються картинки та інші об'єкти. Треба обов’язково заповнювати тег <title> кожного файлу формату .html для забезпечення зв'язку між гіпертекстовим файлом та елементом файлу змісту.

2.2.2.2 Компіляція довідки у файл .chm

Коли сформовані розділи (сторінки) довідкової системи, що проектується, розроблена її структура, вирішені питання про загальний стиль довідки, переходять до другого етапу проектування - компіляції довідки у файл *.chm . Пам’ятайте, що сторінки, які створені у форматі .html і містять символи кирилиці, мають бути збережені у кодуванні Windows-1251.

Компіляція й тестування довідкової системи проводиться за допомогою програми hhw.exe - HTML Help Workshop. Ця програма дозволяє створити файл проекту довідки з розширенням .hhp ( без цього файлу довідку не можна скомпілювати), файл змісту довідки (.hhc), файл індексу .hhk, а також перевірити довідкову систему в роботі.

Для створення файлу проекту простої довідкової системи потрібно виконати наступні дії:

1. Запустити на виконання hhw.exe;

2. Обрати в меню Fіle|New і у вікні, що відкриється, вибрати опцію Help Project;

3. Оскільки ми нічого не будемо конвертувати, то прапорець ставити не треба, нажимаємо кнопку «Далі».

4. У вікні Project Fіle Name задати ім'я й каталог файлу проекту довідки (каталог вибрати саме той, у якому лежать файли довідки у форматі .html. Розширення файлу проекту - .hhp).

5. У вікні проекту, що відкриється, ставимо прапорець навпроти «HTML files (.html)» та нажимаємо кнопку «Далі». Взагалі, на цьому етапі можна вказати не тількі HTML файли, які ми включаємо в проект, а також файл змісту(.hhc) та індексу (.hhk), однак ці файли можна додати до проекту потім.

6. У наступній формі додаємо до проекту .html файлі, які необхідні (кнопка «Add», потім «Готово»). Нажавши на іконку на закладці «Project» можна змінити деякі настройки для нашого Проекту, а саме: мову проекту, сторінку за замовчуванням, додати файл змісту та індексній файл. Наступна форма може мати такий вигляд:

Рисунок 2.1 – Вікно файлу Проекту, відкритого в програмі HTML Help Workshop

7. Нажавши на іконку (View HTML source), можна переглядати та редагувати гіпертекстові сторінки.

8. Коли файл проекту створений, необхідно зберегти і відкомпілювати його - кнопка Save and Compіle . Використовуйте її щораз при зміні файлів Проекту. Після успішної компіляції буде створений файл із розширенням. chm. Після компіляції можна переглянути відомості про результати компіляції, якщо вона завершилася вдало – без повідомлень про помилки (із зазначенням кількості розділів, перехресних посилань, ключових слів, картинок, розміру файлу). Також можна перевірити в роботі файл довідкової системи, нажавши на іконку або за допомогою команди View|Compiled Help File.

2.2.2.3 Створення файлу змісту та індексного файлу

Файл змісту має розширення .hhc. Для його створення необхідно перейти на закладку Contents, задати його ім’я (з розширенням .hhc), у результаті чого з'явиться вікно для його формування. Кожний рядок файлу змісту відповідає або заголовку (Headіng) або сторінці (Page). Елемент «Заголовок» (Headіng) може містити декілька «Сторінок» (Page). Поле редагування заповнюється за допомогою кнопок: «Insert a Headіng» і «Insert a page» . Ці кнопки дозволяють формувати багаторівневу структуру файлу змісту майбутньої довідкової системи. Кнопка дозволяє редагувати виділений рядок, а кнопка - видаляти. Кнопки зі стрілками дозволяють змінювати рівні вкладеності файлу змісту.

На рис. 2.2 приведена послідовність дій для додавання елементу «Сторінка»(Page) файлу змісту. На першому кроці необхідно натиснути на іконку , після чого відкриється нове діалогове вікно, де необхідно задати назву елементу змісту. У наведеному прикладі – «Право на отримання безоплатної освіти». Далі необхідно натиснути на кнопку «Add» (крок 3) для того, щоб обрати відповідний файл, який відкриється, коли користувач довідки, переглядаючи зміст обере для ознайомлення дану інформацію. У наведеному прикладі елемент змісту «Сторінка» з назвою «Право на отримання безоплатної освіти» (вибір з поля «HTML titles» - це крок 4) пов'язаний з файлом 6.html.

Рисунок 2.2 – Послідовність дій для додавання елементу файлу змісту

Файл індексів має розширення .hhk. Для його створення необхідно перейти на закладку Index(«Покажчик»), задати його ім’я (з розширенням .hhk), у результаті чого з'явиться вікно для його формування. Кожний рядок індексного файлу відповідає ключовому слову. Поле редагування заповнюється за допомогою кнопки: «Insert a keyword» . Кнопка дозволяє редагувати виділений рядок, а кнопка - видаляти. Кнопки зі стрілками дозволяють змінювати послідовність ключових слів у файлу індексів.

Для того, щоб додати новий елемент до файлу індексів, необхідно натиснути на іконку , після чого відкриється нове діалогове вікно, де необхідно задати нове ключове слово. Далі необхідно натиснути на кнопку «Add» для того, щоб обрати гіпертекстовий файл, з яким це слово буде пов’язане. З одним і тим же ключовим словом можна задати зв’язати декілька гіпертекстових сторінок.

Після заповнення файлів змісту і індексів та перекомпіляції довідки навігаційна панель буде містити 3 закладки: «Содержание», «Указатель», «Поиск».

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

Нижче наведений код (частина віконної процедури), написаний з використанням функцій WІN32 APІ. За звичай довідкова система викликається при натисканні клавіші F1. Така дія ідентифікується операційною системою як подія про натискання клавіші (WM_KEYDOWN) з віртуальним кодом клавіші рівним VK_F1. Виклик функції HtmlHelp призводить до відкриття вікна довідкової системи. Якщо перший параметр цієї функції, дорівнює нулю, то це вказує на головне вікно додатка як ініціатора виклику довідки. У другому параметрі вказується ім'я файлу довідки. Третій параметр зі значенням HH_DISPLAY_TOC вказує на необхідність запуску довідки з відкритою закладкою змісту. Четвертий параметр (у цьому випадку) ігнорується. Також треба підключити відповідний заготовочний файл Htmlhelp.h та відповідну бібліотеку Htmlhelp.lib. У прикладі, наведеному нижче, назва довідкової системи - edu.chm, місце її розташування - кореневий каталог диску С.

#include <Htmlhelp.h>

#pragma comment(lib, "Htmlhelp.lib")

...

LPWSTR Name1=L"C:\\edu.chm";

...

case WM_KEYDOWN:

if (wParam == VK_F1)

hwnd=HtmlHelp( NULL,Name1,HH_DISPLAY_TOC,NULL);

break;

При натисканні саме клавіші F1 операційна система генерує ще одне повідомлення - WM_HELP. Тому виклик довідки можливий також у такий спосіб:

case WM_HELP:

hwnd=HtmlHelp( NULL,Name1,HH_DISPLAY_TOC,NULL);

break;

На рисунку 2.3 наведений скриншот спроектованої в нижче розглянутому прикладі системи допомоги, що була приєднана до головного вікна додатка, яке має заголовок edu_help_test. Допомога викликається при натисканні клавіші F1.

Рисунок 2.3 – Розроблена довідкова система