Hilfe:Vorlagen

Eine Vorlage ist eine Seite, die nach dem Transklusionsprinzip die Einbindung häufig verwendeter Elemente in andere Seiten erleichtert. Im einfachsten Fall handelt es sich dabei um einen vorformulierten Textbaustein, der auf einer anderen Seite eingefügt werden kann.

Häufig enthalten Vorlagen auch die Möglichkeit, veränderliche Daten einzufügen, binden grafische Elemente ein und verwenden eine elementare Programmierung. Auf diese Art werden beispielsweise die Einbindung von Personendaten, Infoboxen, die Georeferenzierung und Navigationsleisten realisiert.

Keine Themenringe

Wie unter Metapedia:Themenring nachzulesen, dürfen in der deutschsprachigen Wikipedia keine Themenringe erstellt werden. Zulässig sind ausschließlich Navigationsleisten oder andere Zusammenstellungen wie auch Kategorie:Vorlage:Linkbox|Linkboxen, die eine vollständige Aufzählung gleichrangiger Elemente enthalten (z. B. Vorlage:Navigationsleiste Deutsche Länder, Lokomotiven der Baureihe XY).

Vorlagen verwenden

Allgemeines

Datei:Transclusion simple.svg

Einbindung

Geschweifte Klammern

Um eine einfache Vorlage in einem Artikel zu verwenden, gibt es drei Möglichkeiten:

1. Im Hauptanwendungsfall fügst du eine Vorlage mit {{Titel}} ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage „Titel“. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung.
2. {{subst:Titel}} (für Substitution) oder auch {{ers:Titel}} (für Ersetzen) fügt ebenfalls den Inhalt der Vorlage ein, ersetzt den Titel der Vorlage jedoch auch in der Bearbeitungs-Umgebung (die Ansicht, die man erhält, wenn man oben auf den Reiter „Seite bearbeiten“ geklickt hat) durch den eigentlichen Text der Vorlage. Auf diese Art werden zum Beispiel neue Benutzer begrüßt, die anschließend auf ihrer Seite auch beim Bearbeiten den Text der Begrüßung vorfinden sollen und kein verwirrendes Vorlage:Vorlage. Andere Vorlagen sind so konstruiert, dass man sie mit {{subst:Titel}} einbindet, z. B. die Vorlage Löschantrag.
3. {{msgnw:Titel}} zeigt im Artikel den Quellcode der Vorlage an. Diese Funktion wird selten, eigentlich nur zur Erklärung von Vorlagen, gebraucht.

Seiten, die nicht im Namensraum Vorlage stehen, lassen sich dennoch als Vorlage verwenden, wenn man den Namensraum mit angibt. Zum Beispiel würde {{Wikipedia:Fragen zur Wikipedia}} die Seite Metapedia:Fragen zur Wikipedia als Vorlage einbinden. Will man eine Seite aus dem Artikelnamensraum einbinden, muss man allerdings noch einen Doppelpunkt vor den Namen setzen: So würde {{:Test}} beispielsweise den Artikel Test als Vorlage einbinden.

Bedingtes Einbinden von Quelltextblöcken

Folgende Tags sollten nur innerhalb von Seiten verwendet werden, die als Vorlage eingebunden werden:

<onlyinclude>

Wenn die Vorlage direkt betrachtet wird, haben <onlyinclude> und </onlyinclude> keine Wirkung auf alles, was dazwischen steht. Wenn die Vorlage jedoch auf einer anderen Seite eingebunden ist, wird ausschließlich angezeigt, was zwischen <onlyinclude> und </onlyinclude> steht. Außerhalb dieses mit <onlyinclude> festgelegten Bereichs können Dokumentation, Kategorie und Interwiki-Links in Vorlagen eingefügt werden, ohne dass diese in den Artikeln auftauchen. Es können auch mehrere nicht-verschachtelte <onlyinclude>-Blöcke in einer Vorlage stehen.

<includeonly>

Alles, was in einer Vorlage zwischen <includeonly> und </includeonly> steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden wird. Mit <includeonly> lassen sich zum Beispiel alle Seiten, die eine bestimmte Vorlage enthalten, automatisch einer Kategorie hinzufügen. <includeonly> kann auch in <onlyinclude>-Blöcken stehen.

<noinclude>

Alles, was in einer Vorlage zwischen <noinclude> und </noinclude> steht, wird dagegen nur dann angezeigt, wenn die Vorlage selbst betrachtet wird. <onlyinclude> sollte zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden. <noinclude> kann auch in <onlyinclude>-Blöcken stehen.

Tag-Kombination	Auf der Vorlagenseite sichtbar ?	Einbindung ?	Anmerkung
keine	Ja	Ja	Nur, wenn kein onlyinclude in der Vorlage ist.
<includeonly>…</includeonly>	Nein	Ja	Nur, wenn kein onlyinclude in der Vorlage ist.
<noinclude>…</noinclude>	Ja	Nein	Auch innerhalb von onlyinclude
<onlyinclude>…</onlyinclude>	Ja	Ja	Text außerhalb wird nicht eingebunden.
<onlyinclude><includeonly>… </includeonly></onlyinclude>	Nein	Ja	Text außerhalb wird nicht eingebunden.
<onlyinclude>Text 1</onlyinclude>… <includeonly>Text 2</includeonly>	Text 1: Ja, Text 2: Nein	Text 1: Ja, Text 2: Nein	Text 2 ist keine sinnvolle Kombination.

Beispiel

Der folgende Quelltext:

Dokumentierender Text …

<onlyinclude>{| class="wikitable float-right"
 | [[Datei:{{{1<noinclude>|abc.jpg</noinclude>}}}|miniatur|{{{3}}}]]
 | {{{2}}} | {{{3}}}
|}
<includeonly>[[Kategorie:!Hauptkategorie]]</includeonly></onlyinclude>

• beim Betrachten der Vorlagenseite:

Dokumentierender Text …

{{{3}}}

• Mit der Einbindung {{Vorlagenname|Test.jpg|class="hintergrundfarbe5"|← Beispiel}}

Datei:Test 2.jpg ← Beispiel

← Beispiel

Kategorie:!Hauptkategorie

Parameter einfügen und verwenden

Oft sollen in einer Vorlage Inhalte auftauchen, die sich jedoch von Seite zu Seite ändern, zum Beispiel eine Unterschrift oder der individuelle Name des Bildes auf den Commons in der Vorlage:NowCommons. Das erreicht man mit Parametern.

In der Vorlage kennzeichnet man durch drei geschweifte Klammern Stellen als Platzhalter; diese können entweder durchnummeriert oder durch frei gewählte Namen bezeichnet werden:

Nach Angaben von Wikipedianer {{{1}}} ist diese Seite kopiert von {{{2}}}
Nach Angaben von Wikipedianer {{{wikipedianer}}} ist diese Seite kopiert von {{{quelle}}}

Ein Platzhalter kann auch als Wikilink fungieren, wenn er seinerseits mit zwei eckigen Klammern umgeben ist, wie zum Beispiel in [[{{{1}}}]].

Wenn man eine solche Vorlage mit Parametern versehen will, muss man nach dem Namen der Vorlage, getrennt mit jeweils einem senkrechten Strich von diesem und voneinander, die aktuell gewünschten Werte angeben:

{{Titel|wikiwichtel|http://www.irgendwo.de/}}
{{Titel|wikipedianer=wikiwichtel|quelle=http://www.irgendwo.de/}}

Achtung, die erste Schreibweise leistet das Gewünschte nur, wenn die Platzhalter in der Vorlage nummeriert sind, nicht, wenn sie frei benannt sind. Die zweite Schreibweise empfiehlt sich bei Vorlagen, die mehrere, leicht verwechselbare Parameter enthalten.

Wenn ein Parameter nicht mit Inhalt befüllt wird, so erscheint er leer. In den Schwesterprojektvorlagen wird mit diesem Umstand sehr trickreich das Anlegen von mehreren Vorlagen für verschiedene Varianten vermieden, vgl. Vorlage:Wiktionary und die verschiedenen Schreibweisen in Metapedia:Textbausteine/Schwesterprojekte.

Wird ein Parameter nachträglich in eine bestehende Vorlage eingefügt, müssen eventuell die verwendenden Artikel entsprechend geändert werden. Wird dies unterlassen, so wird entweder der Standardwert des Parameters verwendet oder die Änderung hat keine Auswirkungen auf den Artikel.

Daneben existieren in MediaWiki auch einige vordefinierte Variablen, die als Parameterwerte nützlich sind, zum Beispiel der Name der aktuellen Seite ({{PAGENAME}}).

Achtung: Parameter im MediaWiki-Namensraum werden anders verwendet ($1, $2 …).

Vorgabe-Parameterwert definieren

Man kann einen Parameter so definieren, dass für ihn bei Gebrauch der Vorlage kein Wert angegeben werden muss. Ohne diese Angabe findet dann ein vorher definierter Wert Verwendung. Bei einem Konstrukt wie {{{Titel|{{PAGENAME}}}}} wird der erste eingegebene Parameter ausgegeben, ansonsten der Name des Artikels. Diese Konstrukte belasten den Server nicht so stark wie fest definierte Parameterwerte. Siehe auch meta:Help:Parameter default. Dazu muss der Parameter ganz weggelassen werden.

Wichtig:

Der Parameter darf dabei auch nicht leer übergeben werden. Mit

{{Vorlagenname|Titel=}}

funktioniert es nicht. Es muss

{{Vorlagenname}}

lauten.

Soll ein Standardwert auch bei

{{Vorlagenname|Titel=}}

eingesetzt werden, so muss in der Vorlage

{{#if:{{{Titel|}}}|{{{Titel}}}|{{PAGENAME}}}}

stehen.

Problem: Aufzählungszeichen

• Will man Aufzählungszeichen (* oder #), wie am Anfang dieser Zeile eines steht, als Parameterwert benutzen, so sollte in der Vorlage vor dem Parameter eine neue Zeile begonnen werden, wie dies z. B. in der Vorlage:Infobox Film beim Parameter {{{DS}}} für Darsteller der Fall ist.

Problem: Gleichheitszeichen in Parameterwerten

Übergibt man einer Vorlage als Parameterwert einen Text, der ein Gleichheitszeichen enthält, nimmt die MediaWiki-Software an, vor dem ersten Gleichheitszeichen stünde der Name eines Parameters, dem der Rest des Textes hinter dem ersten Gleichheitszeichen als Wert zugewiesen werden solle. Alle Parameterangaben mit enthaltenem Gleichheitszeichen werden also als Name-Wert-Paare interpretiert und dazu am ersten Gleichheitszeichen zerlegt.

Dieses Problem tritt etwa auf, wenn man als Parameterwert an eine Vorlage eine URL übergeben will, in der ein Gleichheitszeichen enthalten ist (z. B.: http://de.wikipedia.org/w/index.php?title=Hilfe:Vorlagen&action=edit&section=3), oder auch einen Text mit enthaltenen „style“-Abschnitten.

Die Abhilfe gegen diese unerwünschte Interpretation ist, dass man dem Parametertext den numerischen Index des Parameters und ein weiteres Gleichheitszeichen voranstellt. Dann wird wie gewünscht interpretiert, dass der Parameterwert schon hinter dem (hinzugesetzten) ersten Gleichheitszeichen beginnt, und der diesem vorangestellte Index bezeichnet unmissverständlich den "Zielparameter" für den Textwert. Die Zählung der Parameter beginnt dabei mit 1 beim ersten Parameter nach dem Vorlagennamen selbst.

Statt:	{{Vorlagenname|http://…/index.php?title=…&action=edit&section=3}}
Richtig:	{{Vorlagenname|1=http://…/index.php?title=…&action=edit&section=3}}

Statt:	{{Vorlagenname|erster Parameter|xx<span style="font-style:italic;">kursiv</span>zz}}
Richtig:	{{Vorlagenname|erster Parameter|2=xx<span style="font-style:italic;">kursiv</span>zz}}

Danach folgende unbenannte Parameter müssen ebenfalls nummeriert werden, da die automatische Zählung die explizite Nummerierung nicht berücksichtigt, d.h. bei {{Vorlagenname|erster Parameter|2=zweiter Parameter|dritter Parameter}} würde dritter Parameter zweiter Parameter ersetzen.

Problem: Sonderzeichen in Parameterwerten

Tabellenelemente

Vorlage	Vorlage:Vorlage	Vorlage:Vorlage	Vorlage:Vorlage	Vorlage:Vorlage	Vorlage:Vorlage+	Vorlage:Vorlage	Vorlage:Vorlage	Vorlage:Vorlage
Inhalt	|	|-	||	|- |	|+	|- !	{|	|}

Da das Zeichen „|“ zur Trennung von Parametern dient, darf es nicht selbst in Parameterwerten vorkommen. Es kann durch &#124; vertreten werden, außer es soll als Wiki-Syntax in Parameterwerten dienen, beispielsweise bei Tabellensyntax oder beim Zusammenbau von Wikilinks. Dafür gibt es dann die folgenden speziellen Vorlagen, die ausschließlich in Parameterwerten eingesetzt werden sollten.

Zur Darstellung von einfach geschweiften Klammern können &#123; für { und &#125; für } verwendet werden. Eine lesbarere Variante ist es, den Text in nowiki-Tags einzufassen, wenn nichts darin als Vorlage interpretiert werden soll.

Geschweifte Klammern

Vorlage	Vorlage:Vorlage	Vorlage:Vorlage
Inhalt	{{	}}

Ein verwandtes Problem tritt bei den geschweiften Klammern „{{“ und „}}“ auf. Werden diese Zeichenfolgen selbst eingegeben, so versucht der Interpreter den dazwischenliegenden Text auf Gedeih oder Verderb als Vorlage zu interpretieren. Mit den folgenden Vorlagen kann man durch bedingte Abfragen erreichen, dass der Interpreter nur notwendige Substitutionen vornimmt, man unterbindet somit unnötige Kaskaden. Diese Vorlagen sollen ausschließlich in Parameterwerten eingesetzt werden.

Zur Darstellung von einfach geschweiften Klammern können &#123; für { und &#125; für } verwendet werden. Eine lesbarere Variante ist es, den Text in nowiki-Tags einzufassen, wenn nichts darin als Vorlage interpretiert werden soll.

Größere Tabellenteile als Parameter können auch auf eine Unterseite geschrieben und dann eingebunden werden. Ist auch das nicht praktikabel, kann notfalls auch auf HTML zurückgegriffen werden.

Eckige Klammern

Vorlage	Vorlage:Vorlage	Vorlage:Vorlage
Inhalt	[	]

Zur Darstellung von einfachen eckigen Klammern können &#91; für [ und &#93; für ] verwendet werden. Eine lesbarere Variante ist es auch hier, den Text in nowiki-Tags einzufassen, wenn nichts darin als Vorlage interpretiert werden soll. Des Weiteren kann man folgende Vorlagen verwenden:

Problem: Generisches Maskulinum

Bei Berufsbezeichnungen muss nicht durchgehend das generische Maskulinum verwendet werden. Stattdessen können zwei Parameter für die männliche und weibliche Form angelegt und gemeinsam ausgewertet werden. Näheres siehe unter Hilfe:Infoboxen/Geschlecht.

Einsatzmöglichkeiten

Vorlagen sind nur dann sinnvoll, wenn es von ihnen nur eine überschaubare Anzahl gibt, die sich Benutzer auch merken können. Insbesondere sollten Vorlagen nicht doppelt oder sehr ähnlich entstehen. Um dies zu verhindern, sollten Vorlagen von allgemeiner Relevanz gefördert werden, indem sie in eine spezielle Liste in alphabetischer Reihenfolge eingetragen werden: Metapedia:Textbausteine und/oder Metapedia:Bewertungsbausteine bzw. Metapedia:Textvorlagen.

Vorlagen dienen in Wikipedia zur:

• Konsistenzmaximierung: Mit Vorlagen lässt sich ein einheitliches Erscheinungsbild erreichen. Bekannte Beispiele sind etwa die Vorlage:Begriffsklärung oder Vorlage:Commons.
• Redundanzminimierung: Wenn der Inhalt zentral nur an einer Stelle festgelegt wird (d. h. in einer Vorlage), dann erscheint der Inhalt in allen Artikeln gleich, auch bei einer nachträglichen Änderung. Das mühselige und fehlerträchtige Übertragen einer Änderung in jeden Artikel entfällt. Bekannte Beispiele sind hier die so genannten Navigationsbausteine. Hierzu gehört auch die Auslagerung von Metadaten, die so zentral aktualisert werden.
• Workflowoptimierung: Mit einer Vorlage kann ein Wikiautor prägnant anderen Wikiautoren mitteilen, in welche Richtung ein Artikel verbessert werden sollte. Bekannte Beispiele sind: Vorlage:URV (Urheberrechtsverletzung), Vorlage:Überarbeiten oder Vorlage:Löschantrag. Bei der Verwendung der Vorlagen wird der Artikel automatisch in spezielle Kategorien für andere Wikiautoren oder Administratoren eingetragen.
• Codeoptimierung: Manche schöne Darstellung lässt sich nur mit einem unschönen Mix aus Wiki-, HTML- bzw. CSS-Befehlen erreichen. Der Artikelquellcode wird dann schnell unübersichtlich und verschreckt Wikianfänger, sich auch an der weiteren Verbesserung eines Artikels zu beteiligen. Hier kann eine Vorlage helfen, den Artikelquellcode lesbarer zu gestalten. Ein bekanntes Beispiel ist Vorlage:Gesprochene Version.
• Auswertung: Neben der einheitlichen Präsentation lassen sich die der Vorlage übergebenen Daten (Parameter) auch automatisiert auswerten. Insbesondere Geodaten lassen sich vielfältig weiternutzen.

Sie sollten nicht dienen als:

• Benutzersignaturen: Die Idee, Vorlagen für die eigene Benutzersignatur zu verwenden, mag ja gut klingen: man muss nur die Vorlage ändern und alle Signaturen, die man irgendwann mal hinterlassen hat, werden „aktualisiert“. Dabei sollte man aber die nicht ganz offensichtliche Tatsache bedenken, dass jede Benutzung einer Vorlage eine zusätzliche Anfrage an die Datenbank bedeutet und somit die Wikipedia belastet, ohne zum eigentlichen Zweck derselben beizutragen. Daher sind Signaturvorlagen nicht erwünscht. Man sollte lieber zu seinen alten Signaturen stehen.
• Abkürzung der Wikisyntax: Die Abkürzung von regelmäßig vorkommenden Textbausteinen durch Vorlagen mag praktisch sein (beispielsweise {{BND}} statt [[Bundesnachrichtendienst]] der Bundesrepublik Deutschland). Vorlagen, die lediglich Wikisyntax abkürzen, haben jedoch im normalen Artikeltext nichts zu suchen. Einzige Ausnahme sind Datenbanklinks, die aus Konsistenz- und vor allem aus Redundanzgründen benötigt werden.

Vorlagen dokumentieren

Vorlagen, die in normalen Artikeln verwendet werden, sollten so einfach gestaltet sein, dass Zweck und Anwendung unmittelbar verständlich sind. In jedem Fall ist eine Beschreibung ihrer Funktion notwendig. Dies kann im noinclude-Bereich der Vorlagenseite geschehen. Bei häufig eingebundenen Vorlagen sollte die Funktionsbeschreibung jedoch besser auf einer separaten Seite stehen; auf diese kann dann mithilfe der Vorlage:Dokumentation noinclude-Bereich der Vorlagenseite verwiesen werden. Eine Änderung der Vorlagenseite selbst bewirkt nämlich, dass alle davon abhängigen Seiten bei einem erneuten Aufruf neu generiert werden müssen, anstatt sie aus dem Cache laden zu können. Diese Serverlast sollte vermieden werden. Die vorstehende Überlegung ist allerdings auch nur relevant, wenn mit Überarbeitungen der Dokumentation bei unveränderter Funktion zu rechnen ist; das Auslagern der Dokumentation verbessert jedoch ohnedies die Übersichtlichkeit.

Ausführliche Dokumentation auf einer Unterseite

Für eine ausführliche Dokumentation eignet sich eine Unterseite der Vorlage. Dafür sollte die Systematik der Vorlage:Dokumentation verwendet werden. Diese sieht vor, dass die Funktion der Vorlage auf einer Unterseite /Doku der Vorlagenseite beschrieben wird. Der Inhalt der Unterseite erscheint dann beim Betrachten der Vorlagenseite. Die Vorlage:Dokumentation wird durch <noinclude>{{Dokumentation}}</noinclude> am Ende der Vorlage eingebunden. Zum weiteren Vorgehen siehe die Dokumentation der Vorlage:Dokumentation.

Kategorisierung

Jede Vorlage soll in eine entsprechende Unterkategorien der Kategorie:Vorlage: einsortiert werden. Achte bei der Einsortierung darauf, eine oder mehrere thematisch passende Kategorien zu finden. Eine Einsortierung von Vorlagen in Artikelkategorien ist nicht erwünscht. Eine Ausnahme sind Wartungskategorien, dort steht die Vorlage meistens auch mit in der Kategorie. Bei einer Einsortierung ist zu beachten, dass dies innerhalb von <noinclude>…</noinclude> geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird. Das WikiProjekt Vorlagen hat eine Systematik zur Kategorisierung aller Vorlagen erarbeitet. Des Weiteren sollte die Sortierung der Vorlage innerhalb der Kategorie angegeben werden, dafür muss hinter den Kategorienamen ein senkrechter Strich und dann die Sortierung eingetragen werden ([[Kategorie:Vorlage:Unterkategorie|Sortierung]]).

Bei der Verwendung der Vorlage:Dokumentation können große Mengen an Metadaten, also auch die Kategorien, auf eine Unterseite ausgelagert werden.

Vorlagen mit speziellen Eigenschaften werden in den passenden Zweig der :Kategorie:Vorlage:nach Eigenschaft eingeordnet. Beispiele wären :Kategorie:Vorlage:mit Kategorisierung|Vorlagen, die Artikel automatisch in eine Kategorie einsortieren, oder :Kategorie:Vorlage:mit Koordinate|solche mit Koordinateneinbindung.

Vorlagen testen

Vorlagen können auf der Spezialseite „Vorlagen expandieren“ getestet werden, siehe auch Hilfe:Vorlagenprogrammierung#Testen.

Siehe auch

• Hilfe:Vorlagenprogrammierung