Module:URL/doc
From CryptoWiki
Revision as of 23:05, 15 July 2021 by wiki_crypto>Pppery (Add {{used in system}})
This is the documentation page for Module:URL
| File:Ambox important.svg | This Lua module is used in MediaWiki:Titleblacklist-custom-URL, and on approximately 518,000 pages, or roughly 7053% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module implements {{URL}} and {{URL2}}. Please see the template page for documentation.
Lua interface
The p._url(url, text, msg) function may be used by other Lua modules. It returns a formatted Wikitext for the given URL, made suitable for line wrapping using . It takes the following parameters:
- url
- REQUIRED. The URL to format.
- text
- OPTIONAL. Display text to put in the Wikitext link. Defaults to a pretty version of the URL.
- msg
- OPTIONAL. String. If content is false, n or N, do not emit a help message (using
{{tlx}}) when URL is not given.
Example
The following module emits a prettified link to log the user out. It will wrap correctly to most widths. <syntaxhighlight lang=lua> local url = require('Module:URL')._url local p = {}
p.main = function(frame)
return url("https://en.wikipedia.org/wiki/Special:UserLogout")
end
return p </syntaxhighlight>
See also
- {{#invoke:WikidataIB|url2}} – a simpler version which only allows one value
