Module:Gridiron color/doc

MyWikiBiz, Author Your Legacy — Saturday November 16, 2024
Jump to navigationJump to search

This is the documentation page for Module:Gridiron color

Template:Module rating Template:High use

Template:Lua 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 Template:Para and Template:Para (if omitted from invoke, module will take values from the template call):

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

Script error: No such module "Gridiron color/sandbox".

Return team color

Returns either raw color value or prefixed color value. Template:Para uses the following values:

  1. Primary color
  2. Secondary color
  3. Tertiary color
  4. Alternative primary color
  5. Alternative secondary color

Set Template:Para to display raw hex values. Team name and year passed in template call or specified using Template:Para and Template:Para:

{{#invoke:Gridiron color|color|columnTemplate:=#|rawTemplate:=true (optional)|teamTemplate:=team name (optional)|yearTemplate:=#### (optional)}}

Script error: No such module "Gridiron color/sandbox".

Return team style

Returns complete CSS style for given team. A border will be displayed using the tertiary color if Template:Para 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 Template:Para and Template:Para:

{{#invoke:Gridiron color|style|borderTemplate:=# or yes (optional)|teamTemplate:=team name (optional)|yearTemplate:=#### (optional)}}

Script error: No such module "Gridiron color/sandbox".