Template:OSM Location map

File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

Technical issue

Documentation

Template:OSM Location map/coretemp This template provides a map in a frame, for any location and scale. At its simplest it shows the OpenStreetMap image and a scale indicator for a given region of the globe. Optionally locations on the map can be highlighted using markers and text labels or numbered dots, a heading and caption can be added, and a mini-locator map can be shown to provide context for the map. The frame also provides a link to an 'Interactive fullscreen' version that allows the user to zoom and scroll and that can also display images at marked locations.

Purpose

OSM Location map allows an editor to include a map in a frame for anywhere in the world, at any scale from the whole world down to one or two streets. It makes use of the OpenStreetMap mapping data, and enables a place-based page or topic to simply show the area being described, without the need for pre-determined map templates or external graphics. The underlying map will be updated and improved automatically as the OSM data develops. A zoom level appropriate to the topic can be selected and a scale marker is provided in the bottom right corner. This only offers a rough guide to the distances on the map, as the map projection results in scale changes depending on the latitude. Some allowance has been made for this, but only in large 20 degree chunks.

The map can also be made to show multiple marks, images and labels (currently limited to 60). The resulting framed map also has a link to an interactive full-screen version, which shows the same location 'over the top' of the current page. This is not able to show any text or other images, so is limited to pointer marks. However in other respects it has a richer map interface, can be re-scaled and panned by the user, can be given popup thumbnail images and captions on the marker points, and also provides yet further links to access a wide range of maps, satellite images etc. (The fullscreen option uses the <maplink> mapping provision.)

OSM Location map is in effect a wrapper above another template called {{Graph:Street map with marks}}. Where very large datasets are being used it may be better to utilise the Graph template directly as that allows unlimited numbers of marks and labels. However it requires a different coding mark-up (GeoJSON) and is not well suited to hand-coding. It is particularly suited to using data-sets directly extracted via automatic searches of Wikidata.

Comparison with {{Maplink}}

From May 2018 it has also been possible to create a map in a frame via {{Maplink}}, which in some respects does a similar job to OSM Location map. In both cases a static map image can be added to an article, for anywhere in the world, pulling in the map from OpenStreetMap data. The differences are in what they can and can't add to the base map. Maplink, in both its framed and fullscreen versions, can only add either points (numbered or icon-style pointy dots), or various lines and areas can be imported from OpenStreetMap via wikidata Q values (at present limited to boundaries, and roads). Thus the framed map and fullscreen version will show identical information. The OSM Location map on the other hand, cannot add the Q value lines and areas except to the interactive fullscreen click-through. On the other hand it can use the framed map to show a much richer selection of dots, shapes, overlays, images and especially text to convey specific details relevant to a particular article.

Usage

Minimal version

an unadorned map centred on a latitude and longitiude coordinates, via a {{coord}} value. Set the zoom to give a scale that fits the subject (0=whole world, 18=a street). With just these options set, all other parameters use the defaults, or are left unused. It also gives a link to the interactive fullscreen version.

<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp </syntaxhighlight>

Single marker

By using mostly default settings a map with a 'Red pog' marker and dark red label can be produced. The example below also adds some additional items (the last three parameters) that are used by the Interactive fullscreen version. Template:OSM Location map/coretemp

<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp</syntaxhighlight>

Template:- Code blank

Blank code for a single marker map	Blank code with comments
<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp</syntaxhighlight>	<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp</syntaxhighlight>

Multiple markers, labels and images

In addition to the un-numbered mark parameter set, there are 60 numbered ones. These are otherwise identical to the one above, but the name terminates in a number (1-60). Each mark and label has its own set of parameters (|mark1=, |mark-coord1=, |label1=, |label-pos1= etc...|mark2=, |mark-coord2=, |label2=, |label-pos2= etc.) Values can be inherited either from the 'mark1 master parameter set', or from a special 'markD' Default set that provides override defaults. When set, these values are inherited by the other numbered sets to avoid having to repeat for each, whilst they can still be set individually where required.

Multiple markers

Template:OSM Location map/coretemp

Example code for the two-marker map shown on the right:
<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp</syntaxhighlight>

Inherited values

To minimise repetition of code, there is a sliding scale of inheritance that applies to each value in each parameter set. For example, if label-size4=16 is set, that will always take precedence. If label-size4 has not been set, it will inherit the value from the special Default setting (defined using label-sizeD= ). If no Default has been set, it will inherit the value set by the 'master parameter set', label-size1=. If that is also undefined it will fall back to the underlying default, which in the case of label-size is 12. The same is true of all the variables relating to marks and labels, (although not to the coordinates, labels themselves, or mark-titles, which are always unique to the particular mark they relate to.)

Adding a Minimap in the left or right corner

Many pages with info-boxes already include a locator map to give readers a proper sense of where the topic or place is located within a broader area. For those that don't it might be helpful to include one within your map. The underling 'Graph' module that OSM Location map uses offers a built-in map of the world option, which will act as a mini locator map and automatically adds a red locator dot (minimap = on). Unfortunately it is too general for most purposes, so an alternative, but rather less automated, option is to make use of an existing 'Location map' file. This can be seen in the Llanfechell map example.

The width and height of the Location map both have to be decided upon, specified (and calculated so as to not distort the map dimensions). Some location maps may already highlight the feature, but if not, an optional locator 'pog' can be placed by calculating and specifying the minipog-gx and -gy values, using a 100x100 grid across the minimap. (so gx and gy values of 25 and 50 would place a dot a quarter of the way across and half way down the minimap. It does not pick up or use latitude and longitude values. The origin (0,0) is in the top left of the minimap and the map itself defaults to the bottom right corner, but can also use minimap=file bottom left, minimap=file top left and minimap=file top right.

<syntaxhighlight lang="wikitext">

minimap = file bottom right

mini-file = Wales relief location map.jpg

mini-width = 70

mini-height = 90

minipog-gx = 36

minipog-gy = 5 </syntaxhighlight>

The dot will remain in the right place even if you subsequently choose a different size for the minimap. (Note, the now redundant minipog-x and minipog-y are retained for compatibility. These used the same pixel dimensions as the width and height of the map, which made them harder to calculate/guess and needed to be re-done if the size was changed. Much better to use gx and gy from here on.)

If the area of the actual map is a large portion of the mini-map, an open red box can be included instead of a dot, so as to show the bounds of the main map. To use this feature, simply specify the width of the required box: minimap-boxwidth=xx where xx = the percentage of the minimap width for the box. In general anything much below xx=15 will be better served by a dot. The box will be centered at the coordinates minipog-x and minipog-y. The required width will require some trial and error to pin down. The box height is then matched in proportion to the actual map and will scale if the minimap size changes.

Text on an arc

Text for broader geographic features can be placed around an arc, to convey a sense of a broader area, or to follow the curve of a river, mountain range, coastline, etc. This works entirely separately from the other labels. It does not attach itself to any mark or dot, and does not create any fullscreen markers. It requires coordinates for the first letter, parameters for the starting angle, radius of arc and gap between letters. Text size and color can also be specified, or inherited from Default settings.

Blank starter-code for text on an arcs, with starter-examples for different arc-patterns.
arc-coordA = ⧼validator-fatal-error⧽	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA =	arc-gapA =		arc-radiusA =	ellipse-factorA = </syntaxhighlight>
Details about using artc-text, with starter-examples for different arc-patterns.
The nature of the earth's coordinate system means that there will be some variation in an arc at different latitudes and at different zoom levels. The program makes corrections for this, but there will still be residual variation. Similarly, changes in radius will also have some effect on the gap size, with a larger radius opening out the gap somewhat. There will therefore need to be considerable trial and correction to get the shape and effect desired. As a general rule, identify the coordinates of the required start-point, then choose a starter-pattern from the selection below, and then adjust parameters to fit the requirement of the map.
Shallow smile: Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = -170	arc-gapA = -1.2	arc-radiusA = 1.6</syntaxhighlight>
Deeper smile: Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = -150	arc-gapA = -3	arc-radiusA = 0.7</syntaxhighlight>
wide eyebrow: Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = -20	arc-gapA = 3	arc-radiusA = 0.8</syntaxhighlight>
opening bracket (reading up): Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = -110	arc-gapA = 1.5	arc-radiusA = 0.6</syntaxhighlight>
opening bracket (reading down): Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = -60	arc-gapA = -2	arc-radiusA = 0.5</syntaxhighlight>
closing bracket (reading up): Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = 120	arc-gapA = -1.5	arc-radiusA = 0.8</syntaxhighlight>
closing bracket (reading down): Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| arc-coordA =	arc-textA =	arc-text-sizeA =	arc-text-colorA =	arc-angleA = 60	arc-gapA = 2.5	arc-radiusA = 0.4</syntaxhighlight>

Multi marker example

Template:OSM Location map/coretemp

Worked example of a map with multiple markers and text: Pentre Ifan
<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp </syntaxhighlight>

Alternative marks

Instead of using the standard 'Red pog' for mark points on the map, other images can be used. Any image from Wikimedia Commons can be specified. The Pentre Ifan example above uses 'Archaeological site icon (red).svg'. If a particular image file is specified in mark1=, all subsequent marks will use it as well unless they name their own image file. If the image is not square, a dimension value also needs to be set (width ratio for a height of 1)

Transparent overlay

A marker image does not have to be small and opaque. A larger overlay image (with a transparent background) can be used to show particular features not included in the base map, such as a town's former walls (see the adjacent map). Such images can be created in several ways (such as tracing over a copy of the base map); they are invoked like any other marker image file. (For a detailed guide to creating and deploying an overlay for these maps see User:J. Johnson/OSM overlay how-to). (See below for a way to achieve linear graphics such as this using text labels and Box Drawing Characters.)

Text color

Color of label text can be specified using label-color = . Standard html colors can be specified by name, and any color can be specified using the hex triplets coding #xxyyzz (see Web colors). However, to create a consistent look and feel across the wikipedia maps, there are some OSM Location map specific colors, with a more muted tone range that fit well with the color scheme of the base maps. In general it is best to make use of this range, unless there are good reasons for using other particular shades for specific features. Under normal usage, the following label color scheme should be followed:-

Template:Font color	Settlements = soft grey (Subject of the map can be hard grey and larger label-size) Map areas with darker or busier backgrounds may need to move a shade darker to hard grey and dark gray respectively.
Template:Font color	Rivers, lakes, sea areas etc = soft blue (Works well on top of OSM blue areas)
Template:Font color	Parkland, national/regional parks, gardens, forests etc = soft green works well on top of OSM green areas. (hard green may be desirable in forests or for the subject of the map)
Template:Font color	Use with care = dark red goes nicely with a red pog but can look like a redlink. Alas, no wikilinks possible on the map as yet.)
Template:Font color	Individual sites = dark grey (no need to specify if the site has a single label to accompany a red pog)

Full table of color options

Colors recommended for OSM Maps. These have a more pastel shade than the standard colors, so blend effectively with the map backgrounds
Template:Font color	Template:Font color	Template:Font color
Template:Font color	Template:Font color	Template:Font color
Template:Font color	Template:Font color	Template:Font color
Template:Font color	Template:Font color	Template:Font color
Template:Font color	Template:Font color	Template:Font color

Also available is 'background1' (#F9F5E7), which matches the most common map background. Useful for blanking out a bit of map using '█' character, to make a plainer background for putting a second label over the top. (This can be tricky to retain the right numbers with numbered dots, and really messes things up if using auto-caption.)

Text and Shape opacity and giving a shape a halo

With the 2021 changes to how the maps are displayed it has become possible to use opacity settings for both labels and the built-in shapes. For labels, use an additional '50%' indicator after the color name. (eg | label-color1 = soft grey 50% will make that text semi-transparent. Additional parameters are available to allow for transparency of both the shapes and outlines. In implementing this, it also became possible to offer a semi-transparent halo around built-in shapes and also around marks such as Red pog.svg. The table below shows a variety of possibilities for using these features.

Parameters to set opacity and a halo, with some examples.
<syntaxhighlight lang="wikitext">	shape-opacity=	outline-opacity=	shape-halo=xx </syntaxhighlight>
Some ideas for using opacity and halo options
There are many use cases for both putting a halo around either shape or marker, to highlight it or indicate a zone of influence, for example. Similarly, using the opacity option for shapes can either retain visibility of the map below or indicate variable intensity of an item. As with all wikipedia graphics, the use should be driven by the needs of the data, and sources for underlying information should be correctly referenced. Parameter settings for various options and combinations are shown below:-
Translucent circle to indicate a zone of interest: Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| shape1=circle	mark-size1=160	shape-color1=dark grey	shape-opacity1=20	outline-opacity1=1</syntaxhighlight>
Translucent circles by setting default values: by using 'D' instead of a parameter number, its value is applied as default to all the markers. Template:OSM Location map/coretemp <syntaxhighlight lang="wikitext">| shapeD=circle	shape-opacityD=50	outline-opacityD=60	shape-outlineD=black</syntaxhighlight>
Use of a halo to highlight a particular pog marker. Template:OSM Location map/coretemp<syntaxhighlight lang="wikitext">| shape-halo2=16</syntaxhighlight> (You can optionally also set the shape-color to a preferred halo color, which will not affect the pog marker)
Additional halo options with shapes and opacity Template:OSM Location map/coretemp On this busy background, the numbered marks are given a 50% opacity, to allow some visibility of the map below. To highlight the dot number 4, it is given a 100% opacity and a halo. Note how any opacity that is not 0 forces the halo to change to an open circle instead of a translucent disc. (nb, when using the built in shapes, the halo will always take the same color setting as the shape itself). <syntaxhighlight lang="wikitext">| shape-opacityD=50	label-sizeD=11	shapeD=n-circle	shape-colorD=dark blue	shape-outlineD=white	shape-halo4= 15	shape-opacity4= 100</syntaxhighlight>
50% Opacity: Any of the named colors has an option to make it only 50% opaque. eg <syntaxhighlight lang="wikitext">|label1=SCOTLAND	label-color1 = soft grey 50% </syntaxhighlight> will produce a translucent grey, in which the background map also has some visibility. (nb only works with 50%. and generally only use it with label-colors, as it may conflict with the other opacity settings. See below for how to get further gradations) And one of the Geeks! <syntaxhighlight lang="wikitext">| label-color=#1659165A</syntaxhighlight> It is possible to set an opacity value for text as well. But it can only be done by adding it as an additional two-digit hex to a color given as a #value. This will not work with the built in color-names, but you can use the hex values shown in the color section below to match the built in colours. The transparency digits 7 and 8 are two optional hex numbers, using the form #RRGGBBTT, where the TT values are hex numbers setting opacity between 0 (transparent) and 255 (opaque).

Text effects

multi-line label

Where label text is too long to fit on a single line, using label = , two further label lines can be used: labela = and labelb = .

Label with no mark

If mark-size=0 this has the effect of a free-floating label with no marker

Angled label

It is possible to specify a label-angle = , which will pivot the label text around the centre of the marker point by the specified angle. Using an angled label which also has no marker is particularly good for labelling various geographic and linear features. A more characterful alternative is to set the text on an arc, using the ArcText options, illustrated by the 'Preseli Hills' text on the Pentre Ifan map. For stylistic consistency settlement and building names should not normally be given an angle.

Numbered dots

Template:OSM Location map/coretemp If numbered dots are needed, instead of (or as well as) text labels, this can be achieved using the built in shapes. For example, shape1=n-circle will place a numbered dot at that coord position (or l-circle for letters). Generally it is much better to use the dots in sequence, so each numbered mark gives a numbered dot, and they will match the full screen ones. If auto-caption=1 then the caption will generate a numbered list using the mark-title entries. For example:-

<syntaxhighlight lang="wikitext"> Template:OSM Location map/coretemp </syntaxhighlight> The other built-in shapes can be used in the same way (n-square, n-diamond etc.). The shape-outline1= value sets the colour for the number (unlike normal, when it sets the shape-outline), and as with the others, only the mark1 parameter values need to be set, to establish the default for this map, which can be overridden as required. The numbered1..2..3 etc parameters can override the automatic numbers or letters to use your own values for each mark. {{Flushing Meadows-Corona Park map}} is a useful real life example in template form.

Use in infoboxes

{{OSM Location map}} can be imbedded in infoboxes which allow the module parameter, for instance {{infobox school}} by using the instruction |module={{OSM Location map| ...}}. For an example, see St John Fisher Catholic School which uses the map to show its two sites within an infobox map. Some infoboxes also allow it to be incorporated within the caption below an image. However, this only works if an image and some caption text are also present. (see Inishmore Lighthouse).

Using label text to draw graphic features

It is possible to use text labels to show simple graphics on a map, particularly by using unicode items in the Box Drawing selection. Copy and paste the individual characters as required, and set the relevant label-angle and label-size. Set the mark-size to 0 to avoid also getting a shape/dot. See example.

Multi-mark example that uses text as a drawing tool: Roman Walls at Caerleon
<syntaxhighlight lang="wikitext" style="overflow: auto; margin-right: 5px;"> Template:OSM Location map/coretemp </syntaxhighlight>

List of parameters

Code blank - OSM Location map template, listing all the parameters
<syntaxhighlight lang="wikitext">Template:OSM Location map/coretemp</syntaxhighlight>

Parameters

Map display parameters
Parameter	Description
coord	Latitude and longitude coordinates of the centre point of the map. Use coord=Template:Tlf. Template:Tlx can deal with a wide range of formats. e.g.: coord=Template:Tlf, coord=Template:Tlf, coord=Template:Tlf. This may not be the 'coord' points of the page, as an appropriate framing area for the map may place the subject off-centre. (Marker point(s) are set separately, see below). gridreferencefinder.com, is a helpful place to find coordinates, or you can right=click on the 'Interactive fullscreen map.
zoom	Sets the scale of the map, from 0 to 19, to the levels defined by OpenStreetMap. (details here). The actual distances represented will vary depending on the latitude, as the scale defines different fractions of a degree. The apparent scale will also vary hugely depending on the monitor being used, the browser magnification level, etc. For most Wikipedia situations, maps with a zoom of 10 (notionally 1:500,000) up to 16 (1:8,000) are likely to be of most use.
float	Positions the frame to the left, centre (or center) or right. (default is right). If centered, the text will be forced above and below, otherwise text will wrap to the side.
width height	Sets the width and height of the map in pixels. Only the number is required (i.e. no px). Default is 350 by 250 pixels.
fullscreen-option	By default an [Interactive Full screen] link is supplied in the bottom left of the frame. By setting this to 0 or no, the link will not appear, should that be preferred
nolabels	By default the base map uses a map label model called 'osm-int'l', in which progressively higher zoom levels bring more place names onto the map, and since 2022 these have been in the language/script of the wiki/user preference, where that is available. For some contexts it may be preferred to 'turn off' the place name labels, and use the mark/label options to provide such names as are wanted. By setting nolabels = 1 an alternative 'osm' base map is used, with no place name labels. (At higher zooms the road names still occur). (nb. at present this does not support an editor being able to set a language/script local to the map. In such cases, adding in the required text label manually is the best option).
caption auto-caption	Optionally, a text caption can be included, below the map. Unless overridden by tags etc., this is left-justified plain text. It can include any wiki-item that can be inserted into a table cell, including images, formatting, citation references, etc. If auto-caption=1, a numbered list will be automatically generated to follow any caption. This will generally only make sense when using numbered dots.
title	Optionally a title or other text can be placed in a cell above the map. By default this is centred and bold, but as with the caption, any wiki-markup etc. can be included.
map-data-heavy map-data-light map-data map-data-text map-data-color map-data-width	Allows OSM ExternalData elements to be added to the map. This can be an administrative boundary, highway or other map element that has been assigned a wikidata Q value. (e.g.: map-data=Q83065 will add the city boundary of Leicester.) The map item needs to be on the same place as the map itself. It currently only allows line features (not areas etc.), which appear as various styles of line. Multiple elements can be added, separating each Q value by a comma. A major limitation, as of May 2017, is that it only appears on the 'fullscreen' map, not on the framed map on the page. Adding map-data items now should mean they appear on the page if and when this limitation is overcome. nominatim.openstreetmap.org/ has a search engine to identify data elements for which Q values have been assigned, or to add wikidata Q values to map elements. For map-data-heavy and map-data-light, this will draw orange lines of thickness 9 and 3 pixels respectively. map-data is more flexible, so can default to an orange line of 6 pixels, but color (using format #XXXXXX) and width in pixels can be set, as can a text element which appears when the line is clicked on. This can include wikilinks.
minimap	Automated world map Used to add an optional locator minimap in the bottom right or left corner. If set to on it adds a 'built in' small(ish) world map with a locator dot showing the position of the main map. (This is a feature supplied by the underlying 'Graph:' template, so the only control over it can only be bottom right and is to be set as on or off. Other 'mini' parameters should be left blank). If set to off or not included a map is not used. External map To allow a map from wikimedia commons, plus optional locator dot, set to file it requires the next section details to be added, which will include a custom map and can be placed in any of the four corners. minimap=file bottom left minimap=file bottom right minimap=file top left minimap=file top right If just minimap=file is used it defaults to 'bottom right', but it is probably better to spell it out.
mini-file mini-width mini-height	Takes the file name of a standard location map from Commons (without File:), and displays it as a minimap in a corner, provided minimap=file. mini-width and mini-height are the desired dimensions of this minimap, in pixels. The ratio mini-width/mini-height must equal width/height of the mini-file to avoid distortion.
minipog-gx minipog-gy minimap-boxwidth	Within the custom minimap this can place an optional small Red pog. Nb. The x and y are not lat and lon values. They relate to a 100x100 grid of the minimap at whatever size it is set to. The origin is top,left of the mini map, so if minipog-gx=25, it will be a quarter of the way across. (Some location maps have a highlighted location already, so leaving these two parameters undefined gives the map without a dot.) minimap-boxwidth=xx can optionally use an open red box instead of a Red pog. xx = the width of the box, in percent of the width of the minimap. The height is then matched in proportion to the actual map. The box is centered at spot corresponding to (minipog-gx,minipog-gy). In general anything much below xx=15 will be better served by a dot. The required width will need some trial and error to pin down. If xx=0 or minimap-boxwidth is undefined, a Red pog is used.
scalemark	By default or with scalemark=1, a scale line with guide to the scale of the map is supplied near the bottom right corner of the map. If this is not required - e.g. if it interfers with a map element at that point - it can be turned off by setting this to '0'. To shift it further left, e.g. to avoid a minimap, or to avoid a 'busy' bit of the map, enter the number of pixels to shift left. If not set by hand it will automatically shift to the left of any bottom-right minimap.
Label and mark parameters.
Sixty-one marks can be set on the map, being an un-numbered version, and the rest numbered 1 to 60. The first numbered one, (mark1, label1, etc.) is a 'master marker' and its values (or defaults) are inherited by the other numbered markers unless set individually. All label, mark and full-screen parameters are available for each numbered marker. If the un-numbered mark is used as the subject of the map, it will be point 1 on the Full Screen map (unless mark-title=none) and can use specific mark and label values of its own. The first numbered mark has values that will be inherited by subsequent marks. For added flexibility a parameter set with a 'D' value instead of a number will override the master values with a more general Default.
Parameter	Description
shape	OSM Location map can use either an external image as a location marker, or one of various built-in shapes. Shape should either be set as =image or can be a circle, square, cross, diamond, triangle-up or triangle-down. If blank or absent it will default to 'image', and use either a Red pog.svg or specified mark = image. If numbered dots are required, use shape1=n-circle Subsequent markers will use the same setting, and automatically number up to 30. shape1=l-circle will do the same but with letters, and any of the built in shapes can be used.
shape-color shape-outline numbered	Set the shape infill and outline to any color, using either the color names shown under 'label-color' blow, or hex triplets (e.g. #FF0000), as described at Web colors. Only used for built in shapes. Setting them to the same value gives an appearance of no outline. Default = #B80000 (a dark red). The numbered = parameter is used with numbered shapes, to override the automatically allocated number.
shape-opacity outline-opacity	Set the opacity value for fill and outline of built-in shapes, as a percentage. 100 = a solid color, 1 = transparent. Note that 0 also = solid color, the same as having no opacity value set, which is the default state.
shape-halo	Sets a halo around a shape or mark. Give a size value for the halo, which relates to the area rather than diameter of the shape, and is in addition to the original shape-size. For example a mark-size=10 and shape-halo=15 will have a useful halo alround the mark. With shape-opacity of zero/undefined the halo will be a translucent filled shape to match the built-in shape, or in the case of pogs and other image files, a circle. For any other opacity value up to and including 100, the halo will be a translucent outline rather than infilled shape.
mark	The name of a Wikimedia commons file, which is used as the marker. Default is Red pog.svg. Other pog colours are available (see Commons: Map pointers, dotset 1), and a large range of map markers can be found at Commons:Location markers and Commons:Category:Map icons
mark-size mark-dim	Size and dimensions of a marker. mark-size is used by both shape and mark to define the size of the marker symbol. It sets the height of the mark or shape in pixels (no 'px' required, default is 10). If only a text label is wanted with no marker, set mark-size=0. mark-dim is used to give a non-square mark. (It has no effect with the built in shapes.) default is 1, i.e. equal width and height. A value of 1.4 will give a typical landscape rectangle. 0.7 will give a typical portrait rectangle. If the original mark-file is non square, a value here is needed to correct the proportions.
mark-coord	Latitude and longitude coordinates of the marker point. Use the format mark-coord={{Coord|lat value|lon value}}. Used by either shape and mark as well as the related label. If the location is outside the area of the map, it will not appear. (for backwards compatibility mark-lat and mark-lon still work, but are not the preferred method.)
label labela labelb	Text to appear alongside a mark or shape. No inline formatting, line wrapping, or other tags, links etc. are possible. If left blank then any mark will show without a label. If only a text label is wanted with no marker, set mark-size=0 A blank label and a mark-size=0 will result in an invisible marker, which will still feature on the Full screen option. If the label is too long for a single line, use labela and labelb for 2nd and 3rd lines. nb if labelb is set without a labela, there will still be a gap where labela would go.
label-size	Sets the text size for the label, in points. default = 10
label-color	Sets the text colour for the label. The standard colour labels (red, black, grey, white, blue, green etc...) all work as described, but can be rather strident on the OSM map. Each of the colors below have three standard shades - soft, hard and dark. Default=dark grey. (Actually defaults to #222211, slightly darker than 'dark grey', so it is prominent when someone just puts a single pog and label. Under normal usage, the following label color scheme should be followed:- Template:Font color Settlements = soft grey (Subject of the map can be hard grey and larger label-size). Map areas with darker or busier backgrounds may need to move a shade darker to hard grey and dark gray respectively. Template:Font color Rivers, lakes, sea areas etc = soft blue (Works well on top of OSM blue areas) Template:Font color Parkland, national/regional parks, gardens, forests etc = soft green works well on top of OSM green areas. (hard green may be desirable in forests or for the subject of the map) Template:Font color Use with care = dark red goes nicely with a red pog but can look like a redlink. Alas, no wikilinks possible on the map as yet.) Template:Font color Individual sites = dark grey (no need to specify if the site has a single label to accompany a red pog) Full table of colors recommended for OSM Maps. These have a more pastel shade than the standard colors, so blend effectively with the map backgrounds Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Standard html colors. These tend to look rather harsh on the OSM maps but are retained for compatibility Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color Template:Font color
label-pos	Sets the position of the label, relative to the marker: left, right, top or bottom. Default=left. Top and bottom text is center-justified, whereas left and right align against the marker. The label aims to be an appropriate distance from the edge of the marker, but irregular shapes and larger sizes may need further adjustment using the label-offsets.
label-angle	It is possible to specify a label-angle = , which will pivot the label text around the centre of the marker point by the specified number of degrees. (+ve angle rotates clockwise, -ve anticlockwise) If mark-size is set to zero, this has the effect of a free-floating label with no marker, useful for various geographic and linear features. For stylistic consistency all settlement names should not be given an angle.
label-offset-x label-offset-y	Allows adjustment of the label location in an x and y direction, relative to its mark coordinates, by the specified number of pixels. It can be +ve or -ve numbers. Higher -x values will move the label to the right. Higher -y values move it down the map. Default is 0,0.
Additional content for Full screen link
The 'full screen' map uses the same OSM base map, in a different map environment, including the option for users to scale in and out, to pan across the map, and to find (via the 'More details' button) other maps and satellite imagery for the location. It also includes numbered markers, for which tooltip-style titles, and image thumbnails with captions can be brought up. This makes most sense where there are several markers on the map. The content for this facility is set with the following three parameters - which need to be numbered for each mark as for the other mark attibutes:
Parameter	Description
mark-title	This title appears as a tooltip and also a thumbnail title, accessed via the marker. if mark-title=none that will exclude that marker from the full screen map. (it will still show as normal on the main map).
mark-image	This provides a pop-up thumbnail image when the marker is clicked. Include only the image name from Wikimedia commons etc. (i.e. no brackets, or 'File:').
mark-description	Caption text, which will either accompany a pop-up photo, or if no photo then as a text box, when the marker is clicked. This can include wikilinks etc., to link on to additional relevant articles.
Arc Text: label placed on an arc
The use of arc-text parameters allows a short text (up to 20 characters) to be placed along on arc, with parameters to control the tightness of the circle (radius) and the looseness of the text (gap). The nature of the earth's coordinate system means that there will be some variation in an arc at different latitudes and at different zoom levels. Some allowance is factored in, but there will still be residual variation. Similarly, changes in radius will also have some effect on the gap size, with a larger radius opening out the gap somewhat. There will therefore need to be a degree of trial and correction to get the shape and effect desired. As a general rule, identify the coordinates of the required start-point, then choose a starter-pattern from the selection at OSM Location map#Text on an arc, and then adjust parameters to fit the requirement of the map. The parameters below are for set A. Sets B and C are also available.
Parameter	Description
arc-coordA	coordinates of first letter, using ={{coord|xxx.xx|yyy.yy}}
arc-textA=	Add your text here
arc-angleA	in degrees, -180 to 180. 0 will start as horizontal, -90 straight up, 90 straight down
arc-gapA	1= a notional 'standard'. 0.2 is very tight, 10 is very wide. Applying a negative gap will invert the letters and run the other way around the circle
arc-radiusA	1= a notional 'standard' 0.5 is quite a tight circle, 8 is so wide as to be almost flat, dependent on latitude and zoom level
arc-text-colorA	sets text color. #000000 color hexes and standardised OSM Location map colors are accepted
ellipse-factorA	will squash or stretch the circle. 1= notionally circular, 0.5 to 1.0 will flattern top and bottom, above 1.0 flattens the sides.

Underlying technology

OSM Location map itself has no map or display ability of its own. Everything within the frame is produced through the template {{Graph:Street map with marks}}, created by User:Yurik. This in turn calls internal processes that turn all the data supplied into a rendered bitmap image. As of 2020, this has been carried out as required for each page view, creating a considerable resource overhead. Hopefully this is being kept in bounds by caching systems, but does mean the resulting images are at the highest resolution, with a major improvement in appearance.

Until 2020 a map being edited and previewed was supplied as a rasterised image, collating the base-map, marks, labels, etc. on the fly, but when the 'Publish Changes' button is pressed, it generated a lower-resolution bitmap with much worse fonts than the preview. Unfortunately, with both the old and new rasterisation methods, there is still no text or objects on the final image, so there is no possibility of adding wikilinks or clickable hot-spots to the maps.

The full screen option, which can be clicked through from below the map, provides an entirely different mapping approach, using the same base-map data. This provides an interactive map that can be panned and zoomed. It also replicates (although at present only as numbered markers) the various marks from the page map. These can then be given more content, by way of a title, caption and image along with displaying the coordinate values. The caption and title can then be given all the wikilinks and other markup features that may be desired, providing a map-based page that will offer another way of engaging with the article content.

Future development of the various mapping technologies is likely to result in further options for showing maps on Wikipedia. In particular, {{maplink}}, which initially just created a text link to a full-screen map, can now create a framed image including dot-markers, roads, boundaries, etc., and can acquire data directly from wikidata to do this. Again, the processor overheads are reduced by initially showing a bitmap, which can be clicked to become interactive within its frame. Maplink is being effectively rolled out within info-boxes, where the map is automatically generated from already available data.

This template, on the other hand, is probably better suited to a hand-editable map, in which the area displayed and the selection of items and labels included are selected, edited, and added to, to suit the specifics of the subject in hand. A further approach, which is not currently supported within this template, but is available via the inderlying {{Graph:Street map with marks}} template, is to draw the data from Wikidata, using a SPARQL query that provides the selection of marks requested.

The 'Graph' technology used here is still best described as under development, so while it is highly likely that this or a similar solution will still be available, it may evolve over time.

See also

• Wikipedia:Maps for Wikipedia - A list of mapping tools available on Wikipedia
• {{Location map}} - Placing one marker/label by latitude/longitude.
• {{Location map+}} - Placing unlimited list of markers/labels.
• {{Location map many}} - For displaying multiple marks using latitude and longitude.
• Commons:Category:Map pointers - List of the many Wikimedia Commons pointer symbols.
• {{Overlay}} - Allows image numbered, textual number, or color tag overlays to be positioned over an image to indicate particular features in the image.

The above documentation is transcluded from Template:OSM Location map/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.