Template:Medal templates documentation

The Medal infobox series of templates allow editors to list an athlete or sportsperson's major medals at the top of their respective biography article, alongside the lead section.

Usage
The medal infobox consists of two templates:
 * MedalTableTop – for starting the table where the other template(s) aren't in an infobox. Do not use MedalTableTop or MedalTop inside an infobox.
 * Medal – for the several elements within the table

A further template (MedalBox) is used for listing medals in the middle of the main article text. Do not use MedalBox inside an infobox.

MedalTableTop

 * Basic usage


 * name – This option adjusts the title that appears at the top of the box. This should typically be the athlete's common name. By default it will display the article title without the disambiguator, for example on Michael Johnson (sprinter) "Michael Johnson" will appear by default. To deactivate the title enter no in the field.
 * image – This give you the option to place a headline image in the infobox. Use just the file name and extension, excluding the namespace prefix, for example: MyImage.jpg not File:MyImage.jpg.
 * image_size (or imagesize) – This adjusts the size of the image and must consist of a number followed by "px" (e.g. 150px). The default is 100px. Sizes over 200px are no recommended for typical usage.
 * alt – This provides a description of the image for accessibility users or those using weak connections
 * caption – This adds a short description to describe the image. Try to be brief, using just a few words.
 * header – This optional field can be used to change the text in the opening "Medal record" section. This is useful when the template appears in a section of an article. See Michael Phelps for a working example.
 * sport – This option includes the athlete's sport (e.g. Men's swimming) in the first line of the medal record. This replaces the need for when an athlete has medalled in only one sport. In cases where an athlete has competed in multiple sports, it is still possible to use the  template usage to list the different sports.
 * country_code – This option uses the country code (e.g. USA = United States, CHN = China, GBR2 = Great Britain) to generate the country that the athlete represents in the second line of the medal record. It will automatically include "the" in front of the country name for the following codes: BAH (the ), GAM (the ), GBR (the 🇬🇧), MHL (the 🇲🇭), NED (the ), PHI (the $\phi$), SEY (the ), SOL (the ), UAE (the ), URS (the ), and USA (the 🇺🇸). This replaces the need for when an athlete has competed for only one country. In cases where an athlete has represented multiple countries, it is still possible to use the  template usage to list the different countries.
 * country – May be used in place of country_code to display the country name using text or templates, such as BRA which displays 🇧🇷 (same output as with BRA), Poland which displays (links to Poland women's national basketball team article), or CAN which displays  (links to Canada men's national ice hockey team). Include "the" where appropriate (e.g. the BAH, the GAM, the GBR, the MHL, the NED, the PHI, the SEY, the SOL, the UAE, the URS, the USA). This replaces the need for the  template (e.g.  or  ).
 * medals – This is the only compulsory field as this is used to place medals and descriptions within the infobox through the Medal template. To work correctly it must be the last field in the main template.

MedalBox
The MedalBox template has a similar output to the MedalTableTop template, but it is specifically designed for non-infobox usages (i.e. mid-article boxes).


 * Basic usage:


 * color – This option changes the color of the box header. If omitted, the default is light grey.
 * title – This parameter allows you to customise the box title. If omitted, the default is "Medal record".
 * sport – This displays the athlete's primary sport (e.g. "Men's beach volleyball"). This option supersedes the "Medal|Sport" template function.
 * country – This displays the athlete's primary country or team using text or a template, such as BRA which displays 🇧🇷 (links to Brazil article), Poland which displays (links to Poland women's national basketball team article), or CAN which displays  (links to Canada men's national ice hockey team). Include "the" where appropriate (e.g. the BAH, the GAM, the GBR, the MHL, the NED, the PHI, the SEY, the SOL, the UAE, the URS, the USA). This replaces the need for the  template (e.g.  or  ).
 * medals – This is the only compulsory field as this is used to place medals and descriptions within the box through the Medal template. To work correctly it must be the last field in the main template.

Medal
The Medal template is a multi-purpose one which allows for all varieties of entries within the medal table.


 * Basic usage :

There are four major types:
 * Competition – This states the general competition at which the following medals were achieved (e.g. Olympic Games, Pan Pacific Swimming Championships)
 * Medal performances – There are ten types of medal performances. These contain two separate fields for the year of the competition and its location (e.g. 2008 Beijing, 2010 Delhi) and the medalling event or category (e.g. pole vault, 56 kg, 50 m freestyle). The medal types are (with shortcut in brackets):
 * Gold (G)
 * Silver (S)
 * Bronze (B)
 * Winner (W)
 * Runnerup (RU)
 * First (1st)
 * Second (2nd)
 * Third (3rd)
 * Disqualified (DQ)
 * TrueSpirit (PdC)

Disqualified
For the disqualified medal template, it is possible to create a reference directly after the template to explain the reason for disqualification. This can be particularly useful in the case of relay runners disqualified through no fault of their own, due to doping by team mates for example.

TrueSpirit
The final medal performances type is used for the Pierre de Coubertin medal. This has only one extra field for the year it was awarded.

Multiple countries/sports
Where an athlete has competed for multiple countries or in multiple sports it will be necessary to use the Country or Sport Medal types, in addition to the main sport and country_code listings in the MedalTableTop template


 * Relevant country (or team) – This is usually the first section showing the person's relevant country (or team).
 * Country – Enter the country's three letter code in curly brackets (e.g. CHN ), including "the" where appropriate (e.g. the USA, the URS, the MHL, the UAE, the GBR, the BAH, the NED, the PHI, the SEY, the GAM, the SOL). In rare cases the correct input may be something else (e.g. a team name).
 * Independent - This is used for independent athletes.
 * Sport – This states the sport that the athlete is competing in (e.g. Women's swimming)

MedalTableTop
For competitors who have competed in the same sport for the same country, the templates should be ordered Sport, Country, Competition1, Award, Competition2, Award and so on.

For competitors who have won medals in different sports, competing for the same country, the templates should be ordered Country, Sport1, Competition, Award, Sport2, Competition, Award and so on. The example shown is based on Rebecca Romero.

For competitors who have won medals in the same sport at the same competition, competing for different countries, the templates should be ordered Sport, Competition, Country1, Award, Country2, Award and so on. The example shown is from Mia Audina.

For competitors who have won medals in the same sport at different competitions, competing for different countries, the templates should be ordered Sport, Country1, Competition1, Award, Competition2, Award, Country2, Competition1, Award and so on.

For use within Infobox basketball biography, Infobox sportsperson, Infobox swimmer, Infobox track athlete, and other infobox template that support an "embed" function for the medal table. Formatting for the medal table embedded within an infobox generally follows the established formatting of the other examples provided, but duplicate wiki links for the sport name ("MedalSport") and represented country ("MedalCountry") may be eliminated within the embedded medal table.

MedalBox
Here is a basic demonstration of the MedalBox template usage:

Historical templates

 * Deprecated TableTop templates
 * and – use  with
 * – (for Paralympic Games) use
 * – use with the same parameters


 * Deprecated Competition templates
 * – use
 * – use
 * – use
 * – use


 * Deprecated Medal templates
 * For competitions differing from Gold, Silver and Bronze terminology
 * For competitions differing from Gold, Silver and Bronze terminology
 * For competitions differing from Gold, Silver and Bronze terminology
 * For competitions differing from Gold, Silver and Bronze terminology




 * Alias for
 * – Use.


 * Deprecated closing template
 * – table now automatically closes by using the |medals= parameter and moving two curly brackets to the end of the templates.