Help:Vorlagen

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:Templates and the translation is 71% complete.

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Napulitano • ‎Nederlands • ‎Tagalog • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎be-tarask • ‎català • ‎dansk • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎lietuvių • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎suomi • ‎čeština • ‎български • ‎русский • ‎српски / srpski • ‎українська • ‎עברית • ‎اردو • ‎العربية • ‎سنڌي • ‎فارسی • ‎پښتو • ‎भोजपुरी • ‎मैथिली • ‎हिन्दी • ‎বাংলা • ‎মেইতেই লোন্ • ‎தமிழ் • ‎ಕನ್ನಡ • ‎中文 • ‎日本語 • ‎한국어
PD Hinweis: Wenn Du diese Seite bearbeitest, stimmst Du zu, dass Deine Bearbeitungen unter CC0 veröffentlicht werden. Siehe Public Domain Help Pages für genauere Informationen.
PD

Wenn du Standardtexte hast, die du auf verschiedenen Seiten einbinden möchtest, kommt die Funktionalität von einer Vorlage bei MediaWiki ins Spiel. Anders als Erweiterungen und Mediendateien gibt es keine zentrale Quelle für Vorlagen. Vorlagen können neu geschrieben oder, um doppelte Arbeit zu sparen, von einem anderen Wiki wie z.B. Wikipedia exportiert und dann im Zielwiki importiert werden.

Erstellen

Vorlagen sind Standard-Wiki-Seiten, deren Inhalt so konzipiert ist, dass er in andere Seiten transkludiert (eingebunden) werden kann. Vorlagen folgen einer Konvention, laut welcher dem Name das Präfix "Template:" vorangestellt wird, um sie diesem Namensraum zuzuweisen; abgesehen davon können sie wie jede andere Wiki-Seite erstellt werden.

Die einfachste Verwendung von Vorlagen ist wie folgt. Wenn man eine Seite mit dem Namen "Vorlage:Willkommen" mit diesem Inhalt erstellt:

Hallo! Willkommen in diesem Wiki.

hat man bereits die erste Vorlage erstellt! Wenn man nun den Code

{{Willkommen}}

in irgendeiner anderen Seite einfügt, wird auf dieser Seite der Text "Hallo! Willkommen in diesem Wiki." anstatt {{Willkommen}} erscheinen. Der Vorlageninhalt wurde somit in die andere Seite übernommen, d.h., er wird in diese Seite integriert.

Man kann nun {{Willkommen}} an einem beliebigen Punkt auf jeder Seite, wo man jemanden begrüßen möchte, einfügen. Nehmen wir an, die Vorlage wird auf 100 Seiten verwendet. Wenn man dann den Vorlageninhalt ändert zu:

Hallo! Willkommen in diesem wundervollen Wiki.

und eine der 100 Seiten, in der die Vorlage verwendet wurde, erneut besucht, wird man den neuen Text anstelle des ursprünglichen sehen. Auf diese Weise kann man die Inhalte von 100 Seiten ändern, ohne diese bearbeitet zu haben - und das nur, weil die Vorlage in diese Seiten eingebunden ist.

Dies ist die grundsätzliche Funktionsweise. Es gibt viele zusätzliche Funktionen, die diese Funktionsweise erweitern und die Verwendung von Vorlagen sehr nützlich machen.

Verwendung

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}} - wenn diese Form eines Vorlagenlinks verwendet wurde, wird er einmalig durch den Inhalt von [[Vorlage:Name]] ersetzt, wie er zum Zeitpunkt des speicherns der Seite mit dem Vorlagenlink war : Es wird also eine Kopie des Inhaltes von [[Vorlage:Name]] anstatt des Vorlagenlinks substituiert (ersetzt). Der Inhalt wird also zu einem Teil der einschließenden Seite und kann infolgedessen unabhängig vom Original ganz normal bearbeitet werden. Anmerkung: Spätere Änderungen an der Vorlagenseite werden demzufolge nicht auf die Seite mit dem Vorlagenlink übertragen.
  • {{safesubst:Name}} — dies wurde eingeführt, um das Ersetzen zu ermöglichen ohne die Transklusion zu unterbrechen, siehe w:en:Help:Substitution#The safesubst: modifier.
  • {{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.

Jede Wikiseite kann als Vorlage verwendet werden, einfach indem man den Namensbereich angibt, dem sie zugehört.

  • {{Template:Pagename}} bindet [[Template:Pagename]] ein.
  • {{Talk:Pagename}} bindet [[Talk:Pagename]] ein
  • {{:Pagename}} schließt [[Pagename]] ein
    • {{subst::Pagename}} ersetzt sich selbst mit dem Inhalt von [[Pagename]]

Wenn kein solcher Namensbereich vorhanden ist, wird der vollständige Name als Vorlagenname angenommen.

  • {{Foo:Bar}} bindet [[Template:Foo:Bar]] ein

Parameter

Um die Funktionalität von Vorlagen zu erweitern, erlaubt MediaWiki es, Parameter an die Vorlage zu übergeben wenn sie eingebunden wird. Parameter ermöglichen es der Vorlage unterschiedliche Inhalte zu erzeugen oder sich sich unterschiedlich zu verhalten.

Stell dir vor, du möchtest eine kleine Dankesnote in talk page vonanderen Benutzern einfügen, z.B.:

Example sunflower image
Ein kleines Dankeschön...
für deine Bemühungen.
Grüße, Ich


Die Dankesnote wird einen Grund (in diesem Fall, für deine Bemühungen) und eine Unterzeichnung (Ich) enthalten. Dein Ziel ist es, dass jeder Benutzer jedem anderen Benutzer danken kann, aus einem beliebigen Grund.

Damit die Notiz überall, wo sie verwendet wird, ähnlich aussieht, kann beispielsweise eine Vorlage namens Template:Thankyou/de definiert werden. Obwohl die Notiz immer ähnlich aussehen soll, wenn ein Benutzer einem anderen Benutzer dankt, wird der spezifische Inhalt (d.h. der Grund und die Signatur) unterschiedlich sein. Deswegen sollten diese als Parameter übergeben werden. Wenn wir die verbleibenden Elemente zum Formatieren der Box und zum Platzieren des Bildes ignorieren, lautet der Kerninhalt der Vorlage wie folgt:

'''Ein kleines Dankeschön...'''
für {{{1}}}.
Grüße, {{{2}}}

Die Verwendung von {{{1}}} und {{{2}}} muss beachtet werden. Auf diese Weise können innerhalb von Vorlagen die Parameter identifiziert werden, die bei der Verwendung der Vorlage angegeben werden. Beachten Sie, dass jeder Parameter der Vorlage von drei Klammern umgeben ist: {{{ }}}. Dies unterscheidet sich von der normalen Verwendung des Namens der Vorlage.

Bei der Verwendung einer Vorlage auf einer Seite werden die Parameterwerte durch ein "Pipe"-Zeichen getrennt (|). MediaWiki erlaubt Parameter auf drei Arten an Vorlagen zu übergeben: Anonym, nummeriert und benannt.

Anonyme Parameter

Um anonyme Parameter zu übergeben, müssen die Werte der Parameter der Reihe nach aufgelistet werden:

{{Thankyou/de|deine Bemühungen|Ich}}

In diesem Fall erhält die Vorlage {{Thankyou/de}} die Parameter {{{1}}}=deine Bemühungen und {{{2}}}=Ich, was folgendes erzeugt:

Example sunflower image
Ein kleines Dankeschön...
für deine Bemühungen.
Grüße, Ich


Die Reihenfolge, in der anonyme Parameter übergeben werden, ist entscheidend für ihr Verhalten. Das Tauschen der Parameter wie folgendend:

{{Thankyou/de|Ich|deine Bemühungen}}

würde dieses Ergebnis erzeugen:

Example sunflower image
Ein kleines Dankeschön...
für Ich.
Grüße, deine Bemühungen


Hinweis: Parameter durch die Reihenfolge zu identifizieren (mit {{{1}}}, etc) funktioniert nur mit anonymen Parametern. Jeder Parameter, der mit Namen identifiziert wird, wie unten gezeigt, wird für die Vorlage durch Verwendung von Ordnungszahlen nicht zugänglich sein.

Hinweis: Wenn ein Gleichheitszeichen innerhalb des Arguments eines anonymen Parameters einer Vorlage vorkommt, wird dieser Parameter möglicherweise als ein Benannter Parameter (was weiter unten in diesem Dokument erläutert wird) falsch interpretiert, wodurch der Text vor dem Gleichheitszeichen als Parametername und der Text danach als der Wert des Arguments. Dies ist ein häufiges Problem, wenn Sie einen externen Link oder ein HTML-Element mit Attributen erfassen (siehe Task 16235). Um das Problem zu umgehen, können benannte oder nummerierte Parameter verwendet werden, wie im folgenden Abschnitt erläutert wird.

Nummerierte Parameter

Um Parameter nummeriert zu übergeben, werden alle Parameter beim Übergeben identifiziert:

{{Thankyou/de|2=Ich|1=deine Freundschaft}}

Dieses Mal erhält die Vorlage {{Thankyou/de}} die Parameter {{{1}}}=deine Freundschaft und {{{2}}}=Ich, was folgendes erzeugt, obwohl die Parameter in umgekehrter Reihenfolge übergeben wurden:

Example sunflower image
Ein kleines Dankeschön...
für deine Freundschaft.
Grüße, Ich


Benannte Parameter

Der dritte Weg, um Parameter zu übergeben, ist mit Namen statt mit Nummern. In diesem Fall würde der Inhalt der Vorlage zu folgendem geändert werden:

'''Ein kleines Dankeschön...'''
für {{{reason}}}.
Grüße, {{{signature}}}

Innerhalb der Vorlage werden {{{reason}}} und {{{signature}}} statt Nummern verwendet, um jeden Parameter zu identifizieren. Um Parameter benannt zu übergeben, werden alle Parameter beim Übergeben identifiziert:

{{Thankyou/de|signature=Ich|reason=sein, wer du bist}}

In diesem Fall erhält die Vorlage {{Thankyou/de}} die Parameter {{{reason}}}=sein, wer du bist und {{{signature}}}=Ich und erzeugt:

Example sunflower image
Ein kleines Dankeschön...
für sein, wer du bist.
Grüße, Ich

Benannte Parameter beachten Groß- und Kleinschreibung, weswegen:

{{Thankyou/de|signature=Ich|Reason=sein, wer du bist|reason=Beachtung der Groß- und Kleinschreibung}}

folgendes erzeugt:

Example sunflower image
Ein kleines Dankeschön...
für Beachtung der Groß- und Kleinschreibung.
Grüße, Ich


Der Vorteil der Verwendung von benannten Namensräumen in einer Vorlage ist, neben der Flexibilität der Reihenfolge der Parameter bei der Übergabe, dass der Code der Vorlage leichter zu verstehen ist, wenn viele Parameter vorkommen.

Standardwerte

Beim Einsetzen einer Vorlage, die Parameter erwartet, ohne Argumente bereitzustellen, wie folgend:

{{Thankyou/de}}

würde bei nummerierten Parametern, wie im oberen Beispiel, folgendes Ergebnis erzeugt werden:

Example sunflower image
Ein kleines Dankeschön...
für {{{1}}}.
Grüße, {{{2}}}


Da keine Argumente übergeben wurden präsentiert die Vorlage die bloßen Parameter statt der repräsentierten Werte. In diesem Fall wäre es hilfreich, Standardwerte für Parameter zu erzeugen, d.h. Werte, die benutzt werden, wenn keine Werte übergeben werden. Zum Beispiel, wenn die Werte der Vorlage zu folgendem geändert werden:

'''Ein kleines Dankeschön...'''
für {{{reason|alles}}}.
Grüße, {{{signature|Ich}}}

dann definiert {{{reason|alles}}}, dass, wenn keine Argumente übergeben werden, für den Parameter {{{reason}}}, der Wert alles verwendet. Genauso definiert {{{signature|Ich}}} den Standardwert des Parameters {{{signature}}} als den Wert Ich. Wenn jetzt die Vorlage eingesetzt wird, ohne Argumente zu übergeben, wird folgendes Ergebnis erzeugt:

Example sunflower image
A little thank you...
for alles.
hugs, Ich


Reihenfolge der Auswertung

Mit ein paar Ausnahmen, werden Parameter vollständig ausgewertet, bevor sie an die Vorlage übergeben werden. Deswegen wird, wenn einer der Parameter der Aufruf einer weiteren Vorlage ist, eigentlich der erweiterte Parameter übergeben.

{{Thankyou/de|reason=besuchen ({{Willkommen}})|signature=Ich}}

wird zu

{{Thankyou/de|reason=besuchen (Hallo! Willkommen in diesem Wiki.)|signature=Ich}}

bevor es zu folgendem wird:

Example sunflower image
Ein kleines Dankeschön...
für besuchen (Hallo! Willkommen in diesem Wiki.).
Grüße, Ich


In einigen Fällen unterscheidet sich diese Reihenfolge der Auswertung von der Alternative. (Die Alternative ist, die Ergebnisse des Aufrufs der Vorlage nach weiteren Vorlagen zu durchsuchen, die erweitert werden müssen.)

Erstens kann der Name der Vorlage gleichzeitig und auf die gleiche Art erweitert werden, wie die Parameter.

Auf diese Art könnte sich

{{Thankyou in {{preffered language}}|signature=Ich}}

zu

{{Thankyou in French|signature=Ich}}

erweitert werden,

damit eine Vorlage, die Thankyou in French heißt, das Dankeschön in der bevorzugten Sprache anzeigen kann (wie auch immer das festgelegt wurde).

Zweitens kann die aufgerufene Vorlage keine Vorlage aus Stücken erstellen, die später aufgeruft werden. Eine Vorlage mit der Form {{start of call}}{{end of call}} würde nicht funktionieren, wenn start of call {{Thankyou/de| und end of call signature=Ich}} wäre.

Drittens wird der übergebene Parameter nur einmal erweitert statt an jeder Stelle, an der der Parameter in der Vorlage verwendet wird, da dies auf dem MediaWiki-Server effizienter ist.

Schließlich kann die aufgerufene Vorlage nicht verhindern, dass der Parameter insgesamt erweitert wird. Auch wenn eine Vorlage einen Parameter nur in bestimmten Umständen verwendet, wird erweitert, bevor dieser Aufruf gemacht wird.

Exceptions to the order of evaluation

In a few circumstance template parameters are not evaluated before being passed to the template.

Parameters to a subst: expansion are not evaluated, but are passed literally.

Some magic words are not evaluated as parameters. Their evaluation is delayed because they have side-effects. For example, {{foo| {{{DISPLAYTITLE:main page}}} }} would not

  1. evaluate DISPLAYTITLE
  2. change the display title of the page and
  3. call foo with parameter 1 being blank

instead

  1. DISPLAYTITLE would not be evaluated (yet)
  2. foo would be called with parameter 1 being {{{DISPLAYTITLE:main page}}}
  3. only if {{{1}}} is evaluated in foo, would the display title of the page be changed.

Which magic words are evaluated late like this has not been fully documented. Known ones include:

Recursion in templates

Including a template in itself won't throw MediaWiki into infinite recursion. MediaWiki will stop the recursion with the template's name in bold. For example, if the content of "Template:Aaaa" is "{{Aaaa}}", it'll show as "Template:Aaaa".

Steuern der Vorlageneinbindung

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:

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.

  • Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the job queue. To force the re-categorization of a particular page, open that page for editing and save it without changes.
  • Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside <noinclude> and <includeonly> is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page. The focus is on what is inside these two tags.

Everything outside <onlyinclude> tags is discarded in the transclusion. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

Nesting of these tags is also possible.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.

Organisation von Vorlagen

Damit Vorlagen effektiv sein können, müssen Nutzer sie schnell finden können und dazu in der Lage sein, sie zu nutzen.

Um Vorlagen zu finden können Benutzer:

  1. auf Spezialseiten > Alle Seiten klicken.
  2. in der Namensraum:-Liste Vorlage auswählen und auf Anwenden klicken.

Eine einfache Technik ist die Integration eines Beispiels auf der Vorlagenseite. Zum Beispiel:

<noinclude>
== Verwendung ==
Benutzer begrüßen:
{{Thankyou|reason=deine Begründung|signature=deine Signatur}}
</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.

Linking to a template

A template page can be linked to like any other wiki page. For example, the link Template:Navbar is generated using the wikicode [[Template:Navbar]].

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code {{tl|Navbar}} may be used to create the link {{Navbar}}.

This construct is commonly used in template documentation, on help pages, and on talk pages when referring to templates. The same effect can be achieved by using <code>{{[[Template:Navbar|Navbar]]}}</code>, but the {{tl}} approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element, as shown here. If not, another similarly named template may do so. See, for example, the "See also" section of the documentation of en:Template:Tl at the English Wikipedia.

Copying from one wiki to another

Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

MediaWiki Code

Falls man Importrechte im neuen Wiki hat:

  1. Gehe im Urspungs-Wiki/im originalen Wiki auf Special:Export und downloade .xml-Datein mit den gesamten Versionsgeschichten aller notwendigen Vorlagen. Verfahre dazu wie folgt:
    • Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
    • Kontrolliere das Kästchen "Inklusive Vorlagen".
    • Entferne das Häkchen in dem Kästchen "Nur die aktuelle Version der Seite exportieren".
    • Klicke auf Seiten exportieren.
  2. Gehe im neuen Wiki auf Special:Import und lade dort die .xml-Datei hoch.

Falls man keine Importrechte auf dem neuen Wiki hat:

  1. Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
  2. On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
  3. Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Erweiterungen

An extension often used in templates is ParserFunctions. Visit page ParserFunctions and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the ParserFunctions extension. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it. In case it's used, you need to install the Scribunto extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS und JavaScript-Code

Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.

  1. Look for the use of CSS classes (text like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
  2. If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Siehe auch

External links