View source for Template:Format link/doc

{{Documentation subpage}}
{{lua|Module:Format link}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This template formats a link for use in hatnote templates. It accepts up to three positional parameters, the link, an optional display value, and an optional target override (which if provided, makes the link parameter optional). These parameters may also be supplied by name, as <var>link</var>, <var>display</var>, and <var>target</var> respectively. Links to categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.

This template doesn't work with [[WP:SUBST|subst]].

== Usage ==
'''Link only:'''

{{tlc|format link|''link''}}

'''Link plus display:'''

{{tlc|format link|''link''|''display''}}

'''Link with an italicized page name:'''

{{tlc|format link|''link''|3=italicizepage=yes}}

'''Link with an italicized section name:'''

{{tlc|format link|''link''|3=italicizesection=yes}}

If the link or display values contain an equals sign, you will need to specify the parameter names like this:

{{tlc|format link|2=1=''link''|3=2=''display''}}

'''Link with a target override:'''

{{tlc|format link|''link''|''display''|''target''}}

'''Link with parameters supplied by name:'''

{{tlc|format link|2=link=''link''|3=display=''display''|4=target=''target''}}

== Examples ==
* {{tlc|format link|Lion}} → <nowiki>[[Lion]]</nowiki> → {{format link|Lion}}
* {{tlc|format link|Lion#Etymology}} → <nowiki>[[Lion#Etymology|Lion §&amp;nbsp;Etymology]]</nowiki> → {{format link|Lion#Etymology}}
* {{tlc|format link|Category:Lions}} → <nowiki>[[:Category:Lions]]</nowiki> → {{format link|Category:Lions}}
* {{tlc|format link|Lion#Etymology|Etymology of lion}} → <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> → {{format link|Lion#Etymology|Etymology of lion}}
* {{tlc|format link|#Bar||Foo#Bar}}  → <nowiki>[[:Foo#Bar|§&amp;nbsp;Bar]]</nowiki> → {{format link|#Bar||Foo#Bar}}
* {{tlc|format link|Quo warranto#Philippines|3=italicizepage=true}} → <nowiki>[[Quo warranto#Philippines|<i>Quo warranto</i> §&amp;nbsp;Philippines]]</nowiki> → {{format hatnote link|Quo warranto#Philippines|italicizepage=true}}
* {{tlc|format link|Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|3=italicizesection=true}} &rarr; <nowiki>[[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&amp;nbsp;<i>Disini v. Secretary of Justice</i>]]</nowiki> &rarr; {{format hatnote link|Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|italicizesection=true}}
* {{tlc|format link}} → {{format link|category=no}}

== Errors ==
If this template is used and neither the <var>link</var> parameter (or positional parameter 1) nor the <var>target</var> parameter (or positional parameter 3) is supplied, then the template will return an error message. At least one of those must be supplied.

== See also ==
* {{tl|Format linkr}} – an arguably better version of this template which converts underscores to spaces and calls {{tl|urldecode}} on the input
* {{tl|Section link}}
<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>

[[Category:Template documentation pages|Format link/doc]]