Module:Sports series/doc

This is a module for generating match results for a sports series, such as a two-legged tie. However, the module can support single-match ties up to an unlimited number of legs. The template supports domestic and international club matches, as well as national team matches. While deisgned for association football, it can be used for any sport that features a series between teams.

Usage

In its simplest form, only a few parameters are needed to build a table.

International club football

{{#invoke:Sports series|main
|first_club|first_country|aggregate|second_club|second_country|first_leg|second_leg
}}

Domestic club football

{{#invoke:Sports series|main|flag=n
|first_club|first_country|aggregate|second_club|second_country|first_leg|second_leg
}}

National team football

{{#invoke:Sports series|main|type=NT
|first_nation|aggregate|second_nation|first_leg|second_leg
}}

Examples

International club football

Usage

{{#invoke:Sports series|main|bold_winner=y
|[[Arsenal F.C.|Arsenal]]|ENG|2–3|[[FC Bayern Munich|Bayern Munich]]|GER|2–2|0–1
|[[Atlético Madrid]]|ESP|4–5|[[Borussia Dortmund]]|GER|2–1|2–4
|[[Real Madrid CF|Real Madrid]]|ESP|4–4 {{pen|4–3}}|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{aet}}
|[[Paris Saint-Germain F.C.|Paris Saint-Germain]]|FRA|6–4|[[FC Barcelona|Barcelona]]|ESP|2–3|4–1
}}

Output

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
Arsenal	2–3	Bayern Munich	2–2	0–1
Atlético Madrid	4–5	Borussia Dortmund	2–1	2–4
Real Madrid	4–4 (4–3 p)	Manchester City	3–3	1–1 (a.e.t.)
Paris Saint-Germain	6–4	Barcelona	2–3	4–1

Domestic club football

Usage

{{#invoke:Sports series|main|bold_winner=y|flag=n
|[[Real Madrid CF|Real Madrid]]|7–3|[[Girona FC|Girona]]|4–2|3–1
|[[Getafe CF|Getafe]]|2–3|[[Valencia CF|Valencia]]|1–0|1–3
|[[Sevilla FC|Sevilla]]|3–6|[[FC Barcelona|Barcelona]]|2–0|1–6
|[[RCD Espanyol|Espanyol]]|2–4|[[Real Betis]]|1–1|1–3 {{aet}}
}}

Output

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
Real Madrid	7–3	Girona	4–2	3–1
Getafe	2–3	Valencia	1–0	1–3
Sevilla	3–6	Barcelona	2–0	1–6
Espanyol	2–4	Real Betis	1–1	1–3 (a.e.t.)

National team football

Usage

{{#invoke:Sports series|main|type=NT|bold_winner=y
|UKR|3–1|SVN|2–0|1–1
|SWE|4–3|DEN|2–1|2–2
|BIH|1–3|IRL|1–1|0–2
|NOR|1–3|HUN|0–1|1–2
}}

Output

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
UKR Template:Country data 3–1	SVN	Template:Country data 1–1 2–0	SWE	4–3
DEN Template:Country data 2–1	2–2	Template:Country data 1–3 BIH	IRL	1–1
0–2	1–3	Template:Country data 0–1 HUN	1–2

Parameter list

Below is a full list of template parameters. All parameters are optional.

Parameter name	Description	Type
type type	Determines the type of competition to be featured. Valid values are club (default, for club competitions) or NT (for national team competitions).	String
flag flag	Determines the flag icon template which will be used in the table. The default for |type=club is {{fbaicon}}, while the default for |type=NT is {{fb}}. If set to a negative value (e.g. n, no, 0), no flags will be displayed for |type=club (this will have no impact if |type=NT). For |type=NT, the text "-rt" is always added to the end of the template name for the first team column, allowing for the flag to be aligned to the right side of the cell. For |type=club, flags are displayed next to club names, while for |type=NT the national team codes/names are wrapped into the national team flag template. To support national team flag templates that use the first parameter to pass a special value (e.g. for youth team templates, such as {{fbu}} which passes the age level), use a "+" in between the template name and the first parameter value (e.g. |flag=fbu+17 generates code for {{fbu|17|<country>}}).	String
legs legs	Determines the number of legs that will be displayed in the table, and how many scores are expected to be passed to each row. The default is 2. If set to a negative value (e.g. n, no, 0), the table will display no legs and will be formatted to display the results of single-leg ties (the aggregate column header will then be changed to "Score").	Number
bold_winner bold_winner	To enable, set to a positive value (e.g. y, yes, 1). Automatically bolds the winning team of the tie. First priority is given to the winning team of scores listed inside brackets (which is commonly used to denote the results of a penalty shoot-out). Otherwise, the regular score will be used. If the aggregate scores are level (such as ties decided on away goals) or no winner can be determined based on the input, neither team in a given tie will be bolded.	String
color_winner color_winner	To enable, set to a positive value (e.g. y, yes, 1). Automatically colors the winning team of the tie with a background color of green (#CCFFCC). First priority is given to the winning team of scores listed inside brackets (which is commonly used to denote the results of a penalty shoot-out). Otherwise, the regular score will be used. If the aggregate scores are level (such as ties decided on away goals) or no winner can be determined based on the input, neither team in a given tie will be colored.	String
collapsed collapsed	To enable, set to a positive value (e.g. y, yes, 1). If set, it collapses the table using mw-collapsed.	String
caption caption	Adds a caption to the table.	String
title title	Adds a title to the table in the form of a table header spanning all columns, placed above the standard column headings.	String
id id	Adds an anchor to the top of the table which allows direct linking to the table.	String
nowrap nowrap	To enable, set to a positive value (e.g. y, yes, 1). Adds a nowrap value to the table style.	String
fill_blanks fill_blanks	To enable, set to a positive value (e.g. y, yes, 1). Adds a placeholder flag icon to the space next to a team's name when flag parameters are present in the table, but the parameter for a given team is left blank (for |type=club) or does not contain a flag (for |type=NT). This will have no impact if |flag=false.	String
team_width team_width	Set to an integer value for the width of the two team columns, in pixels. Default is 250.	Number
score_width score_width	Set to an integer value for the width of the aggregate score column and each leg score column, in pixels. Default is 80.	Number
team1 team1	Adds a custom heading for the first team column. Default is Team 1.	String
team2 team2	Adds a custom heading for the second team column. Default is Team 2.	String
h_a h_a	To enable, set to a positive value (e.g. y, yes, 1). Changes the default column headers for the teams to "Home" and "Away". If |team1= and/or |team2= is set, those respective parameter(s) will override headers set by |h_a=.	String
aggregate aggregate	Adds a custom heading for the aggregate score column. Default is {{Abbrlink|Agg.|Aggregate score}}, unless |legs= is set to a negative value (e.g. n, no, 0), for which the default will be Score.	String
legN legN	Adds a custom heading for the Nth leg column (e.g. |leg1= for the first leg column, |leg3= for the third leg column, etc.). Default is <ordinal> leg (e.g. 1st for the first leg column, 3rd for the third leg column, etc.).	String
headingN headingN	Adds a custom heading spanning all columns above the Nth row of the table (e.g. |heading1= for above the first row, |heading20= for above the twentieth row, etc.).	String

Other features/notes

Please note that in order to display a row in the table, at least one cell of said row must have value that is not empty or whitespace. Otherwise, the module will not create a row for that line and all others below it.

Team names/codes

For |type=club, the country codes supplied for each club are by default wrapped into {{fbaicon}}, based on Wikipedia's country data system of templates, and displayed next to each team.

For |type=NT, the national team names/codes supplied are by default wrapped into {{fb}} and {{fb-rt}}, based on Wikipedia's country data system of templates.

Leg scores

If a cell of one of the leg scores contains only null, the cell will not be generated. This is useful for rounds of competitions that have an inconsistent number of legs for a round, for example competitions that have a possible replay or play-off match after two legs.

Usage

{{#invoke:Sports series|main|type=NT|legs=3|bold_winner=y|leg3=Play-off
|LUX|5–6|DEN|3–3|2–2|0–1
|ESP+1945|7–1|IRL|5–1|2–0|null
|FRA|2–5|HUN|1–3|1–2|null
|SWE|2–4|URS|1–1|1–3|null
}}

Output

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg	Play-off
LUX Template:Country data 5–6	DEN	Template:Country data 2–2 3–3	0–1	ESP+1945	7–1
IRL Template:Country data 5–1	2–0	null	2–5	HUN	1–3
1–2 Template:Country data null	SWE	2–4	1–1	1–3	—

Quasi-parameters

Plus sign (+) for flag templates/youth level

Some youth national team flag templates, such as {{fbu}}, have an additional parameter to pass the age level to be linked within to template. To accomodate, this module supports within the |flag= parameter the use of a plus sign (+) in between the name of the flag template and the age level. For example, |flag=fbu+17 will generate a flag template in the form of {{fbu|17|<country>}}. This only applies for |type=NT. If the portion before the plus sign is a negative value (e.g. n, no, 0), the default flag template ({{fb}}) will be used.

Usage

{{#invoke:Sports series|main|type=NT|flag=fbu+17|bold_winner=y
|LUX|5–6|DEN|3–3|2–2
|ESP|7–1|IRL|5–1|2–0
|FRA|2–5|HUN|1–3|1–2
|SWE|2–4|NOR|1–1|1–3
}}

Output

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
LUX Template:Country data 5–6	DEN	Template:Country data 2–2 3–3	ESP	7–1
IRL Template:Country data 5–1	2–0	Template:Country data 2–5 FRA	HUN	1–3
1–2	2–4	Template:Country data 1–1 NOR	1–3

Plus sign (+) for country codes/flag variants

To allow for the use of flag variants, this module supports within country parameters (the country code parameter for |type=club, or the national team name/code parameter for |type=NT), the use of a plus sign (+) in between the country name/code and the name of the flag variant.

Usage 1

{{#invoke:Sports series|main|type=NT|bold_winner=y
|MLT+1943|5–6|GRE+old|3–3|2–2
}}

Output 1

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
MLT+1943 Template:Country data 5–6	GRE+old	Template:Country data 2–2 3–3

Usage 2

{{#invoke:Sports series|main|bold_winner=y
|[[Atlético Madrid]]|ESP+1945|4–5|[[Borussia Dortmund]]|GER+empire|2–1|2–4
}}

Output 2

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
Atlético Madrid	4–5	Borussia Dortmund	2–1	2–4

Asterick (*) for strings instead of national teams

By default, when |type=NT is set, the team parameters wrap into a flag template. However, it may be desired to pass a plan string to the template without a flag icon, for example as placeholder text for a team that will advance from a prior round. In this case, starting the team parameter with an asterick (*), followed by the text to be displayed, will result in the text showing in that team's cell instead of being wrapped into a flag template. If |fill_blanks= is set to a positive value (e.g. y, yes, 1), a placeholder flag will also be displayed.

Usage 1

{{#invoke:Sports series|main|type=NT|bold_winner=y
|FRA|2–5|HUN|1–3|1–2
|SWE||*Winner QF1||
}}

Output 1

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
FRA Template:Country data 2–5	HUN	Template:Country data 1–2 1–3	SWE
*Winner QF1

Usage 2

{{#invoke:Sports series|main|type=NT|bold_winner=y|fill_blanks=y
|FRA|2–5|HUN|1–3|1–2
|SWE||*Winner QF1||
}}

Output 2

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
FRA Template:Country data 2–5	HUN	Template:Country data 1–2 1–3	SWE
*Winner QF1

Three apostrophes (''') for manual bolding

While the template allows for automatic bolding of winning teams via |bold_winner=y, in some situations (such as matches tied on away goals) the module will be unable to determine the winner. Or, some users may find it undesirable to use |bold_winner= to determine the winner automatically. In these cases, manual bolding can be used to indicate the winning team of a tie. This is simple to do for |type=club, by placing the three apostrophes before and after the name of the team. Additionally, the module supports using three apostrophes around both sides of the national team name/code for |type=NT. If |bold_winner= is set, the team that is manually bolded will override the winning team as determined by the module. If |color_winner= is also set, the cell of the team that is manually bolded will also be colored.

This may be used in conjunction with the below method by using five apostrophes on either side of a team to bold and color the cell.

Usage 1

{{#invoke:Sports series|main|type=NT
|LUX|5–6|'''DEN'''|3–3|2–2
|'''ESP'''|7–1|IRL|5–1|2–0
|FRA|2–5|'''HUN'''|1–3|1–2
|SWE|2–4|'''NOR'''|1–1|1–3
}}

Output 1

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
LUX Template:Country data 5–6	DEN	Template:Country data 2–2 3–3	ESP	7–1
IRL Template:Country data 5–1	2–0	Template:Country data 2–5 FRA	HUN	1–3
1–2	2–4	Template:Country data 1–1 NOR	1–3

Usage 2 (overriding |bold_winner=)

{{#invoke:Sports series|main|type=NT|bold_winner=y
|LUX|5–6|DEN|3–3|2–2
|ESP|7–1|'''IRL'''|5–1|2–0
}}

Output 2 (overriding |bold_winner=)

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
LUX Template:Country data 5–6	DEN	Template:Country data 2–2 3–3	ESP	7–1
IRL Template:Country data 5–1	2–0

Two apostrophes ('') for manual coloring

While the template allows for automatic coloring of the cells of winning teams via |color_winner=y, in some situations (such as matches tied on away goals) the module will be unable to determine the winner. Or, some users may find it undesirable to use |color_winner= to determine the winner automatically. In these cases, manual coloring can be used to indicate the winning team of a tie. This is simple to do for |type=club, by placing the two apostrophes before and after the name of the team. Additionally, the module supports using two apostrophes around both sides of the national team name/code for |type=NT. If |color_winner= is set, the cell of team that is manually colored will override the winning team as determined by the module. If |bold_winner= is also set, the cell of the team that is manually colored will also be bolded.

This may be used in conjunction with the below method by using five apostrophes on either side of a team to color and bold the cell.

(Note: While two apostrophes surrounding both sides of text are usually used to add italics in wikitext, the usage was modified here to allow for a simple way to color the cell. Therefore, it is not possible to italicize team names using this formatting.)

Usage 1

{{#invoke:Sports series|main|type=NT
|LUX|5–6|''DEN''|3–3|2–2
|''ESP''|7–1|IRL|5–1|2–0
|FRA|2–5|''HUN''|1–3|1–2
|SWE|2–4|''NOR''|1–1|1–3
}}

Output 1

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
LUX Template:Country data 5–6	DEN	Template:Country data 2–2 3–3	ESP	7–1
IRL Template:Country data 5–1	2–0	Template:Country data 2–5 FRA	HUN	1–3
1–2	2–4	Template:Country data 1–1 NOR	1–3

Usage 2 (overriding |color_winner=)

{{#invoke:Sports series|main|type=NT|color_winner=y
|LUX|5–6|DEN|3–3|2–2
|ESP|7–1|''IRL''|5–1|2–0
}}

Output 2 (overriding |color_winner=)

Team 1	Agg. Tooltip Aggregate score	Team 2	1st leg	2nd leg
LUX Template:Country data 5–6	DEN	Template:Country data 2–2 3–3	ESP	7–1
IRL Template:Country data 5–1	2–0

See also

• Module:Sports results
• Module:Sports table