Лабораторная работа №34. Тема: «Создание и использование справочной системы».

Цель работы: получение навыков создания и использования справочной системы.

Краткие теоретические сведения

Любая программа, предназначенная для массового распространения, обычно снабжается электронной справочной системой (файлы с расширением .HLP), вызываемой, как правило, нажатием клавиши F1. При этом отображается именно тот раздел системы, который относится к текущей области действий пользователя. Например, если нажать клавишу F1, находясь в Проектировщике форм системы Delphi 7, то откроется раздел справочной системы, описывающий текущий выделенный компонент на форме.

Справочная система по принципу создания напоминает составление программы на Паскале. Сначала готовится исходный текст, который содержит специальные управляющие символы, затем этот текст включается в проект, который компилируется – переводится в файл в формате .HLP. Его можно стандартным образом просматривать в системе Windows, а также включать в свои программы.

Задание

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

Ход работы:

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

   1. Введите текст раздела в редакторе, который способен сохранять файлы в формате .RTF. Удобнее всего использовать для этого редактор Word.

   2. Добавьте идентификационное обозначение раздела, которое в дальнейшем будет использоваться для обращения к нему.

Такой идентификатор записывается в виде IDH_<произвольный текст>, а перед ним предварительно вставляется символ # в режиме сноски (команда Вставка->Сноска). Пример вставки такого идентификатора показан на рисунке 32.

Рис. 32

3. В начало раздела добавьте заголовок, которому должен предшествовать символ $, также в режиме сноски.

4. Файл сохраняется в формате .RTF.

1. Указать ссылку на раздел.

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

Допустим в файле имеются два раздела м идентификаторами IDH_TOPIC001 и IDH_TOPIC002. Чтобы сделать фрагмент гиперссылкой, используется следующий порядок действий.

1. Надо (без пробела) ввести идентификатор раздела, на который должен быть совершен переход.

Здесь переходIDH_TOPIC002

2. Необходимо выделить слово (или слова), входящие в ссылку, и задать режим подчеркивания шрифта. Двойное подчеркивание означает, что после перехода новое содержимое надо открыть в текущем окне справочной системы.

Здесь переходIDH_TOPIC002

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

Здесь переходIDH_TOPIC002

3. Надо выделить идентификатор (IDH_TOPIC002) и сделать соответствующий шрифт скрытым.

Здесь переходIDH_TOPIC002

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

   1. Для создания файла справочной системы необходимо вызвать утилиту Microsoft Help Workshop. Она расположена в каталоге Delphi 7\Help\Tools и называется hcw.exe ., (рис. 33).

рис. 33

2. Выполните команду File->New (Файл->создать). В открывшемся диалоговом окне выберите пункт Help Project (Проект справочной системы) и щелкните на кнопке ОК, (рис. 34).

рис. 34

3. В окне выбора файлов указывается (или создается) каталог, и задается имя файла проекта с расширением .HPJ. Щелкните на кнопке ОК.

4. На вкладке Files (Файлы) указываются следующие сведения.

5. Щелкните на кнопке Map (Соответствие), чтобы открыть одноименное окно. В нем с помощью кнопки Add (Добавить) задаются соответствия между идентификатором раздела и его числовым эквивалентом (целым числом, начиная с единицы). Это требуется для обращения к разделу к его номеру, а не по идентификатору. Следует указать соответствие для каждого идентификатора, который используется в программе для контекстного вызова справочной системы. Теперь в разделе Map (Соответствие) проекта появиться список соответствий, (рис. 35).

рис. 35

6. Сохраните и закройте проект.

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

Подготовьте список входящих в него разделов. Это выполняется командой File->New->Help Contents (Файл->Создать->Содержание справочной системы). В поле Default filename (Имя файла по умолчанию) указывается имя файла .HLP, используемое по умолчанию. В поле Default title (Заголовок по умолчанию) задается заголовок первого диалогового окна справочной системы. Чтобы добавить новый раздел в содержание, надо щелкнуть на кнопке Add Above или Add Below (Добавить выше/Добавить ниже текущего раздела), после чего в диалоговом окне Edit Contents (Изменить содержание) следует установить переключатель Topic (Раздел), (рис. 36-37).

рис. 36 рис. 37

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

В заключении загружается файл проекта и на вкладке Files (Файлы) в окне Options (Параметры) файл .CNT, созданный на предыдущем этапе, указывается в поле Contents file (Файл описания содержания). Далее надо закрыть окно настроек режима компиляции. Здесь надо обязательно установить флажок Include.rtf filename and topic ID in Help file (Включить имя файла RTF и номера разделов в файл справки), который потребует от компилятора включения в создаваемый файл .HLP не только идентификаторов IDH_, но и соответствующих им номеров разделов.

После компиляции выводится информация о числе разделов, гиперссылок, ключевых слов и добавленных в файл справки рисунков.

6. Добавление справочного файла в программу.

Созданный файл .HLP надо скопировать в каталог, в котором хранится проект разрабатываемого приложения. Затем, загрузив этот проект в систему Delphi 7, надо дать команду Project->Options (Проект->Параметры) и на вкладке Application (Приложение) выбрать этот файл в поле Help file (Файл справки) с помощью кнопки Browse (Обзор).

Далее на форме можно разместить произвольные компоненты, а в их свойствах HelpContext указать подходящие номера разделов, связанные с их идентификаторами. Эти номера должны быть больше нуля. Если запустить программу и выбрать любой элемент управления, у которого имеется высокая ссылка на раздел файла-справки, то по нажатию клавиши F1 отображается нужный раздел.