Modul:Landesbezeichnung/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Modul:Landesbezeichnung.
Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Modul-Seite ist.

Dieses Modul ist getestet und für den projektweiten Gebrauch geeignet. Es kann in Vorlagen benutzt und auf Hilfeseiten erläutert werden. Entwicklungen an dem Modul sollten auf Landesbezeichnung/Test und die Anwendung auf der Spielwiese getestet werden, da wiederholte Trial-and-Error-Edits die Resourcen stark belasten können.

Dieses Modul enthält Funktionen für Vorlagen die Landesbezeichnungen verwenden. Man kann die Landesbezeichnungen einfach ausgeben oder sich für die Weiterverarbeitung in anderen Vorlagen und Modulen erzeugen lassen, um z.B. standardisierte Datei-, Artikel- und Kategoriennamen auf Wikivoyage oder Commons zu generieren.

Die Funktionen holen sich die Argumente aus der Vorlage und müssen beim Modulaufruf nicht nochmals übergeben werden. Vergessene Parameter werden mit Standardwerten belegt, unbekannte Parameter werden als Fehlermeldung zusätzlich mit im Artikel ausgegeben.

Allgemein gültige Parameter

Die allgemein gültigen Parameter kann man sowohl innerhalb der Vorlage in der Parserfunktion invoke benutzen, als auch innerhalb des Artikels der Vorlage selbst übergeben. Der Paramter, der bei der Einbindung der Vorlage benutzt wird, hat dabei Vorrang. So kann man bestimmte Funktionalitäten für den generellen Gebrauch der Vorlage aktivieren (über invoke) und im Einzelfall im Artikel abschalten (bei der Verwendung der Vorlage).

|ignore_errors= auf 1 oder true gesetzt, werden die Ausgabe der Fehlermeldungen der Funktionen unterdrückt. Standardmäßig werden die Fehler angezeigt.
|no_category= auf 1 oder true gesetzt, werden die Artikel bei Fehlermeldungen des Moduls einer Fehlerkategorie zugeordnet. Standardmäßig werden Fehlermeldungen in die Kategorie Fehlerberichte des Moduls Landesbezeichnung eingefügt. Wurden unbekannte Parameter verwendet landen die Artikel zusätzlich in der Kategorie Vorlagen mit unbekannten Parametern.
|error_category= gibt den Namen einer Fehlerkategorie an, in der der Artikel bei auftretenden Fehlern einsortiert wird. Standardmäßig ist das Fehlerberichte des Moduls Landesbezeichnung.

Submodule

Modul:Landesbezeichnung/Params – enthält ein mehrdimensionales Array mit allen erlaubten Parametern für jede Funktion/Vorlage und ihre Standardbelegung.
Modul:Landesbezeichnung/de, Modul:Landesbezeichnung/en – Sie enthalten die Namen der Länder in den Landessprachen.

Funktionen

`nameTLD`

Die Funktion gibt den Landesnamen zu einer Top-Level-Domain aus. Sie erwartet von der aufrufenden Vorlage folgende Parameter:

|sprache= Sprachcode für die Sprache, in der die Landesbezeichnungen ausgegeben werden (Standard: de)
|tld= Top-Level-Domain des Landes

Vorlagen

Syntax: {{Landesbezeichnung|sprache=Sprachcode|tld=Top-Level-Domain}}
Lua-Funktion: p.nameTLD

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: Check2