Vorlage:ISO 3166-2/Doku
Dies ist eine nachgeordnete Seite der Dokumentation von Vorlage:ISO 3166-2. Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Vorlage-Seite ist. |
Diese Vorlage sollte nicht ersetzt werden. |
Diese Vorlage benutzt Modul:ISO 3166-2, Skripte geschrieben in der Programmiersprache Lua. Bitte informiere dich dort, wenn du mehr über die Sprache und ihren Einsatz erfahren willst. Diese Vorlagen sollte im Regelfall nicht ersetzt werden. |
Vorlagen und Funktionen
[Bearbeiten]Die Funktion {{ISO 3166-2/Doku}}
und ihre Verwandten kümmert sich um die Verarbeitungen von Regionennamen nach der ISO-3166-2-Kodierung. Sie geben Regionennamen zu ISO-Codes aus und umgekehrt. Auch ein Übersetzen von Regionennamen ist damit möglich. Diese Hilfsmittel richten sich vornehmlich an Vorlagenprogrammierer zur automatisierten Dokumentation anderer Module und Vorlagen (Lagekarten, Imagemaps usw...) sowie für die automatische Einbindung von Karten, Grafiken, Bildern in Quickbars und Tabellen.
Voraussetzungen
[Bearbeiten]Damit die Vorlagen die gewünschten Ergebnisse liefern, muss die entsprechende Provinzliste für das gewünschte Land verfügbar sein. Sie sollte in Form eines Sub-Moduls mit der Namenkonvention Modul:ISO 3166-2/<Landes-TLD>
zur Verfügung stehen. Hier zwei Muster:
- Landesliste Georgien: Modul:ISO 3166-2/ge
- Landesliste Japan: Modul:ISO 3166-2/jp
Der Aufbau der Listen ist für eine Neuerstellung mit etwas Aufwand verbunden. Der einfachste Weg ist ein guter Texteditor wie zum Beispiel Notepad++ der über gute Ersetzen-Funktionalitäten und einen Makrorekorder verfügt. Als Basis kann man die in der Wikipedia verfügbaren Listen nutzen und den Artikeltext oder das Wiki-Markup per Ersetzen oder aufgezeichnetem Makro umschreiben.
Verwendung
[Bearbeiten]{{ISO 3166-2|tld=<Landeskennung>|region=<Regionenbezeichnung>|von=<von Sprache bzw. Code>|nach=<nach Sprache bzw. Code>}}
– Die allgemeine Funktion liefert den Namen einer Region in gewünschter Sprache zu einem ISO-Code und umgedreht. Auch die Übersetzung von einer Sprache in eine andere ist möglich.{{ISO 3166-2|tld=ge|region=ge-ab|von=ISO3166-2|nach=de}}
liefert: Abchasien{{ISO 3166-2|tld=ge|region=ge-ab|von=ISO3166-2|nach=en}}
liefert: Abkhazia{{ISO 3166-2|tld=ge|region=Abchasien|von=de|nach=en}}
liefert: Abkhazia
{{ISO 3166-2 nach DE|<ISO 3166-2-Code>}}
– Liefert den deutschen Namen einer Region bei gegebenem ISO-Code{{ISO 3166-2 nach DE|ge-ab}}
ergibt: Abchasien
{{ISO 3166-2 nach EN|<ISO 3166-2-Code>}}
– Liefert den englischen Namen einer Region bei gegebenem ISO-Code{{ISO 3166-2 nach EN|ge-ab}}
ergibt: Abkhazia
{{BASEPAGENAME/EN}}
– Liefert den englischen Namen des Region, in deren Artikel die Vorlage eingebunden ist.{{BASEPAGENAMEX/EN}}
– Liefert ebenfalls den englischen Namen des Region, in deren Artikel die Vorlage eingebunden ist. Allerdings wird vorher der Wegweiserhinweis aus dem Artikelnamen entfernt.- Im Artikel zu Malakka (Bundesstaat) liefert {{BASEPAGENAME/EN}} einen Fehler, {{BASEPAGENAMEX/EN}} das korrekte Melacca, da der Klammerausdruck ignoriert wird. In Anlehnung and die Magischen Wörter wurde die Vorlage komplett großgeschrieben.
{{Landesbezeichnung|sprache=Sprachcode|tld=Top-Level-Domain}}
– Sie ist eigentlich für Länder gedacht, funktioniert aber auch auf regionaler Ebene. Statt der Top-Level-Domain kann man ihr auch einen Provinzcode übergeben.
Anwendungsfälle
[Bearbeiten]Wie bereits angedeutet, helfen diese Vorlagen hauptsächlich den Vorlagenprogrammierern. Hier soll etwas Arbeit erleichtert und Vorlagencode vereinheitlicht und vereinfacht werden. Sie sind keine Allzweckwaffe und werden auch in einigen Fällen versagen. In den meisten Fällen jedoch können sie helfen. Die Landescodelisten sollten pragmatisch angelegt werden und die Vorlagen sollen ihre Aufgabe erfüllen. Auch wenn beispielsweise der englische Name nicht korrekt geschrieben ist, solange der gewünschte Karte von Commons geliefert wird, ist der Zweck erfüllt.
- Die Vorlagen können bei der einfachen Dokumentation von Modulen und Vorlagen helfen. Module für z.B. Lagekarten und Imagemaps sind meistens unter dem Landes- bzw. Regionenkürzel abgelegt. So ist nur eine Vorlage für die Dokumentation notwendig, da die Namen automatisch eingesetzt werden.
- Dateinamen für sind auf Commons sind im Regelfall englisch. Wer für Regionen in der Quickbar oder in Tabellen und Übersichten automatisch Karte oder andere Dateien einbinden will, kann auf diese Regionsvorlagen zurückgreifen. Beispielsweise nutzt dies die {{Quickbar Präfektur Japan}}. Der Code
| Lagekarte= File:{{BASEPAGENAMEX/EN|jp}} in Japan.svg | Imagemap= jp präfekturen
in der Quickbar holt sich immer die passende Lagekarte in dem Regionsartikel. Es wird der Klammerausdruck (z.B. bei Tokio (Präfektur)) entfernt und die passende Karte Tokyo in Japan.svg mit dem englischen Namen eingebunden.
Ergänzung weiterer Sprachen
[Bearbeiten]Die Vorlagen können weitere Sprachen liefern. Hierzu ist keine Erweiterung der Modul- oder Vorlagenfunktionalitäten erforderlich. Lediglich die Landeslisten müssen um die gewünschte Sprache erweitert werden. Soll zum Beispiel die japanische Liste um die japanischen Namen ergänzt werden, geht man wie folgt vor:
Aus { ['ISO3166-2'] = 'JP-01', ['de'] = 'Hokkaidō', ['en'] = 'Hokkaido' }
wird { ['ISO3166-2'] = 'JP-01', ['de'] = 'Hokkaidō', ['en'] = 'Hokkaido', ['ja'] = '北海道' }
Hinweis: Achte auf die Unterscheidung von Landes- und Sprachcode. Japan als Land hat jp, japanisch als Sprache hat ja.
Jetzt liefert {{ISO 3166-2|tld=jp|region=JP-01|von=ISO3166-2|nach=ja}}
den Text: 北海道
Abgeleitete Vorlagen
[Bearbeiten]Wird eine Umsetzung oft benötigt, kann man von dieser Vorlage weitere Vorlagen ableiten. Wird z.B. eine Ausgabe der japanischen Präfekturnamen bei gegebenem Regionencode ständig gebraucht, kann dies eine abgeleitete Vorlage erledigen. Man legt eine Vorlage mit dem Namen {{ISO 3166-2/jp/iso-ja}}
an. Diese ruft intern dieses Vorlage in der im obigen Abschnitt geschriebenen Form auf. Dann liefert {{ISO 3166-2/jp/iso-ja|JP-01}}
den Text: 北海道. Um eine Einheitlichkeit zu wahren, sollten die Namen der Vorlagen der gerade beschriebenen Variante folgen: {{ISO 3166-2/<Landeskürzel>/<von>-<nach>}}