Wikipedia:Lua/Modul/Vorlage:Währungsbetrag/de

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

FormatCash – Modul zur Formatierung eines Währungsbetrags.

Funktionen für Vorlagen

[Quelltext bearbeiten]
f
Formatierung in der deutschsprachigen Wikipedia.
Das Ergebnis ist eine formatierte Zahl oder eine Fehlermeldung.
Parameter der umgebenden Vorlageneinbindung (bis auf den Betrag alle optional):
1
Betrag, computergerechte Darstellung (ohne Tausendertrennzeichen); Pflichtangabe
n
Anzahl der Nachkommastellen (0)
dewiki
Format der deutschsprachigen Wikipedia; boolesch (1: ja)
CH
Schweizer Format; boolesch (0)
$u
Währungseinheit; wird umbruchgeschützt vorangestellt
u$
Währungseinheit; wird umbruchgeschützt nachgestellt
style
CSS-Dekoration
style-
CSS-Dekoration bei negativen Werten
class-
Klasse bei negativen Werten
error
HTML-Fehlermeldung, ggf. mit Wartungskategorie
failsafe
Versionsverwaltung

Die Failsafe-Schnittstelle erlaubt den damit ausgerüsteten Modulen in globaler Verteilung

  • sicherzustellen, dass eine von einer Vorlage oder einem Modul benötigte Funktion in der lokalen Kopie eines Bibliotheksmoduls vorhanden ist, und ggf. auch in einer erforderlichen Mindestversion;
  • die globale Aktualisierung und Verknüpfung von Modulen über Wikidata zu verwalten.

Die Failsafe-Schnittstelle liegt sowohl auf Ebene der Vorlagen wie auch in direktem Lua-Zugriff vor.

Die Funktionen sind im Einzelnen (nicht alle werden bereits überall in vollem Umfang unterstützt):

Parameter
Wert Ergebnis aktuell
nichts
false
lokale Version »2020-08-06«
Mindest­version Mindestversionsbezeichnung
Datum im ISO-Format

Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.

  • leer, falls Mindestversion nicht erfüllt
  • 2001-01-01 → »2020-08-06«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2020-08-06«
~ Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
  • leer, falls aktuell
  • Versionsbezeichnung auf Wikidata, falls ungleich
»«
@ Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
  • leer, falls mit dem richtigen Item verknüpft
  • Item-ID, falls nicht
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Beispiele (Testseite)

[Quelltext bearbeiten]

Eine Testseite illustriert praktische Beispiele.

Funktionen für Lua-Module

[Quelltext bearbeiten]

Alle oben dokumentierten Funktionen können auch über require() in andere Module eingebunden werden:

local lucky, FormatCash = pcall( require, "Module:FormatCash" )
if type( FormatCash ) == "table" then
    FormatCash = FormatCash.FormatCash()
else
    -- Fehlerfall; FormatCash enthält Fehlermeldung
    return "<span class=\"error\">" .. FormatCash .. "</span>"
end

Danach stehen zur Verfügung:

FormatCash.f( args )
  • argstable mit den Parametern wie für Vorlagen
    • money
      Betrag, computergerechte Darstellung (ohne Tausendertrennzeichen); Pflichtangabe
      n
      Anzahl der Nachkommastellen (0)
      schema
      Format in FormatNum
      pre
      Währungseinheit; wird umbruchgeschützt vorangestellt
      post
      Währungseinheit; wird umbruchgeschützt nachgestellt
      style
      CSS-Dekoration
      styleM
      CSS-Dekoration bei negativen Werten
      classM
      Klasse bei negativen Werten
      error
      HTML-Fehlermeldung, ggf. mit Wartungskategorie
    • Numerische Werte können als number oder als string angegeben werden.
Rückgabewert ist ein string; im Fehlerfall auch eine HTML-formatierte Fehlermeldung usw.
FormatCash.failsafe( atleast )
  • atleast – (optional) string mit der Abfrage
Rückgabewert ist ggf. boolean oder ein string

Abhängigkeiten

[Quelltext bearbeiten]

Die erste Version kombiniert eine Unterstützung der Vorlage:Währungsbetrag mit einem davon unabhängigem, global einsetzbarem Module:FormatCash und wäre bei Bedarf aufzutrennen bzw. die Versorgung der Vorlage anders zu lösen.