Difference between revisions of "Template:Flag/doc"
From Wiki
(+ TD header) |
m (1 revision) |
(No difference)
| |
Latest revision as of 23:46, 1 February 2014
| 40x40px | This template is used on 290,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
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.
Contents
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}} |
23x15px United States | Note that both instances link to United States. |
{{flag|USA}} |
23x15px USA | |
{{flag|Germany}} |
23x15px 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}} |
23x15px DEU | |
{{flag|GER}} |
23x15px GER | |
{{flag|Germany|empire}} |
23x15px Germany | Flag variations can be used with either country names or country codes. |
{{flag|DEU|empire}} |
23x15px DEU | |
{{flag|CAN|name=Canadian}} |
23x15px 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}} |
23x15px Canadian | The name parameter can also be used when flag variants are specified. |
{{flag|Texas}} |
23x15px 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}} |
23x15px BC | |
{{flag|Commonwealth of Nations|name=Cmnwlth}} |
23x15px Cmnwlth | |
{{flag|EU}} |
23x15px EU | |
{{flag|Switzerland|size=14px}} |
14px Switzerland | The size parameter can be used to control the image dimensions. "20x16px Switzerland" is the default size. |
{{flag|Switzerland|size=28px}} |
28px Switzerland |
TemplateData
This template displays a small flag icon next to a wikilinked country name
| Parameter | Description | Type | Default | 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 | empty | required |
| Variant | 2 | Identifies a flag variant to be used instead of the standard flag, e.g. 1815 | string | empty | optional |
| Alternative text | name | Display alternative text instead of the standard country name | string | empty | optional |
| Maximum dimension | size | The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px) | string | empty | optional |
See also
- Template:Coat of arms
- Template:Flagcountry—always expands the link text to the full country name.
- Template:Flagicon—displays the flag only.
