Компоненты разработчика

 

Функции ISBL

 

Редактор справки

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

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

·         Назначение – краткое описание функции;

·         Параметры – параметры функции. Выбор конкретного параметра функции для описания осуществляется на втором уровне дерева разделов. Раздел с параметрами формируется динамически на основе данных табличной части Параметры карточки функции (см. раздел «Карточка функции»);

·         Возвращаемое значение – описание возвращаемого значения функции;

·         Описание – подробное описание функции;

·         Примеры – примеры использования функции;

·         См. также – список функций, дополняющих описание текущей функции (например: функции, выполняющие похожие действия).

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

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

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

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

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

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

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

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

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

·         Назначение – задается при разработке справки;

·         Группа – группа функции – определяется из карточки функции;

·         Синтаксис – синтаксис вызова функции – формируется автоматически;

·         Параметры – описание параметров – задается при разработке справки;

·         Возвращаемое значение – задается при разработке справки;

·         Описание – задается при разработке справки;

·         Пример – ссылка на пример – пример задается при разработке справки;

·         См. также – гиперссылки на функции, список функций задается при разработке справки.

 

 

См. также:

·         Карточка функции;

·         Группы функций ISBL.