Module:Teamnames/doc

See Help:Setting Up Teams if you aren't sure how to do that. After updating this module, please click "Refresh Teamnames" in the upper-right corner of the page and wait for the box to turn green. If you have any questions, please ask in [ Discord]!

Inputs & Outputs
Everything on the left side of an = is an input, i.e. if you write, it will resolve. You need one line per input that you want to work with the template. All inputs you define here must be written in lowercase.

Everything on the right side of an = is an output, i.e. what the template does with your input code. How to define outputs properly is explained in the next sections.

How to add a team with one valid input
This input should be the link variable, written in lowercase.

Example
	["jin air green wings falcons (korean team)"] = { link = "Jin Air Green Wings Falcons (Korean Team)", long = "Jin Air Green Wings Falcons", medium = "Jin Air Falcons", short = "JAF" },

In this scenario, imagine there are two different teams called Jin Air Green Wings Falcons. One is a Korean team, and one is a European team. We will look at the Korean team.
 * , the exact name of the team's page, for example "Jin Air Green Wings Falcons (Korean Team)"
 * , the full name of the team for normal display, for example "Jin Air Green Wings Falcons"
 * , a fully descriptive name of the team that's shorter than about 13 characters, for example "Jin Air Falcons"
 * , a very short abbreviation for a team, at most 5-7 characters and usually 3 characters long, for example "Falcons" or "JAF"

Copyable Code
	[""] = { link = "", long = "", medium = "", short = "" },

How to add additional valid inputs for a team
The line with variable definitions will be the last line in the section of inputs for that particular team, so the following will go on lines immediately preceding the variable definitions themselves.

Make sure that everything on these lines is lowercase!

Example
	["jaf"] = "jin air green wings falcons (korean team)]", ["jag falcons"] = "jin air green wings falcons (korean team)", ["jagw falcons"] = "jin air green wings falcons (korean team)", ["jin air greenwings falcons"] = "jin air green wings falcons (korean team)", ["jinair falcons"] = "jin air green wings falcons (korean team)", ["jinair green wings falcons"] = "jin air green wings falcons (korean team)", ["jinair greenwings falcons"] = "jin air green wings falcons (korean team)",

In this case, "jin air green wings falcons (korean team)" is the original valid input we defined above, and we are additionally adding "jaf" as a valid input on the line BEFORE the full variable definition line. Again, remember everything here is lowercase!

Copyable Code
	[""] = "",

Additional Syntax
You may add a comment with: 	--COMMENT

If a team has the character  or   in its name, you need to escape the character by writing   or.

Style Guide

 * Please keep the tab at the start of each line.
 * Teams are sorted alphabetically by link, and all names for a team go consecutively (unlike the old way with Teamnames/* templates).