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__ | ||
| + | {{GarlicAmbox | documentation}} | ||
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 current templates used to make a table are: | ||
* Template:MapLeagueInclusionTable/Header | * Template:MapLeagueInclusionTable/Header | ||
| Line 5: | Line 6: | ||
* [[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 /> | ||
| + | All templates can be found here: '''[[:Category:MapLeagueInclusionTable Templates]]'''<br /> | ||
Each individual map's table templates can be found here: '''[[:Category:MapLeagueInclusionTable Map Templates]]'''<br /> | Each individual map's table templates can be found here: '''[[:Category:MapLeagueInclusionTable Map Templates]]'''<br /> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== 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>| | + | <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 47: | ||
=== Finding a map download link === | === Finding a map download link === | ||
| − | The preferable download is a direct link with the map in .bsp | + | The preferable download is a direct link with the map in .bsp format (no file compression). Searching for the map's .bsp file name ''(e.g. koth_product_rc8.bsp)'' can often find a website with a download link, make sure that the download is indeed .bsp format and is trustworthy. Copying the website's download link address will give you the URL for the <code>|mapdownload</code> parameter.<br /><br /> |
| + | If .bsp download cannot be found, usually there will be a .bz2 format download. If so, use the .bz2 URL for the table's download link and note that the download is in .bz2 format with the /Note template (more information on adding notes can be found down the page). The common note is: "Map download is in .bz2 format (must be extracted)".<br /><br /> | ||
| + | If no download can be found, do not set the download parameter to any value/URL. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== [[Template:MapLeagueInclusionTable/Row/Info]] == | == [[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 179: | ||
* 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 | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Example === | === Example === | ||
| Line 277: | Line 187: | ||
| esea6s = 3 | | esea6s = 3 | ||
| ozf6s = 4 | | ozf6s = 4 | ||
| − | |||
| − | |||
}}</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 194: | ||
| 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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{MapLeagueInclusionTable/ | ||
| − | |||
| − | |||
| − | |||
| − | | | ||
| official = 1 | | official = 1 | ||
| pro = 1 | | pro = 1 | ||
}}</pre> '''Will yield:''' | }}</pre> '''Will yield:''' | ||
| − | {{MapLeagueInclusionTable/ | + | {{MapLeagueInclusionTable/Key |
| − | | | + | | caption = 1 |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| official = 1 | | official = 1 | ||
| pro = 1 | | pro = 1 | ||
}} | }} | ||
| − | <noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]]</noinclude> | + | |
| + | == [[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> | ||
| + | |||
| + | <noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]][[Category:MapLeagueInclusionTable Documentation Templates]]</noinclude> | ||
