Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | ||
Modul | Deutsch
|
Modul: | Dokumentation |
Zitation
– Lua-Modul mit Funktionen für Ausgabe von Quellenangaben und sonstigen Zitationen in der deutschsprachigen Wikipedia.
Funktionen für Vorlagen
BearbeitenDas Modul ist primär zum Aufruf als Lua-Bibliothek vorgesehen. Aus Wiki-Seiten und Vorlagen heraus soll es in der Regel nicht eingebunden sein.
Endpunkt
BearbeitenGibt eine Zeichenkette im Format eines Titel dar, das heißt, die Zeichenkette wird kursiv dargestellt und bei Bedarf um einen abschließenden Punkt ergänzt.
- titel
- eine beliebige Zeichenkette
Temporäre Unterstützung der Vorlage:Internetquelle.
TitelFormat
BearbeitenGibt eine Zeichenkette im Format eines Titel dar, das heißt, die Zeichenkette wird kursiv dargestellt und bei Bedarf um einen abschließenden Punkt ergänzt.
- titel
- eine beliebige Zeichenkette
Temporäre Unterstützung der Vorlage:Internetquelle.
COinS_Template
BearbeitenUnterstützung der Vorlage:COinS.
- Alle Parameter werden als
&rft.
dem Ergebnis hinzugefügt.
Rückgabe ist ein <span>
für COinS.
failsafe
BearbeitenVersionsbezeichnung des Moduls: 2021-05-25
Verwendung
Bearbeiten- Modul/Vorlage:Literatur
- Vorlage:Internetquelle (Migration).
Funktionen für Lua-Module
BearbeitenNach der üblichen Anbindung als table Zitation
stehen zur Verfügung:
- Zitation.fault(a, always)
- Formatiere Fehler mit class=error; teils ausgeblendet
a
– string, mit Fehlermeldungalways
–true
, wenn nicht zu unterdrücken
- Rückgabewert: string, mit HTML-Element
- Zitation.fetch(assigned, acquire)
- Binde Modul ein
assigned
– string, mit Nameacquire
– string, mit abweichendem Modulnamen, oderfalse
- Rückgabewert: initialisierte table des Moduls
error
– Modul nicht gefunden- Zitation.figure(adjust)
- Bilde Zahlenwert
adjust
– Wert beliebigen Typs
- Rückgabewert: Numerischer Wert, notfalls
0
- Zitation.fill(area, access, assign, alias)
- Parameterkomponente zuweisen
area
– string, mit Name der Parametergruppeaccess
– string, mit Name der Komponenteassign
– Parameterwert; nicht leeralias
– string, mit Name des Benutzerparameters, odernil
- Zitation.filler(args, assign)
- Parameterkomponenten zuweisen
args
–Zfilter.object
, mit Zuweisungen nach Vorlagenparameternameassign
– table, mit Transformation in neutrales Datenmodell
- Zitation.filter(args, allowed)
- Analysiere Argumentenliste und gleiche mit erlaubten Namen ab
args
– table, mit aktuellen Wertenallowed
– table, mit erlaubten Namen
- Rückgabewerte:
- table, mit gefilterten Werten, keine leeren strings
- string, mit Fehlermeldung(en), oder
false
- Zitation.format()
- Zitation darstellen.
- Rückgabewerte:
- string, mit Wikitext-Struktur
- string, mit Fehlermeldung(en), oder
false
- Zitation.COinS(args, assign, already)
- Create string with COinS
<span>
args
– table, with COinS componentsassign
– optional string, with IDalready
– optional string, with preformatted &sequence
- Rückgabewert: string, mit HTML-Element
Dabei wird mit .filler()
und .fill()
das Datenmodell populiert und mit .format()
ausgegeben. Alles andere sind Servicefunktionen.