Benutzer:Entzücklopädie/ModuleDoc/de

Vorlage:ModuleDoc/DocPage Dieses Modul übernimmt Hilfsfunktionen für die Vorlage {{ModuleDoc}}.

Exportierte Funktionen

parseTemplateLanguageLinks()

Diese Funktion parst die der Vorlage {{ModuleDoc}} übergebenen Sprachcodes. Für jeden Sprachcode eine Tabelle mit einem Link auf die entsprechende Dokumentationsseite erstellt (egal, ob diese bereits existiert oder nicht). Sollte die Seite nicht existieren, wird automatisch in einer zweiten Tabellenzeile ein Create-Link erzeugt, der mit einer passenden Preload-Vorlage versehen ist (siehe DOC_PAGE_PRELOAD).

Parameter

• a_frame: Frame, der die Argumente der Invoke-Funktion bereithält. Über dessen Parent-Frame wird auf die Sprachcodes zugegriffen, die der Vorlage übergeben wurden.

Argumente

• module: Name des Moduls, zu dem die Dokumentation gehört (wird von der Vorlage {{ModuleDoc}} an Hand des Seitenpfades automatisch ermittelt).

Rückgabewert

Ein String mit Wiki-Syntax für Tabellen, die Wikilinks zu allen der Vorlage {{ModuleDoc}} übergebenen Sprachcodes enthalten.

includeFirstAvailableLanguage()

Diese Funktion bindet die Dokumentation in der ersten Sprache ein, zu der eine entsprechende Dokumentationsseite existiert. Dabei werden die der Vorlage {{ModuleDoc}} übergebenen Sprachcodes der Reihe nach von links nach rechts durchprobiert.

Parameter

• a_frame: Frame, der die Argumente der Invoke-Funktion bereithält. Über dessen Parent-Frame wird auf die Sprachcodes zugegriffen, die der Vorlage übergeben wurden.

Argumente

• module: Name des Moduls, zu dem die Dokumentation gehört (wird von der Vorlage {{ModuleDoc}} an Hand des Seitenpfades automatisch ermittelt).

Rückgabewert

Ein String mit der als Vorlage expandierten Dokumentationsseite in der entsprechenden Sprache. Sollte keine einzige Sprachversion existieren, wird der leere String zurückgegeben.

Interna

DOC_PAGES_PREFIX

Diese Konstante legt den Pfad fest, unter dem die Dokumentation in den verschiedenen Sprachen abgelegt ist. Standardmäßig beträgt ihr Wert Wikipedia:Lua/Module/, so dass die Dokumentation unter Wikipedia:Lua/Module/MODULNAME/?? gesucht wird (?? steht für die verschiedenen Sprachcodes).

DOC_PAGE_PRELOAD

Diese Konstante zeigt auf die Preload-Seite, die bei der Erstellung neuer Dokumentationsseiten über den Create-Link automatisch in die Editbox eingebunden werden soll. tandardmäßig beträgt ihr Wert Vorlage:ModuleDoc/DocPage/preload