Extensão:Thanks

From mediawiki.org
This page is a translated version of the page Extension:Thanks and the translation is 25% complete.
Outdated translations are marked like this.
Esta extensão acompanha o MediaWiki 1.40 ou superior. Logo, não é necessário baixá-la novamente. No entanto, ainda é necessário seguir as outras instruções fornecidas.
Manual de extensões do MediaWiki
Thanks
Estado da versão: estável
Implementação Interface de usuário
Descrição Permite aos usuários agradecer a outros usuários for edições individuais
Autor(es)
Última versão 1.2.0 (Continuous updates)
Política de
compatibilidade
Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.42
Licença Licença MIT
Download
  • $wgThanksAllowedLogTypes
  • $wgThanksConfirmationRequired
  • $wgThanksLogging
  • $wgThanksSendToBots
Quarterly downloads 48 (Ranked 93rd)
Public wikis using 2,442 (Ranked 193rd)
Para traduzir a extensão Thanks, verifique sua disponibilidade no translatewiki.net
Função no Vagrant echo
Problemas Tarefas em aberto · Relatar um bug

The Thanks extension adds a quick way to give positive feedback for productive contributions to MediaWiki sites. 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.

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…

Instalação

A extensão requer a instalação da extensão Echo como pre-requisito.
  • Baixe e coloque o(s) arquivo(s) num diretório chamado Thanks na sua pasta extensions/.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Thanks
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php :
    wfLoadExtension( 'Thanks' );
    
  • Se necessário, configure à sua conveniência
  • Vá ao histórico de uma página para ver a nova interface da extensão "Thanks".
  • Yes Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

Configuração

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"
];

Uso

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.

Documentação da API

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

Parâmetros:

  • rev - O ID de revisão pelo qual você gostaria de agradecer a alguém (ou isto ou log se faz necessário)
  • log - O ID de registro pelo qual você gostaria de agradecer a alguém (ou isto ou rev se faz necessário)
  • 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)

Exemplo:

 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.

Parâmetros:

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

Exemplo:

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

Errors and Warnings

Code Info
invalidrecipient Não foi encontrado recipiente válido
Bots não podem receber agradecimentos
Você não pode agradecer a si mesmo

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.


Ver também