Login
Login

Module:Sports table/College/doc

{{Module rating |release}}

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

class="wikitable" style="background:white;"
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

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

}}

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 {{para|team1}}, {{para|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 {{para|win_TTT}}, {{para|loss_TTT}}, {{para|gf_TTT}} and {{para|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 {{para|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==

class="wikitable" style="background:white;"
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

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

}}

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

=Customization=

Several things can be customized in these tables

==Hiding played column==

Setting {{para|hide_played|yes}} hides the played column.

==Points, wins or percentage==

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

class="wikitable" style="background:white;"
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

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

}}

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

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

==Games behind==

class="wikitable" style="background:white;"
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

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

}}

Games behind can be added to the table as well by setting {{para|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 {{para|GB_team|N}}.

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

class="wikitable" style="background:white;"
What you type

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

|for_against_style=points

}}

What it looks like

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

|for_against_style=points

}}

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

The wording of the Grp (group) column can be adjusted using {{para|group_header}}, for example {{para|group_header|Lge}}.

==Goal ratio/goal average==

class="wikitable" style="background:white;"
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

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

}}

Using {{para|use_goal_ratio|yes}} use goal ratio (goal average) instead of goal differential.

{{Module:Sports table/styledoc|style_option=WL}}

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.

class="wikitable" style="background:white;"
What you type

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

|update = future

|start_date = Unknown

|source = Unknown

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |team6=FFF |team7=GGG |team8=HHH |team9=III |team10=JJJ |team11=KKK |team12=LLL

|result1=PRO |result2=CLG |result3=KO |result4=CLPO |result5=ELPO |result8=ELG |result11=RPO |result12=REL

|win_AAA=0 |loss_AAA=0 |gf_AAA=0 |ga_AAA=0 |status_AAA=CQ

|win_BBB=0 |loss_BBB=0 |gf_BBB=0 |ga_BBB=0 |status_BBB=C

|win_CCC=0 |loss_CCC=0 |gf_CCC=0 |ga_CCC=0 |status_CCC=A

|win_DDD=0 |loss_DDD=0 |gf_DDD=0 |ga_DDD=0 |status_DDD=T

|win_EEE=0 |loss_EEE=0 |gf_EEE=0 |ga_EEE=0 |status_EEE=

|win_FFF=0 |loss_FFF=0 |gf_FFF=0 |ga_FFF=0 |status_FFF=

|win_GGG=0 |loss_GGG=0 |gf_GGG=0 |ga_GGG=0 |status_GGG=

|win_HHH=0 |loss_HHH=0 |gf_HHH=0 |ga_HHH=0 |status_HHH=

|win_III=0 |loss_III=0 |gf_III=0 |ga_III=0 |status_III=

|win_JJJ=0 |loss_JJJ=0 |gf_JJJ=0 |ga_JJJ=0 |status_JJJ=

|win_KKK=0 |loss_KKK=0 |gf_KKK=0 |ga_KKK=0 |status_KKK=

|win_LLL=0 |loss_LLL=0 |gf_LLL=0 |ga_LLL=0 |status_LLL=R

|name_AAA = A team

|name_BBB = B team

|name_CCC = C team

|name_DDD = D team

|name_EEE = E team

|name_FFF = F team

|name_GGG = G team

|name_HHH = H team

|name_III = I team

|name_JJJ = J team

|name_KKK = K team

|name_LLL = L team

|show_limit =

|class_rules = 1) Points; 2) Goal difference; 3) Number of goals scored;

|res_col_header = PQR

|col_PRO = green1 |text_PRO = Promotion to

|col_KO = green1 |text_KO = Advance to

|col_CLG = green1 |text_CLG = Qualification for

|col_CLPO= green2 |text_CLPO= Qualification for

|col_ELG = blue1 |text_ELG = Qualification for

|col_ELPO= blue2 |text_ELPO= Qualification for

|col_RPO = red2 |text_RPO = Qualification for

|col_REL = red1 |text_REL = Relegation to

}}

What it looks like

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

|update = future

|start_date = Unknown

|source = Unknown

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |team6=FFF |team7=GGG |team8=HHH |team9=III |team10=JJJ |team11=KKK |team12=LLL

|result1=PRO |result2=CLG |result3=KO |result4=CLPO |result5=ELPO |result8=ELG |result11=RPO |result12=REL

|win_AAA=0 |loss_AAA=0 |gf_AAA=0 |ga_AAA=0 |status_AAA=CQ

|win_BBB=0 |loss_BBB=0 |gf_BBB=0 |ga_BBB=0 |status_BBB=Q

|win_CCC=0 |loss_CCC=0 |gf_CCC=0 |ga_CCC=0 |status_CCC=A

|win_DDD=0 |loss_DDD=0 |gf_DDD=0 |ga_DDD=0 |status_DDD=T

|win_EEE=0 |loss_EEE=0 |gf_EEE=0 |ga_EEE=0 |status_EEE=

|win_FFF=0 |loss_FFF=0 |gf_FFF=0 |ga_FFF=0 |status_FFF=

|win_GGG=0 |loss_GGG=0 |gf_GGG=0 |ga_GGG=0 |status_GGG=

|win_HHH=0 |loss_HHH=0 |gf_HHH=0 |ga_HHH=0 |status_HHH=

|win_III=0 |loss_III=0 |gf_III=0 |ga_III=0 |status_III=

|win_JJJ=0 |loss_JJJ=0 |gf_JJJ=0 |ga_JJJ=0 |status_JJJ=

|win_KKK=0 |loss_KKK=0 |gf_KKK=0 |ga_KKK=0 |status_KKK=

|win_LLL=0 |loss_LLL=0 |gf_LLL=0 |ga_LLL=0 |status_LLL=R

|name_AAA = A team

|name_BBB = B team

|name_CCC = C team

|name_DDD = D team

|name_EEE = E team

|name_FFF = F team

|name_GGG = G team

|name_HHH = H team

|name_III = I team

|name_JJJ = J team

|name_KKK = K team

|name_LLL = L team

|show_limit = 5

|class_rules = 1) Points; 2) Goal difference; 3) Number of goals scored;

|res_col_header = PQR

|col_PRO = green1 |text_PRO = Promotion to

|col_KO = green1 |text_KO = Advance to

|col_CLG = green1 |text_CLG = Qualification for

|col_CLPO= green2 |text_CLPO= Qualification for

|col_ELG = blue1 |text_ELG = Qualification for

|col_ELPO= blue2 |text_ELPO= Qualification for

|col_RPO = red2 |text_RPO = Qualification for

|col_REL = red1 |text_REL = Relegation to

}}

{{Sandbox other||

Category:Sports modules

}}