Template:URL/doc
This is a documentation subpage for Template:URL. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template can be used to create a formatted external link. It formats the appearance of displayed URLs, while making them machine-readable as part of emitted microformat meta-data, inside templates such as infoboxes.
If you wish to display text instead of the URL (e.g. "website" instead of example
For web-based references, please see Citation templates.
Contents
Usage
{{URL|example.com}}
- 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 (
{{URL|url name|optional display text}}
) is deprecated. See note above for more information and alternative templates.
URL with = character requires numbered parameters
If the URL contains an equals sign, as is common in a query string, the parameter |1=
must be used for the URL ({{URL|1=example.com}}
). 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 in legacy uses, must also be explicitly numbered if the first parameter is explicitly numbered ({{URL|1=url name|2=optional display text}}
); otherwise it will override the value of the first parameter.
Code | Result |
---|---|
{{ URL | 1=https://example.com/?id=42 }}
|
example |
{{ URL | 1=https://example.com/?id=42 | 2=Title }}
|
Title |
Examples
To the right of each example is the displayed output. Below each example is the actual output including <span>...</span>
and <wbr/>
tags.
{{URL | EXAMPLE.com }}
→ example.com <span class="url">[http://EXAMPLE.com example<wbr/>.com]</span>
{{URL | example.com }}
→ example.com <span class="url">[http://example.com example<wbr/>.com]</span>
{{URL | http://example.com }}
→ example.com <span class="url">[http://example.com example<wbr/>.com]</span>
{{URL | www.example.com }}
→ www.example .com <span class="url">[http://www.example.com www<wbr/>.example<wbr/>.com]</span>
{{URL | http://www.example.com }}
→ www.example .com <span class="url">[http://www.example.com www<wbr/>.example<wbr/>.com]</span>
{{URL | https://www.example.com }}
→ www.example .com <span class="url">[https://www.example.com www<wbr/>.example<wbr/>.com]</span>
{{URL | ftp://www.example.com }}
→ www.example .com <span class="url">[ftp://www.example.com www<wbr/>.example<wbr/>.com]</span>
{{URL | ftp://ftp.example.com }}
→ ftp.example .com <span class="url">[ftp://ftp.example.com ftp<wbr/>.example<wbr/>.com]</span>
{{URL | http://www.example.com/ }}
→ www.example .com <span class="url">[http://www.example.com/ www<wbr/>.example<wbr/>.com]</span>
{{URL | http://www.example.com/path }}
→ www.example .com /path <span class="url">[http://www.example.com/path www<wbr/>.example<wbr/>.com<wbr/>/path]</span>
{{URL | irc://irc.example.com/channel }}
→ irc.example .com /channel <span class="url">[irc://irc.example.com/channel irc<wbr/>.example<wbr/>.com<wbr/>/channel]</span>
{{URL | www.example.com/foo }}
→ www.example .com /foo <span class="url">[http://www.example.com/foo www<wbr/>.example<wbr/>.com<wbr/>/foo]</span>
{{URL | http://www.example.com/path/ }}
→ www.example .com /path / <span class="url">[http://www.example.com/path/ www<wbr/>.example<wbr/>.com<wbr/>/path<wbr/>/]</span>
{{URL | www.example.com/foo/ }}
→ www.example .com /foo / <span class="url">[http://www.example.com/foo/ www<wbr/>.example<wbr/>.com<wbr/>/foo<wbr/>/]</span>
{{URL | 1=http://www.example.com/path?section=17 }}
→ www.example .com /path?section=17 <span class="url">[http://www.example.com/path?section=17 www<wbr/>.example<wbr/>.com<wbr/>/path?section=17]</span>
{{URL | 1=www.example.com/foo?page=42 }}
→ www.example .com /foo?page=42 <span class="url">[http://www.example.com/foo?page=42 www<wbr/>.example<wbr/>.com<wbr/>/foo?page=42]</span>
{{URL | www.example.com | example.com }}
→ example.com<span class="url">[http://www.example.com example.com]</span>
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 the Wikipedia microformats project.
TemplateData
TemplateData for URL
A template to display and format a URL, inside other tempates
Parameter | Description | Type | Status | |
---|---|---|---|---|
URL | 1 | The URL to be linked | String | required |
Display text | 2 | The text to be displayed instead of the URL. Deprecated | String | deprecated |
See also
- {{Official URL}}
- {{Official website}}
- {{Plain link}}