Extension:Thanks

This page is a translated version of the page Extension:Thanks and the translation is 15% complete.
راهنمای افزونهٔ مدیاویکی
OOjs UI icon advanced-invert.svg
Thanks
وضعیت انتشار: پایدار
History-Thank-Link-Mockup1.png
انجام رابط کاربری
توضیحات به کاربران این امکان را می‌دهد که از سایر کاربران برای ویرایش‌های فردی و غیره تشکر کنند.
نویسنده(گان)
آخرین نسخه: 1.2.0 (Continuous updates)
سیاست سازگاری Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.31+
PHP 5.4+
مجوز MIT License
بارگیری
  • $wgThanksAllowedLogTypes
  • $wgThanksConfirmationRequired
  • $wgThanksLogging
  • $wgThanksSendToBots
Translate the Thanks extension if it is available at translatewiki.net

Check usage and version matrix.

Vagrant role echo
Issues Open tasks · گزارش یک مشکل

افزونه متشکرم راهی سریع برای ارائه بازخورد مثبت برای مشارکت‌های سازنده در سایت‌های مدیاویکی اضافه می‌کند. این به کاربران اجازه می‌دهد اعلان‌های عمومی 'تشکر از شما' را (از طریق Echo ) به سایر کاربران برای ویرایش‌های فردی و برخی اقدامات ثبت‌شده ارسال کنند.

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.

A 'thank' link is added in the following places:

  • next to the 'undo' link in history and diff views;
  • to Flow board comments if Flow is installed.

It also provides an API for sending thanks.

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…

بارگیری

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/Thanks/ directory of your MediaWiki installation.

If you are familiar with Git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Thanks.git

نصب

Thanks requires the Echo extension be installed as a prerequisite.
  • Download and place the file(s) in a directory called Thanks in your extensions/ folder.
  • کد زیر را در انتهای LocalSettings.php خودتان اضافه کنید:
    wfLoadExtension( 'Thanks' );
    
  • If necessary configure at your convenience
  • Go to the History action of a page to see the new "Thank" interface.
  •   انجام شد – به Special:Version در ویکی خودتان بروید تا مطئمن شوید که افزونه با موفقیت نصب شده است.

برای کاربرانی که مدیاویکی 1.26 یا جدیدتر را اجر می‌کنند:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.26 and earlier), instead of wfLoadExtension( 'Thanks' );, you need to use:

require_once "$IP/extensions/Thanks/Thanks.php";

پیکربندی

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 documentation

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

Parameters:

  • 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)

Example:

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

To send thanks via OAuth only the "Basic" grant permission is required. A python example can be found here.


Log 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.

Flow Thanks

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

Parameters:

  • 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)

Example:

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

Errors and Warnings

Code Info
invalidrecipient گیرندهٔ معتبری پیدا نشد
از ربات‌ها نمی‌توان تشکر کرد
از خودتان نمی‌توانید تشکر کنید


همچنین ببینید