Справка по системе Платформа ELMA BPM
×
Меню

Вкладка "Документация"

Настройки этой вкладки определяют, какая информация о настраиваемой переменной попадет в документацию по процессу.
Установленный флажок Использовать отображаемое имя и описание для документации указывает, что в документацию в качестве заголовка описания переменной необходимо включать её отображаемое имя, а в качестве описания - описание, заполненное на вкладке Общие настроек переменной (рис. 1).
Рис. 1. Свойства контекстной переменной. Вкладка "Документация"
с установленным флажком "Использовать отображаемое имя и описание для документации"
Если требуется включить в документацию дополнительное описание свойств, сущностей и примеры, необходимо снять флажок Использовать отображаемое имя и описание для документации. При этом ниже откроется поле для ввода специальных тегов XML, с помощью которых можно сформировать требуемое описание (рис. 2). Перечень и описание тегов используемых для оформления документации доступны на сайте Microsoft по адресу: http://msdn.microsoft.com/ru-ru/library/5ast78ax.aspx. По умолчанию в этом поле содержится XML код, в соответствии с которым формируется документация при установленном флажке Использовать отображаемое имя и описание для документации.
Рис. 2. Свойства контекстной переменной. Вкладка "Документация"
со снятым флажком "Использовать отображаемое имя и описание для документации"
См. также: