Вызов справки

English version

Общие сведения

Бизнес платформа Xafari предусматривает возможность вызова справки. Для вызова справки на форме используется специальное действие (Action) XafariShowHelp (Справка). На панели инструментов это действие доступно по соответствующей кнопке. При выполнении действия XafariShowHelp открывается html-страница со справкой, url страниц для различных форм настраивается в редакторе модели.

Реализация

Для реализации справочной системы необходимо указать адрес сайта со справкой в атрибуте HelpSite узла Options|Help модели приложения.

Адрес сайта со справочной системой

Адрес сайта со справочной системой

Отдельным View приложения могут быть назначены соответствующие страницы с указанного сайта. Url страницы справки для отдельного View может быть определен двумя способами:

  1. задан вручную в атрибуте HelpPage для соответствующего View в модели приложения:
Указание страницы справки для отдельного View

Указание страницы справки для отдельного View

  1. сгенерирован в соответствии с шаблоном, определенным в атрибуте DefaultHelpPage узла Views:

Описания шаблона адреса страниц справки в узле Views

Описания шаблона адреса страниц справки в узле Views


Шаблон имеет формат {O:Id}.html, где в качестве параметра Id будет использоваться Id текущего View. Например, при вызове справки для формы списка пользователей (User_ListView), сформируется следующий url: «User_ListView.html».