Hilfe:Vorlagen
Wenn du Standardtexte hast, die du auf verschiedenen Seiten einbinden möchtest, kommt das TeeWiki Vorlagen-Feature ins Spiel (wie der Tag oberhalb, der in die Seiten des Hilfe-Namensraums eingebunden ist).
Erstellen einer Vorlage[Quelltext bearbeiten]
Vorlagennamen sind gekennzeichnet durch ein vorangestelltes Vorlage:
und du kannst sie wie jede andere Wikiseite erstellen.
Verwenden einer Vorlage[Quelltext bearbeiten]
Vorlagen sind Wikiseiten, welche in anderen Seiten auf folgenden drei Wegen verwendet werden können:
{{Name}}
fügt den Inhalt der Vorlage "[[Vorlage:Name]]" zu dem Zeitpunkt ein, wenn die Seite, welche diese Anweisung enthält, aufgerufen wird.{{subst:Name}}
fügt den Inhalt der Vorlage "[[Vorlage:Name]]" in den Code der Seite in einer normal editierbaren Form ein nachdem dein Text gespeichert wurde.{{msgnw:Name}}
wenn die Datei, die diese Anweisung enthält, aufgerufen wird, wird die Vorlage so eingefügt, dass ihr Inhalt als rohe Wikisyntax angezeigt wird, genauso, wie es<nowiki>
tut.
Verwendung von Parametern in Vorlagen[Quelltext bearbeiten]
Vorlage mit nummerierten Parametern | |
'''A little thank you...'''<br> <small>for {{{1}}}.<br> hugs, {{{2}}}</small> | |
Du schreibst | Du bekommst |
{{Thankyou|all|Joe}} |
A little thank you... |
mit benannten Parametern | |
'''A little thank you...'''<br> <small>for {{{reason}}}.<br> hugs, {{{signature}}}</small> | |
Du schreibst | Du bekommst |
{{Thankyou |reason=all |signature=Joe}} |
A little thank you... |
Du kannst Parameter in Vorlagen entweder als nummeriert, wie {{{1}}}
, oder als benannt {{{param}}}
definieren.
Beispiel: Du möchtest eine kleine Danknotiz, die du auf die Gesprächsseite mit anderen Nutzern setzen kannst. Sie soll den Grund und deine Signatur enthalten. Du kannst Template:Thankyou erstellen, um deinen Text wie im Beispiel in der Tabelle einzugeben.
Wenn du die Vorlage auf einer Seite verwendest, füllst du die, durch ein Pipezeichen (|) getrennten, Parameterwerte: {{Thankyou|all|Joe}}
. Für benannte Parameter verwendest du "name=wert"-Paare, welche auch wieder durch ein Pipezeichen voneinander getrennt werden: {{Thankyou|reason=all|signature=Joe}}
. Der Vorteil bei der Verwendung benannter Parameter in deiner Vorlage ist, dass die Reihenfolge flexibel ist. Außerdem ist die Vorlage damit leichter verständlich, wenn du viele Parameter hast. Falls du die Reihenfolge der nummerierten Parameter ändern möchtest, musst du das explizit vermerken: {{Thankyou|2=Joe|1=all}}
.
Steuern der Vorlageneinbindung[Quelltext bearbeiten]
Du kannst das Einbinden der Vorlagen durch die Verwendung von <noinclude>
- und <includeonly>
-Tags steuern.
Alles zwischen <noinclude>
und </noinclude>
wird nur verarbeitet und angezeigt, wenn die Seite direkt angesehen wird und nicht eingefügt.
Mögliche Anwendungen sind:
- Kategorisierung von Vorlagen
- sprachübergreifende Verweise zu ähnlichen Vorlagen in anderen Sprachen
- erläuternde Texte, wie eine Vorlage zu verwenden ist
Das Gegenteil ist <includeonly>
. Text zwischen <includeonly>
und
</includeonly>
wird nur verarbeitet und angezeigt, wenn die Seite eingefügt wird.
Der offensichtliche Anwendungsfall ist das Hinzufügen aller Seiten, die eine vorgegebene Vorlage beinhalten, zu einer Kategorie.
Beachte, dass die üblichen Update-Probleme gelten - wenn du Kategorien innerhalb von Vorlagen änderst, werden die Kategorien von verweisenden Seiten solange nicht aktualisiert, bis diese editiert werden.
Organisation von Vorlagen[Quelltext bearbeiten]
Damit Vorlagen effektiv sein können, müssen Nutzer sie schnell finden können und dazu in der Lage sein, sie zu nutzen. Eine einfache Technik ist die Integration eines Beispiels auf der Vorlagenseite. Zum Beispiel:
<noinclude> ==Verwendung== Erlaubt das Setzen eines Verweises zu einem Thema: {{NameDerVorlage|Term1+Term2+Term3}} </noinclude>
Ein Redakteur kann einfach das Beispiel kopieren und einfügen, um eine ähnliche Seite zu erzeugen. Das Beispiel ist trivial, doch ein funktionstüchtiges Beispiel, das demonstriert, wie Vorlagen verwendet werden können, spart in aufwändigen Umgebungen zu speziellen Themen leichter Zeit.
Auch das Erstellen einer Kategorie:Vorlage in deinem Wiki, um deine Vorlagen zusammenzustellen, könnte, neben Links auf diese Seite, für Autoren nützlich sein, um ihnen ein produktiveres Arbeiten zu ermöglichen.