|
== {{#var:refVorlageVerwenden}} ==
<!--Hinweis: Um die Abschnittsüberschrift zu ändern, bitte die Variable "refVorlageVerwenden" am Anfang dieser Hilfeseite ändern!-->
{{Hilfe:Vorlagen/Verwendung| refVorlageErlaeuterung = {{#var:refVorlageErlaeuterung}} }}
=== Einbinden von Vorlagen auf anderen Seiten ===
Grundsätzlich gibt es zwei Möglichkeiten, eine Vorlage in einem Artikel oder einer anderen Seite zu verwenden:
# Der Seitenname der Vorlage wird an der Textstelle, an der die Vorlage eingebunden werden soll, in zwei geschweiften Klammern angegeben: <code><nowiki>{{<Name der Vorlage>}}</nowiki></code>. 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.
# Der Vorlageninhalt wird ''substantiviert'' eingebunden. Hierbei wird dem Seitenname der Vorlage das Schlüsselwort <code>subst:</code> (für ''Subst''itution) oder auch <code>ers:</code> (für ''Ers''etzen) vorangestellt:<code><nowiki>{{subst:<Name der Vorlage>}}</nowiki></code> bzw. <code><nowiki>{{ers:<Name der Vorlage>}}</nowiki></code>. 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 <code><nowiki>{{Willkommen|~~~~}}</nowiki></code>.
Weiterhin ist zu beachten, dass der {{Wp|Hilfe:Namensraum|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: <code><nowiki>{{<Name der Vorlage>}}</nowiki></code>.
* Liegt die Seite im Artikel-Namensraum, wird beim Einbinden als Vorlage der Seitenname mit vorangestelltem Doppelpunkt angegeben: <code><nowiki>{{:<Name der Vorlage>}}</nowiki></code>.
* Sonst: das Präfix für den Namensraum muss ebenfalls mit angegeben werden: <code><nowiki>{{<Namensraum>:<Name der Vorlage>}}</nowiki></code>.
Dass 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 {{SITENAME}} 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 "{{#var:refVorlageErlaeuterung}}" 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: <code><nowiki>{{subst:Willkommen|~~~~}}</nowiki></code>.
In diesem Beispiel trägt die Vorlage selbst den Namen "Willkommen" und wird substantiviert eingebunden. Als Parameter wird die eigene [[Hilfe:Signatur|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.
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Vorlagen mit anonymen Parametern|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
Die [[Vorlage:K]] wird gemäß ihres Verwendungshinweises wie folgt eingebunden: <code><nowiki>{{K|XXX}}</nowiki></code>, wobei XXX der Nummer eines beliebigen Kapitels aus dem ''Detektiv Conan''-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Formatierungshilfe, die für das mitgegebene Kapitel einen [[Hilfe:Verlinkung|Verweis]] auf den entsprechenden Wiki-Artikel erstellt.
* <code><nowiki>{{K|001}}</nowiki></code> -> {{K|001}}
* <code><nowiki>{{K|002|003|004|005}}</nowiki></code> -> {{K|002|003|004|005}}
* <code><nowiki>{{K|002|005|004|003}}</nowiki></code> -> {{K|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 senkrechten Strich („{{!}}“) 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.
</div>
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Vorlagen mit ausgezeichneten Parametern|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
Die [[Vorlage:Infobox Kapitel]] kann gemäß ihres Verwendungshinweises wie folgt eingebunden werden: <code><nowiki>{{Infobox Kapitel|Kapitel=XXX}}</nowiki></code>, wobei XXX der Nummer eines beliebigen Kapitels aus dem ''Detektiv Conan''-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Infobox, die in [[Hilfe:Kapitel|Kapitel-Artikel]]n verwendet wird.
Die Nummer des Kapitels wird hierbei explizit über den Parameter "Kapitel" an die Vorlage übergeben. Innerhalb der Vorlage wird dieser Parameter anhand seines Namens von anderen Parametern unterschieden und die Reihenfolge der Parameter wirkt sich nicht auf die Darstellung durch die Vorlage aus.
</div>
== {{#var:refVorlageErstellen}} ==
<!--Hinweis: Um die Abschnittsüberschrift zu ändern, bitte die Variable "refVorlageErstellen" am Anfang dieser Hilfeseite ändern!-->
{{Hilfe:Vorlagen/Erstellung| refVorlageVerwenden = {{#var:refVorlageVerwenden}} | refVorlageDokumentieren = {{#var:refVorlageDokumentieren}} }}
=== Namensraum ===
Analog zu Benutzerseiten, Dateien oder Kategorien, werden Vorlagen von gewöhnlichen Wiki-Artikeln unterschieden. In {{SITENAME}} steht hierfür der Namensraum ''Vorlage'' zur Verfügung. Seiten, die eine Vorlage repräsentieren, sind in diesem Namensraum anzulegen.
<!--@ToDo:Textbaustein-->Eine Seite wird in einem bestimmten Namensraum angelegt, indem dieser als Präfix dem Titel der Seite vorangestellt wird: <code><nowiki>{{<Namensraum>:<Titel der Seite>}}</nowiki></code>. Um eine Seite als Vorlage anzulegen, ist diese demnach wie folgt zu benennen: <code><nowiki>{{Vorlage:<Name der Vorlage>}}</nowiki></code>.
=== Sichtbarkeit definieren ===
Zu einer Vorlage kann die ''Sichtbarkeit'' einzelner Textblöcke aus der Vorlage definiert werden. 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.
; <tt><nowiki><onlyinclude></nowiki></tt>
: Wenn die Vorlage direkt betrachtet wird, haben <code><nowiki><onlyinclude></nowiki></code> und <code><nowiki></onlyinclude></nowiki></code> 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. Außerhalb von <code><nowiki><onlyinclude></nowiki></code> können [[{{FULLPAGENAME}}#{{#var:refVorlageDokumentieren}}|Dokumentationen]] und [[Hilfe:Kategorien|Kategorien]] in Vorlagen eingefügt werden, ohne dass diese in den Artikeln auftauchen. Es können auch mehrere ''nicht-verschachtelte'' <code><nowiki><onlyinclude></nowiki></code>-Blöcke in einer Vorlage stehen.
; <tt><nowiki><includeonly></nowiki></tt>
: Alles, was in einer Vorlage zwischen <code><nowiki><includeonly></nowiki></code> und <code><nowiki></includeonly></nowiki></code> steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden wird. Mit <code><nowiki><includeonly></nowiki></code> lassen sich zum Beispiel alle Seiten, die eine bestimmte Vorlage enthalten, automatisch einer Kategorie hinzufügen. <code><nowiki><includeonly></nowiki></code> kann auch innerhalb von <code><nowiki><onlyinclude></nowiki></code>-Blöcken stehen.
; <tt><nowiki><noinclude></nowiki></tt>
: Alles, was in einer Vorlage zwischen <code><nowiki><noinclude></nowiki></code> und <code><nowiki></noinclude></nowiki></code> steht, wird nur dann angezeigt, wenn die Vorlage selbst betrachtet wird und nicht auf einer Seite, auf der die Vorlage eingebunden ist. <code><nowiki><noinclude></nowiki></code> kann auch innerhalb von <code><nowiki><onlyinclude></nowiki></code>-Blöcken stehen. <code><nowiki><onlyinclude></nowiki></code> sollte zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden.
Sind in der Vorlage keine Vorgaben zur Sichtbarkeit 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 Vorgaben zur Sichtbarkeit:
{| class="roundtable wiki" style="width:95%; margin:10px;"
! style="width:22%;" | Tag-Kombination
! style="width:16%;" | Auf der Vorlagenseite
! style="width:20%;" | 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<br /><onlyinclude>Text 2<br /><includeonly>Text 3</includeonly><br /><noinclude>Text 4</noinclude><br /></onlyinclude>Text 5 || Text 1: sichtbar,<br />Text 2: sichtbar,<br />Text 3: nicht sichtbar,<br />Text 4: sichtbar,<br />Text 5: sichtbar || Text 1: nicht sichtbar,<br />Text 2: sichtbar,<br />Text 3: sichtbar,<br />Text 4: nicht sichtbar,<br />Text 5: nicht sichtbar ||
|}
Nachfolgend einige Beispiele für ''nicht'' sinnvolle Kombinationen zur Sichtbarkeit:
{| class="roundtable wiki" style="width:95%; margin:10px;"
! style="width:22%;" | Tag-Kombination
! style="width:16%;" | Auf der Vorlagenseite
! style="width:20%;" | Auf der einbindenden Seite
! Bemerkung
|-
| <includeonly>Text 1</includeonly><br /><onlyinclude>Text 2</onlyinclude> || Text 1: nicht sichtbar,<br />Text 2: sichtbar || Text 1: nicht sichtbar,<br />Text 2: sichtbar || Wenn ''onlyinclude''-Blöcke enthalten sind, werden Textblöcke außerhalb dieser nicht auf anderen Seiten eingebunden. Der Text 1 wird niemals angezeigt und diese Tag-Kombination ist demnach nicht sinnvoll.
|-
| <includeonly><onlyinclude>...<br /></onlyinclude></includeonly> || nicht sichtbar || sichtbar || Textblöcke innerhalb von ''includeonly''-Blöcken werden außschließlich auf den einbindenden Seiten angezeigt. Der zusätzliche ''onlyinclude''-Block macht demnach keinen Sinn und lediglich die Vorlage komplizierter.
|}
=== Einfache Dynamisierung: Parameter definieren ===
In Abschnitt "{{#var:refVorlageVerwenden}}" wurde bereits angesprochen, dass Vorlagen parametrierbar sein können. Die Art und Weise der Parameterübergabe wird bei der Vorlagenerstellung definiert und kann im Nachhinein nur schwer geändert werden.
Innerhalb der Vorlage ist ein Platzhalter durch drei einschließende geschweifte Klammern gekennzeichnet; diese können entweder durchnummeriert oder durch frei gewählte Namen bezeichnet werden:
* <code><nowiki>{{{Y}}}</nowiki></code>, wobei Y eine fortlaufende Nummer beginnend bei Eins ist, kennzeichnet einen ''anonymen Parameter''.
* <code><nowiki>{{{<Parametername>}}}</nowiki></code> kennzeichnet einen ''ausgezeichneten Parameter'', der bei der Verwendung der Vorlage dediziert über seinen Namen angesprochen werden kann.
Nachfolgend ein kleines Beispiel, wie sich die beiden Parameterdefinitionen unterscheiden:
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Anonyme und ausgezeichnete Parameter definieren|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
<pre>Beispielvorlage1:
Nach Auffassung {{{1}}}s ist der Täter {{{2}}}.
</pre>
<pre>Beispielvorlage2:
Nach Auffassung {{{Detektiv}}}s ist der Täter {{{Täter}}}.
</pre>
Die beiden Beispielvorlagen können wie folgt verwendet werden:
* <code><nowiki>{{Beispielvorlage1|Kogoro Mori|Yoshihito Kureko}}</nowiki></code> -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.
* <code><nowiki>{{Beispielvorlage2|Detektiv=Kogoro Mori|Täter=Yoshihito Kureko}}</nowiki></code> -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.
Das Ergebnis beider Vorlagen ist das gleiche. In Beispielvorlage1 ist jedoch implizit definiert, dass der Name des Detektivs immer als erster Parameter übergeben werden soll und der Name des Täters als zweiter Parameter. In Beispielvorlage2 hingegen ist über den zusätzlichen Parameternamen klar ersichtlich, welcher Parameter den Detektivnamen und welcher den Namen des Täters aufnimmt. In Beispielvorlage2 kann daher die Reihenfolge der Parameterübergabe ausgetauscht werden ohne die inhaltliche Aussage zu verändern, in Beispielvorlage1 geht dies nicht:
* <code><nowiki>{{Beispielvorlage1|Yoshihito Kureko|Kogoro Mori}}</nowiki></code> -> Nach Auffassung Yoshihito Kurekos ist der Täter Kogoro Mori.
* <code><nowiki>{{Beispielvorlage2|Täter=Yoshihito Kureko|Detektiv=Kogoro Mori}}</nowiki></code> -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.
</div>
Ob ein Parameter besser anonym oder mit einem Namen ausgezeichnet ist, entscheidet der Vorlagenentwickler bei Einführung des Parameters. Nachfolgende Hinweise können bei der Entscheidung helfen:
* Anonyme Parameter bieten sich an, wenn
** die Übergabe-Reihenfolge egal ist
** die Anzahl der übergebenen Parameter beliebig ist / nicht von vornherein eingeschränkt sein soll
** alle übergebenen Parameter gleich behandelt werden sollen
Ein gutes Beispiel hierfür sind Formatierungsvorlagen, die auf alle an sie übergebenen Parameter die gleiche Formatierungsvorgaben anwenden, bspw. den Text des Parameters als Link darstellen. In einer solchen Vorlage wird der erste Parameter gleich dem letzten behandelt und je nach Anwendungskontext wird an die Vorlage nur ein Parameter übergeben und ein anderes Mal sind es zwei oder mehr.
* Ausgezeichnete Parameter bieten sich an, wenn
** die Übergabe-Reihenfolge nicht egal ist
** ein Parameter dediziert angesprochen oder ausgewertet werden soll
** die übergebenen Parameter unterschiedlich behandelt werden sollen
Ein gutes Beispiel hierfür sind die Infoboxen. Hier wird ein Wert einem bestimmten Parameter zugewiesen, der innerhalb der Vorlage dediziert ausgewertet werden soll. Beispielsweise soll in der Infobox für Manga-Kapitel die Kapitelnummer nicht in dem Datumsfeld für die deutsche Erstveröffentlichung angezeigt werden. Durch die Parameternamen wird einerseits der Vorlagencode selbst besser lesbar und andererseits die Verwendung der Vorlage einfacher; Verwechslungen zwischen einzelnen Parametern können besser vermieden werden.
Wird ein Parameter nachträglich in eine bestehende Vorlage eingefügt, bietet es sich an, diesen entsprechend der anderen bereits vorhandenen Parameter ebenfalls anonym bzw. ebenfalls ausgezeichnet mit einem Namen zu definieren.
''Hinweis'': Nachträglich eingeführte Parameter werden auf Seiten, die die Vorlage bereits eingebunden hatten nicht automatisch verwendet, sofern kein Standardwert definiert ist. Es müssen demnach entweder die verwendenden Seiten entsprechend geändert werden oder die Änderung der Vorlage hat zunächst keine Auswirkungen auf einbindende Seiten.
==== Parameter mit Vorbelegung ====
Ein Parameter kann innerhalb der Vorlage mit einem ''Standardwert'' vorbelegt werden. Hierzu wird der Parameter wie folgt angegeben: <code><nowiki>{{{<Parametername>|<Standardwert>}}}</nowiki></code>. Der senkrechte Strich („{{!}}“) trennt hierbei den Namen des Parameters und dessen Vorbelegung. Eine Vorbelegung kann zum Beispiel in Textbausteinen dazu verwendet werden, dass diese auch bei fehlender Parameterübergabe einen Sinn ergeben.
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Parameter mit Vorbelegung|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
<pre>Beispielvorlage2:
Nach Auffassung {{{Detektiv|des Detektiv}}}s ist der Täter {{{Täter|noch unbekannt}}}.
</pre>
* <code><nowiki>{{Beispielvorlage2|Detektiv=Kogoro Mori|Täter=Yoshihito Kureko}}</nowiki></code> -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.
* <code><nowiki>{{Beispielvorlage2}}</nowiki></code> -> Nach Auffassung des Detektivs ist der Täter noch unbekannt.
</div>
''Hinweis'': Wird ein Parameter an mehreren Stellen in der Vorlage verwendet, macht es Sinn, diesen entweder immer oder nie mit einem Standardwert zu belegen, es ist jedoch nicht erforderlich.
==== Leere Parameter ====
Ein Parameter darf auch leer sein. Ein leerer Parameter ist aber nicht automatisch gleichbedeutend mit einer leeren Zeichenkette, also einem Leertext. Damit ein leerer Parameter bei Verwendung einer Vorlage auch als leerer Text angezeigt wird, wird dieser als Standardwert vorbelegt. Hierzu wird der Parameter wie folgt angegeben: <code><nowiki>{{{<Parametername>|}}}</nowiki></code>.
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Leere Parameter zulassen|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
<pre>Beispielvorlage4:
Herzlich Willkommen {{{Benutzername}}}.
</pre>
<pre>Beispielvorlage5:
Herzlich Willkommen {{{Benutzername|}}}.
</pre>
* <code><nowiki>{{Beispielvorlage4}}</nowiki></code> -> Herzlich Willkommen {{{Benutzername}}}.
* <code><nowiki>{{Beispielvorlage5}}</nowiki></code> -> Herzlich Willkommen .
</div>
=== Erweiterte Dynamisierung: Variablen, Funktionen, Parser-Funktionen, Rekursionen ===
=== {{#var:refVorlageDokumentieren}} ===
Vorlagen sind bei der Erstellung oder Bearbeitung immer entsprechend zu dokumentieren. Dies erhöht einerseits die Wartbarkeit der Vorlage selbst und andererseits wird damit der Anwender einer Vorlage bei der Einbindung auf einer Seite unterstützt.
* Beispiel 1: [[Vorlage:Team]]: Neben den einleitenden Bemerkungen sind ein Abschnitt zur Verwendung und eine Vorschau mit einigen Anwendungsbeispielen enthalten. Die Verwendung der Vorlage ist ausführlich anhand mehrerer Anwendungsszenarien erläutert.
* Beispiel 2: [[Vorlage:Infobox Kapitel]]: Neben den einleitenden Bemerkungen sind ein Abschnitt zur Verwendung mit Parameterübersicht und eine Kopiervorlage enthalten.
Bei Erstellung einer Vorlage sind die folgenden Informationen anzugeben:
* Beschreibung, was die Funktion und das Ziel der Vorlage ist
* Verwendungshinweis
** Wann ist die Vorlage einzusetzen bzw. wann nicht
** Wie kann die Vorlage verwendet werden
** Falls die Vorlage parametrierbar ist: Übersicht über die möglichen Parameter der Vorlage mit kurzer Erläuterung
* Vorschau / Anwendungsbeispiele (''optional'')
* Kopiervorlage (''optional'')
Bei Bearbeitung einer Vorlage sind folgende Änderungen zu dokumentieren:
* Neue Parameter sind in die Parameterübersicht mit einer kurzen Erläuterung aufzunehmen bzw. es ist eine Parameterübersicht anzulegen
* Entfallene Parameter sind in der Parameterübersicht als ''obsolet'' oder ''veraltet'' zu kennzeichnen
* Geänderte oder ergänzte Funktionsweisen sind zu beschreiben und ggf. mit einem Beispiel zu verdeutlichen
* Bereits vorhandene Anwendungsbeispiele oder Kopiervorlagen sind auf Korrektheit zu prüfen und ggf. an die durchgeführten Änderungen anzupassen
* Nach dem Speichern der durchgeführten Änderungen an der Vorlage ist die Vorschau zu prüfen (insbesondere bei Textbausteinen wichtig) und ggf. durch ein ''touch'', ein erneutes Speichern ''ohne'' Änderungen zu tätigen, zu aktualisieren
Die Dokumentation kann in der Regel auf der Vorlagenseite selbst erfolgen. Damit sie nicht auf den einbindenden Seiten angezeigt wird, wird die Dokumentation in einen ''noinclude''-Block eingeschlossen oder außerhalb der ''onlyinclude''-Blöcke gesetzt.
Ausführliche oder sehr komplexe Dokumentationen können auch auf eine Unterseite zur Vorlage ausgelagert werden. Die Dokumentation soll in diesem Fall auf einer Seite mit dem Titel <code><nowiki>Vorlage:<Name der Vorlage>/Doku</nowiki></code> erstellt werden. Eingebunden wird die Dokumentation dann wie eine Vorlage auf der Seite der Vorlage, die sie dokumentiert:
:<code><nowiki><noinclude>{{Vorlage:<Name der Vorlage>/Doku}}</noinclude></nowiki></code>.
=== Kategorisierung ===
{{Siehe_auch|Hilfe:Kategorien#Grundlegendes|titel1=Hilfe zu Kategorien}}
Abschließend ist die Vorlage zu kategorisieren. Hierfür sind eine oder mehrere passende Unterkategorien aus [[:Kategorie:Vorlage]] anzugeben. Im Abschnitt "{{#var:refConanWikiVorlagen}}" sind die einzelnen Unterkategorien in {{SITENAME}} im Überblick dargestellt. Diese Kurzbeschreibungen finden sich auch auf den Seiten der jeweiligen Kategorien und sollen beim Einordnen oder Finden von Vorlagen unterstützen. Eine Einsortierung von Vorlagen in Artikelkategorien ist nicht erwünscht.
Bei der Kategorisierung von Vorlagen ist zu beachten, dass dies innerhalb von ''noinclude''-Blöcken oder außerhalb von ''onlyinclude''-Blöcken geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird: <code><nowiki><noinclude>[[Kategorie:Vorlage:<Unterkategorie>]]</noinclude></nowiki></code>.
Soll eine Sortierung vorgegeben werden, ist der Sortierschlüssel direkt beim Setzen der Kategorie anzugeben: <code><nowiki>[[Kategorie:Vorlage:<Unterkategorie>|<Sortierschlüssel>]]</nowiki></code>.
== {{#var:refConanWikiVorlagen}} ==
<!-- Aufbau der Kategorie:Vorlage erläutern -> Infotexte sollten als Doku-Bausteine erstellt werden; diese können dann auch auf den jeweiligen Kategorie:Seiten eingebunden werden-->
{{Hilfe:Vorlagen/ConanWiki}}
In diesem Abschnitt geht es um die Vorlagen in {{SITENAME}}. Da alle Vorlagen grundsätzlich kategorisiert sein sollen, beschränken sich die nachfolgenden Ausführungen auf den Aufbau der [[:Kategorie:Vorlage]] und ihre Unterkategorien.
Zentrale ''Dimensionen'' bei der Kategorisierung sind als Unterkategorien abgebildet. Dabei kann eine Vorlage in mehreren Dimensionen kategorisiert werden und sollte immer so genau wie möglich eingeordnet werden. Die Dimensionen helfen dabei, Vorlagen wiederzufinden oder ähnliche Vorlagen zu finden.
=== Kategorien-Graph für Vorlagen ===
<!--@ToDo:Skript basteln-->
*[[:Kategorie:Vorlage]]
**[[:Kategorie:Vorlage nach Artikeltyp]]
***[[:Kategorie:Vorlage:Band]]
***[[:Kategorie:Vorlage:Charakter]]
***[[:Kategorie:Vorlage:Episode]]
***[[:Kategorie:Vorlage:Fall]]
***[[:Kategorie:Vorlage:Film]]
***[[:Kategorie:Vorlage:Gegenstand]]
***[[:Kategorie:Vorlage:Kapitel]]
***[[:Kategorie:Vorlage:Ort]]
**[[:Kategorie:Vorlage nach Eigenschaft]]
**[[:Kategorie:Vorlage nach Namensraum]]
**[[:Kategorie:Vorlage Baustein]]
**[[:Kategorie:Vorlage Formatierungshilfe]]
**[[:Kategorie:Vorlage:Funktion]]
**[[:Kategorie:Vorlage Infobox]]
**[[:Kategorie:Vorlage Navigationsleiste]]<!--@Todo:kategorisieren-->
**[[:Kategorie:Vorlage Spoiler]]<!--@Todo:kategorisieren-->
Die Kategorie "Vorlage" bildet die Hauptkategorie für sämtliche Vorlagen. In ihr sollen keine Vorlagen direkt eingeordnet sein, da sie eine zu allgemeine Kategorie ist. Sind Vorlagen direkt dieser Kategorie zugeordnet, sind diese passend neu zu kategorisieren oder mithilfe der [[Vorlage:Team|Team]]-Vorlage wie folgt dem [[{{SITENAME}}:Team Korrektur|Team Korrektur]] zu melden:
:<code><nowiki>{{Team|Korrektur|Bitte Vorlage passend kategorisieren. ~~</nowiki><nowiki>~~}}</nowiki></code>
==== Vorlage nach Artikeltyp ====
Die Kategorie Vorlage nach Artikeltyp enthält Vorlagen, die vorrangig in einzelnen [[Hilfe:Übersicht#spezielle_Artikel|speziellen Artikeln]] verwendet werden. Hierbei bezeichnet der Artikeltyp, was in dem Artikel thematisiert wird, ohne Bezug auf den konkreten Inhalt zu nehmen. Beispielsweise bezeichnet der Artikeltyp "Kapitel" einen Artikel, der sich mit dem Inhalt eines Manga-Kapitels befasst. Der konkrete Inhalt kann sowohl aus der Serie ''Detektiv Conan'' oder '' Kaito Kid'' oder einem anderen hier im Wiki akzeptierten Manga von [[Gosho Aoyama]] sein.
<!--@ToDo: Skript bauen-->
*[[:Kategorie:Vorlage:Band]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Charakter]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Episode]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Fall]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Film]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Gegenstand]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Kapitel]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
*[[:Kategorie:Vorlage:Ort]]
*:Die Kategorie Vorlage:Band enthält Vorlagen, die vorrangig in Band-Artikeln Anwendung finden.
==== Vorlage nach Eigenschaft ====
==== Vorlage nach Namensraum ====
==== Vorlage Baustein ====
==== Vorlage Formatierungshilfe ====
==== Vorlage Funktion ====
=== Vorlagen finden ===
Ist der Name der Vorlage bekannt, kann die Vorlage direkt über die Suchfunktionen für Seiten hier im Wiki gefunden werden. Ist der genaue Name der Vorlage nicht bekannt, jedoch mindestens eine Seite, auf der die Vorlage eingebunden ist, kann im Bearbeitungsmodus der Seite nach der Vorlage geschaut werden. Wurde diese ''nicht'' substantiviert eingebunden, dann steht im Seitentext der Code <code><nowiki>{{<Name der Vorlage>}}</nowiki></code>. Anschließend kann die Vorlage mithilfe des Namens gesucht werden.
{{Vorlage:Absatzrahmen (Formatierung)|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
Gute Beispiele hierfür sind Vorlagen, die in speziellen Artikeln verwendet werden. Möchte ein Autor einen neuen Kapitel-Artikel verfassen, kann er sich zunächst einen bestehenden Artikel im Bearbeitungsmodus ansehen und dadurch die Namen wichtiger Vorlagen ermitteln.</div>
Nicht immer ist jedoch eine Seite bekannt auf der die gesuchte Vorlage verwendet wird oder aber die Vorlage wurde substantiviert eingebunden und damit lediglich der Inhalt der Vorlage kopiert. Oder es ist nicht bekannt, ob überhaupt bereits eine Vorlage existiert, die die gewünschte Aufgabe erfüllt. In diesem Fall kann über den Kategorien-Graph gesucht werden. Die nachfolgenden Fragen können für eine gezielte Suche helfen:
* Was macht die gesuchte Vorlage? -> (Text)Baustein, Formatierungshilfe, Funktion?
* Wo wird die Vorlage vornehmlich verwendet? -> Artikeltyp, Namensraum?
* Erfüllt die Vorlage bestimmte Eigenschaften? -> Eigenschaft?
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Finden der Vorlage:Willkommen|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
Auf der Diskussionsseite von Beispielbenutzer wurde die Willkommen-Vorlage substantiviert eingebunden. Beispielbenutzer erkennt den Text auch auf Diskussionsseiten anderer Benutzer und vermutet daher, dass es sich um eine Vorlage handelt. Er möchte zukünftig ebenfalls neue Benutzer mit der Vorlage begrüßen.
# Was macht die Vorlage?
#: Die Vorlage zeigt einen Begrüßungstext an. Beispielbenutzer vermutet daher, es handelt sich bei ihr um einen (Text)''Baustein''.
# Wo wird die Vorlage vornehmlich verwendet?
#: Die Vorlage wird zur Begrüßung neuer Benutzer auf deren Diskussionsseite verwendet. Beispielbenutzer vermutet daher, die Vorlage wird vornehmlich im Namensraum ''Diskussion'' verwendet.
# Erfüllt die Vorlage bestimmte Eigenschaften?
#: Hierüber hat Beispielbenutzer keine weiteren Informationen. Da die Vorlage substantiviert eingebunden wurde, weiß er nicht, ob beispielsweise die Signatur automatisch von der Vorlage erzeugt wurde oder beim Einbinden als Parameter mitgegeben wurde. Er weiß auch nicht, ob die Vorlage immer substantiviert eingebunden werden muss.
Beispielbenutzer entschließt sich daher, zunächst über die beiden Dimensionen "Vorlage nach Namensraum" und "Vorlage Baustein" zu suchen. In beiden Kategorien findet er die Unterkategorie "Vorlage Diskussion", die demnach nur Vorlagen enthält, die einen ''Diskussionsbaustein'' darstellen.
</div>
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Finden der Vorlage:Inuse|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
Beispielbenutzer möchte einen bestehenden Artikel in {{SITENAME}} gründlich überarbeiten. Er erinnert sich, schon einmal einen Artikel gesehen zu haben, bei dem ein anderer Benutzer angekündigt hat, dass der Artikel überarbeitet wird und möchte diesen Hinweistext ebenfalls setzen.
# Was macht die Vorlage?
#: Die Vorlage zeigt einen Hinweistext an, dass ein Artikel derzeit gewartet wird. Beispielbenutzer vermutet daher, es handelt sich bei ihr um einen (Text)''Baustein''.
# Wo wird die Vorlage vornehmlich verwendet?
#: Hierüber kann Beispielbenutzer keine genauen Angaben machen. Er kann sich vorstellen, dass sowohl Artikel, Hilfe-Seiten oder Vorlagen gewartet werden; eine Einsortierung nach Namensraum oder gar Artikeltyp vermutet er daher nicht.
# Erfüllt die Vorlage bestimmte Eigenschaften?
#: Hierüber hat Beispielbenutzer ebenfalls keine weiteren Informationen. Er kann sich jedoch vorstellen, dass es ggf. eine ''Eigenschaft'' gibt, die "nur Wartung" heißt, die seiner Meinung nach ausdrückt, dass eine Vorlage nur zur Wartung dient.
In der Kategorie "Vorlagen nach Eigenschaft" findet Beispielbenutzer keine passende Unterkategorie, die auf seine vermutete Eigenschaft hinsichtlich "Wartung" hinweist. Er bricht die Suche über diese Dimension daher ab.
In der Kategorie "Vorlage:Baustein" findet Beispielbenutzer hingegen eine Unterkategorie für ''Wartungsbausteine'', in der er die gesuchte Vorlage vermutet und findet.
</div>
''Hinweis'': die Kategorisierung ist kein alleiniges Mittel um Vorlagen in {{SITENAME}} zu finden. Insbesondere können nicht alle Vorlagen über ihre Kategorie(n) gleichermaßen 'einfach' gefunden werden. Beispielsweise sind Vorlagen, die nur hinsichtlich einer Dimension kategorisiert sind ggf. nur über genau einen Pfad im Kategorien-Graph findbar. Vorlagen, die besonders genau kategorisiert werden können, rutschen automatisch in eine tiefergelegene Unterkategorie als Vorlagen die nur grob kategorisiert werden können.
Auch die [[Hilfe:Übersicht|Hilfe-Seiten]] können beim Finden von Vorlagen helfen. Hier sind oftmals zentrale Vorlagen gelistet, die für ein bestimmtes Thema wichtig sind. Beispielsweise wird auf der [[Hilfe:Kapitel|Hilfe zu Kapitel-Artikeln]] auf die obligatorischen und optionalen Vorlagen verwiesen, die in Kapitel-Artikeln verwendet werden können. Auch auf Vorlagen zur weiteren Artikel-Wartung wird verwiesen.
=== Vorlagen einsortieren ===
Bei der Kategorisierung einer Vorlage in {{SITENAME}} helfen ebenfalls die drei Fragen "Was macht die Vorlage?", "Wann oder Wo soll sie (vornehmlich) verwendet werden?" und "Gibt es zusätzliche Eigenschaften, die von der Vorlage erfüllt werden?". Dabei ist die Vorlage immer gemäß ''allen'' möglichen Dimensionen einzuordnen.
{{Vorlage:Absatzrahmen (Formatierung)|hinweis=Vorlage, um auf einen nachfolgenden Band-Artikel zu verweisen|farbcode_rot=113|farbcode_gruen=163|farbcode_blau=212|datei=stern.png}}
Beispielbenutzer hat eine neue Vorlage angelegt, mit der in einem Band-Artikel auf den Artikel des nachfolgenden Manga-Bandes verwiesen werden kann. Diese Vorlage ist in ihrer Funktionsweise an die [[Vorlage:Kapitel Ende]] angelehnt.
# Was macht die Vorlage?
#: Die Vorlage formatiert mitgegebene Daten zu einem Verweis. Beispielbenutzer vermutet daher, die Vorlage ist eine sogenannte ''Formatierungshilfe''; auch die Vorlage "Kapitel Ende", die ihm als Inspiration diente, ist eine solche Formatierungshilfe.
# Wo wird die Vorlage vornehmlich verwendet?
#: Die Vorlage soll in Band-Artikeln verwendet werden. Beispielbenutzer kann daher ganz klar definieren, dass die Vorlage gemäß dem ''Artikeltyp Band'' kategorisiert werden kann. Zudem ergibt sich daraus, dass seine Vorlage vermutlich vornehmlich im ''Artikelnamensraum'' verwendet werden wird. Da die Vorlage aber noch neu und nicht als fester ''Bestandteil'' von Band-Artikeln etabliert ist, möchte er keine weitere Spezifizierung machen; anders als dies bei der bereits etablierten Vorlage "Kapitel Ende" der Fall ist.
# Erfüllt die Vorlage bestimmte Eigenschaften?
#: Hierüber hat sich Beispielbenutzer keine weiteren Gedanken gemacht. Er prüft daher lediglich, nach welchen Eigenschaften derzeit bereits kategorisiert werden kann. Keine der Eigenschaften werden von seiner neuen Vorlage erfüllt.
Beispielbenutzer entschließt sich daher seine Vorlage in die Unterkategorie "Vorlage Verweis" einzusortieren, die nur die Formatierungshilfen enthält, die einen Verweis erstellen. Weiterhin kategorisiert er sie als "Vorlage:Band", womit seine Vorlage zukünftig gemeinsam mit anderen Vorlagen für Band-Artikel gefunden werden kann. Zum Schluss setzt er noch die Kategorie "Vorlage Artikel", mit dem Wissen, dass diese Einsortierung noch recht grob ist. Er startet daher zusätzlich eine [[{{SITENAME}}:Fragen zum Wiki|Frage zum Wiki]], um zu klären, ob seine Vorlage zukünftig obligatorischer Bestandteil von Band-Artikeln sein soll oder eher optional zur Textgestaltung verwendet werden darf. Damit nach Ablauf der Diskussion die Kategorisierung seiner Vorlage noch einmal geprüft und aktualisiert wird, setzt er zusätzlich den nachfolgenden Hinweis für das Team Korrektur:
:<code><nowiki>{{Team|Korrektur|Bitte nach Ablauf [[{{SITENAME}}:Fragen zum Wiki#<meine Diskussion>|dieser Diskussion]] die Kategorisierung der Vorlage erneut prüfen. ~~</nowiki><nowiki>~~}}</nowiki></code>.
</div>
=={{#var:refFragen}} ==
| 