Копировать ссылку на страницу Перейти в предыдущий раздел Перейти в следующий раздел

Для редактирования справки по функциям предназначен специальный редактор, который открывается из карточки функции при нажатии на вкладке Главная в группе Действия на кнопку Справка.

Щелкните для увеличения изображения

В левой части редактора справки расположено дерево с разделами справки:

Назначение – краткое описание функции;
Параметры – параметры функции. Выбор конкретного параметра функции для описания осуществляется на втором уровне дерева разделов. Раздел с параметрами формируется динамически на основе данных табличной части «Параметры»;
Возвращаемое значениеописание возвращаемого значения функции;
Описание – подробное описание функции;
Примеры – примеры использования функции;
См. также – список функций, дополняющих описание текущей функции (например: функции, выполняющие похожие действия).

В правой части редактора справки для каждого раздела, кроме См. также, отображается текстовый редактор. Для раздела См. также в правой части редактора отображается табличная часть, в которой задаются ссылки на другие функции.

При редактировании описания разделов в текстовом редакторе можно использовать теги форматирования, которые вставляются непосредственно в текст описания. Для вставки тега необходимо выделить текст, который должен быть отформатирован, и выбрать действие на ленте:

Ключевое слово. Формат тега: <key>Текст</key>. При просмотре справки текст выделяется жирным шрифтом.

Параметр. Формат тега: <par>Текст</par>. При просмотре справки текст выделяется курсивом.

Список. Формат тега: <list>Текст</list>. При просмотре справки текст отображается в виде маркированного списка.

Исходный код. Формат тега: <code>Текст</code>. При просмотре справки текст отображается моноширинным шрифтом на сером фоне.

Подзаголовок. Формат тега: <subheader>Текст</subheader>. При просмотре справки текст отображается жирным шрифтом и на отдельной строке.

При редактировании справки можно посмотреть, как будет выглядеть готовая справка по функции. Для этого на вкладке Главная в группе Действия нажмите на кнопку Предпросмотр.

Щелкните для увеличения изображения

При просмотре справки и при вызове справки по функции из редактора вычислений или при предварительном просмотре справки отображаются следующие разделы:

Назначение – задается при разработке справки;
Группа – группа функции – определяется из карточки функции;
Синтаксис – синтаксис вызова функции – формируется автоматически;
Параметры – описание параметров – задается при разработке справки;
Возвращаемое значение – задается при разработке справки;
Описание – задается при разработке справки;
Пример – ссылка на пример – пример задается при разработке справки;
См. также – гиперссылки на функции, список функций задается при разработке справки.
© Компания DIRECTUM, 2018 Сообщество пользователей DIRECTUM
.navbar > a:hover { background: #FFD73B; }