Завдання
Розробити та виконати підключення довідникової системи до ПП.
Хід роботи
Вивчити теоретичні відомості щодо принципів розробки ПЗ.
Для створення довідки спочатку потрібно підготувати файли, що містять довідкову інформацію. Це - звичайні документи у форматі rtf, які можна створювати за допомогою різних програм.
Створюємо документ і вибираємо "Зберегти як" - "Текст у форматі RTF". Будемо називати ці файли тематичними (topic files). Для одержання з тематичних файлів готових файлів довідки (hlp), їх потрібно обробити (компілювати) програмою HelpWorkshop (hwc.exe). Крім властиво тексту й малюнків, тематичні файли можуть містити також спеціальну розмітку, що несе в собі інформацію, потрібну для створення переходів по посиланнях, зв'язку змісту довідки з її темами й т.п. - для реалізації різних можливостей WinHelp.
Звичайно довідка містить трохи тим і зміст, з якого можна перейти до цих тем. Найпростіший варіант: якщо тема - одна й змісту немає. У такому випадку просто пишемо те, що потрібно й зберігаємо це у файлі з розширенням ".rtf".
Для створення декількох тим процес ускладнюється ненабагато. Кожна тема повинна закінчуватися твердим переходом на нову станицю. Для цього послу закінчення теми потрібно в меню MS Word "Вставка" вибрати "Розрив"->"Почати нову сторінку".
Для того, щоб тема були доступні зі змісту до довідки, потрібно задати їй ідентифікатор. Для цього потрібно в те місце тексту, куди буде згодом відбуватися перехід зі змісту (початок теми або, якщо потрібно, інше місце), вставити спеціальну розмітку, а саме: кінцеву виноску. Символом виноски потрібно вибрати "#". Ідентифікатором теми служить текст виноски. Наприклад, створимо тему "Підтримка", відокремимо її від інших тем розривами сторінок і задамо їй ідентифікатор "support". Для цього помістимо каретку уведення біля заголовка теми й виберемо в меню "Вставка"->"Виноска...". У діалоговому вікні (мал.1) вибираємо вид виноски - "кінцева", нумерація - "інша", у віконці для уведення символу пишемо "#" (без лапок, зрозуміла справа). Натискаємо ОК, посилання додане й каретка автоматично переведена до тексту посилання. Пишемо "support". Готово.
Повторюємо те ж саме для всіх тем довідки. Зберігаємо файл. Тепер можна спробувати створити свій хелп.
Малюнок 1 - Додавання кінцевої виноски
Запускаємо програму HelpWorkshop. Це - файл Hcw.exe у директорії Delphi\Help\Tools\.
Створюємо новий проект через меню "File"->"New"->"Help Project". Праворуч на панелі є ряд кнопок, натискаємо "Files...". У діалоговому вікні додаємо наш тематичний файл і закриваємо це вікно.
Збережемо проект - це буде файл із розширенням hpj (Help Project). Після першого запуску Help Workshop зв'язує себе з файлами hpj, а також - з файлами змісту довідки (cnt), так що їх потім можна відкривати подвійним клацанням мишею. Для створення help-файлу можна просто нажати кнопку "Save and Compile". Відкриється нове вікно з повідомленням про результат компіляції.
Припустимо, що все в порядку, закриємо це вікно. Тепер у директорії, де перебував наш проект (.hpj), повинен з'явитися файл довідки. Однак, при подвійному клацанні мишею на ньому ми зможемо переглянути тільки першу тему. Щоб переглядати всі теми й переміщатися між ними, потрібно додати файл змісту.
Файл змісту довідки має простий текстовий формат, але створювати його зручно теж в HelpWorkshop. Для цього вибираємо в меню HelpWorkshop "File" -> "New" -> "Help Contents". У верхній частині вікна потрібно вписати ім'я головного файлу довідки (файлів, загалом кажучи, може бути трохи) і заголовок (title) для змісту довідки. Те ж можна зробити в діалоговому вікні, що відкривається при натисканні кнопки Edit... .
Тепер створюємо властиво зміст. Воно складається з елементів двох типів - розділи довідки, які містять у собі трохи тим і представлені в змісті довідки значком книжки й самих тем - текст і картинки, представлені в змісті довідки значком аркуша зі знаком питання на ньому (можна подивитися це в змісті будь-якої довідки).
Праворуч на панелі є набір кнопок для додавання й маніпуляції елементами змісту. (Add Below - Додати нижче, Add Above - Додати вище, Move Right - Зрушити вправо, Move Left - Зрушити вліво, Edit, Delete). За допомогою їх створюємо потрібну структуру змісту. При додаванні роздягнула в діалоговому вікні потрібно вказати тільки його назву, при додаванні теми - назва, ідентифікатор (той, котрий ми задали їй в rtf-файлі, коли вставляли кінцеву виноску), ім'я help-файлу й ім'я вікна. Якщо тема перебуває в тім же help-файлі, що ми вказали як головний, то ім'я help-файлу вказувати не потрібно. Ім'я вікна вказувати теж не обов'язково, якщо воно не зазначено, то тема відкриється у вікні по-умовчанню. Потрібно зберегти файл змісту (він буде мати розширення .cnt) у тій же директорії, де перебуває help-файл краще з тим же ім'ям, що й help-файл.
Тепер потрібно знову відкрити файл проекту .hpj і, нажавши кнопку "Options", у діалоговому вікні, що відкрилося, на закладці "Files" указати наш файл змісту (Contents file). Закриваємо діалогове вікно, знову натискаємо "Save and Compile". Тепер при подвійному клацанні мишею по значку файлу довідки повинне відкритися її зміст, з якого можна одержати доступ до всіх тем.
Зручно переміщатися в довідці від теми до теми за допомогою кнопок ">>" і "<<" на панелі інструментів вікна або за допомогою клавіш "<", ">" клавіатури. Щоб додати таку можливість, потрібно.
Створити одну або кілька послідовностей перегляду (browse sequence) в.rtf файлі тексту довідки, додавши відповідну розмітку.
Визначити в проекті довідки (файл.hpj) вікно з відповідними кнопками. Розмітка має такий вигляд: це теж кінцеві виноски, як і для ідентифікаторів тим, однак у цьому випадку знаком виноски служить не символ "#", а "+" - знак плюса. Текстом виносок може бути або число, або рядок символів. Перегляд буде здійснюватися в порядку зростання (як при сортуванні рядків). Звідси наступне - якщо використовуються номери, то потрібно вставляти необхідну кількість нулів перед значущими цифрами для правильного сортування.
Щоб додати кнопки навігації "<<" і ">>" у вікні довідки (за замовчуванням їх немає), потрібно визначити хоча б одне вікно. Для цього, відкривши файл проекту в HelpWorkshop, потрібно нажати кнопку "Windows..." у правій частині вікна. У діалоговому вікні із закладками нажати кнопку "Add..." і у вікні, що відкрилося, увести в поле назви "main", а поле типу вікна очистити, після чого нажати OK. Тепер у нас визначене одне вікно, різні властивості якого можна змінювати, переміщаючись по закладках. На закладці "Buttons" відзначаємо галочкою "Browse". Натискаємо ОК, готово. Тепер вікно довідки буде мати потрібні кнопки. Натискаємо "Save and Compile" унизу вікна й можемо перевіряти, що вийшло у вихідному help файлі.
Буває, що в довідку потрібно помістити зображення. Це можна зробити, просто додавши їх у документ rtf звичайним для MS Word способом. Якщо одне зображення використовується в декількох місцях, то можна скористатися спеціальною розміткою, передбаченої для вставки зображень у довідку, так що зображення буде зберігатися в одному екземплярі.
Звичайна справа - указати адреса свого сайту й/або електронної пошти в розділі "Підтримка". Як зробити, щоб це посилання виглядало й функціонувало як гіперпосилання на Веб-Сторінках? Аналог гіперпосилання, тобто тегу anchor (<a>) HTML в WinHelp - "hotspot". Hotspot - це область, по клацанню миші на якій, виконується яка-небудь дія з передбачених в WinHelp. У цьому випадку нам потрібно запустити один з макросів WinHelp, а саме макрос ExecFile. Цей макрос нагадує функцію WinApi ShellExecute. Синтаксис його такої: ExecFile(program[, arguments[, display-state[, topic-ID]]])
Перший параметр, як написано в довідці, може вказувати на програму або файл. Однак, як і в ShellExecute, замість ім'я файлу можна вказати URL, наприклад "http://www.mysite.ru" або "mailto:nekto@somemail.ru".
Щоб створити hotspot, що запускає такий макрос, потрібно зробити наступне.
Відразу після тексту hotspot'a увести символ "!", а відразу за ним - текст макросу, наприклад: Наш сайт: www.mysite.ru!ExecFile(http://www.mysite.ru). Примітка: URL у дужках повинен бути без лапок. Далі, потрібно отформатировать цей уривок так: текст hotspot'a повинен мати подвійне підкреслення, а символ "!" і текст макросу після нього - мати атрибут "схований". І те, і інше робиться через меню "Формат" -> "Шрифт".
Тепер, якщо додати такий hotspot і компілювати проект, то ми побачимо у своїй довідці, що в рядку тексту Наш сайт: www.mysite.ru - адреса виглядає й функціонує як гіперпосилання.
Щоб довідка була доступна в програмі, потрібно вказати програмі на файл.hlp. Найпростіший спосіб розміщення файлу довідки - у тій же папці, де перебуває виконується файл, що.
Визначити для додатка файл довідки можна так: відкривши проект (додатка) в Delphi і вибравши меню "Project" -> "Options" -> "Application", вписати назва файлу довідки в поле уведення "Help file". При цьому потрібно вказати назву файлу без шляху. Коли WinHelp намагається знайти довідковий файл, одна з директорій, що переглядаються - та, де розташований виконується файл, що, програми.
Інший спосіб - в оброблювач події OnCreate головної форми програми вставити рядок:
Application.HelpFile:=ExtractFilePath(Application.ExeName)+"MyHelp.hlp";
де MyHelp.hlp - назва файлу довідки.
Щоб з меню в програмі викликати зміст довідки, потрібно скористатися функцією
Application.HelpCommand(HELP_FINDER, 0);
Щоб перейти до однієї з певних нами тим довідки, потрібно викликати функцію
Application.HelpJump('MyTopic'),
де MyTopic - ідентифікатор теми.
Один зі способів виклику довідки - натискання клавіші F1. Можна організувати виклик контекстної довідки при натисканні на F1, коли активним є той або інший елемент керування. Для цього відповідній темі довідки потрібно привласнити номер, а потім цей номер привласнити властивості HelpContext елемента керування.
Щоб задати номера для тем довідки, потрібно відкрити проект довідки в HelpWorkshop і нажати кнопку "Map" у правій частині вікна. Натискаємо в діалоговому вікні "Add", уводимо ідентифікатор теми й довільний номер (наприклад, 1 :) ), повторюємо це для всіх потрібних тем (кожної - свій номер), закриваємо вікно й натискаємо в черговий раз "Save and Compile". Потім в Delphi, у вікні інспектора об'єктів, привласнюємо потрібні номери потрібним елементам керування (нагадую, властивість HelpContext).
Зробити висновки по роботі.