This template is used to display a small flag icon next to a wikilinked country name. It is related to the{{flag icon}},{{flag country}} and{{flagu}} templates, but offers more options in terms of the text string displayed.
SeeWikipedia:WikiProject Flag Template for the main documentation/discussion page for the flag templates system.
Usage
{{flag|country identifier|optional variant|name=alternative text string|size=maximum width and/or height of the flag image}}
- country identifier is the common name of the country (e.g. "United States"), a common alias (e.g. "US"), or a standard country code such as those listed atISO 3166-1 alpha-3
- variant is an optional second parameter that can be used to display a flag variation, such as a historical flag. The list of variants for each country is documented on the appropriate template page, such asTemplate:Country data Germany
- alternative text string, this optional value, specified by thename parameter, is used to display alternative text
- size, this optional value is specified by thesize parameter, and is used to specify the maximum width and/or height of the flag image. This parameter is specified using standardimage syntax.
Seethe prefix index for the templates latently called by this one.
Examples
Wiki markup | Displays | Notes |
---|
{{flag|United States}} | United States | Note that all instances link toUnited States. |
{{flag|US}} | US |
{{flag|USA}} | USA |
{{flag|Germany}} | Germany | All three instances link toGermany. In addition to the ISO country codes, those used byFIFA,IOC, etc. are also supported. |
{{flag|DEU}} | DEU |
{{flag|GER}} | GER |
{{flag|Germany|empire}} | Germany | Flag variations can be used with either country names or country codes. |
{{flag|DEU|empire}} | DEU |
{{flag|CAN|name=Canadian}} | Canadian | The name parameter can be used to change the display string but keep the link to the correct article. |
{{flag|Canada|1957|name=Canadian}} | Canadian | The name parameter can also be used when flag variants are specified. |
{{flag|Texas}} | Texas | Flags are also available for several sub-national and multi-national entities such as US states, Canadian provinces, and theEuropean Union. A complete list can be found atCategory:Country data templates. |
{{flag|British Columbia|name=BC}} | BC |
{{flag|EU}} | EU |
{{flag|Switzerland|size=14px}} | Switzerland | The size parameter can be used to control the image dimensions. 23×15px is the default size for most countries (some entities have a different default size). |
{{flag|Switzerland|size=28px}} | Switzerland |
{{flag|Nepal}} | Nepal | Some flags arenon-quadrilateral. |
Pages with many flags may come close to or exceed Wikipedia'sPost-expand include size limit. In these cases consider using modules or module-wrapper templates instead:
- For many countries, using the country code as the template name will act as a wrapper forModule:Flagg: For example,
{{flag|''USA''}}
can be replaced with{{USA}}
, which has an include size that is about 15% smaller. - {{#invoke:flag||}} is a wrapper forModule:Flagg that can further reduce sizes when invoked directly. For basic use,
{{flag|country}}
can be replaced with{{#invoke:flag||country}}
which has an include size that is about half.
TemplateData
Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter | Description | Type | Status |
---|
Country identifier | 1 | Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code
| String | required |
---|
Variant | 2 variant | Identifies a flag variant to be used instead of the standard flag, e.g. 1815
| String | optional |
---|
Alternative text | name | Display alternative text instead of the standard country name
| String | optional |
---|
Maximum dimension | size | The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)
| String | optional |
---|
See:Wikipedia:Extended image syntax.
See also
SeeWikipedia:WikiProject Flag Template#List for a longer list of flag templates.
Multi-sport templates
See also
Module-based versions which can be used to reduce thepost-expand include size on pages that are near or exceed the limit.