Quelltext der Seite Lua/Modul/WLink/de

{{LuaModuleDoc}}
{{SchaufensterBeginn|Auszug}}'''<code>WLink</code>''' – Modul mit Funktionen für Zeichenketten im Zusammenhang mit Wiki-Verlinkungen (Wikilink-Format und [[Uniform Resource Locator|URL]]-Format).
<noinclude>__TOC__</noinclude>
== {{Anker|Vorlage}} Funktionen für Vorlagen ==

Alle Funktionen haben genau einen unbenannten Parameter (sinnvollerweise anzugeben). Dieser ist tolerant gegenüber Leerzeichen vor oder nach dem Inhalt. HTML-Entities sind in der Eingabe möglich und werden im Resultat aufgelöst. In der Regel handelt es sich dabei um eine Zeichenkette, in der geklammerte Verlinkungen erwartet werden; dann wird die erste Klammer weiterverarbeitet.

Der Rückgabewert ist eine leere Zeichenkette („nichts“), wenn der Parameterwert die Erwartung nicht erfüllt. Wenn ein Ergebnis vorhanden oder die Abfragebedingung wahr ist, resultiert mindestens ein Zeichen. Das Ergebnis beginnt oder endet nicht mit Leerzeichen.
; ansiPercent   {{Anker|ansiPercent}}
: Konvertiere URL mittels [[American National Standards Institute|ANSI]]-Encoding statt durch [[UTF-8]]-Encoding.
: Für manche Server mit Software-Format aus dem letzten Jahrhundert benötigt.
: Optionaler Zusatzparameter <code>space</code> – Kodierung der Leerzeichen:
:* <code>space=+</code> – in Query-Komponenten üblich
:* <code>space=_</code> – wie im Wiki
:* Standard: <code>%20</code>
; formatURL   {{Anker|formatURL}}
: Formatiere eine URL, ein betiteltes Weblink oder schlicht eine Domain.
:* <nowiki>[http://example.org/about Homepage]</nowiki> ''ergibt'' <nowiki>[http://example.org/about Homepage]</nowiki>
:* <nowiki>http://example.org/about</nowiki> ''ergibt'' <nowiki>[http://example.org/about example.org/about]</nowiki>
:* example.org ''ergibt'' <nowiki>[http://example.org/ example.org]</nowiki>
: Textzusätze außerhalb dieser Formate werden durchgereicht.
; getArticleBase   {{Anker|getArticleBase}}
: Ermittle den generischen Seitentitel, ohne Fragment oder Klammerausdruck eines „Klammerlemma“.
: Benutze den momentanen Seitentitel, falls nicht angegeben.
; getBaseTitle   {{Anker|getBaseTitle}}
: Ermittle in einer Unterseite das letzte Segment des Seitentitels, ohne Fragment.
; getEscapedTitle   {{Anker|getEscapedTitle}}
: Bilde einen als Linktitel geeigneten Text.
: Die eckigen Klammern und Pipe <code>[|]</code> sowie Quelltext-Zeilenumbrüche werden darstellbar gemacht.<ref>Ein ähnlicher Effekt ließe sich auch durch Einschluss des Linktitels in <code>&lt;nowiki></code> erreichen; dann wären allerdings Kursiv- und Fettschrift sowie HTML-Elemente nicht mehr funktional.</ref>
; getExtension   {{Anker|getExtension}}
: Ermittle die „[[Dateinamenserweiterung|Namenserweiterung]]“ von Mediendateien.
: Das Ergebnis wird in Kleinschreibung ohne führenden Punkt dargestellt.
; getFile   {{Anker|getFile}}
: Ermittle den Dateinamen.
: Die Eingabe kann eine geklammerte Verlinkung oder nur ein Dateiname sein. Sie ist nur gültig, wenn sowohl eine zulässige Bezeichnung des Dateinamensraum wie auch eine  „[[Dateinamenserweiterung|Namenserweiterung]]“ vorhanden ist.
: Das Ergebnis ist der Titel der Datei ohne Namensraum.
; getFragment   {{Anker|getFragment}}
: Ermittle das originale (nicht dekodierte) Fragment nach <code>#</code>.
: Kein Resultat, wenn Fragment leer oder nicht vorhanden.
; getLanguage   {{Anker|getLanguage}}
: Ermittle den Sprachbezeichner des Projekts.
; getLinktextProblem   {{Anker|getLinktextProblem}}
: Welches Problem hat dieser als Linktext vorgesehene Text?
: <code>]</code> → eckige Klammern; <code>\n</code> → Zeilenumbruch; <code>&lt;wiki></code> → unerlaubte HTML-Elemente; ISBN PMID RFC
; getNamespace   {{Anker|getNamespace}}
: Ermittle die Nummer des Namensraums.
; getNamespaced   {{Anker|getNamespaced}}
: Generiere einen Seitennamen aus Namensraumbezeichner und Link oder Seitentitel oder Seitenname mit Namensraum.
:# Namensraumbezeichner beliebiger Art
:# Seitentitel oder Seitenname mit Namensraum oder Wikilink
; getPlain   {{Anker|getPlain}}
: Löse alle Verlinkungen im Text auf und ersetze durch die Linktitel.
; getProject   {{Anker|getProject}}
: Ermittle den Projektbezeichner (nur innerhalb der Wikifarm) in empfehlenswerter Kurzform.
; getTalkPage   {{Anker|getTalkPage}}
: Ermittle die zugehörige Diskussionsseite, falls es eine geben kann, bzw. diese Diskussionsseite selbst.
; getTarget   {{Anker|getTarget}}
: Ermittle das erste Linkziel (Wikilink oder URL).
; getTargetPage   {{Anker|getTargetPage}}
: Ermittle den Seitennamen zur ersten Verlinkung (Seitenname oder URL der Seite)
: Identisch mit ''getTarget'', falls kein Fragment.
; getTitle   {{Anker|getTitle}}
: Ermittle den ersten Linktitel (Wikilink oder URL), oder sonst das Linkziel eines Wikilinks.
; getWeblink   {{Anker|getWeblink}}
: Generiere formatiertes Weblink (in eckigen Klammern) aus einer Ressourcen-URL
; getWikilink   {{Anker|getWikilink}}
: Generiere robustes standardisiertes Wikilink (in eckigen Klammern)
:# Linkziel, Seitenname, Text mit einem Wikilink
:# abweichender Linktext (optional)
; isBracketedLink   {{Anker|isBracketedLink}}
: Enthält das eine geklammerte Verlinkung?
; isBracketedURL   {{Anker|isBracketedURL}}
: Enthält das eine geklammerte URL?
; isCategorization   {{Anker|isCategorization}}
: Enthält das eine wirksame Kategorisierung?
; isExternalLink   {{Anker|isExternalLink}}
: Enthält das eine URL?
; isInterlanguage   {{Anker|isInterlanguage}}
: Enthält das ein Interlanguage?
; isInterwiki   {{Anker|isInterwiki}}
: Enthält das ein Interwiki-Link innerhalb der Wikifarm, einschließlich Interlanguage?
; isMedia   {{Anker|isMedia}}
: Enthält das eine Medieneinbindung?
; isTalkPage   {{Anker|isTalkPage}}
: Enthält das eine Diskussionsseite?
; isTitledLink   {{Anker|isTitledLink}}
: Enthält das eine betitelte Verlinkung?
; isValidLink   {{Anker|isValidLink}}
: Enthält das eine Verlinkung?
; isValidLinktext   {{Anker|isValidLinktext}}
: Ist das als Linktext geeignet?
; isWikilink   {{Anker|isWikilink}}
: Enthält das ein Wikilink?
; pageLink   {{Anker|pageLink}}
: Robustes Ziel für ein Wikilink auf eine Seite; beginnt nicht mit <code>*;:#</code>
; failsafe   {{Anker|failsafe}}
: Versionsbezeichnung (lokal): <code>{{#invoke:WLink|failsafe}}</code>
: Optionaler Zusatzparameter:
:* <code>1</code> – Mindestversionsbezeichnung oder <code>wikidata</code> oder <code>~</code>
: <code><nowiki>{{#invoke:WLink|failsafe}}</nowiki></code> ergibt <code>{{#invoke:WLink|failsafe}}</code>
: Mit Angabe eines Parameters als Datum im ISO-Format wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.
:* <code><nowiki>{{#invoke:WLink|failsafe|2001-01-01}}</nowiki></code> ergibt: »<code>{{#invoke:WLink|failsafe|2001-01-01}}</code>«
:* <code><nowiki>{{#invoke:WLink|failsafe|2099-01-01}}</nowiki></code> ergibt: »<code>{{#invoke:WLink|failsafe|2099-01-01}}</code>« – leer, falls Mindestversionsbezeichnung nicht erfüllt
: Ist dieser Zusatzparameter das Schlüsselwort <code>wikidata</code>, so ist der Wert die auf Wikidata registrierte Versionsbezeichnung (<code>{{#invoke:WLink|failsafe|wikidata}}</code>) oder lokal, falls dort keine gefunden.
:* Ist der Zusatzparameter das Zeichen <code>~</code>, so ist das Ergebnis ''leer'', falls Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung besteht&nbsp;(<code>{{#invoke:WLink|failsafe|~}}</code>).
: ''Rückgabewert:''
:* Leer, falls Mindestversionsbezeichnung nicht erfüllt, oder Übereinstimmung mit Wikidata
:* Versionsbezeichnung (auf Wikidata registriert:<code>{{#invoke:WLink|failsafe|wikidata}}</code>) bei <code>wikidata</code>, oder lokal falls dort keine gefunden, bzw. leer wenn synchronisiert

===  Beispiele (Testseite) ===
Eine [[Wikipedia:Lua/Modul/WLink/Test|Testseite]] illustriert praktische Beispiele.
<includeonly>
== Anmerkungen ==
<references /></includeonly></onlyinclude>
== {{Anker|Lua}} Funktionen für Lua-Module ==

Alle oben dokumentierten Funktionen können auch über <code>require()</code> in andere Module eingebunden werden:
<syntaxhighlight lang="lua">
local lucky, WLink = pcall( require, "Module:WLink" )
if type( WLink ) == "table" then
    WLink = WLink.WLink()
else
    -- Fehlerfall; WLink enthält Fehlermeldung
    return "<span class=\"error\">" .. WLink .. "</span>"
end
</syntaxhighlight>
Danach stehen zur Verfügung:
* WLink.ansiPercent(story, space)
* WLink.formatURL()
* WLink.getArticleBase()
* WLink.getBaseTitle()
* WLink.getEscapedTitle()
* WLink.getExtension()
* WLink.getFile()
* WLink.getFragment()
*: <code>false</code>, wenn nicht vorhanden; aber "" wenn Fragment leer.
*: Kein <code>#</code> am Anfang des Ergebnisses.
* WLink.getLanguage()
* WLink.getLinktextProblem()
* WLink.getNamespace()
* WLink.getNamespaced()
* WLink.getPlain()
* WLink.getProject()
* WLink.getTalkPage()
* WLink.getTarget()
* WLink.getTargetPage()
* WLink.getTitle()
* WLink.getWeblink()
* WLink.getWikilink()
* WLink.isBracketedLink()
* WLink.isBracketedURL()
* WLink.isCategorization()
* WLink.isExternalLink()
* WLink.isInterlanguage()
* WLink.isInterwiki()
* WLink.isMedia()
* WLink.isTalkPage()
* WLink.isTitledLink()
* WLink.isValidLink()
* WLink.isValidLinktext()
* WLink.isWeblink()
* WLink.isWikilink()
* WLink.pageLink(attempt, appear, assure)
*: Liefert robustes Wikilink auf eine Seite (ohne Klammern)
*:* <code>attempt</code> – mutmaßlicher Link; ''string'' oder ''table'' gemäß [[#.wikilink()|.wikilink()]]
*:* <code>appear</code> – ''(optional)'' Linktext ''string'' oder <code>true</code>
*:* <code>assure</code> – ''(optional)'' Methode zum Schutz gegen Vorlagensyntax: <code>URL</code> oder <code>WIKI</code>
* WLink.pageTarget(attempt, assure)
*: Liefert robustes standardisiertes Ziel für ein Wikilink
*:* <code>attempt</code> – mutmaßlicher Link; ''string'' oder ''table'' gemäß [[#.wikilink()|.wikilink()]]
*:* <code>assure</code> – ''(optional)'' Methode zum Schutz gegen Vorlagensyntax: <code>URL</code> oder <code>WIKI</code>
* WLink.wikilink()   {{Anker|.wikilink()}}
*: Liefert ''table'' mit den Komponenten des Wikilinks, sonst <code>false</code>.
*: Komponenten können sein, falls angegeben:
*:* <code>lead</code> – Führender Doppelpunkt vorhanden und erforderlich, falls <code>true</code>
*:* <code>project</code> – Projekt-Interwiki (standardisierte Abkürzung)
*:* <code>lang</code> – Bekannte Sprachversion (Kleinbuchstaben)
*:* <code>ns</code> – Nummer des Namensraums
*:* <code>space</code> – Standardname des Namensraums
*:* <code>title</code> – Seitentitel wie vorgefunden; mindestens eine leere Zeichenkette
* WLink.[[#failsafe|failsafe]](atleast)
*:# atleast<br /> ''optional''<br /> ''nil'' oder Mindestversion oder <code>"wikidata"</code> oder <code>~</code> für Synchronisation
*: Rückgabewert: Boolesch oder Zeichenkette
Im Erfolgsfall geben die ''WLink.get*()'' eine Zeichenkette zurück, die ''WLink.is*()'' den Wert <code>true</code> (sofern nicht anders angegeben); bei Misserfolg jeweils <code>false</code>.

== Verwendung ==
Allgemeine Bibliothek; nicht eingegrenzt.

== Abhängigkeiten ==
* [[Wikipedia:Lua/Modul/URLutil|URLutil]]

== Installation auf anderen Projekten ==
Siehe [[../en|englischsprachige Dokumentation]].

== Siehe auch ==
* [[Wikipedia:Lua/Modul/URLutil|URLutil]] – allgemeine Funktionalitäten speziell für URL.

== Anmerkungen ==
<references />

[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|WLink]]