Лабораторная работа № 6. Создание справочной системы.

Введение:

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

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

Процесс формирования справочной системы программы состоит из следующих этапов:

• планирования справочной системы;

• создания текстового файла в формате RTF (Rich Text Format);

• создания содержания справочной системы (при необходимости);

• создания файла описания проекта;

• компиляции файла справочной системы;

• подключения справочной системы к приложению, определение контекстно-зависимой подсказки.

Приложение Winhlp32:

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

Программа Winhlp32 обеспечивает доступ к справочной системе с помощью совокупности окон. Основное окно отображения справочной системы включает 3 страницы, которые имеют следующее содержание:

Contents (Содержание) – отображает специально подготовленное содержание справочной системы. Создание содержания – отдельная задача при формировании справочной системы.

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

Find (Найти) – задает текст для поиска раздела по всей справочной системе. Он позволяет найти раздел по минимальной информации о нем, однако в качестве результата часто возвращает слишком много заголовков разделов, а реализация этой возможности требует много ресурсов для хранения и обработки файла с информацией о всех словах в справочной системе.

Найденные по определенному признаку разделы отображаются в окне Topics Found (Найденные разделы) своими заголовками.

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

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

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

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

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

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

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

Важно сразу представлять состав справочной системы программы. Здесь следует определить:

• количество создаваемых справочных файлов;

• необходимость создания содержания справочной системы;

• необходимость использования процедур из DLL-библиотек.

Все это приводит к включению в справочную систему дополнительных файлов.

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

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

Пример № 1: Создание плана справочной системы для приложения, работающего с БД «Телефонная книжка».

Создадим справочную систему для приложения, спроектированного в Лаб./раб. № 5. В этот проект входят четыре формы и модуль DataModule1. Форма Form1 – это основное окно приложения с именем “Информация о людях”. Оно содержит меню, строки ввода значений в БД, два навигатора по связанным таблицам People.db и Tel.db и кнопку выхода из приложения. Форма Form2 – это форма отчета, созданного в Лаб./раб. № 3, с именем “Список телефонов”. Формы Form3 и Form4 – это вспомогательные окна, используемые при поиске, с именами “Поиск по фамилии” и “Поиск по дате рождения” соответственно. Они содержат по две кнопки: “ОК” и “Отмена” и по строке ввода Edit для ввода искомого значения.

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

В данной справочной системе будет 1 файл со справочной информацией. Создадим также файл с содержанием справочной системы.

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

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

В подобном файле содержится справочная информация, и он является основным файлом в справочной системе. На этом этапе основным рабочим инструментом является любой текстовый редактор, позволяющий создать файл в формате RTF и оформлять текст с учетом изложенных ниже правил. Рекомендуется использовать Microsoft Word for Windows 95.

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

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

При создании раздела следует стремиться сделать его по возможности небольшим, т.к. текст с экрана воспринимается труднее, чем с бумаги, при этом абзацы также следует стремиться делать короткими. Раздел рекомендуется начинать с краткого заголовка.

Оформление текста.

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

• избегать многообразия шрифтов и применять выделение текста шрифтом различного размера, начертания и цвета;

• выделять заголовок раздела и его частей, а также по возможности основные наиболее информативные слова;

• использовать средства оформления абзацев для создания промежутков между абзацами;

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

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

Вставка служебной информации в текстовый файл.

Справочный файл (с расширением .hlp), хотя и используется для отображения информации из текстовых файлов, отличается от них. Он получается после компиляции текстовых файлов, в которые после набора и оформления текста внесена специальная служебная информация. Эта дополнительная информация необходима для использования разделов в справочной системе проектируемой программы и их отображения с помощью Winhlp32.