Template:Flagcountry/doc: Difference between revisions
Jump to navigation
Jump to search
Richardpruen (talk | contribs) m (1 revision imported) |
imported>AltoStev |
||
Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
{{High-use}} | |||
==Description== | ==Description== | ||
Line 29: | Line 30: | ||
"description": "Produces a flag icon next to a wikilinked country name.", | "description": "Produces a flag icon next to a wikilinked country name.", | ||
"params": { | "params": { | ||
" | "1": { | ||
"label": "Nation", | "label": "Nation", | ||
"description": "The name or code of the country.", | "description": "The name or code of the country.", | ||
"type": "string", | "type": "string", | ||
" | "required": true | ||
}, | }, | ||
"variant": { | "variant": { | ||
"label": "Variant", | "label": "Variant", | ||
"description": "The flag variant to be displayed.", | "description": "The flag variant to be displayed.", | ||
"aliases": ["2"], | "aliases": [ | ||
"2" | |||
], | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 47: | Line 49: | ||
"type": "number" | "type": "number" | ||
} | } | ||
} | }, | ||
"paramOrder": [ | |||
"1", | |||
"variant", | |||
"size" | |||
] | |||
} | } | ||
</templatedata> | </templatedata> |
Latest revision as of 02:41, 1 January 2023
This is a documentation subpage for Template:Flagcountry. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 39,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Description
{{flagcountry|nation|variant|size=|name=}}
Produces a flag icon attached to a wikilinked article. This template is similar to the more widely used {{flag}} template, but is more useful for two situations described below.
- Parameters
|1=
(first unnamed parameter): Use either the name of the nation or in some cases, a three-letter country code (e.g. ISO 3166-1 alpha-3)|variant=
or|2=
(optional parameter): Specifies an alternative (historical) flag to use. This parameter is documented by the appropriate template in Category:Country data templates.|size=
(optional): Can be used to change the flag icon size.|name=
(optional): The display text of the target wikilink is usually automatically generated, but can always be over-ridden with the name parameter.
Usage examples
{{flagcountry|ITA}}
→ Italy- In this case, the country code for Italy (ITA) is used to produce the correct flag and wikilink. In many cases, it would probably be preferable to use {{flag}} to produce the same result, such as
{{flag|Italy}}
for this example. However, {{flagcountry}} could be used within other templates (such as infoboxes) so that country codes can be used for those template parameters.
- In this case, the country code for Italy (ITA) is used to produce the correct flag and wikilink. In many cases, it would probably be preferable to use {{flag}} to produce the same result, such as
{{flagcountry|ITA|1861}}
→ Italy- Similar to the first example, but with a flag variant parameter to select a historical flag image. Note that the wikilinked article is
[[Italy]]
.
- Similar to the first example, but with a flag variant parameter to select a historical flag image. Note that the wikilinked article is
{{flagcountry|Kingdom of Italy}}
→ Italy- In this example, a different country data template is used, to select an alternative article for the wikilink (in this case,
[[Kingdom of Italy|Italy]]
). Compare with{{flag|Kingdom of Italy}}
→ Kingdom of Italy, in which "Kingdom of Italy" is the display text for the wikilink. Therefore, the choice offlagcountry
orflag
depends on the desired display text; in all other respects, the templates are identical.
- In this example, a different country data template is used, to select an alternative article for the wikilink (in this case,
{{flagcountry|South Korea|name=Korea}}
→ Korea
Tracking categories
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Flagcountry
Produces a flag icon next to a wikilinked country name.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Nation | 1 | The name or code of the country. | String | required |
Variant | variant 2 | The flag variant to be displayed. | String | optional |
Size | size | The size of the flag icon. | Number | optional |
See also
- Template:Coat of arms
- Template:Flag
- Template:Flagicon - displays just the flag
- Template:Flagu - displays the flag and unlinked country name
- Template:Flaglist - names line up vertically in lists
- Wikipedia:WikiProject Flag Template