Vorlage:MediaWikiGadgetDefinition

[Werkzeuge][Bearbeiten]

Dokumentation

TemplateData

Dokumentation eines Gadgets unter MediaWiki.
Es kann ein Abschnitt „Profil“ (oder ähnlich) erzeugt werden.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Bezeichner	ID	Gadget-Bezeichner Beispiel myGenialGadget	Zeile	vorgeschlagen
RL	ResourceLoader	ResourceLoader möglich Standard 0 ☐ Beispiel 1 ☑	Boolesch	optional
Standard	default	Standardmäßig aktiv Standard 0 ☐ Beispiel 1 ☑	Boolesch	optional
versteckt	hidden	Nicht in den Einstellungen konfigurierbar Standard 0 ☐ Beispiel 1 ☑	Boolesch	optional
package	package	package-Unterstützung Standard 0 ☐ Beispiel 1 ☑	Boolesch	optional
top	top	Vorrangig laden Standard 0 ☐ Beispiel 1 ☑	Boolesch	optional
supportsUrlLoad	supportsUrlLoad	Aufruf über URL unterstützen Standard 0 ☐ Beispiel 1 ☑	Boolesch	optional
Geräte	targets	Geräte-Modus; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte desktop mobile Standard desktop	Zeile	optional
Skins	skins	Skin; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte vector vector-2022 timeless minerva monobook modern cologneblue	Zeile	optional
Rechte	rights	Erforderliche Rechte; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt Beispiel protect	Zeile	optional
Aktivitäten	actions	Seiten-Operation; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte view edit history info render print watch unwatch rollback revert protect unprotect delete undelete revisiondelete markpatrolled	Zeile	optional
Namensräume	namespaces	Namensraum-Nummern; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
Inhaltsmodelle	contentmodels	Content Model der Seite; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte wikitext css javascript json sanitized-css Scribunto text flow-board GadgetDefinition wikibase-item wikibase-property wikibase-lexeme wikibase-query proofread-page proofread-index Standard wikitext	Zeile	optional
pageprops	pageprops	Seiten-Eigenschaften; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
transcludes	transcludes	Eingebundene Seiten; Mehrfachauswahl möglich, durch Pipe getrennt	Zeile	optional
groups	groups	; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
userlangs	userlangs	Sprachcode der Benutzersprache; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
contentlangs	contentlangs	Sprachcode der Seiteninhaltssprache; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
categories	categories category	Eingetragen in Kategorie; Mehrfachauswahl möglich, durch Pipe getrennt	Zeile	optional
type	type	Ressourcentyp Vorgeschlagene Werte general styles	Zeile	optional
dependencies	dependencies	Benötigte RL-Module; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
scripts	scripts	Eingebundene JS-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
styles	styles	Eingebundene CSS-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
datas	datas	Eingebundene JSON-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
peers	peers	CSS-only-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
messages	messages	Benötigte Systemnachrichten; mehrere möglich, durch Pipe getrennt	Zeile	optional
Comment	Comment	Freier Kommentar	Inhalt	optional
Überschrift	Überschrift	Abschnittsüberschrift Standard Profil Beispiel Definition	Inhalt	optional
Überschrifts­stufe	Überschrifts­stufe	Level der Abschnittsüberschrift, bei - keinen Abschnitt Vorgeschlagene Werte 2 3 - Standard - Beispiel 3	Nummer	optional

Format: block

Dokumentation eines Gadgets unter MediaWiki. Es kann ein Abschnitt „Profil“ (oder ähnlich) erzeugt werden.

Vorlagenparameter

Diese Vorlage bevorzugt Blockformatierung von Parametern.

Parameter		Beschreibung	Typ	Status
Bezeichner	ID	Gadget-Bezeichner Beispiel myGenialGadget	Zeile	vorgeschlagen
RL	ResourceLoader	ResourceLoader möglich Standard 0 Beispiel 1	Boolesch	optional
Standard	default	Standardmäßig aktiv Standard 0 Beispiel 1	Boolesch	optional
versteckt	hidden	Nicht in den Einstellungen konfigurierbar Standard 0 Beispiel 1	Boolesch	optional
	package	package-Unterstützung Standard 0 Beispiel 1	Boolesch	optional
	top	Vorrangig laden Standard 0 Beispiel 1	Boolesch	optional
	supportsUrlLoad	Aufruf über URL unterstützen Standard 0 Beispiel 1	Boolesch	optional
Geräte	targets	Geräte-Modus; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte desktop mobile Standard desktop	Zeile	optional
Skins	skins	Skin; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte vector vector-2022 timeless minerva monobook modern cologneblue	Zeile	optional
Rechte	rights	Erforderliche Rechte; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt Beispiel protect	Zeile	optional
Aktivitäten	actions	Seiten-Operation; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte view edit history info render print watch unwatch rollback revert protect unprotect delete undelete revisiondelete markpatrolled	Zeile	optional
Namensräume	namespaces	Namensraum-Nummern; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
Inhaltsmodelle	contentmodels	Content Model der Seite; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt Vorgeschlagene Werte wikitext css javascript json sanitized-css Scribunto text flow-board GadgetDefinition wikibase-item wikibase-property wikibase-lexeme wikibase-query proofread-page proofread-index Standard wikitext	Zeile	optional
	pageprops	Seiten-Eigenschaften; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
	transcludes	Eingebundene Seiten; Mehrfachauswahl möglich, durch Pipe getrennt	Zeile	optional
	groups	; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
	userlangs	Sprachcode der Benutzersprache; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
	contentlangs	Sprachcode der Seiteninhaltssprache; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
	categories category	Eingetragen in Kategorie; Mehrfachauswahl möglich, durch Pipe getrennt	Zeile	optional
	type	Ressourcentyp Vorgeschlagene Werte general styles	Zeile	optional
	dependencies	Benötigte RL-Module; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt	Zeile	optional
	scripts	Eingebundene JS-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
	styles	Eingebundene CSS-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
	datas	Eingebundene JSON-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
	peers	CSS-only-Ressourcen; mehrere möglich, durch Pipe getrennt	Zeile	optional
	messages	Benötigte Systemnachrichten; mehrere möglich, durch Pipe getrennt	Zeile	optional
	Comment	Freier Kommentar	Inhalt	optional
	Überschrift	Abschnittsüberschrift Standard Profil Beispiel Definition	Inhalt	optional
	Überschrifts­stufe	Level der Abschnittsüberschrift, bei - keinen Abschnitt Vorgeschlagene Werte 2 3 - Standard - Beispiel 3	Nummer	optional

Kopiervorlage

{{MediaWikiGadgetDefinition
 |ID=
 |ResourceLoader=1
 |default=
 |hidden=
 |targets=
 |skins=
 |rights=
 |actions=
 |namespaces=
 |contentmodels=
 |pageprops=
 |transcludes=
 |groups=
 |userlangs=
 |dependencies=
 |scripts=
 |styles=
 |datas=
 |messages=
 |Comment=
}}

Beispiele

{{MediaWikiGadgetDefinition
 |ID=
 |ResourceLoader=1
 |default=1
 |hidden=1
 |targets=desktop
 |actions=view
 |namespaces=4
 |scripts=desktopHauptseite.js
 |styles=desktopHauptseite.css
}}

Beispiel 1

desktopHauptseite

desktopHauptseite – spezifische Formatierungen der Hauptseite in der Desktop-Ansicht
Eigenschaft	Zuweisung
ResourceLoader	unterstützt
default	Vorgabe für alle
hidden	versteckt
targets	desktop
actions	view
namespaces	4
scripts	desktopHauptseite.js
styles	desktopHauptseite.css

* desktopHauptseite[ResourceLoader|default|hidden|targets=desktop|actions=view]|desktopHauptseite.js|desktopHauptseite.css

MediaWiki:Gadgets-definition

Aktive Spezifikation.

{{MediaWikiGadgetDefinition
 |ID=prettytable
 |ResourceLoader=1
 |default=1
 |hidden=1
 |actions=view edit
 |namespaces=1 2 3 4 5 100 101
 |styles=prettytable.css
}}

Beispiel 2

prettytable

Eigenschaft	Zuweisung
ResourceLoader	unterstützt
default	Vorgabe für alle
hidden	versteckt
actions	viewedit
namespaces	12345100101
styles	prettytable.css

* prettytable[ResourceLoader|default|hidden|actions=view,edit]|prettytable.css

MediaWiki:Gadgets-definition

Lua

Diese Vorlage wurde ganz oder teilweise mit Hilfe der Programmiersprache Lua erstellt.

Die Module sind mit #invoke eingebunden. In der Dokumentation der einzelnen Module finden sich auch weitere Hinweise zu Rückfragen.

Verwendetes Modul: MediaWikiGadgetDefinition #f

Werkzeuge

Bei technischen Fragen zu dieser Vorlage kannst du dich auch an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. Sie können ggf. auch an eine passende Redaktion, Portal usw. gerichtet werden.

• Verwendungen dieser Vorlage
• Cirrus-Suche zu Einbindungen dieser Vorlage (zunächst nur ANR) mit weiteren Möglichkeiten
• Anzahl der Einbindungen
• Liste der Unterseiten.
• Diese Dokumentation befindet sich auf einer eingebundenen Unterseite [Bearbeiten].
• Test-/Beispielseite erstellen.
• giftbot/vorlagenparser: CSV herunterladen (ANR).