Template:Flag/doc
This is a documentation subpage for Template:Flag. It contains usage information, categories, and other content that is not part of the original template page. |
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
edit{{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
editWiki 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}}
|
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}}
|
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}}
|
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
editTemplateData for Flag
This template displays a small flag icon next to a wikilinked country name
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
editTemplate | 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 | Germany |
{{Flagu}}
|
does not link the country name | Template:Flagu |
{{Flagicon}}
|
displays the flag only, linked to the country name | |
{{Flagdeco}}
|
displays an unlinked flag icon only | Template:Flagdeco |
{{Flagc}}
|
links the flag image to its description page | Template:Flagc |
{{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 w:Wikipedia:WikiProject Flag Template#List for a longer list of flag templates.