View source for Module:URL/doc

{{wikipedia|page name}}
{{module rating|protected}}

This module implements {{tl|URL}} and {{tl|URL2}}. Please see the template page for documentation.

== Lua interface ==
The <code>p._url(url, text, msg)</code> function may be used by other Lua modules. It returns a formatted Wikitext for the given URL, made suitable for line wrapping using {{tag|wbr|x}}. 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 <samp>false</samp>, <samp>n</samp> or <samp>N</samp>, do not emit a help message (using {{tlx|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>