Hilfe:Vorlageneinbindung

Aus Wikivoyage
Themenübersicht > Vorlageneinbindung
Zur Navigation springen Zur Suche springen

Damit Vorlagen ihren Zweck erfüllen, sind mehrere Faktoren notwendig

  • Welche Vorlagen gibt es? Siehe hierzu die Seite Hilfe:Was sind Vorlagen?
  • Welche konkrete Aufgabe erfüllt eine bestimmte Vorlage?
  • Wo findet man die Dokumentation zu einer Vorlage?
  • Wie kann man die Vorlage in einen Text einbinden?


Aufruf von Vorlagen[Bearbeiten]

  • Aufruf mit {{Titel}}
    Eine Vorlage liegt üblicherweise im Namensraum Vorlage und hat den Titel {{Vorlage:Titel}}. Genau so wird sie auch in eine andere Seite eingebunden. Es geht in diesem Fall auch kurz: {{Titel}}. Genau genommen, wird nur der Verweis auf die Vorlage eingebunden, nicht die Vorlage selbst. Das hat hat folgenden Vorteil: immer dann, wenn sich eine Vorlage ändert, wird auch der Inhalt der aufrufenden Seite geändert.
  • Aufruf einer Vorlage mit {{subst:Titel}}.
    Damit nicht nur der Verweis auf eine Vorlage eingebunden wird, sondern ihr Inhalt, benutzt man diesen Aufruf mit subst. Beim ersten Versuch mit dieser Methode gibt es Enttäuschungen: die Vorschau zeigt nach wie vor nur den Aufruf {{subst:Titel}}. Erst nach dem Speichern und einem erneuten Aufruf zur Bearbeitung sieht man die Veränderung: der Titel wurde jetzt durch den Inhalt ersetzt. Damit wird der Inhalt der Seite nicht mehr verändert, wenn die ursprüngliche Vorlage abgewandelt wird.
  • Aufruf mit {{msgnw:Hallo}}
    Wer den kompletten Inhalt einer Vorlage lesen möchte, kann dies mit diesem Aufruf tun, das kryptische Wort steht für message nowiki. Und so kryptisch liest sich das dann auch. Kann hilfreich sein, wenn (falls) man Vorlagen programmieren möchte.


Vorlage oder/und Dokumentation?[Bearbeiten]

Eine brauchbare Vorlagendateien enthalten üblicherweise 2 Teile:

  • die einzubindene Vorlage. Faustregel: Alles was in einer Vorlagendatei zwischen den Tags <includeonly>Text</includeonly> steht, gehört zur Vorlage selbst.
  • die nicht einzubindende Dokumentation: was zwischen den Tags <noinclude>Text</noinclude> steht, gehört zur Dokumentation und ist beim Lesen der Vorlagendatei sichtbar.

Siehe auch die Seiten zu Noinclude und zu Includeonly. Es gibt auch noch die Tags mit onlyinclude, die hier bei Wikivoyage nur ausnahmsweise vorkommen. Man kann auch nur mit Noinclude oder mit Onlyinclude auskommen, wie die Beispiele Bsp-4 und Bsp-5 zeigen, ein guter Stil ist es jedoch nicht.

Es ist bei komplexen Vorlagen üblich, dass eine oder mehrere Zeilen der Dokumentation so dargestellt sind, dass man sie zum Einbauen auf eine andere Seite leicht mit Copy and Paste übertragen kann. Als Beispiel sei die folgende Zeile der Vorlage:Anekdote angeführt:

  • {{Anekdote|heading=|text=|image=|float=|header=|size=|styles=}}

Die Begriffe hinter dem Wort Anekdote stellen Variable bzw. Parameter dar, Ihre Anwendung ist bei diesem speziellen Beispiel gut dokumentiert.

Weiteres zu diesem Thema auf der Seite ⇒ Variablen.


Eine Übersicht über alle Hilfeartikel auf Wikivoyage findest du im Index für die Hilfe.