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

From comp.tf
Jump to navigation Jump to search
m (Changed category to MapLeagueInclusionTable Documentaion Templates)
m (Finished documentation)
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 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.<!--
 
-->
 
-->
 
== Associated templates ==
 
== Associated templates ==
Line 27: Line 28:
 
  | mapdownloadnote = 1
 
  | mapdownloadnote = 1
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
−
  | mapspan = 1
+
  | maprowspan = 1
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 37: Line 38:
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 
  | maplink = Main Page
 
  | maplink = Main Page
−
  | mapspan = 1
+
  | maprowspan = 1
 
  | ugc4s = 4
 
  | ugc4s = 4
 
  | esea6s = 17
 
  | esea6s = 17
Line 67: Line 68:
 
  | mapdownloadnote = 1
 
  | mapdownloadnote = 1
 
  | mapname = cp_cheeseburger_pro_v42
 
  | mapname = cp_cheeseburger_pro_v42
−
  | mapspan = 1
+
  | maprowspan = 1
 
  | ugc4s = 5
 
  | ugc4s = 5
 
  | esea6s = 0
 
  | esea6s = 0
Line 77: Line 78:
 
  | mapname = cp_cheeseburger
 
  | mapname = cp_cheeseburger
 
  | maplink = Main Page
 
  | maplink = Main Page
−
  | mapspan = 1
+
  | maprowspan = 1
 
  | ugc4s = 4
 
  | ugc4s = 4
 
  | esea6s = 17
 
  | esea6s = 17
Line 178: Line 179:
 
-->
 
-->
 
== Row ==
 
== Row ==
−
The row contains the main information of the table; map type, map download, map name and, of course, each seasonal inclusion.
+
'''Note:''' The row template cannot be used for multiple rows, only one horizontal row.
−
=== Parameters ===
+
=== 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
 +
* '''valve''' - 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
 +
}}|}
  
 +
=== Example ===
 +
<pre>{{MapLeagueInclusionTable/Header
 +
| ugc4s = 1
 +
| esea6s = 1
 +
| ozf6s = 1
 +
| etf2lhl = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = pro
 +
| mapdownload = comp.tf
 +
| mapdownloadnote = 1
 +
| mapname = cp_cheeseburger_pro_v42
 +
| maprowspan = 2
 +
| ugc4s = 5
 +
| esea6s = 0
 +
| ozf6s = 14
 +
| etf2lhl = 7
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| ugc4s = 4
 +
| esea6s = 0
 +
| ozf6s = 13
 +
| etf2lhl = 0
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = valve
 +
| mapname = cp_cheeseburger
 +
| mapnamenote = 2
 +
| maplink = Main Page
 +
| maprowspan = 1
 +
| ugc4s = 3
 +
| ugc4snote = 3
 +
| esea6s = 17
 +
| ozf6s = 0
 +
| etf2lhl = 0
 +
}}
 +
|}</pre> '''Will yield:'''
 +
{{MapLeagueInclusionTable/Header
 +
| ugc4s = 1
 +
| esea6s = 1
 +
| ozf6s = 1
 +
| etf2lhl = 1
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = pro
 +
| mapdownload = comp.tf
 +
| mapdownloadnote = 1
 +
| mapname = cp_cheeseburger_pro_v42
 +
| maprowspan = 2
 +
| ugc4s = 5
 +
| esea6s = 0
 +
| ozf6s = 14
 +
| etf2lhl = 7
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| ugc4s = 4
 +
| esea6s = 0
 +
| ozf6s = 13
 +
| etf2lhl = 0
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = valve
 +
| mapname = cp_cheeseburger
 +
| mapnamenote = 2
 +
| maplink = Main Page
 +
| maprowspan = 1
 +
| ugc4s = 3
 +
| ugc4snote = 3
 +
| esea6s = 17
 +
| ozf6s = 0
 +
| etf2lhl = 0
 +
}}
 +
|}
 
== Footer ==
 
== Footer ==
 
The footer shows the total inclusions of a map in each individual league. The total overall seasons (second value shown) is calculated automatically.
 
The footer shows the total inclusions of a map in each individual league. The total overall seasons (second value shown) is calculated automatically.
Line 245: Line 373:
 
The notes section contains points of clarification that are previously referenced in the table.<br /><br />
 
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 />
 
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 ===
 
=== Parameters ===
 
<code>|number</code><br />
 
<code>|number</code><br />

Revision as of 02:35, 26 September 2015

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.

Associated templates

The current templates associated with creating a Map League Inclusion Table are:

These templates can also be found in Category:MapLeagueInclusionTable Base Templates.

General information

  • 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 Winter League (6v6), UGC (HL) and ETF2L (HL)
  • Any parameter with "ozf6s" denotes the Ozfortress Winter League (OWL)

Full table example

{{MapLeagueInclusionTable/Header
 | ugc4s = 1
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}
{{MapLeagueInclusionTable/Row
 | maptype = pro
 | mapdownload = comp.tf
 | mapdownloadnote = 1
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 1
 | ugc4s = 5
 | esea6s = 0
 | ozf6s = 14
 | etf2lhl = 7
}}
{{MapLeagueInclusionTable/Row
 | maptype = valve
 | mapname = cp_cheeseburger
 | maplink = Main Page
 | maprowspan = 1
 | ugc4s = 4
 | esea6s = 17
 | ozf6s = 0
 | etf2lhl = 0
}}
{{MapLeagueInclusionTable/Footer
 | ugc4s = 2
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}{{MapLeagueInclusionTable/Key
 | caption = 1
 | valve = 1
 | pro = 1
}}{{MapLeagueInclusionTable/Note
 | number = 1
 | content = Map download is in .bz2 format
}}

Will yield:

Template:MapLeagueInclusionTable/RowTemplate:MapLeagueInclusionTable/Row
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 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

Template:MapLeagueInclusionTable/KeyTemplate:MapLeagueInclusionTable/Note

"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.
Note: numbers should be consecutively ordered from top left of the table to bottom right.

Example

{{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
}}

Will yield:

Template:MapLeagueInclusionTable/Row
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 out of 41 1 out of 46 out of 30 out of 38 out of 21 out of 13 out of 10 out of 39 out of 30 out of 16

Template:MapLeagueInclusionTable/NoteTemplate:MapLeagueInclusionTable/NoteTemplate:MapLeagueInclusionTable/Note

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:
|ugc4s, |ugc6s, |etf2l6s, |esea6s, |ozf6s, |ugchl, and |etf2lhl
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: |mapnamenote, |4v4note, |6v6note, and |highlandernote

Example

{{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

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

|maptype - 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
  • valve - Sets the ribbon colour to grey (#4F4F4F)
  • pro - Sets the ribbon colour to green (#F2F2F2)

|mapname - The file name for the map version. Any set value will appear as bold.
|mapdownload - The download link for the map version.
|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, 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:
|mapnamenote and |mapdownloadnote

Information cells

The information cells of the row contains each seasonal inclusion for a map.

Parameters

|ugc4s, |ugc6s, |etf2l6s, |esea6s, |ozf6s, |ugchl, and |etf2hl 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.
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:
Template:MapLeagueInclusionTable/RowTemplate:MapLeagueInclusionTable/Row|} Is incorrect, as the ESEA6s column has an inclusion at the bottom 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
Template:MapLeagueInclusionTable/RowTemplate:MapLeagueInclusionTable/Row|}

Example

{{MapLeagueInclusionTable/Header
 | ugc4s = 1
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}
{{MapLeagueInclusionTable/Row
 | maptype = pro
 | mapdownload = comp.tf
 | mapdownloadnote = 1
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 2
 | ugc4s = 5
 | esea6s = 0
 | ozf6s = 14
 | etf2lhl = 7
}}
{{MapLeagueInclusionTable/Row
 | ugc4s = 4
 | esea6s = 0
 | ozf6s = 13
 | etf2lhl = 0
}}
{{MapLeagueInclusionTable/Row
 | maptype = valve
 | mapname = cp_cheeseburger
 | mapnamenote = 2
 | maplink = Main Page
 | maprowspan = 1
 | ugc4s = 3
 | ugc4snote = 3
 | esea6s = 17
 | 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
Template:MapLeagueInclusionTable/RowTemplate:MapLeagueInclusionTable/RowTemplate:MapLeagueInclusionTable/Row
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

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:
|ugc4s, |ugc6s, |etf2l6s, |esea6s, |ozf6s, |ugchl, and |etf2lhl
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: |totalinclusionsnote, |ugc4stotalseasonsnote, |ugc6stotalseasonsnote, |etf2l6stotalseasonsnote, |esea6stotalseasonsnote, |ozf6stotalseasonsnote, |ugchltotalseasonsnote, and |etf2lhltotalseasonsnote

Example

{{MapLeagueInclusionTable/Header
 | ugc6s = 1
 | etf2l6s = 1
 | esea6s = 1
 | ozf6s = 1
 | ugchl = 1
}}
{{MapLeagueInclusionTable/Footer
 | ugc6s = 9
 | etf2l6s = 7
 | esea6s = 4
 | ozf6s = 4
 | ugchl = 3
}}

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 9 out of 41 7 out of 46 4 out of 30 4 out of 38 out of 21 out of 13 out of 10 3 out of 39 out of 30 out of 16

Key

The key section is a legend to explain colours/text formatting used in the table.

Parameters

|caption
Setting a "1" value to this parameter will display explaining italic bold text (indicating a current or latest season).
|valve
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).
|pro
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).

There are no additional note parameters.

Example

{{MapLeagueInclusionTable/Key
 | caption = 1
 | valve = 1
 | pro = 1
}}

Will yield:

Template:MapLeagueInclusionTable/Key

Notes

The notes section contains points of clarification that are previously referenced in the table.

A common note is: Map download is in .bz2 format, cited in the table with the |mapdownloadnote parameter.

Parameters

|number
Setting any value to this parameter will display the value in superscript.
|content
Setting text to this parameter will display the content of the note (what is being referenced/clarified) in small text.

There are no note parameters for this template.

Example

{{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
}}

Will yield:

Template:MapLeagueInclusionTable/NoteTemplate:MapLeagueInclusionTable/NoteTemplate:MapLeagueInclusionTable/Note

Retrieved from "http://comp.tf/index.php?title=Template:MapLeagueInclusionTable/Header/doc&oldid=19955"