Hilfe:Vorlagen

Aus Simpsonspedia
Version vom 12. Mai 2013, 15:01 Uhr von Kubi (Diskussion | Beiträge) (Kategorie korrigiert)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springenZur Suche springen

Eine Vorlage ist in der Simpsonspedia ein vorgefertigter Text, der in Artikeln sehr einfach eingesetzt werden kann. Dadurch kann die Arbeit enorm erleichtert werden, da bestimmte Texte oder Tabellen nicht immer wieder vollständig neu geschrieben, sondern nur unter Umständen bestimmte Teile der Vorlage dem jeweiligen Artikel anpasst werden müssen. Dadurch wird sehr häufig eine enorme Platzersparnis erreicht.

Beispielsweise ist die Box rechts auf dieser Seite ebenfalls eine Vorlage. Statt jedes Mal dieses komplizierte Gebilde auf jeder Hilfe-Seite neu zu schreiben, reicht es aus, einfach {{Simpsonspedia-Hilfe}} einzugeben, um sie erscheinen zu lassen.

Erstellen von Vorlagen

Um eine Vorlage zu erstellen, muss wie gewohnt eine Seite angelegt werden. Diese sollte einen passenden Namen und unbedingt den Präfix Vorlage: tragen: Vorlage:NAME.

Vorlagen ohne veränderlichen Inhalt

Soll eine Vorlage erstellt werden, deren Inhalt immer gleich bleibt und in denen keine Angaben vorkommen, die von Artikel zu Artikel verändert werden müssen, so kann diese wie jede andere Seite auch angelegt und es muss nichts weiter beachtet werden.

Vorlagen mit veränderlichen Inhalt (Parameter)

Sollen in der Vorlagen Passagen auftauchen, die veränderlich bleiben sollen und nicht festgeschrieben werden können, müssen diese Abschnitte durch geschweifte Klammern gekennzeichnet werden. Um diesen Abschnitt zu öffnen, werden drei geöffnete Klammern ({{{) eingefügt, um sie wieder zu schließen analog drei geschlossene Klammern (}}}):

Dies ist eine Vorlage. {{{ Hier befindet sich der Abschnitt, der veränderlich bleiben soll. }}} Hier geht die Vorlage weiter.

Wenn der Abschnitt mit den Klammern geschlossen wird, ist diese ab da wieder unveränderlich.

Der Platz in den Klammern muss noch durchnummeriert oder benannt werden:

Durchnummeriert: {{{1}}} findet die Simpsons toll, {{{2}}} hingegen nicht.
Mit Namen: {{{Fanname}}} findet die Simpsons toll, {{{AndererSerienname}}} hingegen nicht.

Der "Name" des Platzes zwischen den Klammern heißt Parameter (also sind beispielsweise 1 und 2 bzw. Fanname und AndererSeriename Parameter).

Parameter als Links

Parameter können, wenn die Vorlage verwendet wird, auch als Link erscheinen, in dem wie gewohnt eckige Klammen benutzt werden:

[[{{{Fanname}}}]] findet die Simpsons toll, [[{{{AndererSerienname}}}]] hingegen nicht.

Fanname und AndererSeriename erscheinen später als Links.

Standard-Parameter

In die Vorlage kann auch ein Standard-Parameter integriert werden, so dass dieser immer angezeigt wird, wenn später beim Einbinden der Vorlage kein Wert angegeben ist. Dieser wird nach einem senkrechten Strich (|) nach der Nummer bzw. dem Namen des Parameters angegeben:

{{{Fanname|Peter}}} findet die Simpsons toll, {{{AndererSerienname|Family Guy}}} hingegen nicht.

Vorlagen einbinden

Um Vorlagen in einen Artikel einzubinden, gibt es drei Möglichkeiten:

Möglichkeit 1:

Es werden je zwei geschweifte Klammern benutzt, innerhalb dieser wird der Name der Vorlage eingetragen, also der Name der Seite, wo diese erstellt wurde. Dabei wird aber auf den Präfix Vorlage: verzichtet. Durch das Einbinden von {{NAME}} erscheint dann also der Inhalt der Vorlage.
Mit dieser Variante können auch die Inhalte von Seiten in Artikel eingebunden werden, die nicht den Präfix Vorlage: verwenden. Dazu wird in den Klammern einfach wie gewohnt der Name der Seite eingetragen, um den Inhalt der Seite Die Simpsons in einen Artikel einzufügen, wird {{:Die Simpsons}} (auf die Doppelpunkte vor dem Seitennamen achten) verwendet. Um den Inhalt von Seiten, die einen anderen Präfix tragen (z. B. Hilfe:Grabpic), in den Artikel einzufügen, wird {{Hilfe:Grabpic}} (hier werden keine Doppelpunkte benötigt) verwendet.

Möglichkeit 2:

Mit {{subst:NAME}} wird ebenfalls der Inhalt der Vorlage in den Artikel eingebunden, jedoch erscheint nach dem Speichern des Artikels beim Bearbeiten der Quelltext der Vorlage mit den entsprechenden Parameterwerten, {{subst:NAME}} ist dann verschwunden - im Unterschied zu Version 1, in der {{NAME}} auch nach dem Speichern erhalten bleibt.

Möglichkeit 3:

Mit {{msgnw:NAME}} wird der Quelltext der Vorlage im Artikel angezeigt. Diese Art der Vorlageneinbindung wird eigentlich nur benötigt, um die Vorlage selbst auf ihrer eigenen Seite zu erklären.

Vorlagen ohne veränderlichen Inhalt

Um Vorlagen ohne veränderlichen Inhalt in einen Artikel einzubinden, wird einfach eine der drei oberen Möglichkeiten verwendet, es muss nichts Weiteres dabei beachtet werden.

Vorlagen mit veränderlichen Inhalt (Parameter)

Um Vorlagen mit veränderlichen Inhalt in einen Artikel einzubinden, wird wieder eine der drei oberen Möglichkeiten verwendet, es müssen aber zusätzliche die Parameterwerte angegeben werden, also die Dinge, die entsprechend dem Artikel verändert werden müssen (die Vorlage muss nun sozusagen angepasst werden).

Wurden die Parameter in der Vorlage nummeriert, so werden diese nun nach dem Namen der Vorlage noch innerhalb der geschweiften Klammern entsprechend ihrer Nummerierung nacheinander angegeben. Dabei werden der Vorlagenname von den Parameterwerten und die Parameterwerte untereinander mit einem senkrechten Strich (|) voneinander getrennt:

Aus {{NAME|Jack|South Park}} wird dann im Artikel:
Jack findet die Simpsons toll, South Park hingegen nicht.

Wurden die Parameter in der Vorlage benannt, müssen diese Namen auch wieder in der Vorlage auftauchen. Nach einem Gleichheitszeichen (=) folgt dann wie bei der Nummerierung die Angabe des eigentlichen Parameterwertes:

Aus {{NAME|Fanname=Jack|AndererSerienname=South Park}} wird dann im Artikel:
Jack findet die Simpsons toll, South Park hingegen nicht.

Wird ein Parameter keinem Wert zugewiesen, so erscheint dieser Platz im Artikel dann einfach leer bzw. wird dann, sofern er vorhanden ist, der Standard-Parameter angezeigt.

Standard-Parameter

Wurde ein Standard-Parameter bei der Vorlage eingebaut und wird kein weiterer Parameterwert wie oben angegeben, erscheint diese dann auch im Artikel:

Aus {{NAME}} wird dann im Artikel:
Peter findet die Simpsons toll, Family Guy hingegen nicht.

Aufzählungszeichnen

Sollen Aufzählungen als Parameterwert benutzt werden, so sollte darauf geachtet werden, nach dem Gleichheitszeichen ein Zeilenumbruch einzufügen und erst dann mit den Aufzählungszeichen zu beginnen.

Gleichheitszeichen in Parameterwerten

Soll ein Text als Parameterwert benutzt werden, der Gleichheitszeichen enthält (beispielsweise, wenn der Parameter eine URL oder ein Tag sein soll), so muss vor diesem Text x= stehen, wobei x für die Nummer steht, die der Parameter trägt (beispielsweise müsste für den 5. Parameter 5= und für 43. Parameter 43= verwendet werden). Anderenfalls würde die Software sonst das Gleichheitszeichen als Parameterzuweiser verstehen (das Wort vor dem Gleichheitszeichen wäre dann der Parameter, der Text danach der Wert dieses Parameters).

Senkrechter Strich in Parameterwerten

Da der senkrechte Strich „|“ benutzt wird, um Parameterwerte zu trennen, kann dieser nicht beim Vorlageneinbau direkt als Wert eingesetzt werden, weshalb dadurch beispielsweise keine Tabellen im Pediastil verwendet werden könnten. Um dies aber dennoch zu ermöglichen, gibt es für dieses Zeichen Vorlagen, die dieses im Nachhinein dann einsetzen:

Vorlage: {{!}} {{!-}} {{!!}}1 {{!-!}}2 {{!+}}2 {{!~}}2 {{(!}}2 {{!)}}2
Inhalt: | |- || |-
||
|+ |-
|!
{| |}

Ebenso verhält es sich mit den doppelten geschweiften Klammern: „{{“ und „}}“, bei denen der dazwischen liegende Text immer als Vorlage interpretiert wird. Aber auch für diese gibt es dementsprechend Vorlagen:

Vorlage: {{((}}2 {{))}}2
Inhalt: {{ }}

Anmerkungen:

1 Die Vorlage:!!2 kann aus einem unbekannten Grund in Tabellen nicht verlinkt werden.
2 Diese Vorlagen wurden nicht benötigt, weshalb sie auch noch nicht angelegt wurden.

Includeonly und Noinclude

Es existieren in der Pedia zwei weitere Features, um auch Dinge in die Vorlage einzubringen, die ansonsten nicht möglich wären oder zu unerwünschten Nebeneffekten führen würden. Diese Features heißen Includeonly (nur einschließen) und Noinclude (nicht einschließen).

Includeonly

Der Text, der in den Tags <includeonly> und </includeonly> geschrieben wird, wird nur dann angezeigt, wenn die Vorlage auch in einem Artikel verwendet wird und hat keine Auswirkung auf die Vorlagenseite selber. Damit lassen sich alle Seiten, die eine bestimmte Vorlage verwenden, kategorisieren, ohne dass die Vorlagenseite selber in dieser Kategorie erscheint.

Noinclude

Der Text, der in den Tags <noinclude> und </noinclude> geschrieben wird, wird nur auf der Vorlagenseite selber angezeigt. Dadurch lassen sich die Vorlagen selber kategorisieren, ohne dass die Artikel, in denen diese dann verwendet wird, ebenfalls in dieser Kategorie auftauchen und die Vorlage selbst und ihre Verwendung kann auf deren Seite erklärt werden.

Variablen

In der Simpsonspedia existieren bereits Variabeln, die vom System selber ausgehen. Welche das sind und welche Funktionen diese haben wird in Hilfe:Variablen beschrieben.

Vorlagenprogrammierung

Die Vorlagenprogrammierung ist in der Simpsonspedia nicht möglich, weshalb sie hier auch nicht erklärt wird.

Weitere Hinweise

  • Auf der Vorlagenseite sollte die Vorlage selber möglichst knapp und verständlich erklärt werden. Dies geschieht mit <noinclude> und </noinclude>.
  • Wird eine Vorlage geändert, verändert dies auch alle Seiten, die diese verwenden.
  • Wenn in einer Vorlage ein weiterer Parameter integriert wird, muss auch der dazugehörige Wert in den einzelnen Artikeln angegeben werden. Wird dies nicht getan, erscheint (wenn er vorhanden ist) der Standardparameter oder diese Stelle bleibt einfach leer.

Der Nutzen von Vorlagen

  • Vorlagen können die Arbeit enorm erleichtern, da nicht immer wieder dieselben Dinge von Hand eingegeben werden müssen, sondern unter Umständen nur der Teil, der sich ändert.
  • Innerhalb des Quellcodes kommt es durch die Verwendung einer Vorlage zu einer Platzersparnis, da der gesamte Text der Vorlage zwar im Artikel, aber nicht im Quellcode erscheint, sondern lediglich den Namen der Vorlage zu sehen ist. Dadurch erscheint der Code insgesamt übersichtlicher und auch neue User haben keine Probleme, sich zu recht zu finden.
  • Durch Vorlagen entsteht ein einheitliches Bild.
  • Überall da, wo eine Vorlage verwendet wird, erscheint dieser Teil gleich - auch bei einer Änderung der Vorlage. Dadurch ergibt sich auch, dass nicht die einzelnen Artikel, sondern lediglich die Vorlage geändert werden müssen, wodurch unnötige Versionen und dadurch Traffic gespart werden.

Beispiele von wichtigen Vorlagen