Jump to content

Template:URL/doc

From Wikisource

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 bbc.co.uk), please do not use this template.

Usage

[edit]
  • {{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 and should not be used.

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 in legacy uses, must also be explicitly numbered if the first parameter is explicitly numbered; otherwise it will override the value of the first parameter.

Note: Instead of hard-coding the URL with this template, the URL can be fetched from the "Official website" property (P856) on Wikidata by using {{Official URL}}. Consider using that template, for infoboxes in particular.

Examples

[edit]
Code Result
{{ URL }} {{URL|example.com|optional display text}}
{{ URL | }} {{URL|example.com|optional display text}}
{{ URL | EXAMPLE.com }} example.com
{{ URL | example.com }} example.com
{{ URL | http://example.com }} example.com
{{ URL | www.example.com }} www.example.com
{{ URL | http://www.example.com }} www.example.com
{{ URL | https://www.example.com }} www.example.com
{{ URL | ftp://www.example.com }} www.example.com
{{ URL | ftp://ftp.example.com }} ftp.example.com
{{ URL | http://www.example.com/ }} www.example.com
{{ URL | http://www.example.com/path }} www.example.com/path
{{ URL | irc://irc.example.com/channel }} irc.example.com/channel
{{ URL | www.example.com/foo }} www.example.com/foo
{{ URL | http://www.example.com/path/ }} www.example.com/path/
{{ URL | www.example.com/foo/ }} www.example.com/foo/
{{ URL | 1=http://www.example.com/path?section=17 }} www.example.com/path?section=17
{{ URL | 1=www.example.com/foo?page=42 }} www.example.com/foo?page=42
{{ URL | www.example.com | example.com }} example.com
{{ URL | http://www.example.com/foo | link }} link (Deprecated)
{{ URL | www.example.com/foo | link }} link (Deprecated)
{{ URL | http://www.example.com/foo/ | link }} link (Deprecated)
{{ URL | www.example.com/foo/ | link }} link (Deprecated)

Microformat

[edit]

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

TemplateData

[edit]
This is the TemplateData documentation for this template used by VisualEditor and other tools.

URL

A template to display and format a URL

Template parameters

ParameterDescriptionTypeStatus
URL1

The URL to be linked

Stringrequired
Display text2

The text to be displayed instead of the URL. Deprecated

Stringdeprecated

See also

[edit]