Template:Linkflag/doc

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

Template:Linkflag displays a flag of the named parameter in "icon" size, currently 23×15 pixels maximally (defined in Template:Linkflag/core), plus a one-pixel border. The image also has a clickable link to the article set in a parameter . For the default link, use Template:Flag icon, and for an unlinked flag icon, use Template:Flag decoration instead.

Please consider the Manual of Style section on flags before using this template.

Usage

{{linkflag|name|link=|variant=|size=}}

name: The first parameter is mandatory, and identifies the name of the country, region, city, etc. A full list of available values can be found in Category:Country data templates. For example, Template:Country data Bulgaria is used when the name parameter is specified as Bulgaria. Many flags are also available via shortened "aliases", such as standard three-letter country codes as specified by ISO 3166-1 alpha-3, IOC, or FIFA. The list of available "aliases" is found in Category:Country data redirects. Many of these country codes could be considered obscure, so it is recommended to use the full country name.

link: The second parameter is optional, and identifies an article the flag icon should be linked to.

variant: The third parameter is optional, and identifies a flag variant to be used instead of the standard flag. This is most often used for historical flags but can also be used to specify naval flags, sport-use flags, etc. The list of available flag variants for each country is documented on the specific page for the country data template. For example, Template:Country data Bulgaria includes a description of each of the available flag variations for Bulgaria. This parameter can be a named parameter (e.g.. "variant=1815"), or a positional parameter, always after the country name.

size: This parameter is optional, and is used to specify the maximum width and/or height of the flag image. This parameter is specified using standard image syntax.

Template data

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

TemplateData for Linkflag

This template displays a wikilinked flag of the named parameter in 'icon' size, currently 23×15 pixels (defined in Template:Linkflag/core) plus a one-pixel border.

Template parameters
Parameter		Description	Type	Status
Name	`1` `name` `alias`	Name of the country, region, city, etc.; full name is recommended for countries	String	required
Link	`2` `link`	Identifies an article to be linked to instead of the country or flag article, e.g. Bastille Day	String	suggested
Variant	`3` `variant`	Identifies a flag variant to be used instead of the standard flag, e.g. 1815	String	optional
Maximum dimension	`size`	The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)	String	optional

Examples

Wikicode	Results	Notes
`{{linkflag\|Bulgaria}}`		default
`{{linkflag\|BUL\|Sport in Bulgaria}}`		Uses the ISO/IOC/FIFA country code
`{{linkflag\|Bulgaria\|Republic of Bulgaria\|1946}}`		Specifies a historical flag
`{{linkflag\|Bulgaria\|link=Republic of Bulgaria\|variant=1946}}`		Specifies a historical flag
`{{linkflag\|BUL\|navy\|naval}}`		Specifies the naval ensign
`{{linkflag\|BUL\|air force\|air force}}`		Specifies the air force flag
`{{linkflag\|Bulgaria\|size=50px}}`		Sets width to 50 pixels
`{{linkflag\|BUL\|navy\|naval\|size=x30px}}`		Sets height to 30 pixels

Implementation notes

This template uses the data templates listed under Category:Country data templates, which contain the data specifying what to display and the formatter Template:Linkflag/core, which contains the logic of how to display the flag.

{{linkflag|Bulgaria}} → — uses Template:Country data Bulgaria
{{linkflag|BUL}} → — uses Template:Country data BUL, which is a redirect to Template:Country data Bulgaria

Inside each country data template, this template uses the following parameters:

flag alias — name of the image file to display
flag alias-xxxx — name of the image file of flag variant xxxx
alias — used to display the alt attribute of the image (defaults to "Flag of alias")

Related templates

Template:Flag is used to display a wikilinked name next to the flag. The displayed name will be the same as the parameter used with the template, but the link target will be the main article for the country (in these examples, Bulgaria).
- {{flag|Bulgaria}} → Bulgaria
- {{flag|BUL}} → BUL
Template:Flag country is also used to display a wikilinked name next to the flag. The displayed name will always be the same, regardless of whether or not a country code alias is used as the template parameter.
- {{flag country|Bulgaria}} → Bulgaria
- {{flag country|BUL}} → Bulgaria
Template:Flag decoration displays an unlinked flag icon without country name.
- {{flag decoration|Bulgaria}} →

For a full list of flag templates, see Category:Flag template system.