Difference between revisions of "Template:FlagIOC/doc"

From blackwiki
Jump to navigation Jump to search
imported>Primefac
(Undid revision 837717261 by Primefac (talk) self-revert, will use main template)
imported>Primefac
(centralize)
 
Line 1: Line 1:
{{documentation subpage}}
+
#REDIRECT [[Template:FlagIOC2/doc]]
 
 
== Usage ==
 
<code><nowiki>{{flagIOC|code|games|athletes}}</nowiki></code>
 
 
 
This template is used to display a small flag and name of a country, with a wikilink to the country's page for the specified Olympic games.
 
 
 
* ''code'' is an [[International Olympic Committee]] country code (see [[List of IOC country codes]]).
 
* ''games'' is a string of the form <tt><year> Summer</tt>, <tt><year> Winter</tt>, or just <tt>Summer</tt> or <tt>Winter</tt>.  [[Wikipedia:WikiProject Olympics]] has created a full set of pages of the form "<country> at the <year> <Summer/Winter> Olympics" and the intent is that this template can be used from medal tables and event result tables to point to the right country page.  Also, the correct historical flag is chosen based on this string, for countries that had different flags in the past.
 
* ''athletes'' is the number of athletes that the nation contributed to the specific Olympics. It is an optional argument, and will render a small <small>(#)</small> after the nation's name. 
 
 
 
== Examples ==
 
* <code><nowiki>{{flagIOC|USA}}</nowiki></code> → {{flagIOC|USA}}
 
* <code><nowiki>{{flagIOC|GER|Winter}}</nowiki></code> → {{flagIOC|GER|Winter}}
 
* <code><nowiki>{{flagIOC|ESP|2004 Summer}}</nowiki></code> → {{flagIOC|ESP|2004 Summer}}
 
* <code><nowiki>{{flagIOC|CHN|2006 Winter}}</nowiki></code> → {{flagIOC|CHN|2006 Winter}}
 
* <code><nowiki>{{flagIOC|CAN|1924 Winter}}</nowiki></code> → {{flagIOC|CAN|1924 Winter}}
 
* <code><nowiki>{{flagIOC|GRE|2004 Summer|441}}</nowiki></code> → {{flagIOC|GRE|2004 Summer|441}}
 
 
 
== Supporting templates ==
 
* The country name is supplied by {{tlx|country alias|''AAA''}} where AAA is an [[IOC country code]].
 
* The flag image name is also supplied by {{tlc|country alias}}
 
** For the complete country code list with related names and flags, see [[Module:Country alias]]
 
*If only the country code is desired, use {{t|FlagIOCshort}}
 
 
 
== TemplateData==
 
<templatedata>
 
{
 
"params": {
 
"1": {
 
"label": "code",
 
"description": "an International Olympic Committee country code (see [[List of IOC country codes]]).",
 
"example": "USA",
 
"type": "string",
 
"required": true
 
},
 
"2": {
 
"label": "games",
 
"description": "a string of the form <year> Summer, <year> Winter, or just Summer or Winter.",
 
"example": "2004 Summer",
 
"type": "string"
 
},
 
"3": {
 
"label": "athletes",
 
"description": "the number of athletes that the nation contributed to the specific Olympics.",
 
"example": "441",
 
"type": "number"
 
}
 
},
 
"description": "This template is used to display a small flag and name of a country, with a wikilink to the country's page for the specified Olympic games.",
 
"paramOrder": [
 
"1",
 
"2",
 
"3"
 
]
 
}
 
</templatedata>
 
== See also ==
 
{{Flag templates}}
 
 
 
<includeonly>
 
[[Category:Olympics flag templates]]
 
 
 
</includeonly>
 

Latest revision as of 03:07, 25 December 2018