Teamplaid:Flagicon/doc

This is a documentation subpage for Teamplaid:Flagicon.
It contains usage information, categories and other content that is not part of the original teamplaid page.

Description

Displays a flag of the named parameter in "icon" size, currently 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|variant=|size=}}

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 Roinn-seòrsa:Country data templates. For example, Teamplaid: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 Roinn-seòrsa: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, Teamplaid: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\|Poland}}`	Teamplaid:Dàta brataich Poland
`{{flagicon\|POL}}`	[[Faidhle:{{{Bratach ainm-bréige}}}\|22x20px\|border \|Flag of {{{alias}}}\|link={{{alias}}}]]	Uses the ISO/IOC/FIFA country code
`{{flagicon\|Poland\|1815}}`	Teamplaid:Dàta brataich Poland	Specifies a historical flag
`{{flagicon\|Poland\|variant=1815}}`	Teamplaid:Dàta brataich Poland
`{{flagicon\|POL\|naval}}`	[[Faidhle:{{{Bratach ainm-bréige}}}\|22x20px\|border \|Flag of {{{alias}}}\|link={{{alias}}}]]	Specifies the naval ensign
`{{flagicon\|POL\|air force}}`	[[Faidhle:{{{Bratach ainm-bréige}}}\|22x20px\|border \|Flag of {{{alias}}}\|link={{{alias}}}]]	Specifies the air force flag
`{{flagicon\|Poland\|size=50px}}`	Teamplaid:Dàta brataich Poland	Sets width to 50 pixels
`{{flagicon\|POL\|naval\|size=999x30px}}`	[[Faidhle:{{{Bratach ainm-bréige}}}\|999x30px\|border \|Flag of {{{alias}}}\|link={{{alias}}}]]	Sets height to 30 pixels

Implementation notes

This template uses the data templates listed under Roinn-seòrsa:Country data templates, which contain the data what to display and the formatter Teamplaid:Country flagicon2, which contains the logic how to display the flag.

{{flagicon|Poland}} → Teamplaid:Dàta brataich Poland — uses Teamplaid:Country data Poland
{{flagicon|POL}} → [[Faidhle:{{{Bratach ainm-bréige}}}|22x20px|border |Flag of {{{alias}}}|link={{{alias}}}]] — uses Teamplaid:Country data POL, which is a redirect to Teamplaid: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

Teamplaid: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}} → Teamplaid:Dàta brataich Poland
- {{flag|POL}} → [[Faidhle:{{{flag alias}}}|22x20px|border ]] [[{{{alias}}}|{{{name}}}]]
Teamplaid: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|Poland}} → Teamplaid:Dàta brataich Poland
- {{flagcountry|POL}} → {{{alias}}}