Delphi позволяет подключить внешний HLP-файл, содержащий справку о компоненте, его свойствах, методах и событиях так, чтобы эта справка вызывалась в среде IDE при нажатии клавиши F1, если компонент выбран в Палитре компонентов или активизирован в окне Редактора формы. Если пользователь компонента работает с его свойствами и событиями в окне Инспектора объектов, клавиша F1 предоставит ему справку по выбранному свойству (событию). Иными словами, среда поддерживает справочную службу вашего компонента точно так же, как справки по любым стандартным компонентам.

В этом разделе описывается процесс создания справочного файла для компонента и подключение его к среде Delphi. В папке $(SOURCE)\Help вы найдете все необходимые файлы справки о компоненте FarWatchClock, рассматриваемом в главе 6.

10.3.1. Создание справочного файла

Основным содержательным документом справочной службы является текстовый файл в формате RTF (Rich Text Format - расширенный текстовый формат). Для создания такого файла можно использовать любой текстовый редактор, поддерживающий формат RTF, в частности, WordPad, входящий в поставку Windows. Однако этот редактор не имеет развитых средств вставки управляющих сносок, которые играют исключительно важную роль в создании справочной службы WinHelp и в интегрировании справки в среду IDE Delphi, поэтому далее описывается методика создания справочного файла с помощью текстового процессора Word, входящего в пакет Microsoft Office.

Справочный файл состоит из серии страниц, каждая из которых определяет некоторую тему и в окне справки воспринимается как отдельная страница. Текст одной темы отделяется от следующей символом разрыва страницы (вставляется командой Вставка ► Разрыв или клавишами Ctrl+Enter).

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

Таблица 10.1. Сноски справочной службы

Сноска

Описание

#

Определяет уникальный идентификатор темы

$

Определяет название темы. Это название появится в списке «Выберите нужный

раздел и нажмите кнопку "Показать"» на вкладке Поиск окна Delphi Help

К

Определяет список ключевых слов. Эти слова появятся в списке «Выберите

подходящие слова, чтобы сузить поиск» на вкладке Поиск окна Delphi Help

А

Создает связь со справочной службой среды Delphi (см. 10.3.3)

в

Создает связь со справочной службой среды Delphi (см. 10.3.3)

На рис. 10.7 показан вид окна Word со справкой по компоненту.

Переход от одной темы к другой реализуется с помощью ссылок. Для определения ссылки часть текста или слово выделяют двойным подчеркиванием, и сразу за этим выделением указывается идентификатор вызываемой темы. Текст идентификатора записывается скрытым шрифтом (в окне, открываемом командой Формат ► Шрифт, устанавливается флажок Скрытый). При демонстрации справки ссылки выделяются цветом и подчеркиванием, кроме того на них меняет свою форму указатель мыши.

1 MultiHelp - это справочная служба среды Delphi, которая, в отличие от WinHelp, способна управлять множеством справочных файлов.

10.3. Создание контекстной справки

Рис. 10.7. Раздел справки в окне Word На рис. 10.8 показан текст справки в режиме отображения всех символов.

10.3. Создание контекстной справки
Рис. 10.8. Показанный на рис. 10.7 раздел справки «в действии»

10.2.2. Заимствование значка || Оглавление || 10.3.2. Особенности оформления тем компонентной справки


Искусство создания компонентов Delphi



Новости за месяц

  • Май
    2019
  • Пн
  • Вт
  • Ср
  • Чт
  • Пт
  • Сб
  • Вс