Wikonia

Hilfe:Vorlagen

Eine Vorlage ist eine Seite, deren Inhalt auf anderen Seiten eingebunden werden kann – nach dem Prinzip der Transklusion. Sie ermöglicht es, wiederkehrende Inhalte oder Strukturen zentral zu pflegen und mehrfach zu verwenden.

Vorlagen können einfache Textbausteine sein, aber auch komplexe Logik enthalten. Sie werden im Regelfall im Namensraum Vorlage: angelegt.

Hilfebereich bei Wikonia
Hilfebereich bei Wikonia

Hilfebereich

Benutzerkonto

Navigation & Suche

Seitenbearbeitung

Seitenorganisation

Vorlagen & Module

Diskussionen & Anträge

Gadgets

Phorge

Verwendung Bearbeiten

Um eine Vorlage einzubinden, wird sie im Wikitext folgendermaßen verwendet: 

{{Beispielvorlage}}

Dadurch ersetzt die MediaWiki-Software diesen Eintrag beim Seitenaufruf durch den Inhalt der Seite Vorlage:Beispielvorlage.

Weitere Varianten Bearbeiten

  • {{subst:Beispielvorlage}}
bindet den Inhalt einmalig ein (Substitution), ideal z. B. für Begrüßungen.

→ Siehe: Details zur Substitution

  • {{msgnw:Beispielvorlage}}
zeigt den Quelltext der Vorlage an (z. B. in Dokumentationen).

Außerhalb des Vorlagen-Namensraums Bearbeiten

Auch andere Seiten können wie Vorlagen eingebunden werden, wenn man ihren vollständigen Namen inklusive Namensraum angibt: 

{{Wikonia:Beispielseite}}

Für Artikelnamensraum-Seiten ist ein führender Doppelpunkt erforderlich: 

{{:Test}}

Vorlagen erstellen Bearbeiten

Vorlagen werden wie normale Seiten angelegt – vorzugsweise im Namensraum Vorlage:. Sie können auch im Benutzernamensraum oder als Unterseiten existieren, sollten dann aber nicht in Artikeln verwendet werden.

Bevor du eine neue Vorlage erstellst, prüfe, ob es bereits eine passende Vorlage gibt. Dopplungen führen schnell zu Chaos.

Namensgebung: Der Vorlagenname sollte klar und beschreibend sein. Abkürzungen unter vier Buchstaben nur bei etablierter Praxis. Verwende möglichst konsistente Bezeichnungen mit bereits vorhandenen Vorlagen.

Einsatzbereiche Bearbeiten

Vorlagen sind besonders sinnvoll für:

  • Einheitliches Erscheinungsbild – z. B. Hinweisboxen, Navigationsleisten
  • Zentrale Wartung – Änderungen wirken sofort überall
  • Automatisierung – Kategorisierung, Bedingte Inhalte
  • Reduzierung von Quelltext-Komplexität – z. B. durch HTML-/CSS-Kapselung

Parameter verwenden Bearbeiten

Vorlagen können Platzhalter enthalten, die beim Einbinden durch Parameter ersetzt werden. Diese werden im Quelltext mit drei geschweiften Klammern geschrieben: {{{1}}} oder {{{name}}}

Beispiel mit nummerierten Parametern Bearbeiten

Vorlagencode: 

'''{{{1}}}''' wurde am {{{2}}} geändert.


Verwendung: 

{{Beispiel|Wikonia|2025-06-19}}

Beispiel mit benannten Parametern Bearbeiten

Vorlagencode: 

'''{{{name}}}''' wurde am {{{datum}}} geändert.

Verwendung: 

{{Beispiel|name=Wikonia|datum=2025-06-19}}

Vorgabewerte definieren Bearbeiten

Ein Parameter kann mit einem Standardwert versehen werden, der genutzt wird, wenn kein Wert übergeben wurde: 

{{{titel|Unbekannt}}}

Wird der Parameter jedoch übergeben, aber leer gelassen, erscheint kein Standardwert: 

{{Vorlagenname|titel=}} → gibt nichts aus

Um auch in diesem Fall einen Fallback zu definieren: 

{{#if:{{{titel|}}}|{{{titel}}}|Unbekannt}}


Vorlagen testen und expandieren Bearbeiten

Vorlagenexpansion bezeichnet den Vorgang, bei dem MediaWiki eine Vorlage durch ihren tatsächlichen Inhalt ersetzt – also „expandiert“. Dieser Vorgang erfolgt automatisch beim Anzeigen oder Speichern einer Seite. Der expandierte Inhalt ist das, was letztlich im Artikel angezeigt wird.

Damit nur der gewünschte Teil einer Vorlage eingebunden wird, bietet MediaWiki spezielle Steuer-Tags:

<onlyinclude>...</onlyinclude>
Nur der Text innerhalb dieser Tags wird eingebunden. Alles außerhalb bleibt unsichtbar.
<includeonly>...</includeonly>
Der Inhalt erscheint nur bei der Einbindung – nicht beim direkten Aufruf der Vorlagenseite.
<noinclude>...</noinclude>
Dieser Inhalt erscheint nur auf der Vorlagenseite selbst, z. B. für Dokumentation oder Kategorisierung.

Beispiel Bearbeiten

Kategorien und Dokumentation werden nur auf der Vorlagenseite benutzt, nicht transkludiert.

<onlyinclude>
Inhalt, der eingebunden wird.
</onlyinclude>

<noinclude>
[[Kategorie:Vorlagen]]
[[Kategorie:Technik (Hilfe:)]]
[[Kategorie:Seitenbearbeitung (Hilfe:)]]
[[Kategorie:Vorlagen (Hilfe:)]]
{{Dokumentation}}
</noinclude>

Spezialseiten zum Testen Bearbeiten

Vorlagen dokumentieren Bearbeiten

Verwende für die Beschreibung einer Vorlage die Unterseite /Doku und binde sie mit <noinclude>{{Dokumentation}}</noinclude> am Ende der Vorlage ein.

Alle Kategorien gehören in den <noinclude></noinclude>-Bereich, um die Einbindungsseiten nicht mitzukategorisieren.

→ Siehe: Hilfe:Dokumentation


Weiterleitungen Bearbeiten

Auch Vorlagen können weitergeleitet werden, z. B. von einem Kurznamen auf die eigentliche Vorlage. Bitte sparsam einsetzen – und bei Umbenennungen die alten Einbindungen nach Möglichkeit anpassen.

Auto-Kategorisierung Bearbeiten

Viele Vorlagen im Wiki sind so gestaltet, dass sie Seiten automatisch bestimmten Kategorien zuordnen, sobald die Vorlage eingebunden wird. Diese Funktion dient dazu, Inhalte systematisch zu organisieren und die manuelle Pflege zu erleichtern.

Funktionsweise Bearbeiten

  • Beim Einfügen einer Vorlage in eine Seite wird im Quelltext der Vorlage eine [[Kategorie:...]]-Anweisung ausgeführt.
  • Die betroffene Seite erscheint anschließend automatisch in der angegebenen Kategorie – ohne dass dies separat im Seiteninhalt vermerkt werden muss.
  • Manche Vorlagen nutzen zusätzliche Bedingungen (z. B. Parserfunktionen wie #if oder #switch), um die Kategorie nur bei bestimmten Parametern oder Ausfüllweisen zu setzen.

Beispiel Bearbeiten

Eine Vorlage wie {{Infobox Smartphone}} enthält beispielsweise eine Zeile wie: [[Kategorie:Smartphones]] Wenn du die Vorlage auf einer Seite einfügst, wird diese Seite automatisch der Kategorie Smartphones zugewiesen.

Hinweise Bearbeiten

  • Wenn du eine Vorlage bearbeitest, achte darauf, dass Kategorien korrekt gesetzt sind und keine unnötige Kategorisierung erfolgt.
  • Die automatische Kategorisierung kann Seiten unerwartet einsortieren, wenn Vorlagen nicht wie vorgesehen verwendet werden.
  • Vorlagen, die eine Automatische Kategorisierung durchführen, sollten dies immer auf ihrer Dokumentation entsprechend vermerken.
  • Um eine falsche Kategorisierung zu vermeiden, sollen Vorlagen mit Auto-Kategorisierung nicht in Entwürfen und nicht außerhalb des vorgesehenen Namensraums eingebunden werden.

Grundlagen der Vorlagensubstitution Bearbeiten

In einem Wiki werden Vorlagen standardmäßig durch doppelte geschweifte Klammern {{Vorlagenname}} eingebunden. Dieser Vorgang wird Transklusion genannt. Dabei lädt der Server den Inhalt der Vorlage bei jedem Aufruf der Seite dynamisch nach. Jede Änderung an der Vorlage wirkt sich somit sofort auf alle Seiten aus, die sie verwenden.

Die Substitution ist ein alternativer Prozess, der durch das Präfix subst: oder ers: ausgelöst wird: {{subst:Vorlagenname}}. Beim Speichern der Seite wird der Inhalt der Vorlage einmalig in den Quelltext kopiert. Nach dem Speichern verweist die Seite nicht mehr auf die Vorlage, sondern enthält ihren statischen Inhalt. Zukünftige Änderungen an der ursprünglichen Vorlage haben keinerlei Einfluss mehr auf die substituierte Seite.

Anwendungsbereiche und Vorteile Bearbeiten

Die Substitution ist in bestimmten Fällen sinnvoll und erwünscht, insbesondere wenn die Inhalte nicht mehr aktualisiert werden müssen.

  • Statische Inhalte: Ideal für Textbausteine oder Inhalte, die einmalig eingefügt und danach nicht mehr verändert werden sollen.
  • Performance: Durch die Umwandlung von dynamischen Vorlagen in statischen Text wird die Serverlast reduziert, was die Ladezeiten der Seiten verbessern kann.
  • Einmalige Funktionen: Sinnvoll für Vorlagen, die nur bei der Erstellung einer Seite benötigt werden, wie zum Beispiel Vorlagen, die das aktuelle Datum oder spezifische Parserfunktionen einfügen.

Wichtige Hinweise und Ausnahmen Bearbeiten

Substitution ist nicht immer die richtige Lösung. Es gibt Fälle, in denen die normale Vorlageneinbindung ({{...}}) zwingend notwendig ist.

  • Dynamische Inhalte: Vorlagen, die sich laufend aktualisieren müssen (z. B. eine Vorlage mit dem aktuellen Datum oder externen Daten), dürfen nicht substituiert werden.
  • Zentrale Steuerung: Wenn der Inhalt der Vorlage zentral von einem Ort aus geändert und auf alle eingebundenen Seiten übertragen werden soll, muss die normale Transklusion verwendet werden. Beispiele hierfür sind Navigationsleisten oder einheitliche Seitenhinweise.
  • Verlust der Aktualität: Einmal substituiert, können zukünftige Verbesserungen oder Korrekturen an der Vorlage die jeweilige Seite nicht mehr erreichen.

Syntax und Funktionsweise Bearbeiten

Die Verwendung von subst: ist unkompliziert. Im Bearbeitungsmodus wird die normale Vorlageneinbindung durch die erweiterte Syntax ersetzt.

Syntax: 

{{subst:Vorlagenname}}

Beispiel Bearbeiten

Stell dir eine Vorlage mit dem Namen "Erstellt am" vor, die intern so definiert ist, dass sie das sie den Seitennamen und das heutige Datum ausgibt.

So gehst du vor: Im Wiki-Editor: Du fügst den Code für die Substitution ein. {{subst:Erstellt am}}

Im Vorlagen-Code:

Der Code der Vorlage sieht dann zum Beispiel so aus: 

<onlyinclude>
Die Seite {{PAGENAME}} wurde am {{#timef:now|date}} erstellt.
</onlyinclude>

Funktionserklärung: Das „Magische Wort“ {{PAGENAME}} gibt den Titel der aktuellen Seite wieder. Die Verwendete Parserfunktion #timef: wird bei der Einbindung durch das aktuelle Datum ersetzt und würde sich bei jedem Seitenaufruf aktualisieren, da die Vorlage neu eingebunden wird. (Bzw. immer dann, wenn der Cache-Inhalt der Seite neu aufgebaut wird.

Nach Speichern (mit Substitution): Wird die Vorlage beim Einbinden allerdings substituiert, wird der Inhalt der Parserfunktion nur einmal beim Speichern in den Text integriert und dann dort als reiner Text belassen, in der Seite steht dann nur noch: Die Seite Vorlagen wurde am 19. August 2025 erstellt. Der Vorteil ist, dass die Seite jetzt statischen Text enthält. Die Information wird nicht dynamisch verändert.

Die Verwenung von Substitution innerhalb des Vorlagen-Codes selbst ist ebenfalls möglich und teilweise notwendig, um das gewünschte Ergebnis zu erzeugen. → Siehe: Rekursive Substitution


Siehe auch

Abgerufen von „https://wiki.wikonia.net/index.php?title=Hilfe:Vorlagen&oldid=2376“