Editing Template:AchievementTable/doc

{{Documentation subpage}}
{{High-use}}
The '''AchievementTable''' template is a simple way to start a table to list [[track and field]] or [[sport of athletics]] achievements on an athlete's article. For an in-use example, see [[James Kwalia]].

==Parameters==
The template has the following parameters, all of them optional.
<syntaxhighlight lang="wikitext">{{AchievementTable|nation=|nation2=|caption=|Event=|Time=|Result=|Wind=|Team=|NotesOff=}}</syntaxhighlight>
* '''nation''' This allows for a caption showing the nation that the athlete represented at the competition. This should only be used when an athlete has represented multiple nations. Note that where different nations are represented as separate table with a new caption should be used as this [[Wikipedia:Manual of Style/Accessibility/Data tables tutorial|helps accessibility]] for screen readers. This option defaults to no caption.
* '''nation2''' Same as above but for other nations represented (e.g. United Kingdom and England). Can also be used for non-national teams, such as institutions or clubs.
* '''caption''' will allow the use of custom table caption for the templated table. Any free text can be used, including template links. This cannot be used in conjunction with the nation captions 
* '''Event''' This adds an additional "Event" column before the final "Notes" column, which should be used to denote the athletic discipline that the result relates to (e.g. [[100 metres]]). The default is that this column is not shown.
* '''Time'''/'''Result''' This adds an additional column to record the time or result that the athlete achieved in the given event
* '''Wind''' This adds an additional column to record the wind registered for the performance in relevant events, such as 100 metres
* '''Team''' This adds an additional column to list the team represented in the performance, such as nation, club or institution. There can be used to link to specific team competition pages for the performance, for example [[China at the 2008 Summer Olympics]] using templates such as {{tl|Flag IOC team}}, or links to the national team pages such as [[Italy national athletics team]]
* '''NotesOff''' This removes the final notes column from the table – useful when no notes are available or required. The default is that the Notes column is shown.

==Usage==
In order to use the template, simply open a table and add the template as follows:

<syntaxhighlight lang="wikitext">{| {{AchievementTable}}</syntaxhighlight>

'''Using this template can help you write tables like the one below'''
{| {{AchievementTable|Event=yes}}
|-
| 2001
| [[2001 IAAF World Youth Championships|World Youth Championships]]
| [[Debrecen]], Hungary
| style="background-color:#cc9966;" | 3rd
| 3000 m
|
|-
| 2003
| [[2003 IAAF World Athletics Final|World Athletics Final]]
| [[Monte Carlo]], Monaco
| 5th
| 3000 m
|
|-
| 2004
| [[2004 IAAF World Athletics Final|World Athletics Final]]
| [[Monte Carlo]], Monaco
| style="background-color:silver" | 2nd
| 3000 m
|
|-
| rowspan=4 | 2005
| [[2005 IAAF World Cross Country Championships|World Cross Country Championships]]
| [[St Etienne]], France
| 15th
| Short race
|
|-
| [[2005 World Championships in Athletics|World Championships]]
| [[Helsinki]], Finland
| 13th
| [[2005 World Championships in Athletics – Men's 5000 metres|5000 m]]
|
|-
| [[2005 IAAF World Athletics Final|World Athletics Final]]
| [[Monte Carlo]], Monaco
| 6th
| 5000 m
|
|-
| [[2005 Asian Athletics Championships|Asian Athletics Championships]]
| [[Incheon]], South Korea
| style="background-color:gold" | 1st
| 5000 m
|
|}

===Basic examples===
You can start to add the details immediately after using the AchievementTable template. For example, the following code:

<syntaxhighlight lang="wikitext">{| {{AchievementTable|nation=JAM}}
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 4th
| 10.04 seconds
|-
| 2008
| 2008 Summer Olympics
| Beijing, China
| 5th
| 10.08 seconds
|}</syntaxhighlight>

'''Would give you the following table:'''

{| {{AchievementTable|nation=JAM}}
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 4th
| 10.04 seconds
|-
| 2008
| 2008 Summer Olympics
| Beijing, China
| 5th
| 10.08 seconds
|}

===Event feature===
Many athletes compete in more than one event, sometimes within the same competition – [[Usain Bolt]] in the 100 and 200 metres at the 2008 Olympics for instance. If you need to note the specific event which the athlete was competing in, then you can activate the "Event" column.

<syntaxhighlight lang="wikitext">{| {{AchievementTable|Event=yes|Result=yes|nation=JAM}}
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 4th
| 100 metres
| 10.04 seconds
| {{AthAbbr|PB}}
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 8th
| 200 metres
| 20.45 seconds
|
|-
| 2008
| 2008 Summer Olympics
| Beijing, China
| 5th
| 100 metres
| 10.08 seconds
|
|-
| 2008
| 2008 Summer Olympics
| Beijing, China
| 7th
| 200 metres
| 20.31 seconds
| {{AthAbbr|NR|Spanish}}
|}</syntaxhighlight>

'''Would give you the following table:'''

{| {{AchievementTable|Event=yes|Result=yes|nation=JAM}}
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 4th
| 100 metres
| 10.04 seconds
| {{AthAbbr|PB}}
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 8th
| 200 metres
| 20.45 seconds
|
|-
| 2008
| 2008 Summer Olympics
| Beijing, China
| 5th
| 100 metres
| 10.08 seconds
|
|-
| 2008
| 2008 Summer Olympics
| Beijing, China
| 7th
| 200 metres
| 20.31 seconds
| {{AthAbbr|NR|Spanish}}
|}

===NotesOff feature===
To turn off the notes column in the table simply add "NotesOff=yes" into the template.

<syntaxhighlight lang="wikitext">{| {{AchievementTable|Event=yes|NotesOff=yes|nation=JAM}}
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 4th
| 100 metres
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 8th
| 200 metres
|}</syntaxhighlight>

'''Would give you the following table:'''
{| {{AchievementTable|Event=yes|NotesOff=yes|nation=JAM}}
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 4th
| 100 metres
|-
| 2004
| 2004 Summer Olympics
| Athens, Greece
| 8th
| 200 metres
|}

===Multiple nations representing===
'''Using this template can help you write tables like the one below'''
<syntaxhighlight lang="wikitext">
{| {{AchievementTable/sandbox|nation=GBR|nation2=ENG}}
|-
| 2001
| [[2001 IAAF World Youth Championships|World Youth Championships]]
| [[Debrecen]], Hungary
| style="background-color:#cc9966;" | 3rd
| 3000 m
|}</syntaxhighlight>
{| {{AchievementTable/sandbox|nation=GBR|nation2=ENG}}
|-
| 2001
| [[2001 IAAF World Youth Championships|World Youth Championships]]
| [[Debrecen]], Hungary
| style="background-color:#cc9966;" | 3rd
| 3000 m
|}

===Custom captions===
'''Using this template can help you write tables like the one below'''
<syntaxhighlight lang="wikitext">
{| {{AchievementTable/sandbox|caption=Sale Harriers and Texas A&M}}
|-
| 2001
| [[2001 IAAF World Youth Championships|World Youth Championships]]
| [[Debrecen]], Hungary
| style="background-color:#cc9966;" | 3rd
| 3000 m
|}</syntaxhighlight>
{| {{AchievementTable/sandbox|caption=Sale Harriers and Texas A&M}}
|-
| 2001
| [[2001 IAAF World Youth Championships|World Youth Championships]]
| [[Debrecen]], Hungary
| style="background-color:#cc9966;" | 3rd
| 3000 m
|}

===Team link column===
'''Using this template can help you write tables like the one below'''
<syntaxhighlight lang="wikitext">
{| {{AchievementTable/sandbox|Event=Yes|Time=Yes|Team=Yes}}
|-
| 2016
| [[Athletics at the 2016 Summer Olympics|Olympic Games]]
| [[Rio de Janeiro]], Brazil
| style="background-color:gold" | 1st
| [[Athletics at the 2016 Summer Olympics – Men's 5000 metres|5000 m]]
| 13:03.30
| {{flag IOC|GBR|2016 Summer}}
|}</syntaxhighlight>
{| {{AchievementTable/sandbox|Event=Yes|Time=Yes|Team=Yes}}
|-
| 2016
| [[Athletics at the 2016 Summer Olympics|Olympic Games]]
| [[Rio de Janeiro]], Brazil
| style="background-color:gold" | 1st
| [[Athletics at the 2016 Summer Olympics – Men's 5000 metres|5000 m]]
| 13:03.30
| {{flag IOC|GBR|2016 Summer}}
|}
''Note that the [[Vertical bar]]'' ( | ) ''character can be written by holding shift and pressing the'' " \ " ''key.''

==See also==
* [[Template:MedalistTable]]
* [[Template:RankedMedalTable]]
* [[Template:AthResult]]

<includeonly>{{Sandbox other||
[[Category:Sports statistics templates]]
[[Category:Athletics templates]]
}}</includeonly>