This is a documentation subpage for Template:Swimmingrecordlisttop. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
editThis set of templates are being designed to be used for records in swimming articles in order to obtain a consistent layout and data field presence throughout all the articles.
{{swimmingrecordlisttop
|caption =
|nationality =
|club =
|meet =
}}
{{swimmingrecord
|eventsort =
|event =
|class =
|time =
|recordinfo =
|splits =
|firstname =
|lastname =
|namearticle =
|chinesename =
|nation =
|nationvariant =
|npc =
|club =
|date = {{Date table sorting|YYYY|mmm|DD}}
|meet =
|city =
|cityarticle =
|country =
|countryvariant =
|ref = <ref>{{cite web |url= |title= |accessdate= |publisher= |date= }}</ref>
}}
{{swimmingrecordrelay
|eventsort =
|event =
|time =
|recordinfo =
|1lastname =
|1name =
|1split =
|2name =
|2split =
|3name =
|3split =
|4name =
|4split =
|nation =
|nationvariant =
|npc =
|club =
|date = {{Date table sorting|YYYY|mmm|DD}}
|meet =
|city =
|cityarticle =
|country =
|countryvariant =
|ref = <ref>{{cite web |url= |title= |accessdate= |publisher= |date= }}</ref>
}}
{{end}}
{{Swimmingrecordlegend
|ratifier=
|WR=
|IPCWR=
|AF=
|AM=
|AS=
|ER=
|OC=
|CR=
|NR=
|nation=
|yd=
|code1=
|legend1=
|sf=
|r=
|rh=
|b=
|†=
|tt=
}}
Parameters
editParameter | Swimmingrecord | Swimmingrecordrelay | Required, Optional or Conditional |
Description |
---|---|---|---|---|
caption | Required | Meaningful text for a table caption, required for accessibility | ||
eventsort | 01 | Required | A double digit number to allow event column sorting starting from 01. Correct order is as used by FINA: first ordered by stroke: freestyle, backstroke, breaststroke, butterfly, individual medley, freestyle relay, medley relay; then ordered within each stroke by distance | |
event | 800 m freestyle | 4×50 m medley relay | Required | Name of event, ensuring non breaking space between number and unit; 4×__ for relays (not 4x__); all stroke/event names in lowercase text |
class | SM6 | Conditional | Used to display disability classification for Paralympic records Condition: {{swimmingrecordlisttop|class=yes}} | |
time | 1:42.78 | Required | Record time in format: m:ss.00 | |
recordinfo | #, WR, ER, NR | Optional | See key below for example text items – each separated by a space | |
splits | 31.02, 32.44, 32.54, 32.99, 33.78, 32.63, 32.51, 30.67 | Optional | Displays intermediate split times under swimmers name. | |
firstname | Firstname | Required | Athlete's first and last name – allows correct sorting in name column. | |
lastname | Lastname | |||
namearticle | Firstname Lastname (swimmer) | Optional | Article title for athlete where disambiguation is required. | |
chinesename | Optional | Allows display of family name before personal name, yet sorts by family name. | ||
1lastname | Lastname | Optional | Surname of 1st relay athlete to allow sorting on name column | |
1name 2name 3name 4name ... up to 10 |
Firstname Lastname | Required | Relay athlete name in correct swim order. Use the form "[[Firstname Lastname (swimmer)|Firstname Lastname]]" where disambiguation is required | |
1split 2split 3split 4split ... up to 10 |
1:59.32 | Optional | Relay split time in format m:ss.00 | |
nation | CAN | Conditional | Three letter country code for nationality – See List of IOC country codes or ISO 3166-1 alpha-3 Condition: {{swimmingrecordlisttop|nationality=yes}} to be defined – if defined, nation must be defined and NOT be blank in {{swimmingrecord}}. | |
nationvariant | Optional | |||
npc | Optional | Use instead of nation to display link to Nations at the Paralympics articles – use three letter country code for nationality – See List of IOC country codes. | ||
club | [[Club article|Club name]] or Club name |
Conditional | Condition: {{swimmingrecordlisttop|club=yes}} to be defined – if defined, club must be defined and NOT be blank in {{swimmingrecord}} (if unknown, it is suggested using a dash). | |
date | {{Date table sorting|YYYY|mmm|DD}} | Required | Use {{Date table sorting}} template to ensure sorting works correctly for the date column. For day-month-year format use |format=dmy .
| |
meet | [[Meet or Championships article|Meet short name excl. year]] or Meet short name excl. year |
Conditional | Condition: {{swimmingrecordlisttop|meet=yes}} to be defined – if defined, meet must be defined and NOT be blank in {{swimmingrecord}} (if unknown, it is suggested using a dash). | |
city | Berlin | Optional | City name | |
cityarticle | Berlin, Germany | Optional | Article title for city where disambiguation is required | |
country | MAS | Required | Three letter country code for event location – See List of IOC country codes or ISO 3166-1 alpha-3 | |
countryvariant | Optional | |||
ref | Optional | Use <ref>{{cite web |url= |title= |accessdate= |publisher= |date= }}</ref>, completing parameters as necessary |
Recordinfo options key
edit- WR: World record
- OR: Olympic record
- CR: Commonwealth record
- ER: European record
- AF: African record
- AS: Asian record
- OC: Oceania record
- AM: Americas record
- #: Any records yet to be officially ratified by the relevant governing body, i.e. not yet appearing on the official records list. (Reference for all records of this type is required)
- Records not set in finals:
- h: Heats
- r: Relay 1st leg
- rh: Relay 1st leg heats
- sf: Semifinal
- b: B-final
- tt: Time-trail
- †: Intermediate split
See Template:Swimmingrecordlegend for more.
See also
edit- Template:Swimmingrecordlisttop
- Template:Swimmingrecord
- Template:Swimmingrecordrelay
- Template:Swimmingrecordlegend