Phabricator のプロジェクト名 #Thanks

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 83% complete.

Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎মেইতেই লোন্ • ‎中文 • ‎日本語 • ‎한국어
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
Thanks
リリースの状態: 安定
History-Thank-Link-Mockup1.png
実装 User interface
説明 利用者が他の利用者の個々の編集などに対し、謝意を表明できる。
作者
最新バージョン 1.2.0 (Continuous updates)
互換性ポリシー リリースブランチ
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+
データベースの変更 いいえ
ライセンス MIT License
ダウンロード
パラメーター
  • $wgThanksSendToBots
  • $wgThanksLogging
  • $wgThanksConfirmationRequired
  • $wgThanksLogTypeWhitelist
使用するフック
HistoryRevisionTools
DiffRevisionTools
PageHistoryBeforeList
DiffViewHeader
BeforeCreateEchoEvent
EchoGetDefaultNotifiedUsers
LocalUserCreated
BeforeSpecialMobileDiffDisplay
GetLogTypesOnUser
BeforePageDisplay
ResourceLoaderTestModules
ApiMain::moduleManager
EchoGetBundleRules
LogEventsListLineEnding
translatewiki.net で翻訳を利用できる場合は、Thanks 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
Vagrant role echo
問題点 未解決のタスク · バグを報告

感謝拡張機能により、MediaWikiサイトに生産的な寄稿に対して肯定的なフィードバックをすばやく返すことができます。利用者は他の人に向け、編集1件単位、ログイン利用者の行動単位で(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.

〈感謝〉リンクは次の4箇所に追加できます。

  • 編集履歴と差分表示の「巻き戻し」リンクの隣。
  • 特別ページ:履歴表示にある特定の項目に対して(下記の#設定節を参照してください)。
  • Flowをインストールしてある場合はFlowボードのコメントに対して。

同時に感謝を通知するAPIを提供します。

もし感謝の通知を受信したくない場合には、下記に説明するとおり、個人設定を変更して簡単に通知を停止できます。

Example of a 'thanks' notification

もし試しに使う機会があったら、この機能に対するフィードバックをトークページに投稿してみませんか。

感謝の通知を使って、より簡単にお互いの作業に謝意を伝え合えたらよいと期待しています—特定のウィキに新規利用者が参加すると、特にデビュー直後の重要な段階で励ますには役立つはずです。この通知は意図的にできる限り簡略化してあり、皆さんの評価で改善していくつもりです。ぜひ使ってみてください。

Download

拡張機能は、Git から直接取得できる場合があります [?]:

  • コードを参照
  • 一部の拡張機能には安定版リリースのタグがあります。
    • タグを参照
    • タグを選択します
    • 「スナップショット」をクリックします
  • 各ブランチは過去の MediaWiki リリースと関連付けられています。 最新のアルファ バージョンを含む「master」ブランチもあります (MediaWiki のアルファ バージョンが必要な場合用)。

スナップショットを展開して、MediaWiki インストレーション内の extensions/Thanks/ ディレクトリに配置します。

git に馴染みがあり、かつサーバーにシェルでアクセスできる場合は、拡張機能を以下のようにして取得することもできます:

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

インストール

Thanks を使用するには、要件として Echo 拡張機能をインストールする必要があります。
  • ダウンロードして、ファイルを extensions/ フォルダー内の Thanks という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'Thanks' );
    
  • お好みで設定を変更してください
  • 新しい「感謝」インターフェースがどう表示されるか、特定のページの「履歴表示」ページを開いて確認しましょう。
  • Yes 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.26 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.26 以前) にインストールする必要がある場合は、wfLoadExtension( 'Thanks' ); の代わりに以下を使用する必要があります:

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

設定

ボットによる編集に対して感謝の通知を有効にする(初期設定は無効)

$wgThanksSendToBots = false;

感謝の通知の操作を「Special:Log」に記録(初期設定は有効)

$wgThanksLogging = true;

感謝の通知の送信前に確認するかどうか(初期設定は有効)

$wgThanksConfirmationRequired = true;

「特別ページ:記録」から感謝の通知を送る対象のログ項目

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

使用法

他の利用者に感謝の通知を送るには、どのページでも「履歴表示」ページを開きます。それぞれの更新記録の横にある〈感謝〉リンクを押して、その利用者に感謝の通知を送ります。同じリンクが差分表示のページと「特別ページ:記録」にもあり、Flow ボードをインストールしてある場合は Flow のコメント直下にあります。

感謝リンクボタンを押すと、Echo 拡張機能により通知を受け取る利用者には、だれが送ったか通知が届きます(感謝の通知を停止している場合を除く)。感謝の通知を送信した行動は特別ページ/感謝に記録されます。

ご利用のウィキでmemcachedを使用している場合は、利用者ひとりが送信できる感謝の通知は毎分10件に制限されます。上限値は$wgRateLimits ['thanks-notification']で設定します。

感謝の通知を受けない

感謝の通知を停止するには、個人設定で無効にします。 個人設定の「通知」タブを開きます。無効にした利用者には通知が届かなくなりますが、他の利用者が感謝の通知を送ることは妨げません。

APIの説明文書

感謝の通知拡張機能には感謝の通知を送信するAPIが含まれています。APIの呼び出しにはaction=thankパラメーターを使います。

パラメーター:

  • rev - 感謝したい相手が編集した編集履歴ID(もしくはlogが必須)
  • log - 感謝したい相手が編集したログID(もしくはrevが必須)
  • source - 感謝通知のソース情報。送信元を示す短い文字列です。例えば送信元がHuggleだった場合、値は〈huggle〉となります(オプション)。
  • token - 編集トークン (別名: csrf トークン)。 トークンAPIを使って入手します(必須)。

例:

 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

Flow ボードのコメントに感謝を通知するには、専用のAPIが必要です。そのAPIの呼び出しはaction=flowthankを使います。

パラメーター:

  • postid - 感謝を通知する対象のコメントのUUID(必須)
  • token - 編集トークン。prop=infoを介して入手します。(必須)

例:

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

エラーと警告

コード 情報
invalidrecipient 感謝の通知の対象に自分自身は指定できません

関連項目