Template:URL

From CasperTech Wiki
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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

Note - this template is for appearance formatting of URLs, and to add microformat meta-data. For web-references etc 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.
    • If no display text is specified or is empty, a default display text will be inferred by trying to reduce the specified URL without its URI scheme (and without the default "/" path), and the domain name part will be forced to lowercase (for shorter and canonical display, but also to limit the occurrences of easily confusable characters, for example between letters and digits). The rest of the URL (including the path, the query string and the fragment identifier) will be displayed unchanged.
  • {{URL|2=display text}}
    • The url or domain name is optional : if it is not specified in the first parameter or this parameter is empty, the display text becomes mandatory, and will be displayed without any change.
    • If both parameters are missing or empty, a default message referencing a correct usage of this template will be generated (including a link to this page), to help editors.
Warning:
  • The parameters 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 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|example.com|optional display text}}
{{ URL | }} {{URL|example.com|optional display text}}
{{ URL | EXAMPLE.com }} example.com
{{ URL | 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/foo | link }} link
{{ URL | www.example.com/foo | link }} link
{{ 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 | http://www.example.com/foo/ | link }} link
{{ URL | www.example.com/foo/ | link }} link

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.

See also