View source for Template:URL2/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:URL}}
{{Commons Import}}

This is a fork of [[Template:URL]] for use in infoboxes.

It behaves similarly to {{tl|URL}} with the following exceptions:
* By default it does not display anything if the parameters are blank or omitted. [[Template:URL]] displays {{URL}} by default.
* It implements a parameter {{para|msg}} that turns on or off the message {{url}}. Setting msg to false or anything beginning with n or N will suppress the message. Anything else enables the message.
* It strips html tags and wiki-link markup from the supplied url parameter.
* It truncates the url parameter at the first space it finds.
* It can take its own output as input, allowing website parameters to be wrapped in {{URL2}} in the design of an infobox, without causing problems if editors add <code><nowiki>|website={{URL|some.url.com}}</nowiki></code> in an article.

== Usage ==
* <code><nowiki>{{URL2|</nowiki><var>url</var><nowiki>}}</nowiki></code>
* <code><nowiki>{{URL2|1=</nowiki><var>url</var><nowiki>}}</nowiki></code>

== Examples ==

=== Different from Template:URL ===
If there is no input, the default behavior of URL2 is to display nothing (use {{para|msg}} to display the instructional message):
{{nowiki template demo|format=inline|code=<nowiki>{{URL2| }}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{URL2|msg=yes| }}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{URL2|msg=true| }}</nowiki>}}

URL2 handles formatting commonly found in the {{para|website}} parameter of an infobox:
{{nowiki template demo|format=inline|code=<nowiki>{{URL2|[http://www.example.com]}}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{URL2|http://www.example.com|website}}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{URL2|{{URL|www.example.com}}}}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{URL2|{{URL2|www.example.com}}}}</nowiki>}}

=== Same as Template:URL ===
The template wraps the output in {{tag|span|attribs=class="url"}} (see {{Section link||Microformat}}) and adds [[HTML element#wbr|&lt;wbr/&gt;]] before displayed periods:
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|www.example.com}}</nowiki>}}

The use of [[HTTP|http://]], [[HTTPS|https://]], a [[URL#prurl|protocol-relative URL]], or a different protocol is preserved in the URL but is not shown in the [[link text]]:
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|http://www.example.com}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|https://www.example.com}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|//www.example.com}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|ftp://ftp.example.com}}</nowiki>}}

If the path is only a slash (<code>/</code>) it is not displayed in the link text:
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|https://www.example.com/}}</nowiki>}}

The template also adds [[HTML element#wbr|&lt;wbr/&gt;]] before any displayed slashes (<code>/</code>) in the path:
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|https://www.example.com/path}}</nowiki>}}

For a URL containing an equal sign (<code>=</code>), use {{para|1}}:
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL2|1=http://www.example.com/path?section=17}}</nowiki>}}

== Microformat ==
The template wraps the ''displayed'' URL with <code>class="url"</code> so that it is included in any parent [[microformat]] which takes a URL parameter - see [[Wikipedia:WikiProject Microformats]].

== See also ==
* {{tl|URL}}
For more detail see wikipedia page [[wikipedia:Template:URL2]]


<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:External link templates]]
}}</includeonly>