Template:Coast guard/doc: Difference between revisions

Content deleted Content added
No edit summary
Undid revision 948428957 by TrailBlzr (talk)
 
(3 intermediate revisions by 3 users not shown)
Line 1:
{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
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 {{tlp|Coast guard/core}} template, which should not be accessed directly. It is built on the {{tlp|flag}} template.
{{Inadequate documentation}}
 
Examples:
== Usage ==
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{coast guard|United States}}</nowiki>}}
 
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{coast guard|USA}}</nowiki>}}
'''<nowiki>{{Coast guard|</nowiki>'''''country identifier'''''&#124;'''''optional variant'''''&#124;'''name=''alternative text string'''''&#124;'''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 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 [[Wikipedia:Extended image syntax|image syntax]].
 
==Examples:==
{| class="wikitable"
! Wiki markup !! Displays !! Notes
|-
| <code><nowiki>{{Coast guard|United States}}</nowiki></code> || {{nowrap| {{Coast guard|United States}}}} || rowspan=2 | Note that both instances link to [[United States Coast Guard]].
|-
| <code><nowiki>{{Coast guard|USA}}</nowiki></code> || {{Coast guard|USA}}
|-
| <code><nowiki>{{Coast guard|Germany}}</nowiki></code> || {{Coast guard|Germany}} || rowspan=3 | All three instances link to [[German Federal Coast Guard]].<br />In addition to the ISO country codes, those used by [[FIFA]], [[IOC]], etc. are also supported.
|-
| <code><nowiki>{{Coast guard|DEU}}</nowiki></code> || {{Coast guard|DEU}}
|-
| <code><nowiki>{{Coast guard|GER}}</nowiki></code> || {{Coast guard|GER}}
|-
| <code><nowiki>{{Coast guard|CAN|name=Canadian}}</nowiki></code> || {{Coast guard|CAN|name=Canadian}} || The name parameter can be used to change the display string but keep the link to the correct article.
|-
| <code><nowiki>{{Coast guard|USA|size=14px}}</nowiki></code> || {{Coast guard|USA|size=14px}} || rowspan=2 | The size parameter can be used to control the image dimensions.<br />23×15px is the default size for most countries ([[:Category:Country data templates with distinct default size|some entities]] have a different default size).
|-
| <code><nowiki>{{Coast guard|USA|size=28px}}</nowiki></code> || {{Coast guard|USA|size=28px}}
|}
 
==TemplateData==
{{TemplateData header}}
<TemplateData>
{
"description": "This template is used to display a small flag icon next to a wikilinked name of that country's coastguard",
"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 coastguard flag variant to be used instead of the standard flag",
"type": "string",
"required": false
},
"name": {
"label": "Alternative text",
"description": "Display alternative text instead of the standard country coastguard name",
"type": "string",
"required": false
},
"size": {
"label": "Maximum dimension",
"description": "The maximum width or height, specified via standard image syntax (e.g. x30px)",
"type": "string",
"required": false
}
}
}
</TemplateData>
 
== See Also ==
 
See [[Wikipedia:WikiProject Flag Template]] for other flag-based templates.
 
<includeonly>{{sandbox other||
<!-- Categories below this line and interwikis at Wikidata -->
[[Category:Flag template system]]
[[Category:Military templates]]
 
}}</includeonly>