MaxSite CMS 0.78 (тестирование)

Версия предназначена для тестирования, поэтому на рабочем сайте её не следует использовать. Она содержит изменения, касаемые нового варианта построения шаблонов. Причем понятие «новый-старый» не совсем корректное, поскольку «старый» точно также работает и останется достаточно длительное время. Я сохранил совместимость, так что можно сказать, что у вебмастеров появился ещё один вариант создания сайта.

В целом же это эволюционный этап: за год работы с Default 2, накопился ряд новых идей, замечаний и начиная с 0.78 я их буду реализовывать.

Основная идея в том, чтобы вынести часть файлов из default-шаблона в общий shared-каталог. У нас так сложилось, что default-шаблон хранит файлы, которые могут использоваться другими шаблонами. В итоге default-шаблон получился достаточно объёмный и вебмастерам (новичкам) не всегда очевидна логика работы.

Некоторые вещи, вроде type-файлов не совсем верно сделаны с идеологической точки зрения. По иерархии системы они должны находиться несколько выше самого шаблона, поскольку в них получаются данные, а кастомизация вывода уже реализуется на уровне шаблона через type_foreach-файлы (как вариант).

Я провёл некоторый анализ и составил список файлов и каталогов, которые действительно являются общими и нет смысла их копировать из шаблона в шаблон. Если сейчас не пойти на такую переделку, то default-шаблон распухнет еще больше.

Кратко расскажу что изменилось.

Все общие файлы вынесены в отдельный shared-каталог. Он находится выше чем шаблоны, поэтому не будет влиять на старые разработки. Default-шаблон остался в неизменом виде. Таким образом все старые шаблоны, которые используют default будут как и прежде работать.

Тут важный момент: теперь мы можем говорить о двух вариантах построения шаблона. Старый - на основе default и новый - на shared-каталоге. Технически это практически одно и тоже, но из-за некоторых изменений, парные файлы могут быть несовместимы. Например type-файлы из shared чуть по-другому подключают main-файлы. Так же есть и другие отличия. Так что не стоит смешивать эти два подхода в своем шаблоне.

Каталог shared/blanks содержит заготовки. Сейчас там create_a_new_template_old, custom-файлы и type_foreach-файлы. Эти файлы предназначены для копирования в свой шаблон.

CSS-cтили находятся в shared/css-less.

Каталог shared/functions хранит файлы, которые могут подключаться в functions.php шаблона. В default-шаблоне это аналог functions-template.php. Но в них есть различия. Файл не нужно копировать в свой шаблон, он подключается прямо из shared.

В каталог main я вынес main-start.php и main-end.php. Эти файлы нужны для работы шаблона, но их код как правило не меняется.

Каталог meta хранит мета-поля, которые могут использоваться всеми шаблонами.

Каталог options хранит файлы с функциями по работе с опциями. Здесь реализовано подключение ini-файл опций.

Каталог stock, традиционно содержит готовые скрипты. Подключать либо из shared, либо копировать в свой шаблон.

Каталог type содержит type-файлы. Теперь type-каталог имеет другую структуру. Тип подключается не по имени файла (+ .php), а по подкаталогу. Например для типа home: type/home/home.php, для записей: type/page/page.php и т.п. Такой подход значительно упрощает модульный подход, где требуется какая-то диспетчеризация вывода. Например главная страница может выводиться новостной лентой или в виде блоков рубрик. Технически проще это сделать с двумя файлами (+ home-cat-block.php), но чтобы исключить этот тип данных, приходилось прописывать исключения (см. index.php default-шаблона). Теперь в type-каталоге все подключаемые модули размещены в подкаталогах units. Вы можете посмотреть рализацию для типа users, где она достаточно проста для понимания.

Файлы main-start.php и main-end.php подключаются в type-файлах немного по-другому. Раньше было простое подключение через require. Теперь код будет таким:

if ($fn = mso_find_ts_file('main/main-start.php')) require($fn);

Функция mso_find_ts_file() ищет указанный файл вначале в каталоге шаблона, и если его нет, в shared-каталоге. На выходе false или полный путь файла. Функция достаточно часто используется, так что есть смысл сразу разобраться в чём её задача.

По структуре шаблон теперь стал несколько компактней и содержит меньше файлов. Я включил к комплект MaxSite CMS шаблон «D2». В каталоге осталось всего неколько базовых файлов:

• info.php - информация о шаблоне
• main.php - html-разметка шаблона (модульная сетка)
• functions.php - функции шаблона
• index.php - дипетчер типов данных (подключение type-файлов)

В main.php чуть поправлен php-код, он стал более компактным. Для компонентов шапки и подвала используются другие имена опций. Это связано с тем, что структура компонентов также изменилась и новые названия позволят избежать конфликта со старыми шаблонами. В остальном это тот же файл.

Файл functions.php практически тот же, только по-умолчанию загружаются некоторые stock-файлы. Файл не требует изменений - для своих целей предназначен, как и раньше, custom/my_functions.php.

Файл index.php сильно изменился. Вся диспетчеризация вынесена в отдельную функцию mso_dispatcher(), что позволило уменьшить размер кода (всего несколько строчек) и его логику.

Компоненты, как и прежде находятся в каталоге components, только теперь каждый компонент располагается в своём подкаталоге. Причём имя основного файла совпадает с именем каталога, например:

• components/menu/menu.php
• components/footer-copy-stat/footer-copy-stat.php

Структура в общем-то повторяет type-файлы. Для компонентов предусмотрено несколько предопределённых файлов:

• style.css - для стилей, которые подключаются в head
• options.ini и options.php - для опций

Если компонент начинается с «_» или «-», то его подключение (отображение в админ-панели) игнорируется. Такие «скрытые» компоненты могут использоваться в других компонентах прямым require-подключением.

Каталоги css, custom, images, js, language, stock, type и type_foreach сохранили своё предназначение, поэтому на них останавливаться не буду.

Новый каталог options содержит options.php, который через shared осуществляет диспетчеризацию опций, а также сами опции в виде привычных ini-файлов. Но, если раньше все опции были в одном ini-файле, то теперь опции можно разнести по отдельным произвольным файлам. Синтаксис полностью сохранён, поэтому логичней разбивать опции по секциям. Подключение производится в алфавитном порядке по именам файлов. Именно поэтому ini-файлы пронумерованы.

Каталог css-less содержит стили шаблона. Технически используется только var_style.less, который компилируется в css/var_style.css через css/var_style.php. Последовательность подключения css-файлов сохранилась, только теперь style-all-mini.css берётся из shared-каталога. Если в шаблоне нет css/var_style.css, то этот файл будет использован из shared-каталога. Грубо говоря, это позволяет вообще исключить css-файлы из своего шаблона. В «D2» именно так это и реализовано, то только с целью тестирования фреймворка style-all-mini.css. В рабочем шаблоне, конечно же, это не имеет смысла - нужно использовать свой css/var_style.css.

В css-less содержится структура каталогов для less-файлов, произведены некоторые подключения, но в целом эти вещи отданы на откуп вебмастера.

Несколько слов о фреймворке style-all-mini.css. В shared-каталоге находятся исходные less-стили. Я предусмотрел вариант, когда этот фреймворк либо не нужен, либо требуется пересобрать по своему варианту. Если в шаблоне будет файл css/style.php, то это будет единственный подключаемый файл вместо связки style-all-mini.css + var_style.css. Соответственно в этом файле можно разместить компилятор mso_lessc(), который будет отдавать в HEAD единый css-файл, собранный уже по своему алгоритму, по аналогии с var_style.less. При этом можно сделать подключение произвольных less-файлов из shared-каталога.

Стили style-all-mini.css немного поправил по типографике, а также удалил спорные моменты. В частности вывел из фреймворка стили некоторых компонентов, которые были в default-шаблоне. Теперь style-all-mini.css несколько проще и по идее вообще не содержит ничего лишнего. Если в своём шаблоне создать пустой var_style.css, то можно увидеть «чистый» style-all-mini.css.

Что в итоге?

Сам шаблон стал проще для понимания. Текущий вариант D2 по-идее будет новым «create_a_new_template», поскольку не содержит ничего лишнего. Все css-стили логично собраны в виде less-файлов, компилятор работает автоматом, можно об этом не задумываться. CSS-фреймворк «вычищен» и есть воможность собрать свой вариант.

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

Type-файлы, получив новую структуру, позволят создавать различные юниты-блоки. Например можно предусмотреть вывод записей колонками, блоками, в несколько рядов и т.п. Всё это будет готово к использованию, достаточно только подключить в своём type-файле. Раньше здесь были серьёзные ограничения, теперь о них можно забыть.

Далее в планах.

- Решить вопросы по css-классам type-файлов. Нужно всё привести к единой схеме именования и html-структуре. Буду признателен, если верстальщики подключатся к этому процессу. Если пожеланий не будет, сделаю на свой лад. После претензий принимать не буду (инфа 146%).

- LESS-миксы под разные задачи. Хочу отдельную библиотеку стилей.

- Блоки-юниты для type-файлов. Сделать разный вывод под разные задачи.

Скачать MaxSite CMS 0.78 (и все последующие в этом roadmap) можно на Github. У меня пока сложности с его освоением, могут быть «косяки», поэтому историю изменений обещать не буду. Качайте zip-версию.