Расширение:Thanks

From mediawiki.org
This page is a translated version of the page Extension:Thanks and the translation is 33% complete.
Это расширение поставляется с MediaWiki 1.40 и выше. Таким образом, вам не нужно загружать его снова. Тем не менее, вы всё равно должны следовать другим инструкциям.
Справка по расширениям MediaWiki
Thanks
Статус релиза: стабильно
Реализация Пользовательский интерфейс
Описание Позволяет участникам поблагодарить других участников за их правки и действия.
Автор(ы)
Последняя версия 1.2.0 (Continuous updates)
Политика совместимости Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.42
Лицензия MIT License
Скачать
  • $wgThanksAllowedLogTypes
  • $wgThanksConfirmationRequired
  • $wgThanksLogging
  • $wgThanksSendToBots
Ежеквартальные загрузки 61 (Ranked 92nd)
Использование общедоступными вики 2,442 (Ranked 193rd)
Переведите расширение Thanks, если оно доступно на translatewiki.net
Роль Vagrant echo
Проблемы Открытые задачи · Сообщить об ошибке

Расширение Thanks добавляет быстрый способ дать положительный отклик на продуктивные действия на сайтах MediaWiki. It allows users to send public 'thank you' notifications (via Echo ) to other users for their individual edits and some logged actions.

The specific revision that is being "thanked" for is not stored in the public logging table. Only the timestamp, sender, and recipient, are publicly logged.

Ссылка «поблагодарить» добавляется в следующих местах:

  • рядом со ссылкой «отменить» при просмотре истории страницы и диффа;
  • у некоторых записей журнала на странице Служебная:Журналы (см. #Конфигурация ниже)
  • на досках обсуждений Flow, если соответствующее расширение установлено.

Также добавляется API для отправки благодарностей.

Note that if you do not want to be thanked, you can easily disable this notification in your preferences, as described below.

Example of a 'thanks' notification

Once you have had a chance to try it out, we welcome your feedback about this feature on the talk page.

We hope that the Thanks notification will make it easier to show appreciation for each other's work – and it should be particularly helpful for encouraging new users during their first critical steps on a wiki. We have intentionally kept this notification as simple as possible, so we can evaluate it and improve it together. Enjoy…

Установка

Thanks requires the Echo extension be installed as a prerequisite.
  • Скачайте и распакуйте файл(ы) в папку с названием Thanks в вашей папке extensions/.
    Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Thanks
  • Добавьте следующий код в конце вашего файла LocalSettings.php :
    wfLoadExtension( 'Thanks' );
    
  • If necessary configure at your convenience
  • Go to the History action of a page to see the new "Thank" interface.
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Конфигурация

Enable the Thank interface for bot edits (disabled by default)

$wgThanksSendToBots = false;

Log Thank actions to "Special:Log" (enabled by default)

$wgThanksLogging = true;

Whether or not confirmation is required for sending thanks (enabled by default)

$wgThanksConfirmationRequired = true;

Log entry types that can be thanked from Special:Log:

$wgThanksLogTypeWhitelist = [
	"contentmodel",
	"delete",
	"import",
	"merge",
	"move",
	"patrol",
	"protect",
	"tag",
	"managetags",
	"rights"
];

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

To thank another user, go to the History tab of any page. Next to each revision will be a 'thank' link. Click the link to send thanks to that user. This link is also available in the diff view, on some entries in Special:Log, and below comments on Flow boards if Flow is installed.

When the thank link is clicked, the recipient will receive a notification with your thanks via the Echo extension (unless they have opted out of receiving thanks notifications). A record of the action is also recorded as a log entry at Special:Log/thanks.

If the wiki is using memcached, a rate limit is imposed of no more than 10 thanks per minute per user. The limit can be configured with $wgRateLimits ['thanks-notification'].

Avoiding thanks

To stop getting thanks notifications, you can opt out from them in your notification preferences. Go to the Notifications tab of your preferences. This only prevents you from getting notified, it does not prevent users from thanking you.

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

The Thanks extension includes an API for sending thanks. In order to call the API, use the parameter action=thank.

Параметры:

  • rev - The revision ID you would like to thank someone for (either this or log is required)
  • log - The log ID you would like to thank someone for (either this or rev is required)
  • source - Source of the thank event. This is a short string that identifies where the thanks was sent from. For example, if the thanks was sent from Huggle, the value could be 'huggle'. (optional)
  • token - Edit token (a.k.a. CSRF token). You can get one of these through the tokens API. (required)

Пример:

 api.php?action=thank&rev=16543&token=%2B\

To send thanks via OAuth only the "Basic" grant permission is required. A python example is available.

Flow Thanks

There is a separate API for sending Thanks for comments on Flow boards. To call the API, use action=flowthank.

Параметры:

  • postid - The UUID of the comment for which to send thanks (required)
  • token - Edit token. You can get one of these through prop=info. (required)

Пример:

 api.php?action=flowthank&postid=abc123&token=%2B\

Ошибки и предупреждения

Код Информация
invalidrecipient Не найдено корректного получателя
Нельзя поблагодарить ботов
Вы не можете поблагодарить сами себя

SQL Documentation

Understanding who thanked who from the logs requires some understanding of the columns. Within the logging table, the log_title represents the receiver, and the log_user_text represents the sender.

The following SQL which finds all the thanks a receiver received within a time period illustrates this:

select log_timestamp as thank_timestamp,
  replace(log_title, '_', ' ') as receiver,
  log_user_text as sender
from logging_logindex
where log_title = :user_name
  and log_action = 'thank'
  and :start_date <= log_timestamp
  and log_timestamp <= :end_date

Notice also that the logging table is not selected from directly, but on Wikimedia servers we take advantage of the logging_logindex table. In order to quickly search for all the thanks a user sent the logging_userindex provides the correct index.


См. также