Nwuan a̱tyin ka a li Ta‌̱mpi‌̱let:AthResult/doc

{{Documentation subpage}}
{{TOC right}}
The '''AthResult''' template is for usage on [[sport of athletics|athletics]] and [[track and field]] athlete biographies. It must be used in conjunction with the [[Template:AchievementTable|AchievementTable template]] to work properly.

AthResult is a semi-automated, non-intrusive method of quickly inserting a particular athlete's performance at a major competition. It must always be [[Wikipedia:Substitution|substituted]] to allow for easy future reading and editing, and to reduce template recall overheads.

==Usage==
:''See [[Template:AchievementTable]] for basic usage of that template''
The basic usage of the template is as follows:
<nowiki>{{subst:AthResult|YEAR|COMPETITION|LOCATION|RESULT|GENDER|EVENT}}</nowiki>

The information appears in the template in roughly the same order as it appears when placed on a page. Once the substituted template is saved on to a page, the resulting entry will automatically become plain text, matching entries done in the usual manual style.

==Parameters==

===A̱lyia̱===
*The first parameter is the year of the competition you want to add (e.g. 2012).

===A̱yangka̱nan===
*The second parameter denotes the competition. There are limited number of specific codes which correspond to the competitions which may be added:
{{col-begin}}
{{col-4}}
;Games
*OG = Summer Olympics
*UNI= [[Athletics at the Summer Universiade]]
*MWG= [[Track and field at the Military World Games]]
*AG= [[Athletics at the Asian Games]]
*AIG= [[Indoor athletics at the Asian Indoor Games]]
*AAG= [[Athletics at the All-Africa Games]]
*PAG= [[Athletics at the Pan American Games]]
*ARA= [[Athletics at the Pan Arab Games]]
*CWG= [[Athletics at the Commonwealth Games]]
*CACG= [[Athletics at the Central American and Caribbean Games]]
*EAG= [[Athletics at the East Asian Games]]
*SAG=[[Athletics at the South Asian Games]]
*SEAG=[[Athletics at the Southeast Asian Games]]
*LUG=[[Athletics at the Lusophony Games]]
*GWG=[[Athletics at the Goodwill Games]]
*JF=[[Athletics at the Jeux de la Francophonie]]
*MG=[[Athletics at the Mediterranean Games]]
*BG=[[Athletics at the Bolivarian Games]]
*CAG=[[Athletics at the Central American Games]]
*SAMG=[[Athletics at the South American Games]]
*PACG=[[Athletics at the Pacific Games#.28South.29 Pacific Games|Athletics at the Pacific Games]]
*PACMG=[[Athletics at the Pacific Games#.28South.29 Pacific Mini Games|Athletics at the Pacific Mini Games]]
*SPG=[[Athletics at the Pacific Games#.28South.29 Pacific Games|Athletics at the Pacific Games]]
*SPMG=[[Athletics at the Pacific Games#.28South.29 Pacific Mini Games|Athletics at the South Pacific Mini Games]]
*MICG=[[Athletics at the Micronesian Games]]
*ALBA=[[Athletics at the ALBA Games]]
*{{col-4}}
;Track and field championships

*WC= [[World Athletics Championships]]
*WIC= [[World Athletics Indoor Championships]]
*AFC=[[African Championships in Athletics]]
*ASC=[[Asian Athletics Championships]]
*AIC=[[Asian Indoor Athletics Championships]]
*CACC=[[Central American and Caribbean Championships in Athletics|CAC Championships]]
*EC=[[European Athletics Championships]]
*EIC=[[European Athletics Indoor Championships]]
*ETC=[[European Athletics Team Championships|European Team Championships]]
*SAC=[[South American Championships in Athletics]]
*CAMC=[[Central American Championships in Athletics|Central American Championships]]
*OAC=[[Oceania Athletics Championships|Oceania Championships]]
*IBC=[[Ibero-American Championships in Athletics]]
{{col-4}}
;Road and XC championships
*WXC= [[World Athletics Cross Country Championships]]
*AFXC=[[African Cross Country Championships]]
*ASXC=[[Asian Cross Country Championships]]
*EXC=[[European Cross Country Championships]]
*WRW= [[World Athletics Race Walking Team Championships]]
*ERW=[[European Race Walking Cup]]
*PARW=[[Pan American Race Walking Cup]]
*SAXC=[[South American Cross Country Championships]]
*SARW=[[South American Race Walking Cup]]
*WHM= [[World Half Marathon Championships]]
{{col-4}}
;Age category
*WJC= [[World Junior Championships in Athletics]]
*WYC= [[World Youth Championships in Athletics]]
*AFJC=[[African Junior Athletics Championships]]
*ASJC=[[Asian Junior Athletics Championships]]
*CAR=[[CARIFTA Games]]
*CARJ=[[CARIFTA Games|CARIFTA Games (U-20)]]
*CARY=[[CARIFTA Games|CARIFTA Games (U-17)]]
*CACJC=[[Central American and Caribbean Junior Championships in Athletics|CAC Junior Championships (U-20)]]
*CACYC=[[Central American and Caribbean Junior Championships in Athletics|CAC Junior Championships (U-17)]]
*EU23= [[European Athletics U23 Championships]]
*EJC= [[European Athletics Junior Championships]]
*NAU23= [[NACAC Under-23 Championships in Athletics]]
*PAJC= [[Pan American Junior Athletics Championships]]
*SAU23=[[South American Under-23 Championships in Athletics]]
*SAJC= [[South American Junior Championships in Athletics]]
*SAYC= [[South American Youth Championships in Athletics]]
*OAJC= [[Oceania Junior Athletics Championships|Oceania Junior Championships]]
*OAYC= [[Oceania Youth Athletics Championships|Oceania Youth Championships]]
*WMAO= [[World Masters Athletics Championships|World Masters Outdoor Athletics Championships]]
*WMAI= [[World Masters Athletics Championships|World Masters Indoor Athletics Championships]]
{{col-end}}

===A̱vwuo===
The third parameter denotes the location of the competition. Typical usage is to link the host city followed by its country unlinked (e.g. <nowiki>[[Berlin]], Germany</nowiki>).

===Result===
The fourth parameter corresponds to the finishing position of the athlete at that event (e.g. 1st, 2nd, 9th). Medal colours are automatically added. Qualifying statements may also be added if desired, for example, "20th (heats)".

===Gender===
The fifth parameter denotes the gender of the competition in which the athlete is competing: either '''Men''' or '''Women'''. This parameter is used to generate links to event result articles when they are present.

===Event===
The sixth parameter denotes the specific athletic event in which the athlete is competing (e.g. 100 metres, shot put, decathlon, marathon). This should not be linked.

==Example==
The code listed below will produce the following table.  The first entry demonstrates how to insert notes alongside the template. The Olympic and European entries demonstrate how event result articles are automatically linked. The Asian Games entry links to the larger "Athletics Results" page.<br>

<pre>
{| {{AchievementTable|Event=yes}}
|-
{{subst:AthResult|2003|MWG|[[Catania]], Italy|1st|Women|10,000 metres}}
|33:42.10
|-
{{subst:AthResult|2004|OG|[[Athens]], Greece|2nd|Men|Discus throw}}
|-
{{subst:AthResult|2006|IBC|[[Ponce, Puerto Rico]]|3rd|Women|100 metres}}
|-
{{subst:AthResult|2010|AG|[[Beijing]], China|4th|Men|Javelin throw}}
|-
{{subst:AthResult|2011|EIC|[[Paris]], France|5th|Women|3000 metres}}
|}
</pre>

{| {{AchievementTable|Event=yes}}
|-
|2003
|[[Track and field at the 2003 Military World Games|Military World Games]]
|[[Catania]], Italy
|bgcolor=gold|1st
|10,000 metres
|33:42.10
|-
|2004
|[[Athletics at the 2004 Summer Olympics|Olympic Games]]
|[[Athens]], Greece
|bgcolor=silver|2nd
|[[Athletics at the 2004 Summer Olympics – Men's discus throw|Discus throw]]
|-
|2006
|[[2006 Ibero-American Championships in Athletics|Ibero-American Championships]]
|[[Ponce, Puerto Rico]]
|bgcolor=cc9966|3rd
|100 metres
|-
|2010
|[[Athletics at the 2010 Asian Games|Asian Games]]
|[[Beijing]], China
|4th
|[[Athletics at the 2010 Asian Games – Results|Javelin throw]]
|-
|2011
|[[2011 European Athletics Indoor Championships|European Indoor Championships]]
|[[Paris]], France
|5th
|[[2011 European Athletics Indoor Championships – Women's 3000 metres|3000 metres]]
|}

==Fixing rowspan issues==
If several entries refer to the same year then the rowspan parameter can be used. If omitted this defaults to 1 and will enter the year for a single line as normal. For example, the following code produces the following result:

<pre>
{| {{AchievementTable}}
|-
{{subst:AthResult|2000|OG|[[Sydney]], Australia|1st|Men|200 metres|rowspan=3}}
|-
{{subst:AthResult|2000|OG|[[Sydney]], Australia|1st|Men|400 metres|rowspan=0}}
|-
{{subst:AthResult|2000|OG|[[Sydney]], Australia|1st|Men|800 metres|rowspan=0}}
|-
{{subst:AthResult|2004|OG|[[Athens]], Greece|1st|Men|1500 metres}}
|}
</pre>

{| {{AchievementTable}}
|-
|rowspan=3| 2000
|[[Athletics at the 2000 Summer Olympics|Olympic Games]]
|[[Sydney]], Australia
|bgcolor=gold|1st
|[[Athletics at the 2000 Summer Olympics – Men's 200 metres|200 metres]]
|-

|[[Athletics at the 2000 Summer Olympics|Olympic Games]]
|[[Sydney]], Australia
|bgcolor=gold|1st
|[[Athletics at the 2000 Summer Olympics – Men's 400 metres|400 metres]]
|-

|[[Athletics at the 2000 Summer Olympics|Olympic Games]]
|[[Sydney]], Australia
|bgcolor=gold|1st
|[[Athletics at the 2000 Summer Olympics – Men's 800 metres|800 metres]]
|-
| 2004
|[[Athletics at the 2004 Summer Olympics|Olympic Games]]
|[[Athens]], Greece
|bgcolor=gold|1st
|[[Athletics at the 2004 Summer Olympics – Men's 1500 metres|1500 metres]]
|}

==Known issues==

*Where a table has both "Event" and "Notes" columns, notes can be manually added by placing them after a vertical bar "|" on the line below the AthResult code.

*For athletes who compete in just one event specifically (high jumpers for instance), this template will still generate the event name for each and every entry.

==Bu nwuan==
*[[Template:AchievementTable]]
*[[Template:MedalistTable]]
*[[Template:RankedMedalTable]]