Extension:Thanks

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:Thanks and the translation is 34% complete.

Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎মেইতেই লোন্ • ‎中文 • ‎日本語 • ‎한국어
Manuel des extensions MediaWiki
OOjs UI icon advanced.svg
Thanks
État de la version : stable
History-Thank-Link-Mockup1.png
Implémentation User interface
Description Permet aux utilisateurs de remercier d’autres utilisateurs pour leurs modifications, etc.
Auteur(s)
Dernière version 1.2.0 (Continuous updates)
Compatibility policy release branches
MediaWiki 1.31+ . Thanks master should only be used with core's master; otherwise, use matching branches (e.g. Thanks REL1_27 with core REL1_27, or matching WMF release branches).
PHP 5.4+
Changements
base de données
Non
Licence MIT License
Téléchargement
  • $wgThanksSendToBots
  • $wgThanksLogging
  • $wgThanksConfirmationRequired
  • $wgThanksLogTypeWhitelist
Traduisez l’extension Thanks sur translatewiki.net
Vérifiez la matrice des utilisations et des versions.
Rôle Vagrant echo
Problèmes Tâches ouvertes · Signalez un bug

L’extension Thanks (remerciements) ajoute une manière simple d’émettre un retour positif pour les contributions constructives aux sites MediaWiki. Elle permet aux utilisateurs d’envoyer des notifications « Merci » publiques (via Echo) aux autres utilisateurs pour leurs contributions individuelles et certaines actions journalisées.

La révision qui est « remerciée » n’est pas enregistrée dans la table publique de journalisation. Seuls l’horodatage, l’émetteur et le destinataire sont publiquement journalisés.

Un lien « remercier » est ajouté à quatre endroits :

  • à côté du lien « annuler » dans l’historique et la visualisation de diff ;
  • sur certaines entrées de journal sur Spécial:Journal(voir la section « Configuration » plus bas) ;
  • aux commentaires d’un plateau Discussions structurées, si l’extension Discussions structurée est installée.

Elle fournit aussi une API pour envoyer des remerciements.

Remarquez que si vous ne voulez pas être remercié, vous pouvez facilement désactiver cette notification dans vos préférences, comme décrit plus bas.

Example of a 'thanks' notification

Si vous avez pu la tester, nous accueillerons avec plaisir vos commentaires sur cette fonctionnalité sur la page de discussion.

Nous espérons que les notifications émises par Thanks rendront plus visible l’appréciation par autrui du travail de chacun — et cela devrait être particulièrement utile pour encourager les nouveaux utilisateurs pendant leurs critiques premiers pas sur le wiki. Nous avons intentionnellement gardé cette extension aussi simple que possible, afin que nous l’évaluions et l’améliorions ensemble. Faites-vous plaisir…

Download

Cette extension peut être récupérée directement depuis Git [?]:

  • Naviguer dans le code
  • Certaines extensions étiquettent les versions stables.
  • Chaque branche correspond à une version antérieure de MediaWiki Il y a aussi une branche master (maître) qui contient la dernière version alpha (elle peut nécessiter une version alpha de MediaWiki)

Décompressez l'instantané et placez le dans le répertoire extensions/Thanks/ de votre installation MediaWiki.

Si vous êtes familier de git et si vous avez un accès au shell de votre serveur, vous pouvez aussi obtenir l'extension de la manière suivante:

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

Installation

Thanks a besoin, en prérequis, que l’extension Echo soit installée.
  • Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé Thanks dans votre dossier extensions/.

Pour les utilisateurs de MediaWiki 1.26 ou précédents :

Les instructions ci-dessus décrivent la nouvelle procédure pour installer cette extension en utilisant wfLoadExtension(). Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.26 ou antérieur), à la place de wfLoadExtension( 'Thanks' );, vous devez utiliser :

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

Configuration

Activer l’interface Remercier pour les modifications faites par des robots (désactivée par défaut).

$wgThanksSendToBots = false;

Journaliser les actions Remercier dans « Spécial:Journal » (activé par défaut).

$wgThanksLogging = true;

Définit si la confirmation est requise ou non pour envoyer des remerciements (activé par défaut).

$wgThanksConfirmationRequired = true;

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

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

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, 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 <= :end_date

Notice also that the logging table is not selected from directly, but on Wikimedia servers we take advantage 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 You cannot thank yourself

See also