Module:URL/doc
 | This is a documentation subpage for Module:URL. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used on 630,000+ pages, or roughly 1% of all pages. 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. Consider discussing 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 warp correctly to most widths.
local url = Require('Module:URL')._url
local p
p.main = function(frame)
return url("https://en.wikipedia.org/wiki/Special:UserLogout")
end
return p