Template:Team appearances list/doc

This is a documentation subpage for Template:Team appearances list.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Team appearances list (sandbox)

This template produces a horizontal list of team appearances at a specified sports competition, each item being in the format

[[<team> at the <year> <competition>|<year>]].

{{Team appearances list}} is principally meant for use in conjunction with {{Infobox country at games}} and {{country at games navbox}}.

Usage

The following is the base template with all parameters:

{{team appearances list|team=|competition=|begin_year=|end_year=|interval=}}

The following parameters are required:

team: The name of the team participating.
competition: The name of the competition, in Title Case (e.g. Summer Youth Olympics). The full list of competitions is at Module:Team appearances list/data.

The following are optional parameters:

begin_year: The first year the team participated in the competition. If omitted, will start with the first year the competition was held.
end_year: May be defined if either the competition or team is now defunct.
interval: The length of time between successive appearances. This parameter is required if competition is not on record, and will be ignored if the competition is in the /data module.

Additionally, any number of positional parameters may be specified, each of which must be a year (or year range) in which the team was absent from the competition. These parameters will be ignored if the data module already contains the team's absences.

Examples

Games stored in the module

For Games stored in the data submodule, there is no need to input the beginning year or interval. Missing competitions or appearances should be reported to the template talk page. Note that if successive games are omitted, they are combined for ease of reading.

{{Team appearances list
| team        = Honduras
| competition = Pan American Games
}}

{{Team appearances list
|competition=Pan American Games
|team=Paraguay
}}

{{Team appearances list
|competition= Summer Paralympics
|team= Russia
}}

1996
2000
2004
2008
2012
2016–2024

If years are included that are not in the range (i.e. before begin_year) they will not be included.

{{Team appearances list
|begin_year=2000
|competition= Summer Paralympics
|team= Russia
}}

2000
2004
2008
2012
2016–2024

Games not stored in the module

For Games not stored in |the data submodule, the interval (|interval=) across which the Games takes place, as well as the first year the team appeared |begin_year=), are required. Missing competitions or appearances should be reported to the template talk page.

{{Team appearances list
|competition = African Youth Games
|begin_year=2010
|team = Tunisia
|interval = 4
}}

{{Team appearances list
|competition = African Youth Games
|begin_year=2010
|team = Tunisia
|interval = 4
|2014 | 2018
}}

2010
2014–2018
2022
2026

Note that if successive games are omitted, they are combined for ease of reading. If years are included that are not in the range (i.e. before begin_year) they will not be included.