User:Wookipan/Map overview

[edit] [purge]

Documentation for Wookipan/Map overview

Description

This template allows you to add markers to an image. When hovering over the marker, the name of the area will appear, accompanied by a scrollable list with each location.

In order to avoid cluttering articles, ALWAYS create the template as a subpage of the map locations template and then include the template into the source article of the respective map under the proper section, which would be at the bottom of the "Locations" section.

For instance: Pier#Locations

If you are new to using templates, see Wikipedia's A quick guide to templates.

The map example used here is the map Pier. The naming convention would then be: Template:Map locations/Pier.

Some map titles like Brimstone (map) will contain (map) and so will the file name of the map overview image. However, as this template is meant solely for maps it is unnecessary to name it as such and should be avoided.

Important: Map overview images with titles that contain (map) must be overridden using the image parameter. Remember to type in the full file name, like so: image = Brimstone (map) overview.png

Parameters

title

Optional. Title of the box. Will automatically fetch the title of the subpage. Can be used to overide the title.

collapsed

Optional. Collapses the box on load. Off by default. Use collapsed = yes to collapse the box.

image

Optional. File name of the image to be used as the base for the map location template. The image will be fetched automatically and resized to a width of 800 pixels. Can be used to override the image.

placement

Optional. The placement of the image. Has 2 values: left and right. The image will be placed to the left by default. Please only use this to invert the image placement if there is more than one map locations template present.

You can add up to 20 locations on the map. Every location is controlled by three main attributes. Each location will then automatically be added to a bulleted list in numeric order.

area1

Required. Contains the name of a given area/location. Adds the respective number to the marker automatically.

area-left1 and area-top1 - X and Y coordinates of the map marker. The number is to be replaced with a number from the range (1-20).

You can add up to 5 spawn points on the map. Every spawn point is controlled by three main attributes. Each spawn point will then automatically be added to a bulleted list in alphabetical order.

spawn1

Optional. Contains the name of a given spawn point. Adds the respective letter to the marker automatically.

spawn-left1 and spawn-top1 - X and Y coordinates of the spawn point marker. The number is to be replaced with a number from the range (1-5).

spawn-color1

Required if spawn is set. The marker color value of the given spawn point. There are 3 marker color values: red (default), blu and mix. The marker color value mix are only to be used to indicate shared spawn rooms, as in the case with some maps.

You can add up to 6 objectives on the map. Every objective is controlled by three main attributes. Unlike the other markers, the objective markers will not be listed and won't contain any number or letter.

objective1

Optional. Contains the name of a given objective. This can be used to mark any objective or point of interest, such as flags, Control Points, or Payload checkpoints.

objective-left1 and objective-top1 - X and Y coordinates of the objective marker. The number is to be replaced with a number from the range (1-6).

objective-color1

Required if objective is set. The marker color value of the given objective. There are 3 marker color values: red (default), blu and neutral. The marker color value neutral are only to be used to indicate neutral Control Points or flags.

Translation

Translations for this template can be added under Template:Dictionary/common strings#map_locations_.28template.29.

Getting the coordinates

To make the process as easy and simple as possible without the need of image editing software, it is highly recommended to use the built-in developer tools in various browsers, to ajust the marker placements with ease.

• Once an area or spawn point has been defined with both its X and Y coordinates, the marker will be placed at the very bottom of the box, simply because it has not yet been given any coordinate values. You can ajust the coordinates while editing by using the Show preview feature. Use the guide below accustomed to your browser.

For Google Chrome/Chromium & Firefox users

• Right-click on the marker and select 'Inspect' (usually at the bottom). Once the inspector is open, select the parent element of the marker if not already selected. The element in question is: <div class="marker" style="left: ; top: ;"></div>
• In the right side is a window divided into sections, with the first being element.style (or element in Firefox) which contains the coordinate values. In this guide, it is assumed that no values have been added, and to add them you must click on both left and top individually and press tab. Once done, simply add a value like 120px and see if the marker changes position. It is important that you add px at the end of the value without a space, as it is used to define the unit type, which must be in pixels in this case. You can click on the value and use the up/down arrow keys to rapidly increase/decrease the pixel value. Once the marker is at a fitting position, copy the entire value and add it to the proper parameter.
  • Remember: left is for X coordinates, and top is for Y coordinates.

Example

{{User:Wookipan/Map overview
 | title = Pier - Locations
 | image = Pier overview.png
 |-
 | spawn1 = BLU first spawn
 | spawn-color1 = blu
 | spawn-left1 = 335px
 | spawn-top1 = 150px
 |-
 | spawn2 = BLU second spawn
 | spawn-color2 = blu
 | spawn-left2 = 193px
 | spawn-top2 = 230px
 |-
 | spawn3 = RED first spawn / BLU third spawn
 | spawn-color3 = mix
 | spawn-left3 = 245px
 | spawn-top3 = 400px
 |-
 | spawn4 = RED final spawn
 | spawn-color4 = red
 | spawn-left4 = 608px
 | spawn-top4 = 512px
 |-
 | objective1 = Cart start
 | objective-color1 = blu
 | objective-left1 = 284px
 | objective-top1 = 148px
 |-
 | objective2 = Checkpoint A
 | objective-left2 = 210px
 | objective-top2 = 320px
 |-
 | objective3 = Checkpoint B
 | objective-left3 = 140px
 | objective-top3 = 440px
 |-
 | objective4 = Checkpoint C
 | objective-left4 = 337px
 | objective-top4 = 498px
 |-
 | objective5 = Checkpoint E
 | objective-left5 = 470px
 | objective-top5 = 416px
 |-
 | objective6 = Final point
 | objective-left6 = 620px
 | objective-top6 = 489px
 |-
 | area1 = Beach
 | area-left1 = 210px
 | area-top1 = 120px
 |-
 | area2 = Caves
 | area-left2 = 285px
 | area-top2 = 230px
 |-
 | area3 = Minivan parking space
 | area-left3 = 280px
 | area-top3 = 290px
 |-
 | area4 = Cliff
 | area-left4 = 240px
 | area-top4 = 220px
 |-
 | area5 = Bridge
 | area-left5 = 200px
 | area-top5 = 340px
 |-
 | area6 = Red carpet building
 | area-left6 = 160px
 | area-top6 = 350px
 |-
 | area7 = Wine cellar
 | area-left7 = 90px
 | area-top7 = 390px
 |-
 | area8 = Docks
 | area-left8 = 135px
 | area-top8 = 520px
 |-
 | area9 = Warehouse
 | area-left9 = 305px
 | area-top9 = 480px
 |-
 | area10 = Kitchen
 | area-left10 = 340px
 | area-top10 = 410px
 |-
 | area11 = Sandy beach
 | area-left11 = 425px
 | area-top11 = 460px
 |-
 | area12 = Barn bridge
 | area-left12 = 430px
 | area-top12 = 400px
 |-
 | area13 = Small barn
 | area-left13 = 468px
 | area-top13 = 430px
 |-
 | area14 = Building adjacent to the barn
 | area-left14 = 505px
 | area-top14 = 460px
 |-
 | area15 = Target range
 | area-left15 = 600px
 | area-top15 = 460px
}}

will yield