Template:Location map many/sandbox2/doc

From blackwiki
Jump to navigation Jump to search

The Template:Location map many/sandbox2 creates a location map as a composite image of an existing map, with multiple (up to 22) markers and optional labels superimposed onto it. This template functions in the style of Template:Location_map, but allows 22 markers and labels (rather than just one marker). The positions of the markers will display correctly on all browsers, even on older MSIE browsers.

For an unlimited list of markers/labels, see: Template:Location map+, which specifies points as a coded template list of markers/labels.

Usage

The first unnamed parameter (shown as {{{1}}} below) specifies a map definition template. If {{{1}}} is Spain, the map image and coordinates are based on the values defined in Template:Location map Spain.

{{Location map many/sandbox2
| {{{1}}}
| width       = 
| float       = 
| border      = 
| caption     = 
| alt         = 
| relief      = 
| AlternativeMap = 
| <!--first label/marker-->
| label       = 
| label_size  = 
| position    =  <!-- or: pos -->
| background  =  <!-- or: bg -->
| mark        = 
| marksize    = 
| link1       =  <!-- or: link -->
| lat_deg     = 
| lat_min     = 
| lat_sec     = 
| lat_dir     = 
| lon_deg     = 
| lon_min     = 
| lon_sec     = 
| lon_dir     = 
| <!--second label/marker-->
| label2      = 
| label2_size = 
| position2   =  <!-- or: pos2 -->
| background2 =  <!-- or: bg2 -->
| mark2       = 
| mark2size   = 
| link2       = 
| lat2_deg    = 
| lat2_min    = 
| lat2_sec    = 
| lat2_dir    = 
| lon2_deg    = 
| lon2_min    = 
| lon2_sec    = 
| lon2_dir    = 
| <!--repeat as needed up to label22-->
}}

Parameters

Map display parameters
Parameter Description
{{{1}}} Required. Use the name of the map as the first unnamed parameter. For example, specify England to use the values in {{Location map England}}. See the examples below.
width Determines the width of the map in pixels. The default is 240. Do not include px, for example: width=300, not width=300px.
float Specifies the position of the map on the page. Valid values are left, right, center and none. The default is right.
border Specifies the color of the 1px map border. The default is lightgrey (see web colors). If set to none, no border will be generated. This parameter is seldom used.
caption The text of a caption to be displayed below the map. Specifying a caption will cause the map to be displayed with a frame. If caption is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If caption is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the label parameter (or the current page name if label not defined) and the name parameter from map definition template. See the examples below.
alt Alt text for map; used by screen readers, see WP:ALT.
AlternativeMap or image=xx.jpg Allows the use of an alternative map or any image. The image must have the same edge coordinates as the location map template. See the example at Location map+/AlternativeMap.
Label and mark parameters
Parameter Description
label
label10
The text of the label to display next to the mark. A wiki link can be used. The default if not specified is no label, just the marker.
label_size
label10_size
The font size to use for the label, given as a percentage of the normal font size (<100 = smaller, >100 = larger). The default is 90. Do not include %, for example: label_size=80, not label_size=80%.
position or pos
pos10
The position of the label relative to the mark. Valid values are left, right, top and bottom. The default is right.
background or bg
bg10
The background color to use for the label. See Web colors. The default is no background color, which shows the map image behind the label.
mark
mark10
The name of an image to display as the mark. The default is Red pog.svg (Red pog.svg). See examples at Commons:Location markers and Commons:Category:Map icons.
marksize
mark10size
The size of the mark in pixels. The default is 8. Do not include px, for example: marksize=10, not marksize=10px.
markhigh
mark10high
The height of the mark in pixels. The default is 8. Do not include px, for example: markhigh=10, not markhigh=10px.
link1
link10
Specifies a wiki link which will be followed if the reader clicks on the mark. The name of the linked article is displayed when the mouse pointer hovers over the mark.
lat_deg
lat10_deg
Required. The degrees of latitude. This value can be specified using decimal degrees and when this format is used minutes and seconds should not be specified.
lat_min
lat10_min
The minutes of latitude.
lat_sec
lat10_sec
The seconds of latitude. Usually not necessary.
lat_dir
lat10_dir
N if north (default value) or S for south of the Equator. Other values will be disregarded. Not required if using signed decimal degrees (i.e. negative numbers for southern latitude).
lon_deg
lon10_deg
Required. The degrees of longitude. This value can be specified using decimal degrees and when this format is used minutes and seconds should not be specified.
lon_min
lon10_min
The minutes of longitude.
lon_sec
lon10_sec
The seconds of longitude. Usually not necessary.
lon_dir
lon10_dir
E for east (default value) or W for west of the Prime Meridian. Other values will be disregarded. Not required if using signed decimal degrees (i.e. negative numbers for western longitude).

Note: For brevity, parameters "pos" & "bg" are aliases (for "position" & "background"), with pos2, bg2, pos3, bg3, etc.

Markers

When a marker's mark#size=0, then that marker is skipped and only the related label is displayed, without the marker.

Each mark, mark2, mark3 (etc.) can be another image-symbol, such as Diamond_sheer_red_20.gif (marksize=20) to show a red diamond on the image: Diamond sheer red 20.png or use: Cercle_rouge_100%.svg to show a red circle Cercle rouge 100%.svg or a larger black diamond: Diamond_sheer_black_37.gif as sized with a larger marksize=37 or similar number to resize the diamond somewhat: Diamond sheer black 37.png

See Wikimedia pointer symbols: commons:Category:Map pointers.

Advisory messages

The degrees of latitude/longitude are validated, to show error messages, but location minutes can be set very large to place markers outside the map (with no warnings). Due to the numerous details of specifying 9 markers/labels, the latitude and longitude are checked to lie within the actual map limits specified in Template:Location_map_<parameter1>. Each marker/label is checked and can list a warning message (under the map), such as:

Latitude#4 (45.68) < map min(53.74).

Processing continues, with that marker actually placed off-map, and all latitude/longitude parameters are checked, for a total of 18 possible advisory messages. Only degrees of latitude/longitude are checked, so a value of 63 minutes would be valid to indicate 1 extra degree + 3 minutes, and setting lon_min=200 could still place a marker off-map (right-side) with no warning message. Also, large markers or long labels can spill over the edges of a map, allowing markers to point inward from outside the map. In such cases, a map could be centered by itself on the page ("float=center") to avoid overlapping the edge markers onto any surrounding article text.

Available maps

Partial list of live templates named Template:Location_map_<locname> (without "Template:" prefix here, A-F):

Special:Prefixindex/Template:Location_map_

Creating new maps

  1. Find an appropriate blank map in equirectangular projection (otherwise, coordinates will drift off, typically further north)
  2. Create a template named "Template:Location_map_locname" (copy the content of any other map template into it and enter appropriate values).
  3. Set default parameter values (using those parameter names), such as setting "mark" with image-file name and "marksize" for pixels wide/tall, or set default label font size ("label_size = 78" percent).
  4. Parameter names not used by "Template:Location_map" will be ignored by it, and only used for multiple-markers (such as defaulting "label2_size = 78" percent, or "mark2size=7" pixels).

Examples

Map with label "Pag" and "Anytown" (degrees)

Pag (Croatia)
Pag
Pag
Anytown_Anywhere
Anytown_Anywhere
Pag (Croatia)
{{Location map many/sandbox2 | Croatia
| width = 280
| float = right
| label = Pag
  | marksize = 8
  | pos = right
  | bg = yellow
  | lat_deg = 44 | lat_min = 26
  | lon_deg = 15 | lon_min = 3
| label2 = Anytown_Anywhere
  | mark2 = Rouge-Admin JollyRoger.svg
  | mark2size = 45
  | pos2 = bottom
  | bg2 = transparent
  | lat2_deg = 45 | lat2_min = 30
  | lon2_deg = 17 | lon2_min = 30
}}

Map with 3 labels (decimal)

Pag (Croatia)
Pag
Pag
Anytown
Anytown
Anytown2
Anytown2
Pag (Croatia)
{{Location map many/sandbox2 | Croatia
| width = 260
| float = right
| label = Pag
  | pos = right
  | marksize = 8
  | lat_deg = 44.44
  | lon_deg = 15.05
| label2 = Anytown
  | pos2 = bottom
  | bg2 = yellow
  | mark2size = 8
  | lat2_deg = 45.86
  | lon2_deg = 17.50
| label3 = Anytown2
  | pos3 = top
  | bg3 = lightgreen
  | lat3_deg = 46.23
  | lon3_deg = 18.43
}}

Example map with red triangle

Hispaniola (100x100)
Hispaniola
Location map many/sandbox2/doc
Cuba
Site of Hispaniola
{{Location map many/sandbox2 | 100x100
| image = LocationJamaica.svg
| float = right
| width = 250
| caption = Site of '''Hispaniola'''
| label = Hispaniola
  | position = left
  | background = #CCDDFF
  | marksize = 0
  | lat_deg = 39.8
  | lon_deg = 65.1
| label2 =
  | mark2 =Diamond_sheer_red_42.png
  | mark2size = 42
  | lat2_deg = 51.4
  | lon2_deg = 72.8
| label3 = Cuba
  | pos3 = left
  | mark3size = 0
  | lat3_deg = 60.8
  | lon3_deg = 66.0
}}

Map with some labels outside map

Pag (Croatia)
Pag
Pag
Anytown
Anytown
Anytown2
Anytown2
North Croatia
Pag (Croatia)


Latitude#2 (47.40) > map max (46.8).
Longitude#2 (12.80) < map min (13.1).
Latitude#3 (41.98) < map min (42.1).

{{Location map many/sandbox2 | Croatia
| width = 260
| float = right
| label = Pag | position=right
  | marksize = 8
  | lat_deg = 44.44
  | lon_deg = 15.05
| label2 = Anytown
  | pos2 = bottom
  | bg2 = yellow
  | mark2size = 8
  | lat2_deg = 47.40
  | lon2_deg = 12.80
| label3 = Anytown2
  | pos3 = top
  | bg3 = lightgreen
  | lat3_deg = 41.98
  | lon3_deg = 18.43
| label4 = North Croatia
  | pos4 = left
  | bg4 = lightgreen
  | mark4size = 0
  | lat4_deg = 46.22
  | lon4_deg = 17.7
}}

Map with 9 markers (decimal)

Pag (Croatia)
Pag
Pag
Anytown
Anytown
Anytown2
Anytown2
44.0 (latitude)
44.0 (latitude)
44.5
44.5
45.0
45.0
45.5
45.5
46.0
46.0
CROATIA
CROATIA
Pag (Croatia)
{{Location map many/sandbox2 | Croatia
| width = 260
| float = right
| label = Pag
  | position = right
  | lat_deg = 44.44
  | lon_deg = 15.05
| label2 = Anytown
  | label2_size = 110
  | pos2 = bottom
  | background2 = yellow
  | lat2_deg = 45.86
  | lon2_deg = 17.50
| label3 = Anytown2
  | label3_size = 140
  | pos3 = top
  | background3 = green
  | lat3_deg = 46.23
  | lon3_deg = 18.43
| mark4 =Diamond_sheer_black_20.png
  | mark4size = 19
  | label4 = 44.0 (latitude)
  | lat4_deg = 44.00
  | lon4_deg = 13.5
| mark5 =Diamond_sheer_black_20.png
  | mark5size = 20
  | label5 = 44.5
  | lat5_deg = 44.50
  | lon5_deg = 13.5
| mark6 =Diamond_sheer_black_20.png
  | mark6size = 20
  | label6 = 45.0
  | lat6_deg = 45.00
  | lon6_deg = 13.5
| mark7 =Diamond_sheer_black_20.png
  | mark7size = 20
  | label7 = 45.5
  | lat7_deg = 45.50
  | lon7_deg = 13.5
| mark8 =Diamond_sheer_black_20.png
  | mark8size = 20
  | label8 = 46.0
  | lat8_deg = 46.00
  | lon8_deg = 13.5
| label9 = ''CROATIA''
  | label9_size = 165
  | mark9size = <!--label only-->
  | lat9_deg = 42.60
  | lon9_deg = 14.4
}}

Map with a custom label and text background

Imotski (Croatia)
Imotski
Imotski
Imotski in Croatia
{{Location map many/sandbox2 | Croatia
| width = 280
| float = right
| caption = Imotski in Croatia
| label = Imotski
| position = right
| background = #FFFFDD
| lat_deg = 43.44
| lon_deg = 17.21
}}

Map with enlarged marker and label

Pag (Croatia)
Pag
Pag
Pag Island in Croatia
{{Location map many/sandbox2 | Croatia
| width = 260
| float = right
| caption = Pag Island in Croatia
| label = Pag
| label_size = 200
| position = right
| marksize = 14
| background = #FFFFDD
| lat_deg = 44.44
| lon_deg = 15.05
}}

Map with no caption

Brčko (Bosnia and Herzegovina)
Brčko
Brčko
{{Location map many/sandbox2 | Bosnia
| width = 150
| float = right
| caption =
| label = Brčko
| position = left
| lat_deg = 44.87
| lon_deg = 18.81
}}

Western Hemisphere

Lockerbie (the United Kingdom)
Lockerbie
Lockerbie
Lockerbie in Scotland


Longitude#1 (3) < map min (-11).
Longitude#1 (3) > map max (2.2).

{{Location map many/sandbox2 | United Kingdom
| width = 180
| float = right
| caption = Lockerbie in Scotland
| label = Lockerbie
| position = right
| lat_deg=55 | lat_min=07 | lat_sec=16
| lat_dir=N
| lon_deg=3  | lon_min=21 | lon_sec=19
| lon_dir=W
}}

Country that crosses 180° meridian

Uelen (Russia)
<div style="position:absolute; z-index:2; top: Expression error: Missing operand for /.%; left: Expression error: Missing operand for *.%; height: 0; width: 0; margin: 0; padding: 0;">
Uelen
Uelen
Uelen (Russia)

Expression error: Missing operand for <.Expression error: Missing operand for >.Expression error: Missing operand for <.Expression error: Missing operand for >.

{{Location map many/sandbox2 | Russia
| width = 400
| float = right
| label = Uelen
| position = left
| background = #FFFFDD
| lat_deg=66  | lat_min = 09
| lat_dir=N
| lon_deg=169 | lon_min = 48
| lon_dir=W
}}

Implementation notes

The map with markers/labels is implemented as nested HTML divisions. The map-image is in an HTML division, containing each point as a percent-locator division containing a marker-image sub-division plus a label sub-division. Each point is calculated (for a percent-locator division) with X or Y coordinate "XX.X%" or "YY.Y%" as follows:

  • The div-tag is "<div style="position: absolute; z-index: 2; top: XX.X%; left: YY.Y%; ...>"
  • For placing latitude, the calculation is:
  • XX.X% = 99.9 * (top - (lat_deg + latmin/60 +latsec/3600) ) / (top - bottom)
  • If lat_deg is empty, the combined decimal latitude is used from "lat".
  • If lat_dir is "S" (south), the latitude is multiplied by -1.
  • (Note latitude is positioned in reverse, from top of map downward.)
  • For placing longitude, the calculation is:
  • YY.Y% = 99.2 * ( (lon_deg + lonmin/60 +lonsec/3600) - left ) / (right - left)
  • If lon_deg is empty, the combined decimal longitude is used as "long".
  • If lon_dir is "W" (west), the longitude is multiplied by -1.
  • The div-tag is ended as "height: 0; width: 0; margin: 0; padding: 0;">".
  • Within that division the marker/label sub-divisions are coded as:
  • <div style="position: relative text-align: center; ...">.
  • For label position, the options are shifted as:
  • when position=left, adds "left: -6.5em; text-align: right;"
  • when position=right, adds "left: 0.5em; text-align: left;"
  • when position=top, adds "top:-2.65em; left:-3em; text-align: center;"
  • when position=bottom, adds "top:-0.15em; left: -3em; text-align: center;" to div-tag.

See also