Задание3_Справочная_система (Лабораторная работа №3)

^{Задание 3}

^{Справочная система}

Для разработанного в задании 2 проекта «Скорость бега» создать справочную систему, которая должна вызываться по кнопке «Справка». Текст справки должен содержать разделы: «Скорость бега», «Ввод данных», «Вычисление скорости» и комментарий. В каждом разделе должны быть слова, помеченные ссылкой на другой раздел справки, и одна ссылка на комментарий.

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

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

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

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

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

Файл документа справочной информации

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

После того, как текст разделов будет набран и сохранен, нужно, используя сноску, пометить знаком ‘#’ заголовки разделов справочной информации (сноски используются компилятором справочной системы в процессе преобразования RTF-файла в HLP-файл, файл справки). Сноска со знаком ‘#’ задает идентификатор раздела справки, который может использоваться в других разделах для перехода к помеченному этой сноской разделу.

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

Рис. 1. Диалоговое окно Сноски

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

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

Рис. 2. Вставка в документ сноски, помечающей заголовок раздела справки

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

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

На рис.3 приведен вид окна редактора текста во время подготовки файлa справочной информации для программы решения квадратного уравнения. Слово "дискриминант" помечено как ссылка на другой раздел справки здесь предполагается, что раздел справки, в котором находятся сведения о дискриминанте, помечен сноской #, имеющей идентификатор IDH_2).

Рис. 3. Оформление ссылки на другой раздел справки

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

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

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

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

После того как создан файл справочной информации системы (RTF-файл можно приступить к созданию справочной системы (HLP-файла). Для этого удобно воспользоваться программой Microsoft Help Workshop, которая поставляется вместе с Delphi и находится в файле Hcw.exe.

Запустить Microsoft Help Workshop можно из Windows или из Delphi, выбрав из меню Tools команду Help Workshop.

Если в меню Tools команды Help Workshop нет, то надо из этого же меню выбрать команду Configure Tools и в открывшемся диалоговом окне Tool Options (рис.4) щелкнуть на кнопке Add. В результате этого откроется диалоговое окно Tool Properties (рис. 5), в поле Title которого надо ввести название программы — Help workshop, а в поле Program — полное (т. е. с указанием пути) имя исполняемого файла программы Microsoft Help WorkShop — C:\Program Files\Borland\Delphi7 \Help\Tools\HCW.exe. Для ввода имени файла можно воспользоваться кнопкой Browse.

Рис. 4. Диалоговое окно Tool Options

Р

ис. 5. Диалоговое окно Tool Properties

После запуска программы Microsoft Help Workshop на экране появляется главное окно программы (рис. 6).

Для того чтобы приступить к созданию справочной системы, нужно из меню File выбрать команду New, затем в открывшемся диалоговом окне (рис.7) тип создаваемого файла — Help Project. В результате этих действий открывается окно Project File Name (рис. 8). В этом окне сначала надо выбрать папку, где находится программа, для которой создается справочная система, и где уже должен находиться файл документа справочной системы (RTF-файл). Затем в поле Имя файла нужно ввести имя файла проекта справочной системы. После щелчка на кнопке Сохранить открывается окно проекта справочной системы (рис. 9).

.

Рис. 6. Главное окно программы Help Workshop

Р ис. 7. Начало работы над новым HLP-проектом

Рис. 8. Начало работы над новым проектом

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

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

Включение в проект файла справочной информации (RTF-файла)

Для того чтобы добавить в проект файл справочной информации, нужно щелкнуть на кнопке Files и в открывшемся диалоговом окне Topic Files — кнопку Add (рис. 10). В результате откроется стандартное окно Открытие файла, используя которое следует выбрать нужный RTF-файл. В результате этих действий в окне проекта появится раздел [FILES], в котором будет указано имя файла справочной информации. Если справочная информация распределена по нескольким файлам, то операцию добавления файла нужно повторить.

Рис. 10. Диалоговое окно Topic Files

Характеристики окна справочной системы

Чтобы задать характеристики главного окна справочной системы, надо в окне проекта нажать кнопку Windows и в поле Create a window named от­крывшегося окна Create a window (рис. 11), ввести слово main.

Рис. 11. Диалоговое окно Create a window

В результате щелчка на ОК появляется окно Window Properties, в поле Title bar text вкладки General которого нужно ввести заголовок главного окна создаваемой справочной системы (рис.12).

Рис. 12. Вкладка General

Используя вкладку Position диалогового окна Window Properties, можно за­дать положение и размер окна справочной системы (рис.13). На вкладке Position находится кнопка Auto-Sizer, при нажатии которой открывается окно Help Window Auto-Sizer (рис. 14), размер и положение которого оп­ределяется содержимым полей вкладки Position. При помощи мыши можно менять размер и положение этого окна. После нажатия кнопки ОК координаты и размер окна Help Window Auto-Sizer будут записаны в поля вкладки Position.