Подготовка справочной информации

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

Основным элементом справочной системы являются HLP-файл, в которых находится справочная информация. В простейшем случае справочная система программы может представлять собой один единственный HLP-файл.

Создать справочную систему (HLP-файл) можно при помощи поставляемой вместе с Delphi программы Microsoft Help Workshop. Исходным "материалом" для создания HLP-файл является текст справочной информации, представленный в виде RTF-файла.

Процесс создания справочной системы (HLP-файл) можно представить как последовательность следующих двух шагов:

1.Подготовка справочной информации(создание файла документа справочной информации).

2. Преобразование файла справочной информации в файл справочной системы.

Файл документа справочной системы представляет собой RTF-файла определенной структуры. Создание RTF-файла справочной информации можно при помощи Microsoft Word. Сначала нужно набрать текст разделов справки, оформив заголовки разделов одним из стилей Заголовок, например Заголовок1. При этом текст каждого раздела должен находится на отдельной странице документа( заканчиваться символом "разрыв страницы"). После того, как текст разделов будет набран, нужно, используя сноски, пометить заголовки разделов справочной информации (сноски используются компиляторы справочной системы в процессе преобразования RTF-файла в HLP-файл, файл справки).

Сноски, используемые для разметки RTF-файла

Для того чтобы пометить заголовок раздела сноской, нужно установить курсор перед первой буквой заголовка раздела и из меню Вставка выбрать команду Сноска. Вставить сноску нужно установить переключатель в положение обычную. а в группе Нумерация- в положение другая. В поле ввода номера сноски следует ввести символ "#" и нажать кнопку ОК.

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

В качестве идентификатор можно использовать аббревиатуру заголовка раздела справки или сквозной номер раздела, поставив перед ним, например, буквы Ti(Topic Identifier).Однако лучше, чтобы идентификатор раздела справки начинался с префикса IDH_. В этом случае во время компиляции RTF-файла будет проверена корректность ссылок: компилятор выведет список идентификаторов, которые перечислены в разделе [MAP] файла проекта (см. ниже), но которых нет в RTF-файле.

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

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

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