MODULE:GRIDIRON COLOR SANDBOX

This is the module sandbox page for Module:Gridiron color ( diff).

Module documentation[ view] [ ] [ history] [ purge]

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This Lua module is used on approximately 37,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 depends on the following other modules:

Implements:

Uses color data from Module:Gridiron color/data.

Usage

Debugging

Displays entire row from Module:Gridiron color/data for team and year passed in template call or using |team= and |year= (if omitted from invoke, module will take values from the template call):

{{#invoke:Gridiron color|test|team=team name (optional)|year=#### (optional)}}

["Buffalo Bills"] = {{ "#00274D", #FFFFFF", #C60C30", #C60C30", #FFFFFF"}}

Return team color

Returns either raw color value or prefixed color value. |column= uses the following values:

Primary color (background)
Secondary color (text)
Tertiary color (border)
Alternative primary color
Alternative secondary color

Set |raw=true to display raw hex values. Team name and year passed in template call or specified using |team= and |year=:

{{#invoke:Gridiron color|color|column=#|raw=true (optional)|team=team name (optional)|year=#### (optional)}}

background: #00274D

Return team style

Returns complete CSS style for given team. A border will be displayed using the tertiary color if |border= is set to "true" (in which case the border will be 2px wide) or to a positive integer value (in which case the width will be the value specified in pixels). Team name and year passed in template call or specified using |team= and |year=:

{{#invoke:Gridiron color|style|border=# or yes (optional)|team=team name (optional)|year=#### (optional)}}

background: #00274D; color: #FFFFFF; box-shadow: inset 2px 2px 0 #C60C30, inset -2px -2px 0 #C60C30;

The above documentation is transcluded from Module:Gridiron color/doc.
Editors can experiment in this module's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this module.


--

-- This module implements

-- {{Gridiron primary color}} -- {{Gridiron primary color raw}} -- {{Gridiron primary style}}

-- {{Gridiron secondary color}} -- {{Gridiron secondary color raw}}

-- {{Gridiron tertiary color raw}}

-- {{Gridiron alt primary color}} -- {{Gridiron alt primary style}} -- {{Gridiron alt secondary color}}

--



local p = {}



local color_data = mw.loadData("Module:Gridiron color/data/sandbox")



local yesno = require('Module:Yesno')



local prefixes = {

	"background: ",

	"color: ",

	"/**/",

	"background: ",

	"color: "

	}

	

local default = {"#DCDCDC", "#000000", "none", "", ""}



local function get_year(colors, year)

	if colors and colors6 and type(colors6 == 'table') then

		for team, year_colors in pairs(colors6]) do

			if mw.ustring.find(team, "%d%d%d%dthru%d%d%d%d$") then

				local start_year, end_year = mw.ustring.match(team, "(%d%d%d%d)thru(%d%d%d%d)$")

				if (tonumber(start_year) <= tonumber(year)) and (tonumber(year) <= tonumber(end_year)) then

					return year_colors

				end

			end

		end

	end

	

	return colors

end



local function get_colors(team, unknown, year)

	team = (team or ''):match("^%s*(.-)%s*$")

	year = tonumber(year)

	unknown = unknown or color_data"#default" or default

	

	local use_default = {

		"" = 1,

		"retired" = 1,

		"free agent" = 1,

	}

	

	local colors = nil

	

	if ( team and use_defaultteam:lower()] ) then

		colors = unknown

	else

		if mw.ustring.find(team, "%d?%d?%d%dthru%d?%d?%d%d$") then

			if (not year or year <= 0) then

				team, year = mw.ustring.match(team, "^(.-) -(%d?%d?%d%d)thru%d?%d?%d%d$")

				team, year = team:match("^%s*(.-)%s*$"), tonumber(year)

				

				if year >= 20 and year < 100 then -- Two-digit years were deprecated in 2018

					year = year + 1900

				elseif year < 20 then

					year = year + 2000

				elseif year < 1000 then

					year = nil

				end

			else

				team = mw.ustring.match(team, "^(.-) -%d?%d?%d%dthru%d?%d?%d%d$") or team

			end

		end

		

		if year and year > 0 then

			--code for handling year parameter

			colors = get_year(color_datateam], year)

		else

			colors = color_datateam

		end

		

		if ( colors and type(colors) == 'string') then

			if team == colors then year = nil end

			-- follow alias recursively

			return  get_colors (colors, unknown, year)

		end

	end

	

	return colors or unknown

end



local function bordercss(c, w)

	if w > 0 then

		local s = 'inset ' .. w .. 'px ' .. w .. 'px 0 ' .. c 

			.. ', inset -' .. w .. 'px -' .. w .. 'px 0 ' .. c

		return 'box-shadow: ' .. s .. ';'

	else

		return ''

	end

end



local function contrast_check(background, text, colors, alt)

	local c_limit = 4.5

	local contrast = require('Module:Color_contrast')

	if contrast._ratio({[1 = text, 2 = background, 'error' = 0}) < c_limit then

		if contrast._ratio({[1 = '#FFFFFF', 2 = background, 'error' = 0}) >= c_limit then

			text = '#FFFFFF'

		elseif contrast._ratio({[1 = '#000000', 2 = background, 'error' = 0}) >= c_limit then

			text = '#000000'

		elseif (not alt) and (contrast._ratio({[1 = colors5], 2 = colors4], 'error' = 0}) >= c_limit) then

			background, text = colors4], colors5

		else

			background, text = default1], default2

		end

	end

	return background, text

end



function p.test(frame)

	local args = frame.args.team and frame.args or frame:getParent().args

	local colors = get_colors((args.team or args1]), nil, args.year)

	return '["' .. args.team .. '"] = {{ "' .. colors1 .. '", '.. colors2 ..

		'", '.. colors3 .. '", '.. colors4 .. '", '.. colors5 .. '"}}'

end



function p.color(frame, column, altcolumn)

	local args = frame.args.team and frame.args or frame:getParent().args

	local colors = get_colors((args.team or args1]), nil, args.year)



	column = (column or tonumber(frame.args.column)) or 1

	altcolumn = altcolumn or tonumber(frame.args.altcolumn)

	if ((not colorscolumn]) or (colorscolumn == '')) and altcolumn then

		column = altcolumn

	end

	

	return (yesno(frame.args.raw) and "" or prefixescolumn]) .. colorscolumn

end



function p.style(frame)

	local team = frame.args.team or frame.args1 or frame:getParent().args.team or frame:getParent().args1

	local year = frame.args.year or frame:getParent().args.year

	local border = frame.args.border or frame:getParent().args.border

	local alt = yesno(frame.args.alt or frame:getParent().args.alt)

	

	local colors = get_colors(team, nil, year)

	

	local background, text

	if alt then background, text = colors4], colors5 end

	if ((not background) or (background  == '')) then background = colors1 end

	if ((not background) or (background  == '')) then background = default1 end

	if ((not text) or (text  == '')) then text = colors2 end

	if ((not text) or (text  == '')) then text = default2 end

	

	background, text = contrast_check(background, text, colors, alt)

	

	local s = prefixes1 .. background .. "; " .. prefixes2 .. text .. "; "

	if tonumber(border) or yesno(border) then

		border = tonumber(border) and border or 2

		s = s .. bordercss(colors3], tonumber(border))

	end

	return '' .. s

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}} {{ NCAA timeline color}}
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 color raw}} {{ Gridiron primary style}} {{ Gridiron alt primary color}} {{ Gridiron alt primary style}} {{ Gridiron alt secondary color}} {{ Gridiron secondary color}} {{ Gridiron secondary color raw}} {{ Gridiron tertiary color raw}}
Handball	{{ Handball color}} {{ Handball color cell}} {{ Handball color cell2}}
UniSport	{{ UniSport color}} {{ UniSport color cell}} {{ UniSport color cell2}}
Volleyball	{{ Volleyball color cell}}
Misc	{{ Esports color}} {{ Netball colours}}
Modules	Module:College color contrast data Module:Gridiron color contrast data Module:Sports color contrast baseball basketball esports handball ice hockey unisport volleyball

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}} {{ NCAA timeline color}}
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 color raw}} {{ Gridiron primary style}} {{ Gridiron alt primary color}} {{ Gridiron alt primary style}} {{ Gridiron alt secondary color}} {{ Gridiron secondary color}} {{ Gridiron secondary color raw}} {{ Gridiron tertiary color raw}}
Handball	{{ Handball color}} {{ Handball color cell}} {{ Handball color cell2}}
UniSport	{{ UniSport color}} {{ UniSport color cell}} {{ UniSport color cell2}}
Volleyball	{{ Volleyball color cell}}
Misc	{{ Esports color}} {{ Netball colours}}
Modules	Module:College color contrast data Module:Gridiron color contrast data Module:Sports color contrast baseball basketball esports handball ice hockey unisport volleyball

Usage

Debugging

Return team color

Return team style

Usage

Debugging

Return team color

Return team style

Videos

Websites

Encyclopedia

Facebook