Template:Flagicon/doc

Description

Displays a flag in "icon" size. The current size is 22x20 pixels plus a one pixel border. The image also has an alt attribute (usually "Flag of name"), which is displayed by Internet Explorer when hovering over the flag image, or interpreted by screen reader software and browsers with images disabled.

Usage

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

name

The first parameter is required, and identifies the name of the country, region, city, etc. A full list of available parameters can be found in Category:Country data templates. For example, Template:Country data Poland is used when the name parameter is specified as Poland. 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" are 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

This parameter is optional, and not used at this time. It 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 Poland includes a description of each of the available flag variations for Poland. 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.

Examples

Wikicode	Results	Notes
{{flagicon|Nowhere}}	Template:Country data Nowhere	Example call with a name that does not have a country data template.
{{flagicon|Poland}}		Using the country name.
{{flagicon|POL}}		Using the ISO/IOC/FIFA country code.
{{flagicon|Poland|1815}}		Using the country name. Specifying a historical flag.
{{flagicon|Poland|variant=1815}}		Using the country name. Specifying a historical flag.
{{flagicon|POL|naval}}		Using the country code. Specifying the naval ensign.
{{flagicon|POL|air force}}		Using the country code. Specifying the air force flag.
{{flagicon|Poland|size=50px}}		Using the country name. Specifying the image width to 50 pixels.
{{flagicon|POL|naval|size=999x60px}}		Using the country code. Specifying the naval ensign. Specifying the image height to 60 pixels.

Implementation notes

This template first checks to make sure that the name parameter was included in the call to the template.

• If it was included, a call is made to the template {{country flagicon}}, passing it the following parameters
  • name
  • name
  • size=(size parameter if specified, else blank)
  • border=true
• If the name parameter was not included, no call to {{country flagicon}} is made.

Note: If {{Flagicon}} is called with a name parameter that does not match up to a template in the format of Template:Country data name, the output displayed will be a red-link in the format Template:Country data name. (Where name is the first parameter passed to the template.) So, {{Flagicon}} will result in the output Template:Country data Nowhere

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

* {{flagicon|Poland}} →  — 
uses Template:Country data Poland
* {{flagicon|POL}} →  — 
uses Template:Country data POL, which is a redirect to Template:Country data Poland

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, Poland).
  • {{flag|Poland}} → Poland
  • {{flag|POL}} → POL
• Template:flagcountry currently displays the same output as Template:flagicon.
  • {{flagcountry|Poland}} → Poland
  • {{flagcountry|POL}} → Poland