Версия: 6.x
burger close
Пример создания темы оформления без использования сетки

Рассмотрим пример создания простой темы оформления без использования сетки. Данный способ пользуется большой популярностью, ввиду простоты и достаточной большой скорости создания таких тем. Такие темы имеют только один, в некоторых случаях незначительный, недостаток - их невозможно обновить простой заменой папки с темой, т.к. в шаблонах прописываются индивидуальные параметры при вставке блоков (видимой части модулей).

Что требуется для создания темы оформления?

  1. Установленная копия движка ReadyScript (можно trial, все равно на .local она работает без ограничений, вечно)
  2. Сверстанные макеты. Для примера, подготовлены 5 простых макетов, из которых предстоит собрать тему оформления.
  • index.html – главная страница
  • catalog.html – страница со списком товаров
  • product.html – страница просмотра товара
  • anytext.html – любая текстовая страница
  • 404.html – страница для ошибок

Отсюда можно скачать полный архив с демо-версткой.

Необходимо установить на время создания темы оформления следующие опции в разделе Управление->Настройки системы:

dev_options.png
Настройки системы

Создаем пустышку

Для начала требуется создать "пустой" шаблон, чтобы можно было его выбрать в административной панели и дальше работать с ним в режиме реального времени.

Темы оформления в ReadyScript располагаются в папке /templates, соответственно создадим в ней каталог с нашей новой темой. Назовем его example. Разместим там файлы:

  • theme.xml, следующего содержания:
    1 <?xml version="1.0" encoding="utf-8"?>
    2 <theme scriptType="shop" scriptMajorVersion="2" themeType="pc">
    3  <general>
    4  <author>ReadyScript lab.</author>
    5  <name>Тестовая тема оформления</name>
    6  <description>Создана для статьи о создании собственной темы</description>
    7  <version>2.0.0.0</version>
    8  </general>
    9  <shades>
    10  <shade>
    11  <id>black</id>
    12  <title>Черная</title>
    13  <color>#000000</color>
    14  </shade>
    15  <shade>
    16  <id>green</id>
    17  <title>Зеленая</title>
    18  <color>#00FF00</color>
    19  </shade>
    20  </shades>
    21 </theme>
  • layout.tpl, следующего содержания:
    1 {* Основной шаблон *}
    2 {addcss file="style.css"} {* подключаем файл ТЕКУЩАЯ_ТЕМА/resource/css/style.css *}
    3 {* Подключаем дополнительный стиль, если выбрана зеленая тема *}
    4 {if $THEME_SHADE == 'green'}{addcss file="style_green.css"}{/if}
    5 {$app->setDoctype('HTML')}
    6 {$app->blocks->renderLayout()} {* Запускаем рендеринг данной страницы *}
  • preview_black.jpg - скриншот темы в черном цвете
  • preview_green.jpg - скриншот темы в зеленом цвете

Необходимо также сразу перенести картинки, css-стили, скрипты из каталога с версткой в соответствующие папки создаваемой темы. т.е. в resource/img, resource/css, resource/js.

Далее заходим в административную панель ReadyScript в раздел Веб-сайт -> Настройка сайта. Выбираем нашу тему оформления.

select_theme.png
Выбор темы оформления

Тема установлена, можно переходить к её оформлению.

Формируем blocks.xml или связываем страницы с шаблонами

Для этих целей в ReadyScript служит раздел: Веб-сайт → Конструктор сайта. Заходим в него.

ReadyScript знает обо всех имеющихся "страницах" в системе (например: главная, просмотр категории товаров, карточка товара, регистрация, и.т.д) и предлагает администратору создать уникальное отображение для каждой из них. В случае, если для некоторой страницы индивидуальное отображение не задано, то используется отображение страницы по-умолчанию.

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

page_options.png
Настройки страницы

Нажимаем на иконку "Настройки страницы".

page_options_dialog.png
Окно настроек страницы

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

create_body_tpl.png
Создание шаблона default.tpl

Этот диалог поможет выбрать шаблон, а если его не существует, то создать. Не забываем нажать на кнопку "Сохранить", расположенную внизу страницы

page_options_after.png
Окно настроек страницы с выбранным шаблоном

В итоге у нас получится выбранное имя шаблона в диалоге редактирования страницы. После чего нажимаем "Сохранить" внизу страницы.

page_info.png
Связанный со страницей шаблон

Доказательством того, что страница по-умолчанию связана с шаблоном является данная надпись

Теперь нужно создать страницу "главная страница" и по аналогии связать её с шаблоном index.tpl.

add_page.png
Добавление новой страницы

Нажимаем добавить страницу и по аналогии связываем её с шаблоном index.tpl.

create_index_tpl.png
Создание шаблона Index.tpl

Пишем в файле index.tpl строчку Hello world и Сохраняем изменения.

page_index_info.png
Страницы в Конструкторе сайта

В итоге мы должны видеть две страницы в нашем Конструкторе сайта, которые связаны с соответствующими шаблонами. Чтобы обеспечить переносимость темы оформления на другой компьютер, нажимаем кнопку "Сохранить эталон темы" в правом углу, что приведет к созданию файла blocks.xml в каталоге нашей темы. Теперь, если зайти на главную страницу нашего сайта, мы увидим надпись Hello World! А это означает, что можно двигаться дальше.

Раскидываем HTML-верстку по tpl шаблонам

Так как у нас на главной странице и на всех стальных страницах имеются общие части(шапка, левая колонка, футер), то логично вынести их на уровень выше из шаблонов default.tpl и index.tpl. И пользоваться общей частью с помощью механизма наследования шаблонов Smarty3.

Назовем шаблон с общей частью - body.tpl. И запишем в него следующее содержимое:

1 <div class="viewport body">
2  <header>
3  {* Вставляем блок "логитип" *}
4  {moduleinsert name="\Main\Controller\Block\Logo" width="206" height="25"}
5  <div class="contacts">
6  <span class="phones">8-800-0000-000</span><br>
7  <span class="address">г. Краснодар, ул. Тестовая, 00</span>
8  </div>
9  </header>
10  <nav class="topMenu">
11  {* Вставляем блок "меню" *}
12  {moduleinsert name="\Menu\Controller\Block\Menu"}
13  </nav>
14  <div class="columns">
15  <aside class="leftColumn">
16  <nav class="catalog">
17  {* Вставляем блок "категории товаров" *}
18  {moduleinsert name="\Catalog\Controller\Block\Category"}
19  </nav>
20 
21  <section class="lastNews">
22  {* Вставляем блок "новости" из категории news *}
23  {moduleinsert name="\Article\Controller\Block\LastNews" category="news"}
24  </section>
25  </aside>
26  <div class="rightColumn">
27  {* Позволяем наследникам этого шаблона определять данную область *}
28  {block name="content"}{/block}
29  </div>
30  </div>
31  <br class="clear">
32  <footer>
33  {* Вставляем еще раз блок "логотип", но с другими параметрами *}
34  {moduleinsert name="\Main\Controller\Block\Logo" width="158" height="19"}
35  </footer>
36 </div>

Как видно, мы разметили разметили область "content", которую будут изменять наследники - default.tpl и index.tpl. А в местах, где должны отображаться блоки информации, связанные с базой, мы вставили конструкции по вызову блочных контроллеров. Кстати сказать, все блочные контроллеры в ReadyScript можно всегда найти в папках /modules/ИМЯ_МОДУЛЯ/controller/block/ИМЯ_БЛОКА. Если открыть класс блока, то в нем всегда можно увидеть его понятное название на Русском языке, описание и ожидаемые параметры.

Переходим к наполнению файла default.tpl. Записываем в него:

1 {extends file="%THEME%/body.tpl"} {* Указываем родителя данного шаблона *}
2 {block name="content"} {* Указываем какую часть будем перезаписывать *}
3  {$app->blocks->getMainContent()} {* Вставляем "Главное содержимое страницы" *}
4 {/block}

Специально для свободы действий разработчиков, фронт-контроллер главной страницы не возвращает ничего, т.е. "главного содержимого страницы" - не будет, соответственно мы должны позаботиться о том, чтобы в центральной колонке у нас отобразился блок "лидеры продаж". Теперь предстоит заполнить шаблон index.tpl. Заполняем:

1 {extends file="%THEME%/body.tpl"} {* Указываем родителя данного шаблона *}
2 {block name="content"} {* Указываем какую часть будем перезаписывать *}
3  {* Выводим 6 товаров из категории "top" *}
4  {moduleinsert name="\Catalog\Controller\Block\TopProducts" dirs="top" pageSize="6"}
5 {/block}

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

Делается это с помощью папки moduleview, которую мы должны создать в каталоге с темой. Чтобы перегрузить, например, шаблон "blocks/topproducts/top_products.tpl" из модуля catalog, нам нужно создать файл по следующему пути moduleview/catalog/blocks/topproducts/top_products.tpl.

где:

  • moduleview - папка для перегрузки шаблонов модулей
  • catalog - имя модуля
  • blocks - указывает, что это папка для шаблонов блочных контроллеров
  • topproducts - имя блочного контроллера
  • top_products.tpl - имя шаблона

Наверняка у читателя возникает вопрос: "А как же можно быстро узнать какой шаблон нужно перегрузить?" На этот случай предусмотрен режим отладки, который можно включить в правом верхнем углу на главной странице сайта, если вы авторизованы под администратором. Находясь в этом режиме, у каждого блока при наведении появляется панель инструментов. Среди инструментов есть иконка "Информация о блоке", при наведении на которую отображается подробная информация о том к какому модулю принадлежит блок и какой шаблон он использует.

block_info.png
Информаия о блоке

Узнать какой шаблон использует тот или иной блок можно также заглянув в класс подключаемого блок-контроллера.

Итак, для наших нужд нужно создать следующие шаблоны:

  • moduleview/main/blocks/logo/logo.tpl - шаблон отображения логотипа
  • moduleview/main/blocks/breadcrumbs/breadcrumbs.tpl - шаблон хлебных крошек
  • moduleview/menu/blocks/menu/hor_menu.tpl - шаблон отображения меню
  • moduleview/catalog/blocks/category/category.tpl - шаблон отображения списка категорий в левой колонке
  • moduleview/catalog/blocks/topproducts/top_products.tpl - шаблон Лидеров продаж
  • moduleview/catalog/list_products.tpl - шаблон просмотра категории. (его использует фронт контроллер, поэтому нет секции blocks)
  • moduleview/catalog/product.tpl - шаблон карточки товара
  • moduleview/article/blocks/lastnews/last_news.tpl - шаблон списка новостей в левой колонке
  • moduleview/article/view_article.tpl - шаблон просмотра новости

Существует 2 методики быстрой перегрузки шаблонов модулей:

1.С помощью модификации существующего шаблона. Т.е. сперва нужно найти шаблон в папке с модулем (Например: /modules/catalog/view/....) и скопировать его в соответствующую папку вашей темы (/templates/НАЗВАНИЕ ТЕМЫ/moduleview/catalog/...). А далее просто изменить HTML вокруг конструкций, возвращающих данные.

  1. Создание с нуля. Т.е. можно сразу создать шаблон в папке с темой (/templates/НАЗВАНИЕ ТЕМЫ/moduleview/МОДУЛЬ/....). Заполнить его необходимым HTML-кодом, а далее заменять строки переменными. Здесь возникает логичный вопрос: "Как можно узнать доступные в шаблоне переменные?". Ответ очень прост, с помощью режима отладки. Нужно кликнуть на иконку "Информация о блоке", и в новом окне откроются доступные переменные в шаблоне.
varclick.jpg
Настройки блоков

Нажмите на иконку

varinfo.jpg
Информация о переменных блока

В отдельном окне откроются все переменные, паредаваемые в шаблон

Также опытным пользователям, будет достаточно заглянуть в класс подключаемого блочного контроллера, чтобы понять какие переменные передаются в шаблон.

Чтобы узнать более подробные сведения о переменной, в Smarty доступна конструкция {var_dump($var)}

Нужно учитывать, что если опция "Подробное отображение ошибок" отключена, то во время любого исключения или ошибки 404 будет отображаться шаблон exception.tpl. Поэтому наполним его следующим кодом:

1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <title>Ой, ошибочка {$error.code}</title>
6 <link rel="stylesheet" type="text/css" href="{$THEME_CSS}/style.css">
7 </head>
8 <body>
9  <section class="exceptionBlock">
10  <div class="code">{$error.code}</div>
11  <div class="message">{$error.comment}</div>
12  </section>
13 </body>
14 </html>

Дело в том, что в отличие от других шаблонов темы оформления, этот шаблон не оборачивается стандартной шапкой и футером из тегов html, head, body, а возвращается как есть, поэтому мы должны позаботиться сами о подключении CSS файлов здесь.

Создание единого файла темы оформления

Чтобы позволить другим пользователям устанавливать полученную тему оформления, нужно просто добавить в zip архив, папку с темой - example.

Для загрузки новой темы оформления в систему ReadyScript, нужно зайти в административную панель в раздел Веб-сайт → Настройка сайта. Открыть диалог выбора темы оформления и нажать на кнопку "Выбрать zip-файл". После загрузки файла, тема станет доступна для выбора.

Итоговый файл темы оформления

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

Скачать итоговую тему оформления можно здесь Тема "Молодежная", присутствующая в дистрибутиве ReadyScript собрана без использования сетки, её также можно использовать в качестве эталона для разработки собственных тем.