Benutzer:Rikku/Test2: Unterschied zwischen den Versionen

@ToDo:Textbaustein-->Auf dieser Hilfeseite sind wichtige Hinweise für das Erstellen oder Verwenden von {{Vorlagen}} zusammengefasst. Nach einer kurzen Erläuterung, was {{Vorlagen}} sind, folgt eine Beschreibung der notwendigen Schritte, {{um eine Vorlage inauf eineeiner Seite einzubinden}}. Anschließend sind Hinweise zur {{Erstellung von Vorlagen}} zusammengefasst, gefolgt von einem kommentierten Überblick über {{die Vorlagen}} hier im {{SITENAME}}.

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

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 {{SITENAME}} 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 in 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übergebene 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 [[Freie Kapitel|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.

=== Einbinden von Vorlagen inauf anderen Seiten ===

Die [[Vorlage:K]] wird gemäß ihres Verwendungshinweises wie folgt eingebunden: <code><nowiki>{{K|XXX}}</nowiki></code>, wobei XXX der Nummer eines beliebigen Kapitels alsaus dem ''Detektiv Conan''-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Formatierungshilfe, die beispielsweise für das erstemitgegebene Kapitel einen [[Hilfe:Verlinkung|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 Querstrichsenkrechten 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.

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 alsaus dem ''Detektiv Conan''-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Infobox, die in [[Hilfe:Kapitel|Kapitel-Artikel]]n verwendet wird.

=== EinbindungsartSichtbarkeit definieren ===

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

: 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. MitAußerhalb von <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.

: 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&lt;noinclude></nowiki></code> solltekann zumauch Abgrenzen des eigentlichen Vorlagentextesinnerhalb von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden. <code><nowiki>&lt;noincludeonlyinclude></nowiki></code>-Blöcken kann auch innerhalb vonstehen. <code><nowiki>&lt;onlyinclude></nowiki></code>-Blöcken stehensollte zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks bevorzugt werden.

WirdSind in der Vorlage keine EinbindungsartVorgaben 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 EinbindungsartenVorgaben zur Sichtbarkeit:

Nachfolgend einige Beispiele für ''nicht'' sinnvolle EinbindungsartenKombinationen zur Sichtbarkeit:

| &lt;includeonly>&lt;onlyinclude>...<br />&lt;/onlyinclude>&lt;/includeonly> || nicht&nbsp;sichtbar || sichtbar || Textblöcke innerhalb von ''includeonly''-BlöckeBlöcken werden außschließlich auf den einbindenden Seiten angezeigt. Der zusätzliche ''onlyinclude''-Block macht demnach keinen Sinn und lediglich die Vorlage komplizierter.

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

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

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.

''Hinweis'': Nachträglich eingeführte Parameter werden auf Seiten, die die Vorlage bereits eingebunden hatten nicht automatisch verwendenverwendet, 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.

Nach Auffassung {{{Detektiv|des Detektiv}}}s Auffassung ist der Täter {{{Täter|noch unbekannt}}}.

* Beispiel 2: [[Vorlage:Infobox Kapitel]]: Neben den einleitenden Bemerkungen sind ein Abschnitt zur Verwendung mit Parameterübersicht und eine Kopiervorlage enthalten.

* Beschreibung, was die Funktion und das Ziel der Vorlage ist.

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

* Neue Parameter sind in die Parameterübersicht mit einer kurzerkurzen 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.

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 KurzbeschreibungKurzbeschreibungen findetfinden sich auch auf derden SeiteSeiten der jeweiligen KategorieKategorien und sollsollen 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>&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>[[Kategorie:Vorlage:<Unterkategorie>|<Sortierschlüssel>]]</nowiki></code>.