Editing Module:Sports table/WDL/doc

{{module rating|release}}
{{module rating|protected}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
This style for Lua-based [[Module:Sports table]] is meant to build group and league tables for competitions with a win-draw-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 WDL 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'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL

|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL

|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
|}

The main command is the <nowiki>{{#invoke:Sports table|main|style=WDL}}</nowiki> 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 <u>without spaces</u> if you want, but using codes (as in the example) can make it easier. For each team you now define the wins, draws, losses, goals for and goals against by using {{para|win_TTT}}, {{para|draw_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.

The {{para|showteam}} parameter is automatically forwarded from a template call (see [[#Team highlighting and partial table]]); the {{para|only_pld_pts}} is automatically forwarded to truncated tables, (see [[#Appearance]]); the {{para|show_matches}} is automatically forwarded to control match result visibility, see [[#Matches]].

====In template====
Using this module in template is now deprecated per [[Wikipedia_talk:WikiProject_Football/Archive_122#An_issue_with_templates_and_a_suggestion|this discussion]].

===Customization===
Several things can be customized in these tables

====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'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL

|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}

|winpoints=2
|drawpoints=1
|losspoints=-0.1
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL

|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}

|winpoints=2
|drawpoints=1
|losspoints=-0.1
}}
|}
As a default a win is worth 3 points, a draw 1 point and a loss 0 points, these values can be overwritten to what you need by {{para|winpoints}}, {{para|drawpoints}} 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)

To order the points column before the played column, use {{para|pts_first|y}}.  To order the percentage column before the played column, use {{para|perc_first|y}}.

====Header options (points for/against and custom other headers)====
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL
|for_against_style=points
|draw_header=<abbr title="Won after extra time or penalties">W+</abbr>
|team_header=Player
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL
|for_against_style=points
|draw_header=<abbr title="Won after extra time or penalties">W+</abbr>
|team_header=Player
}}
|}
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. The wording of the D (draw) column can be adjusted using {{para|draw_header}} and the wording of the Team column can be adjusted using {{para|team_header}}. {{para|for_against_style|none}} removes these columns completely.

The wording of the Grp (group) column can be adjusted using {{para|group_header}} in the same way as the draw header.

====Order of losses and draws====
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL|loss_before_draw=true

|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL|loss_before_draw=true

|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
|}
As a default draws are listed before losses. To list losses first, use {{para|loss_before_draw|true}}.

====Goal ratio/goal average====
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL
|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL
|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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
|}
Using {{para|use_goal_ratio|yes}} use goal ratio instead of goal differential.  To change the heading to goal average, use {{para|use_goal_average|yes}} instead.

====Goal percentage====
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL
|use_goal_percentage=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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL
|use_goal_percentage=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 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3             |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_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=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
|}
Using {{para|use_goal_percentage|yes}} use goal percentage instead of goal differential. 
{{Module:Sports table/styledoc|style_option=WDL}}

== 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'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=WDL
|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 |draw_AAA=0 |loss_AAA=0 |gf_AAA=0 |ga_AAA=0 |status_AAA=CQ <!-- Team A -->
|win_BBB=0 |draw_BBB=0 |loss_BBB=0 |gf_BBB=0 |ga_BBB=0 |status_BBB=C <!-- Team B -->
|win_CCC=0 |draw_CCC=0 |loss_CCC=0 |gf_CCC=0 |ga_CCC=0 |status_CCC=A <!-- Team C -->
|win_DDD=0 |draw_DDD=0 |loss_DDD=0 |gf_DDD=0 |ga_DDD=0 |status_DDD=T <!-- Team D -->
|win_EEE=0 |draw_EEE=0 |loss_EEE=0 |gf_EEE=0 |ga_EEE=0 |status_EEE= <!-- Team E -->
|win_FFF=0 |draw_FFF=0 |loss_FFF=0 |gf_FFF=0 |ga_FFF=0 |status_FFF= <!-- Team F -->
|win_GGG=0 |draw_GGG=0 |loss_GGG=0 |gf_GGG=0 |ga_GGG=0 |status_GGG= <!-- Team G -->
|win_HHH=0 |draw_HHH=0 |loss_HHH=0 |gf_HHH=0 |ga_HHH=0 |status_HHH= <!-- Team H -->
|win_III=0 |draw_III=0 |loss_III=0 |gf_III=0 |ga_III=0 |status_III= <!-- Team I -->
|win_JJJ=0 |draw_JJJ=0 |loss_JJJ=0 |gf_JJJ=0 |ga_JJJ=0 |status_JJJ= <!-- Team J -->
|win_KKK=0 |draw_KKK=0 |loss_KKK=0 |gf_KKK=0 |ga_KKK=0 |status_KKK= <!-- Team K -->
|win_LLL=0 |draw_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 -->
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=WDL
|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 |draw_AAA=0 |loss_AAA=0 |gf_AAA=0 |ga_AAA=0 |status_AAA=CQ
|win_BBB=0 |draw_BBB=0 |loss_BBB=0 |gf_BBB=0 |ga_BBB=0 |status_BBB=Q
|win_CCC=0 |draw_CCC=0 |loss_CCC=0 |gf_CCC=0 |ga_CCC=0 |status_CCC=A
|win_DDD=0 |draw_DDD=0 |loss_DDD=0 |gf_DDD=0 |ga_DDD=0 |status_DDD=T
|win_EEE=0 |draw_EEE=0 |loss_EEE=0 |gf_EEE=0 |ga_EEE=0 |status_EEE=
|win_FFF=0 |draw_FFF=0 |loss_FFF=0 |gf_FFF=0 |ga_FFF=0 |status_FFF=
|win_GGG=0 |draw_GGG=0 |loss_GGG=0 |gf_GGG=0 |ga_GGG=0 |status_GGG=
|win_HHH=0 |draw_HHH=0 |loss_HHH=0 |gf_HHH=0 |ga_HHH=0 |status_HHH=
|win_III=0 |draw_III=0 |loss_III=0 |gf_III=0 |ga_III=0 |status_III=
|win_JJJ=0 |draw_JJJ=0 |loss_JJJ=0 |gf_JJJ=0 |ga_JJJ=0 |status_JJJ=
|win_KKK=0 |draw_KKK=0 |loss_KKK=0 |gf_KKK=0 |ga_KKK=0 |status_KKK=
|win_LLL=0 |draw_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
}}
|}

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Sports modules]]
}}</includeonly>
Description	What you type	What you get
Italic	''Italic text''	Italic text
Bold	'''Bold text'''	Bold text
Bold & italic	'''''Bold & italic text'''''	*Bold & italic text*
Description	What you type	What you get
Reference	Page text.<ref>[https://www.example.org/ Link text], additional text.</ref>	Page text.^[1]
Named reference	Page text.<ref name="test">[https://www.example.org/ Link text]</ref>	Page text.^[2]
Additional use of the same reference	Page text.<ref name="test" />	Page text.^[2]
Display references	<references />	↑ Link text, additional text. ↑ Link text