Module:College color/data/doc

MyWikiBiz, Author Your Legacy — Friday October 11, 2024
Jump to navigationJump to search

This is the documentation page for Module:College color/data

Template:High-use Template:Module rating This is the data module used by Module:College color. Color contrast should meet Web Content Accessibility Guidelines (WCAG) 2.0's AAA level when feasible (see Template:Section link). Please test any changes in Module:College color/data/sandbox first.

Format

Most lines will be of the following form

 ["TEAM NAME"] = {"HEX1", "HEX2", name1="...", name2="...", cite="...", cite2="..."},

or

 ["TEAM NAME"] = {"HEX1", "HEX2", "HEX3",  name1="...", name3="...", cite="...", cite2="..."},

The trailing comma is very important. Here, HEX1, HEX2, and HEX3 are hexadecimal color values. The name1, name2, and name3 are to display the names of the school colors in the infoboxes. The cite and cite2 parameters are used to supply up to two full citations with a URL for verification of the colors for a school's entry. Unsourced entries that are challenged may be deleted.

To use the same color for more than one team name (e.g., if the team goes by more than one name, but the colors are the same), use

 ["SECONDARY TEAM NAME"] = "TEAM NAME",

where TEAM NAME has already been defined, and SECONDARY TEAM NAME is the alternative spelling, or name.

Warning

Be very careful when updating this module, as it is used in a large number of articles. Please test any changes in Module:College color/data/sandbox first.

Also, remember to leave the pound sign (#) out of the hex codes when adding or changing colors, as in Template:Code. Some other data modules require the pound sign. This module does not require it.

Test table

Lua error: Internal error: The interpreter has terminated with signal "24".

As a guide to selecting foreground and background colors for text, the Web Content Accessibility Guidelines 2.0 (guideline 1.4) classifies contrast ratios for ordinary text as follows:

WCAG 2.0 text contrast ratios
Font size Not Compliant Level AA Level AAA
Normal < 4.5 4.5 to 7.0 > 7.0
Large (18 pt or 14 pt bold) < 3.0 3.0 to 4.5 > 4.5

Normal wiki-text is rendered by common browsers at roughly 9.5 to 10.5 pt (12.5 to 14 px), depending on skin. Text would need to be about 180% or 140% bold to qualify as "Large" for WCAG purposes.