Merge pull request #868 from rpadesign/master

Create rescomments.md

Author: Ibochkarev

docs/components/rescomments.md

@@ -0,0 +1,118 @@
+---
+title: reComments
+description: Многоуровневые комментарии с пагинацией для MODX3
+logo: https://file.modx.pro/files/a/9/4/a9499643bf99f8080a37405836d0a504.png
+author: Romanov Pavel
+modstore: https://modstore.pro/packages/utilities/rescomments
+---
+
+# resComments
+Многоуровневые комментарии с пагинацией для ресурсов MODX3.
+
+## Основные свойства
+- Неограниченная вложенность
+- Несколько вызовов на странице
+- Оценка публикации ("звездный" рейтинг)
+- Оценки и рейтинг ответов
+- WYSIWYG-редактор [Pell](https://github.com/jaredreich/pell)
+- Разметка Schema.org
+- Возможность удаления собственных комментариев
+- Email-уведомления менеджеру сайта, автору публикации, автору комментария об ответах
+- Пагинация (с pdoPage)
+- Работает без jQuery (за исключением связки с pdoPage)
+- Настраиваемые всплывающие уведомления
+- Приложение в админке с поиском, фильтрацией и возможностью создания / удаления / редактирования (включая ответы разных уровней) 
+- Вкладка "Комментарии" у ресурсов с указанными шаблонами
+- Вкладка "Комментарии" у ресурсов с указанными ID
+
+## Системные настройки
+| Параметр | Описание | Значение по умолчанию |
+| :----- | :----- |:------ |
+| **rc_antispam_field**	| Поле для защиты от СПАМа (проверяется на пустоту) | comment_subject |
+| **rc_autopublish** | Автопубликация без модерации	| 1 |
+| **rc_notifications**	| Скрипт для всплывающих уведомлений.<br>Поддерживаются [Notyf](https://github.com/caroso1222/notyf) и [SweetAlert2](https://modstore.pro/packages/alerts-mailing/sweetalert2) (требуется установка).  Также можно указать miniShop3, FetchIt или AjaxForm для использования уведомлений этих компонентов (если они установлены).	| Notyf |
+| **rc_js_url**	| Путь к JS-файлу от корня сайта. |`{assets_url}components/rescomments/js/web/default.min.js` |
+| **rc_css_url** | Путь к JS-файлу от корня сайта. | `{assets_url}components/rescomments/css/web/default.min.css` |
+| **rc_tab_tpl** | У каких шаблонов выводить вкладку "Комментарии", ID через запятую.<br>Поставьте `all`, чтобы вкладка выводилась для всех шаблонов, оставьте пустым, чтобы не выводить. | |
+| **rc_tab_resources**	| У каких ресурсов выводить вкладку "Комментарии", ID через запятую. | |	
+| **rc_email_send_createdby**	| Уведомлять ли создателя ресурса о новых комментариях (определяется по createdby). | Нет |
+| **rc_email_send_manager**	| Уведомлять ли менеджеров о новых комментариях. | Да |
+| **rc_email_send_user** | Уведомлять ли пользователей об ответах на их комментарии. | Да |
+| **rc_email_subject_createdby** | Тема письма автору о новом комментарии к его ресурсу | Новый комментарий к вашей публикации |
+| **rc_email_subject_manager** | Тема письма менеджерам о новом комментарии | Новый комментарий |
+| **rc_email_subject_user** |Тема письма пользователю о новом ответе на его комментарий. | Ответ на ваш комментарий |
+| **rc_email_tpl_createdby** | Чанк-шаблон письма автору публикации. | `rc_tpl_email_author` |
+| **rc_email_tpl_manager** | Чанк-шаблон письма менеджерам | `rc_tpl_email_manager`|
+| **rc_email_tpl_user** | Чанк-шаблон письма пользователю | `rc_tpl_email_user`|
+
+## Сниппет resComments
+Выводит комментарии к ресурсу, подключает все необходимые скрипты и стили.
+Вызывается некешированным:
+```
+[[!resComments]]
+```
+На Fenom:
+```
+{'!resComments' | snippet : []}
+```
+
+С **pdoPage**:
+```
+<div id="pdopage">
+    <div class="rows">
+        [[!pdoPage?
+            &element=`resComments`
+        ]]
+    </div>
+    [[!+page.nav]]
+</div>
+```
+
+Параметры сниппета (перекрывают системные настройки)
+| Параметр | Описание | Значение по умолчанию | 
+| :----- | :----- | :----- | 
+| **docid** | ID ресурса. | 	Текущий | 
+| **topic** | Тема (ветка). Должна быть уникальна в рамках сайта. | comments-## (## - ID ресурса) | 
+| **allowAll** | Все посетители могут добавлять комментарии (0 - только авторизованные).| 1 | 
+| **maxLevel** | Максимальный уровень вложенности комментариев. | 50 | 
+| **maxShiftLevel** | Максимальный уровень, после которого не будет происходить визуальный сдвиг ответов. | 10 | 
+| **title** | Заголовок блока комментариев. | `[[%rescomments_block_title]]` | 
+| **addText** | Текст на кнопке добавления комментария. | `[[%rescomments_add]]` | 
+| **replyText** | Текст на кнопке ответа на комментарий. | `[[%rescomments_reply]]` | 
+| **required | Обязательные поля для отправки формы. | `name, email, text, agree` | 
+| **autopublish** | Публиковать ли комментарии и ответы сразу после добавления | 1 | 
+| **antispamField** | Поле для защиты от СПАМа. | `comment_subject` | 
+| **deleteTime** | Время в секундах, в течение которого пользователь может удалить свой комментарий (если на него не получен ответ). | 	600 | 
+| **hideReplies** | Скрывать ответы на комментарии при открытии страницы.<br>Выводятся только комментарии первого уровня. Если есть ответы, выводится их количество и кнопка "Развернуть". | 0 | 
+| **sortby** | Сортировка в JSON-формате. | `{"createdon":"DESC"}` | 
+| **limit** | Количество на страницу. | 10 | 
+| **offset** | Сдвиг от начала. | 0 | 
+| &nbsp; |  |  | 
+| **Шаблоны** |  |  | 
+| **tpl** | Чанк-шаблон комментария. | `rc_tpl_comment` | 
+| **tplWrapper** | Чанк-шаблон обертки всех комментариев. | `rc_tpl_wrapper` | 
+| **tplForm** | Чанк-шаблон формы добавления комментария. | `rc_tpl_form` | 
+| **tplDelete** | Чанк-шаблон кнопки удаления комментария. | `rc_tpl_delete` | 
+| **tplRepliesInfo** | Чанк-шаблон вывода блока количества ответов на комментарий и кнопки «Развернуть». | `rc_tpl_replies_info` | 
+| &nbsp; |  |  | 
+| **Уведомления** |  |  | 
+| **emailTo** |	адреса менеджеров | `[[++emailsender]]` | 
+| **emailFrom** | отправитель уведомлений | `[[++site_name]]` | 
+| **emailManager** | Уведомлять ли менеджеров о новых комментариях. | 1 | 
+| **emailAuthor** |	Уведомлять ли авторов публикаций о новых комментариях. | 1 | 
+| **emailUser** |	Тема ли авторов комментариев об ответах на их комментарии. | 0 | 
+| **emailSubjectAuthor** | Тема письма автору о новом комментарии к его ресурсу. | Новый комментарий к вашей публикации | 
+| **emailSubjectManager** | Тема письма менеджерам о новом комментарии. | Новый комментарий | 
+| **emailSubjectUser** | Тема письма пользователю о новом ответе на его комментарий. | Ответ на ваш комментарий | 
+| **emailTplAuthor** | Чанк-шаблон письма автору публикации. | `rc_tpl_email_author` | 
+| **emailTplManager** | Чанк-шаблон письма менеджерам. | `rc_tpl_email_manager` | 
+| **emailTplUser** | Чанк-шаблон письма пользователю. | `rc_tpl_email_user` | 
+
+В чанках поддерживается стандартный синтаксис и Fenom.  
+Шаблоны, идущие в комплекте, адаптированы под Bootstrap.
+
+## События плагинов
+| Событие | Описание |
+|---------|----------|
+| **rcOnBeforeCreateComment** | Вызывается перед созданием комментария.<br>Принимает массив `$data` с данными, отправленными из формы.<br>Можно обработать и вернуть через `$modx->event->returnedValues = $data;` | 
+| **rcOnAfterCreateComment** | Вызывается после создания комментария. Принимает `$object` — объект созданного комментария. |