Template:MapLeagueInclusionTable/Header/doc

This table was made to show a map's inclusions in the map pool of various leagues and in various seasons. The current templates used to make a table are:

• Template:MapLeagueInclusionTable/Header
• Template:MapLeagueInclusionTable/Row/Map
• Template:MapLeagueInclusionTable/Row/Info
• Template:MapLeagueInclusionTable/Footer
• Template:MapLeagueInclusionTable/Note
• Template:MapLeagueInclusionTable/Key

These templates can be found here: Category:MapLeagueInclusionTable Base Templates
All templates can be found here: Category:MapLeagueInclusionTable Templates
Each individual map's table templates can be found here: Category:MapLeagueInclusionTable Map Templates

General info

• All parameters are in lowercase characters
• The generic makeup of a table consists of 1 Header, at least 1 Row, 1 Footer, 1 Note (optional) and 1 Key (optional)
• The current leagues available to include are UGC (4v4), UGC (6v6), ETF2L (6v6), ESEA (6v6), Ozfortress Winter League (6v6), UGC (HL) and ETF2L (HL)
• Any parameter with "ozf6s" denotes the Ozfortress Winter League (OWL)
• A full table example is listed at the bottom of this page

Table cross-section:
This colour sections are controlled by Template:MapLeagueInclusionTable/Header
Orange sections are controlled by Template:MapLeagueInclusionTable/Row/Map
Hot Pink sections are controlled by Template:MapLeagueInclusionTable/Row/Info
Blue sections are controlled by Template:MapLeagueInclusionTable/Footer
Purple sections are controlled by Template:MapLeagueInclusionTable/Key

Map name			4v4	6v6				Highlander
			UGC	UGC	ETF2L	ESEA	OWL	UGC	ETF2L
	cp_cheeseburger		Season 1	Season 2	Season 3	Season 4	Season 5	Season 6	Season 7
				Season 1				Season 2	Season 3
Total inclusions			1 out of 1	2 out of 2	1 out of 3	1 out of 4	1 out of 5	2 out of 6	2 out of 7

Italic bold denotes the current or latest season

		Official map
		Adapted or 'pro' version

¹ This part is controlled by Template:MapLeagueInclusionTable/Note

Template:MapLeagueInclusionTable/Header

The header defines what leagues will be included in the table.
Setting any of the below parameters to '1' will display the parameter's league as a column.
|ugc4s, |ugc6s, |etf2l6s, |esea6s, |ozf6s, |ugchl, and |etf2lhl

Example

{{MapLeagueInclusionTable/Header
 | ugc6s = 1
 | etf2l6s = 1
 | esea6s = 1
 | ozf6s = 1
 | ugchl = 1
}}
|}

Will yield:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6				Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL

Template:MapLeagueInclusionTable/Row/Map

This controls everything inside the first cell of a single row.
|maptype - The coloured ribbon which indicates the map's type. Must be set to any of the following values:

• official - For official maps, sets the ribbon colour to grey (#4F4F4F)
• pro - For maps that have been adapted/re-created from another, or 'pro' maps (e.g. koth_product_rc8). Sets the ribbon colour to green (#F2F2F2)
• normal - For maps that don't pertain to the above, makes the ribbon invisible
  
  

Parameters:
|mapname - The file name for the map version.
|mapdownload - The download link (URL) for the map version. Tips for how to find a map download are listed below.
|maplink - The wiki page the map name will link to. Should only be used for similar maps that are used in the same Inclusion Table (e.g. cp_granary and cp_granary_pro)
|maprowspan - The rowspan for the entire row, must be set to a value (can be set to 1). If set to more than 1, the same amount of /Row/Info rows will need to follow before another /Row/Map template can be used (e.g. if rowspan is set to 3, three /Row/Info templates will follow).

Finding a map download link

The preferable download is a direct link with the map in .bsp format (no file compression). Searching for the map's .bsp file name (e.g. koth_product_rc8.bsp) can often find a website with a download link, make sure that the download is indeed .bsp format and is trustworthy. Copying the website's download link address will give you the URL for the |mapdownload parameter.

If .bsp download cannot be found, usually there will be a .bz2 format download. If so, use the .bz2 URL for the table's download link and note that the download is in .bz2 format with the /Note template (more information on adding notes can be found down the page). The common note is: "Map download is in .bz2 format (must be extracted)".

If no download can be found, do not set the download parameter to any value/URL.

Template:MapLeagueInclusionTable/Row/Info

This controls the cells of the row that contain each seasonal inclusion.

• Only parameters that are defined with the /Header template should be used
• Parameters should be set to the season number of the parameter's league in which the map is included (e.g. |ugc4s = 2 if the map is included in Season 2 of the UGC 4s League)
• Inclusions should of course be chronologically ordered
• Parameters must be set to a value. If there is no seasonal inclusion, setting the parameter to 0 will leave it blank (#BABABA)
• Inclusions for a map version with multiple rows should always be pushed to the top. For example:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6			Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
			cp_cheeseburger_pro_v42				Season	Season 5		Season 17	Season	Season	Season	Season	Season	Season	Season
							Season 4	Season	Season 20		Season	Season	Season	Season	Season	Season	Season
							Season 3	Season		Season 16	Season	Season	Season	Season	Season	Season	Season

The above table is incorrect, as the ETF2L and ESEA columns have inclusions that are not at the top of the row. The following is a correct version:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6		Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
			cp_cheeseburger_pro_v42				Season	Season 5	Season 20	Season 17	Season	Season	Season	Season	Season	Season	Season
							Season 4	Season		Season 16	Season	Season	Season	Season	Season	Season	Season
							Season 3	Season			Season	Season	Season	Season	Season	Season	Season

Full row example

{{MapLeagueInclusionTable/Header |ugc4s = 1 |esea6s = 1 |ozf6s = 1 |etf2lhl = 1}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = pro
 | mapdownload = comp.tf
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 1
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 5
 | esea6s = 0
 | ozf6s = 14
 | etf2lhl = 7
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = official
 | mapname = cp_cheeseburger
 | maplink = Main Page
 | maprowspan = 2
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 4
 | esea6s = 17
 | ozf6s = 13
 | etf2lhl = 0
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 0
 | esea6s = 16
 | ozf6s = 0
 | etf2lhl = 0
}}

Will yield:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6		Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
			cp_cheeseburger_pro_v42				Season 5	Season	Season		Season 14	Season	Season	Season	Season	Season 7	Season
			cp_cheeseburger				Season 4	Season	Season	Season 17	Season 13	Season	Season	Season	Season		Season
								Season	Season	Season 16		Season	Season	Season	Season		Season

Template:MapLeagueInclusionTable/Footer

The footer shows the total inclusions of a map in each individual league.

• Only parameters that are defined with the /Header template (and therefore the /Row/Info template) should be used
• Parameters should be set to the total number of seasonal inclusions that the parameter's league has displayed in the table (e.g. |esea6s = 2 if there are 6 inclusions under the ESEA column)
• The total number of seasons (second part of each cell) is automatically calculated

Example

{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
{{MapLeagueInclusionTable/Footer
 | ugc6s = 1
 | etf2l6s = 2
 | esea6s = 3
 | ozf6s = 4
}}

Will yield:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6				Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
Total inclusions							out of 28	1 out of 41	2 out of 46	3 out of 30	4 out of 38	out of 21	out of 13	out of 10	out of 39	out of 30	out of 16

	Official map
	Pro version

Template:MapLeagueInclusionTable/Key

The key section is a legend to explain colours/text formatting used in the table.

Parameters:
|caption - Displays: "Italic bold denotes the current or latest season"
|official - Displays a table explaining the grey (official) ribbon
|pro - Displays a table explaining the green (pro) ribbon

• Parameters should only be included if the respective attribute is included in the table (e.g. only include the |pro parameter if there is a pro map in the table)
• Set a parameter to '1' to display it
• If using the |caption parameter (which is used when there is an inclusion for a current or latest season), make sure to remove it once the season has expired.

Example

{{MapLeagueInclusionTable/Key
 | caption = 1
 | official = 1
 | pro = 1
}}

Will yield:

Template:MapLeagueInclusionTable/Note

This template displays a single note that should be referred to somewhere in the table

Parameters:
|number - The number of the note, which should be the same as the number in the table
|content - The text content of the note

Example

Seasonal Inclusions by League

[view]			Map version				4v4	6v6	Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
			cp_cheeseburger				Season	Season	Season 4	Season	Season	Season	Season	Season	Season	Season	Season
Total inclusions							out of 28	out of 41	1 out of 46	out of 30	out of 38	out of 21	out of 13	out of 10	out of 39	out of 30	out of 16

	Official map
	Pro version

{{MapLeagueInclusionTable/Note
 | number = 1
 | content = Map download is in .bz2 format (must be extracted)
}}{{MapLeagueInclusionTable/Note
 | number = 2
 | content = cp_cheeseburger is a brilliant map
}}{{MapLeagueInclusionTable/Note
 | number = 3
 | content = Wowie this is the 4th season of ETF2L
}}

Will yield:

'Note' parameters

The term 'note' can be added on the end of a variety of parameters in the /Row/Map, /Row/Info and /Footer templates to add a number in superscript which can later be referred to/explained with the /Note template. The in-table note parameters should be consecutively numbered from top-left of the table to bottom-right.

Example

{{MapLeagueInclusionTable/Header | ozf6s = 1}}
{{MapLeagueInclusionTable/Row/Map | maptype = normal | mapdownload = comp.tf | mapname = cp_cheeseburger | maprowspan = 1
 | mapdownloadnote = 1
 | mapnamenote = 2 }}
{{MapLeagueInclusionTable/Row/Info | ozf6s = 6
 | ozf6snote = 3 }}
{{MapLeagueInclusionTable/Footer | ozf6s = 1
 | ozf6snote = 4}}

Will yield:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6	Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
			cp_cheeseburger				Season	Season	Season	Season	Season 6	Season	Season	Season	Season	Season	Season
Total inclusions							out of 28	out of 41	out of 46	out of 30	1 out of 38	out of 21	out of 13	out of 10	out of 39	out of 30	out of 16

	Official map
	Pro version

Below is a list of all note parameters across all templates:

/Row/Map

|mapdownloadnote and |mapnamenote

/Row/Info

|ugc4snote, |ugc6snote, |etf2l6snote, |esea6snote, |ozf6snote, |ugchlnote and |etf2lhlnote

/Footer

|ugc4snote, |ugc6snote, |etf2l6snote, |esea6snote, |ozf6snote, |ugchlnote and |etf2lhlnote

Full table example

{{MapLeagueInclusionTable/Header
 | ugc4s = 1
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = pro
 | mapdownload = comp.tf
 | mapdownloadnote = 1
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 1
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 5
 | esea6s = 0
 | ozf6s = 14
 | etf2lhl = 7
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = official
 | mapname = cp_cheeseburger
 | maplink = Main Page
 | maprowspan = 1
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 4
 | esea6s = 17
 | ozf6s = 0
 | etf2lhl = 0
}}
{{MapLeagueInclusionTable/Footer
 | ugc4s = 2
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}{{MapLeagueInclusionTable/Key
 | caption = 1
 | official = 1
 | pro = 1
}}{{MapLeagueInclusionTable/Note
 | number = 1
 | content = Map download is in .bz2 format (must be extracted)
}}

Will yield:

Seasonal Inclusions by League

[view]			Map version				4v4	6v6		Prolander	Highlander
							UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
			cp_cheeseburger_pro_v42				Season 5	Season	Season		Season 14	Season	Season	Season	Season	Season 7	Season
			cp_cheeseburger				Season 4	Season	Season	Season 17		Season	Season	Season	Season		Season
Total inclusions							2 out of 28	out of 41	out of 46	1 out of 30	1 out of 38	out of 21	out of 13	out of 10	out of 39	1 out of 30	out of 16

	Official map
	Pro version