Template:URL/doc

{{#invoke:Fallback | autotranslate

      |base = Documentation subpage
      |lang = 
      |page = Template:URL
    }}

{{

 {{#invoke:Namespace detect|main}}

| type = | image = 42px | imageright = | class = | style = | textstyle = | text = This template uses Module:URL, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = | name = }}

This template can be used to create a formatted external link.

Note - this template is for formatting the appearance of displayed URLs, while making them machine-readable as part of emitted microformat meta-data.

If you wish to display text instead of the URL (e.g. "BBC website" instead of {{#invoke:URL|url|1=bbc.co.uk|2=}}), please do not use this template.

For web-based references, please see Wikipedia:Citation templates

Usage

• {{URL|1=url name|2=optional display text}}
  • The first parameter is parsed to see if it takes the form of a complete URL. If it doesn't start with a URI scheme (such as "http:", "https:", or "ftp:"), an "http://" prefix will be prepended to the specified generated target URL of the link.
  • Parameter 2 is deprecated.

Warning: The parameter 1 must be numbered explicitly if the URL contains an equal sign, as is common in the query string. This applies when the value of the URL is unknown, for example when this template is used in another template specifying the effective URL as a variable value. The deprecated second parameter for the displayed text, if present, must also be explicitly numbered if the first parameter is explicitly numbered; otherwise it will override the value of the first parameter.

Examples

Code	Result
{{ URL }}	url|1=|2=}}
{{ URL | }}	url|1= |2=}}
{{ URL | EXAMPLE.com }}	url|1= EXAMPLE.com |2=}}
{{ URL | example.com }}	url|1= example.com |2=}}
{{ URL | www.example.com }}	url|1= www.example.com |2=}}
{{ URL | http://www.example.com }}	url|1= http://www.example.com |2=}}
{{ URL | https://www.example.com }}	url|1= https://www.example.com |2=}}
{{ URL | ftp://www.example.com }}	url|1= ftp://www.example.com |2=}}
{{ URL | ftp://ftp.example.com }}	url|1= ftp://ftp.example.com |2=}}
{{ URL | http://www.example.com/ }}	url|1= http://www.example.com/ |2=}}
{{ URL | http://www.example.com/path }}	url|1= http://www.example.com/path |2=}}
{{ URL | irc://irc.example.com/channel }}	url|1= irc://irc.example.com/channel |2=}}
{{ URL | www.example.com/foo }}	url|1= www.example.com/foo |2=}}
{{ URL | http://www.example.com/path/ }}	url|1= http://www.example.com/path/ |2=}}
{{ URL | www.example.com/foo/ }}	url|1= www.example.com/foo/ |2=}}
{{ URL | 1=http://www.example.com/path?section=17 }}	url|1=http://www.example.com/path?section=17%7C2=}}
{{ URL | 1=www.example.com/foo?page=42 }}	url|1=www.example.com/foo?page=42|2=}}
{{ URL | http://www.example.com/foo | link }}	url|1= http://www.example.com/foo |2= link }} (Deprecated)
{{ URL | www.example.com/foo | link }}	url|1= www.example.com/foo |2= link}} (Deprecated)
{{ URL | http://www.example.com/foo/ | link }}	url|1= http://www.example.com/foo/ |2= link }} (Deprecated)
{{ URL | www.example.com/foo/ | link }}	url|1= www.example.com/foo/ |2= link}} (Deprecated)

Microformat

The template wraps the displayed URL with a class="url" so that it is included in any parent microformat which takes a URL parameter - see our microformats project.

TemplateData

This is the TemplateData documentation for the template used by the new VisualEditor.

URL <templatedata>{ "description": "A template to display and format a URL", "params": {

 "1": {
   "label": "URL",
   "description": "The URL to be linked",
   "type": "string",
   "required": true
 },
 "2": {
   "label": "Display text",
   "description": "The text to be displayed instead of the URL. Deprecated",
   "type": "string",
   "required": false
 }

}}</templatedata>

See also

• {{official website}}
• {{plain link}}