Module:Gridiron color/data/doc: Difference between revisions

Content deleted Content added
add example
Data format: add warning
Line 6:
 
 
=== Normal team formatting: ===
 
<source lang="lua">["team name"] = {"primary color", "secondary color", "tertiary color", "alternative primary", "alternative secondary"},</source>
 
=== Teams with historical color schemes ===
 
Team with historical colors formatting (where XXXX represents the 4-digit start year and YYYY represents the 4-digit end year):
Line 16 ⟶ 18:
{
["team name XXXXthruYYYY"] = {"primary color", "secondary color", "tertiary color", "alternative primary", "alternative secondary"},
["team name XXXXthruYYYY"] = "alternative team name",
["team name XXXXthruYYYY"] = "alternative team name XXXXthruYYYY"
}
},
</source>
 
=== Team alternative name formatting: ===
 
<source lang="lua">["team alternative name"] = "team name",</source>
 
--------------------------------------------------------------------------------
=== Warnings ===
 
Do '''not''' create a historical color line that links back to the main team name, as in the <code>"Gridiron Team 1990thru2000"</code> line in the example below:
 
<source lang="lua">
["Gridiron Team"] = {"#dcdcdc", "", "none", "", "",
{
["Gridiron Team 1990thru2000"] = "Gridiron Team"
["Gridiron Team 1980thru1990"] = {"#dcdcdc", "", "none", "", ""}
}
},
</source>
 
This will create an infinite loop, and cause script errors on any pages that try to specify that team. The module will always use the current colors if a color for the specified year is not found, so any historical lines that are identical to the top-level color scheme can simply be deleted.
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |