ModxTalks
  • Главная
  • Помощь
  • Демо
  • Демо-Реверс
  • English
Fork me on GitHub

Документация установки и настройки modxTalks

home/Помощь
  • Установка
  • Перед установкой
  • Настройка
  • Настройка
  • Настройка ресурса
  • Последнии комментарии
  • Шаблоны
  • Системные события
  • Вывод в ленте
  • Количество комментариев
Внимание! Это первая бета версия. Исходный код можно посмотреть на github.com/artdevue/modxTalks. Все найденные ошибки возникшие процессе использования modxTalks, вы можете оставить по этой ссылке.

Установка установка, настройка и примеры

Перед установкой

Технические навыки

Хоть modxTalks предназначен для легкой установки, но вы должны быть знакомы с следующими операциями:

Управления панелью
Уверенный пользователь администрирования панелью управления MODX Revolution.
Чанк и Снипет
Знать основы, что такое чанк и что такое сниппет

Системные требования

ModxTalks требуется несколько вещей, чтобы всё работало.

Версия системы
У Вас должна быть установлена версия MODX Revolution не ниже 2.2.6.
jQuery
Версия jQuery 1.7 или выше

Загрузка

Используя панель управления MODX, перейдите в Управления пакетами в строке поиска пакетов, наберите "modxTalks", загрузите и установите пакет.

Исходный код расположен на github.com

Подключение modxTalks на сайте

Есть два способа подключения комментарие для вашего сайта.

Создание ресурса с комментариями
Чтобы создать ресурс с комментариями, достаточно щелкнуть правой кнопкой мыши на ресурс в дереве, а затем перейти на "Создать", вы должны увидеть это:
modx create modxtalks
После создания Ресурса с комментариями, у вас появиться вкладка - Комментарии и иконка перед названием ресурса, что свидельствует о том, что в ресурсе комментарии установленны. Перейдите в созданный вами ресурс в фронтальной сати сайта и вы должны увидеть форму для добавления комментариев сразу после контента.
Вставка снипета в удобное место в сайте
В удобном месте вашего шаблона ресурса или чанка, вы можете вызвать снипет modxTalks

[[!modxTalks]]

Убедитесь, что снипет вызываете не кэшированный

Настройка основная настройка modxTalks

Основная настройка

Основные настройки modxTalks находяться в Настройки системы, в разделе "modxtalks".

Все подсказки описаны в комментариях для каждой отдельной настройки.

Имя Ключ По умолчанию Описание
Настройка BBCode
Включить BBCode modxtalks.bbcode

Да

Включить обработку и редактор BBCode в комментариях? Да / Нет
Ссылки modxtalks.detectUrls

Нет

Переводить адреса веб ресурсов в комментариях в ссылки? Да / Нет
Теги редактора modxtalks.editOptionsControls fixed, image, link, strike, header, italic, bold, video, quote Выберите теги, для отображения иконок редактора. Доступные - fixed, image, link, strike, header, italic, bold, video, quote
Смайлики modxtalks.smileys

Нет

Включить отображение смайликов в комментариях? Да / Нет
Общие настройки
Реверс modxtalks.revers

Нет

Отображение комментариев сверху новые, если выбирете НЕТ, то новые комментарии будут снизу.
Таймаут между отправкой комментариев modxtalks.add_timeout

60

Время в секундах, между отправкой комментариев
Аякс обновление modxtalks.ajax

Да

Включить аякс обновление комментариев с сервера? Да / Нет
Длина комментария modxtalks.commentLength 2000 Максимально допустимая длина комментария в символах.
Количество комментариев modxtalks.commentsPerPage 20 Максимальное количество комментариев на странице для отображения при визуализации управления навигации по страницам.
Формат даты modxtalks.dateFormat j-m-Y, G:i Формат даты отображаемый в комментариях.
Аватар по умолчанию modxtalks.defaultAvatar Полная ссылка на аватар, отображается при отсутствии аватара в системе Граватар.
Период редактирования комментария modxtalks.edit_time 180 Время, после которого пользователь не может редактировать комментарий
Использовать граватар modxtalks.gravatar

Да

Включить граватар в сообщениях пользователей. Да / Нет
Размер граватара modxtalks.gravatarSize 64 Размер граватара выводимого в комментариях.
Включить jQuery modxtalks.jquery

Да

Если вы используете своё подключение jQuery для странице, или используете сторонние сервисы, выбирите НЕТ, и убедитесь, что версия jQuery не ниже v1.7
Группы модераторов modxtalks.moderator Administrator Укажите через запятую группы модераторов, которые могут модерировать комментарии
Только авторизованные modxtalks.onlyAuthUsers

Нет

Оставлять комментарии могут только авторизованные пользователи.
Премодерация комментариев modxtalks.preModarateComments

Да

Если установленно - Да, то комментарии изначально попадают на промодерацию. После потверждения менеджером, комментарий выводиться на сайте.
Офсет скруббер modxtalks.scrubberOffsetTop 0 Отступ скрайбера от вехней части экрана при скроле. Это нужно, если у вас присутствуют элементы с позицированием fixed, например меню
Позиция скруббера modxtalks.scrubberTop

Нет

Отоброжения скрайбера в верхней позиции сообщений, по умолчанию (НЕТ), скрайбер отображаеться в правой колонке.
Голосование за комментарий modxtalks.voting

Нет

Выберите Да, если вы хотите включить голосование за комментари.
Подсветка кода
Подсветка кода modxtalks.highlight

Да

Включить подсветку кода Highlight в комментариях? Да / Нет
Тема Highlight modxtalks.highlighttheme GitHub Укажите тему оформления подсветки кода. Более детально на сайте highlight.
Доступные темы: Default, Dark, FAR, IDEA, Sunburst, Zenburn, Visual Studio, Ascetic, Magula, GitHub, Google Code, Brown Paper, School Book, IR Black, Solarized-Dark, Solarized-Light, Arta, Monokai, XCode, Pojoaque, Rainbow, Tomorrow, Tomorrow Night, Tomorrow Night Bright, Tomorrow Night Blue, Tomorrow Night Eighties
Почтовые уведомления
modxtalks.emailsFrom modxtalks.emailsFrom Адрес электронной почты, для указания отправителя в заголовке письма
modxtalks.emailsReplyTo modxtalks.emailsReplyTo Адрес электронной почты для ответа

Настройка ресурса настройка modxTalks в ресурсе

Настройка modxTalks в ресурсе

После создания ресурса с комментариями, у вас появится вкладка с настройками для комментариев

modx create modxtalks
1
Показывает количество не потверждённых комментариев привязанных к данному ресурсу.
2
Показывает количество удалённых комментариев привязанных к данному ресурсу.
3
Показывает общее количество комментариев привязанных к данному ресурсу.
4
Максимальное количество комментариев на странице для отображения при визуализации управления навигации по страницам.
5
Перечислите через запятую группы модераторов, которые будут имеют возможность модерировать комментарии в этом ресурсе.
6
Шаблон для вывода комментариев. Оставьте не заполненным, если хотите использовать настройки по умолчанию.
7
Шаблон для вывода удалённых комментариев. Оставьте не заполненным, если хотите использовать настройки по умолчанию.
8
Шаблон для вывода редактирования комментариев. Оставьте не заполненным, если хотите использовать настройки по умолчанию.
9
Шаблон для вывода авторизации комментариев. Оставьте не заполненным, если хотите использовать настройки по умолчанию.

Вызов modxTalks через снипет

Для простого вызова снипета modxTalks, в удобном месте шаблона или чанка ресурса, мы ставим вызов [[!modxTalks]]

В снипете доступны следующие параметры вызова.

Параметр Тип Описание
conversation (string) Уникальное название для блока вывода комментариев, по умолчанию [[*class_key]]-[[*id]]
add_timeout (numeric) Время в секундах, между отправкой комментариев.
commentAddFormTpl (string) Шаблон формы добавления комментария.
commentAuthTpl (string) Шаблон формы регистрации. Выводиться не авторизированным юзерам, если параметр onlyAuthUsers активный.
commentEditFormTpl (string) Шаблон формы редактирования комментаря.
commentLength (numeric) Максимально допустимая длина комментария в символах.
commentTpl (string) Шаблон для вывода комментариев.
commentsClosed (boolean) Запретить оставлять комментарии всем кроме выбранных групп модераторов. Комментирование отключено
commentsPerPage (numeric) Максимальное количество комментариев на странице для отображения при визуализации управления навигации по страницам.
dateFormat (string) Формат даты отображаемый в комментариях.
deletedCommentTpl (string) Шаблон для вывода удалённых комментариев.
edit_time (numeric) Время, после которого пользователь не может редактировать комментарий.
gravatar (boolean) Включить граватар в сообщениях пользователей.
gravatarSize (numeric) Размер граватара выводимого в комментариях.
moderator (string) Перечислите через запятую группы модераторов, которые будут имеют возможность модерировать комментарии в этом ресурсе.
onlyAuthUsers (boolean) Оставлять комментарии могут только авторизованные пользователи.

Последнии комментарии вывод последних комментарий

Для вывода последних комментариев на вашем сайте. достаточно установить вызов снипета [[!modxTalksLatestComments]]

Параметры снипgета // Параметры сниппета modxTalksLatestComments

Параметр Тип Описание
commentLatestTpl (string) Шаблон отдельного комментария для блока. Может быть название чанка. Если установленно значение, то заменит исходный шаблон.
commentsLatestOutTpl (string) Шаблон оболочки комментариев для блока. Может быть название чанка. Если установленно значение, то заменит исходный шаблон.
commentsLatestLimit (numeric) Ограничения вывода количество комментариев на страницу.
Важно! Если вы вызываете снипет modxTalksLatestComments не на странице с комментариями, то вы должны убедиться, что у вас подключен jQuery и timeago!.

Пример подключения скриптов // на странице с вызовом последних комментариев

  1. <script src="[[++assets_url]]components/modxtalks/js/web/lib/jquery-1.9.min.js" type="text/javascript"></script>
  2. <script src="[[++assets_url]]components/modxtalks/js/web/lib/timeago.js" type="text/javascript"></script>
  3. <script src="[[++assets_url]]components/modxtalks/js/web/lib/timeago/ru.js" type="text/javascript"></script>

Свои шаблоны настройка и создание шаблонов

Важно! вы должны иметь средний уровень владения HTML и JQuery!.

Вы можете указать свой созданный шаблон ориентируясь и сохраняя логику шаблона, примеры шаблонов можете посмотреть на github.com или посмотреть у себя на сервере, в директории - путь к папке core/ components/modxtalks/elements/chunks

commentTpl // Шаблон для вывода комментариев

Параметр Описание
index data-index, возвращает формат даты в виде 201301 год и месяц
idx idx комметария (уникальный в своей теме)
deleted CSS класс, который добавляеться если комментарий удалён
id id комметария
userId id юзера в md5
hideAvatar CSS класс, который скрывает аватор, если аватор предыдущего комментария принадлежит одному и тому же юзеру
avatar Вывод аватора пользователя
name Имя пользователя
link Ссылка на комментарий
date Дата добавления комментария - пример: 19-01-2013, 23:56 +0200
funny_date Вывод даты публикации комментария в формате fuzzydate
funny_edit_date Вывод даты редактирования комментария в формате fuzzydate
edit_name Вывод имени пользователя, который редактировал комментарий
link_reply Ссылка для ответа на этот комментарий
quote Название ссылки для ответа на комментарий
user Вывод навигации в комментарии, в зависимости от роли юзера
content Содержание комментария

deletedCommentTpl // Шаблон для вывода удалённых комментариев

Параметр Описание
index data-index, возвращает формат даты в виде 201301, год и месяц
idx idx комметария (уникальный в своей теме)
id id комметария
name Имя пользователя
link Ссылка на комментарий
date Дата добавления комментария, пример: 19-01-2013, 23:56 +0200
funny_date Вывод даты публикации комментария в формате fuzzydate
delete_date Дата удаления комментария
funny_delete_date Дата удаления комментария в формате fuzzydate
deleteUser Имя юзера, удалившего комментарий
link_restore Ссылка для восстановления комментария, доступна только модераторам

commentAddFormTpl // Шаблон формы добавления комментария

Параметр Описание
link Ссылка на страницу с комментариями
avatar Вывод аватора пользователя
controlsbb Вывод панели инструментов, для редактирования комментария

commentEditFormTpl // Шаблон формы редактирования комментария

Параметр Описание
link Ссылка на страницу с комментариями
id id комметария
avatar Вывод аватора пользователя
controlsbb Вывод панели инструментов, для редактирования комментария
content Содержимое комментария

comment_auth_tpl // Шаблон формы авторизации

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

mt_send_mail // Шаблон для писем и уведомлений

Вы можете изменить дизайн или элементы дизайна на своё усмотрение

modx create modxtalks
Параметр Описание
title Заголовок e-mail сообщения
avatar Вывод аватара пользователя
text Текст заголовка сообщения
content Содержимое комментария
date Дата добавления комментария

comment_latest // Шаблон отдельного комментария для блока.

Шаблон отдельного комментария для блока. Может быть название чанка. Если установленно значение, то заменит исходный шаблон.

name
Параметр Описание
time Дата добавления комментария в формате UNIX timestamp
cid id комментария
avatar Вывод аватара пользователя
name Имя пользователя
timeago Дата добавления комментария, пример: 19-01-2013, 23:56 +0200
funny_date Вывод даты публикации комментария в формате fuzzydate
total Всего комментариев в теме
link Ссылка на комментарий
content первые 200 символов содержания комментария
title Название ресурса

comments_latest_out // Шаблон оболочки комментариев для блока.

Шаблон оболочки комментариев для блока. Может быть название чанка. Если установленно значение, то заменит исходный шаблон.

Параметр Описание
output Вывод всех комментариев

Системные события системное событие OnModxTalksCommentAfterAdd

Параметры

Событие OnModxTalksCommentAfterAdd вызываеться при добавлении комментария.

Параметр Описание
conversationId ID темы
idx Порядковый индекс комментария
userId ID пользователя добавившего комментарий
time Время создания комментария в формате UNIX timestamp
date Дата создания комментария в формате YYYYMM (201301)
editUserId ID пользователя отредактировавшего комментарий
editTime Время редактирования комментария
deleteUserId ID пользователя удалившего комментарий
deleteTime Время удаления комментария
hash Хэш комментария, md5( текст_комментария + email_пользователя + ID_темы )
content Текст комментария
username Имя пользователя добавившего комментарий (только для гостей)
useremail Email пользователя добавившего комментарий (только для гостей)
ip IP адрес с которого был добавлен комментарий
properties Дополнительные свойства комментария в формате JSON

Вывод в ленте вывод в ленте количества комментариев в ресурсе

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

Расмотрим пример вывода ресурса через getPage или getResources. Откроем ваш чанк вывода ресурса и вставим на место отображения количества комментария тег {%mtr_[[+id]]%}

Пример чанка

Пример чанка для getResources.

  1. ... ...
  2. <div class="comments"><i class="icon-eye-open">comments {%mtr_[[+id]]%}</i></div>
  3. ... ...
Важно! В шаблоне или в ресурсе вывода последних комметариев, нужн установить вызов не кэшированного сниппета [[!MtCount]], это активирует плагин для замены тугов на сущность.

Если вы вызываете комментарии через снипет и у вас своя структура привязки к ресурсу, то вызов должен состоять такой-же как и название, которое вы вставили или сформировали в самом вызове снипета

Вызов тега в таком случае будет следующий: {%mtc_myBlog-2%} - myBlog-2, это и есть само название conversation

Важно! Не забывать активировать плагин, для этого, в ресурсе, где вы выводите количество комментариев для лент, нужно вставить в любом удобном месте шаблона или ресурса вызов некэшированного снипета [[!MtCount]].

Project developers

Version 1.0.1 beta • Created & Maintained by Valentin Rasulov & Ivan Brezhnev.
Translation by Viktorminator

Donate & Support

If you are using modxTalks in some projects and want to thank the author..

Contact us

Artdevue Ltd,

  6 Sokalskogo str., of-126, 04074 UA, Ukraine

 +38098 220.43.37

 info@artdevue.com

Post to social networks

Tweet

Copyright © 2013 Artdevue Ltd,.