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

From comp.tf
Jump to navigation Jump to search
m (Progress save)
m (Progress save)
Line 1: Line 1:
−
This template was made to show a map's inclusions in the map pool of various leagues and in various seasons. <br /><!--
+
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 /><!--
 
-->
 
-->
 
== Associated templates ==
 
== Associated templates ==
Line 12: Line 12:
 
== General information ==
 
== General information ==
 
* All parameters are in lowercase characters
 
* 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 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)
 
* 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)
 
* Any parameter with "ozf6s" denotes the Ozfortress Winter League (OWL)
−
=== Full table example ===<!--
+
=== Full table 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
 +
| mapspan = 1
 +
| ugc4s = 5
 +
| esea6s = 0
 +
| ozf6s = 14
 +
| etf2lhl = 7
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = valve
 +
| mapname = cp_cheeseburger
 +
| maplink = Main Page
 +
| mapspan = 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
 +
}}</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
 +
| mapspan = 1
 +
| ugc4s = 5
 +
| esea6s = 0
 +
| ozf6s = 14
 +
| etf2lhl = 7
 +
}}
 +
{{MapLeagueInclusionTable/Row
 +
| maptype = valve
 +
| mapname = cp_cheeseburger
 +
| maplink = Main Page
 +
| mapspan = 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
 +
}}<!--
 
-->
 
-->
 
== "Note" parameters ==
 
== "Note" parameters ==
Line 97: Line 177:
 
|}<!--
 
|}<!--
 
-->
 
-->
 +
== Row ==
 +
The row contains the main information of the table; map type, map download, map name and, of course, each seasonal inclusion.
 +
=== Parameters ===
 +
 
== Footer ==
 
== Footer ==
−
The footer shows the total inclusions of a map in each individual league.
+
The footer shows the total inclusions of a map in each individual league. The total overall seasons (second value shown) is calculated automatically.
 
=== Parameters ===
 
=== Parameters ===
 
The following are all potential parameters, and therefore leagues, that can be used:<br />
 
The following are all potential parameters, and therefore leagues, that can be used:<br />
Line 140: Line 224:
 
=== Parameters ===
 
=== Parameters ===
 
<code>|caption</code><br />
 
<code>|caption</code><br />
−
Setting a "1" value to this parameter will display explaining italic bold text (indicating a current or latest season)<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 />
 
<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 />
+
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 />
 
<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 />
+
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 />
−
==== Note parameters ====
+
There are no additional note parameters.
−
There are no additional note parameters
 
 
=== Example ===
 
=== Example ===
 
<pre>{{MapLeagueInclusionTable/Key
 
<pre>{{MapLeagueInclusionTable/Key
Line 160: Line 243:
 
-->
 
-->
 
== Notes ==
 
== Notes ==
−
The notes section contains points of clarification that are previously referenced in the table.  
+
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 ===
 
=== Parameters ===
 
<code>|number</code><br />
 
<code>|number</code><br />

Revision as of 06:51, 4 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
 | mapspan = 1
 | ugc4s = 5
 | esea6s = 0
 | ozf6s = 14
 | etf2lhl = 7
}}
{{MapLeagueInclusionTable/Row
 | maptype = valve
 | mapname = cp_cheeseburger
 | maplink = Main Page
 | mapspan = 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

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:
|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.
Currently, the only maps that have this note are cp_freight_b3 and cp_follower_rc1.

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=18537"