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

From comp.tf
Jump to navigation Jump to search
(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 template was made to show a map's inclusions in the map pool of various leagues and in various seasons. <br /><!--
 +
-->
 
== Associated templates ==
 
== Associated templates ==
 
The current templates associated with creating a Map League Inclusion Table are:
 
The current templates associated with creating a Map League Inclusion Table are:
Line 7: Line 8:
 
* [[Template:MapLeagueInclusionTable/Note]]
 
* [[Template:MapLeagueInclusionTable/Note]]
 
* [[Template:MapLeagueInclusionTable/Key]]
 
* [[Template:MapLeagueInclusionTable/Key]]
−
These templates can also be found in [[:Category:MapLeagueInclusionTable Base Templates]].
+
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 ===<!--
 +
-->
 
== "Note" parameters ==
 
== "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. These note parameters have not been referenced in the rest of the article for repetition's sake.
+
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 ===
 
=== Example ===
 
<pre>{{MapLeagueInclusionTable/Header
 
<pre>{{MapLeagueInclusionTable/Header
−
  | ugc6s = 1
+
  | etf2l6s = 1
−
  | ugc6snote = 1
+
  | etf2l6snote = 1
 
}}
 
}}
 
{{MapLeagueInclusionTable/Row
 
{{MapLeagueInclusionTable/Row
 
  | maptype = normal
 
  | maptype = normal
−
  | mapdownload = http://games.ipgn.com.au/tf2/maps/cp_follower_rc1.bsp.bz2
+
  | mapdownload = http://fastdl.colonslash.eu/maps/cp_freight_b3.bsp.bz2
 
  | mapdownloadnote = 2
 
  | mapdownloadnote = 2
−
  | mapname = cp_follower_rc1
+
  | mapname = cp_freight_b3
−
  | maprowspan = 1
+
  | etf2l6s = 4
−
  | ugc6s = 1
+
  | etf2l6snote = 3
−
| ugc6snote = 3
 
 
}}
 
}}
 
{{MapLeagueInclusionTable/Footer
 
{{MapLeagueInclusionTable/Footer
−
  | ugc6s = 1
+
  | etf2l6s = 1
 
}}{{MapLeagueInclusionTable/Note
 
}}{{MapLeagueInclusionTable/Note
 
  | number = 1
 
  | number = 1
−
  | content = UGC is a big league
+
  | content = ETF2L is a big league
 
}}{{MapLeagueInclusionTable/Note
 
}}{{MapLeagueInclusionTable/Note
 
  | number = 2
 
  | number = 2
Line 35: Line 43:
 
}}{{MapLeagueInclusionTable/Note
 
}}{{MapLeagueInclusionTable/Note
 
  | number = 3
 
  | number = 3
−
  | content = Wowie this is the first season of UGC
+
  | content = Wowie this is the 4th season of ETF2L
−
}}</pre> Will yeild as:
+
}}</pre> '''Will yield:'''
 
{{MapLeagueInclusionTable/Header
 
{{MapLeagueInclusionTable/Header
−
  | ugc6s = 1
+
  | etf2l6s = 1
−
  | ugc6snote = 1
+
  | etf2l6snote = 1
 
}}
 
}}
 
{{MapLeagueInclusionTable/Row
 
{{MapLeagueInclusionTable/Row
 
  | maptype = normal
 
  | maptype = normal
−
  | mapdownload = http://games.ipgn.com.au/tf2/maps/cp_follower_rc1.bsp.bz2
+
  | mapdownload = http://fastdl.colonslash.eu/maps/cp_freight_b3.bsp.bz2
 
  | mapdownloadnote = 2
 
  | mapdownloadnote = 2
−
  | mapname = cp_follower_rc1
+
  | mapname = cp_freight_b3
−
  | maprowspan = 1
+
  | 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
 +
| ozf6s = 1
 +
| ugchl = 1
 +
}}
 +
|}</pre> '''Will yield:'''
 +
{{MapLeagueInclusionTable/Header
 
  | ugc6s = 1
 
  | ugc6s = 1
−
  | ugc6snote = 3
+
  | etf2l6s = 1
 +
| esea6s = 1
 +
| ozf6s = 1
 +
| ugchl = 1
 +
}}
 +
|}<!--
 +
-->
 +
== Footer ==
 +
The footer shows the total inclusions of a map in each individual league.
 +
=== 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.
 +
==== Note parameters ====
 +
Excluding the above parameters, the other note parameters are:
 +
<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>
 +
=== 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
 
  | ugc6s = 1
 +
| etf2l6s = 1
 +
| esea6s = 1
 +
| ozf6s = 1
 +
| ugchl = 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 />
 +
==== Note parameters ====
 +
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
 +
}}<!--
 +
-->
 +
== Notes ==
 +
The notes section contains points of clarification that are previously referenced in the table.
 +
=== 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
 
}}{{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
 
  | number = 1
−
  | content = UGC is a big league
+
  | content = ETF2L is a big league
 
}}{{MapLeagueInclusionTable/Note
 
}}{{MapLeagueInclusionTable/Note
 
  | number = 2
 
  | number = 2
Line 60: Line 187:
 
}}{{MapLeagueInclusionTable/Note
 
}}{{MapLeagueInclusionTable/Note
 
  | number = 3
 
  | number = 3
−
  | content = Wowie this is the first season of UGC
+
  | content = Wowie this is the 4th season of ETF2L
 
}}
 
}}
−
== Header ==
+
 
 +
<noinclude>[[Category:Template]][[Category:MapLeagueInclusionTable Templates]][[Category:MapLeagueInclusionTable Base Templates]]</noinclude>

Revision as of 05:29, 4 September 2015

This template was made to show a map's inclusions in the map pool of various leagues and in various seasons.

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

"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

Footer

The footer shows the total inclusions of a map in each individual league.

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)

Note parameters

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.

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