Qualitätswoche
Qualitätswoche: Artikel verbessern und Crunchyroll-Premium-Abo gewinnen!

Verbessere im Rahmen der Qualitätswoche einen Artikel deiner Wahl und gewinne mit etwas
Glück eine Crunchyroll-Premium-Mitgliedschaft. – Jetzt mitmachen …

Benutzer:Rikku/Test2: Unterschied zwischen den Versionen

Aus ConanWiki
Zur Navigation springen Zur Suche springen
Inhalt hinzugefügt Inhalt gelöscht
VisuellWikitext
KKeine Bearbeitungszusammenfassung
(+parameter definieren, dokumentation, kategorisierung;)
Zeile 84: Zeile 84:
   
 
[[Kategorie:Vorlage Infobox|Mangaband]][[Kategorie:Vorlage:Band]]
  
[[Kategorie:Vorlage Infobox|Mangaband]][[Kategorie:Vorlage:Band]]
−
</noinclude>--><noinclude>
 +
</noinclude>--><noinclude>{{Hilfe}}
 
<!--
  
<!--
 
Definierte Variablen in dieser Hilfeseite:
  
Definierte Variablen in dieser Hilfeseite:
Zeile 129: Zeile 129:
 
* Sonst: das Präfix für den Namensraum muss ebenfalls mit angegeben werden: <code><nowiki>{{<Namensraum>:<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>.
   
−
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 {{SITENAME}} eingebunden und aktiv verwendet werden sollen, sind jedoch im Vorlagen-Namensraum zu erstellen bzw. nach den persönlichen Tests dorthin zu verschieben.
 +
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 ===
  
=== 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: <code><nowiki>{{subst:Willkommen|~~~~}}</nowiki></code>.
 +
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.
  
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.
Zeile 164: Zeile 164:
 
* sowohl auf der Vorlagenseite als auch auf den Seiten die die Vorlagen einbinden sichtbar ist.
  
* sowohl auf der Vorlagenseite als auch auf den Seiten die die Vorlagen einbinden sichtbar ist.
   
−
; <tt><nowiki><onlyinclude></nowiki></tt>
 +
; <tt><nowiki>&lt;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. Mit <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.
 +
: Wenn die Vorlage direkt betrachtet wird, haben <code><nowiki>&lt;onlyinclude></nowiki></code> und <code><nowiki>&lt;/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. Mit <code><nowiki>&lt;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>&lt;onlyinclude></nowiki></code>-Blöcke in einer Vorlage stehen.
−
; <tt><nowiki><includeonly></nowiki></tt>
 +
; <tt><nowiki>&lt;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.
 +
: Alles, was in einer Vorlage zwischen <code><nowiki>&lt;includeonly></nowiki></code> und <code><nowiki>&lt;/includeonly></nowiki></code> steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden wird. Mit <code><nowiki>&lt;includeonly></nowiki></code> lassen sich zum Beispiel alle Seiten, die eine bestimmte Vorlage enthalten, automatisch einer Kategorie hinzufügen. <code><nowiki>&lt;includeonly></nowiki></code> kann auch innerhalb von <code><nowiki>&lt;onlyinclude></nowiki></code>-Blöcken stehen.
−
; <tt><nowiki><noinclude></nowiki></tt>
 +
; <tt><nowiki>&lt;noinclude></nowiki></tt>
−
: Alles, was in einer Vorlage zwischen <code><nowiki>&lt;noinclude></nowiki></code> und <code><nowiki>&lt;/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><onlyinclude></nowiki></code> sollte zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden. <code><nowiki><noinclude></nowiki></code> kann auch innerhalb von <code><nowiki><onlyinclude></nowiki></code>-Blöcken stehen.
 +
: Alles, was in einer Vorlage zwischen <code><nowiki>&lt;noinclude></nowiki></code> und <code><nowiki>&lt;/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><onlyinclude></nowiki></code> sollte zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden. <code><nowiki>&lt;noinclude></nowiki></code> kann auch innerhalb von <code><nowiki>&lt;onlyinclude></nowiki></code>-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.
  
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:
  
Nachfolgend einige Beispiele für mögliche sinnvolle Einbindungsarten:
−
{| class="roundtable wiki"
 +
{| class="roundtable wiki" style="width:95%; margin:10px;"
−
! Tag-Kombination
 +
! style="width:22%;" | Tag-Kombination
−
! Auf der Vorlagenseite
 +
! style="width:16%;" | Auf der Vorlagenseite
−
! Auf der einbindenden Seite
 +
! style="width:20%;" | Auf der einbindenden Seite
 
! Bemerkung
  
! Bemerkung
 
|-
  
|-
Zeile 188: Zeile 188:
 
| &lt;onlyinclude>…&lt;/onlyinclude> || sichtbar || sichtbar [3] || [3] Text außerhalb des ''onlyinclude''-Blocks wird nicht eingebunden.
  
| &lt;onlyinclude>…&lt;/onlyinclude> || sichtbar || sichtbar [3] || [3] Text außerhalb des ''onlyinclude''-Blocks wird nicht eingebunden.
 
|-
  
|-
−
| Text 1<br />&lt;onlyinclude>Text 2<br />&lt;includeonly>Text 3&lt;/includeonly><br />&lt;noinclude>Text 4&lt;/noinclude><br />&lt;/onlyinclude>Text 5 || Text&nbsp;1:&nbsp;sichtbar,<br />Text&nbsp;2:&nbsp;sichtbar,<br />Text&nbsp;3:&nbsp;nicht sichtbar,<br />Text&nbsp;4:&nbsp;sichtbar,<br />Text&nbsp;5:&nbsp;sichtbar || Text&nbsp;1:&nbsp;nicht sichtbar,<br />Text&nbsp;2:&nbsp;sichtbar,<br />Text&nbsp;3:&nbsp;sichtbar,<br />Text&nbsp;4:&nbsp;nicht sichtbar,<br />Text&nbsp;5:&nbsp;nicht sichtbar||
 +
| Text 1<br />&lt;onlyinclude>Text 2<br />&lt;includeonly>Text 3&lt;/includeonly><br />&lt;noinclude>Text 4&lt;/noinclude><br />&lt;/onlyinclude>Text 5 || Text&nbsp;1:&nbsp;sichtbar,<br />Text&nbsp;2:&nbsp;sichtbar,<br />Text&nbsp;3:&nbsp;nicht sichtbar,<br />Text&nbsp;4:&nbsp;sichtbar,<br />Text&nbsp;5:&nbsp;sichtbar || Text&nbsp;1:&nbsp;nicht sichtbar,<br />Text&nbsp;2:&nbsp;sichtbar,<br />Text&nbsp;3:&nbsp;sichtbar,<br />Text&nbsp;4:&nbsp;nicht sichtbar,<br />Text&nbsp;5:&nbsp;nicht sichtbar ||
 
|}
  
|}
   
  +
Nachfolgend einige Beispiele für ''nicht'' sinnvolle Einbindungsarten:
−
=== Dynamisierung: Parameter definieren ===
  
  +
{| class="roundtable wiki" style="width:95%; margin:10px;"
−
=== Dynamisierung: Variablen, Funktionen, Parser-Funktionen, Rekursionen ===
  
  +
! style="width:22%;" | Tag-Kombination
  +
! style="width:16%;" | Auf der Vorlagenseite
  +
! style="width:20%;" | Auf der einbindenden Seite
  +
! Bemerkung
  +
|-
  +
| &lt;includeonly>Text 1&lt;/includeonly><br />&lt;onlyinclude>Text 2&lt;/onlyinclude> || Text&nbsp;1:&nbsp;nicht sichtbar,<br />Text&nbsp;2:&nbsp;sichtbar || Text&nbsp;1:&nbsp;nicht sichtbar,<br />Text&nbsp;2:&nbsp;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.
  +
|-
  +
| &lt;includeonly>&lt;onlyinclude>...<br />&lt;/onlyinclude>&lt;/includeonly> || nicht&nbsp;sichtbar || sichtbar || Textblöcke innerhalb von ''includeonly''-Blöcke 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 {{{1}}}s Auffassung ist der Täter {{{2}}}.
  +
</pre>
  +
<pre>Beispielvorlage2:
  +
Nach {{{Detektiv}}}s Auffassung 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.
  +
&nbsp;
  +
</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 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 verwenden, 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 {{{Detektiv|des Detektiv}}}s Auffassung 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.
  +
&nbsp;
  +
</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 .
  +
&nbsp;
  +
</div>
  +
  +
=== Erweiterte Dynamisierung: Variablen, Funktionen, Parser-Funktionen, Rekursionen ===
  +
 
=== {{#var:refVorlageDokumentieren}} ===
  
=== {{#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 kurzer 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>&lt;noinclude>{{Vorlage:<Name der Vorlage>/Doku}}&lt;/noinclude></nowiki></code>.
  +
 
=== Kategorisierung ===
  
=== 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 Kurzbeschreibung findet sich auch auf der Seite der jeweiligen Kategorie und soll 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 geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird: <code><nowiki>&lt;noinclude>[[Kategorie:Vorlage:<Unterkategorie>]]&lt;/noinclude></nowiki></code>
  +
  +
Soll eine Sortierung vorgegeben werden, ist der Sortierschlüssel direkt beim Setzen der Kategorie anzugeben:
  +
:<code><nowiki>&lt;noinclude>[[Kategorie:Vorlage:<Unterkategorie>|<Sortierschlüssel>]]&lt;/noinclude></nowiki></code>
   
−
=={{#var:refConanWikiVorlagen}} ==
 +
== {{#var:refConanWikiVorlagen}} ==
 
<!-- Beispiele
  
<!-- Beispiele
 
- 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-->
  
- 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-->

Version vom 14. April 2014, 13:11 Uhr

Navigation

Allgemeines

Artikelgestaltung

Artikeltypen

Dateien

Wiki-Gemeinschaft

Fragen?

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>}}.

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 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.

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

Nachfolgend einige Beispiele für nicht sinnvolle Einbindungsarten:

Tag-Kombination Auf der Vorlagenseite Auf der einbindenden Seite Bemerkung
<includeonly>Text 1</includeonly>
<onlyinclude>Text 2</onlyinclude>		 Text 1: nicht sichtbar,
Text 2: sichtbar		 Text 1: nicht sichtbar,
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>...
</onlyinclude></includeonly>		 nicht sichtbar sichtbar Textblöcke innerhalb von includeonly-Blöcke 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 "Vorlage verwenden" 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:

  • {{{Y}}}, wobei Y eine fortlaufende Nummer beginnend bei Eins ist, kennzeichnet einen anonymen Parameter.
  • {{{<Parametername>}}} 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:

Anonyme und ausgezeichnete Parameter definieren

Beispielvorlage1:
Nach {{{1}}}s Auffassung ist der Täter {{{2}}}.

Beispielvorlage2:
Nach {{{Detektiv}}}s Auffassung ist der Täter {{{Täter}}}.

Die beiden Beispielvorlagen können wie folgt verwendet werden:

  • {{Beispielvorlage1|Kogoro Mori|Yoshihito Kureko}} -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.
  • {{Beispielvorlage2|Detektiv=Kogoro Mori|Täter=Yoshihito Kureko}} -> 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:

  • {{Beispielvorlage1|Yoshihito Kureko|Kogoro Mori}} -> Nach Auffassung Yoshihito Kurekos ist der Täter Kogoro Mori.
  • {{Beispielvorlage2|Täter=Yoshihito Kureko|Detektiv=Kogoro Mori}} -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.

 

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 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 verwenden, 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: {{{<Parametername>|<Standardwert>}}}. 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.

Parameter mit Vorbelegung

Beispielvorlage2:
Nach {{{Detektiv|des Detektiv}}}s Auffassung ist der Täter {{{Täter|noch unbekannt}}}.
  • {{Beispielvorlage2|Detektiv=Kogoro Mori|Täter=Yoshihito Kureko}} -> Nach Auffassung Kogoro Moris ist der Täter Yoshihito Kureko.
  • {{Beispielvorlage2}} -> Nach Auffassung des Detektivs ist der Täter noch unbekannt.

 

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: {{{<Parametername>|}}}.

Leere Parameter zulassen

Beispielvorlage4:
Herzlich Willkommen {{{Benutzername}}}.

Beispielvorlage5:
Herzlich Willkommen {{{Benutzername|}}}.
  • {{Beispielvorlage4}} -> Herzlich Willkommen {{{Benutzername}}}.
  • {{Beispielvorlage5}} -> Herzlich Willkommen .

 

Erweiterte Dynamisierung: Variablen, Funktionen, Parser-Funktionen, Rekursionen

Dokumentation

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 kurzer 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 Vorlage:<Name der Vorlage>/Doku erstellt werden. Eingebunden wird die Dokumentation dann wie eine Vorlage auf der Seite der Vorlage, die sie dokumentiert:

<noinclude>{{Vorlage:<Name der Vorlage>/Doku}}</noinclude>.

Kategorisierung

→ Siehe auch: Hilfe zu Kategorien

Abschließend ist die Vorlage zu kategorisieren. Hierfür sind eine oder mehrere passende Unterkategorien aus Kategorie:Vorlage anzugeben. Im Abschnitt "Vorlagen in ConanWiki" sind die einzelnen Unterkategorien in ConanWiki im Überblick dargestellt. Diese Kurzbeschreibung findet sich auch auf der Seite der jeweiligen Kategorie und soll 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 geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird: <noinclude>[[Kategorie:Vorlage:<Unterkategorie>]]</noinclude>

Soll eine Sortierung vorgegeben werden, ist der Sortierschlüssel direkt beim Setzen der Kategorie anzugeben:

<noinclude>[[Kategorie:Vorlage:<Unterkategorie>|<Sortierschlüssel>]]</noinclude>

Vorlagen in ConanWiki

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.

Abgerufen von „https://conanwiki.org/index.php?title=Benutzer:Rikku/Test2&oldid=153977“