Vorlog:Dokumentation/Lua/Doku

Diese Vorlage wird in die Dokumentationsseite von Vorlagen eingefügt, wenn Lua-Programmierung benutzt wird.

Wirkung:

Die Vorlage wird automatisch kategorisiert unter: Kategorie:Vorlage:mit Lua-Programmierung
Nachfolgende Programmierer werden auf das Modul und dessen Dokumentation hingewiesen.
Auf der Linkliste der Moduldokumentation wird sichtbar, in welchen Vorlagenprogrammierungen das betreffende Modul verwendet wird.
- Die Linkliste des Moduls benennt nur Tausende von Seiten, bei denen das Modul wirksam wurde.

Voraussetzung ist die Verwendung einer standardisierten Moduldokumentation.

Ort der Einbindung

Es empfiehlt sich die Einbindung zum Schluss der Dokumentation, da eine Abschnittsüberschrift vorangestellt wird. Der Hinweis richtet sich an Vorlagenprogrammierer, nicht an die Anwender der Vorlage.

Auch am Ende dieser Dokumentation ist eine Einbindung sichtbar; die Einbindung steht auf /Doku.

Wird auf der Vorlagenseite selbst eingebunden, dann erscheint nur die Vorlage in der Kategorie. Erfolgt die Einbindung auf der gesonderten Dokumentationsseite, würde auch /Doku in der Kategorie erscheinen, falls dies nicht analog in <includeonly> eingeschlossen wird.

Parameter

1: Pflichtparameter im Vorlagen-Namensraum; Titel des ersten Moduls; Falls auf genau eine unter mehreren Funktionen Bezug genommen wird und diese durch einen Fragmentbezeichner identifizierbar ist, sollte dieser ebenfalls angegeben werden.
2: optional; Titel eines weiteren Moduls; ggf. mit Fragmentbezeichner
3 4 5 6 7 8 9: optional; Titel weiterer Module; ggf. mit Fragmentbezeichner
Kat: Hier kann eine andere Kategorie angegeben werden.

Kopiervorlage

Für /Doku als Unterseite:

<includeonly>
{{Dokumentation/Lua|}}
</includeonly>

Beispiel

{{Dokumentation/Lua|TemplatePar #check}}

Erzeugt den Hinweis am Schluss dieser Seite.