14.4. Создание справочной системы

Справочная система (справка) вызывается нажатием клавиши F1. Ее создание состоит из нескольких этапов.

Создание редактором Word файла типа RTF с текстом справки

Справка делится на разделы. Каждый раздел начинается с новой стра­­ницы (рис. 14.4.1).

Рис. 14.4.1. Исходный текст формируемой справки из двух разделов

Перед разделом указывается идентификатор в виде IDH<текст>, а перед ним вставляется символ “#”в режиме сноски (Вставка/Сноска). После идентификатора раздела указывается его заголо­вок после символа “$” в режиме сноски. При необходимости можно добавить управляющие символы (они описаны в файлеHCW.Hlp). Например, введем ключевые слова, отображаемые на страницеУказатель, после ввода символа “K” в режиме сноски (рис. 14.4.1). Опреде­лим в справке тексты гиперссылок на другие разделы справки (они выделяются зеленым цветом). Гиперссылка должна выделяться двойным или одинарным под­черкиванием (содер­жи­мое раздела после перехода откры­вается в текущем окне или во всплы­вающей подсказке). Сразу после ги­перссылки без про­белов указывается идентификатор раздела, на который осу­ществляется пе­реход (рис. 14.4.1). Далее выделяем эти идентификато­ры и делаем шрифт скры­тым. Сохра­ним этот файл под именемHelprtf.rtf.

Создание файла проекта справочной системы

Для создания справочной системы нужно вызвать утилиту MicrosoftHelpWorkshop(файлHcw.exe). Далее выполним коман­дуFile/New/Help Projectи в окне сохранения файла укажем имя фай­ла проекта с рас­ши­ре­ни­ем .HPJ, например:Help.hpj. В появившемся окне наж­мем кнопкуOptionsи перей­дем на страницуFiles окнаOptions. В полеHelp Fileука­жем имя будущего файла справки (Help.hlp), в полеRTF Files‑ именаRTF‑файлов с исход­ными текстами справки (Helprtf.rtf). Закроем окноOptions и перей­дем на страницуMap и нажмем кнопкуAdd. В полеTopic IDукажем иден­тификатор первого раздела (IDH_01), а в полеMapped numeric valueука­жем его числовой номер (1) и нажмем клавишуOK. Снова нажмем кла­вишуAddдля установки соответствия идентифика­тораIDH_02 номеру 2. Сохраним и закроем проект.

Подготовка содержимого справочной системы

Выполним команду File/New/Help Contents. В полеDefault Filenameуказывается имя файла типа .HLP, используемого по умолча­нию. В полеDefault titleзадается заголовок первого диалогового окна справки (“Пример спра­воч­ной системы”). КнопкиAdd Above/Add Belowслужат для добавления нового раздела справки выше/ниже текущего раздела. Нажмем кнопку Add Below; появится окно Edit Contents Tab Entry. Установим переключательTopic(Раздел). Заполним поля:

Title‑ имя раздела в справке (“Как сформировать расчетную ведомость ”);

Topic ID‑ идентификатор раздела (“IDH_01”);

Help File‑ имя файла .HLPсправочной системы (“Help.hlp”).

Процесс добавления раздела должен соответствовать процессу запи­си заголовков (папок), представленных в виде закрытой книги. Эти заголовки разворачиваются по двойному щелчку, показывая вложенный список разделов (до девяти уровней вложенности). Заголовки добавляются при установке переключателя Heading. Нажмем кнопкуОK. Нажмем кнопкуAdd Belowдля добавления второго раздела. Сохраним файл типа .CNTпод именемHelp.cnt.

Создание справочного файла для приложения

Откроем файл проектаHelp.hpj, нажмем кнопкуFiles в окнеOptionsи в полеContents fileукажем (выберем кнопкойBrowse) файлHelp.cntи нажмем кнопкуOK. Нажмем кнопкуCompile. В окне компиляции установим переключательInclude .rtf filename and topic ID in Help file и нажмем кнопкуCompile. Появится результирующий файлHelp.hlp. Для проверки работы созданной справочной системы можно нажать кнопкуRun WinHelp.

Корректировка справочного файла

При необходимости можно откорректировать исходный справочный файл .RTF, открыть проект справочной системы и откомпилировать его.

Присоединение справочного файла к приложению

Созданный справочный файл (Help.hlp) скопируйте в папку с при­ложе­нием. После загрузки приложения выполните командуPro­ject/Project1 Properties. В полеHelp File Nameукажите имя справочного файла (Help.hlp). В свойствахHelpContextId(п. 5.1) для соответствующих компо­нен­тов ука­­жи­­­те номера нужных разделов справочного файла (1, 2), вызываемых кла­ви­шейF1(рис. 14.4.2). Полученный справочный файл можно исполь­зо­вать и в приложениях, разработанных с использованием других языков прог­рам­мирования (Delphi,BuilderС++,VisualFoxPro).

Рис. 14.4.2. Окно созданной справочной системы