|
Qualitätswoche: Artikel verbessern und Crunchyroll-Premium-Abo gewinnen!
Verbessere im Rahmen der Qualitätswoche einen Artikel deiner Wahl und gewinne mit etwas |
Benutzer:Rikku/Test: Unterschied zwischen den Versionen
Rikku (Diskussion | Beiträge) K (test:) |
Rikku (Diskussion | Beiträge) (hilfe vorlagen (i);) |
||
| Zeile 1: | Zeile 1: | ||
| + | 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 in eine Seite einzubinden}}}. Anschließend sind Hinweise zur {{{Erstellung von Vorlagen}}} zusammengefasst, gefolgt von einem kommentierten Überblick über die Vorlagen hier im {{SITENAME}}. |
||
| − | <onlyinclude>== Erweiterung der [[Vorlage:{{{Name}}}]] == |
||
| − | Hallo {{PAGENAME}}. Mir ist aufgefallen, dass du die Vorlage {{{Name}}} erweitert hast. Damit die Verwendungshinweise weiterhin aktuell bleiben, bitte ergänze Änderungen dort ebenfalls. Nimm neu hinzugekommene Parameter mit einem kurzen Anwendungshinweis, wann und wie diese zu verwenden sind, in die Liste der Parameter mit auf oder kennzeichne entfernte Parameter als ''veraltet''. Bei Bedarf aktualisiere auch die Kopiervorlage(n), sofern vorhanden. |
||
| + | 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. |
||
| − | Einerseits können damit alle Benutzer des Wikis die Vorlage immer in der aktuellsten Version verwenden und deine Neuerungen berücksichtigen. Andererseits ist für zukünftige Weiterentwicklungen an der Vorlage immer der aktuelle Status kurz dokumentiert. Andere Benutzer stoßen also im Vorlagen-Code nicht auf unbekannte Parameter, deren Hintergrund sie erst erschließen oder erfragen müssen. Vielen Dank schon einmal für deine Hilfe. <includeonly>~~</includeonly>~~<noinclude>~~ [[Kategorie:Vorlage Diskussion]][[Kategorie:Vorlage:nur Subst]][[Kategorie:Vorlage:mit Signatur]]</noinclude></onlyinclude> |
||
| + | |||
| + | * Neueinsteigern, die wenig bis keine Erfahrungen im Wiki haben, werden daher zunächst besonders die beiden Abschnitte {{Was ist eine Vorlage}} und {{Vorlagen 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 überarebteitete 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 {{SITENAME}} enthält. Jeder neu registrierte Benutzer bekommt sie auf seiner Diskussionseite 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 nicht von den [[Freie Kapitel|Freien Kapiteln]] in einen Manga-Band wandert und die Wiki-Autoren müssen sich nicht manuell um die 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: |
||
| + | # 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. Willkommens-Vorlage "Vorlage:Willkommen", wobei das Präfix ''Vorlage:'' den Namensraum kennzeichnet. Es können aber auch beliebige andere Seiten wie Vorlagen eingebunden werden. Liegen diese nicht im Artikel-Namensraum, so muss das Präfix für den Namensraum ebenfalls mit angegeben werden. Dies 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 "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 Willkommens-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. |
||
| + | |||
| + | {{Benutzer:Rikku/Test2|hinweis=Vorlagen mit anonymen Parametern|farbcode_rot=105|farbcode_gruen=119|farbcode_blau=219|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 als dem ''Detektiv Conan''-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Formatierungshilfe, die beispielsweise für das erste Kapitel einen [[Hilfe:interne 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 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. |
||
| + | </div> |
||
| + | |||
| + | {{Benutzer:Rikku/Test2|hinweis=Vorlagen mit ausgezeichneten Parametern|farbcode_rot=105|farbcode_gruen=119|farbcode_blau=219|datei=stern.png}} |
||
| + | </div> |
||
| + | |||
| + | == Vorlagen erstellen == |
||
| + | # Namensraum |
||
| + | # Einbindungsart definieren |
||
| + | # Dynamisierung: Parameter definieren |
||
| + | # Dynamisierung: Variablen, Funktionen, Parser-Funktionen, Rekursionen |
||
| + | # Kategorisierung |
||
| + | |||
| + | == Vorlagen in {{SITENAME}} == |
||
| + | <!-- 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--> |
||
| + | |||
| + | == Noch Fragen? == |
||
| + | {{Hilfeseite Artikeltyp Fragen}} |
||
Version vom 7. April 2014, 19:51 Uhr
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 in eine Seite einzubinden}}}. Anschließend sind Hinweise zur {{{Erstellung von Vorlagen}}} zusammengefasst, gefolgt von einem kommentierten Überblick über 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 Vorlage:Was ist eine Vorlage und Vorlage:Vorlagen verwenden empfohlen.
- Erfahrene Benutzer können sich gezielt mit den Vorlage:Vorlagen im Wiki auseinandersetzen. Dies ist insbesondere für die Qualitätssicherung wichtig und für Vorlagen-Entwickler, um neue oder überarebteitete 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 Diskussionseite 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 nicht von den Freien Kapiteln in einen Manga-Band wandert und die Wiki-Autoren müssen sich nicht manuell um die 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:
- 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. - Der Vorlageninhalt wird substantiviert eingebunden. Hierbei wird dem Seitenname der Vorlage das Schlüsselwort
subst:(für Substitution) oder auchers:(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. Willkommens-Vorlage "Vorlage:Willkommen", wobei das Präfix Vorlage: den Namensraum kennzeichnet. Es können aber auch beliebige andere Seiten wie Vorlagen eingebunden werden. Liegen diese nicht im Artikel-Namensraum, so muss das Präfix für den Namensraum ebenfalls mit angegeben werden. Dies 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 Willkommens-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.
| [[|]] | |||
|---|---|---|---|
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 erstellen
- Namensraum
- Einbindungsart definieren
- Dynamisierung: Parameter definieren
- Dynamisierung: Variablen, Funktionen, Parser-Funktionen, Rekursionen
- Kategorisierung
Vorlagen in ConanWiki
Noch Fragen?
Für Fragen stehen die erfahrenen Benutzer des Wiki gerne bereit. Alternativ können Fragen zum Schreiben von {{{Artikeltyp}}}n auch auf der Diskussion dieser Hilfeseite oder auf der allgemeinen Seite für Fragen zum Wiki gestellt werden.