Difference between revisions of "Template:Map infobox/doc"

From Team Fortress Wiki
Jump to: navigation, search
m
(Updated documentation; Added example.)
Line 11: Line 11:
 
| developer =  
 
| developer =  
 
| download-link =  
 
| download-link =  
 +
| map-multiple-stages =
 +
| map-environment =
 +
| map-setting =
 +
| map-deep-water =
 +
| map-hazards =
 +
| map-health-pickups =
 +
| map-ammo-pickups =
 +
| map-special-pickups =
 
| map-stamp-link =  
 
| map-stamp-link =  
 
}}
 
}}
Line 26: Line 34:
 
|-
 
|-
 
| <code>map-image</code>
 
| <code>map-image</code>
| Yes
+
| '''Yes'''
 
| File name of image of map, automatically resized to 300px wide. Defaults to [[:File:Screenshot needed.png]].
 
| File name of image of map, automatically resized to 300px wide. Defaults to [[:File:Screenshot needed.png]].
 
|-
 
|-
Line 48: Line 56:
 
| No
 
| No
 
| Link to permanent map download location.
 
| Link to permanent map download location.
 +
|-
 +
| <code>map-multiple-stages</code>
 +
| No
 +
| Number of stages the map is composed of.
 +
|-
 +
| <code>map-environment</code>
 +
| No
 +
| Map environment (Alpine, Desert, etc). Required to enable the '''Map Info''' section.
 +
|-
 +
| <code>map-setting</code>
 +
| No
 +
| Map setting, as daytime and weather.
 +
|-
 +
| <code>map-deep-water</code>
 +
| No
 +
| Deep water present in map.
 +
|-
 +
| <code>map-hazards</code>
 +
| No
 +
| Various hazards present in map.
 +
|-
 +
| <code>map-health-pickups</code>
 +
| No
 +
| Number of health pickups present in map. Possibly use this notation '''{{tooltip|1|Small}} / {{tooltip|2|Medium}} /  {{tooltip|3|Large}}'''.
 +
|-
 +
| <code>map-ammo-pickups</code>
 +
| No
 +
| Number of ammo pickups present in map. Possibly use this notation '''{{tooltip|1|Small}} / {{tooltip|2|Medium}} /  {{tooltip|3|Large}}'''.
 +
|-
 +
| <code>map-ammo-pickups</code>
 +
| No
 +
| Number of ammo pickups present in map. Possibly use this notation '''{{tooltip|1|Small}} / {{tooltip|2|Medium}} /  {{tooltip|3|Large}}'''.
 +
|-
 +
| <code>map-ammo-pickups</code>
 +
| No
 +
| Special pickups present in map (Halloween gifts, Crit-pumpkins).
 
|-
 
|-
 
| <code>map-stamp-link</code>
 
| <code>map-stamp-link</code>
 
| No
 
| No
 
| If a map stamp is available in Mann Co. Store, provide link to supporters leaderboard.
 
| If a map stamp is available in Mann Co. Store, provide link to supporters leaderboard.
|}<noinclude>[[Category:Template documentation]]</noinclude>
+
|}
 +
== Example==
 +
{{Map infobox
 +
| map-name-override=Egypt
 +
| map-image=Egypt_01.jpg
 +
| game-type=Control Point
 +
| file-name=cp_egypt_final
 +
| developer=[http://steamcommunity.com/id/sean_c Sean "Heyo" Cutino]
 +
| map-multiple-stages=3
 +
| map-environment=Desert
 +
| map-setting=Daylight, sunny
 +
| map-deep-water=No
 +
| map-hazards=[[Environmental_death#Gate_Crush|Ceiling trap]]
 +
| map-health-pickups={{tooltip|0|Small}} / {{tooltip|0|Medium}} / {{tooltip|0|Large}}
 +
| map-ammo-pickups={{tooltip|0|Small}} / {{tooltip|0|Medium}} / {{tooltip|0|Large}}
 +
| map-special-pickups=''None''
 +
| map-stamp-link = http://steamcommunity.com/stats/TF2/leaderboards/30383
 +
}}
 +
<pre>{{Map infobox
 +
| map-name-override=Egypt (NOTE: THIS ALSO INFLUENCES THE MAP STAMP IMAGE)
 +
| map-image=Egypt_01.jpg
 +
| game-type=Control Point
 +
| file-name=cp_egypt_final
 +
| developer=[http://steamcommunity.com/id/sean_c Sean "Heyo" Cutino]
 +
| map-multiple-stages=3
 +
| map-environment=Desert
 +
| map-setting=Daylight, sunny
 +
| map-deep-water=No
 +
| map-hazards=[[Environmental_death#Gate_Crush|Ceiling trap]]
 +
| map-health-pickups={{tooltip|0|Small}} / {{tooltip|0|Medium}} / {{tooltip|0|Large}}
 +
| map-ammo-pickups={{tooltip|0|Small}} / {{tooltip|0|Medium}} / {{tooltip|0|Large}}
 +
| map-special-pickups=''None''
 +
| map-stamp-link = http://steamcommunity.com/stats/TF2/leaderboards/30383
 +
}}</pre>
 +
 
 +
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 18:28, 17 February 2011

This template adds in information box to articles on maps. It adds pages to Category:Maps.

Usage

{{Map infobox
| map-name-override = 
| map-image = 
| game-type = 
| file-name=
| current-version = 
| developer = 
| download-link = 
| map-multiple-stages =
| map-environment = 
| map-setting = 
| map-deep-water = 
| map-hazards = 
| map-health-pickups = 
| map-ammo-pickups = 
| map-special-pickups = 
| map-stamp-link = 
}}

Parameters

Parameter Required? Function
map-name-override No The name of the map if it is anything other than the page name.
map-image Yes File name of image of map, automatically resized to 300px wide. Defaults to File:Screenshot needed.png.
game-type No Game type or mode, such as Arena, in English. Automatically linked and translated.
file-name No File name of map.
current-version No Latest version of the map, such as A2, B5, RC5.
developer No Name and optional link to the developer/author of the map. Do not name individual Valve employees.
download-link No Link to permanent map download location.
map-multiple-stages No Number of stages the map is composed of.
map-environment No Map environment (Alpine, Desert, etc). Required to enable the Map Info section.
map-setting No Map setting, as daytime and weather.
map-deep-water No Deep water present in map.
map-hazards No Various hazards present in map.
map-health-pickups No Number of health pickups present in map. Possibly use this notation 1 / 2 / 3.
map-ammo-pickups No Number of ammo pickups present in map. Possibly use this notation 1 / 2 / 3.
map-ammo-pickups No Number of ammo pickups present in map. Possibly use this notation 1 / 2 / 3.
map-ammo-pickups No Special pickups present in map (Halloween gifts, Crit-pumpkins).
map-stamp-link No If a map stamp is available in Mann Co. Store, provide link to supporters leaderboard.

Example

Map infobox
Egypt 01.jpg
Basic Information
Developer(s): {{{map-developer}}}
Map Info
Environment: Desert
Setting: Daylight, sunny
Hazards: Ceiling trap
Map Photos
Loading screen photos.
Map Stamp
[[File:Item icon Map Stamp - Template:Dictionary/common strings/map name map infobox.png|170px|link=Map Stamp]]
Supporters Leaderboard
{{Map infobox
| map-name-override=Egypt (NOTE: THIS ALSO INFLUENCES THE MAP STAMP IMAGE)
| map-image=Egypt_01.jpg
| game-type=Control Point
| file-name=cp_egypt_final
| developer=[http://steamcommunity.com/id/sean_c Sean "Heyo" Cutino]
| map-multiple-stages=3
| map-environment=Desert
| map-setting=Daylight, sunny
| map-deep-water=No
| map-hazards=[[Environmental_death#Gate_Crush|Ceiling trap]]
| map-health-pickups={{tooltip|0|Small}} / {{tooltip|0|Medium}} / {{tooltip|0|Large}}
| map-ammo-pickups={{tooltip|0|Small}} / {{tooltip|0|Medium}} / {{tooltip|0|Large}}
| map-special-pickups=''None''
| map-stamp-link = http://steamcommunity.com/stats/TF2/leaderboards/30383
}}