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: | ||
| − | + | 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 /><!-- | |
| − | This table was made to show a map's inclusions in the map pool of various leagues and in various seasons. The current templates | + | --> |
| − | + | == Associated templates == | |
| − | * [[Template:MapLeagueInclusionTable/ | + | The current templates associated with creating a Map League Inclusion Table are: |
| − | * [[Template:MapLeagueInclusionTable/Row | + | * [[Template:MapLeagueInclusionTable/Header]] |
| + | * [[Template:MapLeagueInclusionTable/Row]] | ||
* [[Template:MapLeagueInclusionTable/Footer]] | * [[Template:MapLeagueInclusionTable/Footer]] | ||
| − | + | * [[Template:MapLeagueInclusionTable/Note]] | |
| − | + | * [[Template:MapLeagueInclusionTable/Key]] | |
| − | + | These templates can also be found in [[:Category:MapLeagueInclusionTable Base Templates]].<!-- | |
| − | + | --> | |
| − | == General | + | == 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), | + | * 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) | |
| − | + | === Full table example === | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
<pre>{{MapLeagueInclusionTable/Header | <pre>{{MapLeagueInclusionTable/Header | ||
| − | | | + | | ugc4s = 1 |
| − | |||
| esea6s = 1 | | esea6s = 1 | ||
| ozf6s = 1 | | ozf6s = 1 | ||
| − | + | | etf2lhl = 1 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
| − | {{MapLeagueInclusionTable/Row | + | {{MapLeagueInclusionTable/Row |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| maptype = pro | | maptype = pro | ||
| mapdownload = comp.tf | | mapdownload = comp.tf | ||
| + | | mapdownloadnote = 1 | ||
| mapname = cp_cheeseburger_pro_v42 | | mapname = cp_cheeseburger_pro_v42 | ||
| − | | | + | | mapspan = 1 |
| − | |||
| − | |||
| ugc4s = 5 | | ugc4s = 5 | ||
| esea6s = 0 | | esea6s = 0 | ||
| Line 236: | Line 33: | ||
| etf2lhl = 7 | | etf2lhl = 7 | ||
}} | }} | ||
| − | {{MapLeagueInclusionTable/Row | + | {{MapLeagueInclusionTable/Row |
| − | | maptype = | + | | maptype = valve |
| mapname = cp_cheeseburger | | mapname = cp_cheeseburger | ||
| maplink = Main Page | | maplink = Main Page | ||
| − | | | + | | mapspan = 1 |
| − | |||
| − | |||
| ugc4s = 4 | | ugc4s = 4 | ||
| esea6s = 17 | | esea6s = 17 | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| ozf6s = 0 | | ozf6s = 0 | ||
| etf2lhl = 0 | | etf2lhl = 0 | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{MapLeagueInclusionTable/Footer | {{MapLeagueInclusionTable/Footer | ||
| − | | | + | | ugc4s = 2 |
| − | | | + | | esea6s = 1 |
| − | | | + | | ozf6s = 1 |
| − | | | + | | etf2lhl = 1 |
| − | | | + | }}{{MapLeagueInclusionTable/Key |
| + | | 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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| ugc4s = 1 | | ugc4s = 1 | ||
| esea6s = 1 | | esea6s = 1 | ||
| Line 297: | Line 62: | ||
| etf2lhl = 1 | | etf2lhl = 1 | ||
}} | }} | ||
| − | {{MapLeagueInclusionTable/Row | + | {{MapLeagueInclusionTable/Row |
| maptype = pro | | maptype = pro | ||
| − | | mapdownload = | + | | mapdownload = comp.tf |
| + | | mapdownloadnote = 1 | ||
| mapname = cp_cheeseburger_pro_v42 | | mapname = cp_cheeseburger_pro_v42 | ||
| − | | | + | | mapspan = 1 |
| − | |||
| − | |||
| ugc4s = 5 | | ugc4s = 5 | ||
| esea6s = 0 | | esea6s = 0 | ||
| Line 309: | Line 73: | ||
| etf2lhl = 7 | | etf2lhl = 7 | ||
}} | }} | ||
| − | {{MapLeagueInclusionTable/Row | + | {{MapLeagueInclusionTable/Row |
| − | | maptype = | + | | maptype = valve |
| mapname = cp_cheeseburger | | mapname = cp_cheeseburger | ||
| maplink = Main Page | | maplink = Main Page | ||
| − | | | + | | mapspan = 1 |
| − | |||
| − | |||
| ugc4s = 4 | | ugc4s = 4 | ||
| esea6s = 17 | | esea6s = 17 | ||
| Line 326: | Line 88: | ||
| ozf6s = 1 | | ozf6s = 1 | ||
| etf2lhl = 1 | | etf2lhl = 1 | ||
| − | | | + | }}{{MapLeagueInclusionTable/Key |
| + | | 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 | ||
| − | | ugc4s = 1 | + | | 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 | ||
| + | }}<!-- | ||
| + | --> | ||
| + | == 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 | | esea6s = 1 | ||
| ozf6s = 1 | | ozf6s = 1 | ||
| − | | | + | | ugchl = 1 |
}} | }} | ||
| − | {{MapLeagueInclusionTable/ | + | |}</pre> '''Will yield:''' |
| − | | | + | {{MapLeagueInclusionTable/Header |
| − | | | + | | ugc6s = 1 |
| − | | | + | | etf2l6s = 1 |
| − | | | + | | esea6s = 1 |
| + | | ozf6s = 1 | ||
| + | | ugchl = 1 | ||
}} | }} | ||
| − | + | |}<!-- | |
| − | + | --> | |
| − | + | == Row == | |
| − | + | The row contains the main information of the table; map type, map download, map name and, of course, each seasonal inclusion. | |
| − | + | === Parameters === | |
| − | + | ||
| − | + | == 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. | |
| − | {{MapLeagueInclusionTable/ | + | ==== Note parameters ==== |
| − | | | + | Excluding the above parameters, the other note parameters are: |
| − | | esea6s = | + | <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> |
| − | | ozf6s = | + | === Example === |
| − | | | + | <pre>{{MapLeagueInclusionTable/Header |
| + | | ugc6s = 1 | ||
| + | | etf2l6s = 1 | ||
| + | | esea6s = 1 | ||
| + | | ozf6s = 1 | ||
| + | | ugchl = 1 | ||
}} | }} | ||
{{MapLeagueInclusionTable/Footer | {{MapLeagueInclusionTable/Footer | ||
| − | | | + | | 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 | ||
| − | | | + | | ugchl = 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 | ||
| + | }}</pre> '''Will yield:''' | ||
| + | {{MapLeagueInclusionTable/Key | ||
| + | | caption = 1 | ||
| + | | valve = 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 /> | ||
| + | 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 Base Templates]]</noinclude> | ||
