Extension:Thanks

MediaWiki extensions manual

Thanks Release status: stable
Implementation	User interface
Description	Lets users thank other users for individual edits
Author(s)	Ryan Kaldari (Kaldaritalk)
Latest version	1.1.0 (2014-03-14)
MediaWiki	1.22+
PHP	5.3+
Database changes	No
License	MIT
Download	Download snapshot (Git master) Git [?]: repo summary browse file tree commit history
Parameters $wgThanksSendToBots $wgThanksLogging $wgThanksConfirmationRequired
Hooks used HistoryRevisionTools DiffRevisionTools PageHistoryBeforeList DiffViewHeader BeforeCreateEchoEvent EchoGetDefaultNotifiedUsers AddNewAccount BeforeSpecialMobileDiffDisplay
Translate the Thanks extension if possible
Check usage and version matrix; code metrics
Bugs: list open list all report

Thanks is an extension that allows users to thank other users for individual edits. It adds a 'thank' link next to the 'undo' link in history and diff views, and to Flow board comments if Flow is installed. It also provides an API for sending thanks.

Feature

The Thanks notification offers a new way to give positive feedback on Wikipedia. The purpose of this experimental feature is to give quick positive feedback to recognize productive contributions. It invites editors to send a private 'Thank you' notification to users who make useful edits, as shown below. More details are available in this overview page and in this feature requirement.

Once you have had a chance to try it out, we welcome your feedback about this feature on this talk page. (Note that if you do not want to thank others or be thanked, you can easily disable this notification in your preferences, as described here.)

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 Wikipedia. We have intentionally kept this notification as simple as possible, so we can evaluate it and improve it together. Enjoy ...

Installation

Thanks requires the Echo extension be installed as a prerequisite.

• Download and extract the files in a directory called Thanks in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
• Add the following code at the bottom of your LocalSettings.php:

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;

• Go to the History action of a page to see the new "Thank" interface.
• Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Usage

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

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 (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. You can get one of these through prop=info. (required)

Example:

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

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\

See also

• Extension:WikiLove - Another extension for sending gratitude
• Extension:Echo