Modul:Citation/utilities/Doku

Verwendung

Das Modul stellt gemeinsame Funktionen für das Modul:Citation zur Verfügung.

Versionsbezeichnung auf Wikidata: 2024-06-08

Funktionen

function cu.isSet( param )

liefert true, wenn die Zeichenkette param einen nicht-leeren Wert enthält.

function cu.round( num, decimalPlaces )

liefert die auf decimalPlaces Stellen gerundete Zahl num zurück.

function cu.getNumber( s )

konvertiert eine Zeichenkette in eine Zahl unter Berücksichtigung des in Modul:Citation/i18n spezifizierten Dezimalzeichens ci.texts.decimalPoint. Wenn in der Zeichenkette [sic!] enthalten ist, wird 0 zurückgegeben. Damit wird verhindert, dass eine Zahlenangabe als zu groß und fehlerhaft gekennzeichnet wird.

function cu.addErrorMsg( msg )

fügt eine Fehlermeldung in die intern vorgehaltene Fehlertabelle errorMsgs ein.

function cu.getErrorMsgs()

liefert eine Zeichenkette mit allen in der Fehlertabelle errorMsgs enthaltenen Fehlermeldungen – jede aber nur einmal – zurück.

function cu.getFirst( s, delimiter )

liefert das erste Element einer mit dem Trenner delimiter unterteilten Zeichenkette zurück.

function cu.inArray( tab, val )

liefert true zurück, wenn das Element val in der Tabelle tab enthalten ist.

function cu.getKey( t, list )

liefert das key-Element aus der Tabelle list, die Parameternamen in Übersetzung enthält.

function cu.getArgValue( list, param, args )

liefert einen einzelne Wert aus der Parametertabelle args für den Parameter param zurück. Die Tabelle list wir für die Übersetzung der Parameternamen benötigt.

function cu.parameterCleanup( s )

liefert eine bereinigte Zeichenkette zurück, aus der Steuerzeichen, verschiedene Block-Tags (div, p, br) entfernt und XML- bzw. SGML-Zeichenreferenzen ausgetauscht wurden.

function cu.cleanupPageNumbers( pages )

liefert eine Zeichenkette zurück, in der verschiedene Striche durch den Bindestrich ersetzt wurden.

function cu.coinsCleanup( s )

liefert eine Zeichenkette, in der verschiedene Steuerzeichen, span-Tags, Wiki-Syntax (hauptsächlich Links) entfernt wurden.

function cu.finalCleanup( s )

liefert eine Zeichenkette, in der aufeinander folgende Interpunktionszeichen entfernt wurden.

function cu.makeLink( url, text )

liefert einen Link in Wiki-Syntax.

function cu.encodeHandle( handle )

liefert den URI-encodeten Wert des Parameters handle.

function cu.getDate( aDate, aFormat, errorMsg )

liefert eine formatierte Datumsangabe aus aDate mit dem Format aFormat. Bei fehlerhafter Wandlung wird die Fehlermeldung errorMsg in die interne Fehlertabelle geschrieben.

function cu.hasExtension( url, ext )

liefert true, wenn die Internetadresse url die Dateierweiterung ext besitzt.

function cu.insertItem( tab, s, formatStr )

fügt die formatierte Zeichenkette s in die Tabelle tab ein, wenn sie nicht leer ist.

function cu.insertItem2( tab, s1, s2, formatStr )

fügt eine formatierte Zeichenkette aus den Teilzeichenketten s1 und s2 in die Tabelle tab ein, wenn sie beide nicht leer sind.

function cu.formatItem( s, formatStr )

liefert die formatierte Zeichenkette s, wenn sie nicht leer ist.

function cu.formatItem2( s1, s2, formatStr )

liefert eine formatierte Zeichenkette aus den Teilzeichenketten s1 und s2, wenn sie beide nicht leer sind.

function cu.templateStyles( frame )

stellt die templatestyles für die Vorlagen bereit, die das Modul Modul:Citation benutzen.

function cu.getNbnCheckDigit( urn )

liefert die Prüfziffer für urn:nbn-Identifikatoren der Länder at, ch, de und fi.

function cu.check_UrnNbn( urn )

prüft, ob die urn über die korrekte Prüfziffer verfügt.

Verwendung in anderen Modulen

Dieses Modul ist notwendig für die Ausführung folgender Module. Bei Anpassungen sollte die Funktionstüchtigkeit der folgenden Module geprüft werden. Benutze dazu auch diese Tracking-Kategorie um Fehler zu finden, die sich dann auf Artikel auswirken:

• Citation
• Modul benötigt das Modul Citation/utilities – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.