Template:Flag

[[|]]

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Flag/doc.

Note: This template is used on a lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first. Editing a template causes all pages that use the template to be re-rendered. If the template is used often, this can put a lot of load on the servers since it fills up the job queue. Keep in mind that templates that are used on file description pages also show up on other wikis.

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 w: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 both instances link to United States.
{{flag|USA}}	USA
{{flag|Nepal}}	Nepal
{{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}}	Canadian	The name parameter can be used to change the display string but keep the link to the correct article.
{{flag|Canada|1957}}	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, the Commonwealth of Nations, and the European Union. A complete list can be found at Category:Country data templates.
{{flag|British Columbia|name=BC}}	BC
{{flag|Commonwealth of Nations|name=Cmnwlth}}	Cmnwlth
{{flag|EU}}	EU
{{flag|Switzerland|size=14px}}	Switzerland	The size parameter can be used to control the image dimensions. 23x15px is the default size for most countries (some entities have a different default size).
{{flag|Switzerland|size=28px}}	Switzerland

TemplateData

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

---

Wikipedia's help about TemplateData • Commons-specific information

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

Template parameters[Edit template data]

Parameter		Description	Type	Status
Country identifier	1	Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code	String	required
Variant	2	Identifies a flag variant to be used instead of the standard flag, e.g. 1815	String	optional
Alternative text	name	Display alternative text instead of the standard country name	String	optional
Maximum dimension	size	The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)	String	optional

See: w:Wikipedia:Extended image syntax.

See also

Template	Description	Example
{{CoA}}	displays coat of arms image	Germany
{{Flagcountry}}	always expands the link text to the full country name	Germany
{{Flagu}}	does not link the country name	Germany
{{Flagicon}}	displays the flag only, linked to the country name
{{Flagdeco}}	displays an unlinked flag icon only
{{Flagc}}	links the flag image to its description page	Germany
{{Flagteam}}	adds country code in parentheses after linked country name	Germany (GER)
{{Flagathlete}}	displays the flag and another name, followed country name or code	Dirk Nowitzki (GER)
{{Flagmedalist}}	displays the flag and a name, above linked country name and code	Dirk Nowitzki Germany (GER)

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