Modul:Link utilities/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Modul:Link utilities.
Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Modul-Seite ist.

Dieses Modul ist getestet und für den projektweiten Gebrauch geeignet. Es kann in Vorlagen benutzt und auf Hilfeseiten erläutert werden. Entwicklungen an dem Modul sollten auf Link utilities/Test und die Anwendung auf der Spielwiese getestet werden, da wiederholte Trial-and-Error-Edits die Resourcen stark belasten können.

Anwendung

Der Modul stellt grundlegende Funktionen für die Module Modul:LinkPhone, Modul:LinkMail, Modul:LinkSkype und Modul:LinkISBN zur Verfügung.

Versionsbezeichnung auf Wikidata: 2023-12-09

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:

LinkISBN • LinkPhone • LinkSkype • LinkMail
Modul benötigt das Modul Link utilities – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: Link utilities/i18n

Funktionen

function lu.splitItems( s, delimiters, defaultDelimiter )

s: string;

delimiters: array;

defaultDelimiter: string;

Die Funktion spaltet die Zeichenkette s in ihre Einzelbestandteile auf und übergibt das Ergebnis in einem Array. Als Trenner dienen sowohl der defaultDelimiter (bei fehlender Angabe Komma) als auch die zusätzlichen Trenner delimiters. Trenner in Klammerausdrücken werden nicht berücksichtigt.

function lu.extractComment( s )

s: string;

Die Funktion trennt einen in Klammern formulierten Kommentar von der davor stehenden Zeichenkette. Es werden zwei Ergebnisse übergeben: die kommentarlose Zeichenkette und der Kommentar.

function lu.errorInfo( catPrefix, aCat, aClass )

catPrefix: string;

aCat: string;

aClass: string;

Die Funktion gibt die Fehlerausschrift aCat im Haupt- oder Modul-Namenraum aus und legt eine gleichnamige Wartungskategorie an. Die Zeichenkette mit der Fehlerausschrift wird von einem <span>-Tag mit der Klasse aClass umschlossen. Fehlt die Klassenangabe, so wird die Klasse error verwendet. Der Modulparameter demo legt fest, ob die Kategorie angelegt oder nur verlinkt werden soll.