Difference between revisions of "Template:MapLeagueInclusionTable/Header/doc"

From comp.tf
Jump to navigation Jump to search
m (Changed category to MapLeagueInclusionTable Documentaion Templates)
 
(39 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This table was made to show a map's inclusions in the map pool of various leagues and in various seasons. The first two sections of this documentation are best for providing a basic overview for how to make a template; the rest goes more in depth of the specifics of each template.<br /><!--
+
__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:
−
== Associated templates ==
+
* Template:MapLeagueInclusionTable/Header
−
The current templates associated with creating a Map League Inclusion Table are:
+
* [[Template:MapLeagueInclusionTable/Row/Map]]
−
* [[Template:MapLeagueInclusionTable/Header]]
+
* [[Template:MapLeagueInclusionTable/Row/Info]]
−
* [[Template:MapLeagueInclusionTable/Row]]
 
 
* [[Template:MapLeagueInclusionTable/Footer]]
 
* [[Template:MapLeagueInclusionTable/Footer]]
−
* [[Template:MapLeagueInclusionTable/Note]]
+
These templates can be found here: '''[[:Category:MapLeagueInclusionTable Base Templates]]'''<br />
−
* [[Template:MapLeagueInclusionTable/Key]]
+
Each individual map's table templates can be found here: '''[[:Category:MapLeagueInclusionTable Map Templates]]'''<br />
−
These templates can also be found in [[:Category:MapLeagueInclusionTable Base Templates]].<!--
+
All templates can be found here: '''[[:Category:MapLeagueInclusionTable Templates]]'''
−
-->
+
 
−
== General information ==
+
== General info ==
 
* All parameters are in lowercase characters
 
* 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 (6v6), AsiaFortress (6v6), UGC (HL) and ETF2L (HL)
−
* The current leagues available to include are UGC (4v4), UGC (6v6), ETF2L (6v6), ESEA (6v6), Ozfortress Winter League (6v6), UGC (HL) and ETF2L (HL)
+
* A full table example is listed at the bottom of this page
−
* Any parameter with "ozf6s" denotes the Ozfortress Winter League (OWL)
+
 
−
=== Full table example ===
+
== Table cross-section ==
 +
'''<font color="#E0CEF2">Purple</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 />
 +
{| class="wikitable" style="text-align: center;"
 +
|+ <font color="#E0CEF2">Seasonal Inclusions by League</font>
 +
! rowspan="2" colspan="3" style="color: white; background-color: #E0CEF2; width: 22px;" | Map name
 +
! style="color: white; background-color: #E0CEF2;" colspan="1 | 4v4
 +
! style="color: white; background-color: #E0CEF2;" colspan="6" | 6v6
 +
! style="color: white; background-color: #E0CEF2;" colspan="1" | 7v7
 +
! style="color: white; background-color: #E0CEF2;" colspan="3" | Highlander
 +
|-
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:EseaLogo.png | 20px | link=]] [[ESEA]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:Ozfortress Icon.png | 20px | link=]] [[Ozfortress|ozfortress]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:RGL Icon.png | 20px | link=]] [[RGL]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:AsiaFortress-Icon.png | 20px | link=]] [[AsiaFortress]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:RGL Icon.png | 20px | link=]] [[RGL]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
 +
! style="background-color: #E0CEF2; width:110px;" | [[File:RGL Icon.png | 20px | link=]] [[RGL]]
 +
|-
 +
! 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" | Season 8
 +
| style="background-color:#F2CEE0" | Season 9
 +
| style="background-color:#F2CEE0" | Season 10
 +
| style="background-color:#F2CEE0" | Season 11
 +
|-
 +
| 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" |
 +
| style="background-color:#F2CEE0" |
 +
| style="background-color:#F2CEE0" |
 +
| style="background-color:#F2CEE0" | Season 2
 +
| style="background-color:#F2CEE0" | Season 3
 +
| style="background-color:#F2CEE0" |
 +
|-
 +
! 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" | 1 <small>out of</small> 6
 +
! style="background-color:#CEE0F2" | 2 <small>out of</small> 7
 +
! style="background-color:#CEE0F2" | 2 <small>out of</small> 8
 +
! style="background-color:#CEE0F2" | 1 <small>out of</small> 9
 +
! style="background-color:#CEE0F2" | 1 <small>out of</small> 10
 +
! style="background-color:#CEE0F2" | 1 <small>out of</small> 11
 +
|}
 +
<font color="#CEE0F2">'''''Italic bold''''' denotes the current or latest season</font>
 +
{| class="wikitable" style="text-align: left;"
 +
| style="width: 20px; height: 20px; background-color: #CEE0F2" |
 +
| style="background-color:#CEE0F2" | Official map
 +
|-
 +
| style="width: 20px; height: 20px; background-color: #CEE0F2;" |
 +
| style="background-color: #CEE0F2" | Adapted or 'pro' version
 +
|}
 +
 
 +
== 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>|rgl6s</code>, <code>|af6s</code>, <code>|rgl7s</code>, <code>|ugchl</code><code>|etf2lhl</code> and <code>|rglhl</code>, <br />
 +
=== Example ===
 
<pre>{{MapLeagueInclusionTable/Header
 
<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.bz2 format. Searching for the map's .bsp.bz2 file name ''(e.g. koth_product_rc8.bsp.bz2)'' can often find a website with a download link, make sure that the download is indeed .bsp.bz2 format and is trustworthy. Copying the website's download link address will give you the URL for the <code>|mapdownload</code> parameter.
 +
 +
There are 6 maps with no download links:
 +
*koth_lakeside.bsp.bz2
 +
*cp_logjam.bsp.bz2*
 +
*cp_obscure_remake.bsp.bz2
 +
*cp_obscure.bsp.bz2
 +
*cp_standin_rc5.bsp.bz2
 +
*cp_yukon.bsp.bz2
 +
<nowiki>*This could be due to an archiving error by ETF2L, meaning a different map version is the correct map at hand</nowiki>
 +
== [[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
 
  | ugc4s = 1
 +
| etf2l6s = 1
 
  | esea6s = 1
 
  | esea6s = 1
−
| ozf6s = 1
 
−
| etf2lhl = 1
 
 
}}
 
}}
−
{{MapLeagueInclusionTable/Row
+
{{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
 
  | maptype = pro
 
  | mapdownload = comp.tf
 
  | mapdownload = comp.tf
−
| mapdownloadnote = 1
 
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
−
  | mapspan = 1
+
  | maprowspan = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row/Info
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 33: Line 236:
 
  | etf2lhl = 7
 
  | etf2lhl = 7
 
}}
 
}}
−
{{MapLeagueInclusionTable/Row
+
{{MapLeagueInclusionTable/Row/Map
−
  | maptype = valve
+
  | maptype = official
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 
  | maplink = Main Page
 
  | maplink = Main Page
−
  | mapspan = 1
+
  | maprowspan = 2
 +
}}
 +
{{MapLeagueInclusionTable/Row/Info
 
  | ugc4s = 4
 
  | ugc4s = 4
 
  | esea6s = 17
 
  | esea6s = 17
 +
| ozf6s = 13
 +
| etf2lhl = 0
 +
}}
 +
{{MapLeagueInclusionTable/Row/Info
 +
| ugc4s = 0
 +
| esea6s = 16
 
  | ozf6s = 0
 
  | ozf6s = 0
 
  | etf2lhl = 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
 +
 +
There is also a 'key' section to the footer which is used as a legend to explain colours/text formatting used in the table.<br /><br />
 +
'''Parameters:'''<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
 +
* The caption (saying "'''''Italic bold''''' denotes the current or latest season") is controlled by [[Template:Current Rotations]] and is updated in conjunction with that template.
 +
 +
=== Example ===
 +
<pre>{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
 
{{MapLeagueInclusionTable/Footer
 
{{MapLeagueInclusionTable/Footer
−
  | ugc4s = 2
+
  | ugc6s = 1
−
| esea6s = 1
+
  | etf2l6s = 2
−
  | ozf6s = 1
+
  | esea6s = 3
−
  | etf2lhl = 1
+
  | ozf6s = 4
−
}}{{MapLeagueInclusionTable/Key
+
  | official = 1
−
  | caption = 1
 
−
  | valve = 1
 
 
  | pro = 1
 
  | pro = 1
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 1
 
−
| content = Map download is in .bz2 format
 
 
}}</pre> '''Will yield:'''
 
}}</pre> '''Will yield:'''
−
{{MapLeagueInclusionTable/Header
+
{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
 +
{{MapLeagueInclusionTable/Footer
 +
| ugc6s = 1
 +
| etf2l6s = 2
 +
| esea6s = 3
 +
| ozf6s = 4
 +
| official = 1
 +
| pro = 1
 +
}}
 +
 
 +
== Full table example ==
 +
<pre>{{MapLeagueInclusionTable/Header
 
  | ugc4s = 1
 
  | ugc4s = 1
 
  | esea6s = 1
 
  | esea6s = 1
Line 62: Line 297:
 
  | etf2lhl = 1
 
  | etf2lhl = 1
 
}}
 
}}
−
{{MapLeagueInclusionTable/Row
+
{{MapLeagueInclusionTable/Row/Map
 
  | maptype = pro
 
  | maptype = pro
−
  | mapdownload = comp.tf
+
  | mapdownload = Main Page
−
| mapdownloadnote = 1
 
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
−
  | mapspan = 1
+
  | maprowspan = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row/Info
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 73: Line 309:
 
  | etf2lhl = 7
 
  | etf2lhl = 7
 
}}
 
}}
−
{{MapLeagueInclusionTable/Row
+
{{MapLeagueInclusionTable/Row/Map
−
  | maptype = valve
+
  | maptype = official
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 
  | maplink = Main Page
 
  | maplink = Main Page
−
  | mapspan = 1
+
  | maprowspan = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row/Info
 
  | ugc4s = 4
 
  | ugc4s = 4
 
  | esea6s = 17
 
  | esea6s = 17
Line 88: Line 326:
 
  | ozf6s = 1
 
  | ozf6s = 1
 
  | etf2lhl = 1
 
  | etf2lhl = 1
−
}}{{MapLeagueInclusionTable/Key
+
  | official = 1
−
  | caption = 1
 
−
| valve = 1
 
 
  | pro = 1
 
  | pro = 1
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 1
 
−
| content = Map download is in .bz2 format
 
−
}}<!--
 
−
-->
 
−
== "Note" parameters ==
 
−
The term "note" can be added onto the end of any parameter followed by a number which will then display said number in superscript, then referenced below the table with the [[Template:MapLeagueInclusionTable/Note]] template. Potential note parameters are referenced in their individual sections.<br />
 
−
'''Note: numbers should be consecutively ordered from top left of the table to bottom right.'''
 
−
=== Example ===
 
−
<pre>{{MapLeagueInclusionTable/Header
 
−
| etf2l6s = 1
 
−
| etf2l6snote = 1
 
−
}}
 
−
{{MapLeagueInclusionTable/Row
 
−
| maptype = normal
 
−
| mapdownload = http://fastdl.colonslash.eu/maps/cp_freight_b3.bsp.bz2
 
−
| mapdownloadnote = 2
 
−
| mapname = cp_freight_b3
 
−
| etf2l6s = 4
 
−
| etf2l6snote = 3
 
−
}}
 
−
{{MapLeagueInclusionTable/Footer
 
−
| etf2l6s = 1
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 1
 
−
| content = ETF2L is a big league
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 2
 
−
| content =  Map download is in .bz2 format
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 3
 
−
| content = Wowie this is the 4th season of ETF2L
 
 
}}</pre> '''Will yield:'''
 
}}</pre> '''Will yield:'''
 
{{MapLeagueInclusionTable/Header
 
{{MapLeagueInclusionTable/Header
−
  | etf2l6s = 1
+
  | ugc4s = 1
−
  | etf2l6snote = 1
+
  | esea6s = 1
 +
| ozf6s = 1
 +
| etf2lhl = 1
 
}}
 
}}
−
{{MapLeagueInclusionTable/Row
+
{{MapLeagueInclusionTable/Row/Map
−
  | maptype = normal
+
  | maptype = pro
−
  | mapdownload = http://fastdl.colonslash.eu/maps/cp_freight_b3.bsp.bz2
+
  | mapdownload = Main Page
−
| mapdownloadnote = 2
+
  | mapname = cp_cheeseburger_pro_v42
−
  | mapname = cp_freight_b3
+
  | maprowspan = 1
−
| etf2l6s = 4
 
−
  | etf2l6snote = 3
 
 
}}
 
}}
−
{{MapLeagueInclusionTable/Footer
+
{{MapLeagueInclusionTable/Row/Info
−
| etf2l6s = 1
+
  | ugc4s = 5
−
}}{{MapLeagueInclusionTable/Note
+
  | esea6s = 0
−
| number = 1
+
  | ozf6s = 14
−
| content = ETF2L is a big league
+
  | etf2lhl = 7
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 2
 
−
| content =  Map download is in .bz2 format
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 3
 
−
  | content = Wowie this is the 4th season of ETF2L
 
−
}}<!--
 
−
-->
 
−
== Header ==
 
−
The header defines what leagues will be included, displayed as columns in the table.
 
−
=== Parameters ===
 
−
The following are all potential parameters, and therefore leagues, that can be used:<br />
 
−
<code>|ugc4s</code>, <code>|ugc6s</code>, <code>|etf2l6s</code>, <code>|esea6s</code>, <code>|ozf6s</code>, <code>|ugchl</code>, and <code>|etf2lhl</code><br />
 
−
Setting a "1" value to these parameters will display a league as a column.
 
−
==== Note parameters ====
 
−
Excluding the above parameters, the other note parameters are:
 
−
<code>|mapnamenote</code>, <code>|4v4note</code>, <code>|6v6note</code>, and <code>|highlandernote</code>
 
−
=== Example ===
 
−
<pre>{{MapLeagueInclusionTable/Header
 
−
| ugc6s = 1
 
−
| etf2l6s = 1
 
−
  | esea6s = 1
 
−
  | ozf6s = 1
 
−
  | ugchl = 1
 
 
}}
 
}}
−
|}</pre> '''Will yield:'''
+
{{MapLeagueInclusionTable/Row/Map
−
{{MapLeagueInclusionTable/Header
+
  | maptype = official
−
| ugc6s = 1
+
  | mapname = cp_cheeseburger
−
  | etf2l6s = 1
+
  | maplink = Main Page
−
  | esea6s = 1
+
  | maprowspan = 1
−
  | ozf6s = 1
 
−
  | ugchl = 1
 
 
}}
 
}}
−
|}<!--
+
{{MapLeagueInclusionTable/Row/Info
−
-->
+
  | ugc4s = 4
−
== Row ==
+
  | esea6s = 17
−
The row contains the main information of the table; map type, map download, map name and, of course, each seasonal inclusion.
+
  | ozf6s = 0
−
=== Parameters ===
+
  | etf2lhl = 0
−
 
 
−
== Footer ==
 
−
The footer shows the total inclusions of a map in each individual league. The total overall seasons (second value shown) is calculated automatically.
 
−
=== Parameters ===
 
−
The following are all potential parameters, and therefore leagues, that can be used:<br />
 
−
<code>|ugc4s</code>, <code>|ugc6s</code>, <code>|etf2l6s</code>, <code>|esea6s</code>, <code>|ozf6s</code>, <code>|ugchl</code>, and <code>|etf2lhl</code><br />
 
−
Setting any value to these parameters will display that value as the total number of seasonal inclusions for a league.
 
−
==== Note parameters ====
 
−
Excluding the above parameters, the other note parameters are:
 
−
<code>|totalinclusionsnote</code>, <code>|ugc4stotalseasonsnote</code>, <code>|ugc6stotalseasonsnote</code>, <code>|etf2l6stotalseasonsnote</code>, <code>|esea6stotalseasonsnote</code>, <code>|ozf6stotalseasonsnote</code>, <code>|ugchltotalseasonsnote</code>, and <code>|etf2lhltotalseasonsnote</code>
 
−
=== Example ===
 
−
<pre>{{MapLeagueInclusionTable/Header
 
−
  | ugc6s = 1
 
−
| etf2l6s = 1
 
−
  | esea6s = 1
 
−
  | ozf6s = 1
 
−
  | ugchl = 1
 
 
}}
 
}}
 
{{MapLeagueInclusionTable/Footer
 
{{MapLeagueInclusionTable/Footer
−
  | ugc6s = 9
+
  | ugc4s = 2
−
| etf2l6s = 7
 
−
| esea6s = 4
 
−
| ozf6s = 4
 
−
| ugchl = 3
 
−
}}</pre> '''Will yield:'''
 
−
{{MapLeagueInclusionTable/Header
 
−
| ugc6s = 1
 
−
| etf2l6s = 1
 
 
  | esea6s = 1
 
  | esea6s = 1
 
  | ozf6s = 1
 
  | ozf6s = 1
−
  | ugchl = 1
+
  | etf2lhl = 1
−
}}
+
  | official = 1
−
{{MapLeagueInclusionTable/Footer
 
−
| ugc6s = 9
 
−
| etf2l6s = 7
 
−
| esea6s = 4
 
−
| ozf6s = 4
 
−
  | ugchl = 3
 
−
}}<!--
 
−
-->
 
−
== Key ==
 
−
The key section is a legend to explain colours/text formatting used in the table.
 
−
=== Parameters ===
 
−
<code>|caption</code><br />
 
−
Setting a "1" value to this parameter will display explaining italic bold text (indicating a current or latest season).<br />
 
−
<code>|valve</code><br />
 
−
Setting a "1" value to this parameter will display a table with the official map colour code partnered with text (explaining colour coding for official maps).<br />
 
−
<code>|pro</code><br />
 
−
Setting a "1" value to this parameter will display a table with the adapted colour code partnered with text (explaining colour coding for adapted or "pro" maps).<br /><br />
 
−
There are no additional note parameters.
 
−
=== Example ===
 
−
<pre>{{MapLeagueInclusionTable/Key
 
−
| caption = 1
 
−
| valve = 1
 
 
  | pro = 1
 
  | pro = 1
−
}}</pre> '''Will yield:'''
 
−
{{MapLeagueInclusionTable/Key
 
−
| caption = 1
 
−
| valve = 1
 
−
| pro = 1
 
−
}}<!--
 
−
-->
 
−
== Notes ==
 
−
The notes section contains points of clarification that are previously referenced in the table.<br /><br />
 
−
A common note is: ''Map download is in .bz2 format'', cited in the table with the <code>|mapdownloadnote</code> parameter.<br />
 
−
Currently, the only maps that have this note are [[Template:Freight/MapLeagueInclusionTable|cp_freight_b3]] and [[Template:Follower/MapLeagueInclusionTable|cp_follower_rc1]].
 
−
=== Parameters ===
 
−
<code>|number</code><br />
 
−
Setting any value to this parameter will display the value in superscript.<br />
 
−
<code>|content</code><br />
 
−
Setting text to this parameter will display the content of the note (what is being referenced/clarified) in small text.<br />
 
−
<br />
 
−
There are no note parameters for this template.
 
−
=== Example ===
 
−
<pre>{{MapLeagueInclusionTable/Note
 
−
| number = 1
 
−
| content = ETF2L is a big league
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 2
 
−
| content =  Map download is in .bz2 format
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 3
 
−
| content = Wowie this is the 4th season of ETF2L
 
−
}}</pre> '''Will yield:'''
 
−
{{MapLeagueInclusionTable/Note
 
−
| number = 1
 
−
| content = ETF2L is a big league
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 2
 
−
| content =  Map download is in .bz2 format
 
−
}}{{MapLeagueInclusionTable/Note
 
−
| number = 3
 
−
| content = Wowie this is the 4th season of ETF2L
 
 
}}
 
}}
−
 
+
<noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]]</noinclude>
−
<noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]][[Category:MapLeagueInclusionTable Documentation Templates]]</noinclude>
 

Latest revision as of 13:17, 18 September 2020

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:

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

General info[edit]

  • All parameters are in lowercase characters
  • The current leagues available to include are UGC (4v4), UGC (6v6), ETF2L (6v6), ESEA (6v6), ozfortress (6v6), AsiaFortress (6v6), UGC (HL) and ETF2L (HL)
  • A full table example is listed at the bottom of this page

Table cross-section[edit]

Purple 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

Seasonal Inclusions by League
Map name 4v4 6v6 7v7 Highlander
UGC-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png RGL
DownloadIcon.png cp_cheeseburger Season 1 Season 2 Season 3 Season 4 Season 5 Season 6 Season 7 Season 8 Season 9 Season 10 Season 11
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 1 out of 6 2 out of 7 2 out of 8 1 out of 9 1 out of 10 1 out of 11

Italic bold denotes the current or latest season

Official map
Adapted or 'pro' version

Template:MapLeagueInclusionTable/Header[edit]

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, |rgl6s, |af6s, |rgl7s, |ugchl|etf2lhl and |rglhl,

Example[edit]

{{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-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png RGL

Template:MapLeagueInclusionTable/Row/Map[edit]

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[edit]

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

There are 6 maps with no download links:

  • koth_lakeside.bsp.bz2
  • cp_logjam.bsp.bz2*
  • cp_obscure_remake.bsp.bz2
  • cp_obscure.bsp.bz2
  • cp_standin_rc5.bsp.bz2
  • cp_yukon.bsp.bz2

*This could be due to an archiving error by ETF2L, meaning a different map version is the correct map at hand

Template:MapLeagueInclusionTable/Row/Info[edit]

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-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png 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-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png 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[edit]

{{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-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png RGL
Download Link 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[edit]

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

There is also a 'key' section to the footer which is used as a legend to explain colours/text formatting used in the table.

Parameters:
|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
  • The caption (saying "Italic bold denotes the current or latest season") is controlled by Template:Current Rotations and is updated in conjunction with that template.

Example[edit]

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

Will yield:

Seasonal Inclusions by League
[view] Map version 4v4 6v6 Prolander Highlander
UGC-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png 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

Full table example[edit]

{{MapLeagueInclusionTable/Header
 | ugc4s = 1
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = pro
 | mapdownload = Main Page
 | 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
 | official = 1
 | pro = 1
}}

Will yield:

Seasonal Inclusions by League
[view] Map version 4v4 6v6 Prolander Highlander
UGC-Icon2.png UGC UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L EseaLogo.png ESEA Ozfortress Icon.png ozfortress RGL Icon.png RGL AsiaFortress-Icon.png AsiaFortress RGL Icon.png RGL UGC-Icon2.png UGC ETF2L-Icon2.png ETF2L RGL Icon.png RGL
Download Link 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
Retrieved from "http://comp.tf/index.php?title=Template:MapLeagueInclusionTable/Header/doc&oldid=65577"