Module:Sports results/doc

This Lua-based module is meant to build match result tables. Note that this module is used extensively, so test potential changes rigorously in the sandbox and please ensure consensus exists before implementing major changes. Also note that the module is called from Module:Sports table and check for potential issues there as well after making changes. The rest of this documentation explains how to use this module in an article or template, check the table of contents for specific items.

Wikitext test cases at Module:Sports results/testcases wikitext.

Usage

The template can be used as follows:

class="wikitable" style="background:white;"

What you type

{{#invoke:Sports results|main
|update=1 January 1900
|source=[https://en.wikipedia.org/wiki/Main_Page Wikipedia]
|showteam=CCC
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|name_FDT=FIFA World Cup Dream Team  |short_FDT=FDT
|name_BBB=Team 2                         |short_BBB=T2
|name_CCC=Team 3                         |short_CCC=T3
|name_DDD=DDD F.C.                       |short_DDD=DDD
|name_EEE={{fb-rt|GIB}} |short_EEE={{flagicon|Gibraltar}}
|match_FDT_BBB=1–0
|match_FDT_CCC=0–1
|match_FDT_DDD=16 Nov '14
|match_FDT_EEE=3 Sep '15
|match_BBB_FDT=B–F
|match_BBB_CCC=3 Sep '15
|match_BBB_DDD=B–D
|match_BBB_EEE=3 Sep '15
|match_CCC_FDT=16 Nov '14
|match_CCC_BBB=C–B
|match_CCC_DDD=16 Nov '14
|match_CCC_EEE=C–E
|match_DDD_FDT=D–F
|match_DDD_BBB=3 Sep '15
|match_DDD_CCC=D–C
|match_DDD_EEE=3 Sep '15
|match_EEE_FDT=E–F
|match_EEE_BBB=9–5
|match_EEE_CCC=16 Nov '14
|match_EEE_DDD=E–D
|match_FDT_BBB_note=Match awarded to FIFA World Cup Dream Team with a 1–0 score.
}}

What it looks like

|{{#invoke:Sports results|main

|update=1 January 1900

|source=[https://en.wikipedia.org/wiki/Main_Page Wikipedia]

|showteam=CCC

|name_FDT=FIFA World Cup Dream Team |short_FDT=FDT

|name_BBB=Team 2 |short_BBB=T2

|name_CCC=Team 3 |short_CCC=T3

|name_DDD=DDD F.C. |short_DDD=DDD

|name_EEE={{fb-rt|GIB}} |short_EEE={{flagicon|Gibraltar}}

|match_FDT_BBB=1–0

|match_FDT_CCC=0–1

|match_FDT_DDD=16 Nov '14

|match_FDT_EEE=3 Sep '15

|match_BBB_FDT=B–F

|match_BBB_CCC=3 Sep '15

|match_BBB_DDD=B–D

|match_BBB_EEE=3 Sep '15

|match_CCC_FDT=16 Nov '14

|match_CCC_BBB=C–B

|match_CCC_DDD=16 Nov '14

|match_CCC_EEE=C–E

|match_DDD_FDT=D–F

|match_DDD_BBB=3 Sep '15

|match_DDD_CCC=D–C

|match_DDD_EEE=3 Sep '15

|match_EEE_FDT=E–F

|match_EEE_BBB=9–5

|match_EEE_CCC=16 Nov '14

|match_EEE_DDD=E–D

|match_FDT_BBB_note=Match awarded to FIFA World Cup Dream Team with a 1–0 score.

}}

The main command is {{#invoke:Sports results|main}}, which calls the module and sets the basic structure up. Then you list the order in which the teams are listed as {{para|team1}}, {{para|team2}}, etc for however many teams you need in the table. If you set {{para|showteam}} to a team, then that team's results are highlighted as in the example. The display of team names for team TTT is now governed by {{para|name_TTT}} and {{para|short_TTT}} for the row and column headers respectively. The results for the game TTT vs. SSS can now be input by {{para|match_TTT_SSS}}. The table is build this way, future games can be listed with their date or they can be left blank.

The source is controlled by {{para|source}}. The update date can be set by {{para|update|date}} when the season is active; can be removed after the season with {{para|update|complete}} and can be set for a future start date by using {{para|update|future}} and setting the start date with {{para|start_date}}.

The width of the columns can be set by {{para|match_col_width}}.

A note can be added to a result using {{para|match_TTT_SSS_note}}.

Another example is:

class="wikitable" style="background:white;"

What you type

{{#invoke:Sports results|main
|team1=CZE |team2=ISL |team3=KAZ |team4=LVA |team5=NED |team6=TUR
|name_CZE={{fb-rt|CZE}}	|short_CZE={{flagicon|CZE}}
|name_ISL={{fb-rt|ISL}}	|short_ISL={{flagicon|ISL}}
|name_KAZ={{fb-rt|KAZ}}	|short_KAZ={{flagicon|KAZ}}
|name_LVA={{fb-rt|LVA}}	|short_LVA={{flagicon|LVA}}
|name_NED={{fb-rt|NED}}	|short_NED={{flagicon|NED}}
|name_TUR={{fb-rt|TUR}}	|short_TUR={{flagicon|TUR}}
|match_CZE_ISL=16 Nov '14
|match_CZE_KAZ=3 Sep '15
|match_CZE_LVA=28 Mar '15
|match_CZE_NED=2–1
|match_CZE_TUR=10 Oct '15
|match_ISL_CZE=12 Jun '15
|match_ISL_KAZ=6 Sep '15
|match_ISL_LVA=10 Oct '15
|match_ISL_NED=2–0
|match_ISL_TUR=3–0
|match_KAZ_CZE=2–4
|match_KAZ_ISL=28 Mar '15
|match_KAZ_LVA=0–0
|match_KAZ_NED=10 Oct '15
|match_KAZ_TUR=12 Jun '15
|match_LVA_CZE=6 Sep '15
|match_LVA_ISL=0–3
|match_LVA_KAZ=13 Oct '15
|match_LVA_NED=12 Jun '15
|match_LVA_TUR=1–1
|match_NED_CZE=13 Oct '15
|match_NED_ISL=3 Sep '15
|match_NED_KAZ=3–1
|match_NED_LVA=16 Nov '14
|match_NED_TUR=28 Mar '15
|match_TUR_CZE=1–2
|match_TUR_ISL=13 Oct '15
|match_TUR_KAZ=16 Nov '14
|match_TUR_LVA=3 Sep '15
|match_TUR_NED=6 Sep '15
}}

What it looks like

|{{#invoke:Sports results|main

|name_CZE={{fb-rt|CZE}} |short_CZE={{flagicon|CZE}}

|name_ISL={{fb-rt|ISL}} |short_ISL={{flagicon|ISL}}

|name_KAZ={{fb-rt|KAZ}} |short_KAZ={{flagicon|KAZ}}

|name_LVA={{fb-rt|LVA}} |short_LVA={{flagicon|LVA}}

|name_NED={{fb-rt|NED}} |short_NED={{flagicon|NED}}

|name_TUR={{fb-rt|TUR}} |short_TUR={{flagicon|TUR}}

|match_CZE_ISL=16 Nov '14

|match_CZE_KAZ=3 Sep '15

|match_CZE_LVA=28 Mar '15

|match_CZE_NED=2–1

|match_CZE_TUR=10 Oct '15

|match_ISL_CZE=12 Jun '15

|match_ISL_KAZ=6 Sep '15

|match_ISL_LVA=10 Oct '15

|match_ISL_NED=2–0

|match_ISL_TUR=3–0

|match_KAZ_CZE=2–4

|match_KAZ_ISL=28 Mar '15

|match_KAZ_LVA=0–0

|match_KAZ_NED=10 Oct '15

|match_KAZ_TUR=12 Jun '15

|match_LVA_CZE=6 Sep '15

|match_LVA_ISL=0–3

|match_LVA_KAZ=13 Oct '15

|match_LVA_NED=12 Jun '15

|match_LVA_TUR=1–1

|match_NED_CZE=13 Oct '15

|match_NED_ISL=3 Sep '15

|match_NED_KAZ=3–1

|match_NED_LVA=16 Nov '14

|match_NED_TUR=28 Mar '15

|match_TUR_CZE=1–2

|match_TUR_ISL=13 Oct '15

|match_TUR_KAZ=16 Nov '14

|match_TUR_LVA=3 Sep '15

|match_TUR_NED=6 Sep '15

}}

= Win/Draw/Loss colour =

The colour of win/draw/loss colour can be set by {{para|matches_style|FBR}}.

class="wikitable" style="background:white;"

What you type

{{#invoke:sports results|main
|source =
|update=22 April 2018
|matches_style = FBR
|team1=CER |team2=DAV |team3=GLC |team4=JPV |team5=KAY |team6=STA
|name_CER=Ceres–Negros
|name_DAV=Davao Aguilas
|name_GLC=Global Cebu
|name_JPV=JPV Marikina
|name_KAY=Kaya–Iloilo
|name_STA={{nowrap|Stallion Laguna}}
|match_CER_DAV={{small|{{small|23 May}}}}
|match_CER_GLC={{small|{{small|30 May}}}}
|match_CER_JPV={{small|{{small|20 Jun}}}}
|match_CER_KAY=2–1
|match_CER_STA={{small|{{small|2 Jun}}}}
|match_DAV_CER={{small|{{small|2 May}}}}
|match_DAV_GLC={{small|{{small|20 Jun}}}}
|match_DAV_JPV=3–2
|match_DAV_KAY=2–2
|match_DAV_STA={{small|{{small|6 May}}}}
|match_GLC_CER=0–2
|match_GLC_DAV=2–2
|match_GLC_JPV={{small|{{small|27 May}}}}
|match_GLC_KAY={{small|{{small|23 May}}}}
|match_GLC_STA=1–2
|match_JPV_CER=0–3
|match_JPV_DAV={{small|{{small|9 Jun}}}}
|match_JPV_GLC=2–1
|match_JPV_KAY={{small|{{small|5 May}}}}
|match_JPV_STA={{small|{{small|19 May}}}}
|match_KAY_CER={{small|{{small|12 May}}}}
|match_KAY_DAV={{small|{{small|20 May}}}}
|match_KAY_GLC={{small|{{small|2 May}}}}
|match_KAY_JPV=1–0
|match_KAY_STA=4–1
|match_STA_CER={{small|{{small|26 May}}}}
|match_STA_DAV=0–1
|match_STA_GLC={{small|{{small|12 May}}}}
|match_STA_JPV=1–2
|match_STA_KAY=null
}}

What it looks like

|{{#invoke:sports results|main

|source =

|update=22 April 2018

|matches_style = FBR

|name_CER=Ceres–Negros

|name_DAV=Davao Aguilas

|name_GLC=Global Cebu

|name_JPV=JPV Marikina

|name_KAY=Kaya–Iloilo

|name_STA={{nowrap|Stallion Laguna}}

|match_CER_DAV={{small|{{small|23 May}}}}

|match_CER_GLC={{small|{{small|30 May}}}}

|match_CER_JPV={{small|{{small|20 Jun}}}}

|match_CER_KAY=2–1

|match_CER_STA={{small|{{small|2 Jun}}}}

|match_DAV_CER={{small|{{small|2 May}}}}

|match_DAV_GLC={{small|{{small|20 Jun}}}}

|match_DAV_JPV=3–2

|match_DAV_KAY=2–2

|match_DAV_STA={{small|{{small|6 May}}}}

|match_GLC_CER=0–2

|match_GLC_DAV=2–2

|match_GLC_JPV={{small|{{small|27 May}}}}

|match_GLC_KAY={{small|{{small|23 May}}}}

|match_GLC_STA=1–2

|match_JPV_CER=0–3

|match_JPV_DAV={{small|{{small|9 Jun}}}}

|match_JPV_GLC=2–1

|match_JPV_KAY={{small|{{small|5 May}}}}

|match_JPV_STA={{small|{{small|19 May}}}}

|match_KAY_CER={{small|{{small|12 May}}}}

|match_KAY_DAV={{small|{{small|20 May}}}}

|match_KAY_GLC={{small|{{small|2 May}}}}

|match_KAY_JPV=1–0

|match_KAY_STA=4–1

|match_STA_CER={{small|{{small|26 May}}}}

|match_STA_DAV=0–1

|match_STA_GLC={{small|{{small|12 May}}}}

|match_STA_JPV=1–2

|match_STA_KAY=null

}}

= Team header =

To change the default Home \ Away team header, use {{para|team_header}}.

= Two legs =

For two matches per team pair, use {{para|legs|2}} and {{para|match1_AAA_BBB}} / {{para|match2_AAA_BBB}} instead of {{para|match_AAA_BBB}}. For wide tables, use {{para|multirowlegs|y}} which provides a more narrow format.

= Blank and pivot cells =

Pivot cells defaulted to show — (m-dash), but they can be changed to solidly colored cell using code {{para|solid_cell}} where color of the cell could be set by indicating with a phrase (i.e. grey). Also, each individual cell could be made inactive with a phrase null.

Generating a blank table

To generate a blank table, use


{{subst:#invoke:Sports results/blank|main
| team1 = AAA | team2 = BBB | ...
}}

where {{para|team1}}, {{para|team2}}, ... are the abbreviations for the team names in the order you wish them to appear. You may include {{para|name_...}} and other parameters as well, and they should be included in the result.

Module:Sports results/doc

Usage

= Win/Draw/Loss colour =

= Team header =

= Two legs =

= Blank and pivot cells =

Generating a blank table

See also