Module:Sports color

Module documentationview edit history purge

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

This module is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.

This Lua module is used on approximately 79,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module is used by

{{Basketball color}}, {{Basketball color cell}}, {{Basketball color cell2}}

{{Baseball primary style}}, {{Baseball secondary style}}

{{Infobox MLB}}, {{Infobox baseball biography}}

{{Handball color}}, {{Handball color cell}}, {{Handball color cell2}}

Usage

{{#invoke:Sports color|color}} in any of the various color templates
{{#invoke:Sports color|colorcell}} in any of the various color cell templates
{{#invoke:Sports color|colorcell2}} in any of the various color cell2 templates
{{#invoke:Sports color|check}} to check to see if a team has defined colors

Updating team colors

See:

Check

{{#invoke:Sports color|check}} to check to see if a team has defined colors

The above documentation is transcluded from Module:Sports color/doc.
Editors can experiment in this module's sandbox and testcases pages.
Subpages of this module.

--
-- This module implements
-- {{tl|Basketball color}}, {{tl|Basketball color cell}}, {{tl|Basketball color cell2}}
-- {{tl|Infobox basketball biography/style}}
-- {{tl|Baseball color}}
-- {{tl|Baseball primary style}}, {{tl|Baseball secondary style}}
-- {{tl|Infobox MLB}}, {{tl|Infobox baseball biography}}
-- {{tl|Navbox ice hockey}}
-- {{tl|Handball color}}, {{tl|Handball color cell}}, {{tl|Handball color cell2}}
-- {{tl|Esports color}}
--
local p = {}

local data_module = 'Module:Sports color/basketball'

local function stripwhitespace(text)
	return text:match("^%s*(.-)%s*$")
end

local function bordercss(c, w)
	local s = 'inset ' .. w .. 'px ' .. w .. 'px 0 #' .. c 
		.. ', inset -' .. w .. 'px -' .. w .. 'px 0 #' .. c
	return 'box-shadow: ' .. s .. ';'
end

local function get_colors(team, unknown)
	team = stripwhitespace(team or '')
	unknown = unknown or {"DCDCDC", "000000", "000000", "FFFFFF"}
	
	local use_default = {
		[""] = 1,
		["retired"] = 1,
		["free agent"] = 1,
	}
	
	local colors = nil
	
	if ( team and use_default[team:lower()] ) then
		colors = {"DCDCDC", "000000", "DCDCDC", "000000"}
	else
		local all_colors = mw.loadData(data_module)
		colors = all_colors[team]
		if ( colors and type(colors) == 'string' ) then
			colors = all_colors[colors]
		end
	end

	return colors or unknown
end

local function team_check(team, unknown)
	local colors = get_colors(team, unknown)
	if type(colors) == 'table' then
		return 'known'
	else
		return unknown
	end
end

local function team_color(team, num)
	local colors = get_colors(team, nil)

	num = tonumber(num:match('[1-4]') or '0')
	if ( num ) then
		return colors[num]
	else
		return ''
	end
end

local function team_colorcell(team, borderwidth, bg, fg, bd, simple)
	local colors = get_colors(team, nil)
	local border = ''
	borderwidth = borderwidth or ''
	
	if (borderwidth ~= '') then
		local bordercolor = stripwhitespace(colors[bd]) or 'FFFFFF'
		if bordercolor ~= 'FFFFFF' then
			if simple then
				border = 'border: ' .. borderwidth .. 'px solid #' .. bordercolor .. ' !important;'
			else
                border = bordercss(bordercolor, borderwidth)
                border = border .. ' !important;'
			end
		end
	end
	
	return 'background-color: #' .. stripwhitespace(colors[bg]) .. ' !important; ' .. 'color: #' .. stripwhitespace(colors[fg]) .. ' !important; ' .. border
end

local function team_titlestripe(team, topc, botc, borderwidth)
	local colors = get_colors(team, nil)
	local border = ''
	borderwidth = borderwidth or ''

	if (borderwidth ~= '') then
		local bordercolor = stripwhitespace(colors[topc]) or 'FFFFFF'
		if bordercolor ~= 'FFFFFF' then
			border = border .. 'border-top: ' .. borderwidth .. 'px solid #' .. bordercolor .. ';'
		end
		bordercolor = stripwhitespace(colors[botc]) or bordercolor
		if bordercolor ~= 'FFFFFF' then
			border = border .. 'border-bottom: ' .. borderwidth .. 'px solid #' .. bordercolor .. ';'
		end
	end

	return 'background-color: #FFFFFF; ' .. border
end

local function team_cellborder(team, pri, sec, ter, borderwidth, simple)
	local colors = get_colors(team, nil)
	local border = ''
	borderwidth = borderwidth or ''

	if (borderwidth ~= '') then
		local bordercolor = stripwhitespace(colors[pri] or colors[sec] or colors[ter]) or 'FFFFFF'
		if bordercolor ~= 'FFFFFF' then
			if simple then
				border = 'border: ' .. borderwidth .. 'px solid #' .. bordercolor .. ';'
			else
				border = bordercss(bordercolor, borderwidth)
			end
		end
	end

	return 'background-color: #FFFFFF; ' .. border
end

function p.check(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	return team_check(args[1] or '', args[2] or '')
end

function p.color(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	return team_color(args[1] or '', args[2] or '')
end

function p.colorcell(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	return team_colorcell(args[1] or '', args['border'] or '', 1, 2, 3, args['simple'] and 1 or nil )
end

function p.colorcell2(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	return team_colorcell(args[1] or '', args['border'] or '', 3, 4, 1, args['simple'] and 1 or nil )
end

function p.titlestripe(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'ice hockey')
	return team_titlestripe(args[1] or '', 1, 3, args['width'] or '5')
end

function p.cellborder(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'ice hockey')
	return team_cellborder(args[1] or '', 3, 1, 4, args['width'] or '2', args['simple'] and 1 or nil )
end

function p.cellborder2(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'ice hockey')
	return team_cellborder(args[1] or '', 4, 3, 1, args['width'] or '2', args['simple'] and 1 or nil )
end

-- Historical color support for basketball (and other sports with sub-tables)
local function get_historical (all_colors, team, year)
	if not year or year == '' then return nil end
	local entry = all_colors[team]
	if type(entry) == 'string' then entry = all_colors[entry] end
	if type(entry) ~= 'table' then return nil end
	local hist = entry[6]
	if type(hist) ~= 'table' then return nil end
	for k, v in pairs(hist) do
		if k:find(year, 1, true) or k == year then
			if type(v) == 'string' then v = all_colors[v] end
			return v
		end
	end
	return nil
end

local old_get_colors = get_colors
get_colors = function(team, unknown, year)
	local colors = old_get_colors(team, unknown)
	if year and year ~= '' then
		local all_colors = mw.loadData(data_module)
		local hist = get_historical(all_colors, team, year)
		if hist then colors = hist end
	end
	return colors
end

function p.primary(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	local colors = get_colors(args[1] or '', nil, args.year or args['year'])
	return colors and colors[1] or ''
end

function p.secondary(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	local colors = get_colors(args[1] or '', nil, args.year or args['year'])
	return colors and colors[2] or ''
end

function p.tertiary(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	local colors = get_colors(args[1] or '', nil, args.year or args['year'])
	return colors and colors[3] or ''
end

function p.accent(frame)
	local args = (frame.args[1] ~= nil) and frame.args or frame:getParent().args
	data_module = 'Module:Sports color/' .. (frame.args['sport'] or frame:getParent().args['sport'] or 'basketball')
	local colors = get_colors(args[1] or '', nil, args.year or args['year'])
	return colors and colors[4] or ''
end

return p

v t e Sports color templates
College	{{GotCollegeColorsFor}} {{CollegePrimaryColorLink}} {{CollegePrimaryHeader}} {{CollegePrimaryHex}} {{CollegePrimaryStyle}} {{CollegeSecondaryColorLink}} {{CollegeSecondaryHeader}} {{CollegeSecondaryHex}} {{CollegeSecondaryStyle}} {{College color boxes}} {{College color cell and link}} {{College color list}} {{College stripe style}} {{NCAA color}} {{NCAA color cell}} {{NCAA secondary color cell}}
Baseball	{{Baseball color}} {{Baseball primary link}} {{Baseball primary style}} {{Baseball secondary link}} {{Baseball secondary style}}
Basketball	{{Basketball color}} {{Basketball color cell}} {{Basketball color cell2}} {{Basketball primary style}} {{Basketball secondary style}}
Gridiron	{{Gridiron primary color}} {{Gridiron primary style}} {{Gridiron alt primary color}} {{Gridiron alt primary style}} {{Gridiron alt secondary color}} {{Gridiron secondary color}}
Handball	{{Handball color}} {{Handball color cell}} {{Handball color cell2}}
UniSport	{{UniSport color}} {{UniSport color cell}} {{UniSport color cell2}}
Volleyball	{{Volleyball color cell}} {{Volleyball color cell2}}
Misc	{{Esports color}} {{Netball colours}} {{Track and field color}}
Modules	Module:College color contrast data Module:Gridiron color contrast data Module:Sports color contrast baseball basketball esports handball ice hockey international football unisport volleyball