Extension:GlobalWatchlist

GlobalWatchlist

2021 Coolest Tool
Award Winner

in the category
Newcomer

MediaWiki extensions manual

GlobalWatchlist Release status: stable
Implementation	Special page
Description	Creates a "global" watchlist
Author(s)	DannyS712talk
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.36+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review README
Parameters $wgGlobalWatchlistEnableGuidedTour $wgGlobalWatchlistSiteLimit $wgGlobalWatchlistWikibaseSite $wgGlobalWatchlistDevMode
Hooks used ApiOptions GetPreferences LoginFormValidErrorMessages ResourceLoaderRegisterModules SidebarBeforeOutput
Quarterly downloads	8 (Ranked 130th)
Public wikis using	5,392 (Ranked 51st)
Translate the GlobalWatchlist extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The GlobalWatchlist extension allows a user to view changes to watched pages on multiple sites at once.

Installation

• Download and move the extracted GlobalWatchlist folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GlobalWatchlist
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'GlobalWatchlist' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

The extension has the following configuration options

Variable name	Default value	Description
$wgGlobalWatchlistWikibaseSite	false	The site that should be treated as a Wikibase Repository and should have labels fetched for items that are changed. If false, the extra handling for Wikibase items is not applied.
$wgGlobalWatchlistUseVue	false	Whether to use the experimental Vue.js version of the display
$wgGlobalWatchlistDevMode	false	Whether to send debug log entries to the console
$wgGlobalWatchlistEnableGuidedTour	false	Whether to enable the GuidedTour for the settings page, if the GuidedTour extension is installed
$wgGlobalWatchlistSiteLimit	5	The maximum number of sites that a user can save to their watchlist. Set to 0 to disable the limit.

Using

To view the global watchlist, visit Special:GlobalWatchlist on the wiki where the extension is installed. By default, only the local wiki's changes are shown, but by changing the configuration at Special:GlobalWatchlistSettings the user can choose other sites to show, up to the maximum if configured.

Warning:

It is recommended to use this in conjunction with CentralAuth and to choose other sites that the user has an attached account on; this extension is not tested with any other setup.

Integration with other extensions

• When CentralAuth is installed, only wikis where the user has an attached account are allowed in their global watchlist
• When one of the sites included in the global watchlist has the Wikibase Repository extension installed, labels for items and properties can be fetched and displayed. If WikibaseLexeme is installed labels for lexemes are retrieved too.
• When GuidedTour is installed, and $wgGlobalWatchlistEnableGuidedTour is enabled, a tour is available at Special:GlobalWatchlistSettings the first time you visit the page

See also

• MediaWiki-Docker/Extension/GlobalWatchlist