|
1 | | -Автор: <a href="https://github.com/mnoskov/contentblocks">mnoskov</a> |
| 1 | +Автор: <a href="https://github.com/mnoskov/pagebuilder">mnoskov</a> |
2 | 2 |
|
3 | 3 | Плагин позволяет разработчику определить набор блоков с определенной разметкой и списком полей, чтобы контент-менеджер использовал те блоки, которые считает нужным, со своим наполнением. |
4 | 4 |
|
5 | | -Конфигурация для блоков берется из папки config. Для создания нового блока нужно создать в этой папке файл .php, который должен вернуть ассоциативный массив. Структура массива следующая: |
| 5 | +Конфигурация для блоков берется из папки config. Для создания нового блока нужно создать в этой папке файл `.php`, который должен вернуть ассоциативный массив. Для создания контейнера нужно создать файл `.php`, имя которго будет начинаться с `container.`. Структура массива следующая: |
6 | 6 |
|
7 | 7 | <table> |
8 | 8 | <tr><th>Ключ</th><th>Значение</th></tr> |
9 | 9 | <tr><td>title</td><td>Название блока, видимое менеджеру при заполнении</td></tr> |
| 10 | +<tr><td>container</td><td>Имя контейнера (если несколько - то массив имен), в котором будет выводится блок.</td></tr> |
10 | 11 | <tr> |
11 | 12 | <td>fields</td> |
12 | 13 | <td> |
|
22 | 23 | Если этот параметр указан, то "hide_in_docs" не принимается во внимание. |
23 | 24 |
|
24 | 25 | Если не указан ни один из параметров, ограничивающих доступ, блоки будут доступны во всех документах.</td></tr> |
| 26 | +<tr><td>order</td><td>Порядок сортировки в секции добавления блока. Этот параметр НЕ влияет на сортировку самих блоков!</td></tr> |
25 | 27 | <tr> |
26 | 28 | <td>templates</td> |
27 | 29 | <td> |
|
84 | 86 | Также возможна подгрузка шаблона из файла, например: |
85 | 87 |
|
86 | 88 | ```php |
87 | | -'owner' => '@FILE contentblocks/all_fields.tpl', |
| 89 | +'owner' => '@FILE pagebuilder/all_fields.tpl', |
88 | 90 | ``` |
89 | 91 |
|
90 | | -В этом примере файл шаблона будем загружен из `MODX_BASE_PATH . "assets/templates/contentblocks/all_fields.tpl"`. Вообще файл ищется в следующих директориях: |
| 92 | +В этом примере файл шаблона будем загружен из `MODX_BASE_PATH . "assets/templates/pagebuilder/all_fields.tpl"`. Вообще файл ищется в следующих директориях: |
91 | 93 |
|
92 | 94 | ``` |
93 | 95 | assets/tvs/ |
@@ -115,7 +117,7 @@ assets/templates/ |
115 | 117 | то вызов сниппета с параметром `&templates`, равным `anchors`, будет использовать для вывода шаблоны, которые определены в группе `anchors`: |
116 | 118 |
|
117 | 119 | ``` |
118 | | -[[ContentBlocks? &templates=`anchors`]] |
| 120 | +[[PageBuilder? &templates=`anchors`]] |
119 | 121 | ``` |
120 | 122 | ##Поля |
121 | 123 |
|
@@ -155,30 +157,33 @@ assets/templates/ |
155 | 157 |
|
156 | 158 | ##Примеры конфигурации |
157 | 159 |
|
158 | | -Примеры конфигурации можно найти <a href="https://github.com/mnoskov/contentblocks/tree/master/assets/plugins/contentblocks/config" target="_blank">здесь</a>. (Чтобы примеры блоков стали доступны для выбора, нужно переименовать файлы *.php.sample в *.php) |
| 160 | +Примеры конфигурации можно найти <a href="https://github.com/mnoskov/pagebuilder/tree/master/assets/plugins/pagebuilder/config" target="_blank">здесь</a>. (Чтобы примеры блоков стали доступны для выбора, нужно переименовать файлы *.php.sample в *.php) |
159 | 161 |
|
160 | | -##Сниппет ContentBlocks |
| 162 | +##Сниппет PageBuilder |
161 | 163 |
|
162 | | -Для вывода заполненых блоков используется сниппет ContentBlocks с параметрами: |
| 164 | +Для вывода заполненых блоков используется сниппет PageBuilder с параметрами: |
163 | 165 | <table> |
164 | 166 | <tr><th>Имя параметра</th><th>Значение по умолчанию</th><th>Возможные значения</th></tr> |
165 | 167 | <tr><td>docid</td><td>Текущий документ</td><td>Идентификатор любого существующего документа, целое число</td></tr> |
| 168 | +<tr><td>container</td><td>default</td><td>Имя контейнера</td></tr> |
166 | 169 | <tr><td>blocks</td><td>*</td><td>Список блоков через запятую, без пробелов. Берется имя файла конфигурации без расширения (Например, 'all_fields,groups'). Если указать '*', фильтрация по имени произведена не будет</td></tr> |
| 170 | +<tr><td>wrapTpl</td><td>[+wrap+]</td><td>Имя чанка, содержащего шаблон-обертку для списка блоков выводимого контейнера</td></tr> |
167 | 171 | <tr><td>templates</td><td></td><td>Идентификатор группы шаблонов, которые будут использоваться для вывода. Должен быть определен в конфигурации каждого выводимого блока</td></tr> |
168 | 172 | <tr><td>offset</td><td>0</td><td>Число пропускаемых блоков с начала вывода</td></tr> |
169 | 173 | <tr><td>limit</td><td>0</td><td>Число блоков для вывода, либо 0 - для вывода всех</td></tr> |
170 | 174 | </table> |
171 | 175 |
|
172 | | -##Плагин ContentBlocks |
| 176 | +##Плагин PageBuilder |
173 | 177 |
|
174 | 178 | Плагин отвечает за вывод формы редактирования блоков и имеет следующие параметры: |
175 | 179 | <table> |
176 | 180 | <tr><th>Имя параметра</th><th>Значение по умолчанию</th><th>Возможные значения</th></tr> |
177 | | -<tr><td>tabName</td><td>Content Blocks</td><td>Название вкладки на странице редактирования ресурса, в которой будет выводиться форма</td></tr> |
| 181 | +<tr><td>tabName</td><td>Page Builder</td><td>Название вкладки на странице редактирования ресурса, в которой будет выводиться форма</td></tr> |
178 | 182 | <tr><td>addType</td><td>dropdown</td><td>Вид секции для добавления новых блоков, может иметь значения "dropdown", "icons", "images". |
179 | 183 |
|
180 | 184 | Для значения "icons" в конфигурации каждого блока должен быть определен ключ "icon", содержащий класс иконки. |
181 | 185 |
|
182 | 186 | Для значения "images" должен быть определен ключ "image", с адресом изображения (макс. 80х60)</td></tr> |
183 | 187 | <tr><td>placement</td><td>tab</td><td>Размещение формы: tab - в отдельной вкладке, content - под содержимым ресурса</td></tr> |
184 | 188 | </table> |
| 189 | + |
0 commit comments