Modul:LinkMail/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Modul:LinkMail.
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 LinkMail/Test und die Anwendung auf der Spielwiese getestet werden, da wiederholte Trial-and-Error-Edits die Resourcen stark belasten können.

Anwendung[Bearbeiten]

Der Modul stellt Funktionen zur Verlinkung von Email-Adressen bereit.

Versionsbezeichnung auf Wikidata: 2023-12-08

Kommentare müssen hinter der Emailadresse in Klammern angefügt werden. Bei nicht erkennbaren Fehlern stecken in der Email-Adresse möglicherweise nicht sichtbare Steuerzeichen wie Left-To-Right Marks (meist vor und hinter dem @ oder am Ende der Email), oder es wurden falsche Bindestriche verwendet (Soft Hyphen (U+00AD), Hyphen (U+2010) anstelle Hyphen-Minus (U+002D)).

Benötigte weitere Module

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

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:

vCard
Modul benötigt das Modul LinkMail – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.

Wartungskategorien[Bearbeiten]

Beispiele[Bearbeiten]

Text	Code	Ergebnis
cafe@xyz.hotel.com	{{#invoke:LinkMail\|linkMails\|cafe@xyz.hotel.com}}	cafe@xyz.hotel.com
café@xyz.hotel.com	{{#invoke:LinkMail\|linkMails\|café@xyz.hotel.com}}	café@xyz.hotel.com Category:Kontakt: Email enthält Unicode-Zeichen Email enthält Unicode-Zeichen
info.main@xyz.hotel-abc.com (Information)	{{#invoke:LinkMail\|linkMails\|info.main@xyz.hotel-abc.com (Information)}}	info.main@xyz.hotel-abc.com (Information)
info@xyz.hotel.com, reservation@xyz.hotel.travel	{{#invoke:LinkMail\|linkMails\|info@xyz.hotel.com, reservation@xyz.hotel.travel}}	info@xyz.hotel.com, reservation@xyz.hotel.travel
info@$xyz.hotel.com	{{#invoke:LinkMail\|linkMails\|info@$xyz.hotel.com}}	info@$xyz.hotel.com Category:Kontakt: Ungültiges Email-Format Ungültiges Email-Format

Fehlersuche[Bearbeiten]

Im Fehlerfall wird neben der Fehlerkategorie auch ein Fehlertext hinter der Email-Adresse ausgegeben.

Beschreibung der Funktionen[Bearbeiten]

function lm._isEmail( s )

s: string;

Die Funktion prüft, ob die Email-Adresse s gültig ist.

function lm._linkMail( m, args, ignoreUnicode )

m: string;

args: arguments array;

ignoreUnicode: boolean;

Die Funktion prüft und verlinkt eine gültige Email-Adresse m.

function lm.linkMailSet( args )

args: arguments array;

Die Funktion spaltet eine Liste von Email-Adressen auf und übergibt jede einzelne Adresse an lm.linkMail.

function lm.linkMails( frame )

frame: frame object;

Die Funktion stellt die Schnittstelle für einen {{#invoke: ...}}-Aufruf zur Verfügung.

function lm.linkMailsTemplate( frame )

frame: frame object;

Die Funktion stellt die Schnittstelle für einen Vorlagen-Aufruf zur Verfügung.

Bedeutung der Variablen[Bearbeiten]

lm.categories – Array mit gleichnamigen Fehlerausschriften und Kategoriennamen.

lm.delimiters – Array mit Mustern für Trenner unterschiedlicher Telefonnummern. Das Komma muss nicht in dieses Array eingetragen werden.

lm.addNum – Anzahl der sichtbaren, nicht ausgeblendeten Email-Adressen. Die überzähligen Adressen sind aber im HTML-Quelltext enthalten und lassen mit einer Stilvorlage einblenden.

Klassenbezeichner[Bearbeiten]

Im HTML-Quelltext werden folgende Klassenbezeichner eingesetzt:

error – Klasse der Fehlerausschrift.
listing-check-recommended – Klasse der Fehlerausschrift. Eine Prüfung wird empfohlen
listing-add-contact - Klassenbezeichner ausgeblendeter Email-Adressen. Wenn mehr als zwei Email-Adressen vorhanden sind, so werden die überzähligen Adressen ausgeblendet, sind aber im HTML-Quelltext vorhanden.