Методические указания. Разработка справочной системы осуществляется не C++Builder, а с помощью программы Windows WinHelp

Разработка справочной системы осуществляется не C++Builder, а с помощью программы Windows WinHelp. C++Builder только позволяет встроить справочную систему в приложение.

Разработка справки состоит из двух основных этапов:

• Создание текстового файла или нескольких файлов, содержащих темы справок с помощью любого текстового редактора, например, с помощью Microsoft Word.

• Компиляция справки и отладка всей справочной системы осуществляется с помощью специальной программы: Microsoft Help Workshop, которая обычно расположена в C++Builder, в каталоге .../Help/Tools.

Перечень тем для справочной системы:

Ø Страницу на каждую команду меню.

Ø Страницу для оглавления справки, содержащую перечень всех меню с установленными связями со страницами, описывающими команды этих меню.

Ø Отдельную страницу для оглавления всех задач, решаемых программой. Включить примеры и пошаговые инструкции.

Ø Необходима контекстная справка по всем элементам управления в диалоговых окнах.

Help Work Shop создает оглавление тем справки, определяет идентификаторы тем, создает проект, включающий все необходимые файлы и компилирует их в файл Name.hlp. (Name – условное имя файла, м.б. любым именем, соответствующим соглашению об именах в Windows).

Проект справочной системы включает файлы:

Необходимые файлы для создания справки

Name.hlp - для хранения справки

Name.cnt – файл оглавления справки

Name.rtf – текстовый файл разделов

Name.hpj – файл проекта справочной системы

Name.gid– файл конфигурации

Name.fts – файл поиска

Name.ftg – файл группового поиска

Name.hm– файл адресации справки, содержит идентификаторы тем справок

Name.h – содержит определения идентификаторов ресурсов и идентификаторов тем справок.

1. Создание текстового файла разделов (*.rtf)

Создание файла разделов осуществляется с помощью Microsoft Word. Файл тем справок необходимо сохранить в формате rtf — обогащенном текстовом формате, выполнив команду Файл | Сохранить как… .

Каждая тема (в дальнейшем он будет отображаться в отдельном окне) занимает одну страницу. Друг от друга темы отделяются символом разрыва страницы. В Word это осуществляется командой Вставка | Разрыви выбором в диалоговом окне опции Начать Новую страницу.

Каждая тема снабжается сносками, определяющими ее наименование и ряд других свойств. Сноски в Word делаются командой Вставка | Сноска, после чего открывается диалоговое окно «Сноски», где следует указать символ для сноски. Все сноски помещаются перед текстом темы Чтобы наблюдать и редактировать тексты сносок Word должен быть переключен в режим Разметка страницы.

Сноска ^#

Сноска # обозначает уникальный идентификатор темы, по которому на нее могут ссылаться дру­гие темы. Любая тема должна снабжаться меткой #. Идентификатор, указываемый как текст этой ссылки, имеет чисто служебное назначени и может писаться латинскими или русскими буквами, состоять из одного или нескольких слов. Примеры таких сносок: ^# Main, ^#Содержание, ^# 0 программе.

Идентификаторы разделов используются в гиперссылках. Для гиперссылки надо

Þ набрать гипертекст

Þ отметить шрифт гипертекста двойным подчеркиванием (Формат\Шрифт…)

Þ дописать к нему без пробелов идентификатор раздела, к которому хотите перейти

Þ пометить текст идентификатора как скрытый

Þ

Сноска ⁺

Сноска с символом ⁺ используется для указания последовательности просмотра тем с помощью кнопок «>>» и «<<». Если сноски ⁺ есть, но в них не указано никаких значений, то Help Workshop устанавливает автоматически последовательность просмотра в соответствии с последовательностью тем в вашем файле. В темах, в которых сносок ⁺ нет, кнопки просмотра не доступны. Тексты сносок могут быть просто номерами (001, 002 и т.д.) или идентификаторами.

Сноска +

Гипертекст

Текст темы

Сноска ^К (заглавная латинская буква)

Эта сноска должна включаться в тему при работе с закладкой «Предметный указатель» (Index), куда выводятся тексты сносок ^К для всех тем. Текст сноски может состоять из одного или нескольких слов. Например,

^K Меню Правка

В этом случае при работе со справкой в списке указателей появится строчка «Меню Правка», по которой пользователь может выйти на данную тему. Можно также ввести несколько различных обозначений для одной и той же темы, разделяяих точками с запятой. Например, ссылка

^K Меню правка; Меню

обеспечит две строки в указателе: «Меню правка» и «Меню», которые будут ссылаться на одну и ту же тему.

Сноска ^$

Сноска с символом ^$ определяет заголовок данной темы. Этот заголовок используется в WinHelp в ряде режимов работы, в частности, в системе Поиск и Указателя (закладки Find и Index). Выше были рассмотрены сноски ^К. Возможна ситуация, когда для разных тем указан один и тот же текст сноски. Например, если описываются темы, связанные с главным меню приложения и его разделами Файл, Правка и др. Тексты сноскок ^К в этом случае выглядят следующим образом

^K Файл; Меню

^К Правка; Меню

Тогда строка «Меню» в предметном указателе будет относиться сразу к двум темам и пользователь, выбравший эту строку, должен иметь возможность уточнить свой выбор, указав одну из них. Для этого система справки автоматически предъявит пользователю окно «Найденные разделы». Строки, обозначающие в этом окне конкретные темы, задаются с помощью сносок с символом $. Поэтому в нашем примере необходимо добавить

^$ Меню файл

^$ Меню правка

Текст сноски $

Текст сноски К

v Пример файла разделов для программы калькулятор.

#K +Общие сведения о калькуляторе

Данная программа предназначена для выполнения тех же действий, что и обычный калькулятор. Она выполняет основные арифметические действия, такие, как сложение и вычитание.

---------------------------------------------------- разрыв страницы---------------------------------------------------

#$K + Чтобы выполнить простое вычисление

1. Введите первое число.
2. Нажмите кнопку + (сложение), - (вычитание), * (умножение) или / (деление).
3. Введите следующее число, остальные операторыОператоры и числа.
4. Нажмите кнопку =.

---------------------------------------------------- разрыв страницы---------------------------------------------------

#K Операторы

В математике, программировании и компьютерных приложениях — это символ или знак, указывающий, что в операции обрабатывается один или несколько элементов. В обычном режиме вычислений доступны четыре оператора

----------------------------------------------------- разрыв страницы---------------------------------------------------

#$K +Выполнение расчетов с большими числами

В шестнадцатеричной системе счисления восьмибайтовые результаты могут содержать до шестнадцати знаков, четырехбайтовые - до восьми знаков, двухбайтовые - до четырех знаков, а однобайтовые - до двух знаков. (См.общие сведения1)HPG1

----------------------------------------------------- разрыв страницы---------------------------------------------------

#K +Деление на ноль

При попытке произвести данную операцию будет выдаваться сообщение: «Деление на ноль запрещено»

Тексты сносок

# HPG1

K общие сведения

+

# HPG2

$ Простые вычисления

K простые вычисления; расчеты

+

# Операторы

K операторы

# HPG3

$ расчеты с большими числами

K расчеты; расчеты с большими числами; большие числа

+

# HPG4

K ошибки ввода; деление на ноль

+ 004

2. Создание файла содержания (*.cnt)

Файл содержания создается в Help WorkShop. Для его создания необходимо:

Þ Запустить Help WorkShop.

Þ Выбрать команду File|New.

Þ Из предлагаемых пунктов выбрать Help Contents.

Þ В поле default file name задать имя справочного файла Name.hlp.

Þ В поле default title написать «Справка».

Þ Создать структуру файла содержания c помощью кнопок:

AddAbove – добавить выше;

AddBelow – добавить ниже;

При нажатии любой из этих кнопок открывается окно Edit Contents Tab Entry, в котором можно задать очередной заголовок (Heading), отображающийся в виде книги, или очередную тему (Topic). Для заголовка указывается только его текст (Tile). Для темы записывается ее название (Tile), которое появится на странице Содержание справки, и идентификатор темы (Topic ID), указанный в файле разделов (*.rtf) со сноской ^#

3. Создание файла проекта

Þ Запустить Help WorkShop.

Þ Выбрать File | New.

Þ Из предлагаемых пунктов выбрать Help Project.

Þ Задать имя проекта.

Þ Нажать кнопку Options.

Þ В поле Help title задать название файла.

Þ Выбрать вкладку Files окна Options. Задать имена *rtf (в поле PTF files) и *cnt (в поле Contents files) файлов. Закрыть окно Options.

Þ Нажать кнопку Map.

Þ С помощью кнопки Add последовательно задать значения идентификаторов разделов.

Например,

TopicID Mapped numeric value:

HPG1 1

HPG2 2

Þ Если нужно, чтобы разделы помощи выводились в окне с кнопками перехода(«>>»,«<<»), например, если использовалась сноска +, то нажать кнопку Windows.

o Задать имя окна – main.

o Перейти на вкладку Buttons, поставить галочку в Browse.

o Нажать ОК.

Þ Сохранить и откомпилировать проект, нажав на кнопку Save and Compile.

Þ Для просмотра полученной справки нажать кнопку «?» на панели инструментов.

4. Подключение справочной системы к приложению

Пусть справочная система должна вызываться при нажатии кнопки Contents. Тогда обработчик события OnClick этой кнопки – функция ContentsClick – должен выглядеть следующим образом:

void __fastcall TForm1::ContentsClick(TObject *Sender)

{

Application->HelpFile=”Name.hlp”; //Name.hlp – имя файла справки

Application->HelpCommand(HELP_FINDER,0);

}