Module:URL/doc

This is the documentation page for Module:URL

This Lua module is used on 669,000+ pages, or roughly 48199% 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.

{{#if:protected|{{#switch:m |m

|t =

{{#switch: protected

  | pre-alpha | prealpha | pa | experimental = File:Ambox warning blue construction.svg
  | alpha | a                                = File:Greek lc alpha icon.svg
  | beta | b                                 = File:Greek lc beta icon.svg
  | release | r | general | g | stable | protected | protect | p | semiprotected | semiprotect | semi = File:Green check.svg
  | broken | br | unstable = File:Red x.svg
  | deprecated | d | defunct = File:Historical.svg

}}

{{#switch: protected

  | pre-alpha | prealpha | pa | experimental = This module is rated as pre-alpha. It is incomplete and may or may not be in active development. Do not use it in article namespace pages. A module remains in pre-alpha until its developer, or another editor who adopts it if it is abandoned for some time, considers the basic structure complete.
  | alpha | a                 = This module  is rated as alpha. It is ready for limited use and third-party feedback. It may be used on a small number of pages, but should be monitored closely. Suggestions for new features or adjustments to input and output are welcome.
  | beta | b                  = This module  is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected.
  | release | r | general | g | stable | protected | protect | p | semiprotected | semiprotect | semi = This module  is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
  | broken | br | unstable    = This module  is rated as unstable. It has missing dependencies, compatibility issues, or output errors that make it unusable. Editors are encouraged to improve its compatibility or nominate it for deletion if it cannot be fixed.
  | deprecated | d | defunct  = This module  is rated as deprecated and defunct.{{#if:|{{#iferror:{{#expr:1}}
 |{{#switch:{{{1}}}
    |fig= 
    |en= 
    |em= 
    |thin= 
    |hair= 
    | 
  }}
 |{{#switch:{{{2}}}
    |fig= 
    |en= 
    |em= 
    |thin= 
    |hair= 
    | 
  }}

}}It is recommended editors use [[{{{replaced}}}]].}}{{#if:|{{#iferror:{{#expr:1}}

 |{{#switch:{{{1}}}
    |fig= 
    |en= 
    |em= 
    |thin= 
    |hair= 
    | 
  }}
 |{{#switch:{{{2}}}
    |fig= 
    |en= 
    |em= 
    |thin= 
    |hair= 
    | 
  }}

}}{{{message}}}}}

  | #default                  = Page using Template:Template rating with invalid template or module rating in |{{SAFESUBST:#if:1|1=}} parameter.

}}

{{#if:||

     {{#switch: doc
        | doc | sandbox =
        | {{#ifeq:  | true 
            |  
            | {{#switch: protected
                | pre-alpha | prealpha | pa | experimental = 
                | alpha | a                                = 
                | beta | b                                 = 
                | release | r | general | g | stable | protected | p | semiprotected | semiprotect | semi = 
                | deprecated | d | defunct =

| broken | br | unstable =

              }}
          }}
      }}

}} | #default = }}|}}{{#switch:m |t|m = {{#if:

          |
          |{{#switch:Lua error in Module:Effective_protection_level at line 64: attempt to index field 'ext' (a nil value).
               |*|user = 
               |#default = {{#ifeq:doc|doc
                   |Lua error in Module:Effective_protection_level at line 64: attempt to index field 'ext' (a nil value).
                -->|Lua error in Module:Effective_protection_level at line 64: attempt to index field 'ext' (a nil value).}}}}}}

|#default = }}

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 {{#switch:x

 |c|close =
 |e|empty|s|single|v|void
 |o|open
 |p|pair = <{{#if:|wbr|wbr}}{{#if:| {{{attribs}}}}}
}}{{#switch:x
 |c|close = 
 |e|empty|s|single|v|void =  />
 |o|open = >
 |p|pair = {{#ifeq:wbr|!--||>}}...
}}{{#switch:x
 |e|empty|s|single|v|void
 |o|open =
 |c|close
 |p|pair = {{#ifeq:wbr|!--|-->|</wbr>}}
}}. 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>