Логотип

Документация по макросам и шаблонам UMI.CMS

Справочник макросов UMI.CMS

О справочнике макросов

В данном справочнике перечислены основные макросы UMI.CMS. Каждый макрос сопровождается детальной информацией, полезной для понимания принципов работы макроса и шаблонов системы в целом. Макросы, являющиеся методами модулей, сгруппированы по соответствующим модулям.

Структура описания макроса

Все статьи справочника, посвященные отдельным макросам, построены по единому принципу:

  • Название — общая информация о макросе вида:

    %название макроса% — краткая информация о том, что именно делает макрос.

    Важно

    Название макроса является регистрозависимым. Написание макроса, представленное в документации, является единственным корректным вариантом.

  • Параметры — параметры макроса следующего вида:

    имя макроса (обязательный_параметр1, обязательный_параметр2, ... [, необязательный_параметр1 = 'значение_по_умолчанию', ... ] )

    Обязательные параметры не могут быть опущены при вызове макроса. Необязательные параметры в этом случае будут заменены на значения по умолчанию.

    Например:

    • %users viewAuthor()% — выдаст ошибку (пропущен обязательный параметр).

    • %users viewAuthor('14')% аналогично вызову %users viewAuthor('14', 'default')%

    При употреблении макроса с необязательными параметрами символы "[" и "]" указывать не нужно.

    Также в этом блоке приводится детальная информация по каждому из параметров.

  • Описание — подробное описание того, что именно делает этот макрос.

  • Раздел, посвященный XSLT-шаблонизатору:

    • Пример вызова — пример употребления макроса для получения данных в формате UData.

    • XML-ответ UData — пример ответа макроса в формате UData.

    • Элементы и атрибуты — описание отдельных элементов и их атрибутов в ответе UData.

    • Примеры использования — пример использования макроса для реализации конкретных задач.

  • Раздел, посвященный TPL-шаблонизатору:

    • Пример вызова — пример употребления макроса при использовании TPL-шаблонизатора.

    • Используемые шаблоны — папка, где должны храниться шаблоны макроса.

    • Используемые блоки шаблона — подробное описание того, какие блоки шаблона использует этот макрос и для чего.

    • Примеры использования — пример использования макроса для реализации конкретных задач.

  • Дополнительные сведения — ссылки на другие макросы, которые могут быть задействованы или полезны для работы с этим макросом.

Для некоторых макросов отдельные поля описания могут быть опущены.

Была ли данная статья полезна?