Template:Flag/doc: Difference between revisions

Jump to navigation Jump to search
No edit summary
m (Protected "Template:Flag/doc": High traffic page ([Edit=Allow only trusted users] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(No difference)

Latest revision as of 22:08, 17 June 2024

This template is used to display a small flag icon next to a wikilinked country name. It is related to the {{flagicon}}, {{flagcountry}} and {{flagu}} templates, but offers more options in terms of the text string displayed.

See Wikipedia: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 at ISO 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 as Template:Country data Germany
  • alternative text string, this optional value, specified by the name parameter, is used to display alternative text
  • size, this optional value is specified by the size parameter, and is used to specify the maximum width and/or height of the flag image. This parameter is specified using standard image syntax.

See the prefix index for the templates latently called by this one.

Examples

Wiki markup Displays Notes
{{flag|United States}}  United States Note that both instances link to United States.
{{flag|USA}}  USA
{{flag|Bangladesh}}  Bangladesh
{{flag|Germany}}  Germany All three instances link to Germany.
In addition to the ISO country codes, those used by FIFA, 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|BAN|1971}}  BAN
{{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 the European Union.
A complete list can be found at Category: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

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Flag

This template displays a small flag icon next to a wikilinked country name

Template parameters

ParameterDescriptionTypeStatus
Country identifier1

Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code

Stringrequired
Variant2

Identifies a flag variant to be used instead of the standard flag, e.g. 1815

Stringoptional
Alternative textname

Display alternative text instead of the standard country name

Stringoptional
Maximum dimensionsize

The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)

Stringoptional

See: Wikipedia:Extended image syntax.

See also

Template Description Example
{{Coat of arms}} displays coat of arms image  Germany
{{Flagcountry}} always expands the link text to the full country name  wikipedia:Germany
{{Flagu}} does not link the country name  Germany
{{Flagicon}} displays the flag only, linked to the country name wikipedia:Germany
{{Flagdeco}} displays an unlinked flag icon only
{{Flagc}} links the flag image to its description page flag Germany
{{Flaglist}} aligns country names correctly in vertical lists (see that template's documentation) Germany
{{Flagteam}} adds country code in parentheses after linked country name  wikipedia:Germany (GER)
{{Flagathlete}} displays the flag and another name, followed country name or code  Dirk Nowitzki (GER)
{{Flagmedalist}} displays the flag and a name, above linked country name and code Dirk Nowitzki
 wikipedia:Germany

See Wikipedia:WikiProject Flag Template#List for a longer list of flag templates.

Multi-sport templates

Output style → Country name Country (code) Athlete (country) Athlete
Country
Country code
Olympic Games {{FlagIOC}} {{FlagIOCteam}} {{FlagIOCathlete}} {{FlagIOCmedalist}} {{FlagIOCshort}}
Other games {{FlagIOC2}} {{FlagIOC2team}} {{FlagIOC2athlete}} {{FlagIOC2medalist}} {{FlagIOC2short}}
Paralympic Games {{FlagIPC}} {{FlagIPCteam}} {{FlagIPCathlete}} {{FlagIPCmedalist}} {{FlagIPCshort}}
Pan American {{FlagPASO}} {{FlagPASOteam}} {{FlagPASOathlete}} {{FlagPASOmedalist}}
Parapan American {{FlagPPASO}}
Commonwealth {{FlagCGF}} {{FlagCGFteam}} {{FlagCGFathlete}} {{FlagCGFmedalist}}
Southeast Asian {{FlagSEAGF}} {{FlagSEAGFteam}} {{FlagSEAGFathlete}} {{FlagSEAGFmedalist}}
World Games {{FlagIWGA}}
Central American and Caribbean Games {{FlagCAC}}
Asian Games {{FlagOCA}}
"Nation at Championships"-style {{FlagATHCH}} {{FlagATHCHathlete}}
Generic {{Flag}} {{Flagteam}} {{Flagathlete}} {{Flagmedalist}}
Generic (variant) {{Flaglink}} {{Flaglinkmedalist}}