Vorlagen

Aus Puerto Patida Wiki
Zur Navigation springen Zur Suche springen

Vorlagen bieten die Möglichkeit, häufig verwendete Bausteine auszulagern. So erreicht man zum einen ein einheitliches Aussehen dieser Teile über mehrere Seiten hinweg und zum anderen erleichtert es die Arbeit, da sich schnell größere Teile in eine Seite einbetten lassen.

Vorhandene Vorlagen können einfach in den Text integriert werden, indem man den Namen der Vorlage in doppelte geschweifte Klammern setzt, wie z.B. {{OrteTable}}. Die meisten Vorlagen lassen sich darüber hinaus mit Parametern anpassen. Diese werden durch einen senkrechten Strich | getrennt an den Name angehängt, beispielsweise {{Folge|S01F01|Titel}}.

Bei einigen Vorlagen wurden die Parameter mit Namen versehen. Gerade bei vielen Parametern ist dies deutlich übersichtlicher. Diesen Parameter kann man mit einem = einen Wert zuweisen, z.B. {{OrteTable|Name=Puerto Patida}}.

Welche Parameter eine Vorlage verwendet und wie diese übergeben werden, sollte idealerweise auf der Seite der Vorlage vermerkt sein.

Vorhandene Vorlagen

Tabellen

Bisher gibt es einige Vorlagen, die eine einheitliche, kleine Tabelle auf Seiten der gleichen Kategorie anzeigen können. Dies sind bisher:

GebäudeTable Tabelle für Gebäude
OrteTable Tabelle für Orte
PersonenTable Tabelle für Personen
StädteTable Tabelle für Städte
TiereTable Tabelle für Tiere
PflanzenTable Tabelle für Pflanzen

Kleine Vorlagen

Darüber hinaus gibt es noch einige kleinere Vorlagen, die die Arbeit ein wenig erleichtern sollen:

Folge Vorlage für Links auf die einzelnen Folgen. Hier sind alle bisher veröffentlichten Folgen enthalten, so dass man nicht zu jeder Folge den entsprechenden Titel und/oder Link heraussuchen muss.
Nachweis Vorlage für Quellennachweise in den Podcastfolgen. Dies soll eine einheitliche Möglichkeit darstellen, um aufzuzeigen, woher eine Information stammt.
Daten Vorlage für die Darstellung eines Datums, einer Uhrzeit und/oder AutorInnen mit einem kleinen Symbol. Diese Vorlage war insbesondere für die Folgenübersicht gedacht

Positionskarte

Die Vorlage Positionskarte bietet die Möglichkeit, einen Punkt auf einer (unbestätigten) Karte Puerto Patidas zu visualisieren.

Interne Vorlagen

Zuletzt gibt es auch noch interne Vorlagen, die nur in anderen Vorlagen verwendet werden:

Positionskarte~ Die eigentliche Positionskarte, wie sie in den verschiedenen Vorlagen verwendet wird. Im Artikel sollte man allerdings die Vorlage Positionskarte verwenden.
TableStyle Diese Vorlage enthält style-Angaben für die Tabellenvorlagen, damit diese einheitlich aussehen und angepasst werden können.
TableHeadBackground Diese Vorlage enthält eine style-Angabe mit einer Hintergrundfarbe für die Tabellenvorlagen
TableBild Diese Vorlage enthält den Tabellencode zum Einfügen von Bildern, um die Darstellung der Bilder einheitlich gestalten zu können.

Eigene Vorlagen erstellen

Wenn du feststellst, dass ein Teil in mehreren Seiten immer wieder auftaucht, oder Dinge vereinheitlicht werden sollen, kannst du auf den entsprechenden Diskussionsseiten anregen, eine Vorlage anzupassen oder zu erstellen. Oder du erstellst einfach selbst eine Vorlage oder passt eine bestehende an.

Falls du eine eigene Vorlage angelegt hast, solltest du sie dokumentieren und auf dieser Seite verlinken, damit andere die Vorlage auch finden und verwenden können.

Anlegen einer Vorlage

Eine Vorlage ist nichts weiter, als eine Seite, deren Namen mit Vorlage: beginnt. Man kann also eine neue Seite Vorlage:Test anlegen und dort folgendes hineinschreiben:

Dies ist ein Test.

Schon kann diese Vorlage verwendet werden. Gibt man nun z.B. auf einer anderen Seite folgendes im Quelltext ein:

Hallo. {{Test}}

so wird daraus auf der Seite:

Hallo. Dies ist ein Test.

Parameter

Häufig macht es Sinn, einer Vorlage einen Parameter zu übergeben, der in der Ausgabe der Vorlage eingebaut wird. Ein solcher Parameter kann bei Verwendung der Vorlage durch ein | angehängt werden. In der Vorlage kann dieser Wert dann eingefügt werden, indem man an der entsprechenden Stelle {{{1}}} für den ersten Parameter, {{{2}}} für den zweiten Parameter etc. eingibt. Wichtig ist, dass hier drei geschweifte Klammern verwendet werden, nicht zwei wie bei der Verwendung von Vorlagen.

Hat man also eine Vorlage Vorlage:Gruss mit folgendem Inhalt:

Hallo {{{1}}}! Alles Gute!

so erhält man mit {{Gruss|Max}} folgende Ausgabe:

Hallo Max! Alles Gute!

Rückfallwerte

Für Parameter können auch Rückfallwerte angegeben werden, falls ein Parameter nicht angegeben wurde. Diese werden bei der Verwendung des Parameters durch ein | getrennt angegeben. Damit lässt sich das obige Beispiel folgendermaßen anpassen:

Hallo {{{1|Unbekannter}}}! Alles Gute!

Wenn man die Vorlage mit {{Gruss|Max}} aufruft, wird man keinen Unterschied zu vorher feststellen. Wenn der Parameter jedoch weggelassen wird, wird statt dessen der Rückfallwert Unbekannter verwendet. {{Gruss}} ergibt also nun:

Hallo Unbekannter! Alles Gute!

Benannte Parameter

Wenn eine Vorlage viele Parameter verwendet, kann es schnell unübersichtlich werden, welcher Parameter an welcher Stelle gesetzt werden muss. Aus diesem Grund kann man einem Parameter einen Namen geben. Hierzu verwendet man einfach in der Vorlage den Namen des Parameters in drei geschweiften Klammern, wie zuvor die durchnummerierten Parameter. Einen Parameter Name kann man innerhalb der Vorlage also mit {{{Name}}} verwenden. Um wieder auf unser bekanntes Beispiel zurückzugreifen, können wir nun also schreiben:

Hallo {{{Name}}}! Alles Gute!

Natürlich kann man auch hier wieder einen Rückfallwert angeben, z.B.:

Hallo {{{Name|Unbekannter}}}! Alles Gute!

Um diese Vorlage in einer Seite zu verwenden, muss man den Parameter mit seinem Name und einem = angeben. Für unser Beispiel würde man also {{Gruss|Name=Max}} verwenden.

Dokumentation

Du solltest in deiner Vorlage dokumentieren, wie sie verwendet werden kann, welche Parameter sie erlaubt und wie diese sich auswirken. Diese Dokumentation kann direkt in die Vorlagen-Seite integriert werden. Hierzu bietet das Wiki die Tags <noinclude> und <includeonly>.

Die Dokumentation sollte von <noinclude> und </noinclude> eingeschlossen sein. Dadurch wird dieser Teil beim Einbinden (include) in andere Seiten nicht mit übernommen.

Das Tag <includeonly> hingegen funktioniert genau umgekehrt. Alles was sich zwischen den Tags <includeonly> und </includeonly> befindet, wird nur beim Einbinden in eine andere Seite angezeigt, nicht aber, wenn die Vorlagen-Seite selbst geöffnet wird.

Eine dokumentierte Variante der obigen Vorlage wäre also z.B.:

<noinclude>
Ein Vorlage, mit der man seine Mitmenschen grüßen kann.

== Parameter ==
;'''Name''': Der Name der zu grüßenden Person, z.B. "Max". Falls nicht angegeben, wird statt dessen "Unbekannter" verwendet.
</noinclude><includeonly>Hallo {{{Name|Unbekannter}}}! Alles Gute!</includeonly>

Bei der Einbindung in eine Seite verhält sich dieses Beispiel wie bisher. Ruft man jedoch die Vorlagen-Seite selbst auf, bekommt man die Dokumentation zu sehen.

Erweiterte Funktionen

Das Wiki bietet auch die Möglichkeit, mit verschiedenen Funktionen die Vorlage auf die Parameter reagieren zu lassen und beispielsweise abhängig davon, wie ein Parameter gesetzt ist, bestimmte Teile zu verändern. Ein Beispiel hierfür ist, dass in den Tabellen teilweise Zeilen ausgeblendet werden, wenn der entsprechende Parameter nicht angegeben wurde.

Diese Funktionalität ist jedoch recht umfassend und komplex. Daher sei an dieser Stelle zunächst nur auf die MediaWiki-Hilfe verwiesen.