Jump to content

From Noumenapedia

Template:Flag/doc

__EXPECTED_UNCONNECTED_PAGE__

This template is used to display a small flag icon next to a wikilinked country name. It is related to the {{flag icon}}, {{flag country}} and {{flagu}} templates, but offers more options in terms of the text string displayed.

See Wikipedia:WikiProject Flag Template for the main documentation/discussion page for the flag templates system.

Usage

{{flag|country identifier|optional variant|name=alternative text string|size=maximum width and/or height of the flag image}}

  • country identifier is the common name of the country (e.g. "United States"), a common alias (e.g. "US"), or a standard country code such as those listed at ISO 3166-1 alpha-3
  • variant is an optional second parameter that can be used to display a flag variation, such as a historical flag. The list of variants for each country is documented on the appropriate template page, such as Template:Country data Germany
  • alternative text string, this optional value, specified by the name parameter, is used to display alternative text
  • size, this optional value is specified by the size parameter, and is used to specify the maximum width and/or height of the flag image. This parameter is specified using standard image syntax.

See the prefix index for the templates latently called by this one.

Examples

Wiki markup Displays Notes
{{flag|United States}} United States Note that all instances link to United States.
{{flag|US}} US
{{flag|USA}} USA
{{flag|Germany}} Germany All three instances link to Germany.
In addition to the ISO country codes, those used by FIFA, IOC, etc. are also supported.
{{flag|DEU}} DEU
{{flag|GER}} GER
{{flag|Germany|empire}} Germany Flag variations can be used with either country names or country codes.
{{flag|DEU|empire}} DEU
{{flag|CAN|name=Canadian}} Canadian The name parameter can be used to change the display string but keep the link to the correct article.
{{flag|Canada|1957|name=Canadian}} Canadian The name parameter can also be used when flag variants are specified.
{{flag|Texas}} Texas Flags are also available for several sub-national and multi-national entities such as US states, Canadian provinces, and the European Union.
A complete list can be found at Category:Country data templates.
{{flag|British Columbia|name=BC}} File:Flag of British Columbia.svg BC
{{flag|EU}} EU
{{flag|Switzerland|size=14px}} File:Flag of Switzerland (Pantone).svg  Switzerland The size parameter can be used to control the image dimensions.
23×15px is the default size for most countries (some entities have a different default size).
{{flag|Switzerland|size=28px}} File:Flag of Switzerland (Pantone).svg  Switzerland
{{flag|Nepal}} Error creating thumbnail:   Nepal Some flags are non-quadrilateral.

Alternatives to avoid Wikipedia's Post-expand include size limit

Pages with many flags may come close to or exceed Wikipedia's Post-expand include size limit. In these cases consider using modules or module-wrapper templates instead:

  • For many countries, using the country code as the template name will act as a wrapper for Module:Flagg: For example, {{flag|''USA''}} can be replaced with {{USA}}, which has an include size that is about 15% smaller.
  • {{#invoke:flag||}} is a wrapper for Module:Flagg that can further reduce sizes when invoked directly. For basic use, {{flag|country}} can be replaced with {{#invoke:flag||country}} which has an include size that is about half.


TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Flag in articles based on its TemplateData.

TemplateData for Flag

<TemplateData> { "description": "This template displays a small flag icon next to a wikilinked country name", "params": { "1": { "label": "Country identifier", "description": "Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code", "type": "string", "required": true }, "2": { "label": "Variant", "description": "Identifies a flag variant to be used instead of the standard flag, e.g. 1815", "type": "string", "required": false, "aliases": [ "variant" ] }, "name": { "label": "Alternative text", "description": "Display alternative text instead of the standard country name", "type": "string", "required": false }, "size": { "label": "Maximum dimension", "description": "The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)", "type": "string", "required": false } }, "format": "inline" } </TemplateData>

See: Wikipedia:Extended image syntax.

See also

Template Description Example
{{Coat of arms}} displays coat of arms image File:Arms of Canada.svg Canada
{{Flag country}} always expands the link text to the full country name  Germany
{{Flagu}} does not link the country name  Germany
{{Flag icon}} displays the flag only, linked to the country name Germany
{{Flag decoration}} displays an unlinked flag icon only
{{Flagc}} links the flag image to its description page flag Germany
{{Flag list}} aligns country names correctly in vertical lists (see that template's documentation)  Germany
{{Flagwrap}} allows the space after the flag icon to wrap (see that template's documentation) Germany
{{Flag team}} adds country code in parentheses after linked country name  Germany (GER)
{{Flag athlete}} displays the flag and another name, followed country name or code  Dirk Nowitzki (GER)
{{Flag medalist}} displays the flag and a name, above linked country name and code Dirk Nowitzki
 Germany

See Wikipedia:WikiProject Flag Template#List for a longer list of flag templates.

Multi-sport templates

Flag templates
Output style → Country name Country name (code) Athlete (country code) Athlete Country Name Country code
Olympic Games {{Flag IOC}} {{Flag IOC team}} {{Flag IOC athlete}} {{Flag IOC medalist}} {{Flag IOC short}}
Other games {{Flag IOC 2}} {{Flag IOC 2 team}} {{Flag IOC 2 athlete}} {{Flag IOC 2 medalist}} {{Flag IOC 2 short}}
Paralympic Games {{Flag IPC}} {{Flag IPC team}} {{Flag IPC athlete}} {{Flag IPC medalist}} {{Flag IPC short}}
Pan American {{Flag PASO}} {{Flag PASO athlete}} {{Flag PASO medalist}}
Parapan American {{Flag PPASO}}
Commonwealth {{Flag CGF}} {{Flag CGF athlete}} {{Flag CGF medalist}}
Southeast Asian {{Flag SEAGF}} {{Flag SEAGF team}} {{Flag SEAGF athlete}} {{Flag SEAGF medalist}}
World Games {{Flag IWGA}}
Central American and Caribbean Games {{Flag CAC}}
Asian Games {{Flag OCA}}
European Games {{Flag EOC}}
African Games {{Flag AFOC}}
Mediterranean Games {{Flag CIJM}}
Summer Universiade {{Flag FISU}}
"Nation at Championships"-style {{Flag link team}}
Generic {{Flag}} {{Flag team}} {{Flag athlete}} {{Flag medalist}}
Generic (variant) {{Flag link}} {{Flag link athlete}} {{Flag link medalist}}

See also

Module-based versions which can be used to reduce the post-expand include size on pages that are near or exceed the limit.