Template:Wp/khw/Flag/doc
This is a documentation subpage for Template:Wp/khw/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 {{Wp/khw/Flagicon}}, {{Wp/khw/Flagcountry}} and {{Wp/khw/Flagu}} 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
[edit source]{{Wp/khw/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:Wp/khw/Country data Australia
- 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
[edit source]Wiki markup | Displays | Notes |
---|---|---|
{{Wp/khw/flag|United States}} |
United States | Note that both instances link to United States. |
{{Wp/khw/flag|USA}} |
USA | |
{{Wp/khw/flag|Nepal}} |
Nepal | |
{{Wp/khw/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. |
{{Wp/khw/flag|DEU}} |
DEU | |
{{Wp/khw/flag|GER}} |
GER | |
{{Wp/khw/flag|Germany|empire}} |
Germany | Flag variations can be used with either country names or country codes. |
{{Wp/khw/flag|DEU|empire}} |
DEU | |
{{Wp/khw/flag|CAN|name=Canadian}} |
Canadian || The name parameter can be used to change the display string but keep the link to the correct article. | |
{{Wp/khw/flag|Canada|1957|name=Canadian}} |
Canadian || The name parameter can also be used when flag variants are specified. | |
{{Wp/khw/flag|Texas}} |
Texas | Flags are also available for several sub-national and multi-national entities such as US states, Canadian provinces, and the European Union. A complete list can be found at Category:Country data templates. |
{{Wp/khw/flag|British Columbia|name=BC}} |
BC | |
{{Wp/khw/flag|EU}} |
Template:Wp/khw/Country data EU | |
{{Wp/khw/flag|Switzerland|size=14px}} |
Switzerland || rowspan=2 | The size parameter can be used to control the image dimensions. 23×15px is the default size for most countries (some entities have a different default size). | |
{{Wp/khw/flag|Switzerland|size=28px}} |
Switzerland |
TemplateData
[edit source]TemplateData for Wp/khw/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: Wikipedia:Extended image syntax.
See also
[edit source]Template | Description | Example |
---|---|---|
{{Wp/khw/Coat of arms}} | displays coat of arms image | {Template:Wp/khw/Coat of arms |
{{Wp/khw/Flagcountry}} | always expands the link text to the full country name | |
{{Wp/khw/Flagu}} | does not link the country name | Template:Wp/khw/country data Germany |
{{Wp/khw/Flagicon}} | displays the flag only, linked to the country name | |
{{Wp/khw/Flagdeco}} | displays an unlinked flag icon only | Template:Wp/khw/country data Germany |
{{Wp/khw/Flagc}} | links the flag image to its description page | Germany |
{{Wp/khw/Flaglist}} | aligns country names correctly in vertical lists (see that template's documentation) | Germany |
{{Wp/khw/Flagteam}} | adds country code in parentheses after linked country name | Template:Wp/khw/Flagteam |
{{Wp/khw/Flagathlete}} | displays the flag and another name, followed country name or code | Dirk Nowitzki (GER) |
{{Wp/khw/Flagmedalist}} | displays the flag and a name, above linked country name and code | Template:Wp/khw/flagmedalist |
See Wikipedia:WikiProject Flag Template#List for a longer list of flag templates.