При проектировании справочной системы целесообразно учитывать следующие особенности.
Прежде всего нужно определить, для каких пользователей создается справочная система. Начинающие, профессионалы, эксперты обладают разным уровнем знаний, а это определяет глубину и язык изложения справочного материала. Кроме того, следует оценить, как много информации в справочной системе будет по описанию работы с программой, а также по предметной области приложения.
Перед созданием справочной системы нужно определить:
список необходимых разделов в справочной системе;
структуру изложения справочного материала в разделе;
количество создаваемых справочных файлов;
необходимость создания содержания справочной системы.
В наиболее простом варианте справочная система помещается в одном файле. Однако такой файл может оказаться слишком велик, что ведет к замедлению работы при его загрузке и использовании. В этом случае целесообразно создавать несколько справочных файлов.
В ходе планирования справочной системы следует не только определить состав и структуру разделов, которые войдут в справочную систему, но и то, каким образом будет осуществляться переход между ними. В основном для этого используются гипертекстовые ссылки, например, для детализации какого-нибудь понятия. Кроме того, можно последовательно просматривать определенные разделы, например, с однотипной информацией. Для этого перед созданием справочной системы необходимо определить такие последовательности просмотра.
При составлении плана справочной системы в данном случае целесообразно учесть следующие рекомендации.
Создаваемая справочная система предназначена для аудитории, которая будет использовать ее в качестве примера создания как формы, так и самой справочной системы.
Справочная система предположительно должна содержать два файла: один файл со справочной информацией, а другой – с содержанием справочной системы.
Целесообразно для каждой компоненты окна создать свой раздел описания. Следует также создать раздел описания формы, в котором должны присутствовать ссылки на разделы, посвященные ее компонентам.
Желательно также иметь возможность перехода между описаниями однотипных компонент – строк ввода и кнопок. Для этого нужно создать две последовательности просмотра.
В данном примере иллюстрируется способ создания простейшего плана справочной системы. В реальной ситуации может потребоваться создание дополнительных гипертекстовых ссылок, последовательностей просмотра, разделов, которые трудно определить заранее. Поэтому в процессе создания приложения соответствующая ей справочная система может постоянно корректироваться.
Разработка приложений ОС Windows. Создание справочной системы приложений
Планирование справочной системы
Создание файла документа справочной системы
Создание содержания справочной системы
Элементы содержания
Создание структуры содержания
Создание файла проекта справочной системы
Определение параметров создания справочной системы
Определение параметров создания СС. Основные настройки
Определение параметров создания СС. Сжатие справочного файла
Определение параметров создания СС. Сортировка справочной информации
Определение параметров создания СС. Расположение файлов, используемых в проекте
Определение параметров создания СС. Полнотекстовый поиск
Определение параметров создания СС. Шрифты, используемые в справочной системе
Определение параметров создания СС. Включение статей в справочную систему
Состав текстовых файлов, входящих в справочную систему
Определение вторичных окон в справочной системе
Определение вторичных окон в СС. Общие настройки окна
Определение вторичных окон в СС. Расположение окна
Определение вторичных окон в СС. Состав панели кнопок
Определение вторичных окон в СС. Цвет окна
Определение вторичных окон в СС. Графические изображения
Определение вторичных окон в СС. Числовой идентификатор раздела
Секция Alias
Используемые в DLL-библиотеках файлы
Основные сведения о компиляции справочного файла
Подключение файла справочной системы к программе пользователя
Определение контекстно-зависимой справки
Средства создания кратких справок
