Hilfe:Vorlagenerstellung

Wozu Vorlagen

Vorlagen sind vordefinierte Formatierungen für Text, Tabellen, Bilder und die Infoboxen, kurz für alle möglichen Elemente. Sie sind aber auch als Textbausteine zu verwenden, um immer wiederkehrende Texte schnell einzubinden.

Wie erstelle ich eine Vorlage

Um eine Vorlage zu erstellen, muss sich sie lediglich in meinen Artikel aufrufen. Dies geschieht mit {{Vorlagenname}}. Klicke ich nun auf Vorschau zeigen oder Seite speichern erscheint die Vorlage als roter Link. Rot bedeutet immer existiert noch nicht und mit einem Klick darauf bin ich in dem Vorlagenartikel. Sobald ich nun den Vorlagentext abgespeichert habe, verschwindet der Link in meinem Artikel und die Vorlage wird angewendet.
Übrigens, in der Editoransicht ist am Ende des Artikels immer eine Liste der verwendeten Vorlagen direkt mit einem Link zur Bearbeitung. Es empfiehlt sich, über den Link (bearbeiten) einen neuen Browsertab (oder Fenster) zu öffnen und dort die Vorlage zu editieren.

Die ersten Zeilen

Eine Vorlage muss dokumentiert werden. D.h. man muss den anderen Autoren aufzeigen, wozu die Vorlage gut ist und wie sie zu verwenden ist. Dazu wird ein Unterdokument erstellt und dieses wiederrum in die Vorlage eingebunden (ebenfalls als Vorlage). Was sich so kompliziert anhört ist ganz einfach. Die ersten Zeilen einer Vorlage sehen also so aus:

<noinclude>{{Vorlage:Vorlagenname/Dokumentation}}</noinclude>
<includeonly>
.....
</includeonly>

Alles was zwischen den Tags <noinclude></noinclude> steht, wird nur bei der Ansicht der Vorlage, also wenn ich die Vorlage editiere, angezeigt, nicht aber bei der Anwendung der Vorlage in meinem Artikel. Diese Tags sind also ideal um die Vorlagendokumentation einzubinden. Diese wird als Unterseite der Vorlage erstellt, was durch den Schrägstrich zwischen dem Vorlagennamen und Dokumentation erreicht wird. Klickt man nun auf diesen Link (oder am Ende des Editors auf bearbeiten) kann man die Dokumentationsseite erstellen.

Der Vorlagentext

Unter diesem ersten Block folgt nun die eigentliche Vorlage. Dies kann von simplem Text oder Überschriften, z.B. als Textbaustein, bis hin zu komplexen Tabellen oder anderen Gestaltungselementen unter Verwendung von Variablen reichen. Hierzu mehr am Ende dieser Hilfe.

<includeonly>
<div style="float:right">
</includeonly>

Diese Vorlage erzeugt einen Absatz, wobei der Text links und das Element, z.B. ein Bild rechts steht. Die tags <includeonl></includeonl> sorgen dafür, das in der Vorlagenansicht selbst die Vorlage nicht wirkt, sondern nur in den Artikeln in denen sie verwendet wird.

Die Vorlage verwenden

Nun, das ist ja schon geschehen in dem ich sie einfach mit {{Vorlagenname}} in meinem Artikel angegeben habe. Es gibt jedoch zwei Arten eine Vorlage zu verwenden und bei der Erstellung der Dokumentation sollte überlegt werden, welche Art die sinnvollere ist.
Die jetzt schon bekannte Methode wendet den Inhalt der Vorlage an, im Artikel bleibt aber der Vorlagenaufruf stehen, also das Tag {{Vorlagenname}}.
Binde ich sich jedoch mit dem kleinen Wort subst: ein, also {{subst:Vorlagenname}}, wird beim speichern des Artikel, der Vorlagentext in den Artikel kopiert. Es wird klar, dass z.B. Textbausteine mit subst: verwendet werden können, sofern die Textbausteine im Artikel noch geändert werden. Und Textbausteine die Artikelstrukturen (z.B. Überschriften) beinhalten, sollten immer mit subst: kopiert werden.
Achtung! Wenn mittels subst: eine Vorlage in den Artikel kopiert wurde, ist sie von späteren Änderungen an der Vorlage entkoppelt.

Die Dokumentation

Wie bereits erläutert, gehört diese in die Unterseite Dokumentation. Um eine schnelle Orientierung zu gewährleisten, ist eine Dokumentation mit folgender Struktur zu erstellen:

== Funktion ==
(Beschreibt was die Vorlage macht und wofür man sie verwenden kann.)

== Kopiervorlage ==
(Der gesamte Vorlagenaufruf in <pre><{/}pre> Tags zum einfachen Copy-and-Paste in den Artikel.)
<pre>
{{<subst:>Vorlagenname
|VariableX=
...
|VariableY=
|}
<{/}pre>

== Parameter ==
(Sofern Variablen verwendet werden, hier deren Anwendung und ggf. Vorgabewerte beschreiben.)
;Variable: Beschreibung

Beispiel

Anhand der Vorlage Vorlage:Infobox Fahrzeug und deren Dokumentationsseite Vorlage:Infobox Fahrzeug/Dokumentation, die eine Infobox darstellt, kann man dieses Prinzipverfolgen.

Wie mache ich die Vorlage bekannt

Jetzt ist die Vorlage da, aber keiner kennt sie. Um hier Abhilfe zu schaffen, gibt es das Vorlagenportal im Landypedia. Dort wird die Vorlage bekannt gemacht. Da sie dort nur mit ihrem Namen erscheint, wird noch einmal deutlich, wie wichtig ein sprechender Name ist.
Im Vorlagenportal werden einmal alle Vorlagen automatisch alphabetisch aufgeführt und einmal nach Themen geordnet. Dort wird die Vorlage dann unter dem passenden Thema als Link eingetragen. D.h. man verwendet nicht die geschweiften Klammern (sonst würde sie ja angewendet werden) sondern die eckigen: [[Vorlage:Vorlagenname|Vorlagenname]] Neben dieser Methode besteht natürlich immer die Möglichkeit, sich eine Vorlage direkt aus einem Artikel, in dem sie verwendet wird, anzusehen. Dazu öffnet man den Artikel zum Bearbeiten und geht an das Ende des Editorfensters. Dort befindet sich eine Link-Liste der verwendeten Vorlgen.

Weiterführende Links

• Vorlagen, Textbausteine und Vorlagenprogrammierung, offizielle Hilfe