View source for Module:Sports rbr table/matchup/doc

{{Module rating|release}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
=== Basic usage ===
This module is an extension of [[Module:Sports rbr table]], showing matchups and head-to-head results table.

In it's simplest form, only several parameters need to be used to build a table.

{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports rbr table|table
|style=matchup|legend_style=BSK

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|opp_AAA = TM2/TM3/TM4/GIB
|res_AAA =  W / L /OTL/ W

|opp_BBB = GIB/TM1/TM3/TM4
|res_BBB =  L / L /OTW/ W

|opp_CCC = TM4/GIB/TM1/TM2
|res_CCC =  W / L / W /OTL

|opp_DDD = TM3/TM2/TM1/GIB
|res_DDD = OTW/ L / L / L

|opp_EEE = TM3/TM4/TM1/TM2
|res_EEE =  W / W / L / W

|name_AAA=[[Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{bk|GIB}}
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports rbr table|table
|style=matchup|legend_style=BSK

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|opp_AAA = TM2/TM3/TM4/GIB
|res_AAA =  W / L /OTL/ W

|opp_BBB = GIB/TM1/TM3/TM4
|res_BBB =  L / L /OTW/ W

|opp_CCC = TM4/GIB/TM1/TM2
|res_CCC =  W / L / W /OTL

|opp_DDD = TM3/TM2/TM1/GIB
|res_DDD = OTW/ L / L / L

|opp_EEE = TM3/TM4/TM1/TM2
|res_EEE =  W / W / L / W

|name_AAA=[[Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{bk|GIB}}
}}
|}

== Parameters ==
=== General parameters ===
{{Main|Module:Sports rbr table#Parameters}}

=== Style–specific parameters ===
{| class="wikitable"
|-
! colspan=2 | Style–specific parameters
|-
! Parameter !! Description
|-
| <code>opp1</code> or<br><code>opp_ABC</code> || The forward slash (<code>/</code>) delimited list of round-by-round opponents of the team. For example, {{para|opp1|DEF/GHI/JKL/MNO/PQR/STU/VWX}} for seven games.
|-
| <code>legend_style</code> || Legend colors and text to display based on usage. The default is <code>WL</code>. See the [[#Legend|legend]] section below for more information on legend syntax.
|- 
| <code>rdrobin</code> || Number of times each team plays all other teams. The default is <code>1</code> (i.e. single [[Round-robin tournament|round-robin]]).
|-
| <code>ticon</code> || The name of the template to trigger to show teams' identity (e.g. three-letter codes, team colors, team icons)
|}

== Legend ==
=== Key ===
The keys below correspond to <code>res1</code> or <code>res_ABC</code> usage: the forward slash (<code>/</code>) delimited list of matchup results of the team.

For example, {{para|res1|W/OTL/FW/W/L}} for five games with the round-by-round results of win, OT loss, win by forfeit, win, loss.

{| class="wikitable"
! width="80px"| Key !! Legend color
|-
| align="center"| <code>W</code> || {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
|-
| align="center"| <code>D</code> || {{legend2|#FFFFCC|Draw|border=1px solid #AAAAAA}}
|-
| align="center"| <code>L</code> || {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
|-
| align="center"| <code>OTW</code> || {{legend2|#DDFCFF|OT win|border=1px solid #AAAAAA}}
|-
| align="center"| <code>OTL</code> || {{legend2|#FFDDDD|OT loss|border=1px solid #AAAAAA}}
|-
| align="center"| <code>FW</code> || {{legend2|#5CDEFD|Win by forfeit|border=1px solid #AAAAAA}}
|-
| align="center"| <code>FL</code> || {{legend2|#D98080|Loss by forfeit|border=1px solid #AAAAAA}}
|}

=== Style ===
Legend colors and text will be displayed based on usage.
{| class="wikitable"
|-
! width="120px"| Legend style
! width="100px"| <code>WL</code>
! width="100px"| <code>WLF</code>
! width="100px"| <code>BSK</code>
! width="100px"| <code>BSKF</code>
! width="100px"| <code>FBR</code>
! width="100px"| <code>FBRF</code>
|-
! Colors
| style="vertical-align:top;"| {{unbulleted list
| {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
| {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
}}
| style="vertical-align:top;"| {{unbulleted list
| {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
| {{legend2|#5CDEFD|Win by forfeit|border=1px solid #AAAAAA}}
| {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
| {{legend2|#D98080|Loss by forfeit|border=1px solid #AAAAAA}}
}}
| style="vertical-align:top;"| {{unbulleted list
| {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
| {{legend2|#DDFCFF|OT win|border=1px solid #AAAAAA}}
| {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
| {{legend2|#FFDDDD|OT loss|border=1px solid #AAAAAA}}
}}
| style="vertical-align:top;"| {{unbulleted list
| {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
| {{legend2|#DDFCFF|OT win|border=1px solid #AAAAAA}}
| {{legend2|#5CDEFD|Win by forfeit|border=1px solid #AAAAAA}}
| {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
| {{legend2|#FFDDDD|OT loss|border=1px solid #AAAAAA}}
| {{legend2|#D98080|Loss by forfeit|border=1px solid #AAAAAA}}
}}
| style="vertical-align:top;"| {{unbulleted list
| {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
| {{legend2|#FFFFCC|Draw|border=1px solid #AAAAAA}}
| {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
}}
| style="vertical-align:top;"| {{unbulleted list
| {{legend2|#BBF3FF|Win|border=1px solid #AAAAAA}}
| {{legend2|#5CDEFD|Win by forfeit|border=1px solid #AAAAAA}}
| {{legend2|#FFFFCC|Draw|border=1px solid #AAAAAA}}
| {{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
| {{legend2|#D98080|Loss by forfeit|border=1px solid #AAAAAA}}
}}
|}

== Examples ==
=== Example 1: Cells contain literal texts ===
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports rbr table|table|style=matchup|legend_style=FBR

|team1 = ADM |name_ADM = {{UAAPteam|Ateneo|short}}
|team2 = DLZ |name_DLZ = {{UAAPteam|La Salle|name=DLSZ}}
|team3 = FEU |name_FEU = {{UAAPteam|FEU|short}}
|team4 = NUI |name_NUI = {{UAAPteam|NU|short}}
|team5 = UST |name_UST = {{UAAPteam|UST|short}}

|opp_ADM = UST/NUI/DLS/FEU
|res_ADM =  W / W / L / D

|opp_DLZ = NUI/ADM/FEU/UST
|res_DLZ =  L / W / L / L

|opp_FEU = UST/NUI/DLS/ADM
|res_FEU =  W / W / W / D

|opp_NUI = DLS/ADM/FEU/UST
|res_NUI =  W / L / L / D

|opp_UST = ADM/FEU/NUI/DLS
|res_UST =  L / L / D / W
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports rbr table|table|style=matchup|legend_style=FBR
|team1 = ADM |name_ADM = {{UAAPteam|Ateneo|short}}
|team2 = DLZ |name_DLZ = {{UAAPteam|La Salle|name=DLSZ}}
|team3 = FEU |name_FEU = {{UAAPteam|FEU|short}}
|team4 = NUI |name_NUI = {{UAAPteam|NU|short}}
|team5 = UST |name_UST = {{UAAPteam|UST|short}}

|opp_ADM = UST/NUI/DLS/FEU
|res_ADM =  W / W / L / D

|opp_DLZ = NUI/ADM/FEU/UST
|res_DLZ =  L / W / L / L

|opp_FEU = UST/NUI/DLS/ADM
|res_FEU =  W / W / W / D

|opp_NUI = DLS/ADM/FEU/UST
|res_NUI =  W / L / L / D

|opp_UST = ADM/FEU/NUI/DLS
|res_UST =  L / L / D / W
}}
|}

=== Example 2: Cells contain icons ===
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports rbr table|table|style=matchup|ticon=UAAPicon|legend_style=FBR

|team1 = ADM |name_ADM = {{UAAPteam|Ateneo|short}}
|team2 = DLZ |name_DLZ = {{UAAPteam|La Salle|short|name=DLSZ}}
|team3 = FEU |name_FEU = {{UAAPteam|FEU|short}}
|team4 = NUI |name_NUI = {{UAAPteam|NU|short}}
|team5 = UST |name_UST = {{UAAPteam|UST|short}}

|opp_ADM = UST/NUI/DLS/FEU
|res_ADM =  W / W / L / D

|opp_DLZ = NUI/ADM/FEU/UST
|res_DLZ =  L / W / L / L

|opp_FEU = UST/NUI/DLS/ADM
|res_FEU =  W / W / W / D

|opp_NUI = DLS/ADM/FEU/UST
|res_NUI =  W / L / L / D

|opp_UST = ADM/FEU/NUI/DLS
|res_UST =  L / L / D / W
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports rbr table|table|style=matchup|ticon=UAAPicon|legend_style=FBR

|team1 = ADM |name_ADM = {{UAAPteam|Ateneo|short}}
|team2 = DLZ |name_DLZ = {{UAAPteam|La Salle|short|name=DLSZ}}
|team3 = FEU |name_FEU = {{UAAPteam|FEU|short}}
|team4 = NUI |name_NUI = {{UAAPteam|NU|short}}
|team5 = UST |name_UST = {{UAAPteam|UST|short}}

|opp_ADM = UST/NUI/DLS/FEU
|res_ADM =  W / W / L / D

|opp_DLZ = NUI/ADM/FEU/UST
|res_DLZ =  L / W / L / L

|opp_FEU = UST/NUI/DLS/ADM
|res_FEU =  W / W / W / D

|opp_NUI = DLS/ADM/FEU/UST
|res_NUI =  W / L / L / D

|opp_UST = ADM/FEU/NUI/DLS
|res_UST =  L / L / D / W
}}
|}

=== Example 3: Double round-robin schedule ===
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports rbr table|table|style=matchup|rdrobin=2|legend_style=BSK

|team1 = ADU |name_ADU = {{UAAPteam|Adamson|short}}
|team2 = ADM |name_ADM = {{UAAPteam|Ateneo|short}}
|team3 = DLS |name_DLS = {{UAAPteam|La Salle|short}}
|team4 = FEU |name_FEU = {{UAAPteam|FEU|short}}
|team5 = NUI |name_NUI = {{UAAPteam|NU|short}}
|team6 = UEA |name_UEA = {{UAAPteam|UE|short}}
|team7 = UPD |name_UPD = {{UAAPteam|UP|short}}
|team8 = UST |name_UST = {{UAAPteam|UST|short}}

|opp_ADU = ADM/NUI/UEA/UPD/UST/DLS/FEU/UEA/ADM/NUI/UPD/FEU/UST/DLS
|res_ADU =  L /OTW/ W /OTL/ W / L / L / L / L / W / L / L / L / L

|opp_ADM = ADU/DLS/UST/FEU/NUI/UEA/UPD/UST/ADU/DLS/FEU/UEA/NUI/UPD
|res_ADM =  W / W / W / W / W / W / W / W / W / W / W / W / W / W

|opp_DLS = ADM/NUI/UEA/FEU/ADU/UPD/UST/NUI/ADM/UEA/FEU/UST/UPD/ADU
|res_DLS =  L / W / L / L / W / L / W / W / L / W / L / W / L / W

|opp_FEU = UPD/UEA/ADM/DLS/UST/NUI/ADU/UPD/NUI/UST/ADM/DLS/ADU/UEA
|res_FEU =  L / W / L / W / L / L / W /OTW/OTL/ W / L / W / W / W

|opp_NUI = ADU/DLS/UST/UPD/ADM/FEU/UEA/DLS/FEU/ADU/UST/UPD/ADM/UEA
|res_NUI = OTL/ L /OTL/ L / L / W / L / L /OTW/ L / L / L / L / L

|opp_UEA = UST/FEU/ADU/DLS/UPD/ADM/NUI/ADU/UST/UPD/DLS/ADM/FEU/NUI
|res_UEA =  L / L / L / W / L / L / W / W / L / L / L / L / L / W

|opp_UPD = FEU/UST/ADU/NUI/UEA/DLS/ADM/FEU/UEA/UST/ADU/NUI/DLS/ADM
|res_UPD =  W / L /OTW/ W / W / W / L /OTL/ W / L / W / W / W / L

|opp_UST = UEA/UPD/ADM/NUI/ADU/FEU/DLS/ADM/UEA/FEU/UPD/NUI/DLS/ADU
|res_UST =  W / W / L /OTW/ L / W / L / L / W / L / W / W / L / W
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports rbr table|table|style=matchup|rdrobin=2|legend_style=BSK

|team1 = ADU |name_ADU = {{UAAPteam|Adamson|short}}
|team2 = ADM |name_ADM = {{UAAPteam|Ateneo|short}}
|team3 = DLS |name_DLS = {{UAAPteam|La Salle|short}}
|team4 = FEU |name_FEU = {{UAAPteam|FEU|short}}
|team5 = NUI |name_NUI = {{UAAPteam|NU|short}}
|team6 = UEA |name_UEA = {{UAAPteam|UE|short}}
|team7 = UPD |name_UPD = {{UAAPteam|UP|short}}
|team8 = UST |name_UST = {{UAAPteam|UST|short}}

|opp_ADU = ADM/NUI/UEA/UPD/UST/DLS/FEU/UEA/ADM/NUI/UPD/FEU/UST/DLS
|res_ADU =  L /OTW/ W /OTL/ W / L / L / L / L / W / L / L / L / L

|opp_ADM = ADU/DLS/UST/FEU/NUI/UEA/UPD/UST/ADU/DLS/FEU/UEA/NUI/UPD
|res_ADM =  W / W / W / W / W / W / W / W / W / W / W / W / W / W

|opp_DLS = ADM/NUI/UEA/FEU/ADU/UPD/UST/NUI/ADM/UEA/FEU/UST/UPD/ADU
|res_DLS =  L / W / L / L / W / L / W / W / L / W / L / W / L / W

|opp_FEU = UPD/UEA/ADM/DLS/UST/NUI/ADU/UPD/NUI/UST/ADM/DLS/ADU/UEA
|res_FEU =  L / W / L / W / L / L / W /OTW/OTL/ W / L / W / W / W

|opp_NUI = ADU/DLS/UST/UPD/ADM/FEU/UEA/DLS/FEU/ADU/UST/UPD/ADM/UEA
|res_NUI = OTL/ L /OTL/ L / L / W / L / L /OTW/ L / L / L / L / L

|opp_UEA = UST/FEU/ADU/DLS/UPD/ADM/NUI/ADU/UST/UPD/DLS/ADM/FEU/NUI
|res_UEA =  L / L / L / W / L / L / W / W / L / L / L / L / L / W

|opp_UPD = FEU/UST/ADU/NUI/UEA/DLS/ADM/FEU/UEA/UST/ADU/NUI/DLS/ADM
|res_UPD =  W / L /OTW/ W / W / W / L /OTL/ W / L / W / W / W / L

|opp_UST = UEA/UPD/ADM/NUI/ADU/FEU/DLS/ADM/UEA/FEU/UPD/NUI/DLS/ADU
|res_UST =  W / W / L /OTW/ L / W / L / L / W / L / W / W / L / W
}}
|}

== See also ==
* [[Module:Sports table]]
* [[Module:Sports results]]
== Tracking category ==
* {{clc|Pages using sports rbr table with dubious updated parameter}} (pages where the updated date does not match the parent page name)
* {{clc|Pages using sports rbr table with legendorder}} (pages where the {{para|legendorder}} parameter is used)
* {{clc|Pages using sports rbr table with rnd parameters}} (pages where the {{para|rnd1}} parameter is used and may be converted to {{para|firstround}})
* {{clc|Pages using sports rbr table with unsupported parameters}} (pages where unsupported parameters are used, or where the {{para|header}} is potentially missing)

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Sports modules]]
}}</includeonly>