View source for Template:Form-url/doc

<noinclude>{{doc subpage}}[[Category:Template documentation]]</noinclude>
== Documentation ==

This template forms full URLs from individual parts. It mostly exists to be called by other templates, but can be used to display a "bare URL" on a page, if that seems necessary. (Sometimes trying to "save" a page that has a bare URL on it can cause [[MediaWiki]] to flag the edit as spam. This may or may not be true on this wiki. In any case, if you have that problem, you can "hide" the URL from the spam filter by breaking it up and using this template.)

=== Usage ===

* {{tc-var|form-url|protocol|domain|path|query}}
* {{tc-names|form-url|protocol|domain|path|query|url}}

Note that the first positional parameter is the protocol to be used, '''not''' the domain (see the [[#Errors|errors]] below). The protocol can be either {{tpv|https}} or {{tpv|http}} (or, well, other things, but nevermind). Notice how the protocol should '''not''' include the final colon ({{code|:}}), as that is provided by the template.

The {{tp|url}} parameter, which would contain a full URL already, is here just for convenience, to allow templates that call this one to accept either a full URL or one specified in pieces, without needing to have the if-then-else logic necessary to support that.

Technically, none of the parameters are required, but at minimum a domain is necessary to result in a valid URL.

=== Examples ===

* {{tc|form-url|{{null}}|www.angelinajordanofficial.com}} ⇒ {{form-url||www.angelinajordanofficial.com}}
* {{tc|form-url|{{null}}|www.angelinajordanofficial.com|book}} ⇒ {{form-url||www.angelinajordanofficial.com|book}}
* {{tc|form-url|domain{{=}}www.angelinajordanofficial.com|path{{=}}book}} ⇒ {{form-url|domain=www.angelinajordanofficial.com|path=book}}
* {{tc|form-url|protocol{{=}}http|domain{{=}}www.angelinajordanofficial.com|path{{=}}book}} ⇒ {{form-url|protocol=http|domain=www.angelinajordanofficial.com|path=book}}
* {{tc|form-url|https|youtube.com|watch|<nowiki>v{{=}}nwFloCPXzCs</nowiki>}} ⇒ {{form-url|https|youtube.com|watch|v{{=}}nwFloCPXzCs}}
* {{tc|form-url|https|youtube.com|watch|<nowiki>{{qs|v|nwFloCPXzCs}}</nowiki>}} ⇒ {{form-url|https|youtube.com|watch|{{qs|v|nwFloCPXzCs}}}}
* {{tc|form-url|https|youtube.com|watch|4{{=}}v{{=}}nwFloCPXzCs}} ⇒ {{form-url|https|youtube.com|watch|4=v=nwFloCPXzCs}}
* {{tc|form-url|https|youtube.com|<nowiki>watch{{?|v|nwFloCPXzCs}}</nowiki>}} ⇒ {{form-url|https|youtube.com|watch{{?|v|nwFloCPXzCs}}}}
* {{tc|form-url|protocol{{=}}https|domain{{=}}youtube.com|path{{=}}watch|query{{=}}v{{=}}nwFloCPXzCs}} ⇒ {{form-url|protocol=https|domain=youtube.com|path=watch|query=v=nwFloCPXzCs}}

Note the empty first positional parameter in the first two examples. This means the protocol is not being specified, which results in {{w|Protocol-relative URL|protocol-relative}} URLs. As you can see, these are not automatically linked by MediaWiki, as bare HTTP and HTTPS URLs are.

The examples forming YouTube URLs show several ways you can specify a query string containing an equal sign. The second-to-last one, which is calling {{tc|?}}, is actually passing the path and query string information together in the 3rd positional parameter (i.e., as the {{tpvv|path}} value). See also the documentation of {{tl|qs}} and {{tl|?}}.

==== Bad calls ====

* {{tc|form-url}} ⇒ {{form-url}}
* {{tc|form-url|www.angelinajordanofficial.com|book}} ⇒ {{form-url|www.angelinajordanofficial.com|book}}

The first example doesn't give a working URL. The second accidentally uses a domain in the position where the template expects a protocol.

<includeonly>
[[Category:Templates]]
[[Category:Templates mostly called by other templates]]
[[Category:Templates for creating links]]
</includeonly>