Skip to content

Commit 7136b9c

Browse files
authored
Merge pull request #51 from mnoskov/master
PageBuilder update
2 parents 8bfdace + e741943 commit 7136b9c

2 files changed

Lines changed: 15 additions & 10 deletions

File tree

File renamed without changes.
Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
Автор: <a href="https://github.com/mnoskov/contentblocks">mnoskov</a>
1+
Автор: <a href="https://github.com/mnoskov/pagebuilder">mnoskov</a>
22

33
Плагин позволяет разработчику определить набор блоков с определенной разметкой и списком полей, чтобы контент-менеджер использовал те блоки, которые считает нужным, со своим наполнением.
44

5-
Конфигурация для блоков берется из папки config. Для создания нового блока нужно создать в этой папке файл .php, который должен вернуть ассоциативный массив. Структура массива следующая:
5+
Конфигурация для блоков берется из папки config. Для создания нового блока нужно создать в этой папке файл `.php`, который должен вернуть ассоциативный массив. Для создания контейнера нужно создать файл `.php`, имя которго будет начинаться с `container.`. Структура массива следующая:
66

77
<table>
88
<tr><th>Ключ</th><th>Значение</th></tr>
99
<tr><td>title</td><td>Название блока, видимое менеджеру при заполнении</td></tr>
10+
<tr><td>container</td><td>Имя контейнера (если несколько - то массив имен), в котором будет выводится блок.</td></tr>
1011
<tr>
1112
<td>fields</td>
1213
<td>
@@ -22,6 +23,7 @@
2223
Если этот параметр указан, то "hide_in_docs" не принимается во внимание.
2324

2425
Если не указан ни один из параметров, ограничивающих доступ, блоки будут доступны во всех документах.</td></tr>
26+
<tr><td>order</td><td>Порядок сортировки в секции добавления блока. Этот параметр НЕ влияет на сортировку самих блоков!</td></tr>
2527
<tr>
2628
<td>templates</td>
2729
<td>
@@ -84,10 +86,10 @@
8486
Также возможна подгрузка шаблона из файла, например:
8587

8688
```php
87-
'owner' => '@FILE contentblocks/all_fields.tpl',
89+
'owner' => '@FILE pagebuilder/all_fields.tpl',
8890
```
8991

90-
В этом примере файл шаблона будем загружен из `MODX_BASE_PATH . "assets/templates/contentblocks/all_fields.tpl"`. Вообще файл ищется в следующих директориях:
92+
В этом примере файл шаблона будем загружен из `MODX_BASE_PATH . "assets/templates/pagebuilder/all_fields.tpl"`. Вообще файл ищется в следующих директориях:
9193

9294
```
9395
assets/tvs/
@@ -115,7 +117,7 @@ assets/templates/
115117
то вызов сниппета с параметром `&templates`, равным `anchors`, будет использовать для вывода шаблоны, которые определены в группе `anchors`:
116118

117119
```
118-
[[ContentBlocks? &templates=`anchors`]]
120+
[[PageBuilder? &templates=`anchors`]]
119121
```
120122
##Поля
121123

@@ -155,30 +157,33 @@ assets/templates/
155157

156158
##Примеры конфигурации
157159

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)
159161

160-
##Сниппет ContentBlocks
162+
##Сниппет PageBuilder
161163

162-
Для вывода заполненых блоков используется сниппет ContentBlocks с параметрами:
164+
Для вывода заполненых блоков используется сниппет PageBuilder с параметрами:
163165
<table>
164166
<tr><th>Имя параметра</th><th>Значение по умолчанию</th><th>Возможные значения</th></tr>
165167
<tr><td>docid</td><td>Текущий документ</td><td>Идентификатор любого существующего документа, целое число</td></tr>
168+
<tr><td>container</td><td>default</td><td>Имя контейнера</td></tr>
166169
<tr><td>blocks</td><td>*</td><td>Список блоков через запятую, без пробелов. Берется имя файла конфигурации без расширения (Например, 'all_fields,groups'). Если указать '*', фильтрация по имени произведена не будет</td></tr>
170+
<tr><td>wrapTpl</td><td>[+wrap+]</td><td>Имя чанка, содержащего шаблон-обертку для списка блоков выводимого контейнера</td></tr>
167171
<tr><td>templates</td><td></td><td>Идентификатор группы шаблонов, которые будут использоваться для вывода. Должен быть определен в конфигурации каждого выводимого блока</td></tr>
168172
<tr><td>offset</td><td>0</td><td>Число пропускаемых блоков с начала вывода</td></tr>
169173
<tr><td>limit</td><td>0</td><td>Число блоков для вывода, либо 0 - для вывода всех</td></tr>
170174
</table>
171175

172-
##Плагин ContentBlocks
176+
##Плагин PageBuilder
173177

174178
Плагин отвечает за вывод формы редактирования блоков и имеет следующие параметры:
175179
<table>
176180
<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>
178182
<tr><td>addType</td><td>dropdown</td><td>Вид секции для добавления новых блоков, может иметь значения "dropdown", "icons", "images".
179183

180184
Для значения "icons" в конфигурации каждого блока должен быть определен ключ "icon", содержащий класс иконки.
181185

182186
Для значения "images" должен быть определен ключ "image", с адресом изображения (макс. 80х60)</td></tr>
183187
<tr><td>placement</td><td>tab</td><td>Размещение формы: tab - в отдельной вкладке, content - под содержимым ресурса</td></tr>
184188
</table>
189+

0 commit comments

Comments
 (0)