Editing Template:MapLeagueInclusionTable/Header/doc

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page is not enabled for semantic in-text annotations due to namespace restrictions. Details about how to enable the namespace can be found on the configuration help page.

Latest revision Your text
Line 1: Line 1:
 
__NOTOC__
 
__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:
+
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.<!--
* Template:MapLeagueInclusionTable/Header
+
-->
* [[Template:MapLeagueInclusionTable/Row/Map]]
+
== Associated templates ==
* [[Template:MapLeagueInclusionTable/Row/Info]]
+
The current templates associated with creating a Map League Inclusion Table are:
 +
* [[Template:MapLeagueInclusionTable/Header]]
 +
* [[Template:MapLeagueInclusionTable/Row]]
 
* [[Template:MapLeagueInclusionTable/Footer]]
 
* [[Template:MapLeagueInclusionTable/Footer]]
These templates can be found here: '''[[:Category:MapLeagueInclusionTable Base Templates]]'''<br />
+
* [[Template:MapLeagueInclusionTable/Note]]
Each individual map's table templates can be found here: '''[[:Category:MapLeagueInclusionTable Map Templates]]'''<br />
+
* [[Template:MapLeagueInclusionTable/Key]]
All templates can be found here: '''[[:Category:MapLeagueInclusionTable Templates]]'''
+
These templates can also be found in [[:Category:MapLeagueInclusionTable Base Templates]].<!--
 
+
-->
== General info ==
+
== General information ==
 
* All parameters are in lowercase characters
 
* 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)
+
* The generic makeup of a table consists of 1 Header, at least 1 Row, 1 Footer, 1 Note (optional) and 1 Key (optional)
* A full table example is listed at the bottom of this page
+
* 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)
== Table cross-section ==
+
=== Full table example ===
'''<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
+
  | ugc4s = 1
| etf2l6s = 1
 
 
  | esea6s = 1
 
  | esea6s = 1
 
  | ozf6s = 1
 
  | ozf6s = 1
  | ugchl = 1
+
  | etf2lhl = 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
 
| etf2l6s = 1
 
| esea6s = 1
 
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
| 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
 
  | maptype = pro
 
  | mapdownload = comp.tf
 
  | mapdownload = comp.tf
 +
| mapdownloadnote = 1
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
 
  | maprowspan = 1
 
  | maprowspan = 1
}}
 
{{MapLeagueInclusionTable/Row/Info
 
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 205: Line 34:
 
  | etf2lhl = 7
 
  | etf2lhl = 7
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
 
  | maptype = official
 
  | maptype = official
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 
  | maplink = Main Page
 
  | maplink = Main Page
  | maprowspan = 2
+
  | maprowspan = 1
}}
 
{{MapLeagueInclusionTable/Row/Info
 
 
  | ugc4s = 4
 
  | ugc4s = 4
 
  | esea6s = 17
 
  | esea6s = 17
  | ozf6s = 13
+
  | ozf6s = 0
 
  | etf2lhl = 0
 
  | etf2lhl = 0
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Info
+
{{MapLeagueInclusionTable/Footer
  | ugc4s = 0
+
  | ugc4s = 2
  | esea6s = 16
+
  | esea6s = 1
  | ozf6s = 0
+
  | ozf6s = 1
  | etf2lhl = 0
+
  | etf2lhl = 1
}}</pre></small> '''Will yield:'''
+
}}{{MapLeagueInclusionTable/Key
{{MapLeagueInclusionTable/Header |ugc4s = 1 |esea6s = 1 |ozf6s = 1 |etf2lhl = 1}}
+
| caption = 1
{{MapLeagueInclusionTable/Row/Map
+
| official = 1
 +
| pro = 1
 +
}}{{MapLeagueInclusionTable/Note
 +
| number = 1
 +
| content = Map download is in .bz2 format
 +
}}</pre> '''Will yield:'''
 +
{{MapLeagueInclusionTable/Header
 +
| ugc4s = 1
 +
| esea6s = 1
 +
| ozf6s = 1
 +
| etf2lhl = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row
 
  | maptype = pro
 
  | maptype = pro
 
  | mapdownload = comp.tf
 
  | mapdownload = comp.tf
 +
| mapdownloadnote = 1
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
 
  | maprowspan = 1
 
  | maprowspan = 1
}}
 
{{MapLeagueInclusionTable/Row/Info
 
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 236: Line 74:
 
  | etf2lhl = 7
 
  | etf2lhl = 7
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
 
  | maptype = official
 
  | maptype = official
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 
  | maplink = Main Page
 
  | maplink = Main Page
  | maprowspan = 2
+
  | maprowspan = 1
}}
 
{{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
  | ugc6s = 1
+
  | ugc4s = 2
  | etf2l6s = 2
+
| esea6s = 1
  | esea6s = 3
+
  | ozf6s = 1
  | ozf6s = 4
+
  | etf2lhl = 1
 +
}}{{MapLeagueInclusionTable/Key
 +
  | caption = 1
 
  | official = 1
 
  | official = 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 |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
+
{{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
 
{{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
 +
}}<!--
 +
-->
 +
== 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
 
  | ugc6s = 1
  | etf2l6s = 2
+
  | etf2l6s = 1
  | esea6s = 3
+
| esea6s = 1
  | ozf6s = 4
+
| ozf6s = 1
  | official = 1
+
| ugchl = 1
  | pro = 1
+
}}
 +
|}</pre> '''Will yield:'''
 +
{{MapLeagueInclusionTable/Header
 +
| ugc6s = 1
 +
| etf2l6s = 1
 +
| esea6s = 1
 +
| ozf6s = 1
 +
| ugchl = 1
 +
}}
 +
|}<!--
 +
-->
 +
== Row ==
 +
'''Note:''' The row template cannot be used for multiple rows, only one horizontal row.
 +
=== Header cell ===
 +
The header cell of the row contains any information not involving each seasonal inclusion; namely the map's type, name, download link, wiki page link and rowspan.
 +
==== Parameters ====
 +
<code>|maptype</code> - The coloured ribbon which indicates the map's type. The map type parameter must be set to a value, it can be set to:
 +
* '''normal''' - Sets the ribbon colour to the background colour of the table, making the ribbon invisible
 +
* '''official''' - Sets the ribbon colour to grey (#4F4F4F)
 +
* '''pro''' - Sets the ribbon colour to green (#F2F2F2)
 +
<code>|mapname</code> - The file name for the map version. Any set value will appear as bold.<br />
 +
<code>|mapdownload</code> - The download link for the map version.<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, should be set to the maximum amount of inclusions in a single league for the row's map version. Must be set to a value (can be set to 1), and if set to more that one the respective following rows will not need a header cell ''(e.g. if set to 3, the next 2 row will not need header cells)''.
 +
==== Note parameters ====
 +
The only two note parameters for the header cell of a row are:<br />
 +
<code>|mapnamenote</code> and <code>|mapdownloadnote</code>
 +
=== Information cells ===
 +
The information cells of the row contains each seasonal inclusion for a map.
 +
==== Parameters ====
 +
<code>|ugc4s</code>, <code>|ugc6s</code>, <code>|etf2l6s</code>, <code>|esea6s</code>, <code>|ozf6s</code>, <code>|ugchl</code>, and <code>|etf2hl</code>
 +
These parameters should be set to the season numbers the map version of the row is included in. They will automatically link to any associated season page on the wiki.<br />
 +
There are no additional note parameters.
 +
==== Important notes ====
 +
* These parameters cannot be left without a value. If there is not seasonal inclusion, setting the parameter to 0 will leave it blank.
 +
* If adding a row to an existing table, information from the following row may have to be transferred to the added row in order to keep the table correct.
 +
* Seasonal inclusions for a map version with multiple rows should always be pushed to the top. For example:
 +
{{MapLeagueInclusionTable/Header
 +
| ugc4s = 1
 +
| esea6s = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = normal
 +
| mapname = cp_cheeseburger_pro_v42
 +
| maprowspan = 2
 +
| ugc4s = 5
 +
  | esea6s = 0
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
  | ugc4s = 4
 +
  | esea6s = 17
 +
}}|}
 +
Is incorrect, as the ESEA6s column has an inclusion at the bottom of the row. The following is a correct version:
 +
{{MapLeagueInclusionTable/Header
 +
| ugc4s = 1
 +
  | esea6s = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = normal
 +
| mapname = cp_cheeseburger_pro_v42
 +
| maprowspan = 2
 +
| ugc4s = 5
 +
| esea6s = 17
 
}}
 
}}
 +
{{MapLeagueInclusionTable/Row
 +
| ugc4s = 4
 +
| esea6s = 0
 +
}}|}
  
== Full table example ==
+
=== Example ===
 
<pre>{{MapLeagueInclusionTable/Header
 
<pre>{{MapLeagueInclusionTable/Header
 
  | ugc4s = 1
 
  | ugc4s = 1
Line 297: Line 243:
 
  | etf2lhl = 1
 
  | etf2lhl = 1
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
 
  | maptype = pro
 
  | maptype = pro
  | mapdownload = Main Page
+
  | mapdownload = comp.tf
 +
| mapdownloadnote = 1
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
  | maprowspan = 1
+
  | maprowspan = 2
}}
 
{{MapLeagueInclusionTable/Row/Info
 
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 309: Line 254:
 
  | etf2lhl = 7
 
  | etf2lhl = 7
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
 +
| ugc4s = 4
 +
| esea6s = 0
 +
| ozf6s = 13
 +
| etf2lhl = 0
 +
}}
 +
{{MapLeagueInclusionTable/Row
 
  | maptype = official
 
  | maptype = official
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 +
| mapnamenote = 2
 
  | maplink = Main Page
 
  | maplink = Main Page
 
  | maprowspan = 1
 
  | maprowspan = 1
}}
+
| ugc4s = 3
{{MapLeagueInclusionTable/Row/Info
+
  | ugc4snote = 3
  | ugc4s = 4
 
 
  | esea6s = 17
 
  | esea6s = 17
 
  | ozf6s = 0
 
  | ozf6s = 0
 
  | etf2lhl = 0
 
  | etf2lhl = 0
 
}}
 
}}
{{MapLeagueInclusionTable/Footer
+
|}</pre> '''Will yield:'''
| ugc4s = 2
 
| esea6s = 1
 
| ozf6s = 1
 
| etf2lhl = 1
 
| official = 1
 
| pro = 1
 
}}</pre> '''Will yield:'''
 
 
{{MapLeagueInclusionTable/Header
 
{{MapLeagueInclusionTable/Header
 
  | ugc4s = 1
 
  | ugc4s = 1
Line 335: Line 279:
 
  | etf2lhl = 1
 
  | etf2lhl = 1
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
 
  | maptype = pro
 
  | maptype = pro
  | mapdownload = Main Page
+
  | mapdownload = comp.tf
 +
| mapdownloadnote = 1
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
  | maprowspan = 1
+
  | maprowspan = 2
}}
 
{{MapLeagueInclusionTable/Row/Info
 
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 347: Line 290:
 
  | etf2lhl = 7
 
  | etf2lhl = 7
 
}}
 
}}
{{MapLeagueInclusionTable/Row/Map
+
{{MapLeagueInclusionTable/Row
 +
| ugc4s = 4
 +
| esea6s = 0
 +
| ozf6s = 13
 +
| etf2lhl = 0
 +
}}
 +
{{MapLeagueInclusionTable/Row
 
  | maptype = official
 
  | maptype = official
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 +
| mapnamenote = 2
 
  | maplink = Main Page
 
  | maplink = Main Page
 
  | maprowspan = 1
 
  | maprowspan = 1
}}
+
| ugc4s = 3
{{MapLeagueInclusionTable/Row/Info
+
  | ugc4snote = 3
  | ugc4s = 4
 
 
  | esea6s = 17
 
  | esea6s = 17
 
  | ozf6s = 0
 
  | ozf6s = 0
 
  | etf2lhl = 0
 
  | 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
  | ugc4s = 2
+
  | ugc6s = 9
 +
| 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
  | etf2lhl = 1
+
  | ugchl = 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>|official</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
 +
| official = 1
 +
| pro = 1
 +
}}</pre> '''Will yield:'''
 +
{{MapLeagueInclusionTable/Key
 +
| caption = 1
 
  | official = 1
 
  | official = 1
 
  | pro = 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 />
 +
=== 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>

Please note that all contributions to comp.tf may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see comp.tf:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)