Template:Location map/sandbox quick/doc

From blackwiki
Jump to navigation Jump to search

The Template:Location map/sandbox quick displays a location map as a composite image of an existing map, plus a marker and an optional label superimposed onto it, in a quick manner (MediaWiki depth 5). By default, the size of the map is defaulted as 240px wide. Otherwise, set width=200 or such.

Maps used here are not just images alone. Instead, maps are selected by mapper-template suffixes "XX" (to use each template "Location map XX"). Maps here use only squared or equirectangular projections. So, use {{Location_map}} to show curved latitude or longitude lines, to skew the location of the marker symbol, as in Module:Location map/data/Africa. That mapper for Africa uses sine/cosine factors to shift the marker x/y to fit the curved lines. Each mapper template sets its own map borders and decides if skewing x/y for curved lines.

Note:

  • The image is always framed, so use {{Location map}} to show an unframed image.
  • The coordinates are not checked. If the coordinates fall outside the map, then the marker will try to appear outside the map-image, overlaying the page text.
  • For a map with no marker, set marksize=1.
  • Do not use "px". Using width=200px causes maps to cover a page, use: width=200 (no "px").
  • To create a map with more than one marker, refer below to: See also.
  • To display a map that uses a non-equirectangular projection (i.e. has curved latitude or longitude lines), use skew factors for x/y as in Module:Location map/data/Africa or try Template:Location map+.

Usage

Parameter "location" refers to a map definition template. If location is Spain, the map image and coordinates are based on the values set in Module:Location map/data/Spain.

Decimal degree coordinates

{{Location map
| location
| lat        = 
| long       = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| width      = 
| scale      =
| float      = 
| border     = 
| caption    = 
| alt        = 
| image =
}}

Degree, Minute, Second coordinates

{{Location map
| location
| lat_deg    = 
| lat_min    = 
| lat_sec    = 
| lat_dir    = 
| lon_deg    = 
| lon_min    = 
| lon_sec    = 
| lon_dir    = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| image      =
}}

Parameters

Parameter Default Description
{{{1}}} the unnamed 1st parameter contains the location of the map definition (if Spain, then use values from Module:Location map/data/Spain)
lat 0 latitude (decimal format; enter negative numbers for southern latitude)
lat_deg 0 latitude degrees
lat_min 0 latitude minutes
lat_sec 0 latitude seconds
lat_dir N latitude: N = north (default), S = south
long 0 longitude (decimal format; enter negative numbers for western longitude)
lon_deg 0 longitude degrees
lon_min 0 longitude minutes
lon_sec 0 longitude seconds
lon_dir E longitude: E = east (default), W = west
label {{PAGENAME}} label text
label_size 90 label font size as a percentage (<100 = smaller, >100 = larger)
position, or pos right label position relative to the mark: left, right, top, bottom, none
background transparent label background color (background-color: {};)
mark Red pog.svg marker image file name ([[Image: {}]])
marksize 8 marker size in pixels, omit px ([[Image: {}px]]
font-size: {}px;)
width auto-size map width - omit "px" or will stretch across page (image: {}px
width: ({}+2)px;)
scale 1.0 map scale factor - relative to each user's preference setting for image-size (same as upright=x).
float right position of map on page: left, right, center, none (float: {}; clear: {};
border #CCCCCC border color or none (border: {};)
caption "Marker text (location map name)" map caption; for no caption enter "caption="
alt empty alt text for map; used by screen readers, see WP:ALT
image {{Location map {{{1}}}|image}} Alternative map file name without "File:" ([[Image: {}]]), must use same border coordinates as the default map

Available map templates

There are over 1000 map templates available:

List of templates - Many of the items listed here are redirects and a few templates may not function as expected.
Category:Location map templates - templates sorted by category.
Special:WhatLinksHere/Template:Location map/Info - a search that might help.
Special:Prefixindex/Template:Location map - another search that might help.
List of location maps and documentation pages

Creating new map templates

  1. Find an appropriate blank map in equirectangular projection.
  2. Create a template named Template:Location map location (copy the content of any other map template into it and enter appropriate values).

Examples

Default width, float, label position, and caption (decimal coordinates)

Pag (Croatia)
Pag
Pag
Pag (Croatia)


This example shows the default marker (red circle), with the image width as auto-sized for each user preference setting (set in Special:Preferences).

  
{{Location map/sandbox quick | Croatia
| lat = 44.44
| long = 15.05
| label = Pag
| alt = Pag is on an island
}}

Map with the default caption (degrees/minutes)

Pag (Croatia)
Pag
Pag
Pag (Croatia)


This example shows a green circle ("Image:Green pog.svg"), with scale=0.75 to set the map width to 75% (3/4) of each user's image-size setting. The 2 lines are indented for position/mark, to show a way to emphasize the details about the label & marker.

  
{{Location map/sandbox quick | Croatia
| lat_deg = 44 | lat_min = 26
| lon_deg = 15 | lon_min = 3
| label = Pag
  | position = right
  | mark = Green pog.svg <!--green dot-->
| scale = 0.75
| float = right
| alt = Pag is on an island.
}}

Map with a custom caption and text background

Imotski (Croatia)
Imotski
Imotski
Imotski in Croatia


This example sets the label color by "background = #FFFFDD" and sets the caption=xx for the caption below the map. The width=200 sets the image width to 200px for all readers, rather than scale=0.75 as set to 75% of each user's preference setting.

  
{{Location map/sandbox quick | Croatia
| lat = 43.44
| long = 17.21
| label = Imotski
  | position = right
  | background = #FFFFDD
| width = 200
| float = right
| caption = Imotski in Croatia
| alt = Imotski is in Croatia.
}}

Map with enlarged marker and label

Pag (Croatia)
Pag
Pag
Pag Island in Croatia


This example shows a much larger label (double size, label_size=200), with a larger marker set to marksize=14, and with the map width=200.

  
{{Location map/sandbox quick | Croatia
| lat = 44.44
| long = 15.05
| label = Pag
| label_size = 200 <!--200% larger-->
| position = right
| background = #FFFFDD
| marksize = 14
| width = 200
| float = right
| caption = Pag Island in Croatia
| alt = Pag is on an island
}}

Alternative style of map

Lockerbie (Scotland)
Lockerbie
Lockerbie
Lockerbie in Scotland
{{Location map/sandbox quick | UK Scotland
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W 
| label = Lockerbie
| position = right
| mark = Blue_pog.svg
| marksize = 9
| float = right
| caption = Lockerbie in Scotland
| alt = Lockerbie is in southern Scotland.
}}
Lockerbie (Scotland)
Lockerbie
Lockerbie
Lockerbie in Scotland
{{Location map/sandbox quick | UK Scotland
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W 
| label = Lockerbie
| position = right
| mark = Blue_pog.svg
| marksize = 9
| float = right
| caption = Lockerbie in Scotland
| alt = Lockerbie is in southern Scotland.
}}

Using Alternative map image=xx

Biratnagar (Nepal)
Biratnagar
Biratnagar
Location of Biratnagar Airport in Nepal
{{Location map/sandbox quick | Nepal
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
| label = Biratnagar
| position = top
| mark = Airplane silhouette.svg
| marksize = 10
| caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
}}
Biratnagar (Nepal)
Biratnagar
Biratnagar
Location of Biratnagar Airport in Nepal
{{Location map/sandbox quick | Nepal
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
| label = Biratnagar
| position = top
| mark = Airplane silhouette.svg
| marksize = 10
| caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
| image = Nepal relief location map.jpg
}}

Design issues

Each of the mapper templates named as "Location_map_XX" (such as Module:Location map/data/Africa) contains a map-image name, latitude range, longitude range, or x/y skew factors, as the details hidden by data encapsulation (computer science). Some mapper templates treat latitude/longitude as straight lines (Mercator projections), whereas other mappers have skew factors for maps with curved lines. Hence, each of those templates is not a "fork" of {{Location map}} but instead, they are accessor functions which access the map-border coordinates or skew-factors as shared data, rather than being repeated data in each article using Module:Location map/data/Italy. If Italy officially changes its map borders, then only that one mapper template need be changed, and only those Italy-related articles will be reformatted. The total of 20,000+ articles using {Location_map} will NOT be reformatted when someone updates each particular "Location_map_XX" and so the impact on Wikipedia server work is reduced, as roughly 450 times faster, by having 450 separate mapper templates.

See also

Media related to Map pointers at Wikimedia Commons Media related to Location markers at Wikimedia Commons