Handbuch:Schnittstelle/Gadgets-Definition
| Diese Seite dokumentiert eine Systemnachricht, eine Wikiseite, die Teile der MediaWiki-Oberfläche definiert. Siehe auch die Standarddokumentation. |
MediaWiki:Gadgets-definition ist die Seite, auf der die Gadgets definiert werden, die den Benutzern auf Helferlein, einer Registerkarte in Spezial:Einstellungen von Extension:Gadgets, zur Verfügung stehen. Details siehe Extension:Gadgets.
Format
Each line on the MediaWiki:Gadgets-definition page should start with a "*" (asterisk) character to define a gadget. The line takes the following format:
* mygadget [options] | Seitennamen
The first field ("mygadget" in the example) is the gadget's internal name. The label for the preferences page comes from an interface message page (MediaWiki:Gadget-mygadget) where the proper name and a short description can be written, which also allows wikitext markup to be used.
[A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens (-), underscores (_), and periods (.). The reason for this limitation is that the internal name must be valid as the name of an HTML form name, as MediaWiki interface message key, and as ResourceLoader module name.Optionsformat:
[ResourceLoader | Option1 | Option2 | ... OptionN]
The ResourceLoader flag is required unless the gadget contains only styles. Options that are "flags" only need to have their name written to be turned on. Options that need a value are followed by an equals sign and a comma-separated list of values. All whitespace is optional and may be omitted.
[ResourceLoader | myflag | mykey = value1, value2, value3 ]
Beispiele:
* mygadget[ResourceLoader]|mygadget.js|mygadget.css
oder
* mygadget[ResourceLoader|package]| mygadget.js | mygadget-Foo.js | mygadget-data.json | mygadget.css
oder
* mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css
Abschnitte
Die Gadgets-Definition kann Abschnitte enthalten, aber es wird kein Unterschied zwischen den verschiedenen Ebenen der Überschriften gemacht. Überschriften werden nicht direkt für die Anzeige verwendet, sondern verweisen auf eine MediaWiki-Meldung für diese Abschnittsüberschrift, die mit MediaWiki:Gadget-section- beginnt. So verweist ==LanguageSupport== auf MediaWiki:Gadget-section-LanguageSupport, und der Inhalt dieser Nachricht (oder der lokalisierten Unterseiten, MediaWiki:Gadget-section-LanguageSupport/de usw.) wird dem Benutzer unter Spezial:Einstellungen angezeigt.