Wikipedia:Technik/Skin/JS/Variablen

JavaScript-Variablen in MediaWiki

---

Diese Seite beschreibt, wie sich in der JavaScript-Programmierung Informationen gewinnen lassen über die aktuelle Seite, den momentanen Benutzer und die sonstige Konfiguration.

Projekt-, seiten- und situationsabhängige Konfigurationsvariablen

Eine Reihe von Parametern gibt Informationen über die MediaWiki-Installation und das Wiki-Projekt (Database) wie auch die momentane Aktion und Einzelheiten über den Artikel und Benutzer-Einstellungen. Eine Übersicht der wichtigsten Parameter ist nachstehend aufgelistet.

wg steht für „WikiGlobals“.

Mit Einführung von MediaWiki 1.17 (seit 2011) sollen die Parameter wie folgt abgefragt werden:
mw.config.get("Name")
oder gleich mehrere als Array:
mw.config.get( [ "Name1", "Name2" ] )
Rückgabewert ist im zweiten Fall ein Objekt, bei dem die Namen der Komponenten die Namen der Parameter sind.
Für unbekannte Bezeichner wird null zurückgegeben.

Bis 2011 waren die Parameter nur als einfache (globale) JavaScript-Variablen verfügbar. Das war übergangsweise noch ein Jahrzehnt möglich; bei Neuentwicklungen und Überarbeitungen von Skripten musste aber nun auf den neuen Zugriff umgestellt werden. Zugriffe führten seit Januar 2015 auch in der Fehlerkonsole zu Warnungen: phab:T58550 (Bugzilla:56550) / phab:T72470 (Bugzilla:70470) / phab:T35837 (Bugzilla:33837).

Zum 19. April 2021, nach einem Jahrzehnt Gelegenheit zur Migration, sind die globalen Variablen weggefallen. phab:T72470

Weitere Abfrage:

mw.config.exists("Name")

Informiert, ob Name definiert ist.

Zu erweiterten Möglichkeiten siehe mw.Map.

Alle Parameter stehen auf der HTML-Quelltext-Seite.

Die nachstehende Tabelle gibt stabile und umsetzbare Werte wieder.

Parameter (Auswahl)

Bezeichner	Erläuterung
Projektspezifisch
wgDBname	dewiki – deutschsprachige Wikipedia mehr …
wgSiteName	Wikipedia Projektname in der Landessprache, könnte auch „Wikipédia“ oder „Vikipedi“ heißen.
wgContentLanguage	de
wgNamespaceIds	{"diskussion": 1, "talk": 1, "benutzer": 2, "benutzerin": 2, "user": 2, "benutzer_diskussion": 3, … }
wgFormattedNamespaces	{…, "6": "Datei", …, "10": "Vorlage", … }   (Objekt, aber kein fortlaufend ab Null nummeriertes Array)
wgCaseSensitiveNamespaces	Array mit Namensräumen, bei deren Seiten die Groß/Kleinschreibung des Titels unterschieden wird. Vor allem für Wiktionaries wichtig, weil es dort auch eigene Seitennamen mit kleinem Anfangsbuchstaben geben darf. In der de.WP ist die Länge Null.
wgContentNamespaces	Array mit Namensraum-Nummern, in denen keine Signaturen vorgenommen werden sollen. In der de.WP: [ 0 ] Richtig ist, dass Artikel nicht signiert werden; jedoch gibt es Wartungsbausteine.
wgExtraSignatureNamespaces	Array mit Namensraum-Nummern, in denen signierte Beiträge zusätzlich zu Diskussionsseiten vorkommen können. In der de.WP: [ 100, 4, 12 ] mw: [ 0, 4, 12 ]
Seitenspezifisch
wgArticleId	6606385 (Bei Spezialseiten und Bildern, die von Commons geladen werden, gilt wgArticleId === 0)
wgTitle	Technik/Skin/JS/Variablen Menschenfreundliche Form (nicht URL-fähig: Leerzeichen) Ohne Namensraum!
wgPageName	Wikipedia:Technik/Skin/JS/Variablen Bedingt URL-fähig
wgNamespaceNumber	4   (siehe Liste)
wgRevisionId	Versionsnummer der momentan benutzten Seitenversion Wenn wgRevisionId!==wgCurRevisionId dann momentane Version nicht die aktuellste. Nicht bei generierten Spezialseiten und während der Bearbeitung (dann 0).
wgCurRevisionId	Versionsnummer der aktuellen Seitenversion - Auch während action=edit oder submit verfügbar; nicht bei den nur generierten Spezialseiten (dort 0).
wgStableRevisionId	Versionsnummer der zuletzt bestätigten (hier: gesichteten) Seitenversion Wenn wgStableRevisionId!==wgCurRevisionId dann ungesichtet. Nur in Sichtungs-Namensräumen (sonst null).
wgCategories	["Deutscher", "Frau"] nur bei wgIsArticle gefüllt; während action=edit nicht verfügbar; jedoch bei submit→Vorschau (nicht aber Diffpage). Zurzeit auch nicht in der Mobildarstellung.
wgPageContentLanguage	Seiteninhaltssprache; vor allem in mehrsprachigen Wikis wie Commons interessant
wgCanonicalNamespace	"Project" (=Wikipedia), einheitlicher Name
wgCanonicalSpecialPageName	Seite im Spezial-Namensraum, einheitlicher Name beispielsweise "Listfiles", "Watchlist", "Whatlinkshere"; false
wgPageContentModel	“Content Model” der Seite
wgWikibaseItemId	{ wgWikibaseItemId: "Q83" } Nur bei wgAction als view (nicht beim Bearbeiten).
wgIsRedirect	true – Diese Seite enthält #REDIRECT usw. false – Diese Seite ist keine Weiterleitung Nicht zu verwechseln mit wgRedirectedFrom
Situationsabhängig
wgIsArticle	true – Feste Seite nur ansehen (view, auch diffpage); keine Spezialseite false – Generierte Spezialseite oder Aktivität am Artikel: Editieren, Änderungen, Vorschau
wgAction	view – Seite nur ansehen oder Spezialseite; auch Versionsvergleich edit – Seite öffnen zur Bearbeitung submit – Vorschau, Änderungen (, Speichern→view) history – Versionsgeschichte historysubmit – Frühere Versionen (vergleichen) bis 2012 info – Informationen zur Seite watch – Zur Beobachtungsliste hinzugefügt (Bestätigung) parsermigration-edit – Migrationswerkzeug Ausführlich zu action unter Hilfe:URL-Parameter #action.
wgRestrictionEdit	Individueller Schutzstatus einer bearbeiteten Seite
wgRestrictionMove	Individueller Schutzstatus einer Seite
wgIsProbablyEditable	(?) nicht vor aktuellem Benutzer geschützt, keine Spezialseite, kein Flow
wgPostEdit	true – wenn zuvor diese Seite gespeichert wurde und jetzt als Ergebnis angezeigt wird
wgRedirectedFrom	Wenn deklariert: Auf die aktuelle Seite wurde von einer anderen Seite weitergeleitet. Der Wert ist der Seitenname der Weiterleitung.
wgInternalRedirectTargetUrl	Temporäre interne Variable; kann in der dargestellten Seite eigentlich nicht verfügbar sein. Bewahrt vor allem das ursprünglich angegebene Fragment, selbst wenn die Weiterleitung ein anderes vorsieht. mediawiki.action.view.redirect.js
wgRelevantPageName	Wenn deklariert: Die aktuelle Seite (Spezialseite) bezieht sich auf eine andere Seite. Beispiel: Auf “WhatLinksHere” wäre das die Seite, auf die verlinkt wird.
wgRelevantArticleId	PageId zu wgRelevantPageName
wgRelevantUserName	Wenn deklariert: Die aktuelle Seite (Spezialseite) bezieht sich auf einen bestimmten Benutzer (Beiträge, nicht aber Benachrichtigungen, nicht Beo).
debug	true – Debug-Modus aktiviert
Benutzerspezifisch
skin	monobook Skin; ein Wert aus cologneblue minerva modern monobook vector vector-2022
wgUserName	PerfektesChaos null für IP (bis 2024) Zeichenkette für temporary user (ab 2024) nicht angemeldete Konten hätten kein Benutzerskript – wohl aber site-JavaScript
wgUserLanguage	de
wgUserGroups	["autoreview", "editor"] [ "*", "temp" ] für temporary user (ab 2024)
wgGlobalGroups	Aktive globale Benutzergruppen. global-sysop wäre nur in „Kleinen Wikis“ aktiv.
wgEnableAPI	Darf API lesend benutzen.
wgEnableWriteAPI	Darf API schreibend benutzen.
wgUserId	Numerische ID des eigenen Benutzerkontos
wgUserEditCount	Anzahl der eigenen Bearbeitungen (einschließlich gelöschte) Bei nicht angemeldeten Benutzern ist die Variable undefined.
wgUserRegistration	Zeitpunkt der Anmeldung (Sekunden seit 1970-01-01) Bei nicht angemeldeten Benutzern ist die Variable undefined. Bei Benutzern, die sich vor 2005/06 angemeldet haben, ist der Wert null – damals wurde der Anmeldezeitpunkt im Profil noch nicht gespeichert.
wgUserVariant	Nur auf Wikis mit mehreren Sprachvarianten: Bevorzugte Sprachvariante des momentanen Benutzers.
wgNoticeUserData	Im Zusammenhang mit der hauseigenen Banner-Werbung definiertes Objekt, dessen Inhalte direkt an externe Seiten weitergeleitet werden können. Diese könnten allerdings auch über wgUserName erschlossen werden. .editcount .pastyearseditcount .registration "20061126141519"
Echo
wgEchoConfig	Globaler Namensraum, nicht über mw.config.get() DOM-Object einer <tr> tür Echo. { version="1.4", eventlogging={...}} eventlogging – Object mit den Komponenten Echo: { enabled=true, revision=5423520 }, EchoInteraction: { enabled=true, revision=5539940 }, EchoMail: { enabled=true, revision=5467650 }, EchoPrefUpdate: { enabled=false, revision=5488876 }
wgEchoHelpPage	URL zur Hilfeseite
wgEchoOverlayConfiguration	{ notification-count="1", max-notification-count=99 } notification-count – Anzahl der ungelesenen Benachrichtigungen. Offenbar mit mw.echo.overlay.configuration identisch.
wgUserNewMsgRevisionId	oldid der letzten gelesenen eigenen Diskussionsseite, wenn es fremde Beiträge darauf gibt. 393380288 null wenn gelesen.
Webserver
wgServer	//de.wikipedia.org
wgArticlePath	/wiki/$1
wgScript	/w/index.php
wgScriptExtension	".php"
wgScriptPath	/w
wgLoadScript	/w/load.php (2015: //bits.wikimedia.org/de.wikipedia.org/load.php) Entfernt 2019 (1.34.0-wmf) für mw.util.wikiScript( "load" )
stylepath	/w/skins
wgExtensionAssetsPath	//skins/extensions
Lokalisierung
wgDefaultDateFormat	"dmy" Projektstandard
wgDigitTransformTable	[ "", "" ] wichtig für arabisch-basierte Sprachen
wgMonthNames	[ "", "Januar", … ] Weil nicht (mehr) verwendet, soll die Bereitstellung künftig wegfallen: phab:T219340 – mw.language bietet dies inzwischen an.
wgMonthNamesShort	[ "", "Jan.", … ] 2020 weggefallen: phab:T219340 – mw.language bietet dies inzwischen an.
wgSeparatorTransformTable	[ ",Tab.", ".Tab," ]
wgTranslateNumerals	true
Details der Projektkonfiguration
wgAvailableSkins	{ cologneblue:"CologneBlue", modern:"Modern", monobook:"MonoBook", vector:"Vector", timeless: "Timeless", minerva: "MinervaNeue", fallback: "Fallback", apioutput: "ApiOutput" }
wgCitoidConfig	{ citoidServiceUrl:"//citoid.wikimedia.org/api"} (Citoid)
wgCodeMirrorEnabled	true wenn Projekt CodeMirror unterstützt
wgCookiePrefix	dewiki Typischerweise identisch wgDBname, aber nicht zwingend; bei der Bildung der cookie-Namen vorangestellt
wgCookieDomain	(string) leer für "dewiki"
wgCookiePath	/
wgCookieExpiration	2592000 Sekunden entsprechend 30 Tagen
wgEventLoggingBaseUri	"//de.wikipedia.org/beacon/event"
wgFileExtensions	[ "png", "gif", … ] War bis Januar 2015 auf allen Seiten verfügbar gewesen; nunmehr nur noch auf Special:Upload.
wgGuidedTourHelpGuiderUrl	Help:Geführte Touren/Guider
wgIllegalFileChars	":/\"
wgLegalTitleChars	" %!"$&'()*,\-./0-9:;=?@A-Z\\\^_`a-z~+\u0080-\uFFFF"
wgMainPageTitle	"Wikipedia:Hauptseite"
wgNoticeProject	wikipedia – generiert durch CentralNotice.
wgResourceLoaderLegacyModules	["mediawiki.legacy.wikibits"] (wikibits).
wgResourceLoaderMaxQueryLength	2000 oder anders.
wgSearchType	"CirrusSearch" seit Mitte November 2014; zuvor: "LuceneSearch"
wgUrlProtocols	https\:\/\/|ftp\:\/\/|irc\:\/\/| …
wgVersion	1.44.0-wmf.5
Wechselnde Umgebungsbedingungen
wgHostname	Sie enthalten den Servernamen und die Zeit (Millisekunden) für das Parsen der Seite; außerdem den Ressourcenverbrauch. Bisher stand diese Information als Kommentar im HTML-Quelltext: <!-- Served by mw1069 in 0.976 secs --> Inzwischen steht am Ende des HTML-Quelltextes: mw.config.set({"wgBackendResponseTime":981,"wgHostname":"mw1177"}); Außerdem ist der Parser-Report inzwischen als JS-Variable verfügbar.
wgBackendResponseTime
wgPageParseReport
wgBetaFeaturesFeatures	Array
wgBreakFrames	true
wgEditMessage	"editing" beim Bearbeiten (auch in der Vorschau/Diff), sonst null. Wird von LivePreview benutzt, um document.title und #firstHeading mit neuen Werten zu versehen.
wgSiteNoticeId	SiteNotice ist aktiv mit dieser ID
wgULSIMEEnabled	false/true
wgULSNoImeSelectors	[ "#wpCaptchaWord" ]
wgCoordinates	Standortinformation (etwa eines Mobilgerätes)
wgMFNearbyEndpoint	Standortinformation (etwa eines Mobilgerätes) für In der Nähe
wgMFNearbyRange	Umkreisradius (maximale Entfernung) für In der Nähe
Geo.IP Geo.country	eigene IP "DE" usw.; zumindest mutmaßliches Staatsgebiet des Benutzers; Standort des Internetproviders Geo könnte null oder kein Objekt sein

Einige der Werte sind aus den Parserfunktionen bekannt. Eine vollständige Liste steht unter mw:Manual:Interface/JavaScript #mw.config.

Benutzerkonfiguration

Über mw.user hat man im JavaScript-Code Zugriff auf die Benutzerkonfiguration. Das ist ein Spiegel der Benutzereinstellungen auf dem Server (auch bei nicht angemeldeten Benutzern definiert und mit einem entsprechenden Standardprofil belegt).

Für die aktuelle Sitzung kann bekannt sein:

• mw.user.id() – wgUserName, sonst Zufallszahl
• mw.user.isAnon() – true wenn kein wgUserName, sonst false
• mw.user.getName() →wgUserName
• mw.user.sessionId()

Analog zu den Konfigurationsparametern sind mit MediaWiki 1.17 auch die Einstellungen aus dem Benutzerprofil verfügbar geworden.

Die Abfrage soll erfolgen mittels:

• mw.user.options.get("Bezeichner")

Zu weiteren Möglichkeiten siehe mw.Map.

Diese Werte werden allerdings möglicherweise erst nach dem Benutzer-Skript definiert, so dass sie sich nicht ohne weiteres auslesen lassen. Mit der Funktion .loader.using() des ResourceLoader muss die Bereitstellung von user.options abgewartet werden.

Alle Einstellungen (bis auf die E-Mail-Adresse) stehen auf der HTML-Quelltext-Seite.

Änderungen des Objekts sind mit mw.user.options.set() möglich.

• Dies wirkt auf anschließend aufgerufene Skripte; kann diesen gegenüber also eine veränderte Benutzerkonfiguration simulieren.
• Auf das bei angemeldeten Benutzern auf dem Server hinterlegte Profil hat das keinen Einfluss.
• Für Änderungen des Profils auf dem Server müssen API-Funktionen benutzt werden. Es bietet sich .saveOption() bzw. .saveOptions() an.

Seit MW 1.18 ist mit mw.user.tokens.get("editToken") der für automatisierte Bearbeitung per API erforderliche editToken verfügbar, ohne dass zuvor eine gesonderte Abfrage mit Ajax vorgenommen werden muss.

Liste möglicher Optionsbezeichner:

• ccmeonemails
• centralnotice-display-campaign-type-advocacy
• centralnotice-display-campaign-type-advocacy-local-exception
• centralnotice-display-campaign-type-article-writing
• centralnotice-display-campaign-type-article-writing-local-exception
• centralnotice-display-campaign-type-event
• centralnotice-display-campaign-type-event-local-exception
• centralnotice-display-campaign-type-fundraising
• centralnotice-display-campaign-type-fundraising-local-exception
• centralnotice-display-campaign-type-governance
• centralnotice-display-campaign-type-governance-local-exception
• centralnotice-display-campaign-type-photography
• centralnotice-display-campaign-type-photography-local-exception
• cirrussearch-default
• cirrussearch-pref-completion-profile
• compact-language-links
• cx
• cols
• contextchars
• contextlines
• date – Datumsformat
• diffonly
• disablemail
• disablesuggest
• echo-**** Echo
• editfont
• editondblclick
• editsection
• editsectiononrightclick
• editwidth
• email-allow-new-users
• enotifminoredits
• enotifrevealaddr
• enotifusertalkpages
• enotifwatchlistpages
• extendwatchlist
• externaldiff
• externaleditor
• fancysig
• fileexporter
• flaggedrevseditdiffs
• flaggedrevssimpleui
• flaggedrevsstable
• flaggedrevsviewdiffs
• forceeditsummary
• gadget-**** siehe unten
• gender
• gettingstarted-task-toolbar-show-intro
• hideminor
• hidepatrolled
• highlightbroken
• imagesize
• justify
• language
• math
• math-enable-visualeditor
• minordefault
• multimedia-viewer
• multimediaviewer-enable
• newpageshidepatrolled
• nickname
• nocache
• noconvertlink
• norollbackdiff
• numberheadings
• popups
• prefershttps
• previewonfirst
• previewontop
• quickbar
• rcdays
• rcenhancedfilters-disable
• rcfilters-wl-collapsed
• rcfilters-wl-saved-queries
• rclimit
• rememberpassword
• revisionslider-disable
• rows
• searchNs0 searchNs1 … searchNs9 … searchNs100
• searchlimit
• showhiddencats
• showjumplinks
• shownumberswatching
• showtoc
• showtoolbar
• skin
• stubthreshold
• thumbsize
• timecorrection
• twocolconflict
• uls-compact-links
• uls-preferences
• underline
• usebetatoolbar
• usebetatoolbar-cgd
• usecodeeditor
• usecodemirror
• useeditwarning
• uselivepreview
• usenewrc
• user.tokens
• variant
• variant-**   -gan -iu -kk -ku -shi -sr -tg -uz -zh
• vector-collapsiblenav
• vector-simplesearch
• visualeditor-autodisable
• visualeditor-betatempdisable
• visualeditor-diffmode-historical
• visualeditor-enable
• visualeditor-enable-experimental
• visualeditor-hidebetawelcome
• visualeditor-hideusered
• watchcreations
• watchdefault
• watchdeletion
• watchlistdays
• watchlisthideanons
• watchlisthidebots
• watchlisthideliu
• watchlisthideminor
• watchlisthideown
• watchlisthidepatrolled
• watchlisttoken
• watchmoves
• wlenhancedfilters-disable
• wlenhancedfilters-seen-tour
• wllimit

Die Gadgets („Helferlein“) werden teilweise dynamisch durch die Module registriert; ist das Helferlein in den Benutzereinstellungen nicht aktiviert, so wäre dann die Optionsvariable undefiniert (undefined):

• gadget-bkl-check
• gadget-contribsrange
• gadget-Doppel-s-Schreibung
• gadget-editsection-left
• gadget-editsection-right
• gadget-Einleitung-bearbeiten
• gadget-Extra-Editbuttons
• gadget-HotCat
• gadget-markAdmins
• gadget-navigation-popups
• gadget-PB
• gadget-Personendaten
• gadget-Pfeil-hoch
• gadget-Rechtschreibpruefung
• gadget-revisionCounter
• gadget-revisionjumper
• gadget-Rot-Gruen-Sehschwaeche
• gadget-Screenreader-Optimierung
• gadget-Suchfokus-Hauptseite
• gadget-toolserver-integration
• gadget-Vorlagenmeister
• gadget-wikEd
• gadget-Zeitzonenkonverter

Beta-Features wechseln regelmäßig; etwa:

• betafeatures-geonotahack

Im Prinzip können Benutzerskripte auch selbst ausgedachte Werte in der Struktur mw.user.options.values registrieren. Allerdings wird diese möglicherweise auf den serverseitigen Zustand zurückgesetzt, wenn Benutzer ihre Präferenzen verändern. Eine dauerhafte Speicherung der Werte auf dem Server (und damit zwischen Seiten und Sitzungen verfügbar) ist zurzeit nicht vorgesehen. Es empfiehlt sich deshalb nicht, außerhalb der über die Spezialseite Einstellungen verfügbaren Werte hier eigene Werte abzulegen. Nicht von MediaWiki bereitgestellte Skripte sollten besser über mw.libs konfiguriert werden oder völlig andere Wege gehen.