Moodul:Sporditabel/WL
Mooduli dokumentatsioon- Selle mooduli dokumentatsioon on liidetud lehelt Moodul:Sporditabel/WL/doc (redigeeri | ajalugu).
Mall:Module rating 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 muuda
Basic usage muuda
In it's simplest form only several parameters need to be used to build a table
In article muuda
| What you type | {{#invoke:Sports table|main|style=WL
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
The main command is the {{#invoke:Sports table|main|style=WL}} 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 muuda
| What you type | {{#invoke:Sports table|main|style=WL
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
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 muuda
Several things can be customized in these tables
Hiding played column muuda
Setting |hide_played=yes hides the played column.
Points, wins or percentage muuda
By default teams are ranked by points, which can be adjusted as follows:
| What you type | {{#invoke:Sports table|main|style=WL
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
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 muuda
| What you type | {{#invoke:Sports table|main|style=WL
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
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) muuda
| What you type | {{#invoke:Sports table|main|style=WL
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
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 muuda
| What you type | {{#invoke:Sports table|main|style=WL
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
Using |use_goal_ratio=yes use goal ratio (goal average) instead of goal differential.
Moodul:Sports table/doc/doc
Example usage muuda
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
|
| What it looks like | Skriptitõrge: Moodulit "Sports table" pole. |
-- 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
local show_played = true
local hide_played_val = Args['hide_played'] or 'no'
if yesno(hide_played_val) then show_played = false end
table.insert(t,'{|class="wikitable '..sort_text..'" style="text-align:center;"\n') -- Open table
-- Custom header options
local group_head_text = Args['group_header'] or '<abbr title="Group">Grp</abbr>'
-- What to rank the teams by
local ranking_style = Args['ranking_style'] or 'pts'
local show_points, show_perc = false
ranking_style = string.lower(ranking_style)
if ranking_style=='w' or ranking_style=='win' or ranking_style=='wins' then
-- Based on wins
elseif ranking_style=='perc' or ranking_style=='percentage' or ranking_style=='%' then
-- Based on percentage
show_perc = true
else
-- Based on points
show_points = true
end
-- Use points or frames instead of goals for/against
local for_against_style = Args['for_against_style'] or 'goals'
local fa_letter, fa_word_sing, fa_word_plur
local hide_for_against = false
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=='f' or for_against_style=='frame' or for_against_style=='frames' then
fa_letter = 'F'
fa_word_sing = 'Frame'
fa_word_plur = 'Frames'
elseif for_against_style=='game' or for_against_style=='games' then
fa_letter = 'G'
fa_word_sing = 'Game'
fa_word_plur = 'Games'
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'
elseif for_against_style=='none' then
hide_for_against = true
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
if yesno(use_ratio_val) then do_ratio = true end
-- Use games behind header
local show_GB = Args['show_GB'] or 'no'
local do_GB = false
if yesno(show_GB) then do_GB = 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,28,pos_label) -- Position col
-- Add group header
if full_table and group_col then
tt = p_sub.colhead(tt,28,group_head_text) -- Group col
end
tt = p_sub.colhead(tt,team_width,'Team'..VTE_text) -- Team col
if show_played then
tt = p_sub.colhead(tt,28,'<abbr title="Played">Pld</abbr>') -- Matches played col
end
if full_table then
tt = p_sub.colhead(tt,28,'<abbr title="Won">W</abbr>') -- Win col
tt = p_sub.colhead(tt,28,'<abbr title="Lost">L</abbr>') -- Loss col
if not hide_for_against then
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_plur..' for">'..fa_letter..'F</abbr>') -- For col
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_plur..' against">'..fa_letter..'A</abbr>') -- Against col
if not do_ratio then
tt = p_sub.colhead(tt,28,'<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
end
if show_points then
tt = p_sub.colhead(tt,28,'<abbr title="Points">Pts</abbr>') -- Points col
elseif show_perc then
tt = p_sub.colhead(tt,36,'<abbr title="Win percentage">PCT</abbr>') -- Percentage col
end
if full_table then
if do_GB then -- Games behind header
tt = p_sub.colhead(tt,28,'<abbr title="Games behind">GB</abbr>')
end
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 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 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
local points = win_points*wins + loss_points*losses + s_pts
local win_perc = mm._precision_format(wins / matches, 3)
if matches == 0 then
-- Escape for zero matches
win_perc = '—'
elseif losses > 0 then
-- Drop the leading zero (from the string)
win_perc = string.sub(win_perc,2,string.len(win_perc))
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
-- What to rank the teams by
local ranking_style = Args['ranking_style'] or 'pts'
local rank_points, rank_perc = false
local win_fw, win_string
ranking_style = string.lower(ranking_style)
if ranking_style=='w' or ranking_style=='win' or ranking_style=='wins' then
-- Based on wins
win_fw = 'font-weight: bold;'
win_string = hth_string
elseif ranking_style=='perc' or ranking_style=='percentage' or ranking_style=='%' then
-- Based on percentage
rank_perc = true
win_fw=ii_fw
win_string = ''
else
-- Based on points
rank_points = true
win_fw=ii_fw
win_string = ''
end
-- Show games played
local show_played = true
local hide_played_val = Args['hide_played'] or 'no'
if yesno(hide_played_val) then show_played = false end
-- Show for/against
local for_against_style = Args['for_against_style'] or 'goals'
local hide_for_against = false
for_against_style = string.lower(for_against_style)
if for_against_style=='none' then
hide_for_against = true
end
-- Comparison of for and 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
-- Show games behind
local show_GB = Args['show_GB'] or 'no'
local do_GB = false
local GB_text = '—'
if yesno(show_GB) then
do_GB = true
local GB_team_no = tonumber(Args['GB_team']) or 1
if ii == GB_team_no then
-- Do nothing, it's vs this team
else
local wins_GB = tonumber(Args['win_'..team_list[GB_team_no]]) or 0
local losses_GB = tonumber(Args['loss_'..team_list[GB_team_no]]) or 0
local GB_num = (wins_GB-wins+losses-losses_GB)/2
-- Display options
if GB_num >0 then
-- Indicates trailing GB_team
GB_text = GB_num
elseif GB_num == 0 then
-- Equal, do nothing to get dash
else
-- Ahead of GB team, should be noted by plus (instead of minus that comes from formula)
GB_text = '+'..-GB_num
end
end
end
-- Row building
if show_played then
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..matches..'\n') -- Played
end
if full_table then
table.insert(t,'| style="'..win_fw..bg_col..'" |'..wins..win_string..'\n') -- Won
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..losses..'\n') -- Lost
if not hide_for_against then
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
end
if rank_points then
-- Add − for negative point totals
if points<0 then
table.insert(t,'| style="font-weight: bold;'..bg_col..'" | −'..-points..hth_string..'\n')
else
table.insert(t,'| style="font-weight: bold;'..bg_col..'" | '..points..hth_string..'\n')
end
elseif rank_perc then
table.insert(t,'| style="font-weight: bold;'..bg_col..'" | '..win_perc..hth_string..'\n')
end
if do_GB then
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..GB_text..'\n') -- GB
end
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 = { A='Advances to a further round', C='Champion', D='Disqualified',
E='Eliminated', H='Host', O='Play-off winner', P='Promoted', Q='Qualified to the phase indicated',
R='Relegated', T='Qualified, but not yet to the particular phase indicated',
X='?', Y='?', Z='?'}
status_called = { A=false, C=false, D=false, E=false, H=false, O=false, P=false,
Q=false, R=false, T=false, X=false, Y=false, Z=false}
local status_letters = 'ACDEHOPQRTXYZ'
-- Status position (before or after read and default)
local stat_pos_val = Args['status_pos'] or ''
local status_position = 'after' -- 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
-- Read in custom status options
if Args['status_text_X'] then status_code.X = Args['status_text_X'] end
if Args['status_text_Y'] then status_code.Y = Args['status_text_Y'] end
if Args['status_text_Z'] then status_code.Z = Args['status_text_Z'] end
return {code=status_code, called=status_called, letters=status_letters, position=status_position}
end
return pp