Modul:FormatNum/Doku: Unterschied zwischen den Versionen

← Zum vorherigen Versionsunterschied

Modul:FormatNum/Doku (Quelltext anzeigen)

Version vom 6. November 2021, 09:39 Uhr

3.689 Bytes hinzugefügt , 6. November 2021

+

InkluPedia.de - Frank Küster

62.889

Bearbeitungen

@@ 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]]