Module:Sports series/doc explained

This is a module for generating match results for a sports series, such as a two-legged tie. However, the module can support single-leg 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

For two-legged ties in international club football, seven parameters are expected to be passed for each row. This includes each club's name and national association country name/code, the aggregate score and the score of both legs.

{{#invoke:Sports series|main
|first_club|first_association|aggregate|second_club|second_association|first_leg|second_leg
}}

Domestic club football

For two-legged ties in domestic club football, five parameters are expected to be passed for each row. This includes each club's name, the aggregate score and the score of both legs.

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

National team football

For two-legged ties in national team football, five parameters are expected to be passed for each row. This includes each national team's name/code, the aggregate score and the score of both legs.

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

Examples

International club football

Usage
{{#invoke:Sports series|main
|[[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

Domestic club football

Usage
{{#invoke:Sports series|main|flag=n
|[[Valencia CF|Valencia]]|3–3 {{pso|3–2}}|[[Deportivo Alavés|Alavés]]|2–1|1–2 {{aet}}
|[[Atlético Madrid]]|2–5|[[Sevilla FC|Sevilla]]|1–2|1–3
|[[RCD Espanyol|Espanyol]]|1–2|[[FC Barcelona|Barcelona]]|1–0|0–2
|[[CD Leganés|Leganés]]|2–2 ([[Away goals rule|a]])|[[Real Madrid CF|Real Madrid]]|0–1|2–1
}}
Output

Men's national team football

Usage
{{#invoke:Sports series|main|type=NT
|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

Women's national team football

Usage
{{#invoke:Sports series|main|type=WNT
|SRB|2–3|ISL|1–1|1–2
|HUN|2–10|BEL|1–5|1–5
|BIH|0–10|SWE|0–5|0–5
|CRO|0–8|NOR|0–3|0–5
}}
Output

Parameter list

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

Parameter nameDescriptionType
Determines the type of competition to be featured. Valid values are club (default, for club competitions) or NT (for national team competitions).

Using WNT instead of NT allows for the default flag template being changed to without setting . Using MNT acts as an alias for NT. Note that while the documentation will make mention of what setting does to the output, it will be equally true for also setting it to WNT or MNT.

String
Determines the flag icon template which will be used in the table. The default for is, the default for is, and the default for is . If set to a negative value (e.g. n, no, 0), no flags will be displayed for (this will have no impact if). For, 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, flags are displayed next to club names, while for 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 which passes the age level), use a "+" in between the template name and the first parameter value (e.g. generates code for <nowiki>{{fbu|17|<country>}}</nowiki>).

If the flag template passed through the parameter does not exist, the module will revert to the default values for or .

String
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").

Example 1

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

Example 2

Usage
{{#invoke:Sports series|main|legs=n
|[[Arsenal F.C.|Arsenal]]|ENG|2–3|[[FC Bayern Munich|Bayern Munich]]|GER
|[[Atlético Madrid]]|ESP|4–5|[[Borussia Dortmund]]|GER
|[[Real Madrid CF|Real Madrid]]|ESP|4–4 {{aet}} {{pen|4–3}}|[[Manchester City F.C.|Manchester City]]|ENG
|[[Paris Saint-Germain F.C.|Paris Saint-Germain]]|FRA|6–4|[[FC Barcelona|Barcelona]]|ESP
}}
Output
Number
Automatically enabled by default. To disable, set to a negative value (e.g. n, no, 0). The module 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 for two-legged ties and no results of penalty shoot-outs are given, the away goals rule will be applied to determine the winning team (unless is used to turn off this feature). In all other cases, if no winner can be determined based on the input, neither team in a given tie will be bolded.String
To enable, set to a positive value (e.g. y, yes, 1). Automatically gives the winning team of the tie with a background color of . 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 for two-legged ties and no results of penalty shoot-outs are given, the away goals rule will be applied to determine the winning team (unless is used to turn off this feature). In all other cases, if no winner can be determined based on the input, neither team in a given tie will be colored.

When this parameter is enabled for single-leg ties, the score cell of any draws will be automatically given a background color of .

String
When set to FBR for single-leg ties, it automatically changes the background color of the score cells based on the result of the match. Home wins are shown in, draws in and away wins in . A legend for the colors will also be added below the table, and the team column headers will be changed to "Home" and "Away" (as done with, making that parameter redundant when FBR is enabled). This functions similar to Module:Sports results.String
To enable, set to a positive value (e.g. y, yes, 1). If set, it collapses the table using mw-collapsed. This results in the table being spread across the entire width of the page.

Example 3

Usage
{{#invoke:Sports series|main|collapsed=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
}}
Output
String
Adds a caption to the table.

Example 4

Usage
{{#invoke:Sports series|main|caption=This is a caption
|[[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
}}
Output
String
Adds a title to the table in the form of a table header spanning all columns, placed above the standard column headings.

Example 5

Usage
{{#invoke:Sports series|main|title=This is a title
|[[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
}}
Output
String
Adds an anchor to the top of the table which allows direct linking to the table.String
Allows for a custom name to be given to the table for the purposes of transclusion. This is useful when there are multiple instances of this module (or also) on the same page within transclusion tags, allowing for selective calling of specific tables on another page. When the parameter is set and the module code is placed in between tags, other pages transcluding the table and using will only show tables with a matching and not all tables.

For example, if the article "Example" has this module placed in between tags with, then the table can be transcluded to other articles using <nowiki>{{:Example|transcludesection=First round}}</nowiki>.

String
To enable, set to a positive value (e.g. y, yes, 1). Adds a nowrap value to the table style.String
Modifies the font size of the table to a given percentage. The percentage sign is optional. Default is 100. Due to, values lower than 85% will be converted to 85%.Number
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) or does not contain a flag (for). This will have no impact if .String
Set to an integer value for the width of the two team columns, in pixels. Default is 250.Number
Set to an integer value for the width of the aggregate score column and each leg score column, in pixels. Default is 80.Number
If set to a negative value (e.g. n, no, 0), the module will not apply the away goals rule for two-legged ties in which the aggregate score is level. Otherwise, by default the module will use the away goals rule to determine the winner.String
Adds a custom heading for the first team column. Default is Team 1.String
Adds a custom heading for the second team column. Default is Team 2.String
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 and/or is set, those respective parameter(s) will override headers set by .String
Adds a custom heading for the aggregate score column. Default is <nowiki>{{Abbrlink|Agg.|Aggregate score}}</nowiki>, unless is set to a negative value (e.g. n, no, 0), for which the default will be Score.|style="background-color:#fff"|String

|-

|style="text-align:center;vertical-align:top"||style="background-color:#fff"|Adds a custom heading for the Nth leg column (e.g. for the first leg column, for the third leg column, etc.). Default is <ordinal> leg (e.g. 1st leg for the first leg column, 3rd leg for the third leg column, etc.).

Example 6

Usage
{{#invoke:Sports series|main|leg1=Game 1|leg2=Second Leg
|[[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

|style="background-color:#fff"|String

|-

|style="text-align:center;vertical-align:top"||style="background-color:#fff"|Changes the format of the leg score column headings. Instead of using " leg", now the format will be " N". Any string can be specified through the parameter to add as a custom prefix. However, when set only to a positive value (e.g. y, yes, 1), the output will default to Leg ''N''. If is set, this will replace the Nth leg score column heading, overriding the custom prefix.

Example 7

Usage
{{#invoke:Sports series|main|flag=n|legs=7|leg_prefix=Game|aggregate=Series
|[[Golden State Warriors]]|3–4|[[Cleveland Cavaliers]]|104–89|110–77|90–120|108–97|97–112|101–115|89–93
}}
Output

Example 8

Usage
{{#invoke:Sports series|main|leg_prefix=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

|style="background-color:#fff"|String

|-

|style="text-align:center;vertical-align:top"||style="background-color:#fff"|Adds a custom suffix after the ordinal for the leg score column headings. Default is <nowiki>leg</nowiki>. If is set, this will replace the Nth leg score column heading, overriding the custom suffix. In addition, takes precedence over .

Example 9

Usage
{{#invoke:Sports series|main|leg_suffix=match
|[[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
String
Adds a custom heading spanning all columns above the Nth row of the table (e.g. for above the first row, for above the twentieth row, etc.).

Example 10

Usage
{{#invoke:Sports series|main|type=NT|legs=n|h_a=y|heading1=Semi-finals|heading3=Final
|POL|5–1|EST
|WAL|4–1|FIN
|WAL|0–0 {{aet}} {{pso|4–5}}|POL
}}
Output
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, the country codes supplied for each club are by default wrapped into, based on Wikipedia's country data system of templates, and displayed next to each team.

For, the national team names/codes supplied are by default wrapped into and, 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 example competitions that have a possible replay or play-off match after two legs.

Usage
{{#invoke:Sports series|main|type=NT|legs=3|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

Quasi-parameters

Plus sign (+) for flag templates/youth level

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

Usage
{{#invoke:Sports series|main|type=NT|flag=fbu+17
|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

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, or the national team name/code parameter for), 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
|MLT+1943|5–6|GRE+old|3–3|2–2
}}
Output 1
Usage 2
{{#invoke:Sports series|main
|[[Atlético Madrid]]|ESP+1945|4–5|[[Borussia Dortmund]]|GER+empire|2–1|2–4
}}
Output 2

Asterick (*) for strings instead of national teams

By default, when 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 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
|FRA|2–5|HUN|1–3|1–2
|SWE||*Winner QF1||
}}
Output 1
  • Usage 2 
    • {{#invoke:Sports series|main|type=NT|fill_blanks=y
|FRA|2–5|HUN|1–3|1–2
|SWE||*Winner QF1||
}}
    Output 2

    Three apostrophes (''') for manual bolding

    While the template automatically bolds winning teams (unless), in some situations the module will be unable to determine the winner. Or, some users may find it undesirable to have the module bold 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, 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 . If is not disabled, the team that is manually bolded will override the winning team as determined by the module. If 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.

    (Note: The usage of three apostrophes was slightly modified for the purposes of this module to bold the cell. Therefore, it is not possible to selectively bold parts of the team parameters, while leaving other parts of said parameter unbolded.)

    Usage 1
    {{#invoke:Sports series|main|type=NT|bold_winner=n
|LUX|5–6|'''DEN'''|3–3|2–3
|'''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
    Usage 2 (third row overrides automatic bolding)
    {{#invoke:Sports series|main|type=NT
|SWE|2–4|NOR|1–1|1–3
|LUX|5–5 ([[Away goals rule|a]])|'''DEN'''|3–3|2–2
|ESP|7–1|'''IRL'''|5–1|2–0
}}
    Output 2 (third row overrides automatic bolding)

    Two apostrophes ('') for manual coloring

    While the template allows for automatic coloring of the cells of winning teams via, 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 to color 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, 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 . If is set, the cell of team that is manually colored will override the winning team as determined by the module. If is not disabled, the cell of the team that is manually colored will also be bolded.

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

    Two apostrophes surrounding an aggregate score (or the score of a single-leg tie) can also be used to manually indicate a draw/tie.

    (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 or aggregate scores using this formatting.)

    Usage 1
    {{#invoke:Sports series|main|type=WNT|bold_winner=n
|LUX|5–6|''DEN''|3–3|2–3
|''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
    Usage 2 (third row overrides automatic coloring)
    {{#invoke:Sports series|main|type=WNT|color_winner=y|bold_winner=n
|SWE|2–4|NOR|1–1|1–3
|LUX|5–5 ([[Away goals rule|a]])|''DEN''|3–3|2–2
|ESP|7–1|''IRL''|5–1|2–0
}}
    Output 2 (third row overrides automatic coloring)
    Usage 3
    {{#invoke:Sports series|main|type=WNT|legs=0|bold_winner=n
|LUX|5–6|''DEN''
|''ESP''|7–1|IRL
|FRA|''2–2''|HUN
}}
    Output 3

    See also

    This article is licensed under the GNU Free Documentation License. It uses material from the Wikipedia article "Module:Sports series/doc".

    Except where otherwise indicated, Everything.Explained.Today is © Copyright 2009-2024, A B Cryer, All Rights Reserved. Cookie policy.