Hilfe:Vorlage

Grundlagen

Es gibt in einem MediaWiki die Möglichkeit, den Quelltext einer Seite automatisch in andere Seiten einzubinden. Zu diesem Zweck gibt es den Namensraum Vorlage:, aber im Prinzip funktioniert das mit jeder beliebigen Wikiseite. Seiten, deren einziger Zweck es ist, in Artikeln eingebunden zu werden, sollten jedoch im Namensraum Vorlage: erstellt werden.

Der Vorteil von Vorlagen ist, dass der Quelltext nicht permanent auf die Zielseite übertragen wird, d.h. eine spätere Änderung der Vorlage verändert auch das Aussehen der Seiten, in die die Vorlage eingebunden ist. Somit ist es möglich, durch die Veränderung einer Vorlage das Aussehen sehr vieler Wikiseiten zu beeinflussen.

Code	Aussehen	Kommentar
{{Test}}	Dies ist der Text einer Vorlage.	Der Code von Vorlage:Test wird auf der Seite mit eingebunden, diese Einbindung funktioniert also nur mit Seiten aus dem Namensraum 'Vorlage:'.
{{Hilfe:Test}}	Dies ist der Text einer beliebigen Seite.	Der Code von Hilfe:Test wird auf der Seite mit eingebunden, diese Einbindung funktioniert mit Seiten aus allen Namensräumen bis auf den Artikelnamensraum.
{{:Test}}	Dies ist der Text eines Artikels.	Der Code von Test wird auf der Seite mit eingebunden, diese Einbindung funktioniert nur mit Seiten aus dem Artikelnamensraum.
{{subst:Test}}	Dies ist der Text einer Vorlage.	Der aktuelle Code von Vorlage:Test wird permanent auf die Seite übertragen, d.h. eine zukünftige Veränderung der Vorlage hat keinen Effekt mehr auf diesen Artikel.
{{safesubst:Test}}	Dies ist der Text einer Vorlage.	Wird in Form von {{{|safesubst:}}} bei der Vorlagenprogrammierung verwendet, um Vorlagen substituierbar zu machen, die andere Vorlagen und/oder Hilfe:Variablen bzw. Parser-Funktionen verwenden; siehe Help:Substitution.

Benutzung von Parametern

Es ist möglich, beim Aufruf einer Vorlage Parameter zu übergeben. Diese Parameter müssen in der Vorlage programmiert sein, wenn nicht, wird der übergebene Parameter ignoriert. Welche Parameter in der Vorlage programmiert sind, sollte immer auf der Seite der Vorlage dokumentiert sein, siehe z.B. Vorlage:Test.

Code	Aussehen	Kommentar
{{Test|erste}}	Dies ist der erste Text einer Vorlage.	Der mit "1" bezeichnete Parameter der Vorlage wird mit dem Wert "erste" benutzt.
{{Test|Nummer=zweite}}	Dies ist der zweite Text einer Vorlage.	Der mit "Nummer" bezeichnete Parameter der Vorlage wird mit dem Wert "zweite" benutzt.
{{Test|Nix=Null}}	Dies ist der Text einer Vorlage.	Da der Parameter "Nix" nicht programmiert ist, wird der Aufruf ignoriert.

Parameter und dpl

Die in diesem Wiki installierte Extension DPL (dynamic page list, siehe Spezial:Version) kann die bei der Einbindung von Vorlagen angegebenen Parameter auslesen und daraus automatische Listen erstellen (siehe wlh:Vorlage:Extension DPL). Dies funktioniert auch, wenn der Parameter in der Vorlage eigentlich nicht programmiert ist, siehe z.B. Vorlage:Widersprüchliches und Wiki Aventurica:Widersprüchliches in DSA-Publikationen/Personen.

Vorlagenprogrammierung

Grundsätzlich sollte bei der Erstellung einer neuen Vorlage Vorlage:Vorlagenhilfe mit eingebaut werden, auf diese Weise kann man den Zweck und die Verwendung der Vorlage auf einer Unterseite dokumentieren.

Parameter können mit einem Standard-Wert versehen werden, der benutzt wird, falls dem Parameter im Vorlagenaufruf kein Wert übergeben wird.

Code	Kommentar
{{{Wert|0}}} {{{Name|{{PAGENAME}}}}}	Die Angaben nach dem | werden als Standard-Wert des Parameters benutzt.

Bei der Vorlagenprogrammierung sind folgende Befehle nützlich:

Code	Kommentar
<noinclude>Kategorie:Vorlage</noinclude>	Text zwischen den beiden "noinclude" wird beim Einbinden der Vorlage nicht übertragen. In diesem Fall wird die Vorlage in der "Kategorie:Vorlage" gelistet, diese Kategorie aber nicht beim Einbinden der Vorlage übertragen.
<includeonly>Kategorie:Spielwelt</includeonly>	Text zwischen den beiden "includeonly" wird nur beim Einbinden der Vorlage gezeigt, nicht beim Betrachten der Vorlagenseite. In diesem Fall bekommen alle Seiten, in die die Vorlage eingebunden wird, die "Kategorie:Spielwelt", die Vorlage selbst hingegen nicht.

Weiterhin ist mittlerweile auch die Extension ParserFunctions aktiviert (siehe Spezial:Version). Eine genauere Anleitung zu diesen Funktionen findet sich auf Hilfe:Vorlagenprogrammierung, im Folgenden eine kleine Schnellreferenz.

Code	Kommentar
{{#if: <Bedingung> | <Dann-Text> | <Sonst-Text>}}	Als Bedingung einen Vorlagen-Parameter mittels angeben. Wird dem Parameter beim Einbinden der Vorlage ein Wert zugewiesen, wird "Dann" ausgegeben, ansonsten "Sonst".
{{#if: {{{Größe|}}} | {{!}}neue Tabellenzelle}}	Enthalten der "Dann"- oder "Sonst"-Text das | Zeichen, muss dieses über das Magic Word {{!}} eingebunden werden. Zwei || hintereinander könne über die Vorlage:!! eingebunden werden.
{{#if: {{{Haarfarbe|}}}{{{Augenfarbe|}}} | <Dann-Text>}}	Als Bedingung können auch mehrere Parameter angegeben werden. Enthält einer dieser Parameter Text, wird der Dann-Text ausgegeben.

Hinweise zum Umgang mit Sonderzeichen findet man auf Hilfe:Sonderzeichen.

Quelltext-Formatierung

Code	Darstellung
Text mit Zeilenumbruch	Text mit Zeilenumbruch
Text mit zwei Zeilenumbrüchen	Text mit zwei Zeilenumbrüchen
Leerzeichen am Anfang einer Zeile	Leerzeichen am Anfang einer Zeile

Es gibt bisher in diesem Wiki abgesehen von der Vorgabe, Vorlage:Vorlagenhilfe einzubauen, keinen einheitlichen Standard, wie der Wikicode einer Vorlage aussehen sollte; in anderen Programmiersprachen übliche Quelltextformatierung kann nur eingeschränkt verwendet werden, da der Wikicode einer Vorlage vom MediaWiki-Parser zwar um doppelten Whitespace bereinigt wird (falls kein Leerzeichen am Anfang einer Zeile steht, siehe auch Help:Newlines and spaces), aber Zeilenumbrüche (aus unbekannten, unersichtlichen Gründen) seltsam behandelt werden: ein einzelner Zeilenumbruch wird als Leerzeichen dargestellt, zwei Zeilenumbrüche aber als neuer Absatz (</p><p> im html-Code); dies kann dazu führen, dass eine Vorlage an sich das gewünschte Ergebnis liefert (ein von der Vorlage eingebauter, unbeabsichtigter Zeilenumbruch wird nur als Leerzeichen angezeigt), zusammen mit einer anderen Vorlage aber einen neuen Absatz erzeugt (wenn zwei unbeabsichtigte Zeilenumbrüche aufeinandertreffen).

Auch hier sind die Parser-Funktionen hilfreich, da innerhalb jedes Parameters, der an die Parser-Funktion übergeben wird, Whitespace am Anfang und Ende des Parameters gekürzt wird - was auch Zeilenumbrüche beinhaltet (siehe Help:Extension:ParserFunctions). Allerdings darf man zwischen zwei Parser-Funktionen (aus obigem Grund) wiederum keine Zeilenumbrüche einbauen, sodass der Quelltext einer Vorlage, die zwei Parser-Funktionen nacheinander verwendet, in etwa so aussehen muss:

{{#Funktion1
 |Parameter1
}}{{#Funktion2
 |Parameter2
}}

Fallstricke beim Programmieren mit unbenannten Parametern

• Unbenannte Parameter und Zeilenumbrüche: Je nachdem, ob ein unbenannter Parameter auf die ein oder andere Weise verwendet wird, wird ein Zeilenumbruch am Ende des Parameterinhalts in den Artikel übernommen oder auch nicht. Vorlage:Cut erklärt dies genauer und liefert gleichzeitig die Lösung.
• Unbenannte Parameter und Gleichheitszeichen im Inhalt: Angenommen, eine Vorlage mit unbenanntem Parameter wird folgendermaßen eingebunden:

{{Vorlagenname
|<Inhalt>
}}

Dann funktioniert die Vorlage nicht wie erwartet, wenn im <Inhalt> an beliebiger Stelle ein Gleichheitszeichen = enthalten ist - weil von MediaWiki alles vor dem Gleichheitszeichen als Parametername interpretiert wird.
In diesem Fall muss entweder die Vorlage auf benannte Parameter umprogrammiert werden (wenn oft ein Gleichheitszeichen bei der Eingabe zu erwarten ist), das Gleichheitszeichen in der Eingabe durch das Magic Word {{=}} ersetzt werden, oder die Vorlage auf folgende Weise eingebunden werden:

{{Vorlagenname
|1=<Inhalt>
}}

Häufig verwendete Vorlagen

Alle vorhandenen Vorlagen finden sich in der Kategorie:Vorlage (und den Unterkategorien).

Seitenhinweise

Diese Vorlagen sollten immer am Anfang eines Artikels eingebunden werden.

Vorlage	Code	Kommentar
Vorlage:Löschen	{{Löschen|Grund=}}	Mit dieser Vorlage kann man Seiten markieren, die gelöscht werden sollen.
Vorlage:Kürzen	{{Kürzen}}	Mit dieser Vorlage sollen Seiten markiert werden, die entgegen unserer Richtlinien zu viele Informationen enthalten.
Vorlage:Überarbeiten	{{Überarbeiten|Grund=}}	Mit dieser Vorlage können Seiten markiert werden, die überarbeitungsbedürftig sind.
Vorlage:Spoiler	{{Spoiler|}}	Mit dieser Vorlage können Seiten markiert werden, die MI zu dem angegebenen Produkt enthalten.
Vorlage:Dieser Artikel	{{Dieser Artikel|}}	Mithilfe dieser Vorlage kann auf namensgleiche Artikel hingewiesen werden. Der Text ist dabei nach dem Pipe-Symbol einzutragen. Gibt es mehr als zwei namensgleiche Artikel, sollte immer die Vorlage:BKL verwendet werden.
Vorlage:BKL	{{BKL|(Begriffsklärungsseite)|(Erklärung des Artikels)}}	Diese Vorlage wird in Artikeln eingebunden, falls es verwechselbare Artikel gibt, die eine Begriffsklärung nötig machen. Im ersten Parameter wird auf diese Begriffsklärungsseite verwiesen, im zweiten Parameter soll eine kurze Beschreibung des Artikels angegeben werden.
Vorlage:Begriffsklärung	{{Begriffsklärung}}	Diese Vorlage wird ausschließlich auf Begriffsklärungsseiten eingesetzt. Die verwechselbaren Artikel werden dabei aufgrund der Einbindungen der Vorlage:BKL automatisch erkannt.
Vorlage:Hinweisbox	{{Hinweisbox|Text=}}	Der angegebene Text wird in einer Hinweisbox angezeigt.
Vorlage:Inoffiziell	{{Inoffizieller Artikel}}	Mit dieser Vorlage werden Artikel markiert, die inoffiziellen Inhalt haben, und für die keine der anderen Vorlagen passt.
Vorlage:Hausregel	{{Hausregel}}	Mit dieser Vorlage werden Artikel markiert, die Hausregeln enthalten.
Vorlage:Spielerwelten	{{Spielerwelten |Autor= |Art= |Kategorie= }}	Mit dieser Vorlage werden Artikel im Namensraum Spielerwelten markiert.
Vorlage:SC	{{SC |Spieler= }}	Mit dieser Vorlage werden Artikel zu Spielerhelden markiert.

Textformat

Diese Vorlagen formatieren den eingegebenen Text.

Vorlage	Code	Kommentar
Vorlage:Zauber	{{Zauber|Odem Arcanum|Odem}}	Formatierung für Zaubernamen
Vorlage:Errata	{{Errata|Link=Link auf Errataseite|Text=Text der Errata}}	Formatierung für offizielle Erratatexte in Artikeln
Vorlage:Zitat	{{Zitat |Zitat=Aussage |Urheber=Urheber |Quelle=Quelle }}	Formatierung für Publikations-Zitate (bspw. Klappentexte); siehe dazu auch Wiki Aventurica:Leitfaden zur Verwendung von Offiziellen Produkten
Vorlage:Ingame-Zitat	{{Ingame-Zitat |Zitat=Aussage |Quelle=innerderische Quelle |Publikation=DSA-Publikation }}	Formatierung für innerderische Zitate; siehe dazu auch Wiki Aventurica:Leitfaden zur Verwendung von Offiziellen Produkten

Vorlagengruppen

Viele Vorlagen gehören zu einer gewissen Gruppe, die ein einheitliches Format definiert.

Gruppe	Präfix	Formatierende Vorlagen	Beispiel	Kategorie
Infoboxen	Infobox	Vorlage:Box, Vorlage:Infobox Zeile	Vorlage:Infobox Siedlung	Kategorie:Vorlage Infobox
Navigationsleisten	Nav	Vorlage:Navigationsleiste	Vorlage:Nav Derographie Dere	Kategorie:Vorlage Navigationsleiste
Register	Register	Vorlage:RegisterNeu	Vorlage:Register Staat	Kategorie:Vorlage RegisterNeu
DPL-Listenvorlagen für Unterseiten	Liste Kat Liste	Vorlage:Hinweis DPL-Unterseite	Vorlage:Liste Bücher Vorlage:Kat Liste Derographie	Kategorie:Vorlage DPL-Unterseite