Vorlage:Lua-Vorlage/Doku: Unterschied zwischen den Versionen

Aus Cowboy's Wiki
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}}</noinclude> {{Cowboy's Wiki:Lua/Linkbox}} Diese Vorlage wird in die Dokumentation von Vorlagen (oder <code>/Meta</code> …“)
 
K
 
Zeile 1: Zeile 1:
 
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
 
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{Cowboy's Wiki:Lua/Linkbox}}
+
{{Wikipedia:Lua/Linkbox}}
Diese Vorlage wird in die Dokumentation von Vorlagen (oder <code>/Meta</code> oder die Vorlagenseite selbst) eingefügt, wenn Lua-Programmierung benutzt wird.
+
Diese Vorlage wird in die Dokumentation von Vorlagen (oder [veraltet] <code>/Meta</code> oder die Vorlagenseite selbst) eingefügt, wenn Lua-Programmierung benutzt wird.
  
 
Wirkung:
 
Wirkung:
 
# Die Vorlage wird automatisch kategorisiert unter: [[:Kategorie:Vorlage:mit Lua-Programmierung]]
 
# Die Vorlage wird automatisch kategorisiert unter: [[:Kategorie:Vorlage:mit Lua-Programmierung]]
 
# Nachfolgende Programmierer werden auf das Modul und dessen Dokumentation hingewiesen.
 
# 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.
  
 
== Ort der Einbindung ==
 
== Ort der Einbindung ==
Es empfiehlt sich die Einbindung zum Schluss der Dokumentation, da eine Abschnittsüberschrift vorangestellt wird.
+
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 [[Vorlage:Lua-Vorlage/Meta|<code>/Meta</code>]].
+
* Auch am Ende dieser Dokumentation ist eine Einbindung sichtbar; die Einbindung steht auf [[Vorlage:Lua-Vorlage/Doku|<code>/Doku</code>]].
Wird unter <code>/Meta</code> oder auf der Vorlagenseite selbst eingebunden, dann erscheint die Vorlage in der Kategorie. Erfolgt sie auf der gesonderten Dokumentationsseite, steht auch <code>/Doku</code> in der Kategorie.
+
Wird unter <code>/Meta</code> oder auf der Vorlagenseite selbst eingebunden, dann erscheint nur die Vorlage in der Kategorie. Erfolgt die Einbindung auf der gesonderten Dokumentationsseite, würde auch <code>/Doku</code> in der Kategorie erscheinen, falls dies nicht analog in <code>&lt;includeonly></code> eingeschlossen wird.
 
 
Die Hinweise richten sich nicht an Anwender der Vorlage, sondern an Programmierer bei Wartung und Pflege des Inhalts. Es spricht deshalb nichts dagegen, wenn erst nach einem allgemeinen Hinweis auf die Vorlagenwerkstatt die Lua-Programmierung angesprochen wird.
 
  
 
== Parameter ==
 
== Parameter ==
Zeile 18: Zeile 18:
 
: ''Pflichtparameter im Vorlagen-Namensraum''
 
: ''Pflichtparameter im Vorlagen-Namensraum''
 
: Titel des ersten Moduls
 
: Titel des ersten Moduls
; 2 3 4 5 6 7 8 9
+
: 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''
 
: ''optional''
: Titel weiterer Module
+
: Titel weiterer Module; ggf. mit Fragmentbezeichner
  
 
== Kopiervorlage ==
 
== Kopiervorlage ==
 +
Für /Doku als Unterseite:
 
<pre>
 
<pre>
 +
&lt;includeonly>
 
{{Lua-Vorlage|}}
 
{{Lua-Vorlage|}}
 +
&lt;/includeonly>
 
</pre>
 
</pre>
 +
 +
== Beispiel ==
 +
<pre>
 +
{{Lua-Vorlage|TemplatePar #check}}
 +
</pre>
 +
Erzeugt den Hinweis am Schluss dieser Seite.
 +
 +
<includeonly>
 +
{{Lua-Vorlage|TemplatePar #check}}
 +
 +
[[Kategorie:Vorlage:für Vorlagen]]
 +
[[Kategorie:Vorlage:mit Kategorisierung]]
 +
[[Kategorie:Vorlage:Hinweisbaustein]]
 +
[[Kategorie:Wikipedia:Lua]]
 +
</includeonly>

Aktuelle Version vom 12. Oktober 2014, 23:42 Uhr

Dokumentations-Unterseite Diese Seite ist die Dokumentations-Unterseite der Vorlage:Lua-Vorlage.

{{Wikipedia:Lua/Linkbox}} Diese Vorlage wird in die Dokumentation von Vorlagen (oder [veraltet] /Meta oder die Vorlagenseite selbst) eingefügt, wenn Lua-Programmierung benutzt wird.

Wirkung:

  1. Die Vorlage wird automatisch kategorisiert unter: Kategorie:Vorlage:mit Lua-Programmierung
  2. Nachfolgende Programmierer werden auf das Modul und dessen Dokumentation hingewiesen.
  3. 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.

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 unter /Meta oder 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

Kopiervorlage

Für /Doku als Unterseite:

<includeonly>
{{Lua-Vorlage|}}
</includeonly>

Beispiel

{{Lua-Vorlage|TemplatePar #check}}

Erzeugt den Hinweis am Schluss dieser Seite.