Wikipedia:Lua/Modul/Vorlage:LuaModuleDoc

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagen-
programmierung
Diskussionen Lua Unterseiten
Modul Deutsch English

Esperanto Dolnoserbski Hornjoserbsce

Vorlage:LuaModuleDoc – Modul, das die Hauptarbeit zur Dokumentation von Lua-Modulen ausführt.

Die Vorlage:LuaModuleDoc wird auf den entsprechenden Dokumentationsseiten eingebunden. Sie liefert die (hier deutschsprachigen) Projekt-Anpassungen.

  • Außerdem werden die ersten (drei) Parameter mit einer optionalen expliziten Sprachangabe und anderen seitenspezifischen Besonderheiten durchgereicht.

Funktionen für Vorlagen

nav
Linkbox-Text generieren.
  • Auf der zentralen Dokumentationsseite auch:
    • Einbindung der ersten vorhandenen Sprachversion,
    • Einbindung der Vorlageneinbindungs-Hilfestellung (wenn nicht noHint),
    • Kategorisierung (wenn nicht noCat).
Parameter:
langsRequest
(optional; für die aktuelle Seite)
Leerzeichen-getrennte Liste der ausdrücklich gewünschten Sprachcodes.
  • Wenn nicht angegeben, dann alle aus dem Standard anzeigen: langsDefault
  • Wenn angegeben, dann alle existierenden aus langsDefault voranstellen.
noCat
(optional; für die aktuelle Seite, ggf. nicht-leerer Wert)
Kategorisierung der Basis-Dokumentation unterdrücken.
noHint
(optional; für die aktuelle Seite, ggf. nicht-leerer Wert)
Anzeige der Standard-Hinweise nach der Basis-Dokumentation zur Vorlageneinbindung unterdrücken.
categoryDocs
Titel der existierenden (Beschreibungsseite) Kategorie für die Basis-Dokumentation.
langsDefault
Leerzeichen-getrennte Liste der standardmäßigen Sprachcodes.
Die Reihenfolge ist an dieser Stelle bedeutungslos.
langsMore
Leerzeichen-getrennte Liste der Sprachcodes, für die über langsDefault hinaus nach möglichen Dokumentationsseiten gesucht werden soll.
Nur für die insgesamt aufgezählten Sprachen sind in Wikipedia:Lua/Modul-Navigation Rubriken vorgegeben.
Die Reihenfolge ist an dieser Stelle bedeutungslos.
nsDocs
Nummer des Namensraums für die Dokumentationsseiten.
pageDocRoot
Seitentitel der Stammseite für die Dokumentationsseiten.
pageErr
Seitenname für die Darstellung von Fehlermeldungen.
pageNav
Seitenname für die Navigationsbox.
pageTemplateInsert
Seitenname für die Hilfestellung zur Vorlageneinbindung.

Wikipedia:Lua/Modul/Vorlage:LuaModuleDoc/local