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

Revision as of 23:57, 2 October 2015

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:

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

Template:MapLeagueInclusionTable/Header

Example

{{MapLeagueInclusionTable/Header
 | ugc6s = 1
 | etf2l6s = 1
 | esea6s = 1
 | ozf6s = 1
 | ugchl = 1
}}
|}

Will yield:

Seasonal Inclusions by League
[view]			Map version				UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
[view]			Map version				4v4	6v6				Prolander	Highlander

Template:MapLeagueInclusionTable/Row/Map

This controls everything inside the first cell of a single row.
|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
official - Sets the ribbon colour to grey (#4F4F4F)
pro - Sets the ribbon colour to green (#F2F2F2)

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

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:

Seasonal Inclusions by League
[view]	Map version	UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
[view]	Map version	4v4	6v6	Prolander	Highlander
	cp_cheeseburger_pro_v42	Season 5	Season	Season		Season	Season	Season	Season	Season	Season	Season
	cp_cheeseburger_pro_v42	Season 4	Season	Season	Season 17	Season	Season	Season	Season	Season	Season	Season

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	UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
[view]	Map version	4v4	6v6	Prolander	Highlander
	cp_cheeseburger_pro_v42	Season 5	Season	Season	Season 17	Season	Season	Season	Season	Season	Season	Season
	cp_cheeseburger_pro_v42	Season 4	Season	Season		Season	Season	Season	Season	Season	Season	Season

Example

{{MapLeagueInclusionTable/Header
 | ugc4s = 1
 | esea6s = 1
 | ozf6s = 1
 | etf2lhl = 1
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = pro
 | mapdownload = comp.tf
 | mapdownloadnote = 1
 | mapname = cp_cheeseburger_pro_v42
 | maprowspan = 2
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 5
 | esea6s = 0
 | ozf6s = 14
 | etf2lhl = 7
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 4
 | esea6s = 0
 | ozf6s = 13
 | etf2lhl = 0
}}
{{MapLeagueInclusionTable/Row/Map
 | maptype = official
 | mapname = cp_cheeseburger
 | mapnamenote = 2
 | maplink = Main Page
 | maprowspan = 1
}}
{{MapLeagueInclusionTable/Row/Info
 | ugc4s = 3
 | ugc4snote = 3
 | esea6s = 17
 | ozf6s = 0
 | etf2lhl = 0
}}
|}

Will yield:

Seasonal Inclusions by League
[view]	Map version	UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
[view]	Map version	4v4	6v6		Prolander	Highlander
	cp_cheeseburger_pro_v42	Season 5	Season	Season		Season 14	Season	Season	Season	Season	Season 7	Season
	cp_cheeseburger_pro_v42	Season 4	Season	Season		Season 13	Season	Season	Season	Season		Season
	cp_cheeseburger	Season 3	Season	Season	Season 17		Season	Season	Season	Season		Season

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

Note parameters

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				UGC	UGC	ETF2L	ESEA	ozfortress	RGL	AsiaFortress	RGL	UGC	ETF2L	RGL
[view]			Map version				4v4	6v6				Prolander	Highlander
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).
|official
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
 | official = 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/Note Template:MapLeagueInclusionTable/Note Template:MapLeagueInclusionTable/Note

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

Revision as of 23:57, 2 October 2015

Template:MapLeagueInclusionTable/Header

Example

Template:MapLeagueInclusionTable/Row/Map

Header cell

Parameters

Note parameters

Information cells

Parameters

Important notes

Example

Footer

Parameters

Note parameters

Example

Key

Parameters

Example

Notes

Parameters

Example

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Help the Wiki!

comp.tf

Competitive TF2

Tools

@@ Line 1: / Line 1: @@
 __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.<!--
+{{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:
-== Associated templates ==
-The current templates associated with creating a Map League Inclusion Table are:
 * [[Template:MapLeagueInclusionTable/Header]]
 * [[Template:MapLeagueInclusionTable/Row/Map]]
@@ Line 12: / Line 10: @@
 These templates can also be found in [[:Category:MapLeagueInclusionTable Base Templates]].<!--
 -->
-== General information ==
+== [[Template:MapLeagueInclusionTable/Header]] ==
-* All parameters are in lowercase characters
+The header defines what leagues will be included in the table.<br />
-* The generic makeup of a table consists of 1 Header, at least 1 Row, 1 Footer, 1 Note (optional) and 1 Key (optional)
+Setting any of the below parameters to '1' will display the parameter's league as a column.<br />
-* 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
- | ugc4s = 1
- | esea6s = 1
- | ozf6s = 1
- | etf2lhl = 1
-}}
-{{MapLeagueInclusionTable/Row/Map
- | maptype = pro
- | mapdownload = comp.tf
- | mapdownloadnote = 1
- | mapname = cp_cheeseburger_pro_v42
- | maprowspan = 1
-}}
-{{MapLeagueInclusionTable/Row/Info
- | ugc4s = 5
- | esea6s = 0
- | ozf6s = 14
- | etf2lhl = 7
-}}
-{{MapLeagueInclusionTable/Row/Info
- | maptype = official
- | 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
- | official = 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/Map
- | maptype = pro
- | mapdownload = comp.tf
- | mapdownloadnote = 1
- | mapname = cp_cheeseburger_pro_v42
- | maprowspan = 1
-}}
-{{MapLeagueInclusionTable/Row/Info
- | ugc4s = 5
- | esea6s = 0
- | ozf6s = 14
- | etf2lhl = 7
-}}
-{{MapLeagueInclusionTable/Row/Info
- | maptype = official
- | 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
- | official = 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/Map
- | maptype = normal
- | mapdownload = http://fastdl.colonslash.eu/maps/cp_freight_b3.bsp.bz2
- | mapdownloadnote = 2
- | mapname = cp_freight_b3
-}}
-{{MapLeagueInclusionTable/Row/Info
- | 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:'''
-{{MapLeagueInclusionTable/Header
- | etf2l6s = 1
- | etf2l6snote = 1
-}}
-{{MapLeagueInclusionTable/Row/Map
- | maptype = normal
- | mapdownload = http://fastdl.colonslash.eu/maps/cp_freight_b3.bsp.bz2
- | mapdownloadnote = 2
- | mapname = cp_freight_b3
-}}
-{{MapLeagueInclusionTable/Row/Info
- | 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
@@ Line 187: / Line 32: @@
 |}<!--
 -->
-== Row ==
+== [[Template:MapLeagueInclusionTable/Row/Map]] ==
+This controls everything inside the first cell of a single row.<br />
+<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
+* '''official''' - Sets the ribbon colour to grey (#4F4F4F)
+* '''pro''' - Sets the ribbon colour to green (#F2F2F2)
 '''Note:''' The row template cannot be used for multiple rows, only one horizontal row.
 === Header cell ===

	Official map
	Pro version