拡張:グローバルウォッチリスト

GlobalWatchlist

2021 Coolest Tool
Award Winner

in the category
Newcomer

MediaWiki 拡張機能マニュアル

GlobalWatchlist リリースの状態: 保守されていない
実装	特別ページ
説明	「グローバル」なウォッチリストを作成
作者	DannyS712トーク
互換性の方針	スナップショットが MediaWiki とともにリリースされます。 master には後方互換性がありません。
MediaWiki	1.36+
パラメーター $wgGlobalWatchlistEnableGuidedTour $wgGlobalWatchlistDevMode $wgGlobalWatchlistSiteLimit
使用するフック ApiOptions GetPreferences LoginFormValidErrorMessages ResourceLoaderRegisterModules SidebarBeforeOutput
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: リポジトリを参照 (Phabricator · GitHub) Gerrit コード レビュー Git コミット ログ Download source tarball README
translatewiki.net で翻訳を利用できる場合は、GlobalWatchlist 拡張機能の翻訳にご協力ください
問題点	未解決のタスク · バグを報告

グローバルウォッチリスト拡張機能は、利用者が複数のサイトでウォッチしたページの変更をまとめて表示できます。

インストール

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

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

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

  wfLoadExtension( 'GlobalWatchlist' );
  

• 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

設定のオプションは次のとおりです

変数名	既定値	説明
$wgGlobalWatchlistWikibaseSite	false	Wikibase Repository として扱い、変更された項目のラベルを取得すべきサイト。 falseの場合、ウィキベース項目に対する追加処理は適用されない。
$wgGlobalWatchlistUseVue	false	試験的な表示形式のバージョン Vue.js を採用するかどうか
$wgGlobalWatchlistDevMode	false	コンソールにデバッグログエントリを送信するかどうか
$wgGlobalWatchlistEnableGuidedTour	false	GuidedTour 拡張機能がインストールされている場合、設定ページで GuidedTour を有効にするかどうか
$wgGlobalWatchlistSiteLimit	5	ウォッチリストに保存できるサイト件数の上限。制限解除は 0 に設定。

使い方

拡張機能をインストールしたウィキで Special:GlobalWatchlist を開くと、グローバルウォッチリストを表示します。 既定ではローカルウィキの変更のみが表示されますが、Special:GlobalWatchlistSettings で設定を変更することで利用者は表示する他のサイトを選択できます（上限が設定されている場合、その件数まで）。

警告:	使用するときはCentralAuthとの併用ならびに利用者がアカウントを登録した他のウィキの選択を推奨します。この拡張機能はその他の環境で試験をしていません。

JavaScript hook: ext.globalwatchlist.rebuild

The GlobalWatchlist interface exposes a client-side hook named ext.globalwatchlist.rebuild that is fired after every rebuild of the watchlist display, both after a full browser page load and after internal refreshes triggered by the feature itself. This hook can be used by gadgets and user scripts or other extensions to run custom JavaScript whenever the global watchlist view is redrawn.

The hook callback receives a single object parameter with the following fields:

• root – The root DOM element of the GlobalWatchlist interface that has just been rebuilt.
• inLive – Boolean flag indicating whether the interface is currently in “live updates” mode.
• fastMode – Boolean flag indicating whether the interface is in “fast load” mode.
• timestamp – A timestamp string representing the moment of the data snapshot for which this rebuild is valid.

A typical usage pattern looks like:

mw.hook( 'ext.globalwatchlist.rebuild' ).add( function ( data ) {
    // data.root is the rebuilt container element
    // data.inLive indicates live updates mode
    // data.fastMode indicates fast load mode
    // data.timestamp is the data timestamp for this view
    // Custom logic can be added here, for example:
    // $( data.root ).addClass( 'my-globalwatchlist-enhancement' );
} );

他の拡張機能との連携

• CentralAuth をインストールすると、グローバルウォッチリストに表示できるウィキは利用者がアカウントを持っているものに限定されます
• グローバルウォッチリストに登録したサイトが Wikibase Repository 拡張機能を導入していると、項目とプロパティのラベルを取り込んで表示します。WikibaseLexemeを導入していると、語彙素のラベルも取り込みます。
• GuidedTour をインストールし、$wgGlobalWatchlistEnableGuidedTourを有効にすると、ページを最初に開いたときSpecial:GlobalWatchlistSettingsでツアーを利用可能になります

関連項目

• MediaWiki-Docker/Extension/GlobalWatchlist