Модуль комментариев под Битрикс
 

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

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

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

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

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

Полноценные комментарии под Битрикс. Документация

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

Режим работы — параметр, который может принимать одно из двух значений. Всегда в списке выбора режима присутствует режим “local”, который указывает модулю работать с текущей странице в «Одиночном режиме», то есть все комментарии накапливаются и обрабатываются на этом же сайте. Если выбран данный режим, список обсуждений в следующем свойстве формируется из инфоблоков, которые размещены в той же базе данных, что и сам сайт.

В зависимости от настроек на странице «Распределение нагрузки», в списке на выбор может появиться второй параметр — “translator-mode”. Этот режим указывает модулю работать с обсуждением через дистанционный обработчик, в режиме «Транслятора». Все комментарии будут отправляться, обрабатываться и храниться на удалённом сайте, специально выделенным под данную задачу. Если выбран данный режим, список обсуждений в следующем свойстве формируется из инфоблоков, размещённых на сайте-обработчике.

Код инфоблока — параметр, который указывает, в какой инфоблок накапливать обсуждение. Инфоблоки создаются и настраиваются автоматически при инсталляции модуля. Если вам нужно создать и настроить дополнительные инфоблоки — воспользуйтесь сервисной страницей «Список обсуждений» (Административный раздел / Сервис / Полноценные комментарии / Список обсуждений).

Отложенный старт, ajax-режим — данным параметром ветка обсуждения будет инициализирована не при вызове основной страницы, а после её загрузки, через аякс-запросы. Данный механизм ускоряет загрузку основной страницы, что особенно ощутимо при использовании комментариев в режиме «Транслятора» при распределении нагрузки между основным сайтом и сайтом-обработчиком. Для обеспечения индексации комментариев поисковыми системами во время отображения основной страницы индикатор загрузки маркируется ссылкой со специальным ключом «itape_direct=Y», который ведёт на эту же страницу, но с отключенным механизмом «Отложенный старт». Страница, которая открывается со специальным ключом «itape_direct» снабжается мета-тегом canonical. Это исключает создание поисковой системой дубликатов страниц, что зачастую ведёт к исключению их из поискового индекса.

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

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

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

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

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

['USERS_ADD_MOD'] => $list_of_mod // Массив, например: array(345, 3490, 4087);

['USERS_ADD_MOD'] => array (
    0 => $author_USER_ID // Код пользователя
)

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

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

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

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

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

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

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

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

Чтобы активировать механизм подачи жалоб на комментарий, используется параметр «Давать ссылку для жалоб». При отправке жалобы, на административный электронный адрес формируется электронное сообщение. Рассылка производится также и модераторам (параметр компонента «Не рассылать уведомление модераторам» блокирует эту рассылку). Чтобы ссылка с жалобой была доступна только зарегистрированным пользователям, используется следующий параметр: «Ссылку для жалоб — только для авторизованных».

Электронный адрес для приёма жалоб. Если поле пустое, жалобы будут отправляться на электронные адреса модераторов. Если поле заполнено, жалобы будут отправляться только на указанный адрес. Несколько адресов указывается через запятую.

Внешний вид

Полноценные комментарии под Битрикс. Документация

В свойстве «Для подписи использовать формулу» дан список формул для составления особых подписей. Если данным свойством установлена определённая формула, подписи к комментариям будут переопределены по отдельному правилу. Формулы управляются через сервисную страницу административного раздела: Административный раздел / Сервисы / Полноценные комментарии / Формулы подписей.

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

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

Полноценные комментарии под Битрикс. Документация

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

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

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

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

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

Показывать ли время. Время отображается в виде: 12:24. Если на странице отображается и дата и время, они связываются сеюзом «в», например: 12 сентября в 14:50.

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

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

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

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

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

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

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

Полноценные комментарии под Битрикс. Документация

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

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

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

Голосование

Полноценные комментарии под Битрикс. Документация

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

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

Чекбокс «Активировать подсчёт общего рейтинга пользователей» включает отображение индикатора общего рейтинга — параметра, отображающего сумму собранных пользователем голосов. В настройках модуля в закладке «Голосование» предусмотрен параметр, которым можно ограничить область сбора статистики по голосам. Параметр «Где отображать индикатор общего рейтинга пользователя» указывает, где индикатор должен быть отображён. Варианты: у аватара, у подписи комментатора.

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

Полноценные комментарии под Битрикс. Документация

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

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

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


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

dex.Metrika counter -->