Vorlage:ModuleDoc

Dokumentation

Siehe Vorlage:LuaModuleDoc zu einer überarbeiteten und erweiterten Version, die diese Vorlage ablöst.

Diese Vorlage dient der Organisation der Modul-Dokumentation. Sie unterstützt multilinguale Dokumentationen, so dass ein weltweiter Austausch von Modulen einfacher möglich wird.

Da pro Modul standardmäßig nur eine einzige Dokumentationsseite möglich ist (Modul:MODULNAME/Doku), die Dokumentation zu einem Modul im Regelfall aber aus mehreren Seiten bestehen sollte (Sprachversionen für internationalen Austausch, Testseiten, die die Modultestergebnisse dokumentieren, …) wird auf jener Dokumentationsseite ausschließlich diese Vorlage eingebunden. Die eigentliche Dokumentation wird auf verschiedenen Seiten unterhalb von Wikipedia:Lua/Module/MODULNAME/ abgelegt.

Diese Vorlage sorgt dafür, dass zum einen sämtliche Dokumentationsseiten untereinander navigierbar sind und dass zum anderen die Dokumentationsseite in der präferierten Sprache automatisch auf der Modulseite eingebunden wird.

1 Verwendung

Auf der eigentlichen Moduldokumentationsseite Modul:MODULNAME/Doku wird diese Vorlage wie folgt eingebunden:

{{ModuleDoc|de|en|fr|es|...}}

Dabei stellen die Argumente Sprachcodes dar, in deren Sprachen eine Dokumentation des Moduls verfügbar ist (nicht existierende Dokumentationsseiten erscheinen als rote Links).

Die Präferenz der Sprachen fällt von links nach rechs. Die erste Sprache von links, für die eine Dokumentationsseite existiert, wird als primäre Sprache direkt auf der Modulseite als Dokumentation eingebunden. Die Dokumentation für alle anderen Sprachen ist über einen Link im Kopf der Seite ansteuerbar.

Auf den einzelnen Dokumentationsseiten der verschiedenen Sprachen wird dann die Vorlage {{ModuleDoc/DocPage}} zur Verlinkung eingebunden.

2 Kopiervorlagen

Minimale Version mit nur deutschsprachiger Dokumentation:

{{ModuleDoc|de}}

Empfehlenswerte Version mit wenigstens deutsch- und englischsprachiger Dokumentation:

{{ModuleDoc|de|en}}

Zu dieser Vorlage gehört noch die Untervorlage Vorlage:ModuleDoc/DocPage.

Bei Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden oder in der Quelle nachschauen (bisher ist das meist die Vorlage in der Wikipedia).