Module:Sports table/College/doc

This is the documentation page for Module:Sports table/College

This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This style for Lua-based Module:Sports table is meant to build group and league tables for competitions with a win-loss format. Note that this module is used extensively, so test potential changes rigorously in the sandbox and please ensure consensus exists before implementing major changes. The rest of this documentation explains how to use this module with the WL style in an article or template, check the table of contents for specific items.

Usage

Basic usage

In its simplest form only several parameters need to be used to build a table

In article

What you type

{{#invoke:Sports table|main|style=College

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

|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6

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

What it looks like

Pos	Team v t e	CPCT	PCT	GF	GA	GD
1	Dream Team	—	—	10	0	+10
2	Team 2	—	—	3	2	+1
3	Team 3	—	—	3	3	0
4	Team 4	—	—	1	4	−3
5	Tɛmplet:Bk	—	—	0	6	−6

Updated to match(es) played on unknown. Source: ^{[citation needed]}

The main command is the {{#invoke:Sports table|main|style=College}} statement which basically calls the module and enables you to set everything up. Then you list the positions of the teams as |team1=, |team2=, etc for however many teams you need in the table. You can use full team names there without spaces if you want, but using codes (as in the example) can make it easier. For each team you now define the wins, losses, goals for and goals against by using |win_TTT=, |loss_TTT=, |gf_TTT= and |ga_TTT= respectively (with TTT replaced by the team code). If you do not define these numbers, it is automatically assumed to be 0. It is good practice though to include them anyway and to align the columns using appropriate spaces (as in the example), so the code is easy to read. The last step now is to define the |name_TTT= parameters which determine what name is shown in the table, you can use wiki markup and templates in here as well. See #Dating to see how to change the update date.

In template

What you type

{{#invoke:Sports table|main|style=College

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

|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6

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

What it looks like

Pos	Team v t e	CPCT	PCT	GF	GA	GD
1	Dream Team	—	—	10	0	+10
2	Team 2	—	—	3	2	+1
3	Team 3	—	—	3	3	0
4	Team 4	—	—	1	4	−3
5	Tɛmplet:Bk	—	—	0	6	−6

Updated to match(es) played on unknown. Source: ^{[citation needed]}

The markup is effectively the same. The value for |showteam=, is automatically forwarded from the template call (see #Team highlighting and partial table); the |only_pld_pts= is automatically forward truncated tables, (see #Appearance); the |show_matches= is automatically forwarded for match result visibility, see #Matches.

Customization

Several things can be customized in these tables

Hiding played column

Setting |hide_played=yes hides the played column.

Points, wins or percentage

By default teams are ranked by points, which can be adjusted as follows:

What you type

{{#invoke:Sports table|main|style=College

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

|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0 |adjust_points_FDT=1.5
|win_BBB=3 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6 |adjust_points_EEE=-1.5

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

|winpoints=2
|losspoints=-0.1
}}

What it looks like

Pos	Team v t e	CPCT	PCT	GF	GA	GD
1	Dream Team	—	—	10	0	+10
2	Team 2	—	—	3	2	+1
3	Team 3	—	—	3	3	0
4	Team 4	—	—	1	4	−3
5	Tɛmplet:Bk	—	—	0	6	−6

Updated to match(es) played on unknown. Source: ^{[citation needed]}

As a default a win is worth 2 points and a loss 1 point, these values can be overwritten to what you need by |winpoints= and |losspoints=. Teams can also start the season with bonus or penalty points, this can be included by using |adjust_points_TTT= for that specific team.

Alternatively teams can also be ranked by wins (set |ranking_style=wins or |ranking_style=percentage respectively)

Games behind

What you type

{{#invoke:Sports table|main|style=College
|ranking_style=percentage
|show_GB=yes |GB_team=2

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

|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6

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

What it looks like

Pos	Team v t e	CPCT	GB	PCT	GF	GA	GD
1	Dream Team	—	—	—	10	0	+10
2	Team 2	—	—	—	3	2	+1
3	Team 3	—	—	—	3	3	0
4	Team 4	—	—	—	1	4	−3
5	Tɛmplet:Bk	—	—	—	0	6	−6

Updated to match(es) played on unknown. Source: ^{[citation needed]}

Games behind can be added to the table as well by setting |show_GB=yes, per default this will be with respect to the first-placed team. To have the GB with respect to a the team ranked N, set |GB_team=N.

Header options (goals/points for/against and custom other headers)

What you type

{{#invoke:Sports table|main|style=College
|for_against_style=points
}}

What it looks like

Pos	Team v t e	Pld	CW	CL	CPCT	W	L	PCT	PF	PA	PD

Updated to match(es) played on unknown. Source: ^{[citation needed]}

For sports with points for and against rather than goals, setting |for_against_style=points switches the for, against and difference columns to using points instead. |for_against_style=none removes these columns completely. For sports with frames for and against rather than goals or points, setting |for_against_style=frames switches the for, against and difference columns to using points instead. |for_against_style=none removes these columns completely.

The wording of the Grp (group) column can be adjusted using |group_header=, for example |group_header=<abbr title="League">Lge</abbr>.

Goal ratio/goal average

What you type

{{#invoke:Sports table|main|style=College
|use_goal_ratio=yes

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

|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6

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

What it looks like

Pos	Team v t e	CPCT	PCT	GF	GA	GR
1	Dream Team	—	—	10	0	—
2	Team 2	—	—	3	2	1.500
3	Team 3	—	—	3	3	1.000
4	Team 4	—	—	1	4	0.250
5	Tɛmplet:Bk	—	—	0	6	0.000

Updated to match(es) played on unknown. Source: ^{[citation needed]}

Using |use_goal_ratio=yes use goal ratio (goal average) instead of goal differential. Module:Sports table/styledoc

Example usage

The module parameters can be arranged in different orders depending on the editor and article but below is an example use that can be copied when creating a module table.

What you type

{{#invoke:Sports table|main|style=College
|update = future <!-- When tournament started update the update-parameter with date of latest update and remove start_date-->
|start_date = Unknown <!-- On form 24 April 2165. When tournament started remove start_date-->
|source = Unknown <!-- Add source for table here with single bracket [webadress info] -->

<!--Update team positions here-->
|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |team6=FFF |team7=GGG |team8=HHH |team9=III |team10=JJJ |team11=KKK |team12=LLL

<!--Update team qualifications here (defined below)-->
|result1=PRO |result2=CLG |result3=KO |result4=CLPO |result5=ELPO |result8=ELG |result11=RPO |result12=REL

<!--Update team results here and then (if needed) positions above. Dont forget to update the date above (update parameter)-->
|win_AAA=0 |loss_AAA=0 |gf_AAA=0 |ga_AAA=0 |status_AAA=CQ <!-- Team A -->
|win_BBB=0 |loss_BBB=0 |gf_BBB=0 |ga_BBB=0 |status_BBB=C <!-- Team B -->
|win_CCC=0 |loss_CCC=0 |gf_CCC=0 |ga_CCC=0 |status_CCC=A <!-- Team C -->
|win_DDD=0 |loss_DDD=0 |gf_DDD=0 |ga_DDD=0 |status_DDD=T <!-- Team D -->
|win_EEE=0 |loss_EEE=0 |gf_EEE=0 |ga_EEE=0 |status_EEE= <!-- Team E -->
|win_FFF=0 |loss_FFF=0 |gf_FFF=0 |ga_FFF=0 |status_FFF= <!-- Team F -->
|win_GGG=0 |loss_GGG=0 |gf_GGG=0 |ga_GGG=0 |status_GGG= <!-- Team G -->
|win_HHH=0 |loss_HHH=0 |gf_HHH=0 |ga_HHH=0 |status_HHH= <!-- Team H -->
|win_III=0 |loss_III=0 |gf_III=0 |ga_III=0 |status_III= <!-- Team I -->
|win_JJJ=0 |loss_JJJ=0 |gf_JJJ=0 |ga_JJJ=0 |status_JJJ= <!-- Team J -->
|win_KKK=0 |loss_KKK=0 |gf_KKK=0 |ga_KKK=0 |status_KKK= <!-- Team K -->
|win_LLL=0 |loss_LLL=0 |gf_LLL=0 |ga_LLL=0 |status_LLL=R <!-- Team L -->

<!--Team definitions (wikilinks in table)-->
|name_AAA = A team<!-- Add wikilink for Team A here -->
|name_BBB = B team<!-- Add wikilink for Team B here -->
|name_CCC = C team<!-- Add wikilink for Team C here -->
|name_DDD = D team<!-- Add wikilink for Team D here -->
|name_EEE = E team<!-- Add wikilink for Team E here -->
|name_FFF = F team<!-- Add wikilink for Team F here -->
|name_GGG = G team<!-- Add wikilink for Team G here -->
|name_HHH = H team<!-- Add wikilink for Team H here -->
|name_III = I team<!-- Add wikilink for Team I here -->
|name_JJJ = J team<!-- Add wikilink for Team J here -->
|name_KKK = K team<!-- Add wikilink for Team K here -->
|name_LLL = L team<!-- Add wikilink for Team L here -->

<!--Table settings and rules-->
|show_limit = <!-- For league tables and other big tables use showlimit = 5 (standard per consensus to only show five teams on individual articles) -->
|class_rules = 1) Points; 2) Goal difference; 3) Number of goals scored; <!-- Add the classification rules here -->

<!--Qualification and relegation column definitions, use green for top tournament, then blue followed by yellow, red is elimination. Different levels of same competitions should have different shades in color like green1, green2 and so on.-->
|res_col_header = PQR <!-- All of these may not be needed, Promotion (P), Qualification (Q) and Relegation (R) -->
|col_PRO = green1 |text_PRO = Promotion to <!-- Wikilink to higher level, pipe year and association -->
|col_KO  = green1 |text_KO  = Advance to <!-- Wikilink to next stage for example knockout stage (KO) -->
|col_CLG = green1 |text_CLG = Qualification for <!-- Wikilink to tournament stage, pipe year and association -->
|col_CLPO= green2 |text_CLPO= Qualification for <!-- Wikilink to tournament stage, pipe year and association -->
|col_ELG = blue1  |text_ELG = Qualification for <!-- Wikilink to tournament stage, pipe year and association -->
|col_ELPO= blue2  |text_ELPO= Qualification for <!-- Wikilink to tournament stage, pipe year and association -->
|col_RPO = red2   |text_RPO = Qualification for <!-- Wikilink to relegation playoff, pipe to Relegation playoffs -->
|col_REL = red1   |text_REL = Relegation to <!-- Wikilink to lower level, pipe year and association -->
}}

What it looks like

Pos	Team v t e	CPCT	PCT	Promotion, qualification or relegation
1	A team (C, Q)	—	—	Promotion to
2	B team (Q)	—	—	Qualification for
3	C team (A)	—	—	Advance to
4	D team (T)	—	—	Qualification for
5	E team	—	—	Qualification for
6	F team	—	—
7	G team	—	—
8	H team	—	—	Qualification for
9	I team	—	—
10	J team	—	—
11	K team	—	—	Qualification for
12	L team (R)	—	—	Relegation to

First match(es) will be played on Unknown. Source: Unknown
Rules for classification: 1) Points; 2) Goal difference; 3) Number of goals scored;
(A) Advance to a further round; (C) Champion; (Q) Qualified for the phase indicated; (R) Relegated; (T) Qualified, but not yet for the particular phase indicated