Modul:URLutil/doc

Az URLutil modul stringeket vizsgál, megfelelek-e az internet címeinek (URL; IP-címek– IPv4 és IPv6 beleértve – valamint email címek). Lehetséges a nemzetközi címek (IRI) vizsgálata is.

Feltételezzük, hogy Wiki-Projektek használhatják. A teljes nyitott interneten is hasznosak. A következő esetek nincsenek a modulban feldolgozva, de ezek alig valamennyire fontosak: IPv4-cím, mely nem az IETF RFC 1738 szabvány szerintiek (pontokkal tagoltak, decimálisok) URL IPv6-hosttal (zárójelezett, nem illik a wiki nyelvtanába) Authority szerzői névvel

A sablonoknak szóló funkciók

Ezek mindegyike pontosan egyetlen név nélküli paraméterrel (értelemszerűen kell megadni). A bevezető és követő szóközöket lehántolja . Üres stringgel válaszolnak a funkciók, ha a paraméter értéke nem felel meg az elvártnak. Ha van eredmény, vagy a lekérdezésre adandó válasz igen, akkor a visszaadott érték legalább egy karakterből áll. Sem előtte, sem utána nincs szóköz.

getAuthority

Az URL-ből a szervert működtető nevét kapjuk kis betűkkel írva üres – ha érvénytelen

getHost

Az URL-ből a hosztott (gazdagépet), vagy IP-címet adja vissza kis betűkkel írva üres – ha érvénytelen

getPort

Az URL-ből a port adatait kapjuk vissza szám formájában üres – ha nem található

getTLD

A Top-Level-Domain visszaadását kérjük vele, a tartománynevet. (eredménye kisbetűs) üres – ha hibás

getTop2domain

Az URL-ből a tartománynév két felső szintjét kapjuk vissza kis betűkkel írva üres – ha hibás

isAuthority

Lekérdezi, hogy szerver címét tartalmazza-e (IP is megfelel) beleértve a portot is. Visszaadott érték 1 – igen

isDomain

Nevesített tartomány, beleértve az alsóbb szinteket is? 1 – igen

isHost

Szerver cím port nélkül ( IP is beleértve)? 1 – igen

isIP

IP-cím? 4 ha az IPv4 (de a szabvány szerinti lejegyzésben megadva) 6 ha IPv6 üres – különben

isIPv4

IPv4-cím szabvány lejegyzéssel (pontokkal tagolt decimális jegyek)? 1 – igen

isIPv6

IPv6-cím? 1 – igen

isMailAddress

Email cím? 1 – igen

isMailLink

Email link (mailto:)? 1 – igen

isProtocolDialog

Olyan URL /Protokoll-azonosító, ami a wikiben egy dialógust vezet be? mailto, irc, ircs, ssh, telnet 1 – igen

isProtocolWiki

Olyan URL /Protokoll-azonosító, ami a wikiben egy relatív protokollra lehet linkelni? Relatív protokollok, mint ftp, ftps, git, http, https, mms, nntp, sftp, svn, worldwind Itt helytelen: gopher, wais valamint mailto, irc, ircs, ssh, telnet. 1 – igen

isResourceURL

Olyan URL, amely az interneten általában hozzáférhető honlapok elérhetőek? Ezek: relatív protokoll, http, https, ftp és ezen kívül érvényes hoszt. Ezek az enciklopédikus területen használhatók fel. Más URL is létezik.. 1 – igen

isSuspiciousURL

Valószínűleg szintaktikusan hibás, „gyanús“ URL, amely használatátnál óvatosságra kell figyelmeztetni? 1 – igen

isUnescapedURL

URL, amelynél még a wikiszintakszis [ | ] lekérdezendő? 1 – igen

isWebURL

Érvényes cím (a protokoll itt tetszőleges)? 1 – igen

wikiEscapeURL

A wikiszintakszisba biztosan illeszkedő [ | ] eszképek. Visszaadott értéke: Azonos a megadott paraméterrel , ha nincsenek problematikus jelek. A [ | ] helyettesítve a webserver-biztos HTML-egységekkel, ha azok elérhetők. A sablon szintakszis szerinti ugynevezett pipe ilyenkor nem lehetséges minden további nélkül.

Példák (tesztlap)

A tesztlap: Modulvita:URLutil/tesztdoboz szemléltet praktikus példákkal.

Általános szabályok a modulok használatára

Mindenkor a következő formát használjuk: {{#invoke: URLutil | Függvénynév | Paraméter1 értéke | Paraméter2 értéke | ParaméterX neve=értéke … }} Nevesített és név nélküli paraméterek lehetségesek, mint a sablonoknál. Ha ismeretlen stringek kívűlről jönnek (mint valamely sablom paraméterei), akkor ajánlatos mindig az 1=Paraméter-érték formát alkalmaznunk.