Template:Format link

Template documentationviewedithistorypurge

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.

Usage

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

<syntaxhighlight lang="wikitext" inline style="display: none;" />|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

Examples

• {{format link|Lion}} → [[Lion]] → Lion
• {{format link|Lion#Etymology}} → [[Lion#Etymology|Lion §&nbsp;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|§&nbsp;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}} →

Errors

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.

See also

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Format link in articles based on its TemplateData.

TemplateData for Format link

<templatedata> { "description": "This template simplifies the process of formatting links from the URL bar by automatically replacing underscores with spaces and decoding URL-encoded parts.", "params": { "1": { "label": "Page", "description": "The name of the page the link points to. It can include a section after a hashtag (#).", "type": "string", "required": true, "aliases": [ "link" ], "example": "Lion#Etymology" }, "2": { "aliases": [ "display" ], "label": "Display", "description": "optional display value", "example": "Etymology of lion", "type": "string" }, "3": { "aliases": [ "target" ], "label": "Target", "description": "optional target override (which if provided, makes the link parameter optional)", "example": "Lion#Etymology", "type": "string" }, "italicizepage": { "label": "Italicize page", "description": "Set to 'y' to italicize the page name.", "type": "string", "required": false, "default": "n" }, "nud": { "label": "No URL Decode", "description": "Set to 'y' to prevent URL decoding, while still replacing underscores with spaces.", "type": "string", "default": "n" }, "keepunderscore": { "deprecated": true } }, "paramOrder": [ "1", "2", "3", "italicizepage", "nud", "keepunderscore" ] } </templatedata>

The above documentation is transcluded from Template:Format link/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.