View source for Template:Flag icon/doc

{{documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{high-use}}

'''Template:{{TEMPLATENAME}}''' displays a flag of the named parameter in "icon" size, currently 23×15 pixels maximally (defined in [[Template:{{TEMPLATENAME}}/core]]), plus a one-pixel border. The image also has a clickable link to the associated article. For an unlinked flag icon, use [[Template:Flag decoration]] instead.

Please consider the [[Wikipedia:Manual of Style (icons)#Flags|Manual of Style section on flag]]s before using this template.

==Usage==
{{tlc|{{TEMPLATENAME}}|<var>name</var>|variant{{=}}|size{{=}}|noredlink{{=}}}}

;{{para|1|<var>name</var>}}: 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 Peru]] is used when the ''name'' parameter is specified as <code>Peru</code>. Many flags are also available via shortened "aliases", such as standard three-letter country codes as specified by [[ISO 3166-1 alpha-3]], [[List of IOC country codes|IOC]], or [[List of FIFA country codes|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.
;{{para|variant}}: The second 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 Peru]] includes a description of each of the available flag variations for Peru. This parameter can be a named parameter (e.g.. "<code>variant=1815</code>"), or a positional parameter, always after the country name.
;{{para|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 [[Wikipedia:Extended image syntax|image syntax]].

==Template data==
{{TemplateData header}}
<templatedata>
{
	"description": "This template displays a wikilinked flag of the named parameter in 'icon' size, currently 23×15 pixels (defined in Template:flag icon/core) plus a one-pixel border.",
	"params": {
		"1": {
			"label": "Name",
			"description": "Name of the country, region, city, etc.; full name is recommended for countries",
			"type": "string",
			"required": true
		},
		"variant": {
			"label": "Variant",
			"description": "Identifies a flag variant to be used instead of the standard flag, e.g. 1815",
			"type": "string",
			"required": false,
			"aliases": [
				"2"
			]
		},
		"size": {
			"label": "Maximum dimension",
			"description": "The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)",
			"type": "string",
			"required": false
		},
		"noredlink": {
			"label": "No redlink",
			"description": "If set to any value which evaluates as true (i.e. '1', 'true', 'yes', or 'y'), it displays nothing if the country data file doesn't exist. (The default is to display a redlink)",
			"type": "string",
			"required": false
		}
	}
}
</templatedata>

==Examples==
{| class="wikitable"
! Wikicode !! Results !! Notes
|-
| <code><nowiki>{{flag icon|Peru}}</nowiki></code> || {{flag icon|Peru}} ||
|-
| <code><nowiki>{{flag icon|PER}}</nowiki></code> || {{flag icon|PER}} || Uses the ISO/IOC/FIFA country code
|-
| <code><nowiki>{{flag icon|Peru|1822}}</nowiki></code> || {{flag icon|Peru|1822}} || rowspan="2"| Specifies a historical flag
|-
| <code><nowiki>{{flag icon|Peru|variant=1822}}</nowiki></code> || {{flag icon|Peru|variant=1822}}
|-
| <code><nowiki>{{flag icon|PER|naval}}</nowiki></code> || {{flag icon|PER|naval}} || Specifies the naval ensign
|-
| <code><nowiki>{{flag icon|PER|air force}}</nowiki></code> || {{flag icon|PER|air force}} || Specifies the air force flag
|-
| <code><nowiki>{{flag icon|Peru|size=50px}}</nowiki></code> || {{flag icon|Peru|size=50px}} || Sets width to 50 pixels
|-
| <code><nowiki>{{flag icon|Xanadu}}</nowiki></code> || [[Template:Country data Xanadu]] || No flag for Xanadu, so displays redlink
|-
| <code><nowiki>{{flag icon|Xanadu|noredlink=yes}}</nowiki></code> || {{flag icon|Xanadu|noredlink=yes}} || No flag, so displays nothing
|}

==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:flag icon/core]], which contains the logic of '''how''' to display the flag.

* <code><nowiki>{{flag icon|Peru}}</nowiki></code> → {{flag icon|Peru}} — uses [[Template:Country data Peru]]
* <code><nowiki>{{flag icon|PER}}</nowiki></code> → {{flag icon|PER}} — uses [[Template:Country data PER]], which is a redirect to [[Template:Country data Peru]]

Inside each country data template, this template uses the following parameters:
* <code>flag alias</code> — name of the image file to display
* <code>flag alias-xxxx</code> — name of the image file of flag variant <code>xxxx</code>
* <code>alias</code> — used to display the [[alt attribute]] of the image (defaults to "Flag of ''alias''")

== Tracking categories ==
*{{clc|Pages using flag icon template with unknown parameters}}

Where <code><nowiki>{{flag icon|Foo}}</nowiki></code> is used, but the <code><nowiki>Template:Country data Foo</nowiki></code> does not exist, then a [[WP:Red link|redlink]] is displayed, ''unless'' the {{para|noredlink|yes}} parameter has been set.

Where the redlink is displayed, the page is added to a tracking category:

* [[:Category:{{BASEPAGENAME}}s missing country data templates]] (population: {{PAGESINCATEGORY:{{BASEPAGENAME}}s missing country data templates}})

==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, [[Peru]]).
** <code><nowiki>{{flag|Peru}}</nowiki></code> → {{flag|Peru}}
** <code><nowiki>{{flag|PER}}</nowiki></code> → {{flag|Peru}}
* [[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.
** <code><nowiki>{{flag country|Peru}}</nowiki></code> → {{flag country|Peru}}
** <code><nowiki>{{flag country|PER}}</nowiki></code> → {{flag country|PER}}
* [[Template:Flag decoration]] displays an unlinked flag icon without country name.
** <code><nowiki>{{flag decoration|Peru}}</nowiki></code> → {{flag decoration|Peru}}
For a full list of flag templates, see [[:Category:Flag template system]].

==Alternatives to avoid Wikipedia's [[WP:PEIS|Post-expand include size]] limit==
Pages with many flag icons may come close to or exceed Wikipedia's [[WP:PEIS|Post-expand include size]] limit.  In these cases consider using modules or module-wrapper templates instead:
* {{template link|flagg}} is a simple wrapper for [[Module:Flagg]]: For basic use, <code><nowiki>{{flag icon|</nowiki>''country''<nowiki>}}</nowiki></code> can be replaced with <code><nowiki>{{flagg|cxxlo|</nowiki>''country''<nowiki>}}</nowiki></code>
* {{module link|flag|icon}} is a wrapper for [[Module:Flagg]] that can further reduce sizes when invoked directly. For basic use, <code><nowiki>{{flag icon|</nowiki>''country''<nowiki>}}</nowiki></code> can be replaced with <code><nowiki>{{#invoke:flag|icon|</nowiki>''country''<nowiki>}}</nowiki></code>.

==See also==
* [[Template:Flagicon image]]
* [[Template:Coat of arms]]
* [[Wikipedia:WikiProject Flag Template]]
* [[Regional indicator symbol]]

<includeonly>{{Sandbox other||
[[Category:Flag template system|icon]]
}}</includeonly>