Quip

Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$204 per month—let's make that $500!

Learn more

Что такое Quip?¶

Quip это простой сниппет комментариев для MODX Revolution. Вы быстро добавляете комментарии на сайт: вложенные ветки, модерация, автопреобразование URL в ссылки, автозакрытие веток и другое. Полное управление комментариями доступно в бэкенде менеджера Revolution.

Требования¶

MODX Revolution 2.0.0-RC-2 или новее
PHP5 или новее

История¶

Quip написал Shaun McCormick как простой компонент комментариев. Первый релиз вышел 7 мая 2009 года.

Загрузка¶

Установите через менеджер MODX Revolution в Управлении пакетами или скачайте из репозитория MODX Extras: https://modx.com/extras/package/quip

API-документация Quip: http://api.modx.com/quip/

Использование¶

У Quip два режима: вложенные и плоские комментарии.

Плоские комментарии¶

На странице, где нужны комментарии, вызовите сниппет Quip так:

[[!Quip? &thread=`threadNameHere` &threading=`0`]]
<br />
[[!QuipReply? &thread=`threadNameHere`]]

Вложенные комментарии¶

Если включены вложенные ветки, сделайте два шага. Сначала создайте страницу «Ответ в ветке» с такими вызовами:

<h2>Reply to Thread</h2>
[[!Quip]]
<br />
[[!QuipReply]]

Свойства на этой странице задавать не нужно: данные подтянутся из исходного вызова QuipReply на основной странице ветки.

Затем добавьте свойство replyResourceId в исходный вызов Quip на странице с комментариями (например, запись блога). Для ресурса с ID 123 это выглядит так:

[[!Quip? &thread=`threadNameHere` &replyResourceId=`123`]]
<br />
[[!QuipReply? &thread=`threadNameHere`]]

Quip также даёт вспомогательный сниппет QuipCount для подсчёта комментариев в ветке или у пользователя.

Сниппеты Quip¶

В пакете четыре сниппета:

Quip: вывод комментариев ветки.
QuipReply: форма ответа в ветке.
QuipCount: число комментариев в ветке.
QuipLatestComments: последние комментарии по всем веткам, пользователю или конкретной ветке.

Системные настройки¶

Quip поставляется с рядом настроек на уровне сайта.

Name	Description
quip.emailsFrom	Адрес отправителя системных писем и писем модерации.
quip.emailsTo	Адрес получателя системных писем и писем модерации.
quip.emailsReplyTo	Адрес Reply-To. По умолчанию совпадает с emailFrom.
quip.allowedTags	HTML-теги, разрешённые в комментариях. Список допустимых значений см. на php.net/strip_tags.

Для reCaptcha есть три настройки в пространстве имён recaptcha:

Name	Description
recaptcha.public_key	Публичный ключ reCaptcha.
recaptcha.private_key	Приватный ключ reCaptcha.
recaptcha.use_ssl	При true подключение к reCaptcha идёт по SSL.

Примеры¶

Строка для записи блога на ресурсе без вложенных веток:

[[Quip? &thread=`blogpost[[*id]]` &threading=`0`]]

Комментарии для ветки post45, только для авторизованных пользователей, ресурс «Ответ в ветке» с ID 123:

[[!Quip? &thread=`post45` &replyResourceId=`123`]]
<br />
[[!QuipReply? &thread=`post45` &requireAuth=`1`]]

Комментарии для ветки spamproof123 без вложенности, с reCaptcha:

[[!Quip? &thread=`spamproof123` &threaded=`0`]]
<br />
[[!QuipReply? &thread=`spamproof123` &recaptcha=`1`]]

См. также¶