Файл документа довідкової інформації

Файл документа довідкової системи є RTF-файл певної структури. Створити RTF-файл довідкової інформації можна, наприклад, за допомогою Microsoft Word. спочатку потрібно набрати текст розділів довідки, оформивши заголовки розділів одним із стилів Тема, наприклад Заголовок1. При цьому текст кожного розділу повинен знаходитися на окремій сторінці документа (закінчуватися символом “розрив сторінки” ).
Після того, як текст розділів буде набрано, потрібно, використовуючи виноски (табл. 14.1), позначити заголовки розділів довідкової інформації (виноски використовуються компілятором довідкової системи в процесі перетворення RTF-файлу в HLP-файл, файл довідки).

Таблиця 14.1. Примітки, що використовуються для розмітки RTF-файлу

Сноска Призначення
# Задає ідентифікатор розділу довідки, який може використовуватися в інших розділах для переходу до позначеного цієї виноски розділу
$ Задає ім’я розділу, яке буде використовуватися для ідентифікації розділу довідки в списку пошуку і в списку переглянутих тим під час використання довідкової системи
к Задає список ключових слів, при виборі яких зі списку діалогу пошуку здійснюється перехід до розділу довідки, заголовок якої позначений цієї виноски

Для того щоб позначити заголовок розділу виноскою, потрібно встановити курсор перед першою буквою заголовка розділу і з меню Вставка вибрати команду Посилання. В , що відкрився діалоговому вікні Примітки (рис. 14.1) в групі Вставити виноску потрібно встановити перемикач в положення звичайну, а в групі Нумерація – в положення інша. У поле введення номера виноски слід ввести символ #  і натиснути кнопку ОК.

Рис. 14.1. Діалогове вікно Примітки

В результаті в документ буде вставлена виноска #, і в нижній частині вікна документа з’явиться вікно введення тексту виноски, в якому поряд зі значком виноски слід ввести ідентифікатор що позначається розділу довідки (рис. 14.2).
В якості ідентифікатора можна використовувати абревіатуру заголовка розділу довідки або наскрізний номер розділу, поставивши перед ним, наприклад, літери Ti (Topic Identifier). Однак краще, щоб ідентифікатор розділу довідки починався з префікса IDH_. В цьому випадку під час компіляції RTF-файлу буде перевірена коректність посилань: компілятор виведе список ідентифікаторів, які перераховані в розділі [MAP] файлу проекту (Див. Нижче), але яких немає в RTF-файлі.

Рис. 14.2. Вставка в документ виноски, позначати заголовок розділу довідки

Як правило, розділи довідки містять посилання на інші розділи. У вікні довідкової системи поняття (Слова), вибір яких викликає перехід до іншого розділу довідки, виділяються відмінним від основного тексту довідки кольором і підкреслюються.
Під час підготовки тексту довідкової інформації, слово-посилання, вибір якого повинен забезпечити перехід до іншого розділу довідки, слід підкреслити подвійною лінією і відразу за цим словом, без пробілу, помістити ідентифікатор розділу довідки, до якого повинен бути виконаний перехід. Вставлений ідентифікатор необхідно оформити як прихований текст.
На рис. 14.3 наведено вид вікна редактора тексту під час підготовки файлу довідкової інформації для програми вирішення квадратного рівняння. Слово ” дискриминант” позначено як посилання на інший розділ довідки (тут мається на увазі, що розділ довідки, в якому містяться дані про дискримінант, позначений виноскою #, яка має код IDH_2).

Рис. 14.3. Оформлення посилання на інший розділ довідки

Крім посилання, що забезпечує перехід до іншого розділу довідки, в документ можна вставити посилання на коментар – текст, що з’являється в спливаючому вікні. Під час роботи довідкової системи посилання на коментарі виділяються кольором і підкреслюються пунктирною лінією. При підготовці документа довідкової системи коментарі, як і розділи довідки, розташовують на окремій сторінці, проте текст коментаря не повинен мати заголовка. Виноска # повинна бути поставлена перед текстом коментаря. Посилання на коментар оформляється наступним чином: спочатку треба підкреслити одинарної лінією слово, вибір якого повинен викликати появу коментаря, потім відразу після цього слова вставити ідентифікатор коментаря, оформивши його як прихований текст.