Modul:FormatNum/Doku: Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
(+) |
||
Zeile 1: | Zeile 1: | ||
<onlyinclude>{{LuaModuleDoc}}</onlyinclude> | <onlyinclude>Dieses [[Hilfe:Glossar#Modul|Modul]] bietet Funktionen zu Rundung und Formatierung von Zahlen. | ||
== Funktionen == | |||
=== format === | |||
Formatiert eine Gleitkomma- oder Ganzzahl entsprechend dem angegebenen Format. Als Eingabe sind alle Zahlen geeignet, welche den Punkt als Dezimaltrennzeichen verwenden, keine Tausendertrennzeichen haben, nicht in Exponentialschreibweise vorliegen und nur ASCII-Zeichen enthalten. | |||
''Parameter'' | |||
;1 | |||
:(Pflicht) Unformatierte Gleitkomma- oder Ganzzahl | |||
;2 | |||
:(Optional) Als Formatierungsoptionen stehen <code>at</code>, <code>ch</code>, <code>ch_currency</code>, <code>comma</code>, <code>de</code>, <code>dewiki</code>, <code>de_currency</code>, <code>en</code>, <code>iso31_0</code>, <code>iso31_0_point</code> und <code>pc</code> zur Verfügung. | |||
''Rückgabewert'' | |||
:Formatierte Zahl. Bei Fehler wird '''1''' unverändert zurückgegeben. | |||
=== minus === | |||
Ersetzt das Unicode-Minuszeichen U+2212 = 8722<sub>10</sub> durch den ASCII]-Bindestrich U+002D. Das geht auch umgekehrt. | |||
''Parameter'' | |||
;1 | |||
:(Pflicht) Zahl | |||
;2 | |||
:(Optional) Umwandlung in U+002D. Vorgabe: <code>0</code> = →ASCII (boolesch) | |||
''Rückgabewert'' | |||
:Zahl mit ASCII-Bindestrich statt Unicode-Minuszeichen (oder umgekehrt) | |||
=== padding === | |||
Füllt eine Zahl links- oder rechts mit nicht-kopierbarem Weißraum/Freiraum auf. Die Zahl wird links oder rechts bis zum Dezimaltrennzeichen so aufgefüllt, dass alle Zahlen untereinander das Dezimaltrennzeichen an der gleichen Position haben, falls die Ausdehnung des Weißraums geeignet gewählt wurde. | |||
''Parameter'' | |||
;1 | |||
:(Pflicht) Zahl | |||
;2 | |||
:(Pflicht) Ausdehnung des Weißraums. Dabei geben Zahlen größer Null die erwarteten Nachkommastellen an. Sind weniger Stellen vorhanden, wird rechts mit Weißraum aufgefüllt. Bei Ausdehnung kleiner Null werden Zahlen, die weniger Zeichen vor dem Dezimaltrennzeichen haben, links mit Weißraum aufgefüllt. | |||
;3 | |||
:(Pflicht) Dezimaltrennzeichen | |||
''Rückgabewert'' | |||
:Ggf. adjustierte Zahl | |||
=== roman2number === | |||
Wandelt eine römische Zahl in eine numerische Ganzzahl um. | |||
''Parameter'' | |||
;1 | |||
:(Pflicht) Römische Zahl | |||
;2 | |||
:(Optional) Lua-Pattern für erlaubten Suffix. Beispiel: <code>%.$</code> fordert einen Ordinalpunkt nach der römischen Zahl | |||
''Rückgabewert'' | |||
:Positive Ganzzahl, wenn nicht erfolgreich ''leer'' | |||
=== round === | |||
Ermöglicht die Rundung von Zahlen. Die Ausgabe ist eine Zeichenkette mit der entsprechenden Anzahl signifikanter Stellen. Zur Eingabe sind alle Zahlen geeignet, die sich mit der Lua-Methode <code>tonumber()</code> parsen lassen. | |||
''Parameter'' | |||
;1 | |||
:(Pflicht) Gleitkomma- oder Ganzzahl (Punkt als Dezimaltrennzeichen, keine Tausendertrennzeichen, ASCII-Minuszeichen) | |||
;2 | |||
:(Pflicht) Ganze Zahl, welche die Anzahl signifikanter Stellen angibt. | |||
;method | |||
:(Optional) Zahl, gibt die zu verwendende Rundungsmethode an: <code>0</code> = Rundung nach IEEE 754 (round half to even) / <code>1</code> = Kaufmännisches Runden inklusive Eliminierung von "-0"-Ergebnissen. Vorgabe: <code>0</code> | |||
;format | |||
:Formatierung mittels <code>[[#format|format]]</code> auslösen. Der Wert ist die Formatierungsmethode. | |||
;padding | |||
:(Optional) Formatierung mittels <code>[[#format|format]]</code> und <code>[[#padding|padding]]</code> auslösen. Der Wert ist die Ausdehnung des Weißraums. | |||
''Rückgabewert'' | |||
:Zeichenkette der gerundeten Zahl in PC-kompatibler Schreibweise ohne Formatierung. Diese kann mit mittels <code>[[#format|format]]</code> formatiert werden, oder durch <code>format=</code> bzw. <code>padding=</code> ausgelöst werden. | |||
=== failsafe === | |||
Gibt die Versionsbezeichnung des Moduls aus. | |||
Die Failsafe-Schnittstelle ist bei globalen Vorlagen und Modulen nützlich, wie sie in [[Wikipedia]] verwendet werden. | |||
{{LuaModuleDoc}}</onlyinclude> | |||
[[Kategorie:Vorlage:nur Dokumentation]] | [[Kategorie:Vorlage:nur Dokumentation]] |
Aktuelle Version vom 6. November 2021, 08:39 Uhr
Dieses Modul bietet Funktionen zu Rundung und Formatierung von Zahlen.
Funktionen
format
Formatiert eine Gleitkomma- oder Ganzzahl entsprechend dem angegebenen Format. Als Eingabe sind alle Zahlen geeignet, welche den Punkt als Dezimaltrennzeichen verwenden, keine Tausendertrennzeichen haben, nicht in Exponentialschreibweise vorliegen und nur ASCII-Zeichen enthalten.
Parameter
- 1
- (Pflicht) Unformatierte Gleitkomma- oder Ganzzahl
- 2
- (Optional) Als Formatierungsoptionen stehen
at
,ch
,ch_currency
,comma
,de
,dewiki
,de_currency
,en
,iso31_0
,iso31_0_point
undpc
zur Verfügung.
Rückgabewert
- Formatierte Zahl. Bei Fehler wird 1 unverändert zurückgegeben.
minus
Ersetzt das Unicode-Minuszeichen U+2212 = 872210 durch den ASCII]-Bindestrich U+002D. Das geht auch umgekehrt.
Parameter
- 1
- (Pflicht) Zahl
- 2
- (Optional) Umwandlung in U+002D. Vorgabe:
0
= →ASCII (boolesch)
Rückgabewert
- Zahl mit ASCII-Bindestrich statt Unicode-Minuszeichen (oder umgekehrt)
padding
Füllt eine Zahl links- oder rechts mit nicht-kopierbarem Weißraum/Freiraum auf. Die Zahl wird links oder rechts bis zum Dezimaltrennzeichen so aufgefüllt, dass alle Zahlen untereinander das Dezimaltrennzeichen an der gleichen Position haben, falls die Ausdehnung des Weißraums geeignet gewählt wurde.
Parameter
- 1
- (Pflicht) Zahl
- 2
- (Pflicht) Ausdehnung des Weißraums. Dabei geben Zahlen größer Null die erwarteten Nachkommastellen an. Sind weniger Stellen vorhanden, wird rechts mit Weißraum aufgefüllt. Bei Ausdehnung kleiner Null werden Zahlen, die weniger Zeichen vor dem Dezimaltrennzeichen haben, links mit Weißraum aufgefüllt.
- 3
- (Pflicht) Dezimaltrennzeichen
Rückgabewert
- Ggf. adjustierte Zahl
roman2number
Wandelt eine römische Zahl in eine numerische Ganzzahl um.
Parameter
- 1
- (Pflicht) Römische Zahl
- 2
- (Optional) Lua-Pattern für erlaubten Suffix. Beispiel:
%.$
fordert einen Ordinalpunkt nach der römischen Zahl
Rückgabewert
- Positive Ganzzahl, wenn nicht erfolgreich leer
round
Ermöglicht die Rundung von Zahlen. Die Ausgabe ist eine Zeichenkette mit der entsprechenden Anzahl signifikanter Stellen. Zur Eingabe sind alle Zahlen geeignet, die sich mit der Lua-Methode tonumber()
parsen lassen.
Parameter
- 1
- (Pflicht) Gleitkomma- oder Ganzzahl (Punkt als Dezimaltrennzeichen, keine Tausendertrennzeichen, ASCII-Minuszeichen)
- 2
- (Pflicht) Ganze Zahl, welche die Anzahl signifikanter Stellen angibt.
- method
- (Optional) Zahl, gibt die zu verwendende Rundungsmethode an:
0
= Rundung nach IEEE 754 (round half to even) /1
= Kaufmännisches Runden inklusive Eliminierung von "-0"-Ergebnissen. Vorgabe:0
- format
- Formatierung mittels
format
auslösen. Der Wert ist die Formatierungsmethode. - padding
- (Optional) Formatierung mittels
format
undpadding
auslösen. Der Wert ist die Ausdehnung des Weißraums.
Rückgabewert
- Zeichenkette der gerundeten Zahl in PC-kompatibler Schreibweise ohne Formatierung. Diese kann mit mittels
format
formatiert werden, oder durchformat=
bzw.padding=
ausgelöst werden.
failsafe
Gibt die Versionsbezeichnung des Moduls aus.
Die Failsafe-Schnittstelle ist bei globalen Vorlagen und Modulen nützlich, wie sie in Wikipedia verwendet werden.
- Dieses Modul enthält Code in der Programmiersprache Lua.
- Module werden über
#invoke
in Vorlagen eingebunden. - Dieses Modul wird über Vorlagen auf folgenden Seiten verwendet: Seiten anzeigen