В этом уроке мы научились:
Документировать программы.
Соблюдать единый стиль программирования.
Пользоваться соглашениями об именах.
Работать с отладочными средствами Visual Basic.
Создавать тестовые утилиты.
I
13 Урок
Создание
И использование
Справочных файлов
Использование справочных файлов в приложениях
Создание справочных файлов
Проектирование и создание файла содержания
Создание файлов разделов П Создание файла проекта
Подключение справочных файлов к приложениям
Преобразование справочного файла в формат HTML
Одна из важнейших составляющих успеха вашего приложения - полноценное документирование всех его возможностей, чтобы ваши пользователи всегда могли обратиться за справкой в том случае, если у них возникли трудности. Чем проще и подробнее построена документация, тем меньше проблем будет у пользователей. Существует два способа документирования приложений, и вам следует пользоваться обоими. Первый способ - создание электронной справочной системы Справка должна быть контекстно-зависимой, чтобы пользователь в любой момент мог получить информацию о текущих возможностях. Второй способ - печатная документация и руководства. В отличие от печатных руководств для создания электронной документации требуется знать не так уж много. Все необходимые навыки изложены в настоящем уроке.
|
|
Использование справочных файлов в приложениях
В состав готового приложения должна входить электронная справка. Она становится средством «первой помощи» в тех случаях, когда пользователю что-то не-сятно или он нуждается в инструкциях. Справочный файл должен быть тщательно проработан и интегрирован с основным приложением. Контекстная справка обеспечивает вызов справочной системы практически из любого элемента любой формы, а также выводит справочную информацию по текущему элементу. В этом урокe мы создадим простейший справочный файл, в котором объясняется как создать справочный файл. Пользуйтесь им, когда в будущем вам придется работать над собственной справочной системой.
Существует немало коммерческих и условно бесплатных программ, предназначенных для создания справочных файлов, однако в этом уроке мы воспользуемся инструментами Visual Basic.
ПРИМЕЧАНИЕ Вопреки распространенному мнению, создавать справочные файлы не так уж сложно. Труднее всего прочитать и понять документацию. В этом уроке разъясняются многие «белые пятна», связанные с разработкой справочных файлов.
Для создания справочного файла вам понадобится текстовый редактор который позволяет создавать сноски и сохранять файлы в формате RTF (Rich Text Format) многие разработчики применяют для этой цели Word for Windows, мы тоже воспользуемся этим редактором. Если у вас нет Word, работайте в другом редакторе Методику создания справочных файлов нетрудно понять и приспособить для вашего любимого редактора. Вам также понадобится компилятор, генерирующий HLP-файл по исходному файлу в формате RTF (a также по файлам растровых изобра-ш, если они используются). Visual Basic обладает собственным компилятором
|
|
справки. Мы воспользуемся программой Help Workshop, находящейся на компакт-диске Visual Basic (рис.13.1).
ПРИМЕЧАНИЕ После этого урока ознакомьтесь с руководством по компилятору справки (Help Compiler Guide), входящим в документацию Visual Basic. В нем содержится дополнительная информация о подготовке RTF-файлов и последующем создании HLP-файлов.
Рис. 13.1. Help Workshop