Vorlage:Kategorie-via-Vorlage/Doku: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „<noinclude> Die ist die Dokumentation für die Vorlage:Kategorie-via-Vorlage. Sie wird dort ebenfalls angezeigt, weil die Dokumentation wie eine eigene Vor…“) |
K |
||
| (5 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 3: | Zeile 3: | ||
</noinclude> | </noinclude> | ||
==Was macht diese Vorlage?== | ==Was macht diese Vorlage?== | ||
| − | + | Diese Vorlage kann in anderen [[:Kategorie:Vorlage|Vorlagen]] verwendet werden, um durch deren Einbindung in Artikeln gleichzeitig eine Kategorie zu setzen. | |
| − | + | Das Besondere dabei: | |
| − | Die | + | * Die Sortierung aus [[Hilfe:Vorlagen|automatisierten Vorlagen]] wird übernommen. |
| + | * Artikel können anders einsortiert werden, falls beabsichtigt. | ||
| − | + | Das erspart manuelles Setzen von Kategorien, erhält jedoch deren Möglichkeiten ebenso wie die Vorteile automatisierter Vorlagen. | |
| − | + | ==Wie verwendet man diese Vorlage?== | |
| − | + | Zur Einbindung in eine Vorlage muss folgenden Code eingefügt werden: | |
| − | |||
| − | <nowiki>{{Kategorie-via-Vorlage|Kategorie= | + | <nowiki><includeonly>{{Kategorie-via-Vorlage|Kategorie=Überarbeiten|SortierschlüsselManuell={{{Sortierschlüssel|}}} }}</includeonly></nowiki> |
| − | * | + | * Läßt man die Angabe <nowiki><includeonly> </includeonly></nowiki> weg, wird auch die Vorlage in die entsprechende Kategorie einsortiert. |
* Es spielt keine Rolle, in welcher Reihenfolge man die Parameter angibt. | * Es spielt keine Rolle, in welcher Reihenfolge man die Parameter angibt. | ||
'''Parameter:''' | '''Parameter:''' | ||
| − | * '''Kategorie''' - | + | * '''Kategorie''' - Damit wird die Kategorie angegeben, die automatisch gesetzt werden soll. |
| + | ** Der Text ''Überarbeiten'' ist nur ein Beispiel und muss durch den Namen der Kategorie ersetzt werden. | ||
| − | * '''SortierschlüsselManuell''' ''<nowiki>{{{Sortierschlüssel|}}}</nowiki>'' - | + | * '''SortierschlüsselManuell''' mit der Angabe ''<nowiki>{{{Sortierschlüssel|}}}</nowiki>'' - So kann der Artikel, welcher die Vorlage verwendet, ausdrücklich anders einsortiert werden. |
| + | **Beispiel: "[[Drakensang]]" soll in der [[:Kategorie:Drakensang]] nicht unter "D" einsortiert werden, sondern ganz am Anfang, also wie üblich unter "!". | ||
| + | **Im Artikel wird die <nowiki>{{Navigationsleiste Drakensang}}</nowiki> daher so eingebunden: <nowiki>{{Navigationsleiste Drakensang|Sortierschlüssel=!}}</nowiki>. | ||
| + | **In der Vorlage, die diese Vorlage verwendet, kann für den Namen der Variable etwas anderes als "Sortierschlüssel" angegeben werden. Für die Endnutzer ist es jedoch leichter, einen einheitlichen Namen verwenden zu können. | ||
| + | **Entscheidend ist die Abfrage als Variable (durch <nowiki>{{{ |}}}</nowiki>) in der Vorlage. Sonst wird allen Artikeln, die die Vorlage verwenden, derselbe feste Sortierschlüssel zugeordnet! | ||
==Einsatzzweck== | ==Einsatzzweck== | ||
| Zeile 34: | Zeile 39: | ||
'''Absolut unwichtig''' für normale Benutzer, nur relevant für Vorlagen-Programmierer. Daher folgt reichlich technisches Vokabular! | '''Absolut unwichtig''' für normale Benutzer, nur relevant für Vorlagen-Programmierer. Daher folgt reichlich technisches Vokabular! | ||
| − | <includeonly> | + | Zuerst werden aus dem Artikel, in dem die Vorlage eingebunden ist, die Werte der Attribute [[Attribut:Sortierschlüssel|Sortierschlüssel]] bzw. [[Attribut:Kurzname|Kurzname]] ausgelesen. Dies geschieht mit den Abfragen ''<nowiki>{{#show: {{FULLPAGENAME}} | ?Sortierschlüssel }}</nowiki>'' und ''<nowiki>{{#show: {{FULLPAGENAME}} | ?Kurzname }}</nowiki>''. ''Sortierschlüssel'' oder ''Kurzname'' werden in verschiedenen [[Vorlagen]] automatisch gesetzt und dienen dazu, die Artikel in ebenfalls automatisch gesetzten Kategorien einzusortieren. Die ermittelten Werte werden in zwei Variablen namens ''SortierschlüsselAutomatisch'' und ''KurznameAutomatisch'' gespeichert. |
| + | |||
| + | Darauf aufbauend wird die Variable ''SortierschlüsselStandard'' über eine verschachtelte if-Anweisung definiert. Die Idee dahinter ist folgende: Falls einer der automatisierten Werte gesetzt ist, soll dieser zur Sortierung dienen, ansonsten der vollständige Seitenname (<nowiki>{{FULLPAGENAME}}</nowiki>). | ||
| + | Die Syntax "Falls Inhalt der Variable gleich leer dann Standardwert ansonsten Inhalt der Variable" ergibt damit "Falls Inhalt der Variable ''SortierschlüsselAutomatisch'' gleich leer dann (Falls Inhalt der Variable ''KurznameAutomatisch'' gleich leer dann Standardwert ''<nowiki>{{FULLPAGENAME}}</nowiki>'' ansonsten Inhalt der Variable ''KurznameAutomatisch'') ansonsten Inhalt der Variable ''SortierschlüsselAutomatisch''". | ||
| + | |||
| + | Im nächsten Schritt wird mit der Variable ''SortierschlüsselBerechnet'' der letztendliche Sortierschlüssel festgelegt. Falls die Vorlage den Parameter ''SortierschlüsselManuell'' verwendet und die entsprechende Variable im Artikel befüllt wurde, um die Sortierung manuell festzulegen, wird diese Angabe verwendet - ansonsten die soeben ermittelte Standardangabe. | ||
| + | |||
| + | Nun kommt die Kategorien-Angabe, um die es eigentlich geht. Für den Namen der Kategorie wird der Wert verwendet, der mit dem Parameter ''Kategorie'' in der Vorlage gesetzt wurde. Wurde nichts gesetzt, werden die Artikel automatisch in die [[:Kategorie:Überarbeiten]] einsortiert.[[Kategorie:Koschvorlage]]<includeonly> | ||
| − | ''Diese Dokumentation ist unter [[Vorlage:Kategorie-via-Vorlage/Doku]] hinterlegt.''</includeonly | + | ''Diese Dokumentation ist unter [[Vorlage:Kategorie-via-Vorlage/Doku]] hinterlegt.''</includeonly> |
Aktuelle Version vom 11. März 2022, 19:47 Uhr
Die ist die Dokumentation für die Vorlage:Kategorie-via-Vorlage. Sie wird dort ebenfalls angezeigt, weil die Dokumentation wie eine eigene Vorlage funktioniert und daher einfach eingebunden werden kann.
Was macht diese Vorlage?
Diese Vorlage kann in anderen Vorlagen verwendet werden, um durch deren Einbindung in Artikeln gleichzeitig eine Kategorie zu setzen.
Das Besondere dabei:
- Die Sortierung aus automatisierten Vorlagen wird übernommen.
- Artikel können anders einsortiert werden, falls beabsichtigt.
Das erspart manuelles Setzen von Kategorien, erhält jedoch deren Möglichkeiten ebenso wie die Vorteile automatisierter Vorlagen.
Wie verwendet man diese Vorlage?
Zur Einbindung in eine Vorlage muss folgenden Code eingefügt werden:
<includeonly>{{Kategorie-via-Vorlage|Kategorie=Überarbeiten|SortierschlüsselManuell={{{Sortierschlüssel|}}} }}</includeonly>
- Läßt man die Angabe <includeonly> </includeonly> weg, wird auch die Vorlage in die entsprechende Kategorie einsortiert.
- Es spielt keine Rolle, in welcher Reihenfolge man die Parameter angibt.
Parameter:
- Kategorie - Damit wird die Kategorie angegeben, die automatisch gesetzt werden soll.
- Der Text Überarbeiten ist nur ein Beispiel und muss durch den Namen der Kategorie ersetzt werden.
- SortierschlüsselManuell mit der Angabe {{{Sortierschlüssel|}}} - So kann der Artikel, welcher die Vorlage verwendet, ausdrücklich anders einsortiert werden.
- Beispiel: "Drakensang" soll in der Kategorie:Drakensang nicht unter "D" einsortiert werden, sondern ganz am Anfang, also wie üblich unter "!".
- Im Artikel wird die {{Navigationsleiste Drakensang}} daher so eingebunden: {{Navigationsleiste Drakensang|Sortierschlüssel=!}}.
- In der Vorlage, die diese Vorlage verwendet, kann für den Namen der Variable etwas anderes als "Sortierschlüssel" angegeben werden. Für die Endnutzer ist es jedoch leichter, einen einheitlichen Namen verwenden zu können.
- Entscheidend ist die Abfrage als Variable (durch {{{ |}}}) in der Vorlage. Sonst wird allen Artikeln, die die Vorlage verwenden, derselbe feste Sortierschlüssel zugeordnet!
Einsatzzweck
Wann immer es darum geht, eine Kategorie zusammen mit einer Vorlage zu setzen! Einige Ideen:
- Kandidaten sind Vorlagen aus den Kategorien Statische Navigation und Wiki-Element.
- Insbesondere für Navigationsvorlagen und Infokästen liegt es auf der Hand, wenn es für sie bereits eine Kategorie gibt.
Technische Dokumentation
Absolut unwichtig für normale Benutzer, nur relevant für Vorlagen-Programmierer. Daher folgt reichlich technisches Vokabular!
Zuerst werden aus dem Artikel, in dem die Vorlage eingebunden ist, die Werte der Attribute Sortierschlüssel bzw. Kurzname ausgelesen. Dies geschieht mit den Abfragen {{#show: {{FULLPAGENAME}} | ?Sortierschlüssel }} und {{#show: {{FULLPAGENAME}} | ?Kurzname }}. Sortierschlüssel oder Kurzname werden in verschiedenen Vorlagen automatisch gesetzt und dienen dazu, die Artikel in ebenfalls automatisch gesetzten Kategorien einzusortieren. Die ermittelten Werte werden in zwei Variablen namens SortierschlüsselAutomatisch und KurznameAutomatisch gespeichert.
Darauf aufbauend wird die Variable SortierschlüsselStandard über eine verschachtelte if-Anweisung definiert. Die Idee dahinter ist folgende: Falls einer der automatisierten Werte gesetzt ist, soll dieser zur Sortierung dienen, ansonsten der vollständige Seitenname ({{FULLPAGENAME}}). Die Syntax "Falls Inhalt der Variable gleich leer dann Standardwert ansonsten Inhalt der Variable" ergibt damit "Falls Inhalt der Variable SortierschlüsselAutomatisch gleich leer dann (Falls Inhalt der Variable KurznameAutomatisch gleich leer dann Standardwert {{FULLPAGENAME}} ansonsten Inhalt der Variable KurznameAutomatisch) ansonsten Inhalt der Variable SortierschlüsselAutomatisch".
Im nächsten Schritt wird mit der Variable SortierschlüsselBerechnet der letztendliche Sortierschlüssel festgelegt. Falls die Vorlage den Parameter SortierschlüsselManuell verwendet und die entsprechende Variable im Artikel befüllt wurde, um die Sortierung manuell festzulegen, wird diese Angabe verwendet - ansonsten die soeben ermittelte Standardangabe.
Nun kommt die Kategorien-Angabe, um die es eigentlich geht. Für den Namen der Kategorie wird der Wert verwendet, der mit dem Parameter Kategorie in der Vorlage gesetzt wurde. Wurde nichts gesetzt, werden die Artikel automatisch in die Kategorie:Überarbeiten einsortiert.