Документация

Параметры компонента

Параметры компонента по-умолчанию настроены так, что для запуска обсуждения достаточно просто разместить компонент на странице.

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

Группа обсуждений — привязка обсуждения к группе обсуждений (в рамках административного раздела — запись в хайлоадблоке групп обсуждений).

Список ключей запроса, подлежащих чистке. Это список ключей, которые дополнят глобальный список GET-ключей из настроек модуля. Подробнее про чистку урлов для обсуждения можно почитать здесь.

Задать адрес вручную — данным параметром можно задать принудительный адрес страницы, который используется компонентом вместо реального адреса страницы. Следуя логике привязки обсуждения к адресу страницы, где бы ни был размещён данный компонент, он будет отображать одно и то же обсуждение, основываясь на заданную ему «якорную страницу». Данное свойство позволяет запускать сквозные обсуждения в разделах или по всему сайту. Например, сквозной чат.

Индивидуальные модераторы обсуждения — конкретные пользователи, которым разрешён доступ к управлению комментариями. Данная возможность включена в модуль комментариев для того, чтобы можно было давать обычным пользователям (не администраторам) возможность модерировать, например:

• обсуждение на страницах личных блогов;
• в авторских статьях;
• в блокнотах пользователей.

Одновременно можно указать неограниченное количество пользователей. Если планируется передавать в параметры компонента не конкретное число, а значение переменной — указатель на неё рекомендуется прописывать не через механизм редактирования компонента, а вручную, через редактирование файла. Использовать ключи параметров: USERS_ADD_MOD, USERS_ADD_LIMIT_MOD, которым должен быть указан массив переменных. Правильные варианты использования переменных в параметрах персональных модераторов:

Бренд-менеджеры обсуждения. Бренд-менеджер — пользователь, на которого не распространяется параметр «Максимально допустимая глубина комментирования», но который не может модерировать сообщения (не является модератором). В параметрах компонента указываются коды (id) пользователей, которые являются бренд-менеджерами обсуждения. На примере отзывов магазину: обычным пользователям устанавливаем максимально допустимую глубину комментирования равную единице, бренд-менеджеры же могут комментировать на любой глубине. Таким образом клиенты могут оставлять отзыв магазину, бренд-менеджеры могут им ответить, но оставивший отзыв не может вступать в полемику.

«Кто может комментировать» — параметр, указывающий группы пользователей, которым разрешено принимать участие в обсуждении. Если не выбрана ни одна группа, подразумевается, что комментировать могут все. Дополнительно, для более гибкой настройки доступов, предусмотрен параметр «Премодерировать сообщения от...», которым указываются группы пользователей, сообщения от которых отправляются на премодерацию. Это позволяет, к примеру, разделить комментарии неавторизованных пользователей от комментариев авторизованных пользователей. Первые отправляются на премодерацию, вторые — публикуются сразу.

Какая активность для новых комментариев — свойство, указывающее компоненту на то: активировать ли комментарии сразу или оставлять на премодерацию. Комментарии, публикуемые модератором всегда публикуются активными и не блокируются стоп-фильтром.

«Верхняя ссылка комментирования» и «Нижняя ссылка комментирования» — свойства, отвечающие за отображение и вид ссылок комментирования перед деревом обсуждения и после. Данными свойствами можно отключить любую из указанных ссылок, представить в виде поля ввода или в виде ссылки.

«Автоматически раскрывать основную форму комментирования» — параметр позволяет раскрыть одну из главных форм комментирования (перед обсуждением или после обсуждения) сразу же после загрузки страницы. Чтобы посетитель видел уже раскрытую форму.

Выделять подпись пользователей-модераторов — если свойство установлено, подписи комментаторов-модераторов будут выделены. Это обеспечивается дополнительным css-классом «_admin»

Если нужно ограничить глубину, на которой позволено оставлять записи, используется параметр «Максимальная глубина для комментирования пользователями-не модераторами». Это может быть полезным, например, в книге отзывов, когда гости оставляют свои сообщения только на первом уровне, а модератор оставляет под ними ответы. Валидным минимальным уровнем считается первый. Если в поле пусто или ноль — ограничение не применяется.

«Не рассылать уведомление модераторам». По умолчанию, всем модераторам наравне с административным электронным адресом, приходят уведомления про новые сообщения. Если нужно отключить уведомление модераторов конкретного обсуждения, используется данный параметр. Модераторы смогут управлять обсуждением, но им не будет приходить поток уведомлений. Параметр не действует на главный административный электронный адрес.

Внешний вид

Использовать форму авторизации для неавторизованных. Данным параметром включается и отключается механизм авторизации. Авторизация демонстрируется неавторизованному пользователю во время попытки оставить комментарий, если неавторизованным запрещено комментировать. Пользователь может ввести логин и пароль и если они корректны, ему тут же, без перезагрузки страницы, будет открыта форма для добавления комментариев. При настроенных в административном разделе систем авторизации через соцсервисы будут отображены соответствующие пиктограммы для авторизации.

Для авторизованных скрыть поле с подписью и поле с электронным адресом. Параметры скрывают поля подписи и электронного адреса для авторизованных пользователей. Фактически значения этих полей берутся из карточки пользователя и потому нет смысла отображать их, перегружая визуально форму комментирования.

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

Публиковать ссылки на профиль пользователя — включает обрамление пиктограммы и подписи комментатора в ссылку на личный профиль. Ссылка публикуется в том случае, если комментарий оставил зарегистрированный пользователь. Шаблон ссылки берётся из настроек модуля.

Показывать дату. Отображается ли дата в заголовке сообщений.

Формат даты — возможность указать, в каком виде выводить дату.

Показывать ли время. Время отображается в виде: 13:26. Если на странице отображается и дата и время, они связываются сеюзом «в», например: 21 сентября в 13:26. Также модуль содержит механизм, который ближайшие промежутки форматирует в облегчённый для ориентирования вид. Обрабатываются диапазоны в секундах, минутах, отрезки до трёх часов, маркеры "сегодня" и "вчера". Например: "XX секунд назад", "XX минут назад", "2 часа назад в 12:45", "сегодня в 13:40", "вчера в 10:00". Механизм форматирования времени требует активности параметров: "Показывать дату", "Показывать время"

Не собирать подписи комментаторов, не собирать электронные адреса комментаторов, скрыть поле с прикреплением фотографии — настройки, позволяющие отключить соответствующие поля в форме публикации и редактирования сообщения.

Параметры подпись обязательна, обязательно указывать электронный адрес делают соответствующие поля обязательными к заполнению.

Публиковать ветки свёрнутыми, начиная с указанной глубины. Указывается уровень, после которого комментарии публикуются свёрнутыми. Минимальное значение — 1. В этом случае, первый уровень развёрнут, а все подкомментарии вглубь — свёрнуты. Если пусто или ноль — механизм не применяется. Следует брать во внимание, что «свежие» комментарии (при использовании общего параметра модуля «Установить период "устарения" комментариев» или параметра компонента «Период времени для "свежих" комментариев...») публикуются развёрнутыми, даже если попали в свёрнутую ветку.

Период времени для "свежих" комментариев. Действует аналогично общему параметру модуля «Установить период "устарения" комментариев», только в рамках текущего обсуждения.

Использовать микроразметку schema.org. Параметром можно применить микроразметку к дереву обсуждения. Доступны режимы: Не использовать и Использовать схему Review.

Сопровождать комментарии ссылками (по-умолчанию включено) и закрывать в <noindex> с rel="nofollow" (по-умолчанию включено) — чекбоксы управления маркировкой каждого комментария уникальной ссылкой. Особенности:

• в урле используется get-параметр «itape=код_комментария»;
• уведомление про новый комментарий теперь содержит ссылку в указанном формате;
• переход по ссылке с указанием кода комментария теперь подсвечивает комментарий, страница скролится к нему при загрузке;
• если комментарий попал в свёрнутую ветку, ветка публикуется развёрнутой (как в случае со «свежими» комментариями);
• если комментарий находится в одной из страниц пагинации, будет активирована соответствующая страница;
• если переход совершён с указанием кода комментария, который не найден, будет произведён редирект на страницу без кода комментария.

Загрузка порциями и постраничная навигация

Параметр «Использовать обратную сортировку...» предназначен для переключения обсуждения в «чат-режим». В этом случае будет использована обратная сортировка узлов первого уровня и в результате новые сообщения будут находиться в начале, а более старые — в конце списка.

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

Следующий параметр позволяет переключить механизм отображения порциями на постраничную навигацию. Количество главных узлов на одной странице навигации берётся из параметра «Ограничение 2».

Голосование

Первым параметром активируется на странице механизм голосования. При активном данном параметре, следующая опция: «Разрешить голосовать не авторизованным» активирует механизм голосования и для не авторизованных/не зарегистрированных пользователей.

Дополнительные настройки

Надпись, которая дописывается к каждому комментарию, — здесь можно указать строку, которая будет добавлена к каждому сообщению. Используется как правило для маркировки сообщений, отправленых с мобильных устройств. Может быть указан произвольный HTML-код.

Набор параметров для локального переопределения основных фраз. Это позволяет адаптировать каждое рахворачиваемое обсуждение под окружение: обсуждение новостей и фотографий, гостевая книга и отзывы, вопрос-ответы, блокноты пользователей, административные заметки, форма обратной связи...

Читать дальше: Почтовые шаблоны.