Module:Sports series/doc: Difference between revisions

Revision as of 19:33, 2 October 2024

Latest revision as of 02:40, 1 August 2025

(20 intermediate revisions by 3 users not shown)

Line 1:

{{Module rating|beta<!-- Values: pre-alpha • alpha • beta • release • protected • semiprotected -- If a rating not needed/relevant, delete this template call -->}}

{{Lua|Module:Arguments|Module:Yesno}}

{{Uses TemplateStyles|Template:Screen reader-only/styles.css|Module:Sports series/styles.css}}

<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->

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 football matches. While designed for [[association football]], it can be used for any sport that features a series between teams.

Line 9 ⟶ 11:

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.

<presyntaxhighlight lang="mediawiki">{{#invoke:Sports series|main

|first_team|first_association|aggregate|second_team|second_association|first_leg|second_leg

}}</presyntaxhighlight>

=== National team or domestic club football ===

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.

<presyntaxhighlight lang="mediawiki">{{#invoke:Sports series|main|flag=n

|first_team|aggregate|second_team|first_leg|second_leg

}}</presyntaxhighlight>

== Examples ==

Line 24 ⟶ 26:

=== International club football ===

; Usage

<presyntaxhighlight lang="mediawiki">{{#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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}</presyntaxhighlight>

; Output

Line 35 ⟶ 37:

|[[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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}

Line 41 ⟶ 43:

=== Domestic club football ===

; Usage

<presyntaxhighlight lang="mediawiki">{{#invoke:Sports series|main|flag=n

|[[Valencia CF|Valencia]]|3–3 {{pso|(3–2}} p)|[[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

}}</presyntaxhighlight>

; Output

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

|[[Valencia CF|Valencia]]|3–3 {{pso|(3–2}} p)|[[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

Line 58 ⟶ 60:

=== National team football ===

; Usage

<presyntaxhighlight lang="mediawiki">{{#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

}}</presyntaxhighlight>

; Output

Line 74 ⟶ 76:

== Parameter list ==

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

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

|-

! Parameter name

Line 85 ⟶ 87:

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

|style="background-color:#fff"|Determines the [[Wikipedia:WikiProject Flag Template|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|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 <code>2</code>. 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

<presyntaxhighlight lang="mediawiki">{{#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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1|3–3|1–1|3–3 {{(aet}})

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

}}</presyntaxhighlight>

; Output

Line 106 ⟶ 108:

|[[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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1|3–3|1–1|3–3 {{(aet}})

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

}}

Line 112 ⟶ 114:

==== Example 2 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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}} p)|[[Manchester City F.C.|Manchester City]]|ENG

|[[Paris Saint-Germain FC|Paris Saint-Germain]]|FRA|6–4|[[FC Barcelona|Barcelona]]|ESP

}}</presyntaxhighlight>

; Output

Line 123 ⟶ 125:

|[[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}} p)|[[Manchester City F.C.|Manchester City]]|ENG

|[[Paris Saint-Germain FC|Paris Saint-Germain]]|FRA|6–4|[[FC Barcelona|Barcelona]]|ESP

}}

|Number

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

|-

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

|style="background-color:#fff"|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 (association football)|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|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 (association football)|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="background-color:#fff"|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}}.

==== Example 3 ====

; Usage

<syntaxhighlight lang="mediawiki">{{#invoke:Sports series|main|generate_links=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 (4–3 p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 (aet)

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

}}</syntaxhighlight>

; Output

{{#invoke:Sports series|main|generate_links=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 (4–3 p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 (aet)

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

}}

|String

|-

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

|style="background-color:#fff"|When set to <code>FBR</code> for <u>single-leg ties</u>, 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 <code>FBR</code> is enabled). This functions similar to [[Module:Sports results#Win/Draw/Loss colour|Module:Sports results]].

|String

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

|-

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

|style="background-color:#fff"|When set to a positive value (e.g. y, yes, 1), any leg cells with a value of <code>null</code> will be given a background color of {{bg|#BBBBBB|grey (#BBBBBB)}}.

|String

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

|-

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

|style="background-color:#fff"|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). If set, it collapses the table using [[Help:Collapsing#"mw-collapsed"|mw-collapsed]]. This results in the table being spread across the entire width of the page.

==== Example 34 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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

}}</presyntaxhighlight>

; Output

Line 179 ⟶ 207:

}}

|String

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

|-

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

|style="background-color:#fff"|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|Adds a [[MOS:TABLECAPTION|caption]] to the table.

==== Example 45 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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

}}</presyntaxhighlight>

; Output

Line 205 ⟶ 233:

}}

|String

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

|-

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

|style="background-color:#fff"|Adds a title to the table in the form of a table header spanning all columns, placed above the standard column headings.

==== Example 56 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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

}}</presyntaxhighlight>

; Output

Line 225 ⟶ 253:

}}

|String

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

|-

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

|style="background-color:#fff"|Adds an [[WP:LINKPART|anchor]] to the top of the table which allows direct linking to the table.

|String

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

|-

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

|style="background-color:#fff"|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 <code><nowiki>{{:Example|transcludesection=First round}}</nowiki></code>.

|String

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

|-

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

|style="background-color:#fff"|ToBy enabledefault, setonly tothe aaggregate/leg positivescores valueand (e.g.column y,headers yes, 1).will Addshave a [[Help:Table#Nowrap|nowrap]] value applied to the tablecell style.

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

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

|style="background-color:#fff"|Modifies the font size of the table to a given percentage. The percentage sign is optional. Default is <code>100</code>. Due to [[MOS:SMALLTEXT]], values lower than 85% will be converted to 85%.

|Number

|style="background-color:#fff"|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: <code>'''''Width''''' px</code> or <code>x '''''Height''''' px</code> or <code>'''''Width''''' x '''''Height''''' px</code>. 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 [[Wikipedia:WikiProject Flag Template|flag icon or country data templates]], but is usually <code>23x15px</code>.

|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|heading''N''}}) 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 [[Help:Labeled section transclusion|labeled section transclusion]], template parameters cannot be passed, and therefore this parameter would not work.

==== Example 7 ====

; Usage

<syntaxhighlight lang="mediawiki">{{#invoke:Sports series|main|show_country=ENG

|[[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 (4–3 p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 (aet)

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

}}</syntaxhighlight>

; Output

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

|[[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 (4–3 p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 (aet)

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

}}

|String

|-

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

|style="background-color:#fff"|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|Set to an integer value for the width of the two team columns, in pixels. Default is <code>250</code>.

|Number

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

|-

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

|style="background-color:#fff"|Set to an integer value for the width of the aggregate score column and each leg score column, in pixels. Default is <code>80</code>.

|Number

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

|-

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

|style="background-color:#fff"|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|Adds a custom heading for the first team column. Default is <code>Team 1</code>.

|String

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

|-

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

|style="background-color:#fff"|Adds a custom heading for the second team column. Default is <code>Team 2</code>.

|String

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

|-

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

|style="background-color:#fff"|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="background-color:#fff"|String

|-

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

|style="background-color:#fff"|Adds a custom heading for the aggregate score column. Default is <code><nowiki>{{Abbrlink|Agg.|Aggregate score}}</nowiki></code>, unless {{para|legs}} is set to a negative value (e.g. n, no, 0), for which the default will be <code>Score</code>.

|String

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

|-

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

|style="background-color:#fff"|Adds a custom heading for the ''N''th leg column (e.g. {{para|leg1}} for the first leg column, {{para|leg3}} for the third leg column, etc.). Default is <code><ordinal> leg</code> (e.g. <code>1st leg</code> for the first leg column, <code>3rd leg</code> for the third leg column, etc.).

==== Example 68 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}</presyntaxhighlight>

; Output

Line 319 ⟶ 383:

|[[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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}

|String

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

|-

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

|style="background-color:#fff"|Changes the format of the leg score column headings. Instead of using "<ordinal> leg", now the format will be "<leg_prefix> ''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 <code>Leg ''N''</code>. (Note that negative values cannot be used, as they will be treated literally for the prefix text.) If {{para|leg''N''}} is set, this will replace the ''N''th leg score column heading, overriding the custom prefix.

==== Example 79 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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

}}</presyntaxhighlight>

; Output

Line 341 ⟶ 405:

}}

==== Example 810 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}</presyntaxhighlight>

; Output

Line 354 ⟶ 418:

|[[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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}

|String

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

|-

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

|style="background-color:#fff"|Adds a custom suffix after the ordinal for the leg score column headings. Default is <code><nowiki>leg</nowiki></code>. If {{para|leg''N''}} is set, this will replace the ''N''th leg score column heading, overriding the custom suffix. In addition, {{para|leg_prefix}} takes precedence over {{para|leg_suffix}}.

==== Example 911 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}</presyntaxhighlight>

; Output

Line 378 ⟶ 442:

|[[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}} p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 {{(aet}})

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

}}

|String

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

|-

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

|style="background-color:#fff"|Adds a custom heading spanning all columns above the ''N''th row of the table (e.g. {{para|heading1}} for above the first row, {{para|heading20}} for above the twentieth row, etc.).

==== Example 1012 ====

; Usage

<presyntaxhighlight lang="mediawiki">{{#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}}) {{pso|(4–5}} p)|{{fb|POL}}

}}</presyntaxhighlight>

; Output

Line 401 ⟶ 465:

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

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

|{{fb-rt|WAL}}|0–0 {{(aet}}) {{pso|(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 <code>lower-alpha</code> (default), <code>upper-alpha</code>, <code>lower-roman</code>, <code>upper-roman</code> and <code>lower-greek</code>). For more information, see [[H:PREGROUP]]. The predefined group <code>decimal</code> 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}} (<code>lower-alpha</code> by default). This is <u>not necessary</u> 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 ''N''th 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., <code>agg_1</code> to reuse the aggregate note of row 1, or <code>leg2_5</code> 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.

==== Example 13 ====

; Usage

<syntaxhighlight lang="mediawiki">{{#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

}}</syntaxhighlight>

; 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_leg''X''_''N''}}

|Creates a footnote after the Xth leg score of the ''N''th 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., <code>leg2_5</code> to reuse the second leg note of row 5, or <code>agg_1</code> 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.

==== Example 14 ====

; Usage

<syntaxhighlight lang="mediawiki">{{#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 (4–3 p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 (aet)

|'''[[Paris Saint-Germain FC|Paris Saint-Germain]]'''|FRA|w/o|[[FC Barcelona|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

}}</syntaxhighlight>

; Output

{{#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 (4–3 p)|[[Manchester City F.C.|Manchester City]]|ENG|3–3|1–1 (aet)

|'''[[Paris Saint-Germain FC|Paris Saint-Germain]]'''|FRA|[[Walkover|w/o]]|[[FC Barcelona|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

|style="background-color:#fff"|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 (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.

=== Team country codes ===

Line 415 ⟶ 565:

=== Leg and aggregate scores ===

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 [[Help:Table#Nowrap|nowrap]] applied to them, as long as two or more sets of parentheses are not present.

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

* <code>(X–Y p)</code>, <code>(X–Y pen)</code> or <code>(X–Y pso)</code> {{arrow}} <code><nowiki>(X–Y [[Penalty shoot-out (association football)|p]])</nowiki></code>

* <code>(aet)</code> or <code>(a.e.t.)</code> {{arrow}} <code><nowiki>([[Overtime (sports)#Association football|a.e.t.]])</nowiki></code>

* <code>(a)</code> or <code>(agr)</code> {{arrow}} <code><nowiki>([[Away goals rule|a]])</nowiki></code>

* <code>(w/o)</code> or <code>(w.o.)</code> {{arrow}} <code><nowiki>([[Walkover|w/o]])</nowiki></code>

; Usage

Line 435 ⟶ 586:

=== Null/nil leg scores ===

If a cell of one of the leg scores contains only <code>null</code>, 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 <code>nil</code>, the cell will not be generated.