Benutzer:Rikku/Test2

--> Auf dieser Hilfeseite sind wichtige Hinweise für das Erstellen oder Verwenden von Vorlage:Vorlagen zusammengefasst. Nach einer kurzen Erläuterung, was Vorlage:Vorlagen sind, folgt eine Beschreibung der notwendigen Schritte, Vorlage:Um eine Vorlage in eine Seite einzubinden. Anschließend sind Hinweise zur Vorlage:Erstellung von Vorlagen zusammengefasst, gefolgt von einem kommentierten Überblick über Vorlage:Die Vorlagen hier im ConanWiki.

Ziel dieser Hilfeseite ist es, Wiki-Autoren beim Verfassen und Gestalten von Artikeln zu Unterstützen, denn es existiert bereits eine Vielzahl an Vorlagen, die in einigen speziellen Artikeltypen obligatorisch oder optional einzubinden sind. Die Seite kann ganzheitlich wie ein Artikel gelesen werden. Es empfiehlt sich jedoch, vorab einen Schwerpunkt zu setzen und die entsprechenden Abschnitte im Detail zu betrachten.

• Neueinsteigern, die wenig bis keine Erfahrungen im Wiki haben, werden daher zunächst besonders die beiden Abschnitte Was ist eine Vorlage und Vorlage verwenden empfohlen.
• Erfahrene Benutzer können sich gezielt mit den Vorlagen im Wiki auseinandersetzen. Dies ist insbesondere für die Qualitätssicherung wichtig und für Vorlagen-Entwickler, um neue oder überarbeitete Vorlagen korrekt zu dokumentieren und zu kategorisieren.

Was ist eine Vorlage

Eine Vorlage ist eine Seite, die die Einbindung häufig verwendeter Elemente in andere Seiten erleichtert. Im einfachsten Fall handelt es sich dabei um einen vorformulierten Textbaustein, der auf einer anderen Seite eingefügt werden kann. Ein Beispiel hierfür ist die Vorlage:Willkommen, die einige grundlegende Informationen zur Mitarbeit im ConanWiki enthält. Jeder neu registrierte Benutzer bekommt sie auf seiner Diskussionsseite eingebunden und der Willkommenstext wird dadurch beliebig oft wiederverwendet.

Vorlagen helfen auch dabei, ein gewisses Coorporate Design einzuhalten oder unterstützen bei komplexen Formatierungen. Ein Beispiel hierfür sind die sogenannten Infoboxen, die sich Kapitel-, Episoden- oder anderen Artikeln zu Inhalten der verschiedenen in diesem Wiki betrachteten Serien finden. Der Autor des jeweiligen Artikels trägt die relevanten Daten zusammen und übergibt diese an die entsprechende Infobox-Vorlage. Die Vorlage übernimmt die Formatierung der Daten, sucht ein passendes Bild und stellt alles in einer kompakten tabellarischen Übersicht da. Der Autor muss sich demnach um die Präsentation seiner Daten und die dafür nötige Wiki-Syntax nicht weiter kümmern.

Eine dritte Gruppe von Vorlagen sind sogenannte Funktionen. Funktionen führen eine Berechnung oder eine Transformation zu an sie übergebenen Daten durch. Ein Beispiel für diese Kategorie von Vorlagen ist die Vorlage:KB, die zu einem mitgegebenen Kapitel aus Detektiv Conan berechnet, in welchem Manga-Band es veröffentlicht wurde. Da diese Berechnung im Wiki häufig und in ganz verschiedenen Artikeln benötigt wird, wurde eine entsprechende Vorlage angelegt. Auch erfolgt eine mögliche Aktualisierung zentral, beispielsweise, wenn das Kapitel von den Freien Kapiteln in einen Manga-Band wandert. Die Wiki-Autoren müssen sich nicht manuell um diese Aktualisierung in den von ihnen erstellten Artikeln kümmern.

Vorlage verwenden

Einbinden von Vorlagen in anderen Seiten

Grundsätzlich gibt es zwei Möglichkeiten, eine Vorlage in einem Artikel oder einer anderen Seite zu verwenden:

1. Der Seitenname der Vorlage wird an der Textstelle, an der die Vorlage eingebunden werden soll, in zwei geschweiften Klammern angegeben: {{<Name der Vorlage>}}. Beim Anzeigen der Seite ersetzt die Wiki-Software diesen Code dann durch den Inhalt der Vorlage. Ändert jemand die Vorlage, werden die Änderungen automatisch auf allen Seiten sichtbar, auf denen die Vorlage eingebunden ist.
2. Der Vorlageninhalt wird substantiviert eingebunden. Hierbei wird dem Seitenname der Vorlage das Schlüsselwort subst: (für Substitution) oder auch ers: (für Ersetzen) vorangestellt:{{subst:<Name der Vorlage>}} bzw. {{ers:<Name der Vorlage>}}. Wird eine Vorlage auf einer Seite substantiviert eingebunden, so wird nach dem Speichern der Seite der Code durch den aktuellen Inhalt der Vorlage ersetzt. Anders formuliert, der Text aus der Vorlage wird in die Seite, auf der die Vorlage eingebunden wurde, hineinkopiert. Werden danach Änderungen an der Vorlage vorgenommen, so haben diese keine Auswirkungen auf Artikel oder andere Seiten, auf denen die Vorlage substantiviert eingebunden wurde.

Vorlagen, die ausschließlich substantiviert eingebunden werden sollen, sind in der Kategorie:Vorlage:nur Subst enthalten. Ein weiteres Beispiel ist die Vorlage:Willkommen, die bei der Begrüßung neuer Benutzer ebenfalls substantiviert eingebunden werden sollte, damit diese auf ihrer Seite auch beim Bearbeiten den Text der Begrüßung vorfinden und kein ggf. verwirrendes {{Willkommen|~~~~}}.

Weiterhin ist zu beachten, dass der Namensraum aus dem Seitenname der Vorlage nicht mit angegeben wird, sofern die Seite im Namensraum für Vorlagen erstellt wurde. Beispielsweise ist der volle Name der o. g. Willkommen-Vorlage "Vorlage:Willkommen", wobei das Präfix Vorlage: den Namensraum kennzeichnet. Es können aber auch beliebige andere Seiten wie Vorlagen eingebunden werden. Nachfolgend ein Überblick, wie Seiten als Vorlagen eingebunden werden können:

• Liegt die Seite im Vorlagen-Namensraum, wird beim Einbinden als Vorlage der Seitenname ohne Namensraum-Präfix angegeben: {{<Name der Vorlage>}}.
• Liegt die Seite im Artikel-Namensraum, wird beim Einbinden als Vorlage der Seitenname mit vorangestelltem Doppelpunkt angegeben: {{:<Name der Vorlage>}}.
• Sonst: das Präfix für den Namensraum muss ebenfalls mit angegeben werden: {{<Namensraum>:<Name der Vorlage>}}.

Das eine Seite als Vorlage verwendet wird, obwohl sie nicht im Vorlagen-Namensraum liegt, kann bei Vorlagen-Tests sinnvoll sein, wenn ein Benutzer eine neue Vorlage zunächst in seiner persönlichen Sandbox entwickelt und testet. Textbausteine, Formatierungshilfen oder Funktionen, die als Vorlage in Seiten in ConanWiki eingebunden und aktiv verwendet werden sollen, sind jedoch im Vorlagen-Namensraum zu erstellen bzw. nach den persönlichen Tests dorthin zu verschieben.

Verwenden von Parametern

In dem vorangegangenen Abschnitt "Was ist eine Vorlage" wurde bereits angesprochen, dass Vorlagen nicht nur statische Textbausteine enthalten müssen. Dass eine Vorlage in einem gewissen Rahmen individualisiert und an den Inhalt der Seite angepasst werden kann, auf der sie eingebunden wird, wird über Parameter erreicht. Ein Parameter ist hierbei ein definierter Platzhalter innerhalb der Vorlage, der beim Einbinden der Vorlage mit einem Wert belegt werden kann. Ein Beispiel hierfür ist erneut die Willkommen-Vorlage, mit der ein neu angemeldeter Benutzer wie folgt begrüßt werden kann: {{subst:Willkommen|~~~~}}.

In diesem Beispiel trägt die Vorlage selbst den Namen "Willkommen" und wird substantiviert eingebunden. Als Parameter wird die eigene Signatur mitgegeben. Der neu angemeldete Benutzer bekommt dadurch, neben dem Willkommenstext aus der Vorlage, angezeigt, wann und von wem er begrüßt wurde.

Ob eine Vorlage parametrierbar ist oder nicht, kann auf der Vorlagen-Seite nachgeschaut werden. Dort sind in der Regel Beispiele angegeben, wie die Vorlage verwendet werden soll und welche Parameter möglich sind. Dort ist auch angegeben, wenn Parameter dediziert über einen Namen angesprochen werden können. Hierzu nachfolgend zwei Beispiele zu Vorlagen, die im Rahmen der Wiki-Arbeit recht häufig verwendet werden.

Vorlagen mit anonymen Parametern

Die Vorlage:K wird gemäß ihres Verwendungshinweises wie folgt eingebunden: {{K|XXX}}, wobei XXX der Nummer eines beliebigen Kapitels als dem Detektiv Conan-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Formatierungshilfe, die beispielsweise für das erste Kapitel einen Verweis auf den entsprechenden Wiki-Artikel erstellt.

• {{K|001}} -> Band 1: Kapitel 001
• {{K|002|003|004|005}} -> Band 1: Kapitel 002, 003, 004 & 005
• {{K|002|005|004|003}} -> Band 1: Kapitel 002, 005, 004 & 003

Die Nummern der Kapitel, auf die verwiesen werden soll, sind hierbei als Parameter an die Vorlage:K übergeben, indem sie durch einen Querstrich getrennt hintereinander nach dem Vorlagennamen angegeben sind. Innerhalb der Vorlage werden die Parameter anhand der Reihenfolge, in der sie mitgeben sind, voneinander unterschieden und die Reihenfolge der Parameter wirkt sich auf die Darstellung durch die Vorlage aus.

Vorlagen mit ausgezeichneten Parametern

Die Vorlage:Infobox Kapitel kann gemäß ihres Verwendungshinweises wie folgt eingebunden werden: {{Infobox Kapitel|Kapitel=XXX}}, wobei XXX der Nummer eines beliebigen Kapitels als dem Detektiv Conan-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Infobox, die in Kapitel-Artikeln verwendet wird.

Vorlage erstellen

Namensraum

Analog zu Benutzerseiten, Dateien oder Kategorien, werden Vorlagen von gewöhnlichen Wiki-Artikeln unterschieden. In ConanWiki steht hierfür der Namensraum Vorlage zur Verfügung. Seiten, die eine Vorlage repräsentieren, sind in diesem Namensraum anzulegen.

Eine Seite wird in einem bestimmten Namensraum angelegt, indem dieser als Präfix dem Titel der Seite vorangestellt wird: {{<Namensraum>:<Titel der Seite>}}. Um eine Seite als Vorlage anzulegen, ist diese demnach wie folgt zu benennen: {{Vorlage:<Name der Vorlage>}}.

Einbindungsart definieren

Zu einer Vorlage kann die Einbindungsart definiert werden. Die Art der Einbindung beschreibt dabei die Sichtbarkeit einzelner Textblöcke aus der Vorlage. Hierbei wird unterschieden, ob ein Textblock

• nur auf der Vorlagenseite selbst sichtbar ist,
• nur auf Seiten sichtbar ist, auf der die Vorlage eingebunden ist oder
• sowohl auf der Vorlagenseite als auch auf den Seiten die die Vorlagen einbinden sichtbar ist.

<onlyinclude>

Wenn die Vorlage direkt betrachtet wird, haben <onlyinclude> und </onlyinclude> keine Wirkung auf alles, was dazwischen steht. Wenn die Vorlage jedoch auf einer anderen Seite eingebunden ist, wird ausschließlich angezeigt, was zwischen diesen beiden Tags steht. Mit <onlyinclude> können Dokumentationen und Kategorien in Vorlagen eingefügt werden, ohne dass diese in den Artikeln auftauchen. Es können auch mehrere nicht-verschachtelte <onlyinclude>-Blöcke in einer Vorlage stehen.

<includeonly>

Alles, was in einer Vorlage zwischen <includeonly> und </includeonly> steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden wird. Mit <includeonly> lassen sich zum Beispiel alle Seiten, die eine bestimmte Vorlage enthalten, automatisch einer Kategorie hinzufügen. <includeonly> kann auch innerhalb von <onlyinclude>-Blöcken stehen.

<noinclude>

Alles, was in einer Vorlage zwischen <noinclude> und </noinclude> steht, wird nur dann angezeigt, wenn die Vorlage selbst betrachtet wird und nicht auf einer Seite, auf der die Vorlage eingebunden ist. <onlyinclude> sollte zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden. <noinclude> kann auch innerhalb von <onlyinclude>-Blöcken stehen.

Wird in der Vorlage keine Einbindungsart definiert, ist standardmäßig der komplette Text der Vorlage immer sichtbar, also sowohl auf der Vorlagenseite als auch auf den Seiten, die die Vorlage einbinden.

Nachfolgend einige Beispiele für mögliche sinnvolle Einbindungsarten:

Tag-Kombination	Auf der Vorlagenseite	Auf der einbindenden Seite	Bemerkung
keine	sichtbar	sichtbar [1]	[1] Nur, wenn kein onlyinclude-Block in der Vorlage ist.
<includeonly>…</includeonly>	nicht sichtbar	sichtbar [1]	[1] Nur, wenn kein onlyinclude-Block in der Vorlage ist.
<noinclude>…</noinclude>	sichtbar [2]	nicht sichtbar	[2] Auch innerhalb eines onlyinclude-Blocks.
<onlyinclude>…</onlyinclude>	sichtbar	sichtbar [3]	[3] Text außerhalb des onlyinclude-Blocks wird nicht eingebunden.
Text 1 <onlyinclude>Text 2 <includeonly>Text 3</includeonly> <noinclude>Text 4</noinclude> </onlyinclude>Text 5	Text 1: sichtbar, Text 2: sichtbar, Text 3: nicht sichtbar, Text 4: sichtbar, Text 5: sichtbar	Text 1: nicht sichtbar, Text 2: sichtbar, Text 3: sichtbar, Text 4: nicht sichtbar, Text 5: nicht sichtbar

Noch Fragen?

Für Fragen stehen die erfahrenen Benutzer des Wiki gerne bereit. Alternativ können Fragen zum Verwenden oder Erstellen von Vorlagen auch auf der Diskussion dieser Hilfeseite oder auf der allgemeinen Seite für Fragen zum Wiki gestellt werden.