Jot
MODX Wiki
Перейти

Сниппет Jot дает возможность пользователям вашего сайта оставлять комментарии.

Установка

Первичная установка

Данный сниппет уже входит в комплект MODX Evolution, прежде чем устанавливать, убедитесь в том, что сниппет еще не установлен.

1. Скачайте и распакуйте архив.
2. Создайте папку «jot» в папке  assets/snippets/
3. Перенесите файлы из скаченного архива в папку jot
4. Создайте новый сниппет Jot и поместите в код сниппета содержимое файла jot.snippet.txt

Обновление

1. Скачайте последнюю версию сниппета
2. Сделайте Backup и удалите содержимое папки assets/snippets/jot
3. Скопируйте в эту папку файлы из скаченного архива
4. Обновите код сниппета Jot в административной панели MODX, поместив в него содержимое файла jot.snippet.txt

Параметры

Основные параметры

Формат: default | count-comments | count-subscriptions | comments | form
Значение по умолчанию: default
Примечание:
default - форма и коментарии
count-comments - счетчик-коментариев
count-subscriptions - счетчик-подписок
comments - комментарии
form - форма
Пример:
&action=`count-comments`
Формат: ID документа
Значение по умолчанию: родительский документ
Примечание:
Пример:
&docid=`23`
Формат: строка [A-Za-z0-9]
Значение по умолчанию:
Примечание:
Пример:
&tagid=`tag`
Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
0 - отключить возможность оповещения по эл.почте
1 - включить возможность оповещения по эл.почте.
Пример:
&subscribe=`1`
Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
Модератор может просматривать комментарии до публикации
0 - новые комментарии будут опубликованы
1 - новые комментарии будут не опубликованы
Пример:
&moderated=`1`
Формат: 0 | 1 | 2
Значение по умолчанию: 1
Примечание:
Веб-группы модераторов указываются в параметре canmoderate
0 = без оповещений
1 = оповещать о новых не опубликованных комментариях
2 = оповещать о всех новых комментариях
Пример:
&notify=`2`
Формат: строка
Значение по умолчанию: нет
Примечание:
Пример:
&subjectSubscribe=``
Формат: строка
Значение по умолчанию: нет
Примечание:
Пример:
&subjectModerate=``
Формат: 0 | 1 | 2
Значение по умолчанию: 0
Примечание:
0 = отключение
1 = включение
2 = включение, но только для незарегистрированных и не авторизованных пользователей
Пример:
&captcha=`2`
Формат: список фраз | имя чанка
Значение по умолчанию: нет
Примечание: Список фраз через запятую или имя чанка со списком фраз. Используется в сочетании с параметром bw
Пример:
&badwords=`{{MyBadwordsChunk}}`
Формат: 0 | 1 | 2
Значение по умолчанию: 1
Примечание:
0 - опубликовывает
1 - не опубликовывает
2 - отклоняет комментарий. В особых случаях сообщение теряется навсегда
Пример:
&bw=`2`
Формат: дополнительные поля, через запятую
Значение по умолчанию: name,email
Примечание: Поля будут созданы в дополнительной таблице автоматически. Стандартное значение "name,email". (Примечание: В списке, через запятую, не должно быть пробелов)
Пример:
&customfields=``
Формат: ID автора
Значение по умолчанию: автор комментария
Примечание: По-умолчанию автор комментария.
Пример:
&authorid=``
Формат:
Значение по умолчанию: longtitle
Примечание: Используется для темы комментария, когда в форме поле заголовка оставлено пустым.
Пример:
&title=``
Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
0 - не включать <link rel="stylesheet" src="assets/snippets/jot/templates/jot.css" /> в заголовок шаблона, в тег <HEAD></HEAD>
1 - включить <link rel="stylesheet" src="assets/snippets/jot/templates/jot.css" /> в заголовок шаблона
Пример:
&css=`0`
Формат: путь к файлу
Значение по умолчанию: assets/snippets/jot/templates/jot.css
Примечание:
Пример:
&cssFile=``
Формат: список критериев через запятую
Значение по умолчанию: createdon:d
Примечание:
имя поля:a - по возрастанию
имя поля:d - по убыванию
Пример:
&sortby=``
Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
0 - первый комментарий внизу
1 - первый комментарий вверху.
Пример:
&numdir=`0`
Формат:
Значение по умолчанию: content:You forgot to enter a comment.
Примечание:
Синтаксис: fieldname:message(:validation)
Если поле добавлено в validate то оно становится обезательным для заполнения. Возможные значения:
number
email
регулярное выражение
Примеры.
Обязательное поле:
MyRequiredField:Поле обязательно должно быть заполнено!
Проверка электронной почты:
MyEmailField:Адрес электронной почты внесён вами не правильно.:email
Проверка на числовое значение:
MyNumberField:Номер дома должен быть в цифровом значении.:number
Комбинация требований:
MyRequiredField:Поле обязательно должно быть заполнено!,MyEmailField:Адрес электронной почты внесён вами не правильно.:email,MyNumberField:Номер дома должен быть в цифровом значении.:number
Пример:
&validate=`MyRequiredField:Поле обязательно должно быть заполнено!,MyEmailField:Адрес электронной почты внесён вами не правильно.:email,MyNumberField:Номер дома должен быть в цифровом значении.:number`
Формат: строка
Значение по умолчанию: anonymous
Примечание:
Пример:
&guestname=`Гость`
Формат: секунды, как целое число
Значение по умолчанию: 15
Примечание:
Пример:
&postdelay=`10`
Формат: число
Значение по умолчанию: 0
Примечание:
0 - отключение, показывать все комментарии на одной странице (стандартное значение)
1 > любое числовое значение
Пример:
&pagination=`10`
Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
0 - никаких плейсхолдеров не создано (по-умолчанию)
1 - плейсхолдеры созданы для каждого значения debug (смотрите параметр debug)
если tagid не найден, плесхолдеры создаются так:
[+jot.html.form+]
если tagid найден, плейсхолдеры будут созданы так:
[+jot.html.form.tagid+]
Пример:
&placeholders=`1`
Формат: 1 | 0
Значение по умолчанию: 1
Примечание:
0 - спрятать результаты (может использоваться с параметром placeholder)
1 - показать результаты (по-умолчанию)
Пример:
&output=`0`
Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
0 - отключить вывод "скрытых" переменных. (По умолчанию)
1 - включить вывод "скрытых" переменных.
Пример:
&debug=`1`
Формат: список групп пользователей
Значение по умолчанию:
Примечание: Коммментарии пользователей из этих групп будут публиковаться по умолчанию, когда moderated установлен 1. Параметр badwords не применяется к этим группам.
Пример:
&trusted=``
Формат: список групп пользователей
Значение по умолчанию:
Примечание: Оставьте пустым, для публичного комментирования
Пример:
&canpost=``
Формат: список групп пользователей
Значение по умолчанию:
Примечание: Оставьте пустым для публичного просмотра.
Пример:
&canview=``
Формат: список групп пользователей
Значение по умолчанию:
Примечание: Оставьте пустым для того чтоб пользователи не могли редактировать комментарии.
Пример:
&canedit=``
Формат: список групп пользователей
Значение по умолчанию:
Примечание:
Пример:
&canmoderate=``
Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
Пример:
&notifyAuthor=`1`
Формат: строка
Значение по умолчанию:
Примечание:
Пример:
&subjectAuthor=``

Шаблоны

Формат: имя чанка
Значение по умолчанию: chunk.form.inc.html
Примечание:
Пример:
&tplForm=``
Формат: имя чанка
Значение по умолчанию: chunk.comment.inc.html
Примечание: Повторяется для каждого комментария на странице
Пример:
&tplComments=``
Формат: имя чанка
Значение по умолчанию: chunk.moderate.inc.html
Примечание: Этот шаблон используется один раз над комментариями
Пример:
&tplModerate=``
Формат: имя чанка
Значение по умолчанию: chunk.navigation.inc.html
Примечание: Этот шаблон применяется в верхней и частях блока
Пример:
&tplNav=``
Формат: имя чанка
Значение по умолчанию: chunk.subscribe.inc.html
Примечание:
Пример:
&tplSubscribe=``
Формат: имя чанка
Значение по умолчанию: chunk.notify.inc.txt
Примечание:
Пример:
&tplNotify=``
Формат: имя чанка
Значение по умолчанию: chunk.notify.moderator.inc.txt
Примечание:
Пример:
&tplNotifyModerator=``
Формат: имя чанка
Значение по умолчанию: chunk.notify.author.inc.txt
Примечание:
Пример:
&tplNotifyAuthor=``
Формат:
Значение по умолчанию:
Примечание:
Пример:
&cssRowAlt=``
Формат:
Значение по умолчанию:
Примечание:
Пример:
&cssRowMe=``
Формат:
Значение по умолчанию:
Примечание:
Пример:
&cssRowAuthor=``

Примеры

Простой вызов

  • с оповещением на эл.почту.
  • с постраничной навигацией: 10 комментариев на странице.
[!Jot? &subscribe=`1` &pagination=`10`!]

С альтернативной сортировкой

  • с оповещением на эл.почту.
  • с постраничной навигацией: 10 комментариев на странице.
  • комментарии сортируются начиная с самого старого.
[!Jot? &subscribe=`1` &pagination=`10` &sortby=`createdon:a`!]

Модерация

  • с оповещением на эл.почту.
  • с постраничной навигацией: 10 комментариев на странице.
  • новые комментарии не публикуются, их опубликовывает модератор.
  • автору не будут приходить уведомления. Вы должны создать веб-группу с веб-пользователями, которые бы выступали в качестве модераторов.
  • Но автор будет получать уведомления
    • если используется Jot 1.1.3+
    • менеджером является автор комментария
    • вы добавите &notifyAuthor=`1`
[!Jot? &subscribe=`1` &pagination=`10` &moderated=`1`!]

Расширенная модерация

  • с оповещением на эл.почту.
  • с постраничной навигацией: 10 комментариев на странице.
  • новые комментарии не публикуются, их опубликовывает модератор.
  • новые комментарии будут опубликованы лишь в том случае, если автор входит в состав группы "Доверенные Пользователи".
[!Jot? &subscribe=`1` &pagination=`10` &moderated=`1` &trusted=`Доверенные Пользователи`!]

Анти-спам: автоматический

  • с постраничной навигацией: 10 комментариев на странице.
  • с предоставлением динамически меняющейся картинкой с кодом (captcha).
  • если в чёрный список слов входит слово, используемое в комментарии, комментарий будет отклонён, возможно, что даже потерян.
  • чёрным списком фраз является чанк "myBadwordList"
[!Jot? &pagination=`10` &captcha=`1` &badwords=`{{myBadwordList}}` &bw=`2`!]

Анти-спам: с модерацией

  • с постраничной навигацией: 10 комментариев на странице.
  • с предоставлением динамически меняющейся картинкой с кодом (captcha).
  • если в чёрный список слов входит слово, используемое в комментарии, комментарий не будет опубликован, и модератор при этом будет оповещён.
  • веб-пользователи из группы "Модераторы комментариев" могут редактировать комментарии.
  • чёрным списком фраз является чанк "myBadwordList".
[!Jot? &pagination=`10` &captcha=`1` &canmoderate=`Модераторы комментариев` &badwords=`{{myBadwordList}}` &bw=`1`!]

Расположение блоков

Для того, чтобы изменить на странице место и порядок вывода блоков (форма, модерация, комментарии, навигация), поместите вызов сниппета, как обычно:

[!Jot? &placeholders=`1` &output=`0` &pagination=`10` &captcha=`1` &canmoderate=`Jot Moderators` &badwords=`{{myBadwordList}}` &bw=`1`!]

Обратите внимание, следующие параметры вы должны указать обязательно:

&placeholders=`1` &output=`0`

Теперь, разместите на странице с вызовом сниппета Jot следующие плейсхолдеры:

[+jot.html.navigation+] - Первый. Место на странице для навигации
[+jot.html.comments+] - Второй. Место на странице для комментариев
[+jot.html.moderate+] - Третий. Место на странице для модерации
[+jot.html.form+] - Четвертый. Место на странице для формы

Вы можете изменить порядок блоков так, как считаете нужным:

[+jot.html.form+] - Первый. Место на странице для формы
[+jot.html.comments+] - Второй. Место на странице для комментариев
[+jot.html.moderate+] - Третий. Место на странице для модерации
[+jot.html.navigation+] - Четвертый. Место на странице для навигации

Поделитесь ссылкой

Статистика

Яндекс цитирования
© 2011 - 2016 Школа MODX