Legend: # – Record awaiting ratification by [[{{{ratifier}}}]]; WR – World record; WR – World record; AF – African record; AM – Americas record; AS – Asian record; ER – European record; OC – Oceanian record; CR – Commonwealth record; NR – [[List of {{{nation}}} records in swimming|{{{nation}}} record]]; yd – set in a pool measured in yards; {{{code1}}} – {{{legend1}}}; {{{code2}}} – {{{legend2}}}; {{{code3}}} – {{{legend3}}}; {{{code4}}} – {{{legend4}}};
Records not set in finals: h – heat;
Records not set in finals: h – heat;
Usage
This template provides a legend to abbreviations used in List of ____ records in swimming articles; World record progression articles; and Personal bests sections in the biography articles of international competitive swimmers.
{{Swimmingrecordlegend
|ratifier=
|WR=
|IPCWR=
|AF=
|AM=
|AS=
|ER=
|OC=
|CR=
|NR=
|nation=
|yd=
|code1=
|legend1=
|code2=
|legend2=
|code3=
|legend3=
|code4=
|legend4=
|sf=
|r=
|rh=
|b=
|†=
|tt=
}}
The following table indicates which fields are displayed by default and how to turn on/off the optional fields.
| Field | Description | Required/Optional? | Not defined or Defined and blank |
Defined and NOT blank |
|---|---|---|---|---|
| ratifier | Ratifier of record / governing body | Optional | 
|
N/A |
| WR | World record | Optional |
|
|
| IPCWR | IPC World record | Optional |
|
|
| AF | African record | Optional |
|
|
| AM | Americas record | Optional |
|
|
| AS | Asian record | Optional |
|
|
| ER | European record | Optional |
|
|
| OC | Oceania record | Optional |
|
|
| CR | Commonwealth record | Optional |
|
|
| NR | National record | Optional |
|
|
| nation | National record - Nation | Required if NR is defined and not blank |
|
N/A |
| yd | Record set pool measured in yards | Optional |
|
|
| Record set in heat | Always displayed |
|
| |
| sf | Record set in semifinal | Optional |
|
|
| r | Record set in relay 1st leg | Optional |
|
|
| rh | Record set in relay heat 1st leg | Optional |
|
|
| b | Record set in B-final | Optional |
|
|
| † | Record set en route to final mark | Optional |
|
|
| tt | Record set in a time trial | Optional |
|
|
| code1 | Custom legend code | Optional |
|
N/A |
| legend1 | Custom legend description | Required if code1 is defined and not blank |
|
N/A |
| code2 | Custom legend code | Optional |
|
N/A |
| legend2 | Custom legend description | Required if code2 is defined and not blank |
|
N/A |
| code3 | Custom legend code | Optional |
|
N/A |
| legend3 | Custom legend description | Required if code3 is defined and not blank |
|
N/A |
| code4 | Custom legend code | Optional |
|
N/A |
| legend4 | Custom legend description | Required if code4 is defined and not blank |
|
N/A |
Generally we define the optional field as yes to display them (for default off fields) and no to remove them (for default on fields).
The examples below show how to use the ratifier, NR/nation and code1/legend1 fields.
Usage examples
- Lists of records in swimming articles
World records:
{{Swimmingrecordlegend|ratifier=International Swimming Federation{{!}}FINA}}
Legend: # – Record awaiting ratification by FINA;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
Continental records:
{{Swimmingrecordlegend|ratifier=Ligue Européenne de Natation{{!}}LEN|WR=yes}}
Legend: # – Record awaiting ratification by LEN; WR – World record;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
National records:
{{Swimmingrecordlegend|ratifier=British Swimming|WR=yes|ER=yes|CR=yes}}
Legend: # – Record awaiting ratification by British Swimming; WR – World record; ER – European record; CR – Commonwealth record;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
Event/championships with no timetrials, no B-finals, and intermediate records not recognised:
{{swimmingrecordlegend|ratifier=International University Sports Federation{{!}}FISU|WR=yes|†=no|tt=no|b=no}}
Legend: # – Record awaiting ratification by FISU; WR – World record;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
Event/championships with no timetrials, no semifinals, no relays and intermediate records not recognised:
{{swimmingrecordlegend|ratifier=FINA|WR=yes|r=no|sf=no|tt=no|b=no}}
Legend: # – Record awaiting ratification by FINA; WR – World record;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
Event/championships with no timetrials, no semifinals, no B-final, and intermediate records not recognised:
{{Swimmingrecordlegend|ratifier=International Paralympic Committee{{!}}IPC|IPCWR=yes|tt=no|sf=no|b=no|†=no}}
Legend: # – Record awaiting ratification by IPC; WR – World record;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
- Personal bests section of swimmer's biography article
{{swimmingrecordlegend|WR=yes|ER=yes|nation=Swedish}}
Legend: WR – World record; ER – European record; NR – Swedish record;
Records not set in finals: h – heat;
Records not set in finals: h – heat;
- World record progression article
{{swimmingrecordlegend|ratifier=FINA|yd=yes}}
Legend: # – Record awaiting ratification by FINA; yd – set in a pool measured in yards;
Records not set in finals: h – heat;
Records not set in finals: h – heat;