Щоб створити довідковий файл, необхідно спочатку підготувати файли вмісту, розділів і проекту. Файл змісту зберігається в форматі ASCII і визначає структуру і зовнішній вигляд вкладки Contents. Файл розділів містить текст і графіку, з яких складається підсумковий документ. Нарешті, файл проекту об'єднує файли розділів і змісту, а також всі інші файли, що входять в проект. Він же визначає макет, зовнішній вигляд і розміщення вікна довідки при запуску.
При проектуванні файлу змісту варто записати ідентифікатори і заголовки розділів. Ідентифікатори розділів використовуються компілятором довідки для "стикування" довідкового файлу з додатком. Вони можуть стати в нагоді при створенні виносок в файлі розділів. Почнемо з файлу змісту:
Протестувати отриманий довідковий файл
Перший файл змісту готовий, можна приступати до файлу розділів. Сподіваюся, ви не забули записати ідентифікатори і заголовки розділів - вони знадобляться при створенні виносок в файлі розділом. Якщо ви не записали їх, зробіть це зараз.
Виконайте в Help Workshop команду File | New.
Давайте зупинимося і подивимося, що ми зробили. По-перше, ми створили заголовок - по ньому користувач визначає, про що йде мова в даному розділі. У нашому прикладі розділ присвячений створенню файлу змісту. Потім ми ввели основний текст розділу. На цьому етапі можна створити графічні зображення і посилання (в нашому довідковому файлі така можливість не використовується). Якщо ця тема вас зацікавила, в електронній документації по Help Workshop ви знайдете більш ніж вичерпну інформацію.
Нижче перераховані основні правила включення виносок в розділи довідки:
Обов'язково зберігайте роботу перед введенням нового розділу. Тепер ви знаєте основні принципи використання виносок, і ми можемо закінчити створення довідкового файлу:
- Вставте в кінець розділу "жорсткий" розрив сторінки, натиснувши клавіші CTRL + ENTER. Перед тим як вставляти новий розділ, потрібно закінчити попередній "жорстким" розривом сторінки. Завдяки цьому кожен розділ буде починатися з нової сторінки.
- Введіть наступний текст:
Додати заголовки
Для додавання заголовків застосовуються кнопки Add Above і Add Below. Коли на екрані з'явиться діалогове вікно Edit Contents Tab Entry, встановіть перемикач Heading, після чого введіть опис заголовка.
За допомогою заголовків можна класифікувати розділи довідкового файлу. Наприклад, даний файл має три заголовка - по одному для кожного етапу роботи над довідковим файлом. У кожен заголовок ми додамо розділи, що описують окремі операції, що становлять різні етапи.Створити файл проекту
Останнім компонентом довідкового файлу є файл проекту. Він визначає різні характеристики довідкового файлу, містить посилання на файл розділів і файл змісту та іншу інформацію, необхідну для побудови довідкового файлу.
В Help Workshop виконайте команду File | New. Виберіть рядок Help Contents і натисніть кнопку OK.
Введіть ім'я довідкового файлу в поле Help File. У нашому прикладі використано ім'я Skill11.hlp.Створити файл проекту
Задати параметри проекту
Натисніть кнопку Options, щоб задати різні параметри проекту.
Введіть в поле Help Title опис довідкового файлу.
Встановіть перемикач Custom і прапорець Hall Compression. Це забезпечує також можливість пошуку за ключовими словами в довідковому файлі.
Виберіть з першого списку створений раніше файл розділів (в форматі RTF). В поле Contents File введіть ім'я файлу змісту.Задати параметри проекту
Додати файли в проект Задавши параметри проекту, слід додати в нього файли розділів і змісту, а також графіком.
Додати файли в проект
Визначити параметри вікна
Натисніть кнопку Window. У діалоговому вікні Window Properties натисніть кнопку Add. Введіть ім'я стилю вікна і вкажіть, що вікно повинно створюватися на базі стандартного вікна Procedure.
Нарешті, закрийте діалогове вікно кнопкою OK.Визначити параметри вікна
Зберегти і відкомпілювати проект
Перед тим як рухатися далі, необхідно зберегти проект і файл змісту. Для цього можна натиснути на кнопку Save and Compile в нижній частині діалогового вікна проекту.
Компілятор довідки обробляє файли розділів, змісту і проекту. Результати відображаються у вікні. Якщо компіляція пройшла без помилок, можна переходити до тестування довідкового файлу.Зберегти і відкомпілювати проект
Протестувати отриманий довідковий файл Коли все буде працювати нормально, довідковий файл можна підключати до додатка.
Протестувати отриманий довідковий файл
Ви тільки що створили свій перший файл розділів. Пам'ятайте - це був звичайний файл, який лише показує загальну схему дій. Після того як ви введете всі розділи і виноски, цей процес надовго залишиться у вашій пам'яті. Як відомо, практика - найкращий учитель. Давайте перейдемо до останньої стадії роботи над довідковим файлом - створення файлу проекту.
Щоб зв'язати воєдино файли вмісту та розділів, необхідно створити файл проекту:
Довідковий файл слід негайно протестувати, щоб переконатися, що він працює нормально. Для цього виконайте такі дії:
Ось і все, що потрібно зробити для створення найпростішого довідкового файлу. Відкривайте отриманий файл Skill11.hlp кожен раз, коли вам необхідно буде створювати файл довідки в форматі HLP.
- Створіть в Visual Basic новий проект типу Standard EXE.
- Задайте властивості Name форми Form1 значення frmMain. а властивості Caption - значення Додаток до довідки.
- Клацніть правою кнопкою миші на рядку Project1 у вікні проекту і виберіть з контекстного меню команду Project1 Properties.
- У діалоговому вікні Project Properties занесіть в поле Help File ім'я довідкового файлу з попереднього прикладу, а потім натисніть кнопку OK.
- Створіть на формі елемент меню і додайте наступні пункти і команди:
Підключити файл довідки HLP в Borland Delphi 7 можна кількома шляхами.
Перший шлях здійснюється через використання ShellAPI (тому спочатку треба в модулі підключити її), наприклад в такий спосіб:
Шлях другий. Створивши файл * .hlp, надайте його ім'я властивості HelpFile об'єкта Application. Це можна виконати тільки під час роботи програми (наприклад, в обробнику події OnCreate форми). Для цього в обробник введіть оператор, подібний наступного:
Щоб привласнити певний розділ довідки певного об'єкту програми або форми, необхідно наприклад наступне:
Існує інший спосіб переходу до потрібної теми полягає в використанні методу HelpJump, якому в якості параметра потрібно передати контекстно-залежну рядок:
Залежно від того, чи має об'єкт Application пов'язаний з ним файл довідкової системи, метод HelpJump повертає True або False. Використовуючи цю особливість, можемо вивести повідомлення про помилку, якщо HelpJump вовращает False:
Обробник події OnClick