Переменные шаблона (TV)

Что такое переменная шаблона TV?

Переменные шаблона (TV поля) в MODX — это мощный инструмент для настройки и управления выводом информации на сайте. Они позволяют добавлять дополнительные поля к ресурсам, которые могут быть заполнены различной информацией, такой как текст, изображения, ссылки и другие данные.

Каждое TV поле имеет свой уникальный идентификатор и может быть настроено для определенных типов контента. Например, вы можете создать TV поле для заголовка страницы или изображения, которое будет отображаться на странице.

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

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

Создание переменной шаблона

1. Войдите в менеджер MODX

Войдите в админку MODX как администратор (или подобный), чтобы это работало!

2. Добавьте переменную шаблона (TV)

В левой панели дерева ресурсов перейдите на вкладку Элементы

3. Заполните общую информацию

Когда мы определяем TV, мы должны определить много информации о поведении этого настраиваемого поля. Вкладка «Общая информация» содержит основную информацию для этой переменной.

• Имя переменной: Это соответствует плейсхолдерам, которые будут использоваться в ваших шаблонах, например TableOfContents = [[*TableOfContents]]. Это имя должно быть уникальным!
• Подпись: Это основная метка для вашей переменной, которая появляется при редактировании ресурса, который использует это TV
• Описание: Это вторичная метка для вашей переменной
• Категория: Это влияет на то, на какой вкладке отображается переменная
• Порядок сортировки: Если вы используете более одного TV, это определит, какие из них появятся сверху (1 = верх, большие цифры опускаются TV вниз)

4. Определите параметры ввода

Затем нажмите на вкладку Параметры ввода: вам нужно выбрать тип поля, например, текстовое поле, раскрывающееся поле, WYSIWYG и т.д. Ознакомьтесь с Типами ввода переменных шаблона для полного списка возможных типов ввода.

• Тип ввода: Ваше поле может быть простым текстовым полем, раскрывающимся списком, ссылкой на другую страницу или множеством других типов полей.
• Варианты ввода: Некоторые типы ввода игнорируют это поле, но другие могут требовать его. Например. выпадающий список требует список возможных значений. Опять же, смотрите страницу Типы ввода переменных шаблона для получения дополнительной информации.
• Значение по умолчанию: это влияет на то, каким будет значение по умолчанию для поля. Это может быть простое значение, или он может использовать один из MODX Привязки чтобы делать такие вещи, как выборка значений из базы данных или наследование значений от родительской страницы.

5. Настроить доступ к шаблонам

Перейдите на вкладку Доступ к шаблону: вы должны определить, какой шаблон(ы) будет использовать это пользовательское поле, которое вы определили. Как только вы определили это пользовательское поле, вы можете выбрать, какой шаблон(ы) действительно может использовать Это.

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

6. Сохраните определение TV

Когда вы редактируете страницу, которая использует шаблон, связанный с этим TV, вы сможете добавлять данные в это поле TV.

7. Используйте это: создайте ресурс

Теперь, когда вы определили свой TV и добавили его в шаблон, добавьте ресурс MODX (например, щелкните правой кнопкой мыши в дереве документа и выберите Создать -> Создать ресурс здесь). Выберите шаблон, который использует этот TV.

8. Измените значение

Когда ваш ресурс MODX (т.е. страница) использует шаблон, содержащий вашу переменную шаблона, вы можете добавить данные к этому атрибуту, щелкнув на вкладке «Переменные шаблона» на странице.

Использование (вывод в шаблонах)

Допустим, у нас есть TV под названием bio, это текстовое поле TV, которое мы создали. Мы присвоили его нашему шаблону «Страницы биографии» и хотим показать его на нашей странице. Для этого мы просто поместим этот тег в наши шаблоны: [[*bio]]

Чтобы добавить TV на страницу, вы должны вспомнить его шаблон (это переменные Template, помните?). Убедитесь, что вы определили TV и прикрепили его к используемому шаблону. Смотрите страницу Создание переменной шаблона.

Расширенное использование

TVs также могут иметь свойства. Скажем, у вас был TV под названием «intromsg» со значением:

Hello [[+name]], you have [[+messageCount]] messages.

Вы можете заполнить данные с помощью вызова:

[[*intromsg?name=`George` &messageCount=`123`]]

Который будет выводить:

Hello George, you have 123 messages.

Выходные фильтры также отличные инструменты для применения к TV. Скажем, вы хотите ограничить вывод TV до 100 символов. Вы бы просто использовали выходной фильтр «limit»:

[[*bioMessage:limit=`100`]]

Когда мы говорим «Создать переменную шаблона», мы можем говорить о двух возможных действиях: мы можем ссылаться на действие добавления некоторого текста или содержимого в одно из существующих пользовательских полей при редактировании страницы MODX (т.е. ресурс). ИЛИ мы можем ссылаться на действие по определению этого поля, чтобы оно было доступно нашим ресурсам MODX. Эта страница посвящена последнему. В первом случае мы будем создавать пример переменной шаблона, в то время как второй случай — это определение схемы шаблона переменной, которая определяет, как будет вести себя каждый экземпляр.

Класс поля Когда вы создаете переменную шаблона, вы действительно определяете class настраиваемого поля: это действует как проект для всех экземпляров этого настраиваемого поля.

Расширенное использование

В ХОДЕ ЗАПОЛНЕНИЯ …

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

Параметры вывода

В большинстве случаев нужен вывод по умолчанию, но тем не менее к примеру для дат можно выбрать «Дата», и, как вы заметите, под этим полем (в зависимости от выбранного Output Render) будут отображаться некоторые поля формы.

Позволяет нам редактировать более детальные опции для этого Output Render.

Свойства

Оттуда мы можем указать любые свойства по умолчанию, которые мы хотим для TV. «Как вы можете использовать свойства для TV?», спросите вы. Ну, скажем, мы делаем текстовый TV под названием «singSS «. В нашем контенте у нас есть это:

Просмотр: [[+subsection]]

Мы можем добавить свойство списка «subsection» в сетку, а затем разрешить переопределение этого свойства с помощью наборов свойств. Скажем, мы создали набор свойств с именем CarsSectionTVPS (для набора свойств). В нем мы устанавливаем свойство «subsection» на «Cars». Затем мы прикрепили бы его к TV в нашем ресурсе, или шаблоне, или там, где мы его используем, следующим образом:

[[*viewingSS@CarsSectionTVPS]]

Это будет выводить TV:

Просмотр: Cars

Доступ к шаблонам и группам ресурсов

Мы можем назначить TV на Шаблоны, также. Это позволяет тем ресурсам, назначенным тем Шаблонам редактировать TV для каждого ресурса.

Кроме того, TV могут быть ограничены определенными группами ресурсов, которые можно выбрать в сетке с пометкой «Права доступа».