Erweiterung:GlobalWatchlist

GlobalWatchlist

2021 Coolest Tool
Award Winner

in the category
Newcomer

MediaWiki-Erweiterungen

GlobalWatchlist Freigabestatus: ohne Wartung
Einbindung	Spezialseite
Beschreibung	Erstellt eine "globale" Beobachtungsliste
Autor(en)	DannyS712Diskussion
Kompatibilitätspolitik	Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel.
MediaWiki	1.36+
Parameter $wgGlobalWatchlistEnableGuidedTour $wgGlobalWatchlistDevMode $wgGlobalWatchlistSiteLimit
Verwendete Hooks ApiOptions GetPreferences LoginFormValidErrorMessages ResourceLoaderRegisterModules SidebarBeforeOutput
Lizenz	GNU General Public License 2.0 oder neuer
Herunterladen	Erweiterung herunterladen Git [?]: Repository durchsuchen (Phabricator · GitHub) Code-Review Ergänzungen und Änderungen Download source tarball README
Übersetze die GlobalWatchlist-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Probleme	Offene Aufgaben · Einen Fehler melden

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

Installation

• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens GlobalWatchlist im Ordner extensions/ ablegen.
  Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:

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

• Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:

  wfLoadExtension( 'GlobalWatchlist' );
  

• Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.

Konfiguration

Die Erweiterung hat die folgenden Konfigurationsoptionen:

Variablenname	Standardwert	Beschreibung
$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.

Verwendung

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.

Warnung:

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.

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

Integration mit anderen Erweiterungen

• 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

Siehe auch

• MediaWiki-Docker/Extension/GlobalWatchlist