Editing Template:MapLeagueInclusionTable/Header/doc

__NOTOC__
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]]'''<br />
All templates can be found here: '''[[:Category:MapLeagueInclusionTable Templates]]'''<br />
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:<br />
'''<font color="#CEF2E0">This colour</font>'''  sections are controlled by Template:MapLeagueInclusionTable/Header<br />
'''<font color="#F2E0CE">Orange</font>''' sections are controlled by [[Template:MapLeagueInclusionTable/Row/Map]]<br />
'''<font color="#F2CEE0">Hot Pink</font>''' sections are controlled by [[Template:MapLeagueInclusionTable/Row/Info]]<br />
'''<font color="#CEE0F2">Blue</font>''' sections are controlled by [[Template:MapLeagueInclusionTable/Footer]]<br />
'''<font color="#E0CEF2">Purple</font>''' sections are controlled by [[Template:MapLeagueInclusionTable/Key]]
{| class="wikitable" style="text-align: center;"
 ! rowspan="2" colspan="3" style="color: white; background-color: #CEF2E0; width: 22px;" | Map name
 ! style="color: white; background-color: #CEF2E0;" colspan="1 | 4v4
 ! style="color: white; background-color: #CEF2E0;" colspan="4" | 6v6
 ! style="color: white; background-color: #CEF2E0;" colspan="2" | Highlander
|-
 ! style="background-color: #CEF2E0; width:100px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
 ! style="background-color: #CEF2E0; width:100px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
 ! style="background-color: #CEF2E0; width:100px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
 ! style="background-color: #CEF2E0; width:100px;" | [[File:EseaLogo.png | 20px | link=]] [[ESEA]]
 ! style="background-color: #CEF2E0; width:100px;" | [[File:Ozfortress icon.png | 20px | link=]] [[ozfortress | {{ abbr | OWL | Ozfortress Winter League}}]]
 ! style="background-color: #CEF2E0; width:100px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
 ! style="background-color: #CEF2E0; width:100px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
|-
 ! style="border-right: hidden; background-color: #F2E0CE; width: 12px; " rowspan="2" | 
 ! style="background-color: #F2E0CE;" rowspan="2" | [[File:Downloadicon.png | 12px | link=comp.tf]] cp_cheeseburger
 ! style="border-left: hidden; background-color: #F2E0CE; width: 12px;" rowspan="2" | 
 | style="background-color:#F2CEE0" | Season 1
 | style="background-color:#F2CEE0" | Season 2
 | style="background-color:#F2CEE0" | Season 3
 | style="background-color:#F2CEE0" | Season 4
 | style="background-color:#F2CEE0" | Season 5
 | style="background-color:#F2CEE0" | Season 6
 | style="background-color:#F2CEE0" | Season 7
|-
 | style="background-color: #F2CEE0" | 
 | style="background-color:#F2CEE0" | Season 1
 | style="background-color:#F2CEE0" | 
 | style="background-color:#F2CEE0" | 
 | style="background-color:#F2CEE0" | 
 | style="background-color:#F2CEE0" | Season 2
 | style="background-color:#F2CEE0" | Season 3
|-
 ! style="background-color:#CEE0F2; color: white;" colspan="3" | Total inclusions
 ! style="background-color:#CEE0F2" | 1 <small>out of</small> 1
 ! style="background-color:#CEE0F2" | 2 <small>out of</small> 2
 ! style="background-color:#CEE0F2" | 1 <small>out of</small> 3
 ! style="background-color:#CEE0F2" | 1 <small>out of</small> 4
 ! style="background-color:#CEE0F2" | 1 <small>out of</small> 5
 ! style="background-color:#CEE0F2" | 2 <small>out of</small> 6
 ! style="background-color:#CEE0F2" | 2 <small>out of</small> 7
|}
<font color="#E0CEF2">'''''Italic bold''''' denotes the current or latest season</font>
{| class="wikitable" style="text-align: left;" 
 | style="width: 20px; height: 20px; background-color: #E0CEF2" |
 | style="border-right: hidden; background-color: #E0CEF2; width: 1px;" |
 | style="background-color:#E0CEF2" | Official map
 | style="border-left: hidden; background-color: #E0CEF2; width: 1px;" |
|-
 | style="width: 20px; height: 20px; background-color: #E0CEF2;" |
 | style="border-right: hidden; background-color: #E0CEF2; width: 1px;" |
 | style="background-color: #E0CEF2" | Adapted or 'pro' version
 | style="border-left: hidden; background-color: #E0CEF2; width: 1px;" |
|}
:<sup>1</sup> <small>This part is controlled by [[Template:MapLeagueInclusionTable/Note]]</small>

== Template:MapLeagueInclusionTable/Header ==
The header defines what leagues will be included in the table.<br />
Setting any of the below parameters to '1' will display the parameter's league as a column.<br />
<code>|ugc4s</code>, <code>|ugc6s</code>, <code>|etf2l6s</code>, <code>|esea6s</code>, <code>|ozf6s</code>, <code>|ugchl</code>, and <code>|etf2lhl</code><br />
=== Example ===
<pre>{{MapLeagueInclusionTable/Header
 | ugc6s = 1
 | etf2l6s = 1
 | esea6s = 1
 | ozf6s = 1
 | ugchl = 1
}}
|}</pre>'''Will yield:'''
{{MapLeagueInclusionTable/Header
 | ugc6s = 1
 | etf2l6s = 1
 | esea6s = 1
 | ozf6s = 1
 | ugchl = 1
}}
|}

== [[Template:MapLeagueInclusionTable/Row/Map]] ==
This controls everything inside the first cell of a single row.<br />
<code>|maptype</code> - 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 ({{abbr|<nowiki>#</nowiki>4F4F4F|Hexadecimal colour value}})
* '''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 ({{abbr|<nowiki>#</nowiki>F2F2F2|Hexadecimal colour value}})
* '''normal''' - For maps that don't pertain to the above, makes the ribbon invisible<br /><br />
'''Parameters:'''<br />
<code>|mapname</code> - The file name for the map version.<br />
<code>|mapdownload</code> - The download link (URL) for the map version. Tips for how to find a map download are listed below.<br />
<code>|maplink</code> - 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)''<br />
<code>|maprowspan</code> - 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 <code>|mapdownload</code> parameter.<br /><br />
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)".<br /><br />
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.<br />
* 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. ''<code>|''ugc4s = 2</code> 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 ({{abbr|<nowiki>#</nowiki>BABABA|Hexadecimal colour value}})
* Inclusions for a map version with multiple rows should always be pushed to the top. For example:
{{MapLeagueInclusionTable/Header
 | ugc6s = 1
 | etf2l6s = 1
 | esea6s = 1
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = pro
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 3
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc6s = 5
 | esea6s = 17
 | etf2l6s = 0
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 4
 | esea6s = 0
 | etf2l6s = 20
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 3
 | esea6s = 16
 | etf2l6s = 0
}}|}
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:
{{MapLeagueInclusionTable/Header
 | ugc4s = 1
 | etf2l6s = 1
 | esea6s = 1
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = pro
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 3
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc6s = 5
 | esea6s = 17
 | etf2l6s = 20
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 4
 | esea6s = 16
 | etf2l6s = 0
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 3
 | esea6s = 0
 | etf2l6s = 0
}}|}
=== Full row example ===
<small><pre>{{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
}}</pre></small> '''Will yield:'''
{{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
}}
|}

== [[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. ''<code>|''esea6s = 2</code> if there are 6 inclusions under the ESEA column)''
* The total number of seasons (second part of each cell) is automatically calculated

=== Example ===
<pre>{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
{{MapLeagueInclusionTable/Footer
 | ugc6s = 1
 | etf2l6s = 2
 | esea6s = 3
 | ozf6s = 4
}}</pre> '''Will yield:'''
{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
{{MapLeagueInclusionTable/Footer
 | ugc6s = 1
 | etf2l6s = 2
 | esea6s = 3
 | ozf6s = 4
}}

== [[Template:MapLeagueInclusionTable/Key]] ==
The key section is a legend to explain colours/text formatting used in the table.<br /><br />
'''Parameters:'''<br />
<code>|caption</code> - Displays: "'''''Italic bold''''' denotes the current or latest season"<br />
<code>|official</code> - Displays a table explaining the grey (official) ribbon<br />
<code>|pro</code> - 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 ''<code>|''pro</code> parameter if there is a pro map in the table)''
* Set a parameter to '1' to display it
* If using the <code>|caption</code> 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 ===
<pre>{{MapLeagueInclusionTable/Key
 | caption = 1
 | official = 1
 | pro = 1
}}</pre> '''Will yield:'''
{{MapLeagueInclusionTable/Key
 | caption = 1
 | official = 1
 | pro = 1
}}

== [[Template:MapLeagueInclusionTable/Note]] ==
This template displays a single note that should be referred to somewhere in the table<br /><br />
'''Parameters:'''<br />
<code>|number</code> - The number of the note, which should be the same as the number in the table<br />
<code>|content</code> - The text content of the note
=== Example ===
{{MapLeagueInclusionTable/Header | etf2l6s = 1}}
{{MapLeagueInclusionTable/Row/Map | maptype = normal | mapdownload = comp.tf | mapdownloadnote = 1 | mapname = cp_cheeseburger | mapnamenote = 2 | maprowspan = 1}}
{{MapLeagueInclusionTable/Row/Info | etf2l6s = 4 | etf2l6snote = 3}}
{{MapLeagueInclusionTable/Footer | etf2l6s = 1}}
<pre>{{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
}}</pre> '''Will yield:'''
{{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
}}

== '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 ===
<pre>{{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}}</pre> '''Will yield:'''
{{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}}<br />

Below is a list of all note parameters across all templates:
=== /Row/Map ===
<code>|mapdownloadnote</code> and <code>|mapnamenote</code>
=== /Row/Info ===
<code>|ugc4snote</code>, <code>|ugc6snote</code>, <code>|etf2l6snote</code>, <code>|esea6snote</code>, <code>|ozf6snote</code>, <code>|ugchlnote</code> and <code>|etf2lhlnote</code>
=== /Footer ===
<code>|ugc4snote</code>, <code>|ugc6snote</code>, <code>|etf2l6snote</code>, <code>|esea6snote</code>, <code>|ozf6snote</code>, <code>|ugchlnote</code> and <code>|etf2lhlnote</code>

== Full table example ==
<pre>{{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)
}}</pre> '''Will yield:'''
{{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)
}}

<noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]][[Category:MapLeagueInclusionTable Documentation Templates]]</noinclude>