Template:Coast guard/doc
This is a documentation subpage for Template:Coast guard. 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 variant icon next to a wikilinked name of a country's coastguard. It is a usable wrapper of the {{Coast guard/core}} template, which should not be accessed directly. It is built on the {{flag}} template.
Usage
{{Coast guard|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 coastguard flag variation. The list of variants for each country is documented on the appropriate template page, such as Template:Country data Germany. You can only use subvariants of the coast guard variant.
- alternative text string, this optional value, specified by the name parameter, is used to display alternative text instead of the official coast guard name for the wikilinked page.
- 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.
Examples
Wiki markup | Displays | Notes |
---|---|---|
{{Coast guard|United States}} |
United States Coast Guard | Note that both instances link to United States Coast Guard. |
{{Coast guard|USA}} |
United States Coast Guard | |
{{Coast guard|Germany}} |
German Federal Coast Guard | All three instances link to German Federal Coast Guard. In addition to the ISO country codes, those used by FIFA, IOC, etc. are also supported. |
{{Coast guard|DEU}} |
German Federal Coast Guard | |
{{Coast guard|GER}} |
German Federal Coast Guard | |
{{Coast guard|CAN|name=Canadian}} |
Canadian | The name parameter can be used to change the display string but keep the link to the correct article. |
{{Coast guard|USA|size=14px}} |
United States Coast Guard | 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). |
{{Coast guard|USA|size=28px}} |
United States Coast Guard |
TemplateData
TemplateData for Coast guard
This template is used to display a small flag icon next to a wikilinked name of that country's coastguard
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 coastguard flag variant to be used instead of the standard flag | String | optional |
Alternative text | name | Display alternative text instead of the standard country coastguard name | String | optional |
Maximum dimension | size | The maximum width or height, specified via standard image syntax (e.g. x30px) | String | optional |
See Also
See Wikipedia:WikiProject Flag Template for other flag-based templates.