Difference between revisions of "Module:URL/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Zyxw
(add link to second template implemented via this module)
blackwiki>Artoria2e5
(Document the _url Lua interface; it is pretty frame-independent already)
Line 3: Line 3:
  
 
This module implements {{tl|URL}} and {{tl|URL2}}. Please see the template page for documentation.
 
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 <tt>false</tt>, <tt>n</tt> or <tt>N</tt>, 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 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>

Revision as of 20:12, 14 April 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