Template:Flagicon

Jump to navigation Jump to search


Template documentation


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

Usage

{{flagicon|name|variant=|size=|noredlink=}}

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.
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 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 documentation for this template used by VisualEditor and other tools.

Flagicon

[[Category:Templates using TemplateData{{#translation:}}]]

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

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Name1

Name of the country, region, city, etc.; full name is recommended for countries

Stringrequired
Variantvariant 2

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

Stringoptional
Maximum dimensionsize

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

Stringoptional
No redlinknoredlink

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)

Stringoptional

Examples

Wikicode Results Notes
{{flagicon|Bulgaria}} Bulgaria
{{flagicon|BUL}} Template:Country data BUL Uses the ISO/IOC/FIFA country code
{{flagicon|Bulgaria|1946}} Bulgaria Specifies a historical flag
{{flagicon|Bulgaria|variant=1946}} Bulgaria
{{flagicon|BUL|naval}} Template:Country data BUL Specifies the naval ensign
{{flagicon|BUL|air force}} Template:Country data BUL Specifies the air force flag
{{flagicon|Bulgaria|size=50px}} Bulgaria Sets width to 50 pixels
{{flagicon|Xanadu}} Template:Country data Xanadu No flag for Xanadu, so displays redlink
{{flagicon|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:Flagicon/core, which contains the logic of how to display the flag.

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")

Tracking categories

Where {{Flagicon|Foo}} is used, but the Template:Country data Foo does not exist, then a redlink is displayed, unless the |noredlink=yes parameter has been set.

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

Related templates

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

Alternatives to avoid the Post-expand include size limit

Pages with many flag icons may come close to or exceed the Post-expand include size limit. In these cases consider using modules or module-wrapper templates instead:

  • {{flagg}} is a simple wrapper for Module:Flagg: For basic use, {{flagicon|country}} can be replaced with {{flagg|cxxlo|country}}

See also