Difference between revisions of "Module:URL/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Anomalocaris
m (<tt> → <samp>)
blackwiki>Seppi333
(→‎Example: syntax)
Line 14: Line 14:
 
The following module emits a prettified link to log the user out. It will warp correctly to most widths.
 
The following module emits a prettified link to log the user out. It will warp correctly to most widths.
 
<source lang=lua>
 
<source lang=lua>
local url = Require('Module:URL')._url
+
local url = require('Module:URL')._url
local p
+
local p = {}
  
 
p.main = function(frame)
 
p.main = function(frame)
   return url("https://en.wikipedia.org/wiki/Special:UserLogout")
+
    return url("https://en.wikipedia.org/wiki/Special:UserLogout")
 
end
 
end
  
 
return p
 
return p
 
</source>
 
</source>

Revision as of 22:26, 30 August 2019

  1. REDIRECT Template:High-use

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