Difference between revisions of "Template:FlagIOC2medalist/doc"

From blackwiki
Jump to navigation Jump to search
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
imported>Primefac
(update /doc)
 
Line 1: Line 1:
{{Documentation subpage}}
+
{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
+
{{Lua|Module:Country alias}}
  
Similar to {{tlx|flagIOC2athlete}}, but places the country name on a second line.
+
This template family is used to display a small flag, one or more athletes, and the name of a country, with a wikilink to the country's page for the specified multi-sport event.
 +
 
 +
Use {{t|{{PAGENAME}}}} for the {{#switch:{{PAGENAME}}
 +
| FlagIOC |FlagIOCteam |FlagIOCathlete |FlagIOCmedalist |FlagIOCshort = Olympic Games
 +
| FlagIPC |FlagIPCteam |FlagIPCathlete |FlagIPCmedalist |FlagIPCshort =  Paralympic Games
 +
| FlagPASO |FlagPASOteam |FlagPASOathlete |FlagPASOmedalist =  Pan American Games
 +
| FlagPPASO =  Parapan American Games
 +
| FlagCGF |FlagCGFteam |FlagCGFathlete |FlagCGFmedalist =  Commonwealth Games
 +
| FlagSEAGF |FlagSEAGFteam |FlagSEAGFathlete |FlagSEAGFmedalist =  Southeast Asian Games
 +
| FlagIWGA =  World Games
 +
| FlagCAC =  Central American and Caribbean Games
 +
| FlagOCA =  Asian Games
 +
| FlagIOC2 |FlagIOC2team |FlagIOC2athlete |FlagIOC2medalist |FlagIOC2short|#default =  other games not [[#See also|listed below]]
 +
}}.
  
 
== Usage ==
 
== Usage ==
Default usage:
+
<code><nowiki>{{flagXXX|athlete(s)|code|games}}</nowiki></code>
*<code><nowiki>{{flagIOC2medalist|[[Im Dong-hyun]]|KOR|2006 Asian Games}}</nowiki></code>
+
 
:{{flagIOC2medalist|[[Im Dong-hyun]]|KOR|2006 Asian Games}}
+
* ''athletes'' is the name(s) of the athlete(s) to display.
 +
* ''code'' is the three-letter country code used by the [[List of IOC country codes|IOC]], [[List of CGF country codes|CGF]], or [[List of FINA member federations|FINA]].
 +
* ''games'' is a string with slightly different forms depending on the template used:
 +
**{{t|flagIOC2}} takes values in the form <code><year> <games></code>, or just <code><games></code>
 +
**{{t|flagIOC}} and {{t|flagIPC}} use  <code><year> Summer</code>, <code><year> Winter</code>, or just <code>Summer</code> or <code>Winter</code>
 +
**Games-specific templates such as {{t|flagCGF}}, {{t|flagPASO}}, etc, simply take the <code><year></code>. See [[#See also|below]] for a full list of supported "shortcut" templates
 +
: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.
 +
 
  
The template gives the option to display the country code, although this is discouraged by MOS guidelines.
+
== Examples ==
*<code><nowiki>{{flagIOC2medalist|[[Im Dong-hyun]]|KOR|2006 Asian Games|code=yes}}</nowiki></code>
+
In addition to using historical flags when appropriate, the specific name of the games will be selected when appropriate.
:{{flagIOC2medalist|[[Im Dong-hyun]]|KOR|2006 Asian Games|code=yes}}
 
  
 +
{| class="wikitable"
 +
! Template !! Code !! Display
 +
|-
 +
! rowspan=4| flagIOC2
 +
| <code><nowiki>{{FlagIOC2medalist|[[Andy Ardiyansah]] and [[Koko Prasetyo Darkuncoro]]|INA|Asian Games}}</nowiki></code> || {{FlagIOC2medalist|[[Andy Ardiyansah]] and [[Koko Prasetyo Darkuncoro]]|INA|Asian Games}}
 +
|-
 +
|<code><nowiki>{{FlagIOC2medalist|[[Andy Ardiyansah]] and [[Koko Prasetyo Darkuncoro]]|INA|2008 Asian Beach Games}}</nowiki></code> || {{FlagIOC2medalist|[[Andy Ardiyansah]] and [[Koko Prasetyo Darkuncoro]]|INA|2008 Asian Beach Games}}
 +
|-
 +
|<code><nowiki>{{FlagIOC2medalist|Jane Example|HKG|1954 Asian Games}}</nowiki></code>{{efn|name=hist|''{{small|(Uses historical flag)}}''}} || {{FlagIOC2medalist|Jane Example|HKG|1954 Asian Games}}
 +
|-
 +
|<code><nowiki>{{FlagIOC2medalist|Joe Bloggs|JPN|2009 Asian Indoor Games}}</nowiki></code> || {{FlagIOC2medalist|Joe Bloggs|JPN|2009 Asian Indoor Games}}
 +
|-
 +
! rowspan=7 | flagIOCmedalist <br> flagIPCmedalist
 +
| <code><nowiki>{{flagIOCmedalist|[[Teresa Edwards]]|USA}}</nowiki></code> || {{flagIOCmedalist|[[Teresa Edwards]]|USA}}
 +
|-
 +
| <code><nowiki>{{flagIOCmedalist|[[Hubert Van Innis]]|GER|Winter}}</nowiki></code> || {{flagIOCmedalist|[[Hubert Van Innis]]|GER|Winter}}
 +
|-
 +
| <code><nowiki>{{flagIOCmedalist|Joe Example|ESP|2004 Summer}}</nowiki></code> || {{flagIOCmedalist|Joe Example|ESP|2004 Summer}}
 +
|-
 +
| <code><nowiki>{{flagIOCmedalist|Joey Example|CAN|2006 Winter}}</nowiki></code> || {{flagIOCmedalist|Joey Example|CAN|2006 Winter}}
 +
|-
 +
| <code><nowiki>{{flagIOCmedalist|Joy Example|CAN|1924 Winter}}</nowiki></code>{{efn|name=hist}} || {{flagIOCmedalist|Joy Example|CAN|1924 Winter}}
 +
|-
 +
| <code><nowiki>{{flagIOCmedalist|Jonah Example|GRE|2004 Summer}}</nowiki></code> || {{flagIOCmedalist|Jonah Example|GRE|2004 Summer}}
 +
|-
 +
| <code><nowiki>{{flagIPCmedalist|Jon Example|GRE|2004 Summer}}</nowiki></code> || {{flagIPCmedalist|Jon Example|GRE|2004 Summer}}
 +
|-
 +
!rowspan=5|flagCGFmedalist
 +
| <code><nowiki>{{flagCGFmedalist|Joe Example|CAN}}</nowiki></code> || {{flagCGFmedalist|Joe Example|CAN|3= }}<!--Extra param needs to be included here to avoid breaking things, but just in the /doc-->
 +
|-
 +
| <code><nowiki>{{flagCGFmedalist|Jay Example|SCO|2010}}</nowiki></code> || {{flagCGFmedalist|Jay Example|SCO|2010}}
 +
|-
 +
| <code><nowiki>{{flagCGFmedalist|Joy Example|AUS|1974}}</nowiki></code> || {{flagCGFmedalist|Joy Example|AUS|1974}}
 +
|-
 +
| <code><nowiki>{{flagCGFmedalist|Jonah Example|NZL|1962}}</nowiki></code> || {{flagCGFmedalist|Jonah Example|NZL|1962}}
 +
|-
 +
| <code><nowiki>{{flagCGFmedalist|Jon Example|IND|1934}}</nowiki></code> || {{flagCGFmedalist|Jon Example|IND|1934}}
 +
|-
 +
!rowspan=4|flagSEAGFmedalist
 +
| <code><nowiki>{{flagSEAGFmedalist|Joe Example|VIE|1973}}</nowiki></code>{{efn|name=hist}} || {{flagSEAGFmedalist|Joe Example|VIE|1973}}
 +
|-
 +
| <code><nowiki>{{flagSEAGFmedalist|Jay Example|MAS|1961}}</nowiki></code> || {{flagSEAGFmedalist|Jay Example|MAS|1961}}
 +
|-
 +
| <code><nowiki>{{flagSEAGFmedalist|Joy Example|MYA|2013}}</nowiki></code> || {{flagSEAGFmedalist|Joy Example|MYA|2013}}
 +
|-
 +
| <code><nowiki>{{flagSEAGFmedalist|Jon Example|VIE|2015}}</nowiki></code> || {{flagSEAGFmedalist|Jon Example|VIE|2015}}
 +
|-
 +
!rowspan=2|FlagPASOmedalist
 +
| <code><nowiki>{{FlagPASOmedalist|Joe Example|COL|2011}}</nowiki></code> || {{FlagPASOmedalist|Joe Example|COL|2011}}
 +
|-
 +
| <code><nowiki>{{FlagPASOmedalist|Jon Example|BRA|2011}}</nowiki></code> || {{FlagPASOmedalist|Jon Example|BRA|2011}}
 +
|}
 +
{{notelist}}
 
== Supporting templates ==
 
== Supporting templates ==
 
* The country name is supplied by {{tlx|country alias|''AAA''}} where AAA is an [[IOC country code]].
 
* The country name is supplied by {{tlx|country alias|''AAA''}} where AAA is an [[IOC country code]].
Line 22: Line 94:
  
 
<includeonly>{{Sandbox other||
 
<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
+
[[Category:Olympics flag templates]]
[[Category:Olympics flag templates|{{PAGENAME}}]]
 
  
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 02:56, 9 July 2020

This template family is used to display a small flag, one or more athletes, and the name of a country, with a wikilink to the country's page for the specified multi-sport event.

Use Template:T for the other games not listed below.

Usage

{{flagXXX|athlete(s)|code|games}}

  • athletes is the name(s) of the athlete(s) to display.
  • code is the three-letter country code used by the IOC, CGF, or FINA.
  • games is a string with slightly different forms depending on the template used:
    • Template:T takes values in the form <year> <games>, or just <games>
    • Template:T and Template:T use <year> Summer, <year> Winter, or just Summer or Winter
    • Games-specific templates such as Template:T, Template:T, etc, simply take the <year>. See below for a full list of supported "shortcut" templates
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.


Examples

In addition to using historical flags when appropriate, the specific name of the games will be selected when appropriate.

Template Code Display
flagIOC2 {{FlagIOC2medalist|[[Andy Ardiyansah]] and [[Koko Prasetyo Darkuncoro]]|INA|Asian Games}} Andy Ardiyansah and Koko Prasetyo Darkuncoro
 Indonesia
{{FlagIOC2medalist|[[Andy Ardiyansah]] and [[Koko Prasetyo Darkuncoro]]|INA|2008 Asian Beach Games}} Andy Ardiyansah and Koko Prasetyo Darkuncoro
 Indonesia
{{FlagIOC2medalist|Jane Example|HKG|1954 Asian Games}}[lower-alpha 1] Jane Example
 Hong Kong
{{FlagIOC2medalist|Joe Bloggs|JPN|2009 Asian Indoor Games}} Joe Bloggs
 Japan
flagIOCmedalist
flagIPCmedalist
{{flagIOCmedalist|[[Teresa Edwards]]|USA}} Teresa Edwards
 United States
{{flagIOCmedalist|[[Hubert Van Innis]]|GER|Winter}} Hubert Van Innis
 Germany
{{flagIOCmedalist|Joe Example|ESP|2004 Summer}} Joe Example
 Spain
{{flagIOCmedalist|Joey Example|CAN|2006 Winter}} Joey Example
 Canada
{{flagIOCmedalist|Joy Example|CAN|1924 Winter}}[lower-alpha 1] Joy Example
 Canada
{{flagIOCmedalist|Jonah Example|GRE|2004 Summer}} Jonah Example
 Greece
{{flagIPCmedalist|Jon Example|GRE|2004 Summer}} Jon Example
 Greece
flagCGFmedalist {{flagCGFmedalist|Joe Example|CAN}} Joe Example
 Canada
{{flagCGFmedalist|Jay Example|SCO|2010}} Jay Example
 Scotland
{{flagCGFmedalist|Joy Example|AUS|1974}} Joy Example
 Australia
{{flagCGFmedalist|Jonah Example|NZL|1962}} Jonah Example
 New Zealand
{{flagCGFmedalist|Jon Example|IND|1934}} Jon Example
 India
flagSEAGFmedalist {{flagSEAGFmedalist|Joe Example|VIE|1973}}[lower-alpha 1] Joe Example
 [[Vietnam at the 1973 Template:SEAGF year|Vietnam]]
{{flagSEAGFmedalist|Jay Example|MAS|1961}} Jay Example
 [[Malaysia at the 1961 Template:SEAGF year|Malaysia]]
{{flagSEAGFmedalist|Joy Example|MYA|2013}} Joy Example
 [[Myanmar at the 2013 Template:SEAGF year|Myanmar]]
{{flagSEAGFmedalist|Jon Example|VIE|2015}} Jon Example
 [[Vietnam at the 2015 Template:SEAGF year|Vietnam]]
FlagPASOmedalist {{FlagPASOmedalist|Joe Example|COL|2011}} Joe Example
 Colombia
{{FlagPASOmedalist|Jon Example|BRA|2011}} Jon Example
 Brazil
  1. 1.0 1.1 1.2 (Uses historical flag)

Supporting templates

See also

Output style → Country name Country (code) Athlete (country) Athlete
Country
Country code
Olympic Games {{FlagIOC}} {{FlagIOCteam}} {{FlagIOCathlete}} {{FlagIOCmedalist}} {{FlagIOCshort}}
Other games {{FlagIOC2}} {{FlagIOC2team}} {{FlagIOC2athlete}} {{FlagIOC2medalist}} {{FlagIOC2short}}
Paralympic Games {{FlagIPC}} {{FlagIPCteam}} {{FlagIPCathlete}} {{FlagIPCmedalist}} {{FlagIPCshort}}
Pan American {{FlagPASO}} {{FlagPASOteam}} {{FlagPASOathlete}} {{FlagPASOmedalist}}
Parapan American {{FlagPPASO}}
Commonwealth {{FlagCGF}} {{FlagCGFteam}} {{FlagCGFathlete}} {{FlagCGFmedalist}}
Southeast Asian {{FlagSEAGF}} {{FlagSEAGFteam}} {{FlagSEAGFathlete}} {{FlagSEAGFmedalist}}
World Games {{FlagIWGA}}
Central American and Caribbean Games {{FlagCAC}}
Asian Games {{FlagOCA}}
"Nation at Championships"-style {{Flaglinkteam}} {{FlagATHCHathlete}}
Generic {{Flag}} {{Flagteam}} {{Flagathlete}} {{Flagmedalist}}
Generic (variant) {{Flaglink}} {{Flaglinkmedalist}}