Template:Flag icon: Difference between revisions
(Redirected page to Template:Flag icon) Tag: New redirect |
(Removed redirect to Template:Flag icon) Tag: Removed redirect |
||
| Line 1: | Line 1: | ||
{{ | <includeonly>{{safesubst<noinclude />:#ifeq: {{Yesno-no|{{{noredlink|}}}}}|yes<noinclude><!-- | ||
{{ | --></noinclude>|<noinclude><!-- | ||
{{ | #Check for existence of Template: Country data foo before invoking it | ||
{{ | --></noinclude>{{safesubst<noinclude />:#ifexist: Template: Country data {{{1|}}}<noinclude><!-- | ||
}} | --></noinclude>|<noinclude><!-- | ||
# It exists, so proceed | |||
--></noinclude>{{country data {{{1|}}}|flag icon/core|variant={{{variant|{{{2|}}}}}}|size={{{size|}}}}}<noinclude><!-- | |||
--></noinclude>|<noinclude><!-- | |||
# It doesn't exist, so do nothing | |||
--></noinclude>}}<noinclude><!-- | |||
--></noinclude>|<noinclude><!-- | |||
# DEFAULT call Template: Country data {{{1|}}} | |||
# with no prior checks | |||
--></noinclude>{{country data {{{1|}}}|flag icon/core|variant={{{variant|{{{2|}}}}}}|size={{{size|}}}}}<noinclude><!-- | |||
# Track use where "Template:Country data Foo" does not exist | |||
--></noinclude>{{safesubst<noinclude />:#ifexist: Template:Country data {{{1|}}}||{{safesubst<noinclude />:namespace detect showall | |||
| 1 = | |||
| 2 = [[Category:Flag icons missing country data templates]] | |||
| user = 1 | |||
| talk = 1 | |||
| other = 2 | |||
}}}}<noinclude><!-- | |||
--></noinclude>}}</includeonly>{{safesubst<noinclude />:#invoke:Check for unknown parameters|check|unknown={{main other|[[Category:Pages using flag icon template with unknown parameters|_VALUE_{{PAGENAME}}]]}}|preview=Page using [[Template:Flag icon]] with unknown parameter "_VALUE_"|ignoreblank=y| 1 | 2 | noredlink | size | variant }}<noinclude> | |||
{{Documentation}} | |||
</noinclude> | |||
Latest revision as of 11:58, 30 December 2024
Template:Template:TEMPLATENAME displays a flag of the named parameter in "icon" size, currently 23×15 pixels maximally (defined in [[Template:Template:TEMPLATENAME/core]]), plus a one-pixel border. The image also has a clickable link to the associated article. For an unlinked flag icon, use Template:Flag decoration instead.
Please consider the Manual of Style section on flags before using this template.
Usage[edit source]
|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. 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 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 source]
TemplateData for Flag icon
<templatedata> { "description": "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.", "params": { "1": { "label": "Name", "description": "Name of the country, region, city, etc.; full name is recommended for countries", "type": "string", "required": true }, "variant": { "label": "Variant", "description": "Identifies a flag variant to be used instead of the standard flag, e.g. 1815", "type": "string", "required": false, "aliases": [ "2" ] }, "size": { "label": "Maximum dimension", "description": "The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)", "type": "string", "required": false }, "noredlink": { "label": "No redlink", "description": "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)", "type": "string", "required": false } } } </templatedata>
Examples[edit source]
| Wikicode | Results | Notes |
|---|---|---|
{{flag icon|Peru}} |
| |
{{flag icon|PER}} |
Template:Country data PER || Uses the ISO/IOC/FIFA country code | |
{{flag icon|Peru|1822}} |
| |
{{flag icon|Peru|variant=1822}} |
| |
{{flag icon|PER|naval}} |
Template:Country data PER || Specifies the naval ensign | |
{{flag icon|PER|air force}} |
Template:Country data PER || Specifies the air force flag | |
{{flag icon|Peru|size=50px}} |
| |
{{flag icon|Xanadu}} |
Template:Country data Xanadu | No flag for Xanadu, so displays redlink |
{{flag icon|Xanadu|noredlink=yes}} |
Template:Country data Xanadu || No flag, so displays nothing |
Implementation notes[edit source]
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
{{flag icon|PER}}→
Template:Country data PER — uses Template:Country data PER, which is a redirect to 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 variantxxxxalias— used to display the alt attribute of the image (defaults to "Flag of alias")
Tracking categories[edit source]
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: 22)
Related templates[edit source]
- 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, Peru).
- Template:Flag country 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.
{{flag country|Peru}}→ Template:Flag country{{flag country|PER}}→ Template:Flag country
- Template:Flag decoration displays an unlinked flag icon without country name.
{{flag decoration|Peru}}→ Template:Flag decoration
For a full list of flag templates, see Category:Flag template system.
Alternatives to avoid Wikipedia's Post-expand include size limit[edit source]
Pages with many flag icons may come close to or exceed Wikipedia's Post-expand include size limit. In these cases consider using modules or module-wrapper templates instead:
- Template:Template link is a simple wrapper for Module:Flagg: For basic use,
{{flag icon|country}}can be replaced with{{flagg|cxxlo|country}} - Template:Module link is a wrapper for Module:Flagg that can further reduce sizes when invoked directly. For basic use,
{{flag icon|country}}can be replaced with{{#invoke:flag|icon|country}}.