Представлення XSLT

XML-документ сторінки, зібраний із її компонентів, перетворюється на HTML за допомогою таблиць стилів XSLT 1.0, які виконує XSLTProcessor PHP (libxslt). Таблиці стилів використовують функції EXSLT set:distinct і dyn:evaluate; PHP-функції в них недоступні.

Головна таблиця стилів

Ключ конфігурації document.transformer — main.xslt у стартері — задає ім'я головної таблиці стилів у site/modules/main/transformers/. У стартері вона підключає представлення кожного модуля, а потім власні представлення сайту:

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
    <xsl:output method="html" doctype-system="about:legacy-compat"/>
    <xsl:include href="../../../../core/modules/share/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/user/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/calendar/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/apps/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/forms/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/comments/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/mail/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/ads/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/blog/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/shop/transformers/include.xslt"/>
    <xsl:include href="include.xslt"/>
</xsl:stylesheet>

Файл include.xslt сайту підключає energine.xslt — сторінку сайту: її шаблон match="/" будує <html> із заголовком і тілом, а match="document" розміщує компоненти макета та вміст. Таблиці стилів читаються там, де вони лежать, — вони не пов'язані з htdocs, тому редагування не потребує жодного підготовчого запуску, — а компілюються при кожному запиті: кешування таблиць стилів відсутнє.

Що отримує таблиця стилів

XML сторінки має кореневий елемент <document> з атрибутами debug і editable, а всередині нього:

  • <properties> — заголовок сторінки, ключові слова, опис, robots і шаблон, адреса сайту (base, разом з адресами статичних файлів, медіа та ресайзера) і мова;
  • <layout> і <content> — компоненти та контейнери шаблонів;
  • <translations> — рядки інтерфейсу, зареєстровані компонентами;
  • <javascript> — скрипти, потрібні компонентам.

document.xslt надає їм глобальні змінні: $DOC_PROPS, $COMPONENTS, $TRANSLATION, $BASE, $LANG_ID, $LANG_ABBR, $STATIC_URL, $MEDIA_URL, $RESIZER_URL та інші.

Як зіставляється компонент

Елемент компонента містить атрибути name, class — скорочену назву класу, — componentAction — його стан — і властивості, як-от type (list або form), exttype (grid для таблиць) і sample. Шаблони зіставляються за ними:

  • component[@type='list'] і component[@type='form'] — типові представлення списків і форм;
  • component[@sample='TextBlock'] показує кожен текстовий блок;
  • власний клас зіставляється за component[@class='Hello'].

Представлення текстового блоку:

<xsl:template match="component[@sample='TextBlock']">
    <xsl:if test="@editable or recordset/record/field != ''">
        <div class="textblock">
            <xsl:apply-templates/>
        </div>
    </xsl:if>
</xsl:template>

Два класи з однаковою скороченою назвою зіставляються однаково: Energine\apps\components\Ads і Energine\ads\components\Ads — обидва є Ads, і макет стартера розрізняє їх за іменем. XML, для якого не знайдено жодного шаблону, копіюється на сторінку без змін.

Зміна представлення

Розмістіть свої шаблони у файлі в site/modules/main/transformers/ і підключіть його з include.xslt сайту. Він підключається після ядра, тому шаблон з тим самим зразком замінює шаблон ядра; більш специфічний зразок або явно вказаний priority гарантує однозначний вибір.

Заголовок, стилі та скрипти

document.xslt будує заголовок: заголовок сторінки (власний HTML-заголовок сторінки або хлібні крихти), <base>, stylesheets/energine.css, stylesheets/main/main.css і print.css сайту, а також мета-теги. Далі йдуть MooTools 1.5.2 і scripts/Energine.js. Поведінки, які компоненти вказують у своїх конфігурах, завантажуються через карту скриптів htdocs/system.jsmap.php, яку записує php index.php setup scriptMap; без карти жодна сторінка не будується. jQuery 2.1.4 підключається з CDN Google і лише для поведінок, що його потребують; дивіться Відомі ризики. Порожній шаблон match="/" mode="scripts" у document.xslt — місце для власних скриптів.

Перегляд XML

Якщо в конфігурації увімкнено debug, додавання ?debug після адреси сторінки повертає XML-документ сторінки замість HTML, а сторінки помилок показують файл і рядок. На робочому сайті тримайте debug вимкненим.

Інші таблиці стилів вибираються в коді: error_page.xslt — для помилок, таблиці модуля seo — для robots.txt і карти сайту, rss.xslt — для стрічки новин, а вікна магазину — для single_*.xslt.