Modul:Währung/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Modul:Währung.
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 Währung/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 den Umgang mit Währungen.

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 Währung 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 Währung.

Funktionen

Folgende Funktionen können im Artikeltext und Vorlagen benutzt werden.

`getCurrencyNameByCode`

Die Funktion gibt den Namen einer Währung bei gegebenem ISO-4217-Währungscode zurück.

|code= – ISO-4217-Währungscode

`getCurrencyOfCountryWithCode`

Die Funktion gibt den Namen und ISO-4217-Währungscode eines Landes in der Form „<Währung> (<ISO-4217>)“ zurück. Ist das Land unbekannt oder keine Währungsinfo verfügbar, wird der Artikel in der Wartungskategorie Artikel ohne Währung auf Wikidata einsortiert. Die Daten werrden nicht direkt von Wikidata bezogen sondern sind im Modul Währung/Länder abgelegt, welches unter Umständen aktualisiert werden muss.

|id= – Wikidata-ID des Landes

`getCurrencyNameOfCountry`

Die Funktion gibt den Namen der Währung eines Landes. Ist das Land unbekannt oder keine Währungsinfo verfügbar, wird der Artikel in der Wartungskategorie Artikel ohne Währung auf Wikidata einsortiert. Die Daten werrden nicht direkt von Wikidata bezogen sondern sind im Modul Währung/Länder abgelegt, welches unter Umständen aktualisiert werden muss.

|id= – Wikidata-ID des Landes

`getCurrencyCodeOfCountry`

Die Funktion gibt den ISO-4217-Währungscode eines Landes zurück. Ist das Land unbekannt oder keine Währungsinfo verfügbar, wird der Artikel in der Wartungskategorie Artikel ohne Währung auf Wikidata einsortiert. Die Daten werrden nicht direkt von Wikidata bezogen sondern sind im Modul Währung/Länder abgelegt, welches unter Umständen aktualisiert werden muss.

|id= – Wikidata-ID des Landes

Submodule

Modul:Währung/Params – enthält ein mehrdimensionales Array mit allen erlaubten Parametern für jede Funktion/Vorlage und ihre Standardbelegung.
Modul:Währung/Länder – Liste der Länder mit ihren Währungen

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: Check2 • ISO 4217