وحدة:Sports table/WL OTL tiebreak
 | 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-overtime loss with an additional tiebreaker 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 OTL tiebreak style in an article or template, check the table of contents for specific items.
Usage
Basic usage
In it's simplest form only several parameters need to be used to build a table
In article
| What you type | {{#invoke:Sports table|main|style=WL OTL tiebreak
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
تم تحديثها حتى المباريات التي لعبت في unknown. مصدر: [بحاجة لمصدر]
|
The main command is the {{#invoke:Sports table|main|style=WL OTL tiebreak}} 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, OT losses, tiebreaker values, goals for and goals against by using |win_TTT=, |loss_TTT=, |OTloss_TTT=, |tiebr_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=WL OTL tiebreak
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
تم تحديثها حتى المباريات التي لعبت في unknown. مصدر: [بحاجة لمصدر]
|
The markup is effectively the same, you only add two lines. The line |showteam={{{showteam}}}, is needed to forward the showteam parameter from a template call (see #Team highlighting and partial table); the |only_pld_pts={{{only_pld_pts}}} is needed to forward truncated tables, (see #Appearance); the |show_matches={{{show_matches}}} is needed to forward match result visibility, see #Matches. The |template_name= with the actual name of the Template-page, creates the V, T and E buttons that link to the template page (so you can easily reach it from any article it is included in).
Customization
Several things can be customized in these tables
Points
| What you type | {{#invoke:Sports table|main|style=WL OTL tiebreak
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
تم تحديثها حتى المباريات التي لعبت في unknown. مصدر: [بحاجة لمصدر]
|
As a default a win is worth 2 points, an OT loss 1 point and a loss 0 points, these values can be overwritten to what you need by |winpoints=, |OTlosspoints= 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.
Header options (points for/against and custom other headers)
| What you type | {{#invoke:Sports table|main|style=WL OTL tiebreak
| |||||||||||
| What it looks like |
تم تحديثها حتى المباريات التي لعبت في unknown. مصدر: [بحاجة لمصدر]
|
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. The wording of the Pld, OTL and TBR columns can be adjusted using |pld_header=, |OTloss_header= and|tiebr_header=.
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=WL OTL tiebreak
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
تم تحديثها حتى المباريات التي لعبت في unknown. مصدر: [بحاجة لمصدر]
|
Using |use_goal_ratio=yes use goal ratio (goal average) instead of goal differential.
وحدة:Sports table/شرح/doc
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=WL OTL tiebreak
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
تم تحديثها حتى المباريات التي لعبت في future. مصدر: Unknown
قواعد التصنيف: 1) Points; 2) Goal difference; 3) Number of goals scored; |
-- Style for football tables
local pp = {}
function pp.header(t,Args,p_sub,pos_label,group_col,VTE_text,full_table,results_header_txt)
-- Load relevant modules
local yesno = require('Module:Yesno')
-- Create table header
-- Pre stuff
local team_width = Args['teamwidth'] or '190'
local sort_text = ''
local sort_table_val = Args['sortable_table'] or 'no'
if yesno(sort_table_val) then sort_text = 'sortable' end
table.insert(t,'{|class="wikitable '..sort_text..'" style="text-align:center;"\n') -- Open table
-- Custom header options
-- Table header
local table_header = Args['table_header']
if table_header then
table.insert(t,'|+'..table_header..'\n')
end
--Column headers
local pld_head_text = Args['pld_header'] or '<abbr title="Played">Pld</abbr>'
local OTloss_head_text = Args['OTloss_header'] or '<abbr title="Lost in overtime">OTL</abbr>'
local tiebr_head_text = Args['tiebr_header'] or '<abbr title="Tiebreaker">TBR</abbr>'
local group_head_text = Args['group_header'] or '<abbr title="Group">Grp</abbr>'
-- Use points instead of goals for/against
local for_against_style = Args['for_against_style'] or 'goals'
local fa_letter, fa_word_sing, fa_word_plur
-- First convert to lower case if it is a string
for_against_style = string.lower(for_against_style)
if for_against_style=='g' or for_against_style=='goal' or for_against_style=='goals' then
fa_letter = 'G'
fa_word_sing = 'Goal'
fa_word_plur = 'Goals'
elseif for_against_style=='p' or for_against_style=='point' or for_against_style=='points' then
fa_letter = 'P'
fa_word_sing = 'Point'
fa_word_plur = 'Points'
else
fa_letter = 'G'
fa_word_sing = 'Goal'
fa_word_plur = 'Goals'
end
-- Whether to use goal ratio (goal average) instead
local use_ratio_val = Args['use_goal_ratio'] or 'no'
local do_ratio = false
-- True if exist, false otherwise
if yesno(use_ratio_val) then do_ratio = true end
-- Initialize
local tt = {}
tt.count = 0 -- Up by one after every call
tt.tab_text = t -- Actual text
-- Actual headers
tt = p_sub.colhead(tt,32,pos_label) -- Position col
-- Add group header
if full_table and group_col then
tt = p_sub.colhead(tt,32,group_head_text) -- Group/division col
end
tt = p_sub.colhead(tt,team_width,'Team'..VTE_text) -- Team col
tt = p_sub.colhead(tt,32,pld_head_text) -- Matches played col
if full_table then
tt = p_sub.colhead(tt,32,'<abbr title="Won">W</abbr>') -- Win col
tt = p_sub.colhead(tt,32,'<abbr title="Lost">L</abbr>') -- Loss col
tt = p_sub.colhead(tt,32,OTloss_head_text)
tt = p_sub.colhead(tt,32,tiebr_head_text)
tt = p_sub.colhead(tt,32,'<abbr title="'..fa_word_plur..' for">'..fa_letter..'F</abbr>') -- For col
tt = p_sub.colhead(tt,32,'<abbr title="'..fa_word_plur..' against">'..fa_letter..'A</abbr>') -- Against col
if not do_ratio then
tt = p_sub.colhead(tt,32,'<abbr title="'..fa_word_sing..' difference">'..fa_letter..'D</abbr>') -- Difference col
else
tt = p_sub.colhead(tt,36,'<abbr title="'..fa_word_sing..' ratio">'..fa_letter..'R</abbr>') -- Ratio col
end
end
tt = p_sub.colhead(tt,32,'<abbr title="Points">Pts</abbr>') -- Points col
if full_table then
tt.count = tt.count+1
table.insert(tt.tab_text,results_header_txt)
end
return tt
end
function pp.row(frame,t,Args,p_sub,notes_exist,hth_id_list,full_table,rand_val,team_list,team_code_ii,ii_start,ii_end,ii_fw,bg_col,N_teams,ii,ii_show)
-- Build the inner parts of individual rows
-- Sub-module usage
local mm = require('Module:Math')
local yesno = require('Module:Yesno')
-- Get custom/default options for in table
local win_points = tonumber(Args['winpoints']) or 2
local loss_points = tonumber(Args['losspoints']) or 0
local OTloss_points = tonumber(Args['OTlosspoints']) or 1
-- Get some input
local wins = tonumber(Args['win_'..team_code_ii]) or 0
local losses = tonumber(Args['loss_'..team_code_ii]) or 0
local OTlosses = tonumber(Args['OTloss_'..team_code_ii]) or 0
local tiebr_val = tonumber(Args['tiebr_'..team_code_ii]) or 0
local gfor = tonumber(Args['gf_'..team_code_ii]) or tonumber(Args['pf_'..team_code_ii]) or 0
local gaig = tonumber(Args['ga_'..team_code_ii]) or tonumber(Args['pa_'..team_code_ii]) or 0
local s_pts = tonumber(Args['adjust_points_'..team_code_ii]) or tonumber(Args['startpoints_'..team_code_ii]) or 0
local hth_local = Args['hth_'..team_code_ii] or nil
-- Then calculate some values
local matches = wins + losses + OTlosses
local points = win_points*wins + loss_points*losses + OTloss_points*OTlosses + s_pts
-- Comparison of for against
local gcomp
-- Whether to use goal ratio (goal average) instead
local use_ratio_val = Args['use_goal_ratio'] or 'no'
local skip_sign
if yesno(use_ratio_val) then
-- Now it is the goal ratio/goal average
if gaig == 0 then
gcomp = '—'
else
gcomp = mm._precision_format(gfor / gaig, 3)
end
else
-- It's goal difference
gcomp = gfor - gaig
-- Formatting with signs
if gcomp>0 then
gcomp='+'..gcomp
elseif gcomp < 0 then
gcomp='−'..-gcomp
end
end
-- Some local vars
local hth_string
local tt_return = p_sub.hth(frame,Args,full_table,hth_id_list,hth_local,notes_exist,team_list,team_code_ii,ii_start,ii_end,rand_val)
hth_string = tt_return.str
hth_id_list = tt_return.list
notes_exist = tt_return.notes_exist
-- Row building
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..matches..'\n') -- Played
if full_table then
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..wins..'\n') -- Won
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..losses..'\n') -- Lost
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..OTlosses..'\n') -- Lost in OT
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..tiebr_val..'\n') -- Tiebreaker value
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..gfor..'\n') -- GF
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..gaig..'\n') -- GA
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..gcomp..'\n') -- Goal comparison
end
-- Add − for negative point totals
table.insert(t,'| style="font-weight: bold;'..bg_col..'" | ')
if points<0 then
table.insert(t,'−'..-points..hth_string)
else
table.insert(t,points..hth_string)
end
table.insert(t,'\n')
return {t=t, notes_exist=notes_exist, hth_id_list=hth_id_list}
end
function pp.status(Args)
-- Declare status options
-- ------------------------------------------------------------
-- NOTE: If you add to status_code, also add to status_called and status_letters!!
-- Or functionality will be compromised
-- ------------------------------------------------------------
local status_code, status_called = {}
status_code = { E='Eliminated from playoff contention', P='Clinched Presidents Trophy',
X='Clinched playoff spot', Y='Clinched division', Z='Clinched conference'}
status_called = {E=false, P=false, X=false, Y=false, Z=false}
local status_letters = 'EPXYZ'
-- Status position (before or after read and default)
local stat_pos_val = Args['status_pos'] or ''
local status_position = 'before' -- Default location
stat_pos_val = string.lower(stat_pos_val)
if stat_pos_val=='before' then
status_position = 'before'
elseif stat_pos_val=='after' then
status_position = 'after'
end
return {code=status_code, called=status_called, letters=status_letters, position=status_position}
end
return pp