Template:Flag/doc
Jump to navigation
Jump to search
Template loop detected: Template:Mbox
{{#invoke:Message box|ombox}}
This template is used to display a small flag icon next to a wikilinked country name. It is related to the {{flagicon}} and {{flagcountry}} 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 both instances link to United States. |
{{flag|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}} |
| |
{{flag|GER}} |
| |
{{flag|Germany|empire}} |
Template:Country data Germany | Flag variations can be used with either country names or country codes. |
{{flag|DEU|empire}} |
| |
{{flag|CAN|name=Canadian}} |
File:Flag of Canada.svg 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}} |
File:Canadian Red Ensign 1957-1965.svg Canadian | 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, the Commonwealth of Nations, 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|Commonwealth of Nations|name=Cmnwlth}} |
Template:Country data Commonwealth of Nations | |
{{flag|EU}} |
| |
{{flag|Switzerland|size=14px}} |
Template:Country data Switzerland | The size parameter can be used to control the image dimensions. "Template:Country data Switzerland" is the default size. |
{{flag|Switzerland|size=28px}} |
Template:Country data Switzerland |
TemplateData
<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 }, "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 } }
} </TemplateData>
See also
- Template:Coat of arms
- Template:Flagcountry—always expands the link text to the full country name.
- Template:Flagicon—displays the flag only.