Template:Flag icon/doc
This is a documentation subpage for Template:Flag icon (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Template:Flag icon displays a flag of the named parameter in "icon" size, currently 23×15 pixels maximally (defined in Template:Flag icon/core), plus a one-pixel border. The image also has a clickable link to the associated article.
Usage[edit]
{{Flag icon|name|variant=|size=|noredlink=}}
|1=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 Peru is used when the name parameter is specified as
Peru
. |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 Peru includes a description of each of the available flag variations for Peru. 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[edit]
TemplateData for Flag icon
This template displays a wikilinked flag of the named parameter in 'icon' size, currently 23×15 pixels (defined in Template:flag icon/core) plus a one-pixel border.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | 1 | Name of the country, region, city, etc.; full name is recommended for countries | String | required |
Variant | variant 2 | Identifies a flag variant to be used instead of the standard flag, e.g. 1815 | String | optional |
Maximum dimension | size | The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px) | String | optional |
No redlink | noredlink | 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) | String | optional |
Examples[edit]
Wikicode | Results | Notes |
---|---|---|
{{flag icon|Peru}} |
||
{{flag icon|Peru|1822}} |
Specifies a historical flag | |
{{flag icon|Peru|variant=1822}} |
||
{{flag icon|Peru|size=50px}} |
Sets width to 50 pixels | |
{{flag icon|Xanadu}} |
Template:Country data Xanadu | No flag for Xanadu, so displays redlink |
{{flag icon|Xanadu|noredlink=yes}} |
No flag, so displays nothing |
Implementation notes[edit]
This template uses the data templates listed under Category:Country data templates, which contain the data specifying what to display and the formatter Template:flag icon/core, which contains the logic of how to display the flag.
{{flag icon|Peru}}
→ — uses Template:Country data Peru
Inside each country data template, this template uses the following parameters:
flag alias
— name of the image file to displayflag alias-xxxx
— name of the image file of flag variantxxxx
alias
— used to display the alt attribute of the image (defaults to "Flag of alias")
Tracking categories[edit]
Where {{flag icon|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 added to a tracking category:
- Category:Flag icons missing country data templates (population: 0)