Helferlein (Gadgets) sind optionales benutzerdefiniertes CSS oder JavaScript, das Benutzer in ihren Einstellungen auf der Registerkarte „Helferlein“ aktivieren oder deaktivieren können. Helferlein unterscheiden sich daher grundlegend von Community-CSS und -JS, das für alle Benutzer geladen wird.
Ein Beispiel-Helferlein-Abschnitt in Spezial:Einstellungen
Unangemeldete Benutzer können keine Helferlein deaktivieren, die standardmäßig aktiviert sind, und umgekehrt auch keine weiteren Helferlein aktivieren.
Liste[]
Ein Beispiel für Spezial:Helferlein
Um die Liste der Helferlein zu sehen, gehe auf Spezial:Helferlein. Diese Seite enthält auch Bearbeitungslinks für Helferlein-Beschreibungen, zeigt eine Liste der Dateien, die von jedem Helferlein verwendet werden, und zeigt alle Rechte, die für jedes Helferlein erforderlich sind. Um Helferlein zu (de)aktivieren muss man aber Spezial:Einstellungen nutzen.
In Wikis, die die Helferlein-Erweiterung nicht aktiviert haben, existiert Spezial:Helferlein nicht.
Ein Helferlein erstellen[]
Definition[]
Ein Beispiel für MediaWiki:Gadgets-definition
Der erste Schritt beim Erstellen eines Helferleins besteht darin, es zu definieren. Bearbeite dazu MediaWiki:Gadgets-definition. Jedes Helferlein wird durch einen Listeneintrag definiert, daher muss jede Zeile mit * beginnen. Die Formatierung einer Helferlein-Definition ist wie folgt:
*Name_des_Helferleins [Optionen] | Datei1 | Datei2 | usw.
Name_des_Helferleins muss eindeutig sein und beachtet Groß-/Kleinschreibung. Er muss mit einem lateinischen Buchstaben ([A-Za-z]) beginnen und kann von einer beliebigen Anzahl von Buchstaben, Ziffern ([0-9]), Bindestriche (-), Unterstriche (_), Doppelpunkte (:) und Punkte (.).
Siehe Absatz „Optionen“ für eine Erklärung zu Optionen und Absatz „Dateien“ für eine Erklärung zu Datei1, Datei2 usw.
Wenn ein Wiki viele Helferlein hat, kann es hilfreich sein, die Liste mit ==Überschriften== in Abschnitte aufzuteilen. Beispielsweise ist die folgende Liste in zwei Abschnitte unterteilt: Werkzeuge und Farbthemen. Wie bei Helferlein-Namen wird auch bei Abschnittsüberschriften Groß-/Kleinschreibung beachtet und sie müssen eindeutig sein.
== Werkzeuge == * Utility1 [ResourceLoader] | NiceUtility.js * Utility2 [ResourceLoader|rights=rollback] | RollbackUtil.js | RollbackUtil.css == Farbthemen == * Thema1 [type=styles] | CoolTheme.css * Thema2 [type=styles] | FireTheme.css
Beschreibung[]
Standardmäßig sehen Benutzer ein Helferlein in Spezial:Einstellungen als ⧼gadget-Name_des_Helferleins⧽. Das ist keine sehr hilfreiche Beschreibung. Man kann diese Beschreibung bearbeiten, indem man zu MediaWiki:Gadget-Name_des_Helferleins geht. Man kann auch zur Helferlein-Liste unter Spezial:Helferlein gehen und neben jeder Definition auf den Link „Bearbeiten“ klicken.
Denke daran, dass es bei Helferlein darum geht, Benutzern Wahlmöglichkeiten zu geben, um ihre Nutzungserfahrung zu ändern. Eine hilfreiche Beschreibung erklärt also alles, was der Benutzer anders sieht oder auf das er Zugriff erhält, wenn er das Helferlein aktiviert.
Abschnittsüberschriften können auch bearbeitet werden, um benutzerfreundlicher zu erscheinen. Um im obigen Beispiel die Überschrift Werkzeuge zu bearbeiten, gehe einfach zu MediaWiki:Gadget-section-Werkzeuge oder klicke auf den Link „Bearbeiten“ neben der Abschnittsüberschrift bei Spezial:Helferlein.
Optionen[]
Eine Helferlein-Definition kann Optionen enthalten, die weiter spezifizieren, wie das Helferlein geladen wird oder wer es aktivieren kann. Jede Option muss durch ein Pipe-Zeichen | getrennt werden. Optionen, die keine Parameter annehmen, wie beispielsweise ResourceLoader, können einfach alleine stehen; Optionen, die Parameter annehmen, müssen mit einem Gleichheitszeichen gefolgt von einer durch Kommas getrennten Liste von Parametern eingefügt werden, z. B. rights=rollback,delete.
Die folgende Tabelle listet die verfügbaren Helferlein-Optionen für Fandom-Communitys auf.
| Name | Parameter | Beschreibung |
|---|---|---|
ResourceLoader
|
Keine Parameter | Markiert die Skripte des Helferleins als kompatibel mit ResourceLoader. Diese Option ist für jedes Helferlein erforderlich, das mindestens eine JS-Datei lädt, andernfalls zeigt Spezial:Helferlein einen Fehler an und das JS wird nicht geladen. |
dependencies
|
Durch Kommas getrennte ResourceLoader-Modulnamen | Diese Option hat keine Wirkung, wenn das Helferlein keine ResourceLoader-kompatiblen Ressourcen hat (d. h. keine Styles und Skripte, die nicht als kompatibel markiert sind). |
rights
|
Durch Kommas getrennte Namen von Benutzerrechten | Deaktiviert und verbirgt das Gadget in den Einstellungen für Benutzer, die diese Berechtigungen nicht haben. Beachte, dass Benutzerrechte keine Benutzergruppen sind; die vollständige Liste der Benutzerrechte ist in der Rechtenspalte von Spezial:Gruppenrechte zu finden. |
default
|
Keine Parameter | Aktiviert das Helferlein standardmäßig für alle, einschließlich anonymer Benutzer. Nur registrierte Benutzer können dieses Helferlein deaktivieren. Jedes als Standard festgelegte Helferlein muss sich an die Anpassungsrichtlinien halten. |
type
|
styles oder general
|
Verwende type=styles für Helferlein, die „nur“ CSS-Dateien laden. Dadurch wird das CSS über den Seiten-HTML geladen, was schneller ist als das standardmäßige JavaScript-Ladeverhalten. Beachte, dass type=styles keine JS-Dateien lädt.
|
Dateien[]
Das A und O eines Helferleins sind die Dateien, die es lädt, wenn es aktiviert ist. Jeder CSS- oder JS-Seite, die ein Helferlein lädt, muss das Präfix MediaWiki:Gadget- vorangestellt werden. Im obigen Beispiel definiert Utility2 zwei Dateien, „RollbackUtil.js“ und „RollbackUtil.css“, die sich unter MediaWiki:Gadget-RollbackUtil.js und MediaWiki:Gadget-RollbackUtil.css befinden. Eine gute Faustregel ist, denselben Namen für das Gadget und die Dateien zu verwenden, aber wie demonstriert, ist dies keine Voraussetzung.
Abgesehen vom Präfix Gadget- funktionieren Helferlein-CSS- und -JS-Dateien wie alle anderen CSS- oder JS-Dateien. Beachte daher, dass JS-Dateien von Helferlein vom JavaScript-Überprüfungsprozess geprüft sein müssen, bevor sie verfügbar sind. Helferlein werden nach anderen Wiki-Scripts, aber vor persönlichem Code geladen.
Ein Helferlein kann beliebig viele Seiten laden, aber es kommt selten vor, dass mehr als eine JS- und eine CSS-Seite geladen werden. Jeder Datei muss in der Definition ein Pipe-Zeichen | vorangestellt werden. Helferlein-CSS- oder JS-Seiten können auch von mehreren Helferlein geladen werden. Helferlein können nur mit JS oder CSS geschrieben werden.
Siehe auch[]
- Extension:Gadgets (MediaWiki.org)
- Hilfe:Erweiterungen
Mehr Hilfe[]
- Ein Stichwortverzeichnis zu verschiedensten Hilfeseiten findest du auf Hilfe:Index.
- Einen geordneten Einstieg zur Hilfe gibt es auf der Seite Hilfe:Übersicht.
- Fragen an andere Benutzer kannst du in den Diskussionen des Community-Wikis stellen.
- Anmerkungen zu dieser Hilfeseite kannst du auf der dazugehörigen Diskussionsseite hinterlassen.
- Um Fehler zu melden, kontaktiere bitte einen Ansprechpartner oder nutze das entsprechende Kontaktformular.