Hilfe:Vorlagenerstellung

Aus Landypedia
Version vom 5. Februar 2011, 00:57 Uhr von AWo (Diskussion | Beiträge) (Die Vorlage verwenden)
Wechseln zu: Navigation, Suche

Wozu Vorlagen

Vorlagen sind vordefinierte Formatierungen für Text, Tabellen und Bilder, 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, mus 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.

Weiterführende Links