Merge pull request #334 from webnitros/master

Исправление документации
modx-pro · Jul 16, 2018 · c8f770b · c8f770b
2 parents f0836cb + ce24ce7
commit c8f770b
Showing 1 changed file with 130 additions and 74 deletions.
diff --git a/ru/01_Компоненты/54_userMarker.md b/ru/01_Компоненты/54_userMarker.md
@@ -1,19 +1,17 @@
 Платный компонент предназначен для добавления меток к ресурсам.
-[Купить ][1]
 
-Демо-версия [http://usermarker.bustep.ru/demo.html][1]
+* Демо-версия [http://usermarker.bustep.ru/demo.html][1]
+* Видео с демонстрацией [https://www.youtube.com/watch?v=0nksuTp1spQ][1]
+* [Купить ][1]
 
-Видео с демонстрацией [https://www.youtube.com/watch?v=0nksuTp1spQ][1]
-
-### Основные особенности:
+## Основные особенности:
 
 * Можно назначать метки не только ресурсам но и другим любым объектам. Для этого нужно задавать свой classKey для кнопки
 * Так же учитывается контекст откуда был добавлен ресурс (можно отключить)
-* Возможность вывода отмеченых ресурсов пользователя через сниппет ***[[!userMarker.Ids? &label=`Проверен`]]*** с указанием нужной метки(вернет список id ресурсов)
+* Возможность вывода отмеченых ресурсов пользователя через сниппет ***[[!userMarker.Resource? &label=`Проверен`]]*** с указанием нужной метки
 * Управление созданными метками через личный кабинет
 * Управление правами приложения. Возможность назначить права управления метками только определенным группа и контектам. Шаблон политики доступа **userMarker**
 
-
 ## Быстрый старт
 
 
@@ -24,99 +22,67 @@
 [[!userMarker.Initialize]]
 ```
 
-
 #### Список меток. 
-Вставляем сниппет с нашими метками и кнопкой добавить метку
+Вставляем сниппет с метками и кнопкой добавить метку
 
 ```
 [[!userMarker.Label]]
 ```
 
 
-#### Чанк ресурса. 
-вставить  ```[[!userMarker.Record? &resource_id=`[[+id]]`]]``` 
-
+#### Чанк для ресурса. 
+пример **tpl.userMarker.resource.row**
 ```
 <h3>[[+pagetitle]]</h3>
 [[!userMarker.Record? &resource_id=`[[+id]]`]]
 ```
 
 #### Вывод списка ресурсов. 
 
-В resources вставляем сниппет userMarker.Ids.
+Добавить на страницу для вывода отмеченых ресурсов
+
 ```
-[[!pdoResources?
-    &resources=`[[!userMarker.Ids]]`
-    &parents=`3`
-    &tpl=`myTPL`
+[[!pdoPage?
+    &element=`userMarker.Resource`
 ]]
+[[!+page.nav]]
 ```
 
-#### Управление метками
-Вставить на страницу для авторизованного пользователя.
+Или с помощью pdoResources
+
 ```
-[[!userMarker?
-     &tpl=`tpl.userMarker.manager.row`
-     &tplOuter=`tpl.userMarker.manager.outer`
+[[!pdoResources?
+    &tpl=`tpl.userMarker.resource.row`
+    &innerJoin=`{
+            "Marker": {
+                    "class": "userMarkerResource",
+                    "on": "modResource.id=Marker.resource_id"
+            }
+    }`
 ]]
 ```
 
+Вывод списка ресурсов с указанием метки
 
-### Параметры настроек
-
-Параметр	|	По умолчанию				|	Название |	Описание
-------------|-------------------------------|------------|-----------------------------------------------------
-**meta_context**		| 	Да     			| Регистрировать мета тег context | "Да" - то в head добавится мета тег <meta name="page-context" content="web">
-**frontend_css**		| 		[[+cssUrl]]web/default.css     			| Стили фронтенда | Путь к файлу со стилями. Если вы хотите использовать собственные стилями - укажите путь к ним здесь, или очистите параметр и загрузите их вручную через шаблон сайта.
-**frontend_js**		| [[+jsUrl]]web/default.js     			| Скрипты фронтенда | Путь к файлу со скриптами. Если вы хотите использовать собственные скрипты - укажите путь к ним здесь, или очистите параметр и загрузите их вручную через шаблон сайта.
-**frontend_jgrowl_css**		| 	[[+cssUrl]]web/lib/jquery.jgrowl.min.css | Стили фронтенда jgrowl|
-**frontend_jgrowl_js**		| 	[[+jsUrl]]web/lib/jquery.jgrowl.min.js | Скрипты фронтенда jgrowl|
-**regular_expression**		| 	/[^a-Zа-Я0-9-.]+/is| Регулярное выражение для проверки наименования метки|  дает вводить буквы,циры, дифисы и точки
-**framework_bootstrap_css** | [[+framework]]bootstrap3/css/default.min.css | Стили фронтенда bootstrap | Оставить пустым если не хотите подключать дополнительные стили.
-**framework_bootstrap_js**  | [[+framework]]bootstrap3/js/default.js | Скрипты фронтенда bootstrap | Оставить пустым если не хотите подключать дополнительные скрипты.
-**resource_markers**           | пусто | id страницы с результатми выборки отмеченых ресурсов| жите id ресурса куда будет перенаправть пользователя после выбора метки. По умолчанию на текущую страницу
-
-
-### Параметры userMarker.Initialize
-
-Параметр	|	По умолчанию				|	Описание
-------------|-------------------------------|-----------------------------------------------------
-**selector**		| userMarker     			| Селектор кнопки добавить метку
-
-
-
-### Параметры userMarker.Label
-
-Параметр	|	По умолчанию				|	Описание
-------------|-------------------------------|-----------------------------------------------------
-**defaultLabel**		| all     			| Метка для выборки ресурсов по умолчанию
-**resource_markers**		| текуща страница    			| id страницы с результатами выборки отмеченных ресурсо
-**tpl**		| 	tpl.userMarker.row    			| Чанк для вывода записи
-**tplOuter**		| 	tpl.userMarker.outer    | Чанк для вывода обертки
-**user**		| 	true    | Показывать метки только те что создал пользователь.
-
-
-
-### Параметры userMarker.Ids
-
-Параметр	|	По умолчанию				|	Описание
-------------|-------------------------------|-----------------------------------------------------
-**classKey**		| 	modResource     			| classKey ресурса выборки ресурсов
-**label**		| 	пусто     			| Название метки для выборки ресурсов пользователя. По умолчанию all, вернет все ресурсы авторизованного пользователя
-**user**		| 	true    | Показывать метки только те что создал пользователь.
-**user_id**		| 	$modx->user->id    | Индитификатор пользователя для вывода меток
+```
+[[!pdoPage?
+    &label=`Имя метки`
+    &element=`userMarker.Resource`
+]]
+[[!+page.nav]]
+```
 
 
 
-### Параметры userMarker.Record
+#### Управление метками
+Вставить на страницу для авторизованного пользователя.
+```
+[[!userMarker.label?
+     &tpl=`tpl.userMarker.manager.row`
+     &tplOuter=`tpl.userMarker.manager.outer`
+]]
+```
 
-Параметр	|	По умолчанию				|	Описание
-------------|-------------------------------|-----------------------------------------------------
-**resource_id**		| 	пусто     			| id ресурса для добавления метки
-**classKey**		| 	modResource     	| classKey ресурса для добавления метки
-**context_key**		| 	web     			| Контекст ресурса для добавления метки
-**selector**		| 	userMarker     		| Селектор кнопки добавить метку
-**tpl**		        | 	tpl.userMarker.row    			| Чанк для вывода записи
 
 
 ### Переназначения js для модельного окна
@@ -147,4 +113,94 @@
 
 ```
 
-[1]: https://modstore.pro/packages/ecommerce/usermarker
+[1]: https://modstore.pro/packages/ecommerce/usermarker
+
+
+
+### Сниппеты
+
+#### Параметры userMarker.Initialize
+
+для подключение скрипто и стилей
+
+Параметр	|	По умолчанию				|	Описание
+------------|-------------------------------|-----------------------------------------------------
+**selector**		| 	userMarker     			| Селектор для кнопки добавить метку
+
+#### Параметры userMarker.Label
+
+userMarker snippet для вывода блока с метками
+
+Параметр	|	По умолчанию				|	Описание
+------------|-------------------------------|-----------------------------------------------------
+**tplOuter**		| 	tpl.userMarker.outer     			| Обёртка для вывода результатов работы сниппета.
+**tpl**		| 	tpl.userMarker.row     			| Чанк оформления для каждого результата
+**resource_markers**		| 	     			| id страницы с результатами выборки отмеченных ресурсов
+**defaultLabel**		| 	all     			| Метка для выборки ресурсов по умолчанию
+**user**		| 	1     			| Показывать метки только те что создал пользователь.
+
+#### Параметры userMarker.Resource
+
+snippet вернет список ресурсов пользователя с метками
+
+Параметр	|	По умолчанию				|	Описание
+------------|-------------------------------|-----------------------------------------------------
+**label**		| 	     			| Название метки для выборки ресурсов пользователя. По умолчанию all, вернет все ресурсы авторизованного пользователя
+**class**		| 	modResource     			| Имя класса для выборки. По умолчанию, "modResource".
+**user_id**		| 	     			| Индитификатор пользователя для вывода меток
+**tpl**		| 	tpl.userMarker.resource.row     			| Чанк оформления для каждого результата
+**tplOuter**		| 	@INLINE [[+output]]     			| Обёртка для вывода результатов работы сниппета.
+**limit**		| 	10     			| Лимит выборки результатов
+**offset**		| 	0     			| Пропуск результатов с начала выборки
+**sortby**		| 	id     			| Сортировка выборки. Для сортировки по полям метки нужно добавить префикс "Resource.", например: "&sortby=`Marker.label_id`"
+**sortdir**		| 	ASC     			| Направление сортировки
+**toPlaceholder**		| 	     			| Если не пусто, сниппет сохранит все данные в плейсхолдер с этим именем, вместо вывода не экран.
+**toSeparatePlaceholders**		| 	     			| Если вы укажете слово в этом параметре, то ВСЕ результаты будут выставлены в разные плейсхолдеры, начинающиеся с этого слова и заканчивающиеся порядковым номером строки, от нуля. Например, указав в параметре "myPl", вы получите плейсхолдеры [[+myPl0]], [[+myPl1]] и т.д.
+**showLog**		| 	     			| Показывать дополнительную информацию о работе сниппета. Только для авторизованных в контексте "mgr".
+**parents**		| 	     			| Список категорий, через запятую, для поиска результатов. По умолчанию выборка ограничена текущим родителем. Если поставить 0 - выборка не ограничивается.
+**resources**		| 	     			| Список товаров, через запятую, для вывода в результатах. Если id товара начинается с минуса, этот товар исключается из выборки.
+**includeContent**		| 	     			| Выбирать поле "content" у товаров.
+**where**		| 	     			| Строка, закодированная в JSON, с дополнительными условиями выборки.
+**outputSeparator**		| | Необязательная строка для разделения результатов работы.
+**returnIds**		| 	     			| Возвращать строку с id товаров, вместо оформленных чанков.
+**showUnpublished**		| 	     			| Показывать неопубликованные товары.
+**showDeleted**		| 	     			| Показывать удалённые товары.
+**showHidden**		| 	1     			| Показывать товары, скрытые в меню.
+**outerIfEmpty**		| 	1     			| Включает вывод чанка-обертки (tplOuter) даже если результатов нет.
+
+#### Параметры userMarker.Record
+
+snippet для вывода кнопки добавить метку ресурсу
+
+Параметр	|	По умолчанию				|	Описание
+------------|-------------------------------|-----------------------------------------------------
+**selector**		| 	userMarker     			| Селектор для кнопки добавить метку
+**tpl**		| 	tpl.userMarker.record     			| Чанк оформления для каждого результата
+**classKey**		| 	modResource     			| classKey ресурса для добавления записи
+**context_key**		| 	web     			| Контекст ресурса. По умолчанию web
+**resource_id**		| 	     			| id ресурса для добавления метки
+
+#### Параметры userMarker.Colors
+
+snippet для вывода цветов в форме
+
+Параметр	|	По умолчанию				|	Описание
+------------|-------------------------------|-----------------------------------------------------
+**label_id**		| 	     			| ID метки для выборки. Используется когда отсутствует имя метки
+**tpl**		| 	tpl.userMarker.color     			| Чанк оформления для каждого результата
+
+
+
+### Системные настройки
+
+Настройка	|	Описание
+------------|-------------------------------
+**frontend_jgrowl_js** | Скрипты фронтенда jgrowl
+**frontend_jgrowl_css** | Стили фронтенда jgrowl
+**frontend_css** | Стили фронтенда
+**frontend_js** | Скрипты фронтенда
+**meta_context** | Регистрировать мета тег context
+**regular_expression** | Регулярное выражение для проверки наименования метки
+**framework** | Подключить framework
+**framework_modal** | Стили модельного окна
+**resource_markers** | id страницы с результатми выборки отмеченых ресурсов