This is a documentation subpage for Template:Format link. It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 13,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:Format link (sandbox) Module:Urldecode

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 link, display, and target respectively. Links to categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.

Link only:

{{format link|link}}

Link plus display:

{{format link|link|display}}

Link with an italicized page name:

{{format link|link|italicizepage=yes}}

Link with an italicized section name:

{{format link|link|italicizesection=yes}}

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

{{format link|1=link|2=display}}

Link with a target override:

{{format link|link|display|target}}

Link with parameters supplied by name:

{{format link|link=link|display=display|target=target}}

URL formatting:

This template replaces any underscores with spaces and decodes any URL parts in {{format link}}'s output. For example:

• {{format linkr|People_of_the_Philippines_v._Santos,_Ressa_and_Rappler#Santos_Jr.'s_article|italicizepage=y}}

People of the Philippines v. Santos, Ressa and Rappler § Santos Jr.'s article

|nud= (no URL decode) can be added to disable URL decoding but still get underscores replaced:

• {{format linkr|%E6%9C%AA%E6%9D%A5%E6%97%A5%E8%A8%98#M%61_nga|nud=y}}

%E6%9C%AA%E6%9D%A5%E6%97%A5%E8%A8%98 § M%61 nga

• {{format link|Lion}} → [[Lion]] → Lion
• {{format link|Lion#Etymology}} → [[Lion#Etymology|Lion § Etymology]] → Lion § Etymology
• {{format link|Category:Lions}} → [[:Category:Lions]] → Category:Lions
• {{format link|Lion#Etymology|Etymology of lion}} → [[Lion#Etymology|Etymology of lion]] → Etymology of lion
• {{format link|#Bar|Foo#Bar}} → [[:Foo#Bar|§ Bar]] → § Bar
• {{format link|Quo warranto#Philippines|italicizepage=true}} → [[Quo warranto#Philippines|<i>Quo warranto</i> §&nbsp;Philippines]] → Quo warranto § Philippines
• {{format link|Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|italicizesection=true}} → [[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&nbsp;<i>Disini v. Secretary of Justice</i>]] → Cybercrime Prevention Act of 2012 § Disini v. Secretary of Justice
• {{format link}} → Error: no link or target specified! (help)

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

• {{Section link}}
• {{formatter link}} – a template for applying a Wikidata formatter URL (P1630)