Основные принципы работы шаблонной системы

На печать

Шаблоны в Bagira.CMS – это файлы, содержащие HTML-код, на основе которых система генерирует оформление страниц. Редактировать подобные файлы можно в любом текстовом редакторе поддерживающем UTF-8. При создании шаблонов кроме HTML-кода, можно использовать CSS, JavaScript, а так же макросы системы. Все файлы шаблонов должны иметь расширение *.tpl.

По своему назначению шаблоны бывают двух видов:

Шаблоны для сайта находятся в папке /template в папке модуля, к которому относятся. Т.е. для каждого модуля существует своя папка, в которой хранятся шаблоны. Например, для модуля «Структура» это /template/structure.

Макросы – это функционал модулей системы, доступный вам для вызова из шаблонов оформления. Вместо макроса при построении страницы выводится определенная информация сгенерированная системой.  Список всех макросов системы, их назначение и способы использования приведены в разделе «Справочник по макросам системы».

Любой макрос системы справа и слева должен быть обрамлен специальным символом «%».

Общий синтаксис макроса:

%module.function(var1, var2)% где

module – имя модуля

function – имя функции вызываемой из модуля

var1, var2 – параметры, передаваемые в макрос

Обратите внимание, что все параметры, передаваемые в макрос, указываются без кавычек. Так же, если вы указываете шаблон оформления для макроса, расширение шаблона «.tpl» не указывается.

Правильно:

%structure.menu(footer)%

Неправильно:

%structure. menu (‘footer.tpl’)%

Кроме макросов функций существуют сокращенные макросы, которые пишутся в одно слово и без параметров. Например: Отменить, /mpanel/structure/page_upd/157 или %obj.name%.

Об общих принципах работы с шаблонами

Шаблоны это текстовые файлы, содержащие различные части оформления страниц. Структура файлов бывает двух видов:

В любом из этих шаблонов можно использовать любой глобальный макрос. Например, %structure.menu()%, %user.authForm()%  и прочие. А так же сокращенные макросы, которые специфичны для шаблонов. Список этих макросов для каждого конкретного шаблона свой, поэтому за справкой нужно обращаться в раздел «Справочник по макросам системы». Каждый блок составного шаблона имеет свое название, это название определяет назначение данного блока. Описание этих блоков тоже находится в разделе «Справочник по макросам системы».

Теперь о том, как система на основе всего этого генерирует страницы:

  1. Для текущей страницы определяется шаблон оформления (шаблон страницы).
  2. В этом шаблоне ищутся макросы и заменяются на соответствующие значения.
  3. Если макрос для своей работы использует шаблон, этот шаблон обрабатывается по таким же принципам.

Таким образом, главное понять, что любой макрос будет заменен на соответствующее значение. А как именно, это нужно смотреть в разделе «Справочник по макросам системы» для каждого конкретного макроса. Т.к. макросов не много, вы вскоре запомните, что и где использовать.



Что-то не так? Напиши, учтем!