Ardapedia:Vorlagen

< Hilfe < Bausteine < Vorlagen

Hilfe

Bausteine Textbausteine Textvorlagen Variablen Vorlagen Vorlagenprogrammierung Benutzerkonto Bilder Einsteigerinfos FAQ Formatieren Formatvorlagen Seite bearbeiten Seitenverwaltung Software

Vorlagen sind Seiten, die als Textbausteine in Artikel eingebunden werden können. Vorlagen tragen den Präfix „Vorlage:“, sie befinden sich im Namensraum „Vorlage“. Eine Übersicht über sämtliche Vorlagen der Ardapedia findet man hier. Außerdem sollten alle Vorlagen in die Kategorie:Vorlagen oder eine ihrer Unterkategorien eingeordnet werden.

Funktion

Vorlagen können dazu dienen

• ein einheitliches Erscheinungsbild zu erreichen,
• den Artikelquelltext durch das Auslagern von Formatierungsbefehlen lesbarer zu gestalten und
• das vielfache manuelle Einfügen derselben Inhalte in mehrere Artikel zu vermeiden; letzteres gilt jedoch nicht für Fließtext in Artikeln.

Erstellung und Bearbeitung

Eine Vorlage wird wie jede andere Wiki-Seite erzeugt und bearbeitet, ersteres vorzugsweise indem man auf der Spielwiese einen Link [[Vorlage:Vorlagenname]] anlegt, dem Link folgt und die neue Seite bearbeitet und mit dem gewünschten Inhalt füllt (siehe dazu auch Neue Seite anlegen).

Verwendung

Es gibt drei Möglichkeiten, eine Vorlage in einen Artikel einzubinden:

1. In der Regel wird eine Vorlage eingebunden, indem in den Quelltext eines Artikels der Name der Vorlage ohne den Präfix „Vorlage:“ innerhalb von zwei geschweiften Klammern eingefügt wird: {{Vorlagenname}}. Beim Anzeigen des Artikels wird dies dann durch den Inhalt der Vorlage „Vorlagenname“ ersetzt. Spätere Änderungen an der Vorlage wirken sich unmittelbar auf die Darstellung in den sie so verwendenden Artikeln aus.
2. Eine Vorlage kann auch durch {{subst:Vorlagenname}} per Substitution eingebunden werden. Beim Abspeichern des Artikels wird dies im Quelltext durch den Inhalt der Vorlage ersetzt. Spätere Änderungen an der Vorlage wirken sich nicht auf die Darstellung in Artikeln aus, in welche die Vorlage auf diese Weise vor den Änderungen eingebunden wurde.
3. Bindet man eine Vorlage mittels {{msgnw:Vorlagenname}} in einen Artikel ein, wird bei der Anzeige des Artikels der Quelltext der Vorlage wiedergegeben. Diese Funktion kann zur Erläuterung einer Vorlage Verwendung finden.

Man kann auch Seiten, die sich nicht im Namensraum „Vorlage“ befinden, als Textbausteine verwenden. Beispielsweise ließe sich die Seite „Ardapedia:Name“ mittels {{Ardapedia:Name}} als Vorlage einbinden. Bei Seiten aus dem Artikelnamensraum muss dazu ein Doppelpunkt vor den Namen gesetzt werden, also z. B. {{:Name}}.

<noinclude> und <includeonly>

Alles, was in einer Vorlage zwischen <noinclude> und </noinclude> steht, wird nur angezeigt, wenn die Vorlage direkt aufgerufen wird, nicht aber in einem Artikel, in den sie eingebunden ist. Dies kann dazu verwendet werden, die Vorlage einer Kategorie zuzuordnen und Hinweise zu ihrer Funktion zu geben. Siehe dazu den Abschnitt Dokumentation weiter unten auf dieser Seite.

Das Gegenstück dazu ist <includeonly></includeonly>. Alles, was zwischen diesen Tags steht, wird nur in den Artikeln angezeigt, in welche die Vorlage eingebunden wird, nicht aber auf der Seite der Vorlage selbst. Dies kann beispielsweise dazu benutzt werden, alle Artikel, die eine bestimmte Vorlage verwenden, einer Kategorie zuzuordnen.

Parameter

Eine Vorlage kann nicht nur vorher festgelegte Inhalte in einen Artikel einfügen, sondern über Parameter auch vom Verwender der Vorlage zu bestimmende variable Inhalte.

Parameter können entweder durchnummeriert werden oder mit einem Namen bezeichnet werden. Im Quelltext der Vorlage werden sie in drei geschweifte Klammern gefasst: {{{1}}} oder {{{PARAMETERNAME}}}.

Um bei der Verwendung einer Vorlage mit Parametern einem Parameter einen Wert zuzuweisen, fügt man nach dem Namen der Vorlage die Bezeichnung des Parameters, ein Gleichheitszeichen und den gewünschten Wert des Paramters ein, getrennt von einem senkrechten Strich (dem Pipe-Symbol „|“): {{Vorlagenname|1=Wert|2=Wert2}} oder {{Vorlagenname|PARAMETERNAME=Wert|PARAMETERNAME2=Wert2}}.

Bei der Verwendung von Nummern als Parameter kann dies grundsätzlich auch vereinfacht notiert werden: {{Vorlagenname|Wert1|Wert2}}. Diese Schreibweise funktioniert nicht, wenn der Wert ein Gleichheitszeichen enthält.

Da das Zeichen „|“ zur Trennung von Parametern verwendet wird, darf es nicht in Parameterwerten vorkommen. Möchte man Tabellensyntax in Parameterwerten verwenden, muss man daher die folgenden Vorlagen verwenden:

• Vorlage:! für |
• Vorlage:!- für |-
• Vorlage:!+ für |+

Man kann einem Parameter einen Standardwert zuordnen, der ausgegeben wird, wenn dem Parameter bei der Verwendung der Vorlage kein Wert zugewiesen wird: {{{1|Standardwert}}} oder {{{PARAMETERNAME|Standardwert}}}.

Daneben kennt die MediaWiki-Software einige vordefinierte Variablen, die als Parameter verwendet werden können, wie beispielsweise den Namen der aktuellen Seite ({{PAGENAME}}. Siehe dazu Ardapedia:Variablen.

Vorlagenprogrammierung

In Vorlagen ist auch die Verwendung bestimmter Konstrukte einer Programmiersprache möglich. Siehe dazu Ardapedia:Vorlagenprogrammierung.

Dokumentation

Alle Vorlagen sollen auf der entsprechenden Diskussionsseite erläutert werden. Dazu wird in die Vorlage in <noinclude>-Tags eingeschlossen die Vorlage:Vorlagendokumentation eingebunden. Außerdem wird die Vorlage in die Kategorie:Vorlagen oder eine ihrer Unterkategorien eingeordnet:

<noinclude>{{Vorlagendokumentation}}
[[Kategorie:Vorlagen|Vorlagenname]]</noinclude>

Außerdem sollen Vorlagen auf der Seite Ardapedia:Textbausteine eingefügt werden.

Die Erklärung der Vorlage auf der Diskussionsseite geschieht nach folgendem Schema:

== Beschreibung ==

=== Funktion ===

Zunächst werden der Zweck und die Funktion der Vorlage erläutert.

=== Verwendung ===

Anschließend wird erklärt, wie die Vorlage verwendet wird. Gegebenenfalls werden die Parameter der Vorlage erläutert. Dies erfolgt bei mehreren Parametern mittels einer Tabelle:

{| {{Tabellendesign}}
|- {{Highlight}}
! Parameter
! Art
! Funktion
|-
| PARAMETER1
| '''m'''
| Beschreibung der Funktion des ersten Parameters
|-
| PARAMETER2
| k
| Beschreibung der Funktion des zweiten Parameters
|}

* In der Spalte „Art“ bedeuten die Buchstaben:
** m: der Parameter '''m'''uss angegeben werden,
** k: der Parameter '''k'''ann angegeben werden.
* Werden optionale Parameter nicht angegeben, so sind die Felder leer zu lassen und nicht zu entfernen.
* Soll in einem Feld ein Gleichheitszeichen vorkommen, muss dieses in <nowiki><nowiki></nowiki>-Tags eingegeben werden: <nowiki><nowiki>=</nowiki></nowiki>. Ansonsten wird das betreffende Feld nicht angezeigt.

=== Copy & Paste ===

<pre>
{{Vorlagenname
|PARAMETER1=
|PARAMETER2=
}}

=== Beispiele ===
Hier können Seiten angegeben werden, welche die Vorlage verwenden.
== Diskussion ==
Ab hier beginnen dann gegebenenfalls die Diskussionen über die Vorlage.

Diese Seite basiert auf der Seite Hilfe:Vorlagen aus der freien Enzyklopädie Wikipedia und steht unter der Creative Commons Attribution/Share-Alike-Lizenz. In der Wikipedia ist eine Liste der Autoren verfügbar.