Difference between revisions of "Template:Location map/doc"

From blackwiki
Jump to navigation Jump to search
imported>Euriditi
imported>Zyxw
(update and merge examples)
Line 129: Line 129:
 
|-
 
|-
 
| <code>position</code>
 
| <code>position</code>
| The position of the label relative to the mark. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. The default is <code>right</code>''.
+
| The position of the label relative to the mark. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. This defaults to either <code>left</code> or <code>right</code>, depending on the coordinates of the marker and its position relative to the right border of the map image.
 
|-
 
|-
 
| <code>background</code>
 
| <code>background</code>
Line 183: Line 183:
  
 
=== Default width and float, no label, default caption (decimal coordinates) ===
 
=== Default width and float, no label, default caption (decimal coordinates) ===
 +
Note: When a label is not specified, the default caption is "Page name (Map name)", so if this example was viewed on a page named ''Pag'', the default caption would be "Pag (Croatia)". Likewise, on a page named ''Pag (town)'', the default caption would be "Pag (town) (Croatia)".
 
{{Location map | Croatia
 
{{Location map | Croatia
 
| alt    = Pag is on an island.
 
| alt    = Pag is on an island.
Line 195: Line 196:
 
}}
 
}}
 
</pre>
 
</pre>
Note: When a label is not specified, the default caption is "Page name (Map name)", so if this example was viewed on a page named ''Pag'', the default caption would be "Pag (Croatia)". Likewise, on a page named ''Pag (town)'', the default caption would be "Pag (town) (Croatia)".
 
 
{{clear}}
 
{{clear}}
  
 
=== Map with the default caption (degrees/minutes) ===
 
=== Map with the default caption (degrees/minutes) ===
 +
Note: When a label is specified, the default caption is "Label text (Map name)", seen as "Pag (Croatia)" in this example.
 
{{Location map | Croatia
 
{{Location map | Croatia
 
| width = 200
 
| width = 200
Line 221: Line 222:
 
}}
 
}}
 
</pre>
 
</pre>
Note: When a label is specified, the default caption is "Label text (Map name)", seen as "Pag (Croatia)" in this example.
 
 
{{clear}}
 
{{clear}}
  
=== Marker/Label outside of Map ===
+
=== Mark outside of map border, no caption ===
 
{{Location map | Croatia
 
{{Location map | Croatia
 
| width    = 200
 
| width    = 200
 
| float    = right
 
| float    = right
| alt      = Rubicon in Italy (outside the map)
+
| caption  =
| label    = Rubicon
+
| alt      = Rimini in Italy (outside the map)
 +
| lat_deg  = 44.05
 +
| lon_deg  = 12.57 <!--outside map's left border at 13.1-->
 +
| label    = Rimini
 
| position = right
 
| position = right
| lat_deg  = 44.44
 
| lon_deg  = 11.85 <!--outside map-->
 
 
}}
 
}}
 
<pre style="width: 40em;">
 
<pre style="width: 40em;">
Line 238: Line 239:
 
| width    = 200
 
| width    = 200
 
| float    = right
 
| float    = right
| alt      = Rubicon in Italy (outside the map)
+
| caption  =
| label    = Rubicon
+
| alt      = Rimini in Italy (outside the map)
 +
| lat_deg  = 44.05
 +
| lon_deg  = 12.57 <!--outside map's left border at 13.1-->
 +
| label    = Rimini
 
| position = right
 
| position = right
| lat_deg  = 44.44
 
| lon_deg  = 11.85 <!--outside map-->
 
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Map with a custom caption and text background ===
+
=== Caption, label_size, background, mark, marksize ===
{{Location map | Croatia
+
{{Location map | Italy
 
| width      = 200
 
| width      = 200
 
| float      = right
 
| float      = right
| caption    = Imotski in Croatia
+
| caption    = Location of Rimini in Italy
| alt        = Imotski is in Croatia.
+
| alt        = Map of Italy with mark showing location of Rimini
| label      = Imotski
+
| label      = Rimini
| position  = right
+
| label_size = 150 <!--150% of normal size-->
| background = #FFFFDD
+
| position  = bottom
| lat_deg    = 43.44
+
| background = orange
| lon_deg    = 17.21
+
| mark      = Orange_pog.svg
 +
| marksize  = 12 <!--size in pixels-->
 +
| lat_deg    = 44.05
 +
| lon_deg    = 12.57
 
}}
 
}}
 
<pre style="width: 40em;">
 
<pre style="width: 40em;">
{{Location map | Croatia
+
{{Location map | Italy
 
| width      = 200
 
| width      = 200
 
| float      = right
 
| float      = right
| caption    = Imotski in Croatia
+
| caption    = Location of Rimini in Italy
| alt        = Imotski is in Croatia.
+
| alt        = Map of Italy with mark showing location of Rimini
| label      = Imotski
+
| label      = Rimini
| position  = right
+
| label_size = 150 <!--150% of normal size-->
| background = #FFFFDD
+
| position  = bottom
| lat_deg    = 43.44
+
| background = orange
| lon_deg    = 17.21
+
| mark      = Orange_pog.svg
 +
| marksize  = 12 <!--size in pixels-->
 +
| lat_deg    = 44.05
 +
| lon_deg    = 12.57
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Map with enlarged marker and label ===
+
{{anchor|Using Alternative Map}}<!--former section name for links from other pages-->
{{Location map | Croatia
+
=== AlternativeMap parameter ===
| width      = 200
+
{{Location map | Italy
| float      = right
+
| AlternativeMap = Italy location map.svg
| caption    = Pag Island in Croatia
+
| width   = 200
| alt        = Pag is on an island
+
| float   = right
| label      = Pag
+
| caption = Location of Rome in Italy
| label_size = 200 <!--200% larger-->
+
| alt     = Map of Italy with mark showing location of Rome
| position  = right
+
| label   = Rome
| background = #FFFFDD
+
| lat_deg = 41.9
| marksize  = 14
+
| lon_deg = 12.5
| lat_deg    = 44.44
 
| lon_deg    = 15.05
 
}}
 
<pre style="width: 40em;">
 
{{Location map | Croatia
 
| width      = 200
 
| float      = right
 
| caption    = Pag Island in Croatia
 
| alt        = Pag is on an island
 
| label      = Pag
 
| label_size = 200 <!--200% larger-->
 
| position  = right
 
| background = #FFFFDD
 
| marksize  = 14
 
| lat_deg    = 44.44
 
| lon_deg    = 15.05
 
}}
 
</pre>
 
{{clear}}
 
 
 
=== Map with no caption or border ===
 
{{Location map | Bosnia
 
| width   = 200
 
| float   = right
 
| caption =
 
| alt     = Brčko is in northeast Bosnia.
 
| label   = Brčko
 
| position = left
 
| lat_deg = 44.87
 
| lon_deg = 18.81
 
 
}}
 
}}
 
<pre style="width: 40em;">
 
<pre style="width: 40em;">
{{Location map | Bosnia
+
{{Location map | Italy
| width   = 200
+
| AlternativeMap = Italy location map.svg
| float   = right
+
| width   = 200
| caption =
+
| float   = right
| alt     = Brčko is in northeast Bosnia.
+
| caption = Location of Rome in Italy
| label   = Brčko
+
| alt     = Map of Italy with mark showing location of Rome
| position = left
+
| label   = Rome
| lat_deg = 44.87
+
| lat_deg = 41.9
| lon_deg = 18.81
+
| lon_deg = 12.5
 
}}
 
}}
 
</pre>
 
</pre>
Line 332: Line 310:
 
{{anchor|Relief}}<!--former section name for links from other pages-->
 
{{anchor|Relief}}<!--former section name for links from other pages-->
 
=== Relief parameter ===
 
=== Relief parameter ===
{{Location map | Mexico
+
Also demonstrates automatic positioning of label to the left, due to far right position of mark.
| relief  = 1
 
| label   = Popocatépetl
 
| lat_deg = 19 | lat_min =  1 | lat_sec = 20 | lat_dir = N
 
| lon_deg = 98 | lon_min = 37 | lon_sec = 40 | lon_dir = W
 
}}
 
<pre style="width: 40em;">
 
{{Location map | Mexico
 
| relief  = 1
 
| label  = Popocatépetl
 
| lat_deg = 19 | lat_min =  1 | lat_sec = 20 | lat_dir = N
 
| lon_deg = 98 | lon_min = 37 | lon_sec = 40 | lon_dir = W
 
}}
 
</pre>
 
{{clear}}
 
 
 
{{Location map | Mexico
 
| relief  =
 
| label  = Popocatépetl
 
| lat_deg = 19 | lat_min =  1 | lat_sec = 20 | lat_dir = N
 
| lon_deg = 98 | lon_min = 37 | lon_sec = 40 | lon_dir = W
 
}}
 
<pre style="width: 40em;">
 
{{Location map | Mexico
 
| relief  =
 
| label  = Popocatépetl
 
| lat_deg = 19 | lat_min =  1 | lat_sec = 20 | lat_dir = N
 
| lon_deg = 98 | lon_min = 37 | lon_sec = 40 | lon_dir = W
 
}}
 
</pre>
 
{{clear}}
 
 
 
{{anchor|Using Alternative Map}}<!--former section name for links from other pages-->
 
=== AlternativeMap parameter ===
 
 
{{Location map | Nepal
 
{{Location map | Nepal
| AlternativeMap = Nepal relief location map.jpg
+
| relief = yes
 
| caption = Location of Biratnagar Airport in Nepal
 
| caption = Location of Biratnagar Airport in Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| label = Biratnagar
 
| label = Biratnagar
| position = top
 
 
| mark = Airplane silhouette.svg
 
| mark = Airplane silhouette.svg
 
| marksize = 10
 
| marksize = 10
Line 379: Line 323:
 
<pre style="width: 40em;">
 
<pre style="width: 40em;">
 
{{Location map | Nepal
 
{{Location map | Nepal
| AlternativeMap = Nepal relief location map.jpg
+
| relief = yes
 
| caption = Location of Biratnagar Airport in Nepal
 
| caption = Location of Biratnagar Airport in Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| label = Biratnagar
 
| label = Biratnagar
| position = top
 
 
| mark = Airplane silhouette.svg
 
| mark = Airplane silhouette.svg
 
| marksize = 10
 
| marksize = 10
Line 393: Line 336:
  
 
{{Location map | Nepal
 
{{Location map | Nepal
| AlternativeMap =
+
| relief =  
 
| caption = Location of Biratnagar Airport in Nepal
 
| caption = Location of Biratnagar Airport in Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| label = Biratnagar
 
| label = Biratnagar
| position = top
 
 
| mark = Airplane silhouette.svg
 
| mark = Airplane silhouette.svg
 
| marksize = 10
 
| marksize = 10
Line 405: Line 347:
 
<pre style="width: 40em;">
 
<pre style="width: 40em;">
 
{{Location map | Nepal
 
{{Location map | Nepal
| AlternativeMap =
+
| relief =  
 
| caption = Location of Biratnagar Airport in Nepal
 
| caption = Location of Biratnagar Airport in Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| alt = Biratnagar Airport is located in southeastern Nepal
 
| label = Biratnagar
 
| label = Biratnagar
| position = top
 
 
| mark = Airplane silhouette.svg
 
| mark = Airplane silhouette.svg
 
| marksize = 10
 
| marksize = 10
Line 426: Line 367:
 
| alt = Lockerbie is in southern Scotland.
 
| alt = Lockerbie is in southern Scotland.
 
| label = Lockerbie
 
| label = Lockerbie
| position = right
 
 
| mark = Blue_pog.svg
 
| mark = Blue_pog.svg
 
| marksize = 9
 
| marksize = 9
Line 439: Line 379:
 
| alt = Lockerbie is in southern Scotland.
 
| alt = Lockerbie is in southern Scotland.
 
| label = Lockerbie
 
| label = Lockerbie
| position = right
 
 
| mark = Blue_pog.svg
 
| mark = Blue_pog.svg
 
| marksize = 9
 
| marksize = 9
Line 454: Line 393:
 
| alt = Lockerbie is in southern Scotland.
 
| alt = Lockerbie is in southern Scotland.
 
| label = Lockerbie
 
| label = Lockerbie
| position = right
 
 
| mark = Blue_pog.svg
 
| mark = Blue_pog.svg
 
| marksize = 9
 
| marksize = 9
Line 467: Line 405:
 
| alt = Lockerbie is in southern Scotland.
 
| alt = Lockerbie is in southern Scotland.
 
| label = Lockerbie
 
| label = Lockerbie
| position = right
 
 
| mark = Blue_pog.svg
 
| mark = Blue_pog.svg
 
| marksize = 9
 
| marksize = 9

Revision as of 03:32, 21 August 2012

This template generates a location map as a composite image consisting of a map and a location mark. Optionally a label and caption can be added.

Usage

Map image files are not accessed directly but by using an auxiliary map definition template. For example, if the first unnamed parameter supplied to this template is "Japan", then this template uses the auxiliary template, {{Location map Japan}} which contains the data needed to generate the composite image.

Please note
  • Assigning any value to the parameter caption causes the map to be displayed as a thumbnail image. If this parameter is not declared, the template will generate a default caption.
  • The coordinates are not checked. If the coordinates specified fall outside the area covered by the map image, the location mark will not display inside the image, however, it may be displayed somewhere else on the page.
  • Do not use px. Using width=200px will usually cause a very large map to be displayed. Use width=200.
  • To create a map with more than one location mark use {{Location map+}} or {{Location map many}}.

Blank templates

Lua error in Module:Location_map at line 501: Unable to find the specified location map definition: "Module:Location map/data/USA relief" does not exist.

Decimal degrees Degrees, minutes, seconds
{{Location map
| {{{1}}}
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| relief     = 
| AlternativeMap = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| link       = 
| lat_deg    = 
| lon_deg    = 
}}
{{Location map
| {{{1}}}
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| relief     = 
| AlternativeMap = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| link       = 
| lat_deg    = 
| lat_min    = 
| lat_sec    = 
| lat_dir    = 
| lon_deg    = 
| lon_min    = 
| lon_sec    = 
| lon_dir    = 
}}

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.
relief Any non-blank value (1, yes, etc.) will cause the template to display the map specified in the map definition template as image1, which is usually a relief map. See the example at Location map+/relief.
AlternativeMap Allows the use of an alternative map. The image must have the same edge coordinates as the location map template. See the example at Location map+/AlternativeMap.
overlay_image Allows an overlay to be superimposed on the map. This parameter is seldom used. See the example at Location map+/overlay.
Label and mark parameters
Parameter Description
label 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 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%.
label_width The width to use for the label, given as an em size. The default is 6. Do not include em, for example: label_width=7, not label_width=7em.
position The position of the label relative to the mark. Valid values are left, right, top and bottom. This defaults to either left or right, depending on the coordinates of the marker and its position relative to the right border of the map image.
background 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 The name of an image to display as the mark. The default is Red pog.svg (8px). See examples at Commons:Location markers and Commons:Category:Map icons.
marksize The size of the mark in pixels. The default is 8. Do not include px, for example: marksize=10, not marksize=10px.
link 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 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 The minutes of latitude.
lat_sec The seconds of latitude. Usually not necessary.
lat_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 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 The minutes of longitude.
lon_sec The seconds of longitude. Usually not necessary.
lon_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).

Available map templates

There are over 1000 map templates available. To find other templates:

Creating new map definition templates

See Creating a new map template.

Examples

Default width and float, no label, default caption (decimal coordinates)

Note: When a label is not specified, the default caption is "Page name (Map name)", so if this example was viewed on a page named Pag, the default caption would be "Pag (Croatia)". Likewise, on a page named Pag (town), the default caption would be "Pag (town) (Croatia)".

Location map/doc (Croatia)
{{Location map | Croatia
| alt     = Pag is on an island.
| lat_deg = 44.44
| lon_deg = 15.05
}}

Map with the default caption (degrees/minutes)

Note: When a label is specified, the default caption is "Label text (Map name)", seen as "Pag (Croatia)" in this example.

Pag (Croatia)
{{Location map | Croatia
| width = 200
| float = right
| alt = Pag is on an island.
| label = Pag
| position = right
| mark = Green pog.svg <!--green dot-->
| lat_deg = 44 | lat_min = 26 <!-- lat_dir = N -->
| lon_deg = 15 | lon_min = 3  <!-- lat_dir = E -->
}}

Mark outside of map border, no caption

{{Location map | Croatia
| width    = 200
| float    = right
| caption  =
| alt      = Rimini in Italy (outside the map)
| lat_deg  = 44.05
| lon_deg  = 12.57 <!--outside map's left border at 13.1-->
| label    = Rimini
| position = right
}}

Caption, label_size, background, mark, marksize

{{Location map | Italy
| width      = 200
| float      = right
| caption    = Location of Rimini in Italy
| alt        = Map of Italy with mark showing location of Rimini
| label      = Rimini
| label_size = 150 <!--150% of normal size-->
| position   = bottom
| background = orange
| mark       = Orange_pog.svg
| marksize   = 12 <!--size in pixels-->
| lat_deg    = 44.05
| lon_deg    = 12.57
}}

AlternativeMap parameter

{{Location map | Italy
| AlternativeMap = Italy location map.svg
| width   = 200
| float   = right
| caption = Location of Rome in Italy
| alt     = Map of Italy with mark showing location of Rome
| label   = Rome
| lat_deg = 41.9
| lon_deg = 12.5
}}

Relief parameter

Also demonstrates automatic positioning of label to the left, due to far right position of mark.

Location of Biratnagar Airport in Nepal
{{Location map | Nepal
| relief = yes
| caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
| label = Biratnagar
| mark = Airplane silhouette.svg
| marksize = 10
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
}}
Location of Biratnagar Airport in Nepal
{{Location map | Nepal
| relief = 
| caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
| label = Biratnagar
| mark = Airplane silhouette.svg
| marksize = 10
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
}}

Same coordinates on different maps

Lua error in Module:Location_map at line 501: Unable to find the specified location map definition: "Module:Location map/data/Scotland relief" does not exist.

{{Location map | Scotland relief
| width = 180
| float = right
| caption = Lockerbie in Scotland
| alt = Lockerbie is in southern Scotland.
| label = Lockerbie
| mark = Blue_pog.svg
| marksize = 9
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W
}}

Lua error in Module:Location_map at line 501: Unable to find the specified location map definition: "Module:Location map/data/Scotland relief 2" does not exist.

{{Location map | Scotland relief 2
| width = 180
| float = right
| caption = Lockerbie in Scotland
| alt = Lockerbie is in southern Scotland.
| label = Lockerbie
| mark = Blue_pog.svg
| marksize = 9
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W
}}

Map that crosses 180° meridian

See Category:Location map templates crossing 180th meridian
{{Location map | Fiji
| width      = 180
| float      = right
| label      = Suva
| position   = right
| background = yellow
| mark       = Locator_Dot.png
| marksize   = 7
| lat_deg =  18 | lat_min =  8 | lat_sec = 0 | lat_dir = S
| lon_deg = 178 | lon_min = 26 | lon_sec = 0 | lon_dir = E
}}

Additional examples

For similar examples, see the documentation at Template:Location map+, as well as:

See also

Template:Sister project Template:Sister project

Location map templates
Infoboxes incorporating Location map - any country or region
List
Infoboxes incorporating Location map - specific countries or regions
Other templates