|
| 1 | +TV-параметр в MODx - элемент (поле), который содержит определенную информацию для текущей страницы. |
| 2 | + |
| 3 | +TV-параметры позволяют добавить к документу дополнительную информацию, которую затем можно использовать наравне с основными параметрами. Они имеют различные типы и в зависимости от этого меняется их поведение и внешний вид. Значение параметра можно вывести на страницу или передать сниппету для дальнейшей обработки. |
| 4 | + |
| 5 | +#### Для чего нужен TV-параметр? |
| 6 | + |
| 7 | +Для упорядочненного и логичного хранения информации на сайте. Допустим, на сайте есть 2 типа материалов - товары и новости. Для товара можно создать параметры, в одном из которых будет храниться цена, а в другом фотография. А для новостей - теги и сюжет. |
| 8 | + |
| 9 | +Зачастую TV-параметры используются для создания SEO-полей наподобие meta description, keywords и т.д. |
| 10 | +Параметры привязываются к шаблонам, и это позоляет в зависимости от типа материала задавать абсолютно разные для заполнения поля. |
| 11 | + |
| 12 | +### Пример параметра: |
| 13 | + |
| 14 | +[\*pagetitle\*] - вызов параметра в шаблоне, который вернет заголовок страницы. Чаще всего он используется для вывода title: |
| 15 | +``` |
| 16 | +<head> |
| 17 | +<title>[*pagetitle*]</title> |
| 18 | +</head> |
| 19 | +``` |
| 20 | + |
| 21 | +Все параметры можно разделить на основные, системные и пользовательские. |
| 22 | + |
| 23 | +### Основные параметры: |
| 24 | + |
| 25 | +Список основных параметров заранее определен в cms и содержит основную информацию о документе. Большую часть из них можете увидеть при создании и редактировании любого документа. |
| 26 | + |
| 27 | +#### Наиболее используемые: |
| 28 | + |
| 29 | +- **[\*pagetitle\*]** - заголовок документа |
| 30 | +- **[\*longtitle\*]** - расширенный заголовок документа |
| 31 | +- **[\*description\*]** - описание документа |
| 32 | +- **[\*introtext\*]** - аннотация документа |
| 33 | +- **[\*content\*]** - содержимое документа |
| 34 | +- **[\*id\*]** - идентификатор (номер) документа |
| 35 | +- **[\*parent\*]** - номер (ID) родительского документа |
| 36 | +- **[\*pub_date\*]** - дата публикации дкоумента |
| 37 | +- **[\*unpub_date\*]** - дата завершения публикации |
| 38 | +- **[\*createdby\*]** - Идентификатор пользователя создавшего документ |
| 39 | +- **[\*createdon\*]** - Дата создания документа |
| 40 | +- **[\~идентификатор\~]** - URL документа по указанному идентификатору |
| 41 | + |
| 42 | +Стоит отдельно упомянуть о том, что параметры можно сочетать. В особенности это актуально для создания ссылок на разные документы с помощью параметра **[\~идентификатор\~]**. В качестве идентификатора можно также задать параметр. |
| 43 | + |
| 44 | +**[\~[\*id\*]\~]** -Вывести ссылку на текущий документ. |
| 45 | + |
| 46 | +**[\~[\*parent\*]\~]** - Вывести ссылку на родителя текущего документа. |
| 47 | + |
| 48 | +#### Дополнительные |
| 49 | + |
| 50 | +- **[\*alias\*]** - псевдоним документа |
| 51 | +- **[\*editedby\*]** - идентификатор пользователя, редактировавшего документ |
| 52 | +- **[\*editedon\*]** - дата редактирования документа |
| 53 | +- **[\*type\*]** - тип ресурса (документ, папка или ссылка) |
| 54 | +- **[\*contentType\*]** - тип содержимого (например, text/html) |
| 55 | +- **[\*published\*]** - опубликован ли документ (1|0) |
| 56 | +- **[\*isfolder\*]** - является ли документа папкой (1|0) |
| 57 | +- **[\*richtext\*]** - используется ли при редактировании документа визуальный редактор |
| 58 | +- **[\*template\*]** - номер (ID) используемого шаблона для документа |
| 59 | +- **[\*menuindex\*]** - порядковый номер отображения в меню |
| 60 | +- **[\*searchable\*]** - доступен ли документ для поиска (1|0) |
| 61 | +- **[\*cacheable\*]** - Кэшируется ли документ (1|0) |
| 62 | +- **[\*deleted\*]** - документ удален (1|0) |
| 63 | +- **[\*deletedby\*]** - идентификатор пользователя удалившего документ |
| 64 | +- **[\*menutitle\*]** - заголовок меню. |
| 65 | +- **[\*donthit\*]** - Слежение за количеством посещений отключено (1|0) |
| 66 | +- **[\*haskeywords\*]** - Документ содержит ключевые слова (1|0) |
| 67 | +- **[\*hasmetatags\*]** - Документ имеет метатеги (1|0) |
| 68 | +- **[\*privateweb\*]** - Документ входит в частную группу пользовательских документов (1|0) |
| 69 | +- **[\*privatemgr\*]** - Документ входит в частную группу менеджерских документов (1|0) |
| 70 | +- **[\*content_dispo\*]** - Вариант выдачи содержимого (1 - для отображения | 0 - для скачивания) |
| 71 | +- **[\*hidemenu\*]** - Документ не отображается в меню (1|0) |
| 72 | +- **[\*alias_visible\*]** - Участвует ли документ в формировании URL(1|0) |
| 73 | + |
| 74 | +### Системные параметры |
| 75 | + |
| 76 | +Параметры, которые отображают системные данные |
| 77 | + |
| 78 | +- **[^qt^]** - время на запросы к базе данных |
| 79 | +- **[^q^]** - запросов к базе данных |
| 80 | +- **[^p^]** - время на работу PHP скриптов |
| 81 | +- **[^t^]** - общее время на генерацию страницы |
| 82 | +- **[^s^]** - источник содержимого (база или кэш) |
| 83 | +- **[^m^]** - количество потребляемой памяти |
| 84 | + |
| 85 | +#### Пример: |
| 86 | + |
| 87 | +``` |
| 88 | +Memory : [^m^], |
| 89 | +MySQL: [^qt^], [^q^] request(s), |
| 90 | +PHP: [^p^], |
| 91 | +Total time: [^t^], |
| 92 | +Document from [^s^]. |
| 93 | +``` |
| 94 | + |
| 95 | +### Пользовательские TV-параметры |
| 96 | + |
| 97 | +Пользовательские параметры создаются программистом вручную, исходя из опыта и структуры сайта. |
| 98 | + |
| 99 | +#### Создание и редактирование TV-параметра |
| 100 | + |
| 101 | +Для создания параметра необходимо нажать на ссылку "Элементы - Параметры (TV)" и выбрать "Новый параметр (TV)". |
| 102 | + |
| 103 | + |
| 104 | + |
| 105 | +#### Назначение полей |
| 106 | + |
| 107 | +- **Имя параметра** - используется для вызова TV-параметра. Можно использовать как английский так и русский язык, а также дефис и знак подчеркивания. Пробел использовать нельзя! |
| 108 | +- **Заголовок** - используется для названия TV-параметра в документе при редактировании. |
| 109 | +- **Описание** - используется для более расширенной информации о параметре в документе при редактировании, а также в общем списке TV-параметров. |
| 110 | +- **Тип ввода** - определяет вид получаемой информации. В зависимости от выбранного типа интерфейс меняется. Более подробно смотрите "Типы ввода". |
| 111 | +- **Значение по умолчанию** - определеяет значение TV-параметра по умолчанию при редактировании документа. |
| 112 | +- **Возможные значения** - используются в некоторых типах ввода (например Radio Options, Check Box) для предоставления вариантов выбора. Более подробно смотрите Определение значений TV-параметра. |
| 113 | +- **Визуальный компонент** - определеяет вариант вывода TV-параметра на страницу сайта. Более подробно смотрите Вид TV-параметра. |
| 114 | +- **Порядок в списке** - определяет порядок TV-параметра в документе. |
| 115 | +- **"Замок" в имени параметра** - если включить флажок, то никто, кроме администраторов не сможет редактировать этот TV-параметр. |
| 116 | + |
| 117 | +#### Типы ввода #### |
| 118 | + |
| 119 | +- **Text** - поле ввода. |
| 120 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 121 | + |
| 122 | +- **Raw Text, Raw Textarea** - устарели и не рекомендуются к использованию. |
| 123 | +Вместо них рекомендуется использовать Textarea и Textarea (Mini). |
| 124 | + |
| 125 | +- **Textarea и Textarea (Mini)** - текстовое поле. Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 126 | + |
| 127 | +- **RichText** - поле с визуальным редактором. |
| 128 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 129 | + |
| 130 | +- **DropDown List Menu** - раскрывающийся список. |
| 131 | +Поле "Возможные значения" задает список значений и определеляется специальным форматом. Более подробно смотрите Определение значений TV-параметра. Значение по-умолчанию определяет выбранный пункт при первом редактировании. |
| 132 | + |
| 133 | +- **Listbox (Single-Select) и Listbox (Multi-Select)** - список множественного выбора. |
| 134 | +Single-Select и Multi-Select отличаются только тем, что в первом варианте можно выбрать одно значение, а во втором несколько (с использование Ctrl). |
| 135 | +Поле "Возможные значения" задает конечный список значений и определеляется специальным форматом. Более подробно смотрите Определение значений TV-параметра. Значение по умолчанию определяет выбранный пункт при первом редактировании. |
| 136 | + |
| 137 | +- **Radio Options** - переключатели. |
| 138 | +Поле Возможные значения задает конечный список значений и определеляется специальным форматом. Более подробно смотрите Определение значений TV-параметра. Значение по умолчанию определяет выбранный пункт при первом редактировании. |
| 139 | + |
| 140 | +- **Check Box** - флажки. |
| 141 | +Поле Возможные значения задает конечный список значений и определеляется специальным форматом. Более подробно смотрите Определение значений TV-параметра. Значение по умолчанию определяет выбранный пункт при первом редактировании. |
| 142 | + |
| 143 | +- **Image** - изображение. |
| 144 | +При нажатии кнопки "Вставить" открывается файловый менеджер, который позволяет выбрать необходимое изображение и загрузить его. |
| 145 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 146 | + |
| 147 | +- **File** - файл. |
| 148 | +При нажатии кнопки "Вставить" открывается файловый менеджер, который позволяет выбрать необходимый файл и загрузить его. |
| 149 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 150 | + |
| 151 | +- **URL** - ссылка. |
| 152 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 153 | + |
| 154 | +- **Email** - электронная почта. |
| 155 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 156 | + |
| 157 | +- **Number** - число. |
| 158 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 159 | + |
| 160 | +- **Date** - дата. |
| 161 | +Первая кнопка вызывает календарик, с помощью которого можно выбрать дату. Вторая кнопка стирает дату. |
| 162 | +Возможные значения не используются. Значение по умолчанию автоматически записывается в поле при первом редактировании. |
| 163 | + |
| 164 | +#### Определение значений TV-параметра #### |
| 165 | + |
| 166 | +Настройкой "Возможные значения" определяются варианты для таких параметров как DropDown List Menu, Listbox,Check Box и Radio Options. |
| 167 | + |
| 168 | +Формат определения значений следующий: |
| 169 | +``` |
| 170 | +параметр1==значение1||параметр2==значение2||параметр3==значение3 |
| 171 | +``` |
| 172 | +Разделитель "==" используется для разделения отображаемого и фактического значения, а разделитель "||" разделяет значения между собой. |
| 173 | + |
| 174 | +Если фактические и отображаемые значения совпадают, то можно использовать упрощенный вариант записи: |
| 175 | +``` |
| 176 | +значение1||значение2||значение3 |
| 177 | +``` |
| 178 | +#### Пример #### |
| 179 | + |
| 180 | +Тип ввода: DropDown List Menu |
| 181 | +Возможные значения: |
| 182 | +``` |
| 183 | +Красный==#FF0000||Зеленый==#00FF00||Синий==#0000FF |
| 184 | +``` |
| 185 | + |
| 186 | +Когда пользователь будет редактировать документ, то увидит выпадающий список со значениями "Красный, Зеленый, Синий". При выборе значения и сохранения документа в базу сохранится одно из значений - #FF0000, #00FF00 или #0000FF. |
0 commit comments