Admin am 7. Juni 2025 um 10:40 Uhr

2025-06-07T10:40:18Z

← Nächstältere Version		Version vom 7. Juni 2025, 10:40 Uhr
Zeile 1:		Zeile 1:
	{{LuaModuleDoc}}		{{LuaModuleDoc}}
	<onlyinclude>		<onlyinclude>
	'''<code>WLink</code>''' – Module with functions for strings in context of wikilinks and external links (~~[[Uniform Resource Locator\|~~URL]]).		'''<code>WLink</code>''' – Module with functions for strings in context of wikilinks and external links (URL).
	<noinclude>__TOC__</noinclude>		<noinclude>__TOC__</noinclude>
	== {{Anker\|template}} Functions for templates ==		== {{Anker\|template}} Functions for templates ==

Admin: AZ: Die Seite wurde neu angelegt: {{LuaModuleDoc}} '''`WLink`''' – Module with functions for strings in context of wikilinks and external links (URL). TOC == {{Anker|template}} Functions for templates == Most functions expect exactly one unnamed parameter (which should be provided to get a meaningful answer). Whitespace ahead and after content is ign…

2025-01-29T17:44:50Z

AZ: Die Seite wurde neu angelegt: {{LuaModuleDoc}} <onlyinclude> '''<code>WLink</code>''' – Module with functions for strings in context of wikilinks and external links (URL). <noinclude>__TOC__</noinclude> == {{Anker|template}} Functions for templates == Most functions expect exactly one unnamed parameter (which should be provided to get a meaningful answer). Whitespace ahead and after content is ign…

Neue Seite

{{LuaModuleDoc}}
<onlyinclude>
'''<code>WLink</code>''' – Module with functions for strings in context of wikilinks and external links ([[Uniform Resource Locator|URL]]).
<noinclude>__TOC__</noinclude>
== {{Anker|template}} Functions for templates ==

Most functions expect exactly one unnamed parameter (which should be provided to get a meaningful answer). Whitespace ahead and after content is ignored. HTML Entities would not disturb syntax and might be resolved. The parameter might contain single or double bracketed links which would be extracted if appropriate.

The return value is an empty string (“nothing”), if the parameter value does not fulfil the expectations. If there is a result or the query condition is true, at least one visible character will be returned. The result does not begin or end with a space.

; ansiPercent
: Convert string by ANSI encoding rather than UTF-8 encoding
: Required for some 20th century servers
: Optional parameter <code>space</code> – encoding of spaces:
:* <code>space=+</code> – common for query components
:* <code>space=_</code> – as for Wikis
:* Default: <code>%20</code>
; formatURL
: Create bracketed link, if not yet, from URL or domain
:* <nowiki>[http://example.org/about Homepage]</nowiki> ''yields'' <nowiki>[http://example.org/about Homepage]</nowiki>
:* <nowiki>http://example.org/about</nowiki> ''yields'' <nowiki>[http://example.org/about example.org/about]</nowiki>
:* example.org ''yields'' <nowiki>[http://example.org/ example.org]</nowiki>
; getArticleBase
: Retrieve generic page title, no fragment nor brackets
: Use current page title, if omitted.
; getBaseTitle
: Retrieve last segment in subpage, no fragment
; getEscapedTitle
: Retrieve link title with visible square brackets and pipe <code>[|]</code> and enable source line breaks, but avoid <code><nowiki></code> for other wikisyntax.
; getExtension
: Retrieve media extension
: Result is downcased (without leading dot).
; getFile
: Retrieve media page identifier
; getFragment
: Retrieve original (not decoded) fragment string after <code>#</code>
; getLanguage
: Retrieve language identifier
; getLinktextProblem
: Which problem has this presumable link text?
: <code>]</code> → square brackets; <code>\n</code> → line break; <code><wiki></code> → illegal HTML or wikisyntax elements (block); ISBN PMID RFC
; getNamespace
: Retrieve namespace number
; getNamespaced
: Retrieve page name in namespace
: Two mandatory parameters:
:# Any kind of namespace specification
:# Page title or prefixed page name or link to page
; getPlain
: Retrieve text with all links replaced by link titles
; getProject
: Retrieve project identifier within wikifarm (recommendable brief notation)
; getTalkPage
: Retrieve talk page, if permitted, or a talk page itself
; getTarget
: Retrieve first target (wikilink or URL)
; getTargetPage
: Retrieve first target page (page name or URL of page)
: Same as ''getTarget'' if no fragment.
; getTitle
: Retrieve first link title (wikilink or URL), or wikilink target
; getWeblink
: Retrieve bracketed link from resource URL
; getWikilink
: Retrieve robust normalized internal link (in brackets)
:# Page name or text with internal link
:# Different link text (optional)
; isBracketedLink
: Does attempt match a bracketed link?
; isBracketedURL
: Does attempt match a bracketed URL?
; isCategorization
: Does attempt match a categorization?
; isExternalLink
: Does attempt match an external link?
; isInterlanguage
: Does attempt match an interlanguage link?
; isInterwiki
: Does attempt match an interwiki link?
; isMedia
: Does attempt match a media translusion?
; isTalkPage
: Does attempt match a talk page?
; isTitledLink
: Does attempt match a titled link?
; isValidLink
: Does attempt match a link?
; isValidLinktext 
: Is attempt permitted as link text, does not contain other links or other structures?
; isWeblink
: Does attempt match an external link?
; isWikilink
: Does attempt match a wikilink?
; pageLink 
: Make robust link on a wiki page, not beginning with <code>*;:#</code>.
; failsafe
: Version ID (local): <code>{{#invoke:WLink|failsafe}}</code>
: Optional parameter:
:* <code>1</code> – Minimum version or <code>wikidata</code> or <code>~</code>
: <code><nowiki>{{#invoke:WLink|failsafe}}</nowiki></code> yields <code>{{#invoke:WLink|failsafe}}</code>
: With a parameter as ISO date it is compared whether the current module satisfies this version or later.
:* <code><nowiki>{{#invoke:WLink|failsafe|2001-01-01}}</nowiki></code> returns: »<code>{{#invoke:WLink|failsafe|2001-01-01}}</code>«
:* <code><nowiki>{{#invoke:WLink|failsafe|2099-01-01}}</nowiki></code> returns: »<code>{{#invoke:WLink|failsafe|2099-01-01}}</code>« – (empty), if minimal version condition not matched
:* If keyword is <code>wikidata</code>, result is version ID registered on Wikidata (<code>{{#invoke:WLink|failsafe|wikidata}}</code>) or local if not found there.
:* If keyword is <code>~</code>, result is ''empty'' if local and Wikidata version are the same: (<code>{{#invoke:WLink|failsafe|~}}</code>).
: ''Returns:''
:* Empty, if minimal version condition not matched, or <code>~</code> and local version is synchronized.
:* Version ID if no parameter, or if <code>wikidata</code>, or local if not found there, or not synchronized.

=== Examples (test page) ===
A [[Helmstedt-Wiki:Lua/Modul/WLink/Test|test page]] illustrates practical use.</onlyinclude>

== {{Anker|Lua}} Functions for Lua modules (API) ==

All functions described above can be used by other modules:
<syntaxhighlight lang="lua">
local lucky, WLink = pcall( require, "Module:WLink" )
if type( WLink ) == "table" then
WLink = WLink.WLink()
else
-- failure; WLink is the error message
return "" .. WLink .. ""
end
</syntaxhighlight>
Subsequently there are available:
* WLink.ansiPercent(story, space)
* WLink.formatURL()
* WLink.getArticleBase()
* WLink.getBaseTitle()
* WLink.getExtension()
* WLink.getFile()
* WLink.getFragment()
*: <code>false</code>, if not found; but empty string if empty fragment.
*: No leading <code>#</code> in result.
* WLink.getLanguage()
* WLink.getLinktextProblem()
* WLink.getNamespace()
* WLink.getNamespaced(area,at)
*# area – ''string'' or ''number''
*# at – ''string''
* 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)
*: Yields robust internal link to a page
*:* <code>attempt</code> – presumable internal link; ''string'' oder ''table'' as of WLink.wikilink()
*:* <code>appear</code> – ''(optional)'' link text ''string'' oder <code>true</code>
*:* <code>assure</code> – ''(optional)'' method to protect against template syntax: <code>URL</code> or <code>WIKI</code>
* WLink.pageTarget()
*: Yields ''string'' with robust normalized internal link target
* WLink.wikilink()
*: Yields ''table'' with wikilink components, else <code>false</code>.
*: Components might be, if provided:
*:* <code>lead</code> – leading colon <code>:</code> present and required, if <code>true</code>
*:* <code>project</code> – project interwiki within wikifarm (recommendable brief notation)
*:* <code>lang</code> – known language version (downcased)
*:* <code>ns</code> – number of namespace
*:* <code>space</code> – local canonical name of namespace
*:* <code>title</code> – page title as provided; at least empty string
* WLink.failsafe(atleast)
: Versioning interface
:# atleast ''optional'' ''nil'' or minimum version or <code>wikidata</code> or <code>~</code> for synchronisation
: ''returns:'' Version ID as ''string'' or <code>false</code>
If succeeding, the ''WLink.get*()'' return a string, the ''WLink.is*()'' <code>true</code> (if no exception mentioned); on failure always <code>false</code>.

== Installation on other WMF projects ==
Follow the steps:
# Copy main module <code>[[Module:WLink]]</code> into your project.
#* If possible keep the name <code>WLink</code>.
#* If another name is required due to conflict or naming convention or non-latin script then choose a different one.
# Register this module at [[d:Q19363224]].
# [[../../URLutil/en|URLutil]] should be available; otherwise related functions will not work.
# Ready.
# Consider translation of doc page.

== Usage ==
General library; no limitations.

== Dependencies ==
* [[../../URLutil/en|URLutil]]

[[Kategorie:Helmstedt-Wiki:Lua/Modul/Dokumentation|WLink/en]]

Helmstedt-Wiki:Lua/Modul/WLink/en - Versionsgeschichte

Admin am 7. Juni 2025 um 10:40 Uhr