View source for Module:Sports table/Volleyball/doc

{{Module rating |release}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This style for Lua-based [[Module:Sports table]] is meant to build group and league tables for competitions with a volleyball 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
{| class="wikitable" style="background:white;"
|+ Big/small win/loss input style
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|</nowiki>style=Volleyball<br>

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

|bwin_FDT=4 |swin_FDT=1 |sloss_FDT=0 |bloss_FDT=0 |sw_FDT=15 |sl_FDT=3  |spw_FDT=423 |spl_FDT=210
|bwin_BBB=3 |swin_BBB=0 |sloss_BBB=1 |bloss_BBB=0 |sw_BBB=9  |sl_BBB=4  |spw_BBB=377 |spl_BBB=251
|bwin_CCC=1 |swin_CCC=2 |sloss_CCC=0 |bloss_CCC=2 |sw_CCC=9  |sl_CCC=5  |spw_CCC=301 |spl_CCC=287
|bwin_DDD=1 |swin_DDD=0 |sloss_DDD=0 |bloss_DDD=3 |sw_DDD=3  |sl_DDD=9  |spw_DDD=222 |spl_DDD=327
|bwin_EEE=0 |swin_EEE=0 |sloss_EEE=2 |bloss_EEE=3 |sw_EEE=0  |sl_EEE=15 |spw_EEE=151 |spl_EEE=399

|name_FDT=[[Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{vb|AUS}}
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=Volleyball

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

|bwin_FDT=4 |swin_FDT=1 |sloss_FDT=0 |bloss_FDT=0 |sw_FDT=15 |sl_FDT=3  |spw_FDT=423 |spl_FDT=210
|bwin_BBB=3 |swin_BBB=0 |sloss_BBB=1 |bloss_BBB=0 |sw_BBB=9  |sl_BBB=4  |spw_BBB=377 |spl_BBB=251
|bwin_CCC=1 |swin_CCC=2 |sloss_CCC=0 |bloss_CCC=2 |sw_CCC=9  |sl_CCC=5  |spw_CCC=301 |spl_CCC=287
|bwin_DDD=1 |swin_DDD=0 |sloss_DDD=0 |bloss_DDD=3 |sw_DDD=3  |sl_DDD=9  |spw_DDD=222 |spl_DDD=327
|bwin_EEE=0 |swin_EEE=0 |sloss_EEE=2 |bloss_EEE=3 |sw_EEE=0  |sl_EEE=15 |spw_EEE=151 |spl_EEE=399

|name_FDT=[[Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{vb|AUS}}
}}
|}
{| class="wikitable" style="background:white;"
|+ 345 set win/loss input style
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|style=Volleyball
|team1=FDT|team2=BBB|team3=CCC|team4=DDD

|win3s_FDT=3 |win4s_FDT=0 |win5s_FDT=0 |loss5s_FDT=0 |loss4s_FDT=0 |loss3s_FDT=0 |spw_FDT=225 |spl_FDT=158 
|win3s_BBB=0 |win4s_BBB=1 |win5s_BBB=1 |loss5s_BBB=0 |loss4s_BBB=0 |loss3s_BBB=1 |spw_BBB=256 |spl_BBB=269 
|win3s_CCC=0 |win4s_CCC=1 |win5s_CCC=0 |loss5s_CCC=0 |loss4s_CCC=1 |loss3s_CCC=1 |spw_CCC=243 |spl_CCC=254 
|win3s_DDD=0 |win4s_DDD=0 |win5s_DDD=0 |loss5s_DDD=1 |loss4s_DDD=1 |loss3s_DDD=1 |spw_DDD=233 |spl_DDD=276 

|name_FDT=[[Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD={{vb|AUS}}

|col_A=#ccffcc|result1=A|result2=A
|col_E=#ffcccc|result3=E|result4=E
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=Volleyball
|team1=FDT|team2=BBB|team3=CCC|team4=DDD

|win3s_FDT=3 |win4s_FDT=0 |win5s_FDT=0 |loss5s_FDT=0 |loss4s_FDT=0 |loss3s_FDT=0 |spw_FDT=225 |spl_FDT=158 
|win3s_BBB=0 |win4s_BBB=1 |win5s_BBB=1 |loss5s_BBB=0 |loss4s_BBB=0 |loss3s_BBB=1 |spw_BBB=256 |spl_BBB=269 
|win3s_CCC=0 |win4s_CCC=1 |win5s_CCC=0 |loss5s_CCC=0 |loss4s_CCC=1 |loss3s_CCC=1 |spw_CCC=243 |spl_CCC=254 
|win3s_DDD=0 |win4s_DDD=0 |win5s_DDD=0 |loss5s_DDD=1 |loss4s_DDD=1 |loss3s_DDD=1 |spw_DDD=233 |spl_DDD=276 

|name_FDT=[[Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD={{vb|AUS}}

|col_A=#ccffcc|result1=A|result2=A
|col_E=#ffcccc|result3=E|result4=E
}}
|}
The main command is the <nowiki>{{#invoke:Sports table|main|style=Volleyball}}</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 big wins small wins, small losses, big losses, sets won, sets lost, setpoints won and setpoints lost by using {{para|bwin_TTT}}, {{para|swin_TTT}}, {{para|sloss_TTT}}, {{para|bloss_TTT}}, {{para|sw_TTT}}, {{para|sl_TTT}}, {{para|spw_TTT}} and {{para|spl_TTT}} respectively (with TTT replaced by the team code). Alternatively, you can define {{para|win3s_TTT}}, {{para|win4s_TTT}},  {{para|win5s_TTT}}, {{para|loss5s_TTT}}, {{para|loss4s_TTT}}, {{para|loss3s_TTT}} for 3-set-wins, 4-set-wins, 5-set-wins, 5-set-losses, 4-set-losses, and 3-set-losses.  Note that, <code>win5s</code> is the same as "small wins" and <code>win4s</code>/<code>win3s</code> are the same as "big wins".  You should not use both the <code>bwin</code> and <code>win4s</code>/<code>win3s</code> syntax simultaneously. If you do not define any of these numbers, they are 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.

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

====Hiding played column====
Setting {{para|hide_played|yes}} hides the played column.
====Hiding the sets columns====
Setting {{para|show_sets|no}} hides the sets columns.
====Hiding the setpoints columns====
Setting {{para|show_setpoints|no}} hides the setpoints columns.
====Showing the setpoints columns first====
Setting {{para|setpoints_before_sets|yes}} moves the setpoints columns before the sets colums.
====Wins or points====
By default teams are ranked by wins, but also list points which can be adjusted as follows:
{| class="wikitable" style="background:white;"
|-
|'''What you type'''
|<syntaxhighlight lang=moin>{{#invoke:Sports table|main|</nowiki>style=Volleyball<br>
|ranking_style=points

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

|bwin_FDT=4 |swin_FDT=1 |sloss_FDT=0 |bloss_FDT=0 |sw_FDT=15 |sl_FDT=3  |spw_FDT=423 |spl_FDT=210
|bwin_BBB=3 |swin_BBB=0 |sloss_BBB=1 |bloss_BBB=0 |sw_BBB=9  |sl_BBB=4  |spw_BBB=377 |spl_BBB=251
|bwin_CCC=1 |swin_CCC=2 |sloss_CCC=0 |bloss_CCC=2 |sw_CCC=9  |sl_CCC=5  |spw_CCC=301 |spl_CCC=287
|bwin_DDD=1 |swin_DDD=0 |sloss_DDD=0 |bloss_DDD=3 |sw_DDD=3  |sl_DDD=9  |spw_DDD=222 |spl_DDD=327
|bwin_EEE=0 |swin_EEE=0 |sloss_EEE=2 |bloss_EEE=3 |sw_EEE=0  |sl_EEE=15 |spw_EEE=151 |spl_EEE=399

|adjust_points_FDT=1.5
|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}}

|bwinpoints=5
|swinpoints=1.5
|slosspoints=-0.1
|blosspoints=-0.8
}}</syntaxhighlight>
|-
|'''What it looks like'''
|{{#invoke:Sports table|main|style=Volleyball
|ranking_style=points

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

|bwin_FDT=4 |swin_FDT=1 |sloss_FDT=0 |bloss_FDT=0 |sw_FDT=15 |sl_FDT=3  |spw_FDT=423 |spl_FDT=210
|bwin_BBB=3 |swin_BBB=0 |sloss_BBB=1 |bloss_BBB=0 |sw_BBB=9  |sl_BBB=4  |spw_BBB=377 |spl_BBB=251
|bwin_CCC=1 |swin_CCC=2 |sloss_CCC=0 |bloss_CCC=2 |sw_CCC=9  |sl_CCC=5  |spw_CCC=301 |spl_CCC=287
|bwin_DDD=1 |swin_DDD=0 |sloss_DDD=0 |bloss_DDD=3 |sw_DDD=3  |sl_DDD=9  |spw_DDD=222 |spl_DDD=327
|bwin_EEE=0 |swin_EEE=0 |sloss_EEE=2 |bloss_EEE=3 |sw_EEE=0  |sl_EEE=15 |spw_EEE=151 |spl_EEE=399

|adjust_points_FDT=1.5
|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}}

|bwinpoints=5
|swinpoints=1.5
|slosspoints=-0.1
|blosspoints=-0.8
}}
|}
As a default a big win is worth 3 points, a small win 2 points, a small loss 1 point and a big loss 0 points, these values can be overwritten to what you need by {{para|bwinpoints}}, {{para|swinpoints}}, {{para|slosspoints}} and {{para|blosspoints}}. 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 points (set {{para|ranking_style|points}} to bold that row instead)
{{Module:Sports table/styledoc|style_option=Volleyball}}

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