Hilfe:Vorlagen

Vorlagen sind in der sogenannten MediaWiki-Syntax verfasste Makros, mit denen wiederholende Texte oder Textformatierungen vereinheitlicht werden. Jede Änderung einer Vorlage wirkt sich automatisch auf alle Artikel aus, in denen diese Vorlage eingebunden ist. Bei einfachen Vorlagen wird der Inhalt der Vorlage unverändert in den Artikel übernommen. Vorlagen lassen sich aber auch mit Parametern versehen. Dabei wird der Inhalt über die Parameter beeinflusst.

Jede Vorlage hat innerhalb des Minecraft Wiki eine eigene Seite, zu der immer eine erläuternde Dokumentation (siehe unten) gehört. Der Seitenname einer Vorlage folgt dabei dem Schema "Vorlage:Vorlagenname", also z. B. Vorlage:Hinweis. Alle verfügbaren Vorlagen werden auf der Seite Minecraft Wiki:Vorlagen gesammelt.

Anwendung

Die Vorlage wird innerhalb geschweifter Klammerpaare in den Artikeltext eingefügt. Das doppelte Klammernpaar enthält in der einfachsten Form nur den Namen der Vorlage.
Beispiel: {{vorlage}}

Wenn es bei einer Vorlage vorgesehen ist, können zusätzlich Parameter angegeben werden. Sie werden durch einen senkrechten Strich | voneinander getrennt.
Beispiel: {{vorlage|parameter1|parameter2|...}}

Bei manchen Vorlagen haben die Parameter Namen. Wenn sie keine Namen haben, müssen sie in der vorgegeben Reihenfolge angegeben werden. Wenn sie Namen haben, ist die Reihenfolge nicht relevant, dafür muss immer der Name angegeben werden.
Beispiel: {{vorlage|name2=parameter2|name1=parameter1|...}}

Wichtig: Leerzeichen haben eine Bedeutung bei der Formatierung des Textes, sie werden bei der Einbindung einer Vorlage nicht entfernt. Daher dürfen Leerzeichen nur dort verwendet werden, wo sie benötigt werden. Die Verwendung weiterer Leerzeichen zur besseren Lesbarkeit kann zu fehlerhaften Ergebnissen führen.

Beispiel: Die "Vorlage:zeigen" hat als Parameter den Namen einer Unterseite, deren Inhalt sie zeigt. Wird dann auf der Seite "Irgendwas" die Vorlage mit {{zeigen|/text}} eingebunden, bewirkt das die Anzeige des Inhalts der Unterseite "Irgendwas/text". Schreibt man aber stattdessen {{ zeigen | /text }}, wird nichts angezeigt, obwohl die Unterseite "Irgendwas/text" existiert. Der Grund ist das Leerzeichen vor "/text", wodurch die Seite "Irgendwas /text" gesucht wird, die es nicht gibt.

Dasselbe gilt für Zeilenumbrüche innerhalb von Parametern. Zwar machen sie Vorlageneinbindung lesbarer, sie sind aber immer auch Teil des übergebenen Parameters.

Anlegen und Bearbeiten

Bitte beachten Die Anzahl der Vorlagen soll übersichtlich bleiben. Nicht jede Spielerei, die möglich ist, ist auch sinnvoll. Vorlagen, die nicht ausreichend dokumentiert sind, werden wieder gelöscht. Bitte vor der Programmierung von Vorlagen hier informieren: de.wikipedia:Hilfe:Vorlagen und: de.wikipedia:Hilfe:Vorlagenprogrammierung

Vorlagen werden wie andere Seiten im Editiermodus bearbeitet. Eine neue Vorlage ist jedoch erst einmal als Unterseite der Benutzerseite anzulegen. Dazu einfach eine neue Seite anlegen, z. B. "Benutzer:Benutzername/testvorlage". Auf dieser Seite codiert man die Vorlage. Dann ruft man sie auf der Benutzerseite durch Einbindung des vollständigen Seitennamens auf, z. B. {{Benutzer:Benutzername/testvorlage}}
Erst wenn alle Tests erfolgreich verlaufen sind und die Vorlage eine Allgemeingültigkeit für das Wiki hat und eine Dokumentation vorbereitet ist (siehe unten), kann die Vorlage öffentlich gemacht werden. Dazu wird wieder eine neue Seite angelegt, doch diesmal im Namensbereich "Vorlage:", z. B. "Vorlage:Beispiel". Die Vorlage erhält einen verständlichen deutschen Namen und wird auf der Unterseite "Vorlage:Beispiel/Dokumentation" dokumentiert (siehe unten).

Damit die Programmierung einer Vorlage auch von anderen verstanden wird und jederzeit an zukünftige Anforderungen angepasst werden kann, sind Code-Teile, deren Sinn nicht sofort ersichtlich ist, durch Kommentare im Code zu erklären. Kommentare werden durch <!-- und --> geklammert.

Eine Vorlage enthält neben dem eigentlichen Inhalt immer auch mindestens eine formale Information, die auf den Anwendungsseiten nicht erscheinen soll, nämlich die Vorlagendokumentation. Zur Unterscheidung, welche Bereiche der Vorlage auf Anwendungsseiten erscheinen sollen und welche nur auf der Vorlagenseite, gibt es drei Tags:

<noinclude> ... </noinclude>

Was zwischen diesen Tags steht, wird auf der Anwendungsseite nicht eingebunden. Es ist nur auf der Vorlagenseite sichtbar. Im Minecraft Wiki wird so die Vorlagendokumentation behandelt.

<includeonly> ... </includeonly>

Was zwischen diesen Tags steht, ist nur auf den Anwendungsseiten sichtbar, nicht jedoch auf der Vorlagenseite. <includeonly> kann auch in <onlyinclude>-Bereichen stehen.

<onlyinclude> ... </onlyinclude>

Nur was zwischen diesen Tags steht, erscheint auf der Anwendungsseite. Somit ist die gesamte Vorlage auf der Vorlagenseite zu sehen, auf der Anwendungsseite nur der Teil zwischen den Tags. Es können auch mehrere nicht-verschachtelte <onlyinclude>-Bereiche in einer Vorlage stehen.

Wikitext	Vorlagenseite	Anwendungsseite
Vorlage <noinclude> Doku </noinclude>	Vorlage Doku	Vorlage
<includeonly> Vorlage </includeonly> Doku	Vorlage Doku	Vorlage
Text1 <onlyinclude> Text2 </onlyinclude> Text3	Text1 Text2 Text 3	Text2

Bei einfachen Texten mag das trivial sein, interessant wird die Anwendung dieser Tags für ausführbare Befehle, die z.B. nur auf der Anwendungsseite ausgeführt werden sollen.

Die Tags sollen im Minecraft Wiki möglichst einfach und leicht verständlich angewendet werden. Auf komplexe Kombinationen ist zu verzichten, auch wenn sie funktionieren.

Ein häufiges Problem bei Verwendung dieser Tags sind unerwünschte Zeilenumbrüche. Sie entstehen, weil man die Vorlage lesbarer gestalten möchte. Aber Zeilenumbrüche sind immer Teil der Vorlage und werden in die Anwendungsseiten mit eingebunden. Daher wird entweder auf den Zeilenumbruch verzichtet oder - wenn das unübersichtlich wäre - der Zeilenumbruch in einem Kommentar versteckt.

Die Dokumentation wird immer mit <noinclude>{{Dokumentation}}</noinclude> in die Vorlage eingebunden (siehe unten).

Hier ist eine Liste sämtlicher Variablen und Magic Words von MediaWiki: Magic Words.

Um sich den Quelltext der Vorlage anzeigen zu lassen, muss in den Bearbeitungs-Modus der Vorlagenseite gewechselt werden. Um sich dagegen den Quelltext der Dokumentation anzeigen wird der "[Bearbeiten]"-Link angeklickt, der am Anfang und am Ende jeder Dokumentation zu sehen ist: [Lesen] | [Bearbeiten] | [Aktualisieren] | [Hilfe]

Bitte beachten Jede neue Wiki-Vorlage muss in eine Navigationsbox und in die Liste aller Vorlagen eingetragen werden! (Minecraft Wiki:Vorlagen)

Dokumentation

Jede Vorlage muss dokumentiert werden. Undokumentierte Vorlagen werden wieder gelöscht. Das Anlegen einer neuen Dokumentation ist ganz einfach: Im Quelltext der Vorlage muss am Ende immer eingetragen werden: <noinclude>{{Dokumentation}}</noinclude>. Dadurch erscheint auf der Vorlagenseite ein Hinweis mit einem Link auf die noch nicht existierende Dokumentation. Klickt man den Link an, wird die noch leere Vorlagendokumentation mit dem notwendigen Rahmentext vorbelegt. Dort stehen Kommentare, die entfernt und durch den Dokumenationstext ersetzt werden sollen.

Die Dokumentation ist zu jeder Vorlage und zu jedem Modul die Unterseite "/Dokumentation". Beispiel: Zur Vorlage:Hinweis gehört die Dokumentation Vorlage:Hinweis/Dokumentation.

Folgende Gliederung soll verwendet werden:

• Einleitung (ohne Überschrift) mit Sinn bzw. Verwendung der Vorlage und ggf. der Abkürzung (siehe Vorlage:Abkürzung).
• Abschnitt "Anwendung" mit Syntax für den Standardfall und einem Code-Beispiel. Für die Darstellung der Syntax ist einheitlich das pre-Tag zu verwenden, nicht das code-Tag: <pre> ... </pre>
• Abschnitt "Parameter" mit einer Tabelle sämtlicher Parameter (wenn es welche gibt). Dabei werden namenlose Parameter durch einen erklärenden Namen repäsentiert und Parameter mit Namen mit einem zusätzlichen Gleichheitszeichen dargestellt. Bei der Beschreibung der Parameter ist auf Meta-Notationen wie <...> oder [ ... ] zu verzichten, weil sie nicht jeder Leser versteht und wir den Lesern die Vorlagennutzung so einfach wie möglich machen wollen. Optionale Parameter werden in der Beschreibung einfach als "Optional" bezeichnet.
• Weitere Abschnitte je nach Bedarf mit Erläuterung von speziellen Einsatzmöglichkeiten, die über den Standard hinausgehen.
• Die Navigationsbox und evtl. Interwikilinks für die Vorlage werden innerhalb der Dokumentation mit <includeonly> ... </includeonly> abgegrenzt, damit sie nur für die Vorlagenseite gelten, nicht auch noch für die Dokumentationsseite.

Babel-Vorlagen

Die Dokumentation der Babel-Vorlagen ist so kurz, dass sie ausnahmsweise nicht auf einer eigenen Seite steht.

Es gibt auch keine Navigationsbox für die Babel-Vorlagen, weil es stattdessen die Seite Minecraft Wiki:Babel gibt, auf die in jeder Babel-Vorlagendoku verlinkt werden muss.

Da es keine Navigationsbox gibt, werden die Babel-Vorlagen manuell einer Kategorie zugeordnet. Dazu wird der Code [[Kategorie:Babel]] eingefügt. Innerhalb einer Kategorie werden die Vorlage immer anhand ihres Namens alphabetisch sortiert. Die Babel-Vorlagen beginnen alle mit "Babel", würden also alle unter "B" einsortiert werden. Damit dies nicht geschieht, wird immer ein zusätzlicher Sortierbuchstabe angegeben. Beispiel: Die Babelbox Vorlage:Babel Alter wird so kategorisiert: [[Kategorie:Babel|A]].

Lua-Module

Bitte beachten Die Anzahl der Lua-Module soll übersichtlich bleiben. Nicht jede Spielerei, die möglich ist, ist auch sinnvoll.

In Vorlagen können mittels {{#invoke:}} Lua-Module aufgerufen werden. Lua ist eine Skriptsprache, die Möglichkeiten bietet, die mit der Wiki-Syntax schwer oder nur umständlich zu realisieren wären.

Wird von einer Vorlage ein Lua-Modul aufgerufen, wird dies in der Dokumentation als Parameter übergeben. Beispiel: {{Dokumentation|lua=Sprite}}.

• Umgang mit Lua-Modulen: Wikipadia-Hilfe zu Lua-Modulen. Insbesondere ist zu beachten, dass Lua-Module nie direkt aus Artikeln aufgerufen werden, sondern immer über eine Vorlage - auch wenn diese dann nur aus einer Zeile bestehen sollte (Wrapper).
• Alle Lua-Module im Minecraft Wiki: Modul-Liste
• Deutsche Übersetzung der offiziellen Lua-Dokumentation: http://lua.coders-online.net/

MediaWiki-Abarbeitung

Bei Änderungen an Vorlagen kann es vorkommen, dass diese scheinbar nicht angenommen werden. Das kann Sprite-Bilder betreffen, wie die Datei:BlockSprite.png oder Änderungen an Navigationsboxen wie die Vorlage:Navbox-Naturblöcke. Das Sprite-Bild sieht korrekt aus, aber auf den Seiten, auf denen es eingebunden ist, ist noch das alte oder ein leeres zu sehen. Bei Änderungen an einer Navigationsbox zeigt die Spezial:Linkliste noch längere Zeit Verlinkungen an, die gar nicht mehr existieren dürften.

Dies liegt am Konzept der Wiki-Software MediaWiki, die die Aktualisierung solcher Verknüpfungen im Hintergrund abarbeitet und solange noch den alten Zustand anzeigt. Würden alle Aktualisierungen sofort durchgeführt, könnte das Wiki dadurch blockiert werden.

Meist ist nach kurzer Zeit alles wieder aktuell. Selten dauert es einige Stunden, bei sehr vielen Verknüpfungen manchmal auch einige Tage. Möchte man eine bestimmte Seite sofort aktuell sehen, hilft oft ein Nulledit, d.h. eine Bearbeitung und Speicherung ohne Änderung.