Yffo: 1 revision

2013-07-31T17:28:14Z

1 revision

New page

{{Documentation subpage}}<includeonly>{{pp-template|small=yes}}</includeonly>

{{high-risk|290,000+}}

This template is used to display a small flag icon next to a wikilinked country name. It is related to the {{tl|flagicon}} and {{tl|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==
'''<nowiki>{{flag|</nowiki>'''''country identifier'''''|'''''optional variant'''''|'''name=''alternative text string'''''|'''size=''maximum width and/or height of the flag image'''''<nowiki>}}</nowiki>'''

*''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 [[Wikipedia:Extended image syntax|image syntax]].

See [http://en.wikipedia.org/w/index.php?title=Special%3APrefixindex&from=Country+data&namespace=10 the prefix index] for the templates latently called by this one.

==Examples==
{| class="wikitable"
! Wiki markup !! Displays !! Notes
|-
| <code><nowiki>{{flag|United States}}</nowiki></code> ||{{nowrap| {{flag|United States}}}} ||rowspan=2| Note that both instances link to [[United States]].
|-
| <code><nowiki>{{flag|USA}}</nowiki></code> || {{flag|USA}}
|-
| <code><nowiki>{{flag|Germany}}</nowiki></code> || {{flag|Germany}} ||rowspan=3| All three instances link to [[Germany]]. In addition to the ISO country codes, those used by [[FIFA]], [[IOC]], etc. are also supported.
|-
| <code><nowiki>{{flag|DEU}}</nowiki></code> || {{flag|DEU}}
|-
| <code><nowiki>{{flag|GER}}</nowiki></code> || {{flag|GER}}
|-
| <code><nowiki>{{flag|Germany|empire}}</nowiki></code> || {{flag|Germany|empire}} ||rowspan=2| Flag variations can be used with either country names or country codes.
|-
| <code><nowiki>{{flag|DEU|empire}}</nowiki></code> || {{flag|DEU|empire}}
|-
| <code><nowiki>{{flag|CAN|name=Canadian}}</nowiki></code> || {{flag|CAN|name=Canadian}} || The name parameter can be used to change the display string but keep the link to the correct article.
|-
| <code><nowiki>{{flag|Canada|1957|name=Canadian}}</nowiki></code> || {{flag|Canada|1957|name=Canadian}} || The name parameter can also be used when flag variants are specified.
|-
| <code><nowiki>{{flag|Texas}}</nowiki></code> || {{flag|Texas}} ||rowspan=4| 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]].
|-
| <code><nowiki>{{flag|British Columbia|name=BC}}</nowiki></code> || {{flag|British Columbia|name=BC}}
|-
| <code><nowiki>{{flag|Commonwealth of Nations|name=Cmnwlth}}</nowiki></code> || {{flag|Commonwealth of Nations|name=Cmnwlth}}
|-
| <code><nowiki>{{flag|EU}}</nowiki></code> || {{flag|EU}}
|-
| <code><nowiki>{{flag|Switzerland|size=14px}}</nowiki></code> || {{flag|Switzerland|size=14px}} || rowspan=2| The size parameter can be used to control the image dimensions. "{{flag|Switzerland}}" is the default size.
|-
| <code><nowiki>{{flag|Switzerland|size=28px}}</nowiki></code> || {{flag|Switzerland|size=28px}}
|}

==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.

<includeonly>
[[Category:Flag template system]]
</includeonly><noinclude>
[[ja:Template:Flag]]
</noinclude>

Template:Flag/doc - Revision history

Yffo: 1 revision