Modul:UrlCheck/Doku

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

Version[Bearbeiten]

Versionsbezeichnung auf Wikidata: 2023-11-02

Funktion[Bearbeiten]

Das Modul stellt Funktionen zur Überprüfung von Internetadressen bereit. Sie werden üblicherweise in anderen Modulen oder Vorlagen verwendet.

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 • Failsafe • Marker utilities • GetP856
Modul benötigt das Modul UrlCheck – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.

Beispiele[Bearbeiten]

function uc.checkUrl( frame )

Mögliche Parameter:
- |url= URL, die überprüft werden soll.
- |show= msg Anstelle der Fehlernummern wird der Fehler im Wortlaut ausgegeben.

Text	Code	Ergebnis	Beschreibung
http://xyz.hotel.com:8080	{{#invoke:UrlCheck\|checkUrl\|url=http://xyz.hotel.com:8080}}	0	Keinen Fehler entdeckt
http://xyz.hotel.com/index.html?p1=A&p2=B#ressource	{{#invoke:UrlCheck\|checkUrl\|url=http://xyz.hotel.com/index.html?p1=A&p2=B#ressource}}	0	Keinen Fehler entdeckt
//xyz.hotel.com	{{#invoke:UrlCheck\|checkUrl\|url=//xyz.hotel.com}}	0	Keinen Fehler entdeckt
xyz.hotel.com	{{#invoke:UrlCheck\|checkUrl\|url=xyz.hotel.com}}	6	Fehlendes oder falsches Protokoll
https://max:muster@xyz.hotel.com	{{#invoke:UrlCheck\|checkUrl\|url=https://max:muster@xyz.hotel.com}}	0	Keinen Fehler entdeckt
http://www.müller.com	{{#invoke:UrlCheck\|checkUrl\|url=http://www.müller.com}}	1	Host mit Nicht-ASCII-Zeichen
http://150.150.150.150/index.html	{{#invoke:UrlCheck\|checkUrl\|url=http://150.150.150.150/index.html}}	2	Host ist eine IP-Adresse
http://150.150.150/index.html	{{#invoke:UrlCheck\|checkUrl\|url=http://150.150.150/index.html}}	22	Ungültige Host-Struktur
http://my.weekend.co.il/צימר_עזוז/	{{#invoke:UrlCheck\|checkUrl\|url=http://my.weekend.co.il/צימר_עזוז/}}	0	Keinen Fehler entdeckt
http://my.hotel.de/a'b\|c/	{{#invoke:UrlCheck\|checkUrl\|url=http://my.hotel.de/a'b\|c/}}	0	Keinen Fehler entdeckt

Weitere Funktionen[Bearbeiten]

function uc.ip4( address )

Die Funktion überprüft, ob eine gültige vierstellige IP4-Internetadresse vorliegt.
Ergebnis: Integer-Zahl. true: Adresse ist korrekt, false: Angabe ist keine gültige IP4-Internetadresse.

function uc.isUrl( url, skipPathCheck )

Die Funktion überprüft, ob eine URL formal syntaktisch korrekt ist. Die Bezeichnungen der Top-Level-Domänen werden noch nicht überprüft. Die formelle Prüfung der Pfadangaben in der URL kann mit skipPathCheck unterdrückt werden.
Ergebnis: Integer-Zahl. 0: URL ist wohl formal korrekt. > 0: URL ist fehlerhaft.

function uc.uriEncodePath( url )

Die Funktion liefert die URL mit URI-enkodierten Pfad.
Beispiel: Aus uc.uriEncodePath( 'http://my.weekend.co.il/צימר_עזוז/' ) wird http://my.weekend.co.il/%D7%A6%D7%99%D7%9E%D7%A8_%D7%A2%D7%96%D7%95%D7%96%2F.

function uc.encodePath( frame )

Die Funktion liefert die URL mit URI-enkodierten Pfad über einen #invoke-Aufruf.
Mögliche Parameter:
- |url= URL, die enkodiert werden soll.

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: UrlCheck/i18n