Extension:Thanks

MediaWiki 拡張機能マニュアル

Thanks リリースの状態: 安定
実装	ユーザー インターフェイス
説明	個々の編集などに対して、他の利用者に感謝の気持ちを伝えることができます。
作者	Ryan Kaldari Benjamin Chen Wctaiwan
最新バージョン	1.2.0 (継続的な更新)
互換性の方針	MediaWiki とともにリリースされるスナップショット。 master には後方互換性がありません。
ライセンス	MIT ライセンス
ダウンロード	拡張機能をダウンロード Git [?]: リポジトリを参照 (Phabricator · GitHub) Gerrit コード レビュー Git コミット ログ Download source tarball
パラメーター $wgThanksAllowedLogTypes $wgThanksConfirmationRequired $wgThanksLogging $wgThanksSendToBots
使用するフック ApiMain::moduleManager BeforeCreateEchoEvent BeforePageDisplay ChangesListInitRows DiffTools DifferenceEngineViewHeader EchoGetBundleRules GetAllBlockActions GetLogTypesOnUser HistoryTools LocalUserCreated LogEventsListLineEnding PageHistoryBeforeList PageHistoryPager::doBatchLookups
translatewiki.net で翻訳を利用できる場合は、Thanks 拡張機能の翻訳にご協力ください
Vagrant role	echo
問題点	未解決のタスク · バグを報告

Thanks拡張機能は、MediaWikiサイトへの生産的な貢献に対して肯定的なフィードバックを与える迅速な方法を追加します。 利用者が個々の編集やいくつかの記録された操作に対して、他の利用者に公開の「感謝」を通知で (Echo 経由で) 送信できるようにします。

以下の場所に「感謝」リンクが追加されています。

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

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

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

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

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

インストール

Thanks を使用するには、要件として Echo 拡張機能をインストールする必要があります。

この拡張機能は MediaWiki 1.40 以降に同梱されているため、ダウンロードする必要はありません。 残りの設定手順は必ず従ってください。

• ダウンロードして、ファイルをextensions/フォルダー内のThanksという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:

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

• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'Thanks' );
  

• お好みで設定を変更してください
• 新しい「感謝」インターフェイスがどう表示されるか、ページの履歴タブで確認しましょう。
• 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

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

$wgThanksSendToBots = false;

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

$wgThanksLogging = true;

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

$wgThanksConfirmationRequired = true;

Special:Log の記録項目の種類のうち、感謝を示す対象となるもの:

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

使用法

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

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

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

感謝の通知を受けない

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

APIの説明文書

thank
このモジュールは generator としては使用できません。
接頭辞
必要な権限	なし
POST のみ?	はい
自動生成ヘルプ	現行バージョン

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

パラメーター:

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

例:

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

OAuth 経由で感謝を送るには、「基本」の権限を認めるだけです。 Pythonのサンプルはこちらでご覧になれます。

Flow Thanks

flowthank
このモジュールは generator としては使用できません。
接頭辞
必要な権限	なし
POST のみ?	はい
自動生成ヘルプ	現行バージョン

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

パラメーター:

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

例:

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

エラーと警告

コード	情報
invalidrecipient	無効な対象者 ボットに感謝することはできません 自分自身を感謝することはできません

SQL 解説文書

「感謝」が示された特定の版、イベント、または操作は、記録データベーステーブルには保管されません（そのため、システムでは Special:Log/thanks などに表示できる内容に制限があります）。タイムスタンプ、送信者、受信者のみが記録されます。 過去ログから誰が誰に感謝したかを理解するには、列をある程度理解する必要があります。 logging 表内の log_title は受信者を、log_user_text は送信者を表します。

以下の SQL は特定の期間、特定の受信者に寄せられた感謝を抽出するので、その例を示します。

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

もう1点、the logging table の表は直接の抽出結果ではなく、ウィキメディアのサーバを賢く使って logging_logindex テーブルを応用しています。 特定の利用者が送った 感謝の類型を手早く検索するには、logging_userindexを押すと正しい索引を表示します。

関連項目

• w:Help:Notifications/Thanks - 当拡張機能を英語版ウィキペディアでどう使うか情報があります
• Echo (Notifications)/Feature requirements#Thank_you_notification - 当初の機能提案（Echo拡張機能だったとき）
• Extension:WikiLove - 謝意表明を行う別の拡張機能
• Extension:Echo - 通知システムを提供