Module:Sports series/doc

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

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_team|first_association|aggregate|second_team|second_association|first_leg|second_leg

}}

For two-legged ties in national team or 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. The parameter {{para|flag|n}} must be passed to disable the country flag parameter.

{{#invoke:Sports series|main|flag=n

|first_team|aggregate|second_team|first_leg|second_leg

}}

; Usage

{{#invoke:Sports series|main

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Output

{{#invoke:Sports series|main

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Usage

{{#invoke:Sports series|main|flag=n

|Valencia|3–3 (3–2 p)|Alavés|2–1|1–2 (aet)

|Atlético Madrid|2–5|Sevilla|1–2|1–3

|Espanyol|1–2|Barcelona|1–0|0–2

|Leganés|2–2 (a)|Real Madrid|0–1|2–1

}}

; Output

{{#invoke:Sports series|main|flag=n

|Valencia|3–3 (3–2 p)|Alavés|2–1|1–2 (aet)

|Atlético Madrid|2–5|Sevilla|1–2|1–3

|Espanyol|1–2|Barcelona|1–0|0–2

|Leganés|2–2 (a)|Real Madrid|0–1|2–1

}}

; Usage

{{#invoke:Sports series|main|flag=n

|{{fb-rt|UKR}}|3–1|{{fb|SVN}}|2–0|1–1

|{{fb-rt|SWE}}|4–3|{{fb|DEN}}|2–1|2–2

|{{fb-rt|BIH}}|1–3|{{fb|IRL}}|1–1|0–2

|{{fb-rt|NOR}}|1–3|{{fb|HUN}}|0–1|1–2

}}

; Output

{{#invoke:Sports series|main|flag=n

|{{fb-rt|UKR}}|3–1|{{fb|SVN}}|2–0|1–1

|{{fb-rt|SWE}}|4–3|{{fb|DEN}}|2–1|2–2

|{{fb-rt|BIH}}|1–3|{{fb|IRL}}|1–1|0–2

|{{fb-rt|NOR}}|1–3|{{fb|HUN}}|0–1|1–2

}}

Below is a full list of the named parameters for this module. Additionally, the unnamed parameters are used to pass the teams and scores of each of the ties (as shown above). All parameters are optional.

{| class="wikitable" style="width:100%"

|-

! Parameter name

! Description

! Type

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|flag}}

|Determines the flag icon template which will be used in the table. The default is {{tl|fbaicon}}. If set to a negative value (e.g. n, no, 0), no flags will be displayed. If the flag template passed through the parameter does not exist, the module will default to {{tl|flagicon}}.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|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").

; Usage

{{#invoke:Sports series|main|legs=5

|Arsenal|ENG|6–8|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|ESP|11–11 (4–3 p)|Manchester City|ENG|3–3|1–1|3–3|1–1|3–3 (aet)

|Paris Saint-Germain|FRA|14–11|Barcelona|ESP|2–3|4–1|2–3|4–1|2–3

}}

; Output

{{#invoke:Sports series|main|legs=5

|Arsenal|ENG|6–8|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|ESP|11–11 (4–3 p)|Manchester City|ENG|3–3|1–1|3–3|1–1|3–3 (aet)

|Paris Saint-Germain|FRA|14–11|Barcelona|ESP|2–3|4–1|2–3|4–1|2–3

}}

; Usage

{{#invoke:Sports series|main|legs=n

|Arsenal|ENG|2–3|Bayern Munich|GER

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER

|Real Madrid|ESP|4–4 (aet) (4–3 p)|Manchester City|ENG

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP

}}

; Output

{{#invoke:Sports series|main|legs=n

|Arsenal|ENG|2–3|Bayern Munich|GER

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER

|Real Madrid|ESP|4–4 (aet) (4–3 p)|Manchester City|ENG

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP

}}

|Number

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|bold_winner}}

|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 {{para|away_goals}} 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

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|color_winner}}

|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 {{bg|#CCFFCC|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 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 {{para|away_goals}} 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 {{bg|#FFFFBB|yellow (#FFFFBB)}}.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|generate_links}}

|To enable, set to a positive value (e.g. y, yes, 1). Automatically generates wikilinks around match scores, linking to anchors in the format of "[Team 1] v [Team 2]" for the first leg and single-leg ties, and "[Team 2] v [Team 1]" for the second leg. If the first and/or second team from a tie is missing, the text within the anchor will default to "Team 1" and/or "Team 2", respectively. A link will be placed around the match score (or match date for future fixtures), excluding any text in parentheses, unless a link is already present around the score, in which case no change will be made.

This feature is intended to complement the automatic anchor generation feature of {{tl|Football box}}. On that template, anchors are automatically generated for articles with "group" or "knockout" in the title, as well as templates using the parameter {{para|id|auto}}.

; Usage

{{#invoke:Sports series|main|generate_links=y

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Output

{{#invoke:Sports series|main|generate_links=y

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|matches_style}}

|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 {{bg|#BBF3FF|blue (#BBF3FF)}}, draws in {{bg|#FFFFBB|yellow (#FFFFBB)}} and away wins in {{bg|#FFBBBB|red (#FFBBBB)}}. A legend for the colors will also be added below the table, and the team column headers will be changed to "Home team" and "Away team" (as done with {{para|h_a}}, making that parameter redundant when FBR is enabled). This functions similar to Module:Sports results.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|solid_cell}}

|When set to a positive value (e.g. y, yes, 1), any leg cells with a value of null will be given a background color of {{bg|#BBBBBB|grey (#BBBBBB)}}.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|small_text}}

|Automatically enabled by default. To disable, set to a negative value (e.g. n, no, 0). The module automatically generates small text (85% font size) for legs (or the score column for single-leg ties) when no match score is present, and no small text exists in the cell already. This is to allow for the proper formatting of future matches, which typically lists the date of the fixture in a reduced font size. Small text is not applied to any references, notes or superscripts present.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|collapsed}}

|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.

; Usage

{{#invoke:Sports series|main|collapsed=y

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

}}

; Output

{{#invoke:Sports series|main|collapsed=y

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|center_table}}

|To enable, set to a positive value (e.g. y, yes, 1). If set, it centers the wikitable horizontally across the page. Does not work if {{para|collapsed}} is set.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|caption}}

|Adds a caption to the table.

; Usage

{{#invoke:Sports series|main|caption=This is a caption

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

}}

; Output

{{#invoke:Sports series|main|caption=This is a caption

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|title}}

|Adds a title to the table in the form of a table header spanning all columns, placed above the standard column headings.

; Usage

{{#invoke:Sports series|main|title=This is a title

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

}}

; Output

{{#invoke:Sports series|main|title=This is a title

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|id}}

|Adds an anchor to the top of the table which allows direct linking to the table.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|section}}

|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 Module:Sports table) 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 {{xtag|onlyinclude|p}} tags, other pages transcluding the table and using {{para|transcludesection}} will only show tables with a matching {{para|section}} and not all tables.

For example, if the article "Example" has this module placed in between {{xtag|onlyinclude|p}} tags with {{para|section|First round}}, then the table can be transcluded to other articles using {{:Example|transcludesection=First round}}.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|nowrap}}

|By default, only the aggregate/leg scores and column headers will have a nowrap value applied to the cell style.

To enable nowrap for the entire table, set to a positive value (e.g. y, yes, 1).

To disable nowrap for the cells that it is included for by default, set to a negative value (e.g. n, no, 0).

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|font_size}}

|Modifies the font size of the table to a given percentage. The percentage sign is optional. Default is 100. Due to MOS:SMALLTEXT, values lower than 85% will be converted to 85%.

|Number

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|flag_size}}

|Modifies the size of the flags to a specific pixel count. The size is specified in pixels: Width px or x Height px or Width x Height px. This scales the image to be no greater than the given width or height, keeping its aspect ratio. For more information, see Wikipedia:Extended image syntax. The trailing "px" text is optional. By default, the size is controlled by the flag icon or country data templates, but is usually 23x15px.

|Number

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|show_country}}

|When set to a specific country name or code, only rows containing a team with that accompanying country name/code will be displayed in the final output. For example, if {{para|show_country|GER}}, rows only containing teams with the accompanying country code of "GER" (for Germany) will be displayed. Nothing will occur if {{para|flag|n}} is also set. Any custom headings within the table (set via {{para|headingN}}) will be suppressed when {{para|show_country}} is used.

This feature is useful when transcluding content to country-related articles, for example 2024–25 in German football. However, note that if the module is being transcluded via labeled section transclusion, template parameters cannot be passed, and therefore this parameter would not work.

; Usage

{{#invoke:Sports series|main|show_country=ENG

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Output

{{#invoke:Sports series|main|show_country=ENG

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|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. This will have no impact if {{para|flag|n}}.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|team_width}}

|Set to an integer value for the width of the two team columns, in pixels. Default is 250.

|Number

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|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

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|away_goals}}

|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

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|team1}}

|Adds a custom heading for the first team column. Default is Team 1.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|team2}}

|Adds a custom heading for the second team column. Default is Team 2.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|h_a}}

|To enable, set to a positive value (e.g. y, yes, 1). Changes the default column headers for the teams to "Home team" and "Away team". If {{para|team1}} and/or {{para|team2}} is set, those respective parameter(s) will override headers set by {{para|h_a}}.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|aggregate}}

|Adds a custom heading for the aggregate score column. Default is {{Abbrlink|Agg.|Aggregate score}}, unless {{para|legs}} is set to a negative value (e.g. n, no, 0), for which the default will be Score.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|legN}}

|Adds a custom heading for the Nth leg column (e.g. {{para|leg1}} for the first leg column, {{para|leg3}} for the third leg column, etc.). Default is leg (e.g. 1st leg for the first leg column, 3rd leg for the third leg column, etc.).

; Usage

{{#invoke:Sports series|main|leg1=Game 1|leg2=Second Leg

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Output

{{#invoke:Sports series|main|leg1=Game 1|leg2=Second Leg

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|leg_prefix}}

|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. (Note that negative values cannot be used, as they will be treated literally for the prefix text.) If {{para|legN}} is set, this will replace the Nth leg score column heading, overriding the custom prefix.

; 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

{{#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

}}

; Usage

{{#invoke:Sports series|main|leg_prefix=y

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Output

{{#invoke:Sports series|main|leg_prefix=y

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|leg_suffix}}

|Adds a custom suffix after the ordinal for the leg score column headings. Default is leg. If {{para|legN}} is set, this will replace the Nth leg score column heading, overriding the custom suffix. In addition, {{para|leg_prefix}} takes precedence over {{para|leg_suffix}}.

; Usage

{{#invoke:Sports series|main|leg_suffix=match

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

; Output

{{#invoke:Sports series|main|leg_suffix=match

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|6–4|Barcelona|ESP|2–3|4–1

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|headingN}}

|Adds a custom heading spanning all columns above the Nth row of the table (e.g. {{para|heading1}} for above the first row, {{para|heading20}} for above the twentieth row, etc.).

; Usage

{{#invoke:Sports series|main|flag=n|legs=n|h_a=y|heading1=Semi-finals|heading3=Final

|{{fb-rt|POL}}|5–1|{{fb|EST}}

|{{fb-rt|WAL}}|4–1|{{fb|FIN}}

|{{fb-rt|WAL}}|0–0 (aet) (4–5 p)|{{fb|POL}}

}}

; Output

{{#invoke:Sports series|main|flag=n|legs=n|h_a=y|heading1=Semi-finals|heading3=Final

|{{fb-rt|POL}}|5–1|{{fb|EST}}

|{{fb-rt|WAL}}|4–1|{{fb|FIN}}

|{{fb-rt|WAL}}|0–0 (aet) (4–5 p)|{{fb|POL}}

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|note_group}}

|Determines the group that will be used for the notes. Can be either a custom-named group (e.g. {{para|note_group|nb}} will generate {{dummy ref|nb 1}}, {{dummy ref|nb 2}}, etc.), or a predefined group (options are lower-alpha (default), upper-alpha, lower-roman, upper-roman and lower-greek). For more information, see H:PREGROUP. The predefined group decimal is also valid, but this will render the same as a standard reference.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|note_list}}

|When set to a positive value (e.g. y, yes, 1), a list of notes will be forced to display, with the group based on the value of {{para|note_group}} (lower-alpha by default). This is not necessary for standard note usage, as a note list will always be displayed when notes are created integrally through via the respective parameters. This is primarily useful if the module does not contain any notes, but you want to display notes below the table from elsewhere above on the page.

When set to a negative value (e.g. n, no, 0), no list of notes will be generated below the module. This is useful if it is desired to display the note list elsewhere below on the page.

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|note_agg_N}}

|Creates a footnote after the aggregate score of the Nth row of the table (excluding header rows). The parameter can contain either the contents of the note, or a reference to another note.

Notes can be reused across different rows and different types of notes (aggregate or leg). To reuse a note, set the value to the identifier of the original note (e.g., agg_1 to reuse the aggregate note of row 1, or leg2_5 to reuse the second leg note of row 5).

A list of all the notes will then be generated in the table footer.

If the value of the note parameter begins with a reference, footnote or superscript, it will be directly prepended to the aggregate score without creating a separate note. These cannot be reused like standard notes. This is useful if it is desired to use an outside note system, or reference a note that exists elsewhere on the page.

; Usage

{{#invoke:Sports series|main|flag=n|legs=n|h_a=y|heading1=Semi-finals|heading3=Final

|{{fb-rt|POL}}|5–1|{{fb|EST}}

|{{fb-rt|WAL}}|4–1|{{fb|FIN}}

|{{fb-rt|WAL}}|0–0 (aet) (4–5 p)|{{fb|POL}}

|note_agg_1=Played behind closed doors

|note_agg_3=agg_1

}}

; Output

{{#invoke:Sports series|main|flag=n|legs=n|h_a=y|heading1=Semi-finals|heading3=Final

|{{fb-rt|POL}}|5–1|{{fb|EST}}

|{{fb-rt|WAL}}|4–1|{{fb|FIN}}

|{{fb-rt|WAL}}|0–0 (aet) (4–5 p)|{{fb|POL}}

|note_agg_1=Played behind closed doors

|note_agg_3=agg_1

}}

|String

|-

|style="text-align:center;vertical-align:top"|{{TOC tab|note_legX_N}}

|Creates a footnote after the Xth leg score of the Nth row of the table (excluding header rows). The parameter can contain either the contents of the note, or a reference to another note.

Notes can be reused across different rows and different types of notes (aggregate or leg). To reuse a note, set the value to the identifier of the original note (e.g., leg2_5 to reuse the second leg note of row 5, or agg_1 to reuse the aggregate note of row 1).

A list of all the notes will then be generated in the table footer.

If the value of the note parameter begins with a reference, footnote or superscript, it will be directly prepended to the aggregate score without creating a separate note. These cannot be reused like standard notes. This is useful if it is desired to use an outside note system, or reference a note that exists elsewhere on the page.

; Usage

{{#invoke:Sports series|main

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|w/o|Barcelona|ESP|2–3|Canc.

|note_leg1_2=Played behind closed doors.

|note_agg_4=Paris Saint-Germain were awarded a walkover victory after Barcelona refused to play the second leg.

|note_leg2_4=agg_4

}}

; Output

{{#invoke:Sports series|main

|Arsenal|ENG|2–3|Bayern Munich|GER|2–2|0–1

|Atlético Madrid|ESP|4–5|Borussia Dortmund|GER|2–1|2–4

|Real Madrid|ESP|4–4 (4–3 p)|Manchester City|ENG|3–3|1–1 (aet)

|Paris Saint-Germain|FRA|w/o|Barcelona|ESP|2–3|Canc.

|note_leg1_2=Played behind closed doors.

|note_agg_4=Paris Saint-Germain were awarded a walkover victory after Barcelona refused to play the second leg.

|note_leg2_4=agg_4

}}

|String

|}

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 (this includes the note parameters for the aggregate and leg score columns). Otherwise, the module will not create a row for that line and all others below it.

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

For the legs and aggregate scores, all incorrect types of dashes (such as a hyphen, em dash or minus sign) will be converted to an en dash (–). This does not apply to dashes contained in the article title/section anchor portion of wikilinks. These cells will also have nowrap applied to them, as long as two or more sets of parentheses are not present.

In addition, the module will also automatically convert text in brackets (as it relates to how matches were decided) to wikilinks. The following are supported:

• (X–Y p), (X–Y pen) or (X–Y pso) {{arrow}} (X–Y p)
• (aet) or (a.e.t.) {{arrow}} (a.e.t.)
• (a) or (agr) {{arrow}} (a)

; Usage

{{#invoke:Sports series|main|flag=n

|Valencia|3-3 (3-2 p)|Alavés|2-1|1-2 (aet)
|Leganés|2-2 (a)|Real Madrid|0-1|2-1
}}

; Output

{{#invoke:Sports series|main|flag=n

|Valencia|3-3 (3-2 p)|Alavés|2-1|1-2 (aet)

|Leganés|2-2 (a)|Real Madrid|0-1|2-1

}}

If a cell of one of the leg scores contains only null, the cell will only contain an em dash (—). If {{para|generate_links|y}}, then this em dash will be linked. However, if {{para|solid_cell|y}}, then the cell will be left empty and given a background color of {{bg|#BBBBBB|grey (#BBBBBB)}}.

If a cell of one of the leg scores contains only nil, the cell will not be generated.

These features are 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 1 (for null)

{{#invoke:Sports series|main

|İstanbul Başakşehir|TUR|1–3|Copenhagen|DEN|1–0|0–3
|Olympiacos|GRE|1–2|Wolverhampton Wanderers|ENG|1–1|0–1
|Rangers|SCO|1–4|Bayer Leverkusen|GER|1–3|0–1
|VfL Wolfsburg|GER|1–5|Shakhtar Donetsk|UKR|1–2|0–3
|Inter Milan|ITA|2–0|Getafe|ESP|null|null
|Sevilla|ESP|2–0|Roma|ITA|null|null
|Eintracht Frankfurt|GER|0–4|Basel|SUI|0–3|0–1
|LASK|AUT|1–7|Manchester United|ENG|0–5|1–2
}}

; Output 1 (for null)

{{#invoke:Sports series|main

|İstanbul Başakşehir|TUR|1–3|Copenhagen|DEN|1–0|0–3

|Olympiacos|GRE|1–2|Wolverhampton Wanderers|ENG|1–1|0–1

|Rangers|SCO|1–4|Bayer Leverkusen|GER|1–3|0–1

|VfL Wolfsburg|GER|1–5|Shakhtar Donetsk|UKR|1–2|0–3

|Inter Milan|ITA|2–0|Getafe|ESP|null|null

|Sevilla|ESP|2–0|Roma|ITA|null|null

|Eintracht Frankfurt|GER|0–4|Basel|SUI|0–3|0–1

|LASK|AUT|1–7|Manchester United|ENG|0–5|1–2

}}

; Usage 2 (for null, {{para|solid_cell|y}})

{{#invoke:Sports series|main|solid_cell=y

|İstanbul Başakşehir|TUR|1–3|Copenhagen|DEN|1–0|0–3
|Olympiacos|GRE|1–2|Wolverhampton Wanderers|ENG|1–1|0–1
|Rangers|SCO|1–4|Bayer Leverkusen|GER|1–3|0–1
|VfL Wolfsburg|GER|1–5|Shakhtar Donetsk|UKR|1–2|0–3
|Inter Milan|ITA|2–0|Getafe|ESP|null|null
|Sevilla|ESP|2–0|Roma|ITA|null|null
|Eintracht Frankfurt|GER|0–4|Basel|SUI|0–3|0–1
|LASK|AUT|1–7|Manchester United|ENG|0–5|1–2
}}

; Output 2 (for null, {{para|solid_cell|y}})

{{#invoke:Sports series|main|solid_cell=y

|İstanbul Başakşehir|TUR|1–3|Copenhagen|DEN|1–0|0–3

|Olympiacos|GRE|1–2|Wolverhampton Wanderers|ENG|1–1|0–1

|Rangers|SCO|1–4|Bayer Leverkusen|GER|1–3|0–1

|VfL Wolfsburg|GER|1–5|Shakhtar Donetsk|UKR|1–2|0–3

|Inter Milan|ITA|2–0|Getafe|ESP|null|null

|Sevilla|ESP|2–0|Roma|ITA|null|null

|Eintracht Frankfurt|GER|0–4|Basel|SUI|0–3|0–1

|LASK|AUT|1–7|Manchester United|ENG|0–5|1–2

}}

; Usage 3 (for nil)

{{#invoke:Sports series|main|flag=n|legs=3|leg3=Play-off

|{{fb-rt|LUX}}|5–6|{{fb|DEN}}|3–3|2–2|0–1
|{{fb-rt|ESP|1945}}|7–1|{{fb|IRL}}|5–1|2–0|nil
|{{fb-rt|FRA}}|2–5|{{fb|HUN}}|1–3|1–2|nil
|{{fb-rt|SWE}}|2–4|{{fb|URS}}|1–1|1–3|nil
}}

; Output 3 (for nil)

{{#invoke:Sports series|main|flag=n|legs=3|leg3=Play-off

|{{fb-rt|LUX}}|5–6|{{fb|DEN}}|3–3|2–2|0–1

|{{fb-rt|ESP|1945}}|7–1|{{fb|IRL}}|5–1|2–0|nil

|{{fb-rt|FRA}}|2–5|{{fb|HUN}}|1–3|1–2|nil

|{{fb-rt|SWE}}|2–4|{{fb|URS}}|1–1|1–3|nil

}}

Pages utilizing this module often include a wikilink with an anchor to the scores of the legs of a tie, linking to full match summaries.

Typically, when using anchored wikilinks, the page title can be omitted if the anchor appears on the same page. However, such links generally do not function properly when transcluded to other articles.

However, for this module, if any parameter contains an anchored wikilink that omits the page title (for example, 2–2), the module will automatically insert the page title during transclusion to ensure proper linking. For proper functionality, the "sports series" module code must originate from the same page that contains the anchors.

To allow for the use of flag variants, this module supports within the country code parameter the use of a plus sign (+) in between the country name/code and the name of the flag variant.

; Usage

{{#invoke:Sports series|main

|Atlético Madrid|ESP+1945|4–5|Borussia Dortmund|GER+empire|2–1|2–4
}}

; Output

{{#invoke:Sports series|main

|Atlético Madrid|ESP+1945|4–5|Borussia Dortmund|GER+empire|2–1|2–4

}}

While the template automatically bolds winning teams (unless {{para|bold_winner|n}}), 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 can be done by placing the three apostrophes before and after the name of the team. If {{para|bold_winner}} is not disabled, the team that is manually bolded will override the winning team as determined by the module. If {{para|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.

(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|flag=n|bold_winner=n

|{{fb-rt|LUX}}|5–6|{{fb|DEN}}|3–3|2–3
|{{fb-rt|ESP}}|7–1|{{fb|IRL}}|5–1|2–0
|{{fb-rt|FRA}}|2–5|{{fb|HUN}}|1–3|1–2
|{{fb-rt|SWE}}|2–4|{{fb|NOR}}|1–1|1–3
}}

; Output 1

{{#invoke:Sports series|main|flag=n|bold_winner=n

|{{fb-rt|LUX}}|5–6|{{fb|DEN}}|3–3|2–3

|{{fb-rt|ESP}}|7–1|{{fb|IRL}}|5–1|2–0

|{{fb-rt|FRA}}|2–5|{{fb|HUN}}|1–3|1–2

|{{fb-rt|SWE}}|2–4|{{fb|NOR}}|1–1|1–3

}}

; Usage 2 (third row overrides automatic bolding)

{{#invoke:Sports series|main|flag=n

|{{fb-rt|SWE}}|2–4|{{fb|NOR}}|1–1|1–3
|{{fb-rt|LUX}}|5–5 (a)|{{fb|DEN}}|3–3|2–2
|{{fb-rt|ESP}}|7–1|{{fb|IRL}}|5–1|2–0
}}

; Output 2 (third row overrides automatic bolding)

{{#invoke:Sports series|main|flag=n

|{{fb-rt|SWE}}|2–4|{{fb|NOR}}|1–1|1–3

|{{fb-rt|LUX}}|5–5 (a)|{{fb|DEN}}|3–3|2–2

|{{fb-rt|ESP}}|7–1|{{fb|IRL}}|5–1|2–0

}}

While the template allows for automatic coloring of the cells of winning teams via {{para|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 {{para|color_winner}} to color the winner automatically. In these cases, manual coloring can be used to indicate the winning team of a tie. This can be done by placing the two apostrophes before and after the name of the team. If {{para|color_winner}} is set, the cell of team that is manually colored will override the winning team as determined by the module. If {{para|bold_winner}} 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|flag=n|bold_winner=n

|{{fbw-rt|LUX}}|5–6|{{fbw|DEN}}|3–3|2–3
|{{fbw-rt|ESP}}|7–1|{{fbw|IRL}}|5–1|2–0
|{{fbw-rt|FRA}}|2–5|{{fbw|HUN}}|1–3|1–2
|{{fbw-rt|SWE}}|2–4|{{fbw|NOR}}|1–1|1–3
}}

; Output 1

{{#invoke:Sports series|main|flag=n|bold_winner=n

|{{fbw-rt|LUX}}|5–6|{{fbw|DEN}}|3–3|2–3

|{{fbw-rt|ESP}}|7–1|{{fbw|IRL}}|5–1|2–0

|{{fbw-rt|FRA}}|2–5|{{fbw|HUN}}|1–3|1–2

|{{fbw-rt|SWE}}|2–4|{{fbw|NOR}}|1–1|1–3

}}

; Usage 2 (third row overrides automatic coloring)

{{#invoke:Sports series|main|flag=n|color_winner=y|bold_winner=n

|{{fbw-rt|SWE}}|2–4|{{fbw|NOR}}|1–1|1–3
|{{fbw-rt|LUX}}|5–5 (a)|{{fbw|DEN}}|3–3|2–2
|{{fbw-rt|ESP}}|7–1|{{fbw|IRL}}|5–1|2–0
}}

; Output 2 (third row overrides automatic coloring)

{{#invoke:Sports series|main|flag=n|color_winner=y|bold_winner=n

|{{fbw-rt|SWE}}|2–4|{{fbw|NOR}}|1–1|1–3

|{{fbw-rt|LUX}}|5–5 (a)|{{fbw|DEN}}|3–3|2–2

|{{fbw-rt|ESP}}|7–1|{{fbw|IRL}}|5–1|2–0

}}

; Usage 3

{{#invoke:Sports series|main|flag=n|legs=0|bold_winner=n

|{{fbw-rt|LUX}}|5–6|{{fbw|DEN}}
|{{fbw-rt|ESP}}|7–1|{{fbw|IRL}}
|{{fbw-rt|FRA}}|2–2|{{fbw|HUN}}
}}

; Output 3

{{#invoke:Sports series|main|flag=n|legs=0|bold_winner=n

|{{fbw-rt|LUX}}|5–6|{{fbw|DEN}}

|{{fbw-rt|ESP}}|7–1|{{fbw|IRL}}

|{{fbw-rt|FRA}}|2–2|{{fbw|HUN}}

}}

• Module:Sports results
• Module:Sports table

{{Sandbox other||

Category:Sports modules

}}