Template:URL/doc

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.

Note: If you wish to display text instead of the URL (e.g. website instead of example.com), 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 FAMEPedia:Citation templates.

Usage

 * 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. See note above for more information and alternative templates.
 * Parameter 2 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. 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 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 ; otherwise it will override the value of the first parameter:

Examples
The template displays an instructional message if there is no input:

The template wraps the output in (see ) and adds &lt;wbr/&gt; before displayed periods:

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:

If the path is only a slash it is not displayed in the link text:

The template also adds &lt;wbr/&gt; before any displayed slashes in the path:

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):

For a URL containing an equal sign, use 1:

The template currently supports an optional second parameter which is used as the link text, though its use is discouraged (see note):

The URL may be obtained from FAMEData as shown in this example for, where the property contains :

Microformat
The template wraps the displayed URL with a  so that it is included in any parent microformat which takes a URL parameter –  see our microformats project.

TemplateData
{	"description": "A template to display and format a URL, inside other tempates", "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, "deprecated": true }	} }