Wikipedia:Technik/Skin/JS/Variablen
From Wikipedia, the free encyclopedia
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“.[1]
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.
Weitere Abfrage:
mw.config.exists("Name")- Informiert, ob Name definiert ist.
- Zu erweiterten Möglichkeiten siehe mw.Map.[2]
Alle Parameter stehen auf der HTML-Quelltext-Seite.[3]
Die nachstehende Tabelle gibt stabile und umsetzbare Werte wieder.
| Bezeichner | Erläuterung |
|---|---|
| Projektspezifisch | |
wgDBname |
dewiki – deutschsprachige Wikipediamehr … |
wgSiteName |
WikipediaProjektname in der Landessprache, könnte auch „Wikipédia“ oder „Vikipedi“ heißen.[4] |
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: |
| Seitenspezifisch | |
wgArticleId | 6606385(Bei Spezialseiten und Bildern, die von Commons geladen werden, gilt wgArticleId === 0) |
wgTitle | Technik/Skin/JS/VariablenMenschenfreundliche Form (nicht URL-fähig: Leerzeichen) Ohne Namensraum! |
wgPageName | Wikipedia:Technik/Skin/JS/VariablenBedingt URL-fähig[5] |
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.[6] |
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[7] |
wgPageViewLanguage | Seitenansichtssprache; Mischung aus Seiteninhaltssprache unter den Bedingungen einer Benutzersprache (mehrsprachige Wikis) |
wgWikibaseItemId | { wgWikibaseItemId: "Q83" }Nur bei |
wgIsRedirect | true – Diese Seite enthält #REDIRECT usw.false – Diese Seite ist keine WeiterleitungNicht zu verwechseln mit wgRedirectedFrom |
| Situationsabhängig | |
wgIsArticle | true – Feste Seite nur ansehen (view, auch diffpage); keine Spezialseitefalse – Generierte Spezialseite oder Aktivität am Artikel: Editieren, Änderungen, Vorschau |
wgAction | view – Seite nur ansehen oder Spezialseite; auch Versionsvergleichedit – Seite öffnen zur Bearbeitung[8]submit – Vorschau, Änderungen (, Speichern→view)[8]history – Versionsgeschichteinfo – Informationen zur Seitewatch – Zur Beobachtungsliste hinzugefügt (Bestätigung)parsermigration-edit – MigrationswerkzeugAusführlich zu action unter Hilfe:URL-Parameter #action. |
wgRestrictionEdit | Individueller Schutzstatus einer bearbeiteten Seite[9] |
wgRestrictionMove | Individueller Schutzstatus einer Seite[9] |
wgIsProbablyEditable | (?) nicht vor aktuellem Benutzer geschützt, keine Spezialseite, kein Flow |
wgPostEdit | "saved" (früher: 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. |
wgRelevantPageIsProbablyEditable | false / true |
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 | monobookSkin; ein Wert aus cologneblue minerva modern monobook vector vector-2022 |
wgUserName | PerfektesChaosnull 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 |
wgUserIsTemp | angemeldet (ab 2024)? false / true |
wgUserFirstRegistration | 1146555091000[10] |
wgUserRegistration | [seit etwa 2006 registriert] 17626593926000[10] |
wgUserGroups | ["autoreview", "editor"][ "*", "temp" ] für temporary user (ab 2024) |
wgGlobalGroups | Aktive globale Benutzergruppen. global-sysop wäre nur in „Kleinen Wikis“ aktiv. |
| Darf API lesend benutzen. | |
| Darf API schreibend benutzen. | |
wgUserId | Numerische ID des eigenen Benutzerkontos |
wgUserEditCount | Anzahl der eigenen Bearbeitungen (einschließlich gelöschte)
|
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.
|
| Echo | |
wgEchoConfig | Globaler Namensraum, nicht über mw.config.get() DOM-Object einer <tr> tür Echo.
|
wgEchoHelpPage | URL zur Hilfeseite |
wgEchoOverlayConfiguration | { notification-count="1", max-notification-count=99 }
|
wgUserNewMsgRevisionId | oldid der letzten gelesenen eigenen Diskussionsseite, wenn es fremde Beiträge darauf gibt.[11]
|
| Webserver | |
wgServer | //de.wikipedia.org[12][13] |
wgArticlePath | /wiki/$1[13][14] |
wgScript | /w/index.php[13] |
weggefallen; ".php" | |
wgScriptPath | /w[13] |
weggefallen; /w/load.php (2015: //bits.wikimedia.org/de.wikipedia.org/load.php)[15]
| |
stylepath | /w/skins |
wgExtensionAssetsPath | /skins/extensions |
| Lokalisierung[16] | |
wgDefaultDateFormat | "dmy" Projektstandard[17] |
wgDigitTransformTable | [ "", "" ] wichtig für arabisch-basierte Sprachen |
wgMonthNames | [ "", "Januar", … ] Weil nicht (mehr) verwendet, soll die Bereitstellung künftig wegfallen: phab:T219340 – |
| [ "", "Jan.", … ] 2020 weggefallen: phab:T219340 – | |
wgSeparatorTransformTable | [ ",Tab.", ".Tab," ] |
wgTranslateNumerals | true |
| Nur auf Special:Upload | |
| wgCheckFileExtensions | true |
| wgFileCanRotate | true |
| wgFileExtensions | [ "png", "gif", … ] War bis 2015 auf allen Seiten verfügbar gewesen; nunmehr nur noch auf Special:Upload. |
| wgMaxUploadSize | { file: 104857600, "*": 5368709120 } |
| wgStrictFileExtensions | true |
| wgUploadAutoFill | true |
| wgUploadSourceIds | [ "wpUploadFile" ] |
| Details der Projektkonfiguration | |
| { cologneblue:"CologneBlue", modern:"Modern", monobook:"MonoBook", vector:"Vector", timeless: "Timeless", minerva: "MinervaNeue", fallback: "Fallback", apioutput: "ApiOutput" } | |
wgAjaxLicensePreview | true |
wgCheckUserClientHintsHeadersJsApi | [ "brands", "architecture", "bitness", "fullVersionList", "mobile", "model", "platform", "platformVersion" ] |
wgCiteReferencePreviewsActive | true / false |
wgCitoidConfig | { citoidServiceUrl:"//citoid.wikimedia.org/api"} (Citoid) |
weggefallen; früher true wenn Projekt CodeMirror unterstützt | |
weggefallen; dewikiTypischerweise identisch wgDBname, aber nicht zwingend; bei der Bildung der cookie-Namen vorangestellt | |
| weggefallen; (string) leer für "dewiki" | |
weggefallen; / | |
weggefallen; 2592000Sekunden entsprechend 30 Tagen | |
wgEditSubmitButtonLabelPublish | true |
wgEventLoggingBaseUri | "//de.wikipedia.org/beacon/event" |
wgFlaggedRevsParams | { tags: { accuracy: {…} } |
wgGuidedTourHelpGuiderUrl | Help:Geführte Touren/Guider |
wgIllegalFileChars | ":/\" |
wgLegalTitleChars | " %!"$&'()*,\-./0-9:;=?@A-Z\\\^_`a-z~+\u0080-\uFFFF" |
| weggefallen; "Wikipedia:Hauptseite" | |
wgMediaViewerEnabledByDefault | true |
wgMediaViewerOnClick | false |
wgNoticeProject |
wikipedia – generiert durch CentralNotice |
wgPopupsFlags | 0 |
weggefallen; zuletzt: ["mediawiki.legacy.wikibits"] (wikibits). | |
weggefallen; zuletzt: 2000 oder anders. | |
wgSearchType | "CirrusSearch" seit Mitte November 2014; zuvor: "LuceneSearch" |
wgUrlProtocols | https\:\/\/|ftp\:\/\/|irc\:\/\/| … |
wgVector2022LanguageInHeader | false |
wgVersion | 1.46.0-wmf.19 |
wgVisualEditor | { pageLanguageCode: "de-x-formal", pageLanguageDir: "ltr", pageVariantFallbacks: "de-formal" } |
| 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. Nunmehr Wert von wgHostname: "mw-web.eqiad.canary-d6f885b86b-fh4vc" |
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. |
wgRequestId | "908706d4-dda2-4453-9289-42d279f9c4b9" |
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.country | " DE" usw.; zumindest mutmaßliches Staatsgebiet des Benutzers; Standort des InternetprovidersGeo könnte null oder kein Objekt sein[18] |
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 Zufallszahlmw.user.isAnon()–truewenn keinwgUserName, sonstfalsemw.user.getName()→wgUserNamemw.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.[2]
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.[3]
Ä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. - Wenn der Bezeichner mit
userjs-beginnt, können bis zu 100 durch Gadgets und Benutzerskripte generierte Optionen hinterlegt und abgefragt werden.[19]
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:[20]
advancedsearch-disablebetafeatures-auto-enrollcampaignevents-allow-invitationsccmeonemailscentralnotice-display-campaign-type-advocacycentralnotice-display-campaign-type-advocacy-local-exceptioncentralnotice-display-campaign-type-article-writingcentralnotice-display-campaign-type-article-writing-local-exceptioncentralnotice-display-campaign-type-eventcentralnotice-display-campaign-type-event-local-exceptioncentralnotice-display-campaign-type-fundraisingcentralnotice-display-campaign-type-fundraising-local-exceptioncentralnotice-display-campaign-type-governancecentralnotice-display-campaign-type-governance-local-exceptioncentralnotice-display-campaign-type-photographycentralnotice-display-campaign-type-photography-local-exceptioncheckuser-temporary-account-enablecheckuser-userinfocard-enablecirrussearch-defaultcirrussearch-pref-completion-profilecodemirror-beta-feature-enablecompact-language-linkscolscontextcharscontextlinescxcx-enable-entrypointscx-entrypoint-fd-statuscx_campaign_newarticle_showndate– Datumsformat[17]date-local-exceptiondiffonlydiff-typedisablemaildisablesuggestdiscussiontools-autotopicsubdiscussiontools-betaenablediscussiontools-editmodediscussiontools-newtopictooldiscussiontools-newtopictool-createpagediscussiontools-replytooldiscussiontools-showadvanceddiscussiontools-sourcemodetoolbardiscussiontools-topicsubscriptiondiscussiontools-visualenhancementsdisplayquicksurveysecho-**** Echoeditfonteditondblclickeditsectiononrightclickeditrecoveryeditsectioneditsectiononrightclickeditwidthemail-allow-new-usersenotifminoreditsenotifrevealaddrenotifusertalkpagesenotifwatchlistpageseventlogging-display-consoleextendwatchlistexternaldiffexternaleditorfancysigfileexporterflaggedrevseditdiffsflaggedrevssimpleuiflaggedrevsstableflaggedrevsviewdiffsforceeditsummaryforcesafemodegadget-**** siehe untengendergettingstarted-task-toolbar-show-introgrowthexperiments-****hidecategorizationhideminorhidepatrolledhighlightbrokenhomepage_mobile_discovery_notice_seenimagesizeipinfo-beta-feature-enableipinfo-use-agreementjustifylanguagemathmath-popupsmath-enable-visualeditormf_amc_optinminordefaultminerva-thememobile-editormultimedia-viewermultimediaviewer-enablenewpageshidepatrollednicknamenocachenoconvertlinknorollbackdiffnumberheadingsparsermigrationparsermigration-parsoid-readviewspopupspopups-local-exceptionpopups-reference-previewsprefershttps[21]previewonfirstpreviewontoppst-cssjsquickbarrcdaysrcenhancedfilters-disablercfilters-wl-collapsedrcfilters-wl-saved-queriesrclimitrcshowwikidatareadinglists-web-ui-enabledrealme-urlsrememberpasswordrequireemailrevisionslider-disablerowssearch-match-redirectsearchNs0searchNs1…searchNs9…searchNs100searchlimitsearch-special-pagesearch-thumbnail-extra-namespacesshowhiddencatsshowjumplinksshownumberswatchingshowrollbackconfirmationshowtocshowtoolbarskinskin-local-exceptionskin-responsivestubthresholdtemplatedata-favorite-templatesthumbsizetimecorrectiontwl-notifiedtwocolconflicttwocolconflict-enableduls-compact-linksuls-preferencesunderlineusebetatoolbarusebetatoolbar-cgdusecodeeditorusecodemirrorusecodemirror-colorblinduseeditwarninguselivepreviewusenewrcuserjs-***user.tokensvariantvariant-** -gan -iu -kk -ku -shi -sr -tg -uz -zhvector-appearance-pinnedvector-collapsiblenavvector-font-sizevector-limited-widthvector-main-menu-pinnedvector-page-tools-pinnedvector-simplesearchvector-themevector-toc-pinnedvisualeditor-autodisablevisualeditor-betatempdisablevisualeditor-betatempdisable-local-exceptionvisualeditor-collabvisualeditor-diffmode-historicalvisualeditor-editorvisualeditor-enablevisualeditor-enable-experimentalvisualeditor-hidebetawelcomevisualeditor-hidetabdialogvisualeditor-hideuseredvisualeditor-newwikitextvisualeditor-tabswatchcreationswatchcreations-expirywatchdefaultwatchdefault-expirywatchdeletionwatchlistdayswatchlisthideanonswatchlisthidebotswatchlisthidecategorizationwatchlisthideliuwatchlisthideminorwatchlisthideownwatchlisthidepatrolledwatchlistreloadautomaticallywatchlisttokenwatchlistunwatchlinkswatchmoveswatchrollbackwatchrollback-expirywatchstar-expirywatchuploadswlenhancedfilters-disablewlenhancedfilters-seen-tourwllimitwlshowwikibase
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-checkgadget-contribsrangegadget-createNewSectiongadget-Doppel-s-Schreibunggadget-easyNewSectiongadget-editMenusgadget-editsection-leftgadget-editsection-rightgadget-Einleitung-bearbeitengadget-Erweiterte-Navigationsleiste-Quicklinksgadget-Extra-Editbuttonsgadget-HotCatgadget-markAdminsgadget-navigation-popupsgadget-navileisteAutocollapsegadget-OpenStreetMapgadget-PBgadget-PermaPageLinkgadget-Personendatengadget-Pfeil-hochgadget-PrettyLoggadget-Rechtschreibpruefunggadget-revisionCountergadget-revisionjumpergadget-rightsfiltergadget-Rot-Gruen-Sehschwaechegadget-Screenreader-Optimierunggadget-Suchfokus-Hauptseitegadget-toolserver-integrationgadget-Vorlagenmeistergadget-wikEdgadget-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 nicht vorgesehen (bis auf userjs-). 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.