Module:URL/doc: Difference between revisions
Content deleted Content added
add link to second template implemented via this module |
Artoria2e5 (talk | contribs) 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
 | 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