Hilfe:Vorlagen

Aus FreieFantasyWelt
Version vom 2. April 2011, 19:53 Uhr von Eleonore (Diskussion | Beiträge) (/* Seite neu angelegt)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

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}}
Test 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.

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.


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 die Vorlage:! 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.

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 zu viele Informationen enthalten und dadurch unübersichtlich sind.
Vorlage:Überarbeiten
{{Überarbeiten|Grund=}}
Mit dieser Vorlage können Seiten markiert werden, die überarbeitungsbedürftig sind.

Textformat

Diese Vorlagen formatieren den eingegebenen Text.

Vorlage Code Kommentar
{{Zitat|Zitat=Aussage|Urheber=Urheber|Quelle=Quelle}}
Formatierung für Zitate.