Дневник разработчика

О настройках TS и удобстве работы с шаблонами

Здесь хочу остановиться на том, как я сам редактирую шаблоны TypoSript (TS) и использую их на сайтах. 

Как известно, TYPO3 – система модульная, чем и хороша. Шаблоны также целесообразно строить модулями, собирая по кирпичикам целый сайт. Поясню.

Шаблон TS состоит из Констант, Настроек

и включений шаблонов либо из расширений, либо ранее созданных:

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

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

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

Лично я предпочитаю работать с файлам настроек и констант, соответственно. Почему для меня это удобно? Все просто. Несмотря на то, что внутренний интерфейс TYPO3 довольно удобен, но в нем практически невозможно одновременно работать сразу с несколькими документами, например править содержимое и одновременно подправлять настройки шаблона TS. А делать это приходиться постоянно. Несмотря на многие ухищрения, сетевая среда пока не располагает к многозадачной работе. На примере работы с шаблоном для расширения, поясню то, что я хочу донести.

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

Для начала по месту установки TYPO3 создаем папку fileadmin/config – она служит местом хранения всех файлов для настройки сайта. В ней же я создаю еще три папки: templavoila (для файлов templavoila), skins (для файлов внешнего оформления) и plugins (для файлов, предназначенных для расширений – у каждого из них своя подпапка).

Внутри папки fileadmin/config будут помещаться файлы для настроек typoscript-шаблонов. Это обычные текстовые файлы в кодировке UTF (без BOM), которым я дают расширение .ts. Сами файлы называю в соответствии с содержащимися в них настройками и предназначением:

• name_of_extension_constants.ts – для констант;
• name_of_extension_setup.ts – для настроек.

Для редактирования  файлов я предпочитаю использовать Notepad++ с  предустановками для синтаксиса typoscript. Для доступа к файловой системе сервера я использую  WinSCP.

Для чего все это нужно? А вот для чего. Итак, для настройки нашего расширения во внутреннем интерфейсе TYPO3, в папке-хранилище под названием Шаблоны, создаем новый шаблон, называем его "настройки для name_of_extension".

Переходим на вкладку "Включения" свойств шаблона и в разделе "Подключить статические шаблоны (из расширений):" подключаем необходимые нам статические шаблоны, предоставляемые настраиваемым расширением (находим их в левом столбце, кликаем мышкой, при этом они появляются в правом столбце). С этой частью покончено.

Теперь на вкладке "Общие" в текстовые поля вводим следующий код, соответственно для констант

									<INCLUDE_TYPOSCRIPT: source="FILE: fileadmin/config/name_of_extension_constants.ts">
									

и настроек

									<INCLUDE_TYPOSCRIPT: source="FILE: fileadmin/config/name_of_extension_setup.ts">

Тем самым в поле констант мы помещаем текст из файла name_of_extension_constants.ts, а в поле настроек (TypoScript Setup) текст из файла name_of_extension_setup.ts. После чего можем редактировать содержимое этих файлов в любимом текстовом редакторе, одновременно с работой во внутреннем интерфейсе TYPO3.

Но откуда взять константы и настройки для расширений? Все очень просто – из самих расширений! Закачав расширение в свою локальную установку TYPO3 мы получим папку вложенную в typo3conf/ext/ с названием совпадающим с ключом расширения (например, tt_news), в которой и находятся все файлы для данного расширения.

В недрах этих папок и запрятаны файлы с настройками для разных режимов и модулей расширений. Файлы с названиями setup.txt – не что иное, как typoscript для настроек, а  constants.txt – константы для настроек. Конечно же, авторы расширений могут дать и другие названия подобным файлам, но это крайне редкий случай. А сами настройки поясняются в комментариях (которые, кстати, можно перевести или сделать пометки для себя). Поэтому содержимое этих файлов можно скопировать в упомянутые выше файлы для настроек, чтобы было удобно вносить изменения и оградить себя от ошибок при неверном вводе названий переменных или параметров (что бывает весьма обидно).

В итоге получаем хорошо упорядоченную структуру шаблонов TS в базе данных (и дереве страниц) и соответствующую им структуру файлов для настроек расширений или функционала сайта.