Simpsonspedia:Lua/Modul/Vorlage:LuaModuleDoc/de

Vorlagenprogrammierung	Diskussionen	Lua			Unterseiten
		Modul	Deutsch	English	Modul:	Dokumentation

Weiterleitung erstellen

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.

forkedGlobal

(optional; für die Modul-Seite)

Hiesiges Modul ist Fork der globalen Version.

• 0 (Vorgabe) – nein
• 1 – ja, Versionsbezeichnungen nicht vergleichen

categoryDocs

Titel der existierenden (Beschreibungsseite) Kategorie für die Basis-Dokumentation.

categoryWikiData

Titel der Kategorie für globale Module, die über WikiData verknüpft sind.

categoryWikiDataChild

Titel der Kategorie für globale Module, die über WikiData verknüpft sind, und aus einem anderen Wiki aktualisiert werden.

categoryWikiDataParent

Titel der Kategorie für globale Module, die über WikiData verknüpft sind, und Mutterversion für andere Wikis sind.

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 Vorlage:LuaModuleDoc/Navigation Rubriken vorgegeben.

Die Reihenfolge ist an dieser Stelle bedeutungslos.

Der Parameter muss nicht angegeben werden.

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.

preloadCentral

Seitenname zum Preload bei der Generierung von zentralen Dokumentationsseiten.

preloadRedir

Seitenname zum Preload bei der Generierung von Weiterleitungen der Diskussionsseiten.

subTest

Unterseitenname der Testseiten.

templateGlobal

Seitenname für den Hinweis zur globalen Verwendung.

Testseite

Das Verhalten des Moduls hängt maßgeblich vom Namensraum ab sowie von der Frage, ob es sich um eine Unterseite handelt. Eine konventionelle Testseite ist deshalb nicht möglich.

Vielmehr ist jede einschlägige Seite im Modulbereich ein Testfall, und zur Entwicklung können diese auch in der Seitenvorschau dargestellt werden.

Verwendung

Ausschließlich durch Vorlage:LuaModuleDoc.

Abhängigkeiten

• Modul:LuaWiki

Siehe auch

• Lua/Seitenorganisation und Dokumentation