Modul:MagicWords/Doku
Dies ist die Dokumentationsseite für Modul:MagicWords
Modul:MagicWords – Automatische Einbindung von Magic Words Bearbeiten
Dieses Modul dient der standardisierten, automatischen Einbindung von MediaWiki Magic Words und Variablen in Artikeln. Es ermöglicht eine zentrale Wartung der Definitionen und markiert automatisch als veraltet definierte Einträge mit einer Wartungskategorie.
Datengrundlage Bearbeiten
Alle Magic Words, Common Names und ihr Unterstützungsstatus sind in der ausgelagerten Tabelle Modul:MagicWords/Data definiert.
Die Daten werden über mw.loadData geladen und sind somit hochgradig gecacht.
Verfügbare Funktionen Bearbeiten
Das Modul bietet zwei Funktionen, die über {{#invoke:MagicWords|Funktionsname}} aufgerufen werden:
| Funktion | Zweck | Input | Output |
|---|---|---|---|
getLookupValues
|
Gibt die reinen Daten aus der Lookup-Tabelle als String aus (zur Validierung oder Dokumentation). | Komma-separierte Liste der Common Names. | Zeilenweise formatierte Strings. |
renderMagicWords
|
Rendert die tatsächlichen Magic Words für die Artikeleinbindung. | Komma-separierte Liste der Common Names. | Zeilenweise Wikitext-Ausgabe. Inklusive Wartungskategorie für veraltete Einträge. |
1. Funktion: getLookupValues (Datenabfrage)
Bearbeiten
Diese Funktion zeigt die in der Datentabelle hinterlegten Werte an.
Syntax Bearbeiten
{{#invoke:MagicWords|getLookupValues|Common Name 1, Common Name 2, ...}}
Beispiel [Wikitext] Bearbeiten
{{#invoke:MagicWords|getLookupValues|Jahr, Seitenname, AnzahlViews}}
Beispiel (Resultat [Lua]) Bearbeiten
Common Name: Jahr, Magic Word: {{CURRENTYEAR}}, Supported: true
Common Name: Seitenname, Magic Word: {{PAGENAME}}, Supported: true
Common Name: AnzahlViews, Magic Word: {{NUMBEROFVIEWS}}, Supported: false
2. Funktion: renderMagicWords (Artikeleinbindung)
Bearbeiten
Rendert die tatsächlichen Magic Words. Die Ausgabe erfolgt zeilenweise, da dies für Verhaltensschalter (__NOTOC__) oft notwendig ist.
Wartungslogik Bearbeiten
Wenn ein Magic Word in der Datentabelle den Status false (nicht unterstützt/veraltet) hat, wird die Wartungskategorie Kategorie:Veraltete MagicWords-Definition automatisch in den Artikel eingebunden.
Syntax Bearbeiten
{{#invoke:MagicWords|renderMagicWords|Common Name 1, Common Name 2, ...}}
Beispiel (Wikitext) Bearbeiten
{{#invoke:MagicWords|renderMagicWords|AnzahlViews, Nicht_Indexieren, Tag1Stellig}}
Beispiel (Resultat im Artikel) Bearbeiten
{{NUMBEROFVIEWS}}
[[Kategorie:Veraltete MagicWords-Definition]]
__NOINDEX__
{{CURRENTDAY}}
3. Datenstruktur (Modul:MagicWords/Data) Bearbeiten
Die folgende Tabelle zeigt einen Auszug der im Datenmodul hinterlegten Common Names und Magic Words. Der Status Supported (true/false) steuert die Wartungskategorie.
| Common Name | Magic Word / Variable | Supported | Kategorie |
|---|---|---|---|
| 1. Verhaltensschalter | |||
| Kein_Inhaltsverzeichnis | __NOTOC__
|
true | Steuerung |
| Nicht_Indexieren | __NOINDEX__
|
true | Indexierung |
| Keine_Titelkonvertierung | __NOTITLECONVERT__
|
false | Sprachkonvertierung (Veraltet) |
| Archiv | __ARCHIVEDTALK__
|
false | Diskussionsseitenarchive (benötigt DiscussionTools) |
| 2. Variablen | |||
| Jahr | {{CURRENTYEAR}}
|
true | Zeit/Datum |
| Monatsname | {{CURRENTMONTHNAME}}
|
true | Zeit/Datum |
| Seitenname | {{PAGENAME}}
|
true | Seiteninformation |
| AnzahlViews | {{NUMBEROFVIEWS}}
|
false | Statistik (Mit Mediawiki 1.25 deaktiviert) |
| SiteName | {{SITENAME}}
|
true | Site-Information |
| 3. Parserfunktionen | |||
| DefaultSortierSchlüssel | {{DEFAULTSORT:}}
|
true | Formatierung |
| Bedingter_Ausdruck | {{#ifexpr:}}
|
true | ParserFunctions |
… für die vollständige Liste → Siehe: Modul:MagicWords/Data.