Templet:Flagicon/doc

This is the documentation page for Templet:Flagicon.
This page is not intended to be viewed directly. Links using variables may appear broken; do not replace these with w:en:hardcoded page names or URLs.

Description

Displays a flag of the named parameter in "icon" size, currently 22x20 pixels plus a one pixel border. The image also has an en:alt attribute (usually "Flag of <name>"), which is displayed by most browsers by hovering over the flag image, or interpreted by en:screen reader software.

Usage

{{flag|name|variant=|size=}}

Parameters

name — The first parameter is mandatory, 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 Italy is used when the name parameter is specified as Italy. Many flags are also available via shortened "aliases", such as standard three letter country codes as specified by en: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 — 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 Italy includes a description of each of the available flag variations for Italy. This parameter can be a named parameter (e.g. "variant=1861"), 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|Italy}}
{{flagicon|ITA}}		Uses the ISO/IOC/FIFA country code
{{flagicon|Italy|1861}}		Specifies a historical flag
{{flagicon|Italy|variant=1861}}
{{flagicon|ITA|naval}}		Specifies the naval ensign
{{flagicon|Italy|size=50px}}		Sets width to 50 pixels
{{flagicon|ITA|naval|size=999x30px}}		Sets height to 30 pixels

Implementation notes

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|Italy}} → — uses Template:Country data Italy
• {{flagicon|ITA}} → — uses Template:Country data ITA, which is a redirect to Template:Country data Italy

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, Italy).
  • {{flag|Italy}} →  Italy
  • {{flag|ITA}} →  ITA
• Template:flagcountry 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.
  • {{flagcountry|Italy}} →  Itali
  • {{flagcountry|ITA}} →  Itali