Help:Templates/de

Wenn du Standardtexte hast, die du auf verschiedenen Seiten einbinden möchtest, kommt das MediaWiki Vorlagen-Feature ins Spiel. Anders als Erweiterungen und Mediendateien gibt es kein zentrales Lager für Vorlagen. Vorlagen können neugeschrieben oder, um doppelte Arbeit zu sparen, von einem anderen Wiki wie z.B. Wikipedia exportiert und anschließend im Zielwiki importiert werden.

Erstellen einer Vorlage
Vorlagen sind Standard-Wiki-Seiten, deren Inhalt so konzipiert ist, dass er in andere Seiten transkludiert (eingebunden) werden kann. Vorlagen folgen der Namenskonvention, dass die Seite mit dem Präfix " " beginnt. Vorlagen können wie jede andere Seite im Wiki 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

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

Mann kann nun  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 die Vorlageninhalt ändern zu:

Hallo! Willkommen in diesem wundervollen Wiki.

und eine der 100 Seiten, in dem 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ätzlich 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:


 * fügt den Inhalt der Vorlage "Vorlage:Name" zu dem Zeitpunkt ein, wenn die Seite, welche diese Anweisung enthält, aufgerufen wird.
 * - 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.
 * — this was introduced to allow for substitution that doesn't break transclusion, see w:en:Help:Substitution.
 * 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  tut.

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


 * bindet  ein.
 * bindet  ein
 * includes
 * replaces itself with the contents of

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


 * bindet  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.:

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.

So that the note will look similar everywhere it is used, you can define a template called Template:Thankyou, for example. Although the note should look similar whenever a user thanks another user, its specific contents (i.e. the reason and the signature) will be different. For that reason, you should pass them as parameters. If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:

Notice the use of  and. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces:. This is different from normal template name usage.

When using the template on a page, you fill in the parameter values, separated by a "pipe" character. MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

Anonyme Parameter
To pass in anonymous parameters, list the values of those parameters sequentially:

In this case, the  template receives parameters   and , producing:

The order in which anonymous parameters are passed in is crucial to its behavior. Reversing the order of the parameters, like so:

would produce this result:

Note: Identifying parameters by order (with, etc) works only with anonymous parameters. If your page identifies any parameter by number or name, as shown below, this method will no longer be available to the template which receives them.

Note: If an equal sign appears inside the argument to an anonymous template parameter, that parameter may be misinterpreted as a named parameter (which is explained below in this document) treating the text before the equal sign as the parameter name and the text after it as the argument value. This is a common problem when you need to include an external link, or an HTML element with attributes (see Task 16235). The workaround is to use named parameters instead, or even numbered parameters as explained in the following section.

Nummerierte Parameter
To pass in parameters by number, identify each parameter when passing it:

This time, template  receives parameters   and , though they have been supplied in inverse order, and produces:

Benannte Parameter
The third way of passing parameters is by name, instead of numbers. In this case, the template contents would be changed to:

A little thank you... for. hugs,

Within the template, we use  and   to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

In this case, template  receives parameters   and   and produces:

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

Standardwerte
If you transclude a template that expects parameters, but do not provide their arguments, in this way:

in the numbered parameters example above you would get the following:

Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

then  defines that if no argument is provided for parameter , then the value   will be used. Similarly,, defaults parameter   to value. Now, transcluding the template again without passing any argument results in the following:

Order of evaluation
Template parameters are fully evaluated before they are passed to the template. So if one of your parameters is a call to another template, what is actually passed is the expanded parameter.

becomes before it becomes:

In a few circumstances, this order of evaluation makes a difference from the alternative. (The alternative being to check the results of the template call to see if there are additional templates to be expanded.)

First, the name of the template can be expanded at the same time and in the same way as the parameters.

Thus might expand to So that a template called  could display the thank you in the preferred language (however that was determined.)

Secondly, the template being called can't construct a template from pieces to be called later. A template that took the form would not work if was and was.

Thirdly, the parameter being passed is expanded only once, rather than every place the parameter is used in the template. This is more efficient on the mediawiki server.

Finally, the template being called can't stop the parameter from being expanded altogether. Even if a template only uses a parameter in some circumstances, it will always have been expanded before the call was made.

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 " ", it'll show as "Template:Aaaa".

Steuern der Vorlageneinbindung
Du kannst das Einbinden der Vorlagen durch die Verwendung von - und  -Tags steuern.

Alles zwischen  und   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. Text zwischen  und   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 . 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  and   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  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 ' > ' klicken.
 * 2) in der '-Liste Vorlage auswählen und auf ' klicken.

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

Verwendung
Benutzer begrüßen:

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
To link to a template instead of including it, use the tl template. The name of the template the editor wants to link to goes after the vertical pipe. For example: links to the navbar template.

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:
 * 2) * 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.
 * 3) * Kontrolliere das Kästchen "".
 * 4) * Entferne das Häkchen in dem Kästchen "".
 * 5) * Klicke auf.
 * 6) 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 and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the. 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  in template code is a good sign for it. In case it's used, you need to install the 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  ) 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

 * – a template special use case example
 * – fancy stuff you may find in some templates
 * - additional fancy control functions such as #if and #switch
 * - guidance on using parser functions in templates
 * m:Help:Template – contains a much more thorough manual on how exactly templates function
 * m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable variables
 * m:Help:Embed page – embedding pages from namespaces other than.
 * m:Help:Embed page – embedding pages from namespaces other than.