Cowboy: Die Seite wurde neu angelegt: „{{../../!header |Text=Gadgets (Helferlein)}} '''Gadgets''' (in der deutschsprachigen Wikipedia meist '''Helferlein''' genannt) sind Hilfsmittel für die Benutzeroberfläche, die angemeldet über die Einstellungen jederzeit individuell zu- oder abgewählt werden können. Außerdem gehören dazu Komponenten, die das Verhalten der Seiten in dieser Wikipedia beeinflussen, ohne dass sie einer individuellen Konfiguration zugänglich sind…“

2026-07-30T15:48:34Z

Die Seite wurde neu angelegt: „{{../../!header |Text=Gadgets (Helferlein)}} '''Gadgets''' (in der deutschsprachigen Wikipedia meist '''Helferlein''' genannt) sind Hilfsmittel für die Benutzeroberfläche, die angemeldet über die Einstellungen jederzeit individuell zu- oder abgewählt werden können. Außerdem gehören dazu Komponenten, die das Verhalten der Seiten in dieser Wikipedia beeinflussen, ohne dass sie einer individuellen Konfiguration zugänglich sind…“

Neue Seite

{{../../!header
|Text=Gadgets (Helferlein)}}
'''Gadgets''' (in der deutschsprachigen Wikipedia meist '''Helferlein''' genannt) sind Hilfsmittel für die Benutzeroberfläche, die angemeldet über die [[Hilfe:Einstellungen|Einstellungen]] jederzeit individuell zu- oder abgewählt werden können. Außerdem gehören dazu Komponenten, die das Verhalten der Seiten in dieser Wikipedia beeinflussen, ohne dass sie einer individuellen Konfiguration zugänglich sind.

Diese Projektseite beschreibt für Programmierer und Administratoren die technischen und organisatorischen Angelegenheiten.

Das aktuelle Angebot für die angemeldeten Benutzer ist auf {{Benutzer-Einstellung|gadgets}} dargestellt.

== Benutzereinstellungen ==
* Die Einbindung durch Benutzer ist einfach möglich, indem das gewünschte Gadget in der {{Benutzer-Einstellung|gadgets}} ausgewählt wird.
* Die jeweils aktuell verfügbaren Helferlein werden dort thematisch gruppiert angezeigt.
* Gadgets werden immer in der aktuellen Form eingebunden (jede Veränderung bekommt eine unterschiedliche [[Uniform Resource Locator|URL]]); Leeren des [[Cache|Browser-Cache]] ist deshalb nach Veränderungen nicht erforderlich.

=== Gelegentliches Laden ===
Wenn ein Helferlein nicht bei jedem Aufruf einer Seite geladen werden soll, sondern etwa nur in bestimmten [[Hilfe:Namensräume|Namensräumen]], nicht beim Bearbeiten der Seite oder unter sonstigen benutzerdefinierten Bedingungen, dann lässt sich das im [[../JS|Benutzer-JS]] veranlassen wie [[#loader.load|unten]] angegeben.

=== Nicht angemeldete Benutzer ===
Nicht angemeldete Benutzer können die Helferlein ebenfalls nutzen, indem sie die Ressourcen mittels [[CowboysWiki:Technik/Browser/Greasemonkey|Greasemonkey/Browser-Skript]] laden wie [[#loader.load|unten]] angegeben.

Als [[#Opt-out|Opt-out markierte Helferlein]] lassen sich jedoch nicht abschalten.

=== Name der Einstellung ===
Jede Einstellung im Benutzerprofil hat einen Namen; für ein Gadget lautet er:
<div style="margin-left: {{WikiLayout|indent}}">
<code>gadget-</code>''[[#Bezeichner|Bezeichner]]''
</div>

== Arten ==
Es gibt für ein Gadget die Möglichkeit, [[JavaScript]] einzubinden (der häufigste Fall) und dies auch mit [[Cascading Style Sheets|CSS]] zu kombinieren oder ein reines CSS-Gadget zu definieren.

== Management und Vorschläge ==
Nur eine kleine Auswahl von besonders häufig benötigten Werkzeugen kann allen Benutzern angeboten werden.
* Vorschläge für gut dokumentierte, sichere und erprobte Skripte können auf [[CowboysWiki:Technik/Skin/MediaWiki/Änderungen]] gemacht werden.

Beim Gadget übernimmt die Gemeinschaft eine Mitverantwortung für die ordnungsgemäße Funktion.
* Eine Veränderung ist nur durch [[CowboysWiki:Benutzeroberflächenadministratoren|Benutzeroberflächenadministratoren]] möglich.
* Die Funktion muss für eine große Zahl von Benutzern sinnvoll sein. Ansonsten werden Definitionsseite und Einstellungen zu unübersichtlich, und Wartung und Pflege sind kaum noch zu leisten.
* Sind ursprüngliche Autoren nicht mehr aktiv, versuchen andere Programmierer die Funktionalität zu erhalten. Das ist nur in begrenztem Umfang möglich.

== Spezialseite ==
Auf der [[Hilfe:Spezialseiten|Spezialseite]] [[Spezial:Helferlein]] kann unmittelbar auf den Quellcode aller Helferlein zugegriffen werden, und es werden die Kurzbeschreibungen wie auf der Benutzereinstellungsseite angezeigt.

Außerdem werden Einzelheiten aus der [[#Definitionsseite|Definitionsseite]] angegeben, also ob das Helferlein [[../JS/ResourceLoader|andere Module benötigt]], ob es standardmäßig für alle Benutzer aktiviert ist und ob spezielle Berechtigungen erforderlich sind (heißt: nur für Administratoren gedacht).

Schließlich gibt es zu jedem Helferlein ein Link „Export“, das im [[Extensible Markup Language|XML]]-Format die Kurzbeschreibung usw. sowie die beteiligten Quellcodes in einer Datei zusammenfasst. Das ist dazu gedacht, das Gadget möglichst einfach in einem anderen Wiki-Projekt importieren zu können.

== ResourceLoader ==
Jedes [[../JS/ResourceLoader|Modul]] für ein Gadget hat folgenden Namen:
<div style="margin-left: {{WikiLayout|indent}}">
<code>ext.gadget.</code>''[[#Bezeichner|Bezeichner]]''
</div>
Zum Modul gehören alle Seiten (Systemnachrichten: [[../MediaWiki/Ressourcen/]]), die in der entsprechenden Anweisung auf der [[#Definitionsseite|Definitionsseite]] in die [[#resources|Liste]] aufgenommen wurden. Systemnachrichten ohne diese Definition werden nicht erkannt.

=== Bezeichner ===
Die Gadget-Bezeichner müssen mit einem Buchstaben (<code>[A-Za-z]</code>) beginnen, gefolgt von jeder Zahl von Buchstaben, Ziffern (<code>[0-9]</code>), gegliedert durch Bindestrich (<code>-</code>), Unterstrich (<code>_</code>), Doppelpunkt (<code>:</code>) und Punkt (<code>.</code>).

Zwar ist es nicht ausdrücklich ausgeschlossen und könnte wahrscheinlich funktionieren, aber aus zahlreichen Kompatibilitätsgründen bei der Nutzung durch JavaScript-Anweisungen und für gut lesbare URL beschränkt man sich auf den [[American Standard Code for Information Interchange|ASCII]]-Zeichensatz und verzichtet auf Umlaute usw. Die Bildung der Kodierung nach [[UTF-8]] kann zu unterschiedlichen Bezeichnern an irgendeiner Stelle führen. Unterstreichungstriche verhindern einfache eindeutige Abschnittsüberschriften bei der Beschreibung. Ohne Bindestriche (<code>-</code>) lassen sich ggf. eindeutigere Suchausdrücke und weitere Nutzungen erreichen.

Zu jedem Gadget-Bezeichner sollen Administratoren eine textliche [[../MediaWiki/Systemnachrichten|Systemnachricht]] als Wikitext anlegen, welche in einem Satz die Funktion erläutert. Sie wird bei den Einstellungen des Kontos und auf der [[#Spezialseite|Spezialseite]] dargestellt und solte, soweit vorhanden, die Dokumentation zu diesem Gadget verlinken.

Die Systemnachricht wird auf <code>MediaWiki:Gadget-</code>''Bezeichner'' hinterlegt.

Die Systemnachrichten können auch als Unterseite <code>/en</code> eine englischsprachige usw. Version anbieten.

=== {{Anker|loader.load}} Manuelles Laden ===
Alle JavaScript- und CSS-Ressourcen eines Gadgets lassen sich auf einmal in der aktuellen Version laden.
* Nicht ausgewertet werden dabei die in der Gadget-Definition spezifizierten Einschränkungen.

==== Aus dem eigenen Projekt heraus ====
<code>[[../JS/ResourceLoader#.loader.load()|mw.loader.load]]( "ext.gadget.</code>''[[#Bezeichner|Bezeichner]]''<code>" );</code>

==== Aus jedem anderen Wiki heraus ====
<code>[[../JS/ResourceLoader#.loader.load()|mw.loader.load]]( "https:<nowiki />//de.wikipedia.org/w/load.php?modules=ext.gadget.</code>''[[#Bezeichner|Bezeichner]]''<code>" );</code>
* Beachte das ausführende PHP-Skript <code>load.php</code> – sonst stünde <code>index.php</code> an dieser Stelle.

== Definitionsseite ==
Die wirksame Definition im Wiki erfolgt über die Seite [[MediaWiki:Gadgets-definition]], die nur von [[CowboysWiki:Benutzeroberflächenadministratoren|Benutzeroberflächenadministratoren]] geändert werden kann.

Gadgets sollten so programmiert sein, dass sie nicht vom Eintrag in der Definitionsseite abhängig sind, sondern auch alleinstehend gestartet werden können. Zum einen ist das für die Entwicklung und zum Testen sinnvoll; zum anderen erlaubt das auch dynamische Zugriffe nur unter bestimmten Bedingungen, etwa nur in bestimmten Namensräumen.

Diese Definitionsseite selbst kann ganz normal angesehen werden. Innerhalb der daraus resultierenden [[Spezial:Einstellungen #mw-prefsection-gadgets]] sind jedoch keinerlei projektdefinierte CSS- oder JS-Ressourcen wirksam.

=== {{Anker|format}} Format des Eintrags ===

Jeder Eintrag für ein Gadget hat die Form:
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
'''<code>*</code>''' ''[[#Bezeichner|Bezeichner]]''<code>|</code>''Quellcode1''<code>|</code>''Quellcode2''
</div>
* Eine Systemnachricht <code>MediaWiki:Gadget-</code>''Bezeichner'' muss als Wikitext eine Kurzbeschreibung enthalten, die auf der Benutzereinstellungsseite angezeigt wird.
Die Definition kann mit Optionen versehen werden:
Jeder Eintrag für ein Gadget hat die Form:
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
'''<code>*</code>''' ''Bezeichner''<code>[</code>''Optionsliste''<code>]|</code>''Quellcode-Liste''
</div>
* Dabei ist ''[[#Optionsliste|Optionsliste]]'' eine durch <code>|</code> gegliederte Aufzählung von Optionen; ''Beispiel:''
*: <code>[ResourceLoader|dependencies=mediawiki.util]</code>
*:* Geeignet für [[#RLability|Einbindung mittels ResourceLoader]].
*:* Hängt vom Modul [[../JS/mw#.util|{{Hilfe/tt|1=mediawiki.util}}]] ab, das vor dem Start geladen worden sein sollte.
* An Pipes und Kommata sind Leerzeichen zulässig.

=== {{Anker|resources}} Liste der Quellcode-Ressourcen ===
Auf den Bezeichner und möglicherweise die Optionsliste folgt die Liste der Verweise auf Quellcode-[[../MediaWiki/Ressourcen/]] (Systemnachrichten).
* Die Liste sollte möglichst auf eine Seite für JS und eine für CSS beschränkt bleiben, um den Überblick nicht zu verlieren.
* Deshalb sollten sie auch denselben Bezeichner verwenden:
*: <code>*</code> ''Bezeichner''<code>|</code>''Bezeichner''<code>.js|</code>''Bezeichner''<code>.css</code>
Gemeinsame Bibliotheksressourcen sind in der deutschsprachigen Wikipedia kaum vorhanden, ließen sich aber ohne eigenständiges Gadget als „Systemnachricht“ definieren und auflisten.
* Im Prinzip sind somit auch weitere Seiten und Unterseiten möglich. Ein JavaScript-Gadget könnte sie aber auch selbst [[#loader.load|nachladen]]. Das müsste es ohnehin automatisch machen, wenn die Ressourcen noch nicht geladen sind, damit es getestet und außerhalb der Gadget-Automatik eingesetzt werden kann. Weitere Ressourcen sind möglicherweise nicht immer erforderlich und müssten nur bei tatsächlichem Bedarf nachgefordert werden.
Jedem Quellcode-Verweis wird <code>MediaWiki:Gadget-</code> zur Bildung des Seitennamens vorangestellt.

=== {{Anker|RLability}} ResourceLoader ===
Geeignet für Einbindung mittels [[../JS/ResourceLoader|ResourceLoader]].
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[ResourceLoader]</code>
</div>
Die Quellcodes werden nicht einfach aus den Mediawiki-Seiten geladen, sondern es werden automatisch Pakete daraus gebildet und diese versioniert.

''Achtung:'' Die Paketbildung setzt voraus, dass die Programmierung auf einem modernen Stand ist.
* Die JavaScript-Einheiten werden [[../JS/Datenelemente#wiki scope|gekapselt]].
* Das hat zur Folge, dass angebotene Funktionsaufrufe über das globale Objekt angeboten werden müssen, also <code>window</code> oder besser {{Hilfe/tt|1=[[../JS/mw/libs|mw.libs]]}} verwenden.
* Deklarationen über <code>var</code> und Funktionsdeklarationen haben nur lokale Wirkung.

=== Optionsliste ===

==== {{Anker|dependencies{{=}}}} Abhängigkeiten ====
Durch Kommata getrennte Liste von [[../JS/ResourceLoader|Modulen]] (MW-Standard-Module).
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[ResourceLoader|dependencies=</code>''Liste von Modulen''<code>]</code>
bzw. angehängtes
* <code>|ResourceLoader|dependencies=</code>''Liste von Modulen''
in einer vorhandenen Optionsliste.
* Die Option [[#RLability|{{Hilfe/tt|1=ResourceLoader}}]] muss in der Optionsliste vorhanden sein.
</div>
Um ein Gadget jedoch universell nutzen zu können und bereits für die Entwicklungsphase ist es sinnvoll, wenn auch intern das Vorhandensein erforderlicher Module geprüft und bei deren Fehlen das Nachladen veranlasst wird.

Das Laden in Standardsituationen kann jedoch effizienter gestaltet werden, wenn von vornherein sichergestellt ist, dass benötigte Module in demselben Paket ausgeliefert werden.

''Achtung:'' Die beiden fundamentalen Module <code>mediawiki</code> und <code>jquery</code> dürfen ''niemals'' als Abhängigkeiten aufgeführt werden, da es sonst zu einer ''[[Deadlock (Informatik)|deadlock]]''-Situation kommt.

Die Anforderung eines nicht existierenden Moduls (womöglich falsch geschriebenen Modulnamens) führt nur zu einem einfachen Fehler mit begrenzten Auswirkungen.

==== {{Anker|skins{{=}}}} Skins ====
Durch Kommata getrennte Liste von Skin-Bezeichnern, wie etwa: <code>cologneblue modern monobook vector</code>
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[skins=</code>''Liste von Skin-Bezeichnern''<code>]</code>
bzw. angehängtes
* <code>|skins=</code>''Liste von Skin-Bezeichnern''
in einer vorhandenen Optionsliste.
</div>
Die Präsentation des Gadgets auf der Einstellungsseite wird auf solche Benutzer beschränkt, die momentan eine dieser Skins aktiviert haben. Die Einstellungswirkung des Gadgets bleibt nach einem Skin-Wechsel jedoch erhalten; es wird allerdings nicht ausgeführt, solange keine geeignete Skin vom Benutzer gewählt wurde.

Die Präsentation ist intransparent; die fortbestehende Wirkung nach der Rückkehr zu dieser Skin würde kaum bemerkt werden. Gadgets sollten sowohl in JS wie CSS die momentan aktive Skin abfragen, wenn Einschränkungen bestehen, und darauf dynamisch reagieren. Die Deklaration dieser Option ist zu vermeiden. Es kann in Kauf genommen werden, Gadgets überflüssigerweise zu laden, die von den Benutzern zwar aktiviert wurden, selbst wenn zwischenzeitlich eine andere Skin ausgewählt wurde.

==== {{Anker|default}} Opt-out ====
Seit MW 1.18 gibt es die Möglichkeit, ein Gadget standardmäßig als ''opt-out'' zu vereinbaren. Es wird dann bei allen nicht angemeldeten Benutzern ausgeführt, und angemeldete Benutzer müssen es explizit deaktivieren.
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[default]</code>
bzw. angehängtes
* <code>|default</code>
in einer vorhandenen Optionsliste.
</div>

==== {{Anker|rights{{=}}}} Benutzerrechte ====
Durch Kommata getrennte Liste von Kennwörtern für ein Benutzerrecht (keine Benutzer''gruppen'' wie etwa <code>sysop</code>). Damit kann die Präsentation des Gadgets auf der Einstellungsseite auf solche Benutzer beschränkt werden, die alle diese Rechte haben. Praktisch wird es auf die Administratoren hinauslaufen.
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[rights=</code>''Liste von Benutzerrechten''<code>]</code>
bzw. angehängtes
* <code>|rights=</code>''Liste von Benutzerrechten''
in einer vorhandenen Optionsliste.
</div>

Im Prinzip handelt es sich um eine Komma-getrennte Liste; alle aufgezählten Rechte müssen gleichzeitig vorliegen. Praktisch kommt es durch den Pyramidenaufbau der Rechte wohl kaum dazu, dass mehr als ein Recht anzugeben wäre.

==== {{Anker|actions{{=}}}} Aktionen ====
Durch Kommata getrennte Liste von Kennwörtern für eine [[Hilfe:URL-Parameter#action|Aktion]] (<code>view</code>, <code>edit</code>, <code>history</code>, etc). Falls angegeben, wird das Helferlein nur bei der/den angegebenen Seitenaktion(en) ausgeführt. <code>edit</code> schließt <code>submit</code> ein. (seit Anfang 2022)
* Vorgabe ist: ''immer''.
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[actions=</code>''Liste von Aktionen''<code>]</code>
bzw. angehängtes
* <code>|actions=</code>''Liste von Aktionen''
in einer vorhandenen Optionsliste.
</div>

==== {{Anker|namespaces{{=}}}} Namensräume ====
Durch Kommata getrennte Liste von [[Hilfe:Namensräume|Namensraum-Nummern]] (seit Herbst 2023).
* Vorgabe ist: ''alle''.
* Beispiel für typische Foren: <code>1,3,4,5,7,9,11,13,15,100,101</code>

<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[namespaces=</code>''Liste von Namensraum-Nummern''<code>]</code>
bzw. angehängtes
* <code>|namespaces=</code>''Liste von Namensraum-Nummern''
in einer vorhandenen Optionsliste.
</div>

==== {{Anker|contentModels{{=}}}} Inhaltsmodelle ====
Durch Kommata getrennte Liste von [[../../MediaWiki/Content Model|Inhaltsmodellen]] (seit Herbst 2023).
* Vorgabe ist: ''alle''.
* Beispiel für Ressourcen: <code>css,javascript,json</code>

<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[contentModels=</code>''Liste von Inhaltsmodellen''<code>]</code>
bzw. angehängtes
* <code>|contentModels=</code>''Liste von Inhaltsmodellen''
in einer vorhandenen Optionsliste.
</div>

Auch eine Seite mit Code in einer Programmiersprache kann anteilig Wikitext einblenden, was möglicherweise zusätzlich <code>wikitext</code>-Ressourcen bedarf. Eine Beschränkung auf <code>wikitext</code> könnte deshalb auf Seiten für Programmcode nachteilig sein.

==== {{Anker|categories{{=}}}} Kategorien ====
Seit Ende März 2024 kann das Laden auf (fast nur Wikitext-)Seiten eingeschränkt werden, die in bestimmten Kategorien gelistet sind.

Durch Kommata getrennte Liste von Kategorie-Titeln.
* Vorgabe ist: ''jede Seite''.
* Kategorien, die ein Komma im Titel enthalten, wurden vom Programmierer nicht berücksichtigt.
* Mehrere Kategorien erweitern im Sinne einer ODER-Verknüpfung die wirksamen Seiten; jede Seite, die von ''Kategorie1'' oder auch ''Kategorie2'' erfasst ist.

In der deutschsprachigen Wikipedia werden Unterkategorien von [[:Kategorie:MediaWiki:Gadget]] verwendet, deren Titel durch Anhängen des [[#Bezeichner|Bezeichners]] gebildet wird.

<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[categories=</code>''Liste von Kategorie-Titeln''<code>]</code>
bzw. angehängtes
* <code>|categories=</code>''Liste von Kategorie-Titeln''
in einer vorhandenen Optionsliste.
</div>

==== {{Anker|type{{=}}}} Ressourcen-Typ ====
Bei Ressourcenlisten, die auch CSS enthalten, ist zu entscheiden, ob sie am Anfang geladen werden müssen, und möglichst schon auf den ersten Seitenaufbau wirken sollen, oder ob dies zusammen mit den anderen Ressourcen und JavaScript geschehen kann. Werden HTML-Elemente erst durch das JavaScript-Gadget generiert, und sind sie womöglich nicht ohne Benutzeraktivität sichtbar, dann genügt der zweite Fall.

<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[type=]</code>
bzw. angehängtes
* <code>|type=</code>
in einer vorhandenen Optionsliste.
</div>
Dabei kann einer der beiden Werte angegeben werden:
* <code>type=general</code>
** Wird vom Wiki-Server automatisch gesetzt, wenn alle Ressourcen JavaScript sind.
** CSS-Ressourcen werden zusammen mit JavaScript geladen; also ggf. später.
* <code>type=styles</code>
** Wird vom Wiki-Server automatisch gesetzt, wenn alle Ressourcen CSS sind.
** Die CSS-Ressourcen werden zum ersten Seitenaufbau geladen.
* Keine Spezifikation:
** Zumindest übergangsweise wird CSS doppelt geladen; einmal zum Seitenaufbau und einmal beim Laden von JavaScript.
** Relevant bei Gadgets, die Ressourcen beider Art enthalten.
** Es sollte dann explizit mittels <code>type=general</code> spezifiziert werden, dass ein späterer Ladezeitpunkt ausreicht.
Wenn ein Gadget sowohl CSS- wie auch JavaScript-Ressourcen enthält und es erforderlich ist, dass das CSS bereits auf den Seitenaufbau wirkt, dann sollte dieses in ein separates, ggf. [[#hidden|verstecktes]] Gadget ausgelagert werden. Es kann durch eine Abhängigkeitsdeklaration vom eigentlichen JavaScript-Gadget abgefordert werden.

Diese Funktionalität wurde Anfang Oktober 2016 eingeführt<ref>1.28.0-wmf.21, {{Phab|Task=42284}} / [[gerrit:308096]]</ref> und soll mittelfristig vermeiden, dass sicherheitshalber CSS-Ressourcen doppelt geladen werden müssen.

==== {{Anker|hidden}} Versteckte Module ====
Durch Kennzeichnung mit <code>hidden</code> werden Gadgets in der Einstellungsseite unsichtbar. Das wirkt sich nur auf die Einstellungsseite aus; aus den sonstigen Datenstrukturen wird die Definition nicht entfernt. 

Somit lassen sich Gadgets vor den Benutzern verstecken, aber trotzdem die Zuweisung des ''[[#Bezeichner|Bezeichner]]'' zu einem Quellcode nutzen, wie auch die weitere Effizienzsteigerung bei der Paketbildung.

<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[hidden]</code>
bzw. angehängtes
* <code>|hidden</code>
in einer vorhandenen Optionsliste.
</div>
Diese Code-Blöcke können auch als <code>[[#dependencies=|dependencies]]</code> angegeben werden.

Zwar sind die Gadgets in der [[Spezial:Einstellungen|Einstellungsseite]] niemals zu sehen, für niemanden; jedoch wird ihr Beschreibungstext auf [[Special:Gadgets]] erwartet. Fehlt dieser, dann gibt es hässlichen Ersatz und ein Rotlink würde produziert. Es soll deshalb immer eine Nachricht für den Beschreibungstext erstellt werden, in der dann auch auf eine Dokumentation verlinkt werden kann.

Enthält ein Abschnitt nur versteckte oder für dieses Konto nicht wirksame ''(rights, skins)'' Gadgets, so wird auch dessen [[#Überschriften |Abschnittsüberschrift]] nicht angezeigt.


Bis November 2016  wurden für versteckte Module Konstrukte der Form
<pre>
[rights=hidden-gadget]
[rights=hidden-NIEMAND]
</pre>
verwendet. Durch Forderung nach einem frei erfundenen Benutzerrecht wurde die gleiche Wirkung erzielt. Das kann mittlerweile umgestellt werden und sollte zur Verständlichkeit auch nicht mehr genutzt werden.

==== {{Anker|package}} Bildung eines ''package'' ====
Die zugehörigen Ressourcen sollen ein ''package'' bilden.
* Nur die allererste JavaScript-Seite solle dann auch ausgeführt werden.
* Andere Seiten können importiert (und damit ausgeführt) werden über die Funktion <code>require()</code>.
JSON-Seiten, die ansonsten nicht zugänglich wären, lassen sich damit ebenfalls in das ausgelieferte Paket einbinden.
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[package]</code>
bzw. angehängtes
* <code>|package</code>
in einer vorhandenen Optionsliste.
</div>
Die alleinige Angabe des Schlüsselworts solle ausreichen.

==== {{Anker|peers}} Nutzung anderer Gadgets ====
Durch Kommata getrennte Liste von [[#Bezeichner|Gadget-Bezeichnern]], die nur CSS enthalten sollen.
* Diese Gadgets werden ebenfalls geladen, falls dieses Gadget geladen wird.
* Damit lässt sich eine Bibliothek gemeinsam geteilter Ressourcen bilden.
Diese Ressourcen werden vor den anderen [[#dependencies|Abhängigkeiten]] geladen.
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration: Angehängtes
* <code>|peers=</code>''Liste von Gadgets''
in einer vorhandenen Optionsliste.
</div>

==== {{Anker|supportsUrlLoad}} Unterstützt URL-Laden ====
Durch Kennzeichnung mit <code>supportsUrlLoad</code> kann erlaubt werden, mittels des [[Hilfe:URL-Parameter#withgadget|URL-Parameter]] <code>&withgadget=</code>''[[#Bezeichner|Bezeichner]]'' ein Gadget zu starten und somit auch entsprechende Verlinkungen anzubieten.

<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[supportsUrlLoad]</code>
bzw. angehängtes
* <code>|supportsUrlLoad</code>
in einer vorhandenen Optionsliste.
</div>

Die alleinige Angabe des Schlüsselworts solle ausreichen; es könnten auch Werte zugewiesen werden: <code>true</code>|<code>false</code>

==== {{Anker|top{{=}}}} <s>''Vorrangiges Laden''</s> ====
In sehr seltenen Fällen (etwa für VisualEditor-Plugins) war es sinnvoll, ein Gadget vor anderen Modulen zu laden.

<div style="background-color: #C8C8C8; border: 2px #000000 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[top]</code>
bzw. angehängtes
* <code>|top</code>
in einer vorhandenen Optionsliste.
</div>
Dieses Feature wird mittlerweile auf anderen Wegen realisiert und war 2024 beendet.

==== {{Anker|targets{{=}}}} <s>''Geräte''</s> ====
Dieses Feature wurde 2023 auf korrespondierende [[#skins=|Skins]] migriert und im Januar 2024 beendet.

Durch Kommata getrennte Liste von Ausgabegeräten. Das waren: <code>desktop</code> <code>mobile</code>
* Vorgabe war <code>desktop</code> – auf Mobilgeräte hatten die Definitionen standardmäßig keinen Einfluss.

<div style="background-color: #C8C8C8; border: 2px #000000 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
Deklaration:
* <code>[targets=</code>''Liste von Ausgabegeräten''<code>]</code>
bzw. angehängtes
* <code>|targets=</code>''Liste von Ausgabegeräten''
in einer vorhandenen Optionsliste.
</div>

=== Überschriften ===
Die Einstellungsseite kann gegliedert werden durch
<div style="border: 1px #B0B0B0 solid; display:table; margin-left: {{WikiLayout|indent}}; padding-left:0.5em; padding-right:1em;">
== Was-Neues ==
</div>
und diese erscheinen auch auf der [[#Spezialseite|Spezialseite]].

Der deutschsprachige Text für die Überschrift (hier ''Was-Neues'') muss in einer [[../MediaWiki/Systemnachrichten|Systemnachricht]] <code style="white-space:nowrap">MediaWiki:Gadget-section-</code>''Was-Neues'' hinterlegt werden.

Neben H2-Überschriften sind auch tiefere Ebenen möglich.

Die Systemnachrichten können auch als Unterseite <code>/en</code> eine englischsprachige usw. Version anbieten.

== {{Anker|System}} Systemgadgets ==
Systemgadgets enthalten CSS- und JavaScript-Code, der über das Gadgetsystem geladen wird, aber nicht dafür vorgesehen ist, individuell in den Einstellungen deaktiviert (oder wieder aktiviert) zu werden. Systemgadgets sind deshalb standardmäßig für alle registrierten und nicht registrierten Benutzer aktiviert und in der Regel vor ihnen versteckt. Ihren Ursprung haben sie meist in den zentralen [[CowboysWiki:Technik/Skin/MediaWiki/Ressourcen|Ressourcenseiten]], also etwa der [[MediaWiki:Common.css]], aus der sie ausgelagert wurden. Dieses Vorgehen hat folgende Vorteile:
* Das Laden von Code ist über die Definitionsseite zielgerichteter möglich, etwa durch die Beschränkung auf Namensräume und Aktionen. Code in zentralen Ressourcenseiten wird dagegen bei jedem Seitenaufruf geladen, auch wenn dieser in einem Fall gar nicht erforderlich wäre.
* Es können Redundanzen zwischen zwischen Desktop- und Mobilansicht vermieden werden, wenn über Gadgets derselbe Code in beiden Ansichten geladen wird. Dies ist über die Ressourcenseiten nur eingeschränkt möglich.
* In der Versionsgeschichte des Gadgets finden sich nur Codeänderungen, die die dort bereitgestellten Funktionen betreffen. Änderungen sind über die Zeit somit leichter nachzuvollziehen.
* Jede Angelegenheit hat eine unabhängige Dokumentations- und Diskussionsseite, auf der im Wikitext die Hintergründe genauer beschrieben werden können, und es wird keine gemeinschaftliche Diskussionsseite für sämtliche Common-Angelegenheiten über die Jahrzehnte hinweg benutzt.

Derzeit sind folgende Systemgadgets aktiviert:
* [[/annotationPair/]] – Unterstützung der Vorlagen [[Vorlage:FN|FN]] und [[Vorlage:FNZ|FNZ]]
* [[/citeRef/]] – Verbesserungen und projektspezifische Anpassungen bei der Anzeige von Einzelnachweisen
* [[/defaultPlainlinks/]] – Darstellung ausgewählter Linkziele als interne Links
* [[/dewikiCommonHide/]] – projektweites Ausblenden bestimmter Elemente
* [[/dewikiCommonLayout/]] – projektweite CSS-Klassen für Positionierungen
* [[/dewikiCommonStyle/]] – projektweite CSS-Klassen für Hintergrund- und Rahmenfarben
* [[/dewikiDarkmode/]] – Anpassungen für den Dunkelmodus
* [[/dewikiResponsive/]] – Anpassungen für responsive Skins
* [[/Hauptseite/]] – spezifische Formatierung der Hauptseite
* [[/Hauptseite-Sprachen/]] – Sprachauswahl auf der Hauptseite
* [[/navileisteAutocollapse/]] – automatisches Ausklappen von Navigationsleisten
* [[/NavFrameLegacy/]] – Unterstützung der früher genutzten <code>NavFrame</code>-Klassenfamilie in einigen Namensräumen
* [[/prettytableLegacy/]] – Definition der früher genutzten <code>prettytable</code>-Klasse für den Benutzernamensraum
* [[/sourceEditing/]] – Verbesserungen bei Quelltext-Bearbeitungen
* [[/specialpageLoader/]] – Nachladen weiterer Gadgets auf bestimmten Spezialseiten
* [[/specialSearch/]] – CSS für [[Spezial:Suche]]
* [[/uploadtools/]] – ermöglicht die Vorschaufunktion im lokalen Hochladeformular
* [[/watchlistMessage/]] – ermöglicht das Ausblenden von Hinweisnachrichten auf der Beobachtungsliste

Systemgadgets für einzelne [[Hilfe:Namensräume|Namensräume]]:
* [[/nsCategory/]] – Kategorienamensraum

Zeitweise kann aktiviert werden:
* [[/dewiki-logo/]] – Änderung des Seitenlogos zu besonderen Anlässen

Eine automatisch erzeugte detaillierte Übersicht der Systemgadgets und ihrer Konfiguration ist auf [[Spezial:Gadgets #Systemgadgets]] einsehbar.

== Weitere Informationen ==
{{MediaWiki|Extension:Gadgets}}
{{Phabricator|ICON=1|project=EGAD}}
* [[MediaWiki:Gadgets-definition]] – Spezifikation der Gadgets
* [[../JS/Gadget|JS/Gadget]] – Hinweise für Gadget-Entwickler
* [{{canonicalurl:Special:Prefixindex|prefix=Gadget-&namespace=8}} Alle Gadget-Unterseiten]
* [[Spezial:GadgetUsage]] – Statistiken zur Nutzung von Helferlein pro Wiki 

== Anmerkungen ==
<references />
<noinclude>
{{SORTIERUNG:Gadgets}}
[[Kategorie:CowboysWiki:Technik/Skin/Gadgets| ]]
[[Kategorie:CowboysWiki:Technik/Werkzeuge]]
[[Kategorie:Hilfe:Spezialseite]]
</noinclude>

CowboysWiki:Technik/Skin/Gadgets - Versionsgeschichte