Руководство по структуре, макетам и операторам
Все системные директории защищены от перезаписи и не подлежат правке.
Ведётся сверка контрольных сумм, а все ручные изменения будут затёрты при обновлении.
Основные директории системы
│ ├─ modules — Модули системы (не изменяйте файлы внутри)
│ ├─ tools — Компоненты движка (не изменяйте файлы внутри)
│ ├─ themes — Темы панели управления (не сайта)
│ ├─ ajax — Компоненты, вызываемые с frontend напрямую (не изменяйте файлы внутри)
│ └─ editors — Сторонние редакторы кода и статей
> includes — Директория для сторонних скриптов. Единственное место, куда можно класть собственную backend логику!
> templates — Тут хранятся макеты и дизайны сайта. Для изменения можно пользоваться модулем /templates в ПУ
При обнаружении сторонних скриптов в корневой директории, система вышлет запрос на удаление данного файла или его разрешения (через ПУ).
Скрипты в директории /core удаляются автоматически без предупреждения.
Как вносить правки на страницы сайта
Страницы сайта хранятся в таблицах базы данных (например, в pages)
Для изменения страниц желательно использовать функционал ПУ
В отличии от множества других систем, материалы страниц жёстко привязаны к пунктам меню.
Иерархия структуры следующая: Сайт (таблица sites) → Меню (таблица menus) → Страница / пункт меню (таблица pages)
Пункты меню могут содержать другие пункты меню в неограниченном количестве (сложная вложенность)
Как вносить правки в макеты или изменять функционал
Макеты (шаблоны) сайта (см. директорию templates) — это файлы в формате sct.
Они представляют собой расширенный html (с поддержкой тегов/операторов [s-core])
Макеты хранятся в папках внутри директории templates. Папка со сборником макетов — отдельный дизайн для сайта.
Структура у дизайнов следующая:
│ ├─ images — директория изображений, используемых в дизайне
│ ├─ parts — части макета (опционально)
│ ├─ scripts — js скрипты макета (опционально)
│ ├─ styles — css стили макета (опционально)
│ ├─ info.json — описание дизайна в формате json
│ ├─ main.sct — макет для главной страницы (опционально)
│ ├─ general.sct — основной макет дизайна
│ └─ scr1.jpg — скриншот дизайна (обычно содержит изображение главной страницы сайта с данным дизайном)
Дизайн может содержать и другие директории, например fonts, icons и т.п., но не должен содержать backend логики и php файлов.
Если макет назван как url страницы, он автоматически будет применён к ней
Если макет назван как pagent_ID (где ID — id пункта меню),
он автоматически будет применён ко всем страницам, чей родитель имеет указанное ID,
если для них не задан персональный макет и нет макета с url страницы.
Также, можно явно указать, какой макет использовать для той или иной странице,
указав его в ПУ — Структура сайта → Меню → Статья → Редактор статей → Вкладка «Оформление и скрипты»
Блоки макета (parts)
Макеты могут логически разбиваться на блоки (parts). Это упрощает создание макетов с повторяющимися элементами.
Блоки макета могут содержать те-же операторы S-CORE и html, что и макеты. Они тоже имеют расширение sct.
Блоки макета хранятся в поддиректории parts, внутри папки макета. Например, /templates/serenity/footer.sct
В макетах блоки выводятся через оператор [s-core]templates part ИМЯ_ФАЙЛА[/s-core]
Имя файла внутри оператора пишется без расширения sct, например [S-core]templates part footer[/S-core]
Блоки макета могут подгружаться только из того набора макетов, где они хранятся.
Операторы S-CORE
Содержимое статьи добавляется в макет через оператор [s-core]pages data[/s-core]
Операторы S-CORE имеют следующий вид:
Чтобы узнать, какие операторы есть у модуля, можно воспользоваться оператором help
например, [s-core]pages help[/s-core] выведет на страницу сайта все операторы модуля pages.
Технически, операторы также описаны в json файле модуля, в блоке commands,
а их функционал — это методы класса модуля, что лежат в файлах interface.php в директории модуля,
например /core/modules/pages/interface.php > $pages->data($vars).
Добавление собственных backend скриптов
Все пользовательские php скрипты хранятся в директории /includes
Хранение скриптов в других местах может нанести вред сайту или системе, а встроенный механизм защиты может удалять такие скрипты автоматически.
Для добавления произвольного кода php, можно воспользоваться оператором execute, модуля main
Например, чтобы добавить скрипт /includes/hello.php, нужно добавить строку
в макет дизайна, его часть (через parts) или в статью (через редактор в ПУ)
Добавление стилей
Стили, как и js, на страницу можно добавить несколькими способами:
- Через макеты, для всех страниц сайта, что используют данный макет.
Для этого файл стиля добавляется в поддиректорию css, scripts или styles (возможны все три варианта)
директории дизайна. Например, /templates/serenity/styles/main.css (где serenity — имя дизайна для примера)
Затем, в макете указать команду [s-core]templates css ИМЯ[/s-core]
где ИМЯ — полный путь к файлу или curtemplate/ИМЯ для директории текущего дизайна.
Команду нужно указать СТРОГО до команды [s-core]templates head[/s-core] (она закрывает блок head в макете). - Через ПУ системы, модуль «Структура» → редактор статей → вкладка «Оформление и скрипты»,
где можно подключить любой css файл для конкретной статьи.
Сторонние стили подключаются аналогичным образом, через команду s-core (пропуская этап с загрузкой стиля в директорию)
Для стиля также возможно использовать асинхронную загрузку, указав параметр async после имени стиля в команде s-core
или выбрав режим загрузки в редакторе статей.
Добавление javascript
Скрипты js можно безопасно хранить внутри поддиректории scripts или js (возможны оба варианта)
директории дизайна. Например, /templates/serenity/scripts (где serenity — имя дизайна для примера)
Подключение js производится в макете до оператора [s-core]templates head[/s-core] при помощи оператора [s-core]templates js ИМЯ ОПЦИЯ[/s-core]
где ИМЯ — полный путь к файлу или curtemplate/ИМЯ для директории текущего дизайна
ОПЦИЯ — может принимать значения defer или async для асинхронной загрузки скрипта (рекомендуется) или быть опущена.
Также, возможно указание скриптов в редакторе статей, на вкладке «Скрипты и стили».
Сторонние скрипты подключаются аналогичным образом, через команду s-core (пропуская этап с загрузкой скрипта в директорию)
Правка модулей
Для создания нового модуля нужно иметь лицензионную подпись и аккредитацию.
Все созданные модули и их версии хранятся на эталонном сервере разработчика.
По этой причине создание модуля возможно только через согласование с правообладателем системы.
Правки внутри модулей возможны только после снятия шифрования и установки пометки — разрешения на правку.
Такая пометка отключает автоматическую проверку контрольных сумм модуля, что понижает безопасность.
Все неподписанные модули автоматически удаляются системой, а в случаи невозможности их удаление,
происходит автоматический отзыв лицензии (блокировка может быть снята после обращения правообладателя в поддержку и
исправления причины блокировки с последующим аудитом кода).