- •Лабораторная работа № 6. Создание справочной системы.
- •Управляющие символы
- •Идентификатор раздела
- •Описание идентификатора целесообразно делать коротким и информативным. Заголовок раздела
- •Ключевое слово
- •Альтернативное ключевое слово
- •Номер в последовательности просмотра
- •Запуск макрокоманды
- •Признак включения раздела в справочный файл
- •Тип вторичного окна
- •Ссылки на другие разделы справочной системы
- •Переход к другим разделам
- •Окно с дополнительной информацией
- •Действие по ссылке
- •Назначение, состав и возможности электронной записной книжки
- •Тема содержания
- •Раздел справочной системы
- •Макрокоманда
- •Включаемое оглавление
- •Основные настройки
- •Сжатие справочного файла
- •Сортировка справочной информации
- •Расположение файлов, используемых в проекте
- •Полнотекстовый поиск
- •Шрифты, используемые в справочной системе
- •Включение статей в справочную систему
- •Запуск макрокоманд по ключевым словам
- •Общие настройки окна
Назначение, состав и возможности электронной записной книжки
Данная телефонная записная книжка предназначена для хранения информации о людях: ФИО, дата рождения, пол, номера имеющихся у них телефонов; а также для удобной работы с этой информацией
При запуске программы появляется основное окноMainWin (главная форма) с именем “Информация о людях”, большую часть которой занимают элементы отображения информации из БДView.
Различные возможности по работе с информацией предоставляют навигаторыNavigator и менюMenu.
См. также Завершение работыClose.
В конце текста следует ввести дополнительный пустой абзац. В этом тексте первая строка представляет собой заголовок, который должен быть соответствующим образом оформлен, остальные строки – текст раздела. Подчеркнутые двойной линией слова являются выделенными фрагментами, по которым осуществляется переход на другие разделы справочной системы. После компиляции они будут подчеркнуты сплошной линией. Подчеркнутые пунктирной линией слова – ссылки на другие разделы справочной системы, оформленные как скрытый текст. После компиляции они станут невидимыми.
Правила оформления текста (двойное подчеркивание, скрытый текст и т.д.) были описаны выше.
Выделим также фрагменты текста с двойным подчеркиванием синим цветом, для чего в строке ввода со списком Color (Цвет) выберем синий цвет. Нажмем кнопку ОК.
Определим уникальный идентификатор раздела. Для этого установим курсор перед первым словом раздела - “Назначение”, и зададим команду меню Insert|Footnote (Вставка|Сноска). После этого в появившемся окне Footnote and Endnote (Сноски) в группе Insert (Вставить сноску) установим переключатель Footnote (Обычную). Затем в группе Numbering (Нумерация) установим переключатель Custom Mark (Другая), в строке ввода рядом с ним введем символ # и нажмем кнопку ОК. В результате перед первым предложением строки появится изображение # в виде надстрочного индекса (оформление сноски), такой же символ появится внизу страницы. Внизу страницы рядом с символом сноски нужно ввести уникальный идентификатор раздела – “MainTopic”.
Определим заголовок данного раздела, которым он будет отображаться в окне результатов поиска. Для этого произведем те же действия, что и в п.3, за исключением того, что символ, помещаемый в строку ввода рядом с переключателем Custom Mark (Другая) в окне Footnote and Endnote (Сноски), - $, а текст внизу страницы рядом с символом сноски – “Назначение, состав и возможности”.
Определим ключевые слова для данного раздела, по которым можно будет его найти. Для этого произведем те же действия, что и в п.3, за исключением того, что символом сноски будет символ K (латинская), а текст внизу страницы рядом с символом сноски – “о программе;назначение;состав;возможности”.
Поместим созданный раздел на отдельную страницу. Для этого разместим курсор за последним словом в разделе и зададим команду меню Insert|Break (Вставка|Разрыв). Затем в появившемся окне выберем переключатель Page Break (Новую страницу) и нажмем кнопку ОК.
Наберем на новой странице текст справочной системы, посвященного описанию основного окна с именем “Информация о людях”:
Основное окно
В данном окне производится большая часть работы с информацией из БД, и отображаются результаты всех операций и действий через элементы отображенияView. А имеющиеся элементы управления, такие как навигаторыNavigator и менюMenu, обеспечивают взаимодействие и работу с информацией о людях, хранящейся в БД, а также завершение работыClose с приложением.
В конце текста следует ввести дополнительный пустой абзац. Оформление текста аналогично описанному в п.2.
Действуя аналогично пп.3-5, установим уникальный идентификатор раздела – “MainWin”, заголовок раздела – “Основное окно”, ключевые слова – “основное окно;главное окно;главная форма;основная форма;информация о людях”.
Поместим созданный раздел на отдельную страницу, выполнив такие же действия, как в п.6.
Наберем текст раздела справочной системы, посвященного описанию элементов отображения информации в целом:
Элементы отображения информации
Вся информация, содержащаяся в записной книжке, разбита В БД на две таблицы: People.db – данные о человеке, Tel.db – данные о телефонах человека, в результате чего для ее отображения используется два вида элементов: строки вводаEdit, расположенные в верхней части основного окнаMainWin, и таблицаGrid, расположенная в нижней части основного окна.
В конце текста следует ввести дополнительный пустой абзац. Оформление текста аналогично описанному в п.2.
Действуя аналогично пп.3-5, установим уникальный идентификатор раздела – “View”, заголовок раздела – “Элементы отображения информации”, ключевые слова – “элементы отображения информации;строки ввода;таблица”.
Поместим созданный раздел на отдельную страницу, выполнив такие же действия, как в п.6.
Наберем текст раздела справочной системы, посвященный описанию строк ввода:
Строки ввода
Данные элементы отображенияView предназначены для ввода/вывода и редактирования данных о человеке
Имеются следующие строки ввода:
Строка ввода порядкового номера: информация данного типа отображается в виде: Порядковый номер: 012; а вводится в виде: 12.
Строка ввода фамилии: информация данного типа отображается в виде строки, состоящей из символов латинского или русского алфавита и начинающейся с заглавной буквы; ввод фамилии производится в таком же формате.
Строка ввода имени: аналогична строке ввода фамилии.
Строка ввода отчества: аналогична строке ввода фамилии.
Строка ввода даты рождения: информация данного типа отображается в следующем виде: 15 Апрель 1979 г.; а ввод данных производится в формате: 15.04.1979 или 15.04.79.
Комбинированная строка ввода пола: для ввода информации данного типа используется выпадающий список допустимых значений.
Строка ввода комментариев: используется для ввода/вывода дополнительной информации в виде строки достаточно большой длины.
Строки ввода фамилии и даты рождения используются также при поиске по фамилииSeekFamily и при поиске по дате рожденияSeekDate для ввода искомого значения.
В конце текста следует ввести дополнительный пустой абзац. Оформление текста аналогично п.2.
Действуя аналогично пп.3-5, установим уникальный идентификатор раздела – “Edit”, заголовок раздела – “Строки ввода”, ключевые слова – “строки ввода;поиск;отображение информации;элементы отображения”.
Дополнительно определим номер в последовательности просмотра разделов, описывающих элементы отображения информации. Для этого произведем такие же действия, которые описаны в п.3, за исключением того, что символ, помещаемый в строке ввода рядом с переключателем Custom Mark (Другая) в окне Footnote and Endnote (Сноски), - +, а текст в нижнем окне рядом с текстом сноски – “View:005”.
Поместим созданный раздел на отдельную страницу, выполнив такие же действия, как в п.6.
Наберем текст раздела справочной системы, посвященного описанию таблицы:
Таблица.
Данный элемент отображенияView предназначен для ввода/вывода и редактирования данных о телефонах человека.
Она состоит из двух столбцов: “Номер” и “Тип”, определяющий тип телефона.
Номер отображается и вводится в виде 232-00-00.
Тип телефона вводится при помощи выпадающего списка допустимых значений.
В конце текста следует ввести дополнительный пустой абзац. Оформление текста аналогично описанному в п.2.
Действуя по аналогии, установим уникальный идентификатор раздела – “Grid”, заголовок раздела – “Таблица”, ключевые слова – “таблица;отображение информации;элементы отображения”, номер в последовательности просмотра – “View:010”.
Поместим созданный раздел на отдельную страницу, выполнив те же действия, что и в п.6.
Составим и оформим раздел справочной системы, описывающий навигаторы, присвоив ему уникальный идентификатор – “Navigator”, заголовок раздела – “Навигаторы”, ключевые слова – “элементы управления;навигатор;навигаторы”, и который содержит следующий текст:
Навигаторы.
В основном окнеMainWin расположены два навигатора, каждый из которых включает в себя следующие кнопки (слева на право, по порядку):
First record - Переход к первой записи.
Prior record - Переход к предыдущей записи.
Next record - Переход к следующей записи.
Last record - Переход к последней записи.
Insert record - Вставить новую запись.
Delete record - Удалить текущую запись.
Edit record - Редактировать текущую запись.
Post edit - Сохранить изменения в текущей записи.
Cancel edit - Отменить изменения в текущей записи.
Refresh data - Обновление данных в текущей записи.
При помощи 4-х левых кнопок верхнего навигатора осуществляется навигация по всем имеющимся в записной книжке записям. Осуществить те же операции при помощи нижнего навигатора не возможно.
Для того, чтобы вставить новую запись, необходимо нажать кнопку “плюс” на панели верхнего навигатора, внести необходимую информацию в строки вводаEdit и нажать кнопку сохранения того же навигатора. Только после этого осуществляется ввод телефонов для этого же человека при помощи нижнего навигатора аналогичным образом.
Все остальные операции имеют тот же принцип действия: сначала идет работа с данными конкретного человека при помощи верхнего навигатора, затем выполняются различные операции с информацией о телефонах того же человека при помощи нижнего навигатора.
Составим и оформим раздел справочной системы, описывающий меню, присвоив ему уникальный идентификатор – “Menu”, заголовок раздела – “Меню”, ключевые слова – “элементы управления;меню”, и который содержит следующий текст:
Меню.
Меню располагается в верхней части основного окнаMainWin, непосредственно под его названием.
Оно включает в себя следующие пункты:
ФайлFile.
ПоискSeek для поиска информации.
СортировкаSort для сортировки и упорядочивания информации по определенному признаку.
Составим и оформим раздел справочной системы, описывающий завершение работы с программой, присвоив ему уникальный идентификатор – “Close”, заголовок раздела – “Завершение работы”, ключевые слова – “закрытие формы;кнопка”, и который содержит следующий текст:
Завершение работы
Завершить работу с электронной записной книжкой можно двумя способами: нажав кнопку “Выход” в основном окнеMainWin программы или выбрав команду меню Файл|ВыходFile.
Составим и оформим раздел справочной системы, описывающий пункт меню “Файл”, присвоив ему уникальный идентификатор – “File”, заголовок раздела – “Пункт меню “Файл””, ключевые слова – “меню;файл;пункт меню Файл;печать;выход”, номер в последовательности просмотра – “Menu:005”, и который содержит следующий текст:
Пункт меню “Файл”.
Данный пункт менюMenu содержит следующие подпункты:
ПечатьPrint.
ВыходClose.
Составим и оформим раздел справочной системы, описывающий подпункт меню “Печать”, присвоив ему уникальный идентификатор – “Print”, заголовок раздела – “Печать”, ключевые слова – “печать;меню;файл;пункт меню Файл”, и который содержит следующий текст:
Печать.
Имеющееся менюMenu предоставляет возможность печати списка телефонов и их владельцев. При выборе команды Файл|Печать появляется окно предварительного просмотра, основную часть которого занимает изображение отчета, содержащего заголовок, системные дату и время, номер страницы и список людей с указанием их телефонов.
На верхней панели окна расположены следующие кнопки управления (слева на право):
Zoom to fit – Разместить страницу отчета полностью на экране.
Zoom to 100% - Отобразить страницу отчета так же, как она будет напечатана.
Zoom to page width – Разместить страницу, чтобы максимально отобразить ее ширину на экране.
First Page – Отобразить первую страницу отчета.
Previous Page – Отобразить предыдущую страницу отчета.
Next Page – Отобразить следующую страницу отчета.
Last Page – Отобразить последнюю страницу отчета.
Printer Setup – Определить параметры принтера в стандартном окне.
Print – Напечатать отчет.
Save – Сохранить отчет в файле с расширением .qrp.
Load – Загрузить отчет из файла с расширением .qrp.
Close – Закрыть стандартную форму для предварительного просмотра.
Составим и оформим раздел справочной системы, описывающий пункт меню “Поиск”, присвоив ему уникальный идентификатор – “Seek”, заголовок раздела – “Пункт меню “Поиск””, ключевые слова – “меню;поиск;пункт меню Поиск;поиск по фамилии;поиск по дате рождения”, номер в последовательности просмотра – “Menu:010”, и который содержит следующий текст:
Пункт меню “Поиск”.
Данный пункт менюMenu предоставляет возможность поиска необходимой информации по какому-либо признаку, в частности, по фамилии человекаSeekFamily и по дате рожденияSeekDate.
Составим и оформим раздел справочной системы, описывающий поиск по фамилии человека, присвоив ему уникальный идентификатор – “SeekFamily”, заголовок раздела – “Поиск по фамилии”, ключевые слова – “меню;поиск;пункт меню Поиск;поиск по фамилии”, и который содержит следующий текст:
Поиск по фамилии человека.
При выборе команды менюMenu Поиск|По фамилии появляется вспомогательное диалоговое окно с именем “Поиск по фамилии”, в котором необходимо ввести искомую фамилию в имеющуюся в окне строку ввода. Причем фамилию можно ввести не полностью, в этом случае будет найдена запись, наиболее похожая на искомую. Допускается также неточный ввод значения.
Результат поиска отображается в основном окнеMainWin через имеющиеся в нем средства отображенияView информации.
Работа заканчивается при нажатии одной из кнопок управления: “OK”ButtonOK или “Отмена”ButtonCancel.
См. также Строки вводаEdit
Составим и оформим раздел справочной системы, описывающий поиск по дате рождения человека, присвоив ему уникальный идентификатор – “SeekDate”, заголовок раздела – “Поиск по дате рождения”, ключевые слова – “меню;поиск;пункт меню Поиск;поиск по дате рождения”, и который содержит следующий текст:
Поиск по дате рождения человека.
При выборе команды менюMenu Поиск|По дате рождения появляется вспомогательное диалоговое окно с именем “Поиск по дате рождения”, в котором необходимо ввести искомую дату рождения в имеющуюся в окне строку ввода.
Результат поиска отображается в основном окнеMainWin через имеющиеся в нем средства отображенияView информации.
Работа заканчивается при нажатии одной из кнопок управления: “OK”ButtonOK или “Отмена”ButtonCancel.
См. также Строки вводаEdit.
Составим и оформим раздел справочной системы, описывающий кнопку “OK”, присвоив ему уникальный идентификатор – “ButtonOK”, заголовок раздела – “Кнопка “ОК””, ключевые слова – “меню;поиск;кнопки управления”, и который содержит следующий текст:
Кнопка “OK”.
Данная кнопка используется для подтверждения начала поискаSeek. При ее нажатии диалоговое окно закрывается и осуществляется поиск по заданному признаку.
Составим и оформим раздел справочной системы, описывающий кнопку “Отмена”, присвоив ему уникальный идентификатор – “ButtonCancel”, заголовок раздела – “Кнопка “Отмена””, ключевые слова – “меню;поиск;кнопки управления”, и который содержит следующий текст:
Кнопка “Отмена”.
Данная кнопка позволяет отменить операцию поискаSeek. При ее нажатии диалоговое окно закрывается, а поиск не производится.
Составим и оформим раздел справочной системы, описывающий пункт меню “Сортировка”, присвоив ему уникальный идентификатор – “Sort”, заголовок раздела – “Пункт меню “Сортировка””, ключевые слова – “меню;сортировка;пункт меню Сортировка;сортировка по фамилиям;сортировка по номеру”, номер в последовательности просмотра – “Menu:020”, и который содержит следующий текст:
Пункт меню “Сортировка”.
Данный пункт менюMenu предоставляет возможность упорядочивания информации по какому-либо признаку, в частности, по номеру записиSortNumber и по фамилиямSortFamily людей в алфавитном порядке.
Составим и оформим раздел справочной системы, описывающий сортировку по номеру записи, присвоив ему уникальный идентификатор – “SortNumber”, заголовок раздела – “Сортировка по номеру записи”, ключевые слова – “меню;сортировка;пункт меню Сортировка;сортировка по номеру”, и который содержит следующий текст:
Сортировка по номеру записи.
При выборе команды менюMenu Сортировка|По номеру осуществляется упорядочивание записей по номеру, что сразу же отображается в основном окнеMainWin приложения через средства отображенияView информации.
Составим и оформим раздел справочной системы, описывающий сортировку по фамилиям, присвоив ему уникальный идентификатор – “SortFamily”, заголовок раздела – “Сортировка по фамилиям”, ключевые слова – “меню;сортировка;пункт меню Сортировка;сортировка по фамилиям”, и который содержит следующий текст:
Сортировка по фамилиям.
При выборе команды менюMenu Сортировка|По фамилии осуществляется упорядочивание записей по фамилиям в алфавитном порядке, что сразу же отображается в основном окнеMainWin приложения через средства отображенияView информации.
Сохраним созданный документ для дальнейшего использования при формировании справочного файла под именем Help.rtf.
Создание содержания справочной системы:
Содержание в справочной системе необязательно, причем если его нет, то страница Contents в основном окне справочной системы отсутствует.
Инструментом для создания файла содержания справочной системы является утилита Microsoft Help Workshop. Она входит в состав пакета Delphi Standard 3.0 и содержит редактор файла описания проекта справочной системы. При установке пакета утилита помещается в папку C:\Program Files\Borland\Delphi 3\Help\Tools. Чтобы запустить ее, нужно запустить файл hcw.exe, находящийся в этой папке. После этого появляется окно Microsoft Help Workshop, с помощью которого будет проводиться дальнейшая работа по созданию файла содержания справочной системы.
Файл содержания справочной системы.
Содержание помещается в файл с расширением .cnt. Чтобы создать файл содержания, требуется после запуска утилиты Help Workshop выполнить команду меню File|New. При этом появиться окно New, в котором нужно выбрать из списка действий значение Help Contents (Содержание справочной системы) и нажать кнопку ОК. В результате будет открыто основное окно редактора файла содержания, основное место в котором занимает формируемый макет содержания. В нем всегда представляется развернутая структура оглавления.
В верхней части окна редактора находятся строки ввода для определения основных параметров по умолчанию. Чтобы задать значения в них, рекомендуется нажать кнопку Edit, находящуюся справа от строк ввода. В появившемся окне Default Help Information (Справочная информация по умолчанию) можно установить необходимые параметры в строки ввода.
Default Help Filename – имя справочного файла, который используется по умолчанию для отображения справочной информации.
Default Windows – тип вторичного окна справочной системы, в котором отображается информация из разделов справочной системы.
Default Title – заголовок, который будет у основного окна программы Winhlp32.
Элементы содержания.
Содержание представляет собой древовидную структуру, узлами которой выступают заголовки тем содержания, а листья – конкретные разделы или макрокоманды. Создание содержания логически связано с определением последовательностей просмотра статей в справочной системе. Связанные в одной последовательности просмотра разделы целесообразно помещать в одну тему содержания.
Чтобы добавить элемент содержания в макет, требуется нажать кнопки Add Above (Добавить впереди) или Add Below (Добавить сзади). После этого появляется окно Edit Contents Tab Entry (Редактор содержания), в котором требуется определить тип добавляемого в макет элемента, используя переключатели в верхней части этого окна: Heading (Тема содержания), Topic (Раздел справочной системы), Macro (Макрокоманда) и Include (Включаемое оглавление). В этом окне требуется также определить характеристики помещаемого в макет элемента оглавления. Элементы и их характеристики могут быть следующими: