Шаблоны страниц

У каждой страницы два шаблона: макет — то, что окружает содержимое, — и шаблон содержимого — то, что находится на этой странице. Оба представляют собой XML-файлы, размещающие компоненты в контейнерах. Страница также может хранить собственный XML вместо файла.

Расположение файлов

  • Модули поставляют шаблоны в core/modules/<module>/templates/layout/*.layout.xml и …/templates/content/*.content.xml; собственные шаблоны сайта располагаются в site/modules/main/templates/layout/ и …/content/.
  • Установщик связывает их с htdocs/templates/layout/ и htdocs/templates/content/: шаблоны ядра — напрямую, шаблоны сайта — в подпапку main/. После добавления шаблона выполните php index.php setup linker из htdocs/.
  • Страница хранит путь к файлу относительно этих папок: textblock.content.xml для шаблона ядра, main/users.content.xml для шаблона сайта.

Макет и содержимое вместе

Корневой элемент макета — <page>, шаблона содержимого — <content>. Если в макете присутствует пустой <content/>, на его место подставляется шаблон содержимого; в противном случае содержимое следует за макетом. Макет страниц ошибок содержит такой заполнитель:

<page>
    <component name="langSwitcher" class="Energine\share\components\LangSwitcher"/>
    <content/>
    <component name="footerTextBlock" class="Energine\share\components\TextBlock">
        <params>
            <param name="num">footerTextBlock</param>
        </params>
    </component>
</page>

Внутри корневого элемента:

  • <component name class> с <params> — см. Компоненты.
  • <container name …> группирует блоки; все его атрибуты копируются в XML страницы. Таблицы стилей сайта используют html_class (CSS-классы), block="alfa" или block="beta" (рамка блока; alfa — основной блок, отображающий заголовок страницы, кроме главной), column и widget (колонки и блоки редактора блоков), а также contains (вывести здесь другой контейнер или компонент).
  • <translations><translation const="…"/></translations> перечисляет строки интерфейса, необходимые представлению; <javascript><behavior name="…"/></javascript> — скрипты.

Корневой элемент шаблона содержимого может также содержать атрибуты: segment (фиксирует сегмент адреса страницы), layout (выбирает макет), unique (одна такая страница на сайт) и disabled (не предлагается в списке). robots.txt — именно такая страница: robots_txt.content.xml модуля seo:

<content segment="robots.txt" layout="empty.layout.xml" unique="">
    <component name="robots" class="Energine\seo\components\Robots"/>
</content>

Выбор шаблонов страницы

Форма страницы в «Управление структурой» (Structure management, /admin/structure/) содержит два списка: «Макет страницы» (Page layout) и «Содержимое страницы» (Page content). В них отображаются все файлы *.layout.xml или *.content.xml из htdocs/templates/…/ и подпапки main/ — либо, если на сайте есть site/modules/main/templates/content.include (или layout.include), только файлы, соответствующие строкам этого файла. Имя шаблона в списке — перевод константы LAYOUT_<NAME> или CONTENT_<NAME>, например CONTENT_TEXTBLOCK; шаблон без перевода отображает саму константу. Файл сайта с именем, совпадающим с файлом ядра, заменяет его в списке.

Собственный XML страницы

«Управление блоками» (Manage blocks) на панели инструментов страницы позволяет перемещать блоки страницы и сохранять результат:

  • «Сохранить только для этой страницы» (Save for this page only) — сохраняет XML непосредственно в странице;
  • «Сохранить в текущем шаблоне» (Save into the current template) — копирует шаблон ядра в site/modules/main/templates/content/ и переключает все страницы, использовавшие его, на копию;
  • «Вернуться к шаблону ядра» (Return to the core template) и «Вернуть к начальному виду» (Reset to the initial view) — отменяют эти действия.

Выбор другого шаблона в форме страницы удаляет собственный XML страницы.

Шаблоны, входящие в поставку

Файл В списке На странице
default.layout.xml «Базовый» (Basic) переключатель языков, баннеры, брендинг, подвальный текст и панель администратора
empty.layout.xml «Пустой» (Empty) ничего вокруг содержимого
main.content.xml «Главная страница» (Home page) три колонки: главное меню, боковой текст, форма входа, текст и последние новости
textblock.content.xml «Текстовая страница» (Text page) текст
media_textblock.content.xml «Текстовая страница с медиа-файлами» (Text page with media files) тексты и медиафайлы страницы
childs.content.xml «Список подразделов» (List of subsections) дочерние страницы текущей страницы
map.content.xml «Карта сайта» (Site map) дерево страниц
login, register, restore_password, user_profile «Авторизация» (Sign-in), «Регистрация» (Registration), «Восстановление пароля» (Password recovery), «Профиль пользователя» (User profile) страницы пользователя
news.content.xml «Список новостей» (News list) новости
feedback_form.content.xml «Форма обратной связи» (Feedback form) форма обратной связи

Страницы модулей — магазина, блогов, форм, рассылок — поставляются с собственными шаблонами; они перечислены на страницах документации соответствующих модулей.