Extension:GlobalWatchlist

GlobalWatchlist

2021 Coolest Tool
Award Winner

in the category
Newcomer

This extension is currently not actively maintained! Although it may still work, any bug reports or feature requests will more than likely be ignored. If you are interested in taking on the task of developing and maintaining this extension, you can request repository ownership. As a courtesy, you may want to contact the author. You should also remove this template and list yourself as maintaining the extension in the page's {{Extension }} infobox.

MediaWiki extensions manual

GlobalWatchlist Release status: unmaintained
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+
Parameters $wgGlobalWatchlistEnableGuidedTour $wgGlobalWatchlistDevMode $wgGlobalWatchlistSiteLimit
Hooks used ApiOptions GetPreferences LoginFormValidErrorMessages ResourceLoaderRegisterModules SidebarBeforeOutput
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (Phabricator · GitHub) Gerrit code review Git commit log Download source tarball README
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.

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

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.

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' );
} );

• When CentralAuth is installed, only wikis where the user has an attached account are allowed in their global watchlist
• When some of the sites included in the global watchlist have 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

• MediaWiki-Docker/Extension/GlobalWatchlist

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.

This extension is included in the following wiki farms/hosts and/or packages: Miraheze