Hilfe:Vorlagen
| Inhaltsverzeichnis |
Vorlagen erzeugen und bearbeiten
Eine Vorlage wird wie jede andere Wiki-Seite erzeugt, indem man einen Link [[Vorlage:Name]] auf einer Seite anlegt, dem Link folgt und die neue Seite bearbeitet und mit dem gewünschten Inhalt füllt. Vergiss dabei nicht den Namensvorsatz „Vorlage:" vor dem Namen der Vorlage.
Eine Vorlage kann grundsätzlich so bearbeitet werden wie ein klassischer Text. Auch lassen sich Vorlagen schachteln, d. h. innerhalb einer Vorlage können weitere Vorlagen verwendet werden. Vorlagen, die zur Verwendung in normalen Artikeln angelegt werden, benötigen eine Erklärung, die innerhalb von <noinclude> oder auf der Diskussionsseite angegeben werden kann.
Alle in eine Seite eingebundenen Vorlagen werden als Links unter dem Bearbeiten-Fenster aufgelistet.
Vorlagen verwenden
Um eine einfache Vorlage in einem Artikel zu verwenden gibt es drei Möglichkeiten:
- Im Hauptanwendungsfall fügst du eine Vorlage mit
{{Titel}}ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage „Titel“. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung. - {{subst:Titel}} fügt ebenfalls den Inhalt der Vorlage ein, ersetzt den Text jedoch direkt beim Speichern.
- {{msgnw:Titel}} zeigt im Artikel den Quellcode der Vorlage an. Diese Funktion wird selten, eigentlich nur zur Erklärung von Vorlagen, gebraucht.
Parameter einfügen und verwenden
Oft sollen in einer Vorlage noch Inhalte auftauchen, die sich von Seite zu Seite ändern. Das geschieht mit Parametern.
In der Vorlage kennzeichnet man durch drei geschweifte Klammern Stellen als Platzhalter, die entweder durchnummeriert oder frei benannt werden:
Nach Angaben von Wikipedianer {{{1}}} ist diese Seite kopiert von {{{2}}}
Nach Angaben von Wikipedianer {{{wikipedianer}}} ist diese Seite kopiert von {{{quelle}}}
Ein Parameter kann auch als Wikilink anklickbar erscheinen, wenn er mit zwei eckigen Klammern umgeben ist, wie zum Beispiel: [[{{{1}}}]].
Wenn du eine solche Vorlage mit Parametern verwenden willst, gibst du nach dem Namen der Vorlage, getrennt mit einem senkrechten Strich, die Werte an:
{{Titel|wikiwichtel|http://www.irgendwo.de/}}
{{Titel|wikipedianer=wikiwichtel|quelle=http://www.irgendwo.de/}}
Hierbei ist zu beachten, dass die erste Schreibweise nur für nummerierte Parameter gilt und nicht auch für benannte. Die zweite Schreibweise empfiehlt sich bei Vorlagen, die mehrere, leicht verwechselbare Parameter enthalten.
Grundsätzlich werden in Wikipedia Vorlagen präferiert, die auf benannte Parameter verzichten.
Wenn ein Parameter nicht mit Inhalt befüllt wird, so erscheint er leer.
Standardparameter definieren
Man kann einen Parameter so definieren, dass eine Eingabe optional ist, ohne Eingabe wird ein vorher definierter Parameter eingesetzt. Bei {{{1|{{PAGENAME}}}}} wird der erste eingegebene Parameter ausgegeben, ansonsten der Name des Artikels. Diese Konstruktionen belasten den Server nicht so stark wie fest definierte Parameter.
Problem: Gleichheitszeichen in Parametern
Wenn man einer Vorlage als einen Parameter, der nur durch eine Zahl im Vorlagencode eingebunden ist, Text übergibt, der ein Gleichheitszeichen enthält, „denkt“ die MediaWiki-Software, man wolle den Parameter mit der Bezeichnung des Textes vor dem Gleichheitszeichen nehmen.
Dieses Problem taucht beispielsweise auf, wenn man eine URL, in welcher ein Gleichheitszeichen enthalten ist (http://de.wikipedia.org/w/index.php?title=Hilfe:Vorlagen&action=edit§ion=3), mit einem Parameter verlinken will.
Um dieses Problem zu umgehen, muss man lediglich dem Parameter, in dem das "=" vorkommt, beispielsweise dem x-ten Parameter, x= voranstellen (wobei x durch die entsprechende Zahl zu ersetzen ist und der Name der Vorlage nicht mitzählt).
| Statt: | {{Beispielvorlage|http://.../index.php?title=...&action=edit§ion=3}} |
| Folgendes: | {{Beispielvorlage|1=http://.../index.php?title=...&action=edit§ion=3}}
|
Ein weiteres Beispiel, wenn man dem Parameterinhalt einen Style zuweisen möchte:
| Statt: | {{Beispielvorlage|erster Parameter|a<span style="font-size:1.5em">b</span>c}} |
| Folgendes: | {{Beispielvorlage|erster Parameter|2=a<span style="font-size:1.5em">b</span>c}}
|
Problem: Senkrechter Strich in Parametern
Da das Zeichen „|“ zur Trennung von Parametern eingesetzt wird, kann es nicht direkt in Parameterwerten vorkommen; somit kann beispielsweise nicht die normale Tabellensyntax in Parameterwerten verwendet werden. Aus diesem Grund gibt es folgende spezielle Vorlagen, die ausschließlich in Parameterwerten eingesetzt werden sollten:
| Parameter | {{!}} | {{!-}} | {{!!}} | {{!-!}} | {{!+}} |
|---|---|---|---|---|---|
| Inhalt | | | |- | || | |- | | |+ |
Vorlagen dokumentieren
Vorlagen, die in normalen Artikeln verwendet werden, sollten so einfach gestaltet sein, dass Zweck und Anwendung unmittelbar verständlich sind. In jedem Fall ist eine Beschreibung ihrer Funktion notwendig, vorzugsweise auf der Diskussionsseite. Insbesonders bei häufig eingebundenen Vorlagen bewirkt eine Änderung der Vorlage selbst, dass alle davon abhängigen Seiten bei einem erneuten Aufruf neu generiert werden müssen, anstatt sie aus dem Cache laden zu können. Diese Serverlast sollte vermieden werden. Befindet sich die Dokumentation auf einer Projektseite, so ist ein Hinweis auf diese mittels <noinclude>...</noinclude> innerhalb der Vorlage selbst möglich.
Hinweis mit noinclude
Unter- oder oberhalb einer Vorlage kann mit den Befehl <noinclude> eine Kurzerklärung gegeben werden.
Ausführliche Dokumentation auf der Diskussionsseite
Für eine ausführliche Dokumentation eignet sich die Diskussionsseite einer Vorlage besser, insbesondere wenn Überschriften verwendet werden.
