Занятие №5 Подготовка справочной системы Цель занятия

Научиться создавать справочную систему, подключать ее к приложению.

Методические указания

Разработка справочной системы осуществляется не Deplhi, а с помощью программы HelpWorkShop. Delphi только позволяет встроить справочную систему в приложение.

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

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

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

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

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

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

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

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

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

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

N

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

ame.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 и т.д.) или идентификаторами.

Текст темы

Гипертекст

Сноска +