Skip to content

Commit

Permalink
Merge pull request #755 from createit-ru/master
Browse files Browse the repository at this point in the history
docs: обновление документации easyComm
  • Loading branch information
Ibochkarev authored Jan 9, 2024
2 parents 0923807 + 96e6d07 commit 42b2f11
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 13 deletions.
13 changes: 8 additions & 5 deletions docs/components/easycomm/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,13 @@ easyComm работает как с неавторизованными поль

Для корректной работы необходимо (вы должны самостоятельно установить на сайт):

- подключенные на сайте **jQuery** и плагин **[jquery.form](http://malsup.com/jquery/form/)** (не поставляется с компонентом, НЕОБХОДИМО ПОДКЛЮЧИТЬ ВРУЧНУЮ);
- установленная библиотека **pdoTools** (в чанках используется парсер Fenom, входящий в состав pdoTools);
- в чанке вывода сообщения дополнительно используется сниппет **dateAgo** для формирования «красивой» даты (но можно и без него).

::: info
Старые версии компонента (до 1.11.4-pl) требовали наличие на фронте библиотеки **jQuery** и плагина **[jquery.form](http://malsup.com/jquery/form/)**.
:::

## Пример работы

### Форма добавления сообщения
Expand All @@ -60,7 +63,7 @@ easyComm работает как с неавторизованными поль

![Написать сообщение](https://file.modx.pro/files/8/c/b/8cbe662519d913f58cf2e7fa5c9a4fd8.png)

Когда пользователь заполняет форму и отправляет ее, сообщение сохраняется в базе со статусом "не опубликовано" (кстати, есть возможность автопубликации сообщений, см. параметры сниппета). Менеджеру сайта приходит уведомление на электронную почту. Если пользователь оставил свою электронную почту, ему так же придет уведомление о том, что его сообщение получено и ожидает модерации.
Когда пользователь заполняет форму и отправляет ее, сообщение сохраняется в базе со статусом "не опубликовано" (кстати, есть возможность автопубликации сообщений, см. параметры сниппета `[[!ecForm]]`). Менеджеру сайта приходит уведомление на электронную почту. Если пользователь оставил свою электронную почту, ему так же придет уведомление о том, что его сообщение получено и ожидает модерации.

Менеджер в специальном разделе панели управления может управлять сообщениями, например опубликовать их, оставить свой ответ, удалить. При редактировании сообщения менеджер имеет возможность установить галочку "уведомить об ответе", в этом случае пользователь получит уведомление на почту о том, что его сообщение на сайте опубликовано. Возможны различные варианты действий, например: опубликовал без ответа; опубликовал и оставил ответ; не публиковал на сайте, но ответил.

Expand All @@ -79,7 +82,7 @@ easyComm работает как с неавторизованными поль

Благодаря тому, что все сообщения привязаны к цепочке, а не к ресурсу, можно на одной странице использовать несколько вызовов easyComm и создать, к примеру, 2 вкладки: "Отзывы о товаре" и "Вопросы о товаре".

Поля объекта ecThread:
**Поля объекта ecThread:**

- **resource** - id ресурса, к которому относится цепочка
- **name** - уникальное имя цепочки, например "resource-123";
Expand All @@ -93,7 +96,7 @@ easyComm работает как с неавторизованными поль
- **rating_simple** - средняя оценка, на основании всех сообщений в цепочке;
- **rating_wilson** - оценка, рассчитанная с использованием алгоритма Вильсона.

Поля объекта ecMessage:
**Поля объекта ecMessage:**

- **thread** - id цепочки;
- **subject** - тема сообщения, например вы можете создать выпадающий список со значениями "Служба поддержки", "Отдел продаж";
Expand All @@ -114,4 +117,4 @@ easyComm работает как с неавторизованными поль
- **votes_rating** - оценка голосов (рейтинг) Сообщения;
- **extended** - не используется в текущей версии.

Кроме того, у сообщения есть такие поля: `createdon, createdby, editedon, editedby, published, publishedon, publishedby, deleted, deletedon, deletedby`, назначение их ясно из названия поля.
Кроме того, у сообщения есть такие поля: `createdon`, `createdby`, `editedon`, `editedby`, `published`, `publishedon`, `publishedby`, `deleted`, `deletedon`, `deletedby`, назначение их ясно из названия поля.
2 changes: 2 additions & 0 deletions docs/components/easycomm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ items: [
- вопросы пользователей.

Кроме того, встроены пользовательские оценки, которые позволяют при создании отзывов оценить что-либо, а в дальнейшем вывести рейтинг.

Компонент работает как в MODX Revolution версии > 2.6, так и в MODX 3. В магазине дополнений находятся 2 версии установочного пакета, нужная будет скачана автоматически в зависимости от вашей версии MODX.
8 changes: 7 additions & 1 deletion docs/components/easycomm/multiple-rating-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

## Введение

**Статья актуальна для easyComm версии 1.6.0-pl и выше.**
::: tip
Статья актуальна для easyComm версии не ниже 1.6.0-pl и только для MODX версий 2.*.*.
:::

::: tip
Этот механизм НЕ реализован в версии компонента для MODX 3! Добавлять свои поля описанных способом в MODX 3 не получится!
:::

В компоненте easyComm имеется поле rating (Оценка), которое позволяет посетителям сайта проставить оценку (в виде звездочек) чего-либо. Типовой сценарий применения – отзывы о товарах или услугах.

Expand Down
4 changes: 4 additions & 0 deletions docs/components/easycomm/plugins-and-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ easyComm позволяет вам добавить дополнительные

Механизм работы идентичен таковому в miniShop2 (тот, который использовался в версии 2.2 и ранее).

::: tip
Этот механизм НЕ реализован в версии компонента для MODX 3! Добавлять свои поля описанных способом в MODX 3 не получится!
:::

Рассмотрим добавление полей **field1** и **field2**. Для этого необходимо:

1. Создать папку "myplugin" (можете задать любое имя) в 2 каталогах:
Expand Down
Loading

0 comments on commit 42b2f11

Please sign in to comment.