Modul:Exchange rate/Doku

Hinweis: Seit dem 24. Februar 2023 werden die Wechselkurse auf Wikimedia Commons nicht mehr aktualisiert.

Versionsbezeichnung auf Wikidata: 2024-02-24

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: CountryData/Currencies

Verwendung in anderen Modulen

Dieses Modul ist notwendig für die Ausführung folgender Module. Bei Anpassungen sollte die Funktionstüchtigkeit der folgenden Module geprüft werden. Benutze dazu auch diese Tracking-Kategorie um Fehler zu finden, die sich dann auf Artikel auswirken:

• vCard
• Modul benötigt das Modul Exchange rate – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.

Häufig genutzte Variablen

• amount: string Wert oder Wertebereich eines Geldbetrages,
• source: string dreistelliger ISO-4217-Code der Ursprungswährung,
• target: string dreistelliger ISO-4217-Code der Zielwährung,
• frame: table Parametertabelle, die durch einen #invoke-Aufruf übergeben wird.

Extern nutzbare Funktionen

function er.getRate( source, target, toRound )

Die Funktion liefert drei Werte zurück: rate, asOf, digitCount.

• Vorgabe:
  • toRound: boolean. Falls true wird rate nur mit maximal signifikanten Stellen ausgegeben.

• Ergebnis:
  • rate: number. Wechselkurs für die Umrechnung aus Ursprungs- in die Zielwährung.
  • asOf: string. Datumsangabe für den Wechselkurs in der Form YYYY-MM-DD.
  • digitCount: number: Anzahl signifikanter Stellen für den Wechselkurs.

function er.getWrapper( amount, source, target, digits, externalFormatter )

Die Funktion liefert eine Formatierungszeichenkette für ein span-Tag, wobei öffnendes und schließendes Tag den %s-Platzhalter umschließen. Das title-Attribut des Tags enthält den umgerechneten Betrag in mehreren Währungen (üblicherweise EUR, CHF und USD), das class-Attribut zwei Werte, nämlich voy-currency und voy-currency-xxx, wobei xxx den ISO-4217-Code der Ursprungswährung in Kleinbuchstaben darstellen.

• Vorgabe:
  • digits: number. Anzahl der Nachkommastellen der umgerechneten Beträge. Standard ist 2.
  • externalFormatter: function. Externe Funktion, die eine Formatierungszeichenkette für das Einfügen eines Betrages zurückliefert. Sie stellt einen Ersatz für die lokale Funktion getFormatter dar, um den Zugriff auf das externe Modul mit den Währungscodes zu vermeiden.

• Ergebnis:
  • string: Formatierungszeichenkette.

function er.rate( frame )

Die Funktion liefert den Wechselkurs für die Umrechnung aus Ursprungs- in die Zielwährung in wählbaren Formaten zur Verfügung.

• Vorgabe:
  • args.source, args.target, args.show und args.digits.
  • args.show: date: nur Datum des Wechselkurses, all: Wechselkurs mit Datum in Klammern.
  • args.digits: maximale Anzahl der Nachkommastellen.

• Ergebnis:
  • string: Formatierungszeichenkette.

function er.convert( frame )

function er.currencyWithConversions( frame )

Lokale Funktionen

local function getFormatter( isoCode, externalFormatter )

local function getDigitCount( num )

local function round( num, digitCount )

local function getFields( tabularData )

local function getRateTable( tableName )

local function getCurrencyData( rateTable, source, target )

local function getDate( aDate, formatStr )

local function insertThousandsSep( amount )

local function formatNumber( num )

local function addUnit( amount, isoCode, externalFormatter )

local function formatRate( rate, asOf, show, digits, target )

local function convertSingle( source, target, amount, digits )

function er._convert( source, targets, amount, withUnit, digits, externalFormatter )