Hilfe:Vorlagen

Aus JobWiki
Wechseln zu: Navigation, Suche

Eine Vorlage ist eine Seite, die sich als Textbaustein verwenden lässt, d. h. als vorgefertigten Text, der in einen anderen Text eingefügt wird. Die Hilfebox rechts zeigt eine Übersicht über Vorlagen die in Artikeln verwendet werden.

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:

  1. 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.
  2. {{subst:Titel}} fügt ebenfalls den Inhalt der Vorlage ein, ersetzt den Text jedoch direkt beim Speichern. Auf diese Art werden zum Beispiel neue Benutzer begrüßt, die anschließend auf ihrer Seite auch beim Bearbeiten den Text der Begrüßung vorfinden sollen und kein verwirrendes {{Hallo}}. Andere Vorlagen sind extra so konstruiert, dass man sie mit {{subst:Titel}} einbindet, z.B. die Vorlage Löschantrag.
  3. {{msgnw:Titel}} zeigt im Artikel den Quellcode der Vorlage an. Diese Funktion wird selten, eigentlich nur zur Erklärung von Vorlagen, gebraucht.


Seit Mediawiki 1.6 lassen sich zwei neue Tags in Vorlagen verwenden:

  • Alles, was in einer Vorlage zwischen <includeonly> und </includeonly> steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden ist. Mit <includeonly> lassen sich alle Seiten, die eine bestimmte Vorlage enthalten, einer Kategorie hinzufügen.
  • Alles, was in einer Vorlage zwischen <noinclude> und </noinclude> steht, wird dagegen nur dann angezeigt, wenn die Vorlage direkt betrachtet wird. Mit <noinclude> lassen sich so Vorlagen kategorisieren, mit entsprechenden Vorlagen in anderen Sprachen verlinken oder eine Erklärung anfügen, wie die Vorlage verwendet wird.

Parameter einfügen und verwenden

Oft sollen in einer Vorlage noch Inhalte auftauchen, die sich von Seite zu Seite ändern, zum Beispiel eine Unterschrift oder der Name des Bildes. 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. In den Schwesterprojektvorlagen wird mit diesen Umstand sehr trickreich das Anlegen von mehreren Vorlagen für verschiedene Varianten vermieden, vgl. Vorlage:Wiktionary und die verschiedenen Schreibweisen in Wikipedia:Textbausteine/Schwesterprojekte.

Daneben existieren in MediaWiki auch einige vordefinierte Variablen, die als Parameter nützlich sind, zum Beispiel der Name der aktuellen Seite ({{PAGENAME}}).

Achtung: Parameter im MediaWiki-Namensraum werden anders verwendet ($1, $2 …).

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: Aufzählungszeichen

Will man Aufzählungszeichen, wie am Anfang dieser Zeile, als Parameter benutzen, so sollte in der Vorlage vor dem Parameter eine neue Zeile begonnen werden, wie dies z. B. in der Vorlage:Infobox Film beim Parameter {{{DS}}} für Darsteller der Fall ist.

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&section=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&section=3}}
Folgendes: {{Beispielvorlage|1=http://.../index.php?title=...&action=edit&section=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 | |- || |-
|
|+

Einsatzmöglichkeiten

Vorlagen sind nur dann sinnvoll für Wikipedia, wenn es von ihnen nur eine überschaubare Anzahl gibt, die sich Benutzer auch merken können. Insbesondere sollten Vorlagen nicht doppelt oder sehr ähnlich entstehen. Um dies zu verhindern, sollten Vorlagen von allgemeiner Relevanz gefördert werden, indem sie in eine spezielle Liste in alphabetischer Reihenfolge eingetragen werden: Jobwiki:Textbausteine und/oder Jobwiki:Bewertungsbausteine bzw. Jobwiki:Textvorlagen.

Vorlagen dienen in Wikipedia zur:

  • Konsistenzmaximierung: Mit Vorlagen lässt sich ein einheitliches Erscheinungsbild erreichen. Bekannte Beispiele sind etwa die Vorlage:Begriffsklärung oder Vorlage:Commons.
  • Redundanzminimierung: Wenn der Inhalt zentral nur an einer Stelle festgelegt wird (d. h. in einer Vorlage), dann erscheint der Inhalt in allen Artikeln gleich, auch bei einer nachträglichen Änderung. Das mühselige und fehlerträchtige Übertragen einer Änderung in jeden Artikel entfällt. Bekannte Beispiele sind hier die sogenannten Navigationsbausteine.
  • Workflowoptimierung: Mit einer Vorlage kann ein Wikiautor prägnant anderen Wikiautoren mitteilen, in welche Richtung ein Artikel verbessert werden sollte. Bekannte Beispiele sind: Vorlage:URV (Urheberverletzung), Vorlage:Überarbeiten oder Vorlage:Löschantrag. Bei der Verwendung der Vorlagen wird der Artikel automatisch in spezielle Aufgabenlisten (to-do list) für andere Wikiautoren oder Administratoren eingetragen.
  • Codeoptimierung: Manche schöne Darstellung lässt sich nur mit einem unschönen Mix aus Wikibefehlen und HTML- bzw. CSS-Befehlen erreichen. Der Artikelquellcode wird dann schnell unübersichtlich und verschreckt Wikianfänger sich auch an der weiteren Verbesserung eines Artikels zu beteiligen. Hier kann eine Vorlage helfen, den Artikelquellcode lesbarer zu gestalten. Ein bekanntes Beispiel ist Vorlage:Gesprochene Wikipedia.

Sie sollten nicht dienen als:

  • Benutzersignaturen: Die Idee, Vorlagen für die eigene Benutzersignatur zu verwenden, mag ja gut klingen: man muss nur die Vorlage ändern und alle Signaturen, die man irgendwann mal hinterlassen hat, werden „aktualisiert“. Dabei sollte man aber die nicht ganz offensichtliche Tatsache bedenken, dass jede Benutzung einer Vorlage eine zusätzliche Anfrage an die Datenbank bedeutet und somit die Wikipedia belastet, ohne zum eigentlichen Zweck derselben beizutragen. Daher werden Signaturvorlagen nicht so gern gesehen. Man sollte lieber zu seinen alten Signaturen stehen.
  • Abkürzung der Wikisyntax: Die Abkürzung von regelmäßig vorkommenden Textbausteinen durch Vorlagen mag praktisch sein (beispielsweise {{BND}} statt [[Bundesnachrichtendienst]] der Bundesrepublik Deutschland. Im normalen Fließtext haben Vorlagen jedoch nichts zu suchen, da sie die Bearbeitung für Außenstehende erschweren und die Artikeltexte so nicht mehr für sich verständlich sind.

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. Eine Kurzerklärung bietet sich an, wenn ein Parameterbeispiel ausreicht wie etwa in Vorlage:Link-Bild. Besser ist es aber, wenn auf eine Erklärungsseite unter Wikipedia:Textbausteine verwiesen wird, wie es vorbildlich bei der Vorlage:Commons der Fall ist.

Ausführliche Dokumentation auf der Diskussionsseite

Für eine ausführliche Dokumentation eignet sich die Diskussionsseite einer Vorlage besser, insbesondere wenn Überschriften verwendet werden. Es wird folgende Gliederung mit Layout empfohlen. Ein Beispiel für Vorlage:Löschantrag:

  • Funktion: Diese Vorlage dient dazu, einen Artikel zum Löschen vorzuschlagen
  • Verwendung:

{{subst:Löschantrag}} ''Deine Begründung'' --~~~~ ----

<div style="margin:1em; padding:1em; border:solid 1px #FF0040; background-color:#FFFFFF">
* '''Funktion:''' Diese Vorlage dient dazu, ...
* '''Verwendung:'''
</div>

Kategorisierung

Jede Vorlage sollte in eine Kategorie eingeordnet werden. Dabei ist zu beachten, dass dies innerhalb von <noinclude>...</noinclude> geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird.


Dieser Artikel basiert auf dem Artikel Vorlagen aus der freien Enzyklopädie Wikipedia und steht unter der GNU-Lizenz für freie Dokumentation. In der Wikipedia ist eine Liste der Autoren verfügbar.