Template:Flag/doc

From TSP Encyclopedia
Revision as of 23:33, 16 April 2023 by Pronoun (talk | contribs) (copy documentation from Wikipedia)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Template:High-risk

This template is used to display a small flag icon next to a wikilinked country name. It is related to the {{flagicon}}, {{flagcountry}} 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}} Template:Country data United States Note that all instances link to United States.
{{flag|US}} Template:Country data US
{{flag|USA}} Template:Country data USA
{{flag|Germany}} Template:Country data 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}} Template:Country data DEU
{{flag|GER}} Template:Country data GER
{{flag|Germany|empire}} Template:Country data Germany Flag variations can be used with either country names or country codes.
{{flag|DEU|empire}} Template:Country data DEU
{{flag|CAN|name=Canadian}} Template:Country data CAN The name parameter can be used to change the display string but keep the link to the correct article.
{{flag|Canada|1957|name=Canadian}} Template:Country data Canada The name parameter can also be used when flag variants are specified.
{{flag|Texas}} Template:Country data 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}} Template:Country data British Columbia
{{flag|EU}} Template:Country data EU
{{flag|Switzerland|size=14px}} Template:Country data 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}} Template:Country data Switzerland
{{flag|Nepal}} Template:Country data Nepal Some flags are non-quadrilateral.

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

This template displays a small flag icon next to a wikilinked country name

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Country identifier1

Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code

Stringrequired
Variant2 variant

Identifies a flag variant to be used instead of the standard flag, e.g. 1815

Stringoptional
Alternative textname

Display alternative text instead of the standard country name

Stringoptional
Maximum dimensionsize

The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)

Stringoptional

See: Wikipedia:Extended image syntax.

See also

Template Description Example
{{Coat of arms}} displays coat of arms image Template:Coat of arms
{{Flagcountry}} always expands the link text to the full country name Template:Country data Germany
{{Flagu}} does not link the country name Template:Country data Germany
{{Flagicon}} displays the flag only, linked to the country name Template:Country data Germany
{{Flagdeco}} displays an unlinked flag icon only Template:Flagdeco
{{Flagc}} links the flag image to its description page Template:Flagc
{{Flaglist}} aligns country names correctly in vertical lists (see that template's documentation)  Germany
{{Flagteam}} adds country code in parentheses after linked country name Template:Flagteam
{{Flagathlete}} displays the flag and another name, followed country name or code Template:Flagathlete
{{Flagmedalist}} displays the flag and a name, above linked country name and code Template:Flagmedalist

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

Multi-sport templates

Template:Flag templates

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.