Разделы справки по стандартным компонентам строятся в соответствии с некоторыми стандартными принципами, которые перечисляются в этом разделе.

Каждый раздел имеет главную тему, в которой описываются основные возможности компонента. Именно эта тема появляется при нажатии клавиши Fl, когда компонент активен (выделен) в Палитре компонентов или в окне Редактора форм. В заголовке главной темы обычно указывается значок компонента. Для вставки в справку произвольного рисунка в виде растра используются специальные директивы:

{bmX Name.bmp} Здесь X - одна из букв 1, с или г, указывающая место вставки рисунка в строку, соответственно слева от нее, в центр или справа. Name.bmp - имя файла с растровым рисунком.

Заголовок главной темы состоит из двух строк: первая содержит значок и имя компонентного класса, вторая - ссылки Properties, Methods, Events и, возможно, Using CompClass, где CompClass - имя компонентного класса.

Обе строки оформляются в виде абзацев, для которых установлен флажок Не отрывать от следующего на вкладке Положение на странице окна, открываемого командой Формат ► Абзац. Такое оформление создает в окне справки так называемую фиксированную область, которая не участвует в прокрутке содержимого окна. В готовом файле справки эта область выделяется цветом и отделяется от остального текста темы чертой (рис. 10.9).

Текст во всех справках по стандартным компонентам оформляется шрифтом Arial высотой 10 пунктов. Обе строки заголовка выделяются полужирным шрифтом, высота первой - 12 пунктов, высота второй - 8.

ПРИМЕЧАНИЕ---

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

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

В стандартных справочных системах ниже следует пустая строка, затем слово «unit», далее имя модуля, в котором описан компонентный класс, и, наконец, еще одна пустая строка. Нестандартные компоненты обычно создаются в отдельном модуле (один модуль на один компонент). В этом случае ссылка на модуль не указывается. Вместо нее можно указать объявление компонентного класса (см. рис. 10.8).

ПРИМЕЧАНИЕ -

Все объявления классов, типов, свойств и т. п., а также примеры программ оформляются шрифтом Courier New высотой 10 пунктов с выделением зарезервированных слов полужирным шрифтом и комментариев - курсивом.

10.3.2. Особенности оформления тем компонентной справки

Рис. 10.9. Выделение фиксированной области в окне Word

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

Folder property (TFarDirExplorer) TFarDirExplorer

10.3. Создание контекстной справки || Оглавление || 10.3.3. Сноски А и В


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



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

  • Апрель
    2019
  • Пн
  • Вт
  • Ср
  • Чт
  • Пт
  • Сб
  • Вс