Hilfe:Vorlagen

Aus Wikivoyage
(Weitergeleitet von Hilfe:Was sind Vorlagen?)
Themenübersicht > Bausteine > Vorlagen
Zur Navigation springen Zur Suche springen

Vorlagen sind wiederkehrende Textbausteine. Sie sind ein Hilfsmittel, die zum einen immer wieder kehrende Aufgaben übernehmen können, zum anderen zur Vereinheitlichung und damit zur Übersichtlichkeit beitragen sollen. In weiteren Fällen können sie auch bestimmte Funktionen in Artikeln zur Verfügung stellen. Dies ist ein Artikel für Einsteiger in die Wiki-Syntax. Für erfahrene Autoren empfehlen wir trotzdem die Lektüre des Artikels über häufig benutzte Vorlagen.

Wozu braucht man Vorlagen?[Bearbeiten]

Vorlagen (auch Templates) sind Hilfsdateien, die unterschiedliche Aufgaben erfüllen können:

  • Textbausteine und/oder eine Grafik in eine beliebige Seite einfügen.
  • Formatierungen übernehmen, z.B. eine mit Rahmen versehene Textbox ausgeben.
  • Das Grundgerüst für eine leere Seite festlegen.
  • einfache Berechnungen vornehmen.
  • Funktionen wie z. B. eine Karte im Artikel einblenden.

Verwendung von Vorlagen[Bearbeiten]

Einfacher Vorlagenaufruf:

Um eine Vorlage zu verwenden setzt man einfach den Vorlagennamen in zwei geschweifte Klammern. Um zum Beispiel ein Rollstuhlsymbol auszugeben, schreibst du also einfach {{Rolli}}. Das erzeugt folgendes: Wheelchair-grau3.png

Vorlagen mit Parametern: Die meisten Vorlagen akzeptieren einen oder mehrere Parameter. Diese werden durch eine Pipe (|) getrennt. Die Reihenfolge ist dabei entscheidend. Beispiele:

  • {{rolli|grün}} ergibt: barrierefreibarrierefrei
  • {{em|Das ist ein kursiver Text}} ergibt: Das ist ein kursiver Text
  • {{color|red|Hello, world!}} ergibt: Hello, world!

Mittlerweile sollte man Parameter mit einer Bezeichnung spezifizieren. Ist keine vorgesehen, kann man Nummern verwenden. Dann wird auch die Reihenfolge nebensächlich. Auch neue Programmiersprachen für Vorlagen, wie Lua kommen dann besser mit den Vorlagen zurecht

  • {{rolli|1=grün}} ergibt: barrierefreibarrierefrei
  • {{em|1=Das ist ein kursiver Text}} ergibt: Das ist ein kursiver Text
  • {{color|2=Hello, world!|1=red}} ergibt: Hello, world!

Vorlagen mit benannten Parametern: Parameter mit Namen sind heutzutage Standard und haben einen weiteren Vorteil. Sie sind im Wikitext besser lesbar und in der Anwendung verständlicher, da man zumindest erahnen kann, welche Funktion jeder Parameter hat. Beispiel:

  • {{ZhS|v=武汉市|t=武漢市|audiodatei=zh-Wuhan.ogg|p=Wǔhàn}} ergibt: chinesisch: 武汉市 / 武漢市 Zum Anhören bitte klicken!, Pinyin: Wǔhàn

Namensräume:

Vorlagen werden im Namensraum Vorlage: erwartet. Der Namensraum muss dabei nicht mit angegeben werden. Theoretisch lassen sich aber alle Seiten als Vorlage benutzen. Dann muss der Namensraum mit angegeben werden. Um den kompletten Inhalt dieses Hilfeartikels an anderer Stelle einzubinden muss man lediglich {{Hilfe:Vorlagen}} an gewünschter Stelle eintragen.

Substitution[Bearbeiten]

Wenn Vorlagen geändert werden, ändern sich auch automatisch alle Artikel, in denen sie verwendet werden. Das kann nicht immer gewünscht sein. Mit dem kleinen Codewort subst:kannst du erreichen, dass beim Speichern des Artikels die betroffene Vorlage entpackt und ihr Inhalt fest im Artikel gespeichert wird. Beim nächsten Editieren ist die Vorlagensyntax dann nicht mehr sichtbar. Im Falle unserer Begrüßung musst du einfach {{subst:hallo}} schreiben. Einige Vorlagen (wie das angesprochene {{hallo}} sollten bei ihrer Verwendung immer substituiert werden. Das ist auf deren Dokumentationsseite vermerkt. Einige dieser speziellen Vorlagen haben sogar eine Prüfung eingebaut. Statt des Textes erscheint bei einfacher Verwendung ein Hinweis auf der Seite in folgender Form (am Beispiel unserer Begrüßung):

Diese Vorlage sollte substituiert werden. Bitte ersetze {{Hallo}} durch {{subst:Hallo}} (inklusiver möglicher Parameter).

Diese Vorlage sollte nur ersetzt, aber nicht eingebunden werden.

Kategorien:

Magische Wörter[Bearbeiten]

Magische Wörter werden von der Syntax her genau so benutzt. Sie liegen aber nicht als Vorlagen-Seiten vor, sondern sind in der Software fest implementiert. Man erkennt sie in der Regel daran, dass sie komplett in Großbuchstaben geschrieben sind. Es gibt ein paar zusätzliche Vorlagen die die magischen Wörter ergänzen und deshalb auch in Großbuchstaben geschrieben sind.

Parserfunktionen[Bearbeiten]

Optisch sehen sie im Wikitext aus wie Vorlagen, aber es sind eher Programme, die etwas mehr können, als eine übliche Vorlage. Diese Parserfunktionen dienen der höheren Kunst der Vorlagenprogrammierung. Als Artikelautor kommt man daher wenig mit ihnen in Kontakt. Wer die Community mit Vorlagenprogrammierung unterstützen möchte und Aufgaben aus der Vorlagenwerkstatt erledigen möchte, findet in den beiden verlinkten Hilfe-Artikel der Wikipedia reichlich Hintergrundinformationen. Eine Dokumentation gibt es auch im Mediawiki-Wiki.

Dokumentation von Vorlagen[Bearbeiten]

Auf jeder Vorlagenseite findest du in der Regel eine Dokumentation, wie sie zu benutzen ist (siehe z. B. hier bei {{hallo}}). Solltest du mal eigene Vorlagen kreieren, denke daran, dass du immer eine Dokumentation zur Verfügung stellst.

Erstellung von Vorlagen[Bearbeiten]

Bist du an der Erstellung von Vorlagen interessiert oder benötigst du für deine Arbeit eine Vorlage, beachte folgende Tipps:

  • Recherchiere, ob es schon eine passende Vorlage gibt, oder ob eine vorhandene Vorlage angepasst bzw. erweitert werden kann.
  • Mache einen Vorschlag in der Vorlagenwerkstatt. Wundere dich nicht über ein paar Leute, die Vorlagen anlegen oder verändern, ohne die Vorlagenwerkstatt zu benutzen. Sie sind Admins, die sich um technische Belange kümmern und daher den „kurzen Weg“ beschreiten. Die Vorlagenwerkstatt bleibt aber die erste Wahl.
  • Bedenke bei Vorschlägen oder der Umsetzung, dass das Ergebnis von Vorlagen heutzutage auch auf mobilen Endgeräten und gängigen Offlineversionen (z. B. Kiwix) funktionieren muss. Berate dich hierzu mit der Community in der Vorlagenwerkstatt. Die Community kann auch beim Testen der Vorlage helfen.
  • Wenn du eine Vorlage programmierst, vergiss nicht, sie zu dokumentieren und zu kategorisieren.

Siehe auch[Bearbeiten]

Hilfeartikel in der Wikipedia[Bearbeiten]
Hilfeartikel im Mediawiki-Wiki[Bearbeiten]