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 is used in MediaWiki:Titleblacklist-custom-URL, and on approximately 338,000 pages, or roughly 3533% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
 | This template uses Lua: |
This template creates 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.
Script error: No such module "anchor".Note: If you wish to display text instead of the URL (e.g. website instead of Script error: No such module "URL".), please do not use this template. Instead, consider using normal wiki markup or Template:Official website. Displaying text instead of the url will render the microformat data invalid.
For web-based references, please see Wikipedia:Citation templates.
Usage
{{URL|example.com}}- The first parameter is parsed to decide whether it is a complete URL. If it doesn't start with a URI scheme (such as "http:", "https:", or "ftp:"), the prefix "http://" is 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 should use numbered parameters
If the URL contains an equals sign, as is common in a query string, the parameter |1= should 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
{{URL | 1=https://example.com/?id=42 }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-2">Script error: No such module "URL".</span></strong>
The template attempts to handle simple cases where a URL containing an equals sign is specified without the necessary |1=, but it is still better practice to pass it in.
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:
{{URL | 1=https://example.com/?id=42 | 2=Title }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-3">Script error: No such module "URL".</span></strong>
Examples
The template displays an instructional message if there is no input:
{{URL| }}→ Script error: No such module "URL".
The template wraps the output in <span class="url">...</span> (see § Microformat) and adds <wbr/> before displayed periods:
{{URL | www.example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-5">Script error: No such module "URL".</span></strong>
The use of http://, https://, a protocol-relative URL, or a different protocol is preserved in the URL but is not shown in the link text:
{{URL | http://www.example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-6">Script error: No such module "URL".</span></strong>
{{URL | https://www.example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-7">Script error: No such module "URL".</span></strong>
{{URL | //www.example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-8">Script error: No such module "URL".</span></strong>
{{URL | ftp://www.example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-9">Script error: No such module "URL".</span></strong>
{{URL | ftp://ftp.example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-10">Script error: No such module "URL".</span></strong>
{{URL | irc://irc.example.com/channel }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-11">Script error: No such module "URL".</span></strong>
If the path is only a slash (/) it is not displayed in the link text:
{{URL | http://example.com/ }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-12">Script error: No such module "URL".</span></strong>
The template also adds <wbr/> before any displayed slashes (/) in the path:
{{URL | example.com/path }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-13">Script error: No such module "URL".</span></strong>
{{URL | https://example.com/path }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-14">Script error: No such module "URL".</span></strong>
{{URL | www.example.com/path/ }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-15">Script error: No such module "URL".</span></strong>
{{URL | https://www.example.com/path/ }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-16">Script error: No such module "URL".</span></strong>
Upper case in the domain name is preserved in the URL, but not in the link text (upper case in the path is not changed):
{{URL | EXAMPLE.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-17">Script error: No such module "URL".</span></strong>
{{URL | ExampleExample.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-18">Script error: No such module "URL".</span></strong>
{{URL | ExampleExample.com/PathPath }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-19">Script error: No such module "URL".</span></strong>
For a URL containing an equal sign (=), use |1=:
{{URL |1= example.com/path?page=42 }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-20">Script error: No such module "URL".</span></strong>
{{URL |1= https://example.com/path?page=42 }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-21">Script error: No such module "URL".</span></strong>
The template currently supports an optional second parameter which is used as the link text, though its use is discouraged (see note):
{{URL | www.example.com | example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-22">Script error: No such module "URL".</span></strong>
{{URL | exampleexample.com | ExampleExample.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-23">Script error: No such module "URL".</span></strong>
{{URL |1= example.com/path?page=42 |2= example.com }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-24">Script error: No such module "URL".</span></strong>
The URL may be obtained from Wikidata as shown in this example for
- REDIRECT Template:Wikidata entity link
 This page is a redirect. The following categories are used to track and monitor this redirect:
|
, where the property (P856) contains :
{{URL | {{Wikidata|property|Q23317|P856}} }}→ Script error: No such module "URL".<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-25">Script error: No such module "URL".</span></strong>
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
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 |
Maintenance categories
See also
- {{URL2}}
- {{#invoke:WikidataIB|url2}}
- {{Official URL}}
- {{Official website}}
- {{Plain link}}
- {{Wbr}}