Batakan:Location map

Dokumentasyon han batakan

This template is used on 428,000+ pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them.

Uses Lua:

Module:Location map

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. For example, if the first unnamed parameter supplied to this template is "Japan", then this template uses the entry for Japan in Module:Location map/data/Japan if it exists, or {{Location map Japan}} otherwise, one of 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

Location of Yellowstone in the northwestern United States

Decimal degrees

Degrees, minutes, seconds

{{Location map
| {{{1}}}
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| relief     = 
| AlternativeMap = 
| overlay_image = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| link       = 
| lat_deg    = 
| lon_deg    = 
}}

{{Location map
| {{{1}}}
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| relief     = 
| AlternativeMap = 
| overlay_image = 
| 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, specifying England will use the values for England in Module:Location map/data/England if it exists, or {{Location map England}} otherwise. See the examples below.
`width`	Determines the width of the map in pixels, overriding any default values. Do not include `px`, for example: `width=300`, not `width=300px`.
`default_width`	Determines the default width of the map in pixels, intended for use by templates e.g. place infoboxes. The default value is 240. Do not include `px`. This value will be multiplied by the `defaultscale` parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps. For example if `default_width=200` is given, a map of Thailand will be displayed with a width of 200 * 0.57 = 114 pixels (as specified in Template:Location map Thailand).
`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 (). 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 maps

There are over 1000 maps available. To find other maps:

Special:PrefixIndex/Module:Location map/data/ - Checked before a map template is searched for. New maps should be created here rather than creating new templates.
Template:Location map/List - some 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

Creating new map definitions

See Creating a new map definition.

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 (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

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 <!-- default: lat_dir = N -->
| lon_deg = 15 | lon_min = 3  <!-- default: lon_dir = E -->
}}

Mark outside of map border, no caption

Rimini

{{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-->
| outside  = 1 <!-- we're aware the point is outside the map, so suppress the warning category -->
| label    = Rimini
| position = right
}}

Caption, label_size, background, mark, marksize

Rimini

Location of Rimini in Italy

{{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

Rome

Location of Rome in Italy

{{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.

Biratnagar

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
}}

Biratnagar

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

Lockerbie

Lockerbie in Scotland, UK

{{Location map | UK Scotland
| relief = 1
| width = 180
| float = right
| caption = Lockerbie in Scotland, UK
| 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
}}

Lockerbie

Lockerbie in Scotland, UK

{{Location map | United Kingdom
| relief = 1
| width = 180
| float = right
| caption = Lockerbie in Scotland, UK
| 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

Suva

Suva (Fiji)

{{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
}}

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Location map

This template places a location mark on a map.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Map name	`1`	The name of the map to be used	String	required
Map width	`width`	Determines the width of the map in pixels, overriding any default values. Do not include "px", for example: "300", not "300px".	Number	optional
Default width	`default_width`	Determines the default width of the map in pixels, intended for use by templates such as infoboxes. The default value is 240. Do not include "px". This value will be multiplied by the defaultscale parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps.	Number	optional
Position	`float`	Specifies the position of the map on the page. Valid values are left, right, center and none. The default is right.	String	optional
Border color	`border`	Specifies the color of the map border. If set to none, no border will be generated.	String	optional
Map caption	`caption`	The text of a caption to be displayed below the map. 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.	String	optional
Alt text	`alt`	Alt text for map; used by screen readers.	String	optional
Alternative map from template	`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.	String	optional
Alternative map not from template	`AlternativeMap`	Allows the use of an alternative map. The image must have the same edge coordinates as the map template.	String	optional
Overlay image	`overlay_image`	Allows an overlay to be superimposed on the map. This parameter is seldom used.	String	optional
Marker label	`label`	The text of the label to display next to the mark. A wiki link can be used.	String	optional
Label size	`label_size`	The font size to use for the label, given as a percentage of the normal font size. Do not include "%".	Number	optional
Label width	`label_width`	The width to use for the label, given as an em size. Do not include "em".	Number	optional
Label position	`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.	String	optional
Label background	`background`	The background color to use for the label.	String	optional
Marker image	`mark`	The name of an image to display as the marker.	String	optional
Marker size	`marksize`	The size of the mark in pixels. Do not include "px".	Number	optional
Marker link	`link`	Specifies a wiki link which will be followed if the reader clicks on the mark.	String	optional
Latitude degrees	`lat_deg`	The degrees of latitude. This value can be specified using decimal degrees. When this format is used minutes and seconds should not be specified.	Number	required
Latitude minutes	`lat_min`	The minutes of latitude.	Number	optional
Latitude seconds	`lat_sec`	The seconds of latitude.	Number	optional
Latitude direction	`lat_dir`	N if north or S for south of the Equator. Not required if using signed decimal degrees.	String	optional
Longitude degrees	`lon_deg`	The degrees of longitude. This value can be specified using decimal degrees. When this format is used minutes and seconds should not be specified.	Number	required
Longitude minutes	`lon_min`	The minutes of longitude.	Number	optional
Longitude seconds	`lon_sec`	The seconds of longitude.	Number	optional
Longitude direction	`lon_dir`	E for east or W for west of the Prime Meridian. Not required if using signed decimal degrees.	String	optional