Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
Автор: <a href="https://github.com/mnoskov/contentblocks">mnoskov</a>
Автор: <a href="https://github.com/mnoskov/pagebuilder">mnoskov</a>

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

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

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

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

```php
'owner' => '@FILE contentblocks/all_fields.tpl',
'owner' => '@FILE pagebuilder/all_fields.tpl',
```

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

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

```
[[ContentBlocks? &templates=`anchors`]]
[[PageBuilder? &templates=`anchors`]]
```
##Поля

Expand Down Expand Up @@ -155,30 +157,33 @@ assets/templates/

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

Примеры конфигурации можно найти <a href="https://github.com/mnoskov/contentblocks/tree/master/assets/plugins/contentblocks/config" target="_blank">здесь</a>. (Чтобы примеры блоков стали доступны для выбора, нужно переименовать файлы *.php.sample в *.php)
Примеры конфигурации можно найти <a href="https://github.com/mnoskov/pagebuilder/tree/master/assets/plugins/pagebuilder/config" target="_blank">здесь</a>. (Чтобы примеры блоков стали доступны для выбора, нужно переименовать файлы *.php.sample в *.php)

##Сниппет ContentBlocks
##Сниппет PageBuilder

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

##Плагин ContentBlocks
##Плагин PageBuilder

Плагин отвечает за вывод формы редактирования блоков и имеет следующие параметры:
<table>
<tr><th>Имя параметра</th><th>Значение по умолчанию</th><th>Возможные значения</th></tr>
<tr><td>tabName</td><td>Content Blocks</td><td>Название вкладки на странице редактирования ресурса, в которой будет выводиться форма</td></tr>
<tr><td>tabName</td><td>Page Builder</td><td>Название вкладки на странице редактирования ресурса, в которой будет выводиться форма</td></tr>
<tr><td>addType</td><td>dropdown</td><td>Вид секции для добавления новых блоков, может иметь значения "dropdown", "icons", "images".

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

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