Module:URL/doc

From Incwajana
Jump to: navigation, search

This is the documentation page for Module:URL

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. <source 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 </source>