Quelltext der Seite Modul:Exchange rate/doc

{{DU}}

{{Modulversion}}

{{Benötigt Submodule|CountryData/Currencies}}
{{Modul wird benötigt von|vCard}}

== Häufig genutzte Variablen ==

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

== Extern nutzbare Funktionen ==

<syntaxhighlight lang="lua">function er.getRate( source, target, toRound )</syntaxhighlight>

Die Funktion liefert drei Werte zurück: <code>rate</code>, <code>asOf</code>, <code>digitCount</code>.

* Vorgabe:
** <code>toRound</code>: <code>boolean</code>. Falls <code>true</code> wird <code>rate</code> nur mit maximal signifikanten Stellen ausgegeben.

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

<syntaxhighlight lang="lua">function er.getWrapper( amount, source, target, digits, externalFormatter )</syntaxhighlight>

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

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

* Ergebnis:
** <code>string</code>: Formatierungszeichenkette.

<syntaxhighlight lang="lua">function er.rate( frame )</syntaxhighlight>

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

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

* Ergebnis:
** <code>string</code>: Formatierungszeichenkette.

<syntaxhighlight lang="lua">function er.convert( frame )</syntaxhighlight>

<syntaxhighlight lang="lua">function er.currencyWithConversions( frame )</syntaxhighlight>

== Lokale Funktionen ==

<syntaxhighlight lang="lua">local function getFormatter( isoCode, externalFormatter )</syntaxhighlight>

<syntaxhighlight lang="lua">local function getDigitCount( num )</syntaxhighlight>

<syntaxhighlight lang="lua">local function round( num, digitCount )</syntaxhighlight>

<syntaxhighlight lang="lua">local function getFields( tabularData )</syntaxhighlight>

<syntaxhighlight lang="lua">local function getRateTable( tableName )</syntaxhighlight>

<syntaxhighlight lang="lua">local function getCurrencyData( rateTable, source, target )</syntaxhighlight>

<syntaxhighlight lang="lua">local function getDate( aDate, formatStr )</syntaxhighlight>

<syntaxhighlight lang="lua">local function insertThousandsSep( amount )</syntaxhighlight>

<syntaxhighlight lang="lua">local function formatNumber( num )</syntaxhighlight>

<syntaxhighlight lang="lua">local function addUnit( amount, isoCode, externalFormatter )</syntaxhighlight>

<syntaxhighlight lang="lua">local function formatRate( rate, asOf, show, digits, target )</syntaxhighlight>

<syntaxhighlight lang="lua">local function convertSingle( source, target, amount, digits )</syntaxhighlight>

<syntaxhighlight lang="lua">function er._convert( source, targets, amount, withUnit, digits, externalFormatter )</syntaxhighlight>

<includeonly>[[Kategorie:Vorlagen:Währungen]]<includeonly>