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 5: Line 5:
 
* [[Template:MapLeagueInclusionTable/Row/Info]]
 
* [[Template:MapLeagueInclusionTable/Row/Info]]
 
* [[Template:MapLeagueInclusionTable/Footer]]
 
* [[Template:MapLeagueInclusionTable/Footer]]
 +
* [[Template:MapLeagueInclusionTable/Note]]
 +
* [[Template:MapLeagueInclusionTable/Key]]
 
These templates can be found here: '''[[:Category:MapLeagueInclusionTable Base Templates]]'''<br />
 
These templates can be found here: '''[[:Category:MapLeagueInclusionTable Base Templates]]'''<br />
Each individual map's table templates can be found here: '''[[:Category:MapLeagueInclusionTable Map Templates]]'''<br />
+
All templates can be found here: '''[[:Category:MapLeagueInclusionTable Templates]]'''<br />
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 ==
 
== General info ==
 
* 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)
 +
* 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
 
* A full table example is listed at the bottom of this page
  
 
== Table cross-section ==
 
== Table cross-section ==
'''<font color="#E0CEF2">Purple</font>'''  sections are controlled by Template:MapLeagueInclusionTable/Header<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="#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="#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="#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;"
 
{| class="wikitable" style="text-align: center;"
|+ <font color="#E0CEF2">Seasonal Inclusions by League</font>
+
  ! rowspan="2" colspan="3" style="color: white; background-color: #CEF2E0; width: 22px;" | Map name
  ! rowspan="2" colspan="3" style="color: white; background-color: #E0CEF2; width: 22px;" | Map name
+
  ! style="color: white; background-color: #CEF2E0;" colspan="1 | 4v4
  ! style="color: white; background-color: #E0CEF2;" colspan="1 | 4v4
+
  ! style="color: white; background-color: #CEF2E0;" colspan="4" | 6v6
  ! style="color: white; background-color: #E0CEF2;" colspan="6" | 6v6
+
  ! style="color: white; background-color: #CEF2E0;" colspan="2" | Highlander
  ! 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: #CEF2E0; width:100px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
  ! style="background-color: #E0CEF2; width:110px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
+
  ! style="background-color: #CEF2E0; width:100px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
  ! style="background-color: #E0CEF2; width:110px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
+
  ! style="background-color: #CEF2E0; width:100px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
  ! style="background-color: #E0CEF2; width:110px;" | [[File:EseaLogo.png | 20px | link=]] [[ESEA]]
+
  ! style="background-color: #CEF2E0; width:100px;" | [[File:EseaLogo.png | 20px | link=]] [[ESEA]]
  ! style="background-color: #E0CEF2; width:110px;" | [[File:Ozfortress Icon.png | 20px | link=]] [[Ozfortress|ozfortress]]
+
  ! style="background-color: #CEF2E0; width:100px;" | [[File:Ozfortress icon.png | 20px | link=]] [[ozfortress | {{ abbr | OWL | Ozfortress Winter League}}]]
! style="background-color: #E0CEF2; width:110px;" | [[File:RGL Icon.png | 20px | link=]] [[RGL]]
+
  ! style="background-color: #CEF2E0; width:100px;" | [[File:UGC-Icon.png | 20px | link=]] [[UGC]]
! style="background-color: #E0CEF2; width:110px;" | [[File:AsiaFortress-Icon.png | 20px | link=]] [[AsiaFortress]]
+
  ! style="background-color: #CEF2E0; width:100px;" | [[File:ETF2L-Icon.png | 20px | link=]] [[ETF2L]]
! 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="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="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="border-left: hidden; background-color: #F2E0CE; width: 12px;" rowspan="2" |  
 
  | style="background-color:#F2CEE0" | Season 1
 
  | style="background-color:#F2CEE0" | Season 1
Line 49: Line 48:
 
  | style="background-color:#F2CEE0" | Season 6
 
  | style="background-color:#F2CEE0" | Season 6
 
  | style="background-color:#F2CEE0" | Season 7
 
  | 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" |  
 
  | style="background-color:#F2CEE0" | Season 1
 
  | 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" |  
Line 64: Line 56:
 
  | style="background-color:#F2CEE0" | Season 2
 
  | style="background-color:#F2CEE0" | Season 2
 
  | style="background-color:#F2CEE0" | Season 3
 
  | style="background-color:#F2CEE0" | Season 3
| style="background-color:#F2CEE0" |
 
 
|-
 
|-
 
  ! style="background-color:#CEE0F2; color: white;" colspan="3" | Total inclusions
 
  ! style="background-color:#CEE0F2; color: white;" colspan="3" | Total inclusions
Line 72: Line 63:
 
  ! style="background-color:#CEE0F2" | 1 <small>out of</small> 4
 
  ! 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> 5
  ! style="background-color:#CEE0F2" | 1 <small>out of</small> 6
+
  ! style="background-color:#CEE0F2" | 2 <small>out of</small> 6
 
  ! style="background-color:#CEE0F2" | 2 <small>out of</small> 7
 
  ! 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>
+
<font color="#E0CEF2">'''''Italic bold''''' denotes the current or latest season</font>
 
{| class="wikitable" style="text-align: left;"  
 
{| class="wikitable" style="text-align: left;"  
  | style="width: 20px; height: 20px; background-color: #CEE0F2" |
+
  | style="width: 20px; height: 20px; background-color: #E0CEF2" |
  | style="background-color:#CEE0F2" | Official map
+
| 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: #CEE0F2;" |
+
  | style="width: 20px; height: 20px; background-color: #E0CEF2;" |
  | style="background-color: #CEE0F2" | Adapted or 'pro' version
+
| 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 ==
 
== Template:MapLeagueInclusionTable/Header ==
 
The header defines what leagues will be included in the table.<br />
 
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 />
 
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 />
+
<code>|ugc4s</code>, <code>|ugc6s</code>, <code>|etf2l6s</code>, <code>|esea6s</code>, <code>|ozf6s</code>, <code>|ugchl</code>, and <code>|etf2lhl</code><br />
 
=== Example ===
 
=== Example ===
 
<pre>{{MapLeagueInclusionTable/Header
 
<pre>{{MapLeagueInclusionTable/Header
Line 123: Line 115:
  
 
=== Finding a map download link ===
 
=== 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.
+
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.
  
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]] ==
 
== [[Template:MapLeagueInclusionTable/Row/Info]] ==
 
This controls the cells of the row that contain each seasonal inclusion.<br />
 
This controls the cells of the row that contain each seasonal inclusion.<br />
Line 261: Line 247:
 
* 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)''
 
* 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
 
* 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 ===
 
=== Example ===
Line 277: Line 255:
 
  | esea6s = 3
 
  | esea6s = 3
 
  | ozf6s = 4
 
  | ozf6s = 4
| official = 1
 
| pro = 1
 
 
}}</pre> '''Will yield:'''
 
}}</pre> '''Will yield:'''
 
{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
 
{{MapLeagueInclusionTable/Header |ugc6s = 1 |etf2l6s = 1 |esea6s = 1 |ozf6s = 1 }}
Line 286: Line 262:
 
  | esea6s = 3
 
  | esea6s = 3
 
  | ozf6s = 4
 
  | 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
 
  | official = 1
 
  | pro = 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 ==
 
== Full table example ==
Line 299: Line 353:
 
{{MapLeagueInclusionTable/Row/Map
 
{{MapLeagueInclusionTable/Row/Map
 
  | 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 = 1
Line 326: Line 381:
 
  | ozf6s = 1
 
  | ozf6s = 1
 
  | etf2lhl = 1
 
  | 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 (must be extracted)
 
}}</pre> '''Will yield:'''
 
}}</pre> '''Will yield:'''
 
{{MapLeagueInclusionTable/Header
 
{{MapLeagueInclusionTable/Header
Line 337: Line 397:
 
{{MapLeagueInclusionTable/Row/Map
 
{{MapLeagueInclusionTable/Row/Map
 
  | 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 = 1
Line 364: Line 425:
 
  | ozf6s = 1
 
  | ozf6s = 1
 
  | etf2lhl = 1
 
  | 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 (must be extracted)
 
}}
 
}}
 
<noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]]</noinclude>
 
<noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable 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)