Hilfe:Vorlagen/ Verwenden

Aus Wikibooks
Wechseln zu: Navigation, Suche

Hoch zum Lehrbuch

Vorlagen: FindenVerwendenBenennenErstellenErklären


Die Beschreibung sollte auf der Vorlagenseite erklären, wie man eine Vorlage verwendet. Hier werden allgemeine Verfahren beschrieben.

Allgemeine Hinweise[Bearbeiten]

Ausprobieren auf der Spielwiese[Bearbeiten]

Da wiederholte Änderungen „nur zum Probieren“ nicht sinnvoll sind, hat Wikibooks die Spielwiese vorbereitet.

  • Gehe auf diese Seite und öffne sie zum Bearbeiten.
  • Kopiere den Inhalt des ersten Kommentars, nämlich {{Bitte nicht ändern|~~~~}} an das Ende der Seite (hinter den markierten Block) und speichere die Seite mit Veröffentlichen ab. Dadurch wissen andere Nutzer, dass die Spielwiese im Moment von dir genutzt wird.
  • Öffne die Seite erneut zum Bearbeiten und beginne mit den eigentlichen Versuchen.

Alle folgenden Beispiele sind dazu gedacht, dass sie auf der Spielwiese getestet werden. Übrigens werden fast alle Eingaben bereits durch das Vorschau zeigen umgesetzt; das „Veröffentlichen“ einer Änderung ist überflüssig.

Nach Abschluss der Tests sollte die Spielwiese wieder aufgeräumt werden: Öffne sie erneut zum Bearbeiten, lösche alles unterhalb des markierten Blocks, kontrolliere den Zustand mit „Vorschau zeigen“ und speichere die Seite mit „Veröffentlichen“ ab.

Beispiele suchen[Bearbeiten]

Bei einer bestimmten Vorlage ist es oft nützlich zu wissen, wo und wie sie verwendet wird. Dazu gibt es diese Verfahren:

  • Lies die Beschreibung der Vorlage. Sie wird in aller Regel direkt bei der Vorlage angezeigt.
  • Lies die Definition der Vorlage. Dazu gehst du auf    Bearbeiten    oder    Quelltext anzeigen    (oben auf der Seite).
  • Prüfe die Seiten, die eine Vorlage verwenden. Auf der Seite der Vorlage erhältst du (links unter Werkzeuge) die Links auf diese Seite. Alle diese Links enthalten die betreffende Vorlage; im Quelltext einer Seite steht, wie die Vorlage eingebunden ist.

Vorlagen ohne Variablen[Bearbeiten]

Weil die Vorlagen zu verschiedenen Namensräumen gehören, werden sie leicht unterschiedlich benutzt.

Projektweite Vorlagen[Bearbeiten]

Eine solche Vorlage wird mit zwei geschweiften Klammern einfach in den Text eingefügt. Beide folgenden Varianten funktionieren:

{{Inuse}}
{{Vorlage:Inuse}}

Bei verschiedenen Vorlagen genügt das freilich nicht. Probiere einmal diese Vorlagen aus:

{{Bitte nicht ändern}}
{{Nicht löschen}}
{{Datum}}
  • Bei {{Bitte nicht ändern}} taucht in der Anzeige {{{1}}} auf. Ein Ausdruck mit drei geschweiften Klammern zeigt an, dass es sich um eine Vorlage mit Parametern (also variablen Angaben) handelt und mindestens eine Angabe fehlt.
  • Bei {{Nicht löschen}} wird auf fehlende Texte hingewiesen. Solche Hinweise gehören zu nutzerfreundlichen Vorlagen (leider viel zu selten); auch das ist ein Hinweis auf eine Vorlage mit Parametern.
  • Bei {{Datum}} macht die Anzeige keinen sinnvollen Eindruck. Der Text subst verweist auf subst, nämlich einen der Sonderfälle beim Aufruf (siehe unten).

Bucheigene Vorlagen[Bearbeiten]

Nun wollen wir dasselbe Verfahren mit einer bucheigenen Vorlage wiederholen (ebenfalls mit und ohne den Begriff „Vorlage“):

{{Blender3D: Vorlage:BuchWarnung}}
{{Blender3D: BuchWarnung}}

Die Software sucht – ausgelöst durch die geschweiften Klammern – nach projektweiten Vorlagen, findet sie nicht und liefert uns rote Links. Wir müssen deshalb angeben, dass dem Seitennamen nicht Vorlage: voranzustellen ist. Dazu dient der Doppelpunkt:

{{:Blender3D: Vorlage:BuchWarnung}}
{{:Blender3D: BuchWarnung}}

Für eine bucheigene Vorlage muss also der vollständige Seitenname angegeben werden. Zusätzlich zu den geschweiften Klammern ist ein Doppelpunkt voranzustellen.

Regaleigene Vorlagen[Bearbeiten]

Wie die Liste der regaleigenen Vorlagen zeigt, entsprechen verschiedene Namen nicht den Regeln. Sofern der Name mit Vorlage: beginnt, gehören sie zum Vorlagen-Namensraum, werden von der Software also wie projektweite Vorlagen behandelt. Beim folgenden Beispiel fehlt der Begriff Vorlage:

{{Regal Medizin: Nicht löschen!}}
{{:Regal Medizin: Nicht löschen!}}

Beide Varianten (mit und ohne Doppelpunkt) funktionieren; dies liegt daran, dass Regal ein eigener Namensraum ist. Alle anderen regaleigenen Vorlagen benötigen Parameter.

Einbindung von Nicht-Vorlagen[Bearbeiten]

Der Trick mit dem vorangestellten Doppelpunkt funktioniert auch mit beliebigen anderen Seiten, die keine Vorlagen sind. Du kannst ja spaßeshalber mal unsere Hauptseite in die Spielwiese einbinden:

{{:Hauptseite}}

Es funktioniert! Dieses Verfahren ist vor allem dann sinnvoll, wenn gleiche (oder fast gleiche) Inhalte auf mehreren Seiten angezeigt werden sollen. Das wird beispielsweise für die Navigation zwischen Hilfe-Seiten verwendet (siehe am Anfang dieser Seite):

{{:Hilfe:Vorlagen/ Navi}}

Vorlagen mit Parametern[Bearbeiten]

Sehr oft sollen in einer Vorlage variable Inhalte auftauchen, die sich von Seite zu Seite ändern, zum Beispiel eine Unterschrift oder der Name des Bildes auf den Commons in der Vorlage:NowCommons. Das geschieht mit Parametern. Die Verwendung von variablen Inhalten über Parameter gilt für alle Arten von Vorlagen (projektweite, regalweite, bucheigene) sowie für Nicht-Vorlagen in gleicher Weise.

In der Definition der Vorlage kennzeichnet man durch drei geschweifte Klammern solche Platzhalter, die entweder durchnummeriert oder frei benannt werden; das wird auf der Seite Vorlagen erstellen beschrieben.

Bei der Verwendung werden die Werte der Parameter innerhalb der geschweiften Klammern eingetragen. Die Parameter werden jeweils durch das Pipe-Zeichen | getrennt.

Parameter mit Nummern[Bearbeiten]

Im einfachen Fall stehen die Werte der Parameter einfach hinterander und werden intern (bei Definition und Anzeige) durchnummeriert:

{{Bitte nicht ändern|~~~~}}                       <!-- ein Parameter: die Signatur -->
{{Achtung | Dies ist ein Hinweistext. |center}}   <!-- zwei Parameter: Text, Ausrichtung -->

Der Inhalt eines Parameters kann auch formatiert oder als Link anklickbar erscheinen wie in folgenden Beispielen:

{{Achtung | Dies ist ein '''wichtiger Hinweis'''. }}
{{Achtung | Mehr dazu steht auf der [[Hilfe:Vorlagen|Überblicksseite]]. }}

Sehr oft – vor allem bei Vorlagen zur Navigation – wird der eingegebene Text automatisch als Link dargestellt.

Manche Parameter sind notwendig, andere nicht. Bei der Vorlage:Achtung muss (sinnvollerweise) ein Text angegeben werden; die Ausrichtung des Textes kann festgelegt werden (= center) oder standardmäßig gelten (= left).

Auch bei regal- und bucheigenen Vorlagen sowie bei Nicht-Vorlagen sind Parameter möglich:

Weitere Hinweise siehe {{:Regal:Medizin/ Vorlage:DrugBank|APRD00174|Clonidin}}
{{:Blender3D: Vorlage:Difficulty|Hinweis auf typische Schwierigkeiten und wie man sie vermeidet.}}
{{:Wikibooks:Missbrauchsfilter/ Hinweistext|12}}

Parameter mit Namen[Bearbeiten]

Parameter ohne Namen gibt es üblicherweise bei Vorlagen mit wenigen Parametern, deren Reihenfolge leicht zu verstehen ist. (Intern gelten 1, 2 usw. als Namen.) Wenn eine Vorlage Parameter mit Namen vorsieht, gehört alles zum Aufruf der Vorlage in die geschweiften Klammern:

  • zuerst der Name der Vorlage
  • jeweils nach einem Pipe-Zeichen der Name eines Parameters und nach einem Gleichheitszeichen der Inhalt (Wert) des Parameters

Auf die Reihenfolge der Parameter kommt es dabei nicht an; der Inhalt eines Parameters ist immer der Text zwischen dem Gleichheitszeichen und dem nächsten Pipe-Zeichen. Bei den verschiedenen Arten von Vorlagen sieht das beispielsweise so aus:

{{Kasten |style=Info |inhalt={{Blindtext}} }}
{{:Blender-Handbuch: Vorlage:NavOben|vor=Blender unter Windows kompilieren|zurück=Entwicklerversionen}}
  • Die (regaleigene) Code-Vorlage benutzt die Parameter kopf, lang und code.
{{:Regal:Programmierung: Vorlage:SingleCode|
|kopf=Dies ist ein '''C#-Beispiel'''.
|lang=csharp
|code=public class Beispielklasse
{
  int help;
}
}}

Bei Nicht-Vorlagen gibt es üblicherweise nur wenige Parameter, es werden also Nummern statt Namen verwendet.

Die Schreibweise der Parameternamen ist genau zu beachten und in der Beschreibung anzugeben. Leerzeichen und Zeilenumbruch innerhalb des Aufrufs einer Vorlage, sind möglich; die Auswirkung hängt aber teilweise von der Definition der Vorlage ab und kann mit allgemeinen Regeln kaum erläutert werden.

Vordefinierte Variable[Bearbeiten]

Zusätzlich existieren (ähnlich wie die Signatur ~~~~) einige vordefinierte Variablen, die wie Vorlagen aussehen und oft als Parameter nützlich sind. Beispiele:

Heutiges Datum: {{LOCALDAY2}}. {{LOCALMONTHABBREV}} {{LOCALYEAR}}
Aktuelle Seite: {{PAGENAME}} auf {{SERVER}}
Zurzeit {{NUMBEROFARTICLES}} Seiten in {{NUMBEROFBOOKS}} Büchern

Systemnachrichten[Bearbeiten]

Ein Spezialfall sind die Systemnachrichten im MediaWiki-Namensraum, wo die Parameter fortlaufend mit $1, $2 usw. bezeichnet werden. Mit diesen Nachrichten dürfen sich sowieso nur Administratoren befassen; es wird deshalb hier nicht weiter besprochen.

Sonderfälle beim Aufruf[Bearbeiten]

subst[Bearbeiten]

Wie oben schon festgestellt, funktioniert die Vorlage:Datum nicht mit dem einfachen Aufruf {{Datum}}. Gib zusätzlich auf der Spielwiese dies ein:

{{Datum}}<br />
{{subst:Datum}}

Die zweite Variante mit dem Zusatzbefehl subst: bewirkt eine „Substitution“: Nicht der Aufruf der Vorlage wird veröffentlicht, sondern sie wird durch den aktuellen Inhalt ersetzt und mit dem aktuellen Wert gespeichert.

Am Anfang der Versuche wurde der Vermerk Bitte nicht ändern in die Spielwiese eingetragen; während der Versuche siehst du, dass nach wie vor die Vorlage eingetragen ist. Speichere aber nun den folgenden Vermerk mit einem Klick auf Veröffentlichen:

{{subst:Bitte nicht ändern|~~~~}}

Öffne anschließend wieder zum Bearbeiten. Du siehst, dass der neue Text in der Spielwiese identisch ist mit dem Textkörper der Vorlage:Bitte nicht ändern, der nicht von den Tags <noinclude> und </noinclude> umschlossen ist.

Manche Vorlagen können übrigens – wie Vorlage:Datum – nur mit dem subst:-Befehl sinnvoll verwendet werden. Grundsätzlich gilt das immer dann, wenn die aktuelle Benutzerin und/oder Datum und Uhrzeit fest übernommen werden sollen. Jede dieser Vorlagen sollte in der Beschreibung den Vermerk nur Subst enthalten und damit in der Kategorie:Vorlage:nur Subst stehen.

Was die Verwendung von subst allgemein gesehen an Vor- bzw. Nachteilen bringt, wird bei der Vorlagenerstellung erörtert.

msgnw[Bearbeiten]

Eine ähnliche Wirkung hat der Zusatzbefehl msgnw (Message no-Wiki). Er zeigt den vollständigen Inhalt der Vorlage an, ohne dass der Wiki-Quelltext übersetzt wird. Gespeichert wird nicht der Quelltext der Vorlage, sondern der msgnw-Aufruf.

Sinnvoll ist dies vor allem zum Testen einer Vorlage, falls unerwartete Ergebnisse auftreten oder die Zusammenarbeit verschachtelter Vorlagen untersucht werden soll. Mehr dazu (und zu einer weiteren Möglichkeit) siehe Vorlagen erstellen.

Problemfälle[Bearbeiten]

Aufzählungen[Bearbeiten]

  • Will man innerhalb eines Parameters Aufzählungszeichen (wie am Anfang dieser Zeile) benutzen, so muss eine neue Zeile oder ein neuer Absatz begonnen werden. Beispiel:
{{subst:Willkommen|~~~|text=</p>
:* [[:Kategorie:Vorlage für Navigation|]]
:* [[:Kategorie:Vorlage für Buchgestaltung|]]
}}

Das genaue Vorgehen hängt von der Definition der Vorlage ab und ist auszuprobieren. Nach dem Gleichheitszeichen können folgen: eine neue Zeile, &nbsp; oder </p>.

Ein weiteres Beispiel bietet die Wikipedia-Vorlage Infobox Film beim Parameter DS (= Darsteller, Besetzung):

{{Infobox Film
| DT      = Citizen Kane   <!-- usw. diverse andere Parameter -->
| DS      = 
* [[Orson Welles]]: Charles Foster Kane
* [[Joseph Cotten]]: Jedediah Leland
* [[Dorothy Comingore]]: Susan Alexander Kane
* [[Agnes Moorehead]]: Mary Kane
}}

Pipe-Zeichen und verschwundener Parameter-Inhalt[Bearbeiten]

Wenn der Inhalt eines Parameters ein Pipe-Zeichen | enthalten soll, kommt es oft vor, dass alles dahinter abgeschnitten wird:

  • Eingabe: {{blau|Der erste Teil des Inhalts kommt. | Aber wo bleibt der Rest? Und was ist mit der Blaufärbung? }}
    Anzeige: Der erste Teil des Inhalts kommt.

Die Software rechnet damit, dass hinter dem zweiten Pipe-Zeichen ein zweiter Parameter beginnt (bei dieser Vorlage mit Angabe der Farbe). In einem solchen Fall muss statt | immer {{!}} geschrieben werden:

  • Eingabe: {{blau|Der erste Teil des Inhalts kommt. {{!}} Jetzt kommt auch der Rest des Texts – und alles gefärbt. }}
    Anzeige: Der erste Teil des Inhalts kommt. | Jetzt kommt auch der Rest des Texts – und alles gefärbt.

Gleichheitszeichen[Bearbeiten]

Wenn ein Parameter ohne Namen benutzt wird und der Wert ein Gleichheitszeichen enthält, wird der Parameter nicht erkannt:

{{Achtung|Ein Problem ist [//de.wikibooks.org/w/index.php?diff=prev&oldid=713581 diese Änderung]. }}

Das Problem ist an der Anzeige {{{1}}} zu erkennen: Die MediaWiki-Software vermisst den Wert des Parameters "1". Durch das (erste) Gleichheitszeichen glaubt der Wiki-Interpreter, dass der erste Parameter "Ein Problem ... diff" heißt, aber nicht "1". Um diese Fehlinterpretation zu vermeiden, muss der Name des Parameters ausdrücklich angegeben werden; und der erste Parameter heißt eben "1":

{{Achtung|1=Ein Problem ist [//de.wikibooks.org/w/index.php?diff=prev&oldid=713581 diese Änderung]. }}

Dieses Problem taucht vor allem bei URLs mit einem Gleichheitszeichen auf, aber auch dann, wenn dem Parameterinhalt ein Style zugewiesen werden soll. Häufig sollten nichtlateinische Schriften – z.B. Arabisch, Chinesisch, Devanagari, Koreanisch – zur besseren Lesbarkeit vergrößert werden. Das könnte so erfolgen:

falsch:  {{Achtung|  Ein Problem ist 她 oder <span style="font-size:200%">她</span>. }}
richtig: {{Achtung|1=Ein Problem ist 她 oder <span style="font-size:200%">她</span>. }}

Verschachtelte Vorlagen[Bearbeiten]

Mancher einfach aussehende Textbaustein besteht aus mehreren miteinander verschachtelten Vorlagen. Hast du eine der Vorlagen der „Zwischenschicht“ erwischt, wird sie nicht das von dir erhoffte Ergebnis liefern! Dann musst du über die Linkliste feststellen, wo eine Vorlage verwendet wird; irgendwo sollte das Zusammenspiel der Vorlagen beschrieben sein.

Ein Extrembeispiel sind Wikibooks Automatische Vorlagen, die mit einer Reihe von Vorlagen und bucheigenen Listen automatisch Inhaltsverzeichnis, Navigation und Druckversion erzeugen.

Merksätze[Bearbeiten]

  1. Um Vorlagen einzubinden, fasst man den Namen in geschweifte Klammern.
  2. Bei projektweiten Vorlagen kann man den Begriff „Vorlage“ weglassen, bei bucheigenen Vorlagen muss man noch einen Doppelpunkt voranstellen.
  3. Parameter werden (mit oder ohne Namen) innerhalb der geschweiften Klammern eingetragen, getrennt durch das Pipe-Zeichen.
  4. Mit dem Befehl subst: wird der derzeitige Inhalt in der Seite veröffentlicht.
  5. Die Erklärung auf der Vorlagenseite wird nicht mit eingebunden.