Difference between revisions of "Template:Mapframe/doc"
Template>Ed g2s (Add TempateData) |
Tag: 2017 source edit |
||
(One intermediate revision by one other user not shown) | |||
Line 38: | Line 38: | ||
<templatedata> | <templatedata> | ||
{ | { | ||
− | + | "params": { | |
− | + | "1": { | |
− | + | "label": "Latitude", | |
− | + | "description": "Latitude of the map's centre, -90 to 90", | |
− | + | "type": "number", | |
− | + | "example": "51.47766", | |
− | + | "suggested": true | |
− | + | }, | |
− | + | "2": { | |
− | + | "label": "Longitude", | |
− | + | "description": "Longitude of the map's centre, -180 to 180", | |
− | + | "example": "0.00115", | |
− | + | "type": "number", | |
− | + | "suggested": true | |
− | + | }, | |
− | + | "zoom": { | |
− | + | "label": "Zoom level", | |
− | + | "description": "Zoom level from 0-18 (0=Earth, 18=city block, auto=fit all markers)", | |
− | + | "example": "14", | |
− | + | "type": "number", | |
− | + | "suggested": true | |
− | + | }, | |
− | + | "align": { | |
− | + | "label": "Alignment", | |
− | + | "description": "Alignment of the map frame, left/right/center", | |
− | + | "example": "center", | |
− | + | "type": "string", | |
− | + | "default": "right" | |
− | + | }, | |
− | + | "name": { | |
− | + | "label": "Name", | |
− | + | "description": "Name of the location as you want it to appear in the caption", | |
− | + | "default": "Article title", | |
− | + | "example": "the Binnenstad" | |
− | + | }, | |
− | + | "staticmap": { | |
− | + | "label": "Static map image", | |
− | + | "description": "A PNG or SVG file to serve as the static map image", | |
− | + | "example": "map.png", | |
− | + | "type": "wiki-file-name" | |
− | + | }, | |
− | + | "width": { | |
− | + | "label": "Width", | |
− | + | "description": "Width of map frame", | |
− | + | "example": "400", | |
− | + | "type": "number", | |
− | + | "default": "420" | |
− | + | }, | |
− | + | "height": { | |
− | + | "label": "Height", | |
− | + | "description": "Height of map frame", | |
− | + | "example": "400", | |
− | + | "type": "number", | |
− | + | "default": "420" | |
− | + | }, | |
− | + | "layer": { | |
− | + | "label": "Layer", | |
− | + | "description": "List of layers to show, see [[Wikivoyage:How to use dynamic maps#Mapframe]]", | |
− | + | "example": "MLSCG", | |
− | + | "type": "string" | |
− | + | } | |
− | + | }, | |
− | + | "paramOrder": [ | |
− | + | "1", | |
− | + | "2", | |
− | + | "zoom", | |
− | + | "width", | |
− | + | "height", | |
− | + | "name", | |
− | + | "align", | |
− | + | "layer", | |
− | + | "staticmap" | |
− | + | ], | |
− | + | "description": "This template acts as a frame for an external map. Javascript is used to replace \"mapdiv\" with an iframe. See [[Wikivoyage:How to use dynamic maps]] and [[Wikivoyage:Dynamic maps Expedition]] for more information.", | |
− | + | "format": "inline" | |
} | } | ||
</templatedata> | </templatedata> |
Latest revision as of 07:49, 3 August 2020
This is a documentation subpage for Template:Mapframe. It contains usage information, categories and other content that is not part of the original template page. |
Function
This template acts as a frame for an external map. Javascript is used to replace "mapdiv" with an iframe. See Wikivoyage:How to use dynamic maps and Wikivoyage:Dynamic maps Expedition for more information.
Usage
{{Mapframe|1|2|zoom=|height=|width=|layer=|staticmap=|align=|name=}}
Required parameters
|1
latitude of the map's centre, valid range: -90.0 to 90.0|2
longitude of the map's centre, valid range: -180.0 to 180.0
Optional parameters
|zoom=
zoom level, default=14, valid range: 0 to 18 or auto (0=Earth, 18=city block, auto=showing all markers)|height=
height of map frame, default is 420px - should be at least 370 to provide enough space for the layers menu to expand|width=
width of map frame, default is 420px|staticmap=
static map image, a normal png or svg file|align=
alignment of map frame, default is right (other values are "left" and "center")|name=
name of the location as you want it to appear in the caption - default display is the article title with parent page and disambiguation removed. For an example of this parameter's usage, see Amsterdam/Binnenstad.|layer=
see Wikivoyage:How to use dynamic maps#Mapframe
Examples
{{Mapframe|51.47766|0.00115}}
{{Mapframe|zoom=auto}} (lat/long is not required)
{{Mapframe|51.47766|0.00115|zoom=14|height=400|width=400}}
{{Mapframe|51.47766|0.00115|zoom=14|height=400|width=400 |layer=W|staticmap=map.png}}
{{Mapframe|51.47766|0.00115|zoom=14|height=400|width=400 |layer=MLSCG|align=center|name=the Binnenstad}}
Associated template
- {{mapshape}} - Used to create a mask, shape or line using data from the OpenStreetMap database; useful for city or region borders, or for showing routes.
- {{mapmask}} - Used to create a mask using manually entered latitude/longitude pairs; useful for drawing city or region borders that aren't available from OpenStreetMap.
Code
- Module:Map used to create <mapframe> tag with all of the parameters
This template acts as a frame for an external map. Javascript is used to replace "mapdiv" with an iframe. See [[Wikivoyage:How to use dynamic maps]] and [[Wikivoyage:Dynamic maps Expedition]] for more information.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Latitude | 1 | Latitude of the map's centre, -90 to 90
| Number | suggested |
Longitude | 2 | Longitude of the map's centre, -180 to 180
| Number | suggested |
Zoom level | zoom | Zoom level from 0-18 (0=Earth, 18=city block, auto=fit all markers)
| Number | suggested |
Width | width | Width of map frame
| Number | optional |
Height | height | Height of map frame
| Number | optional |
Name | name | Name of the location as you want it to appear in the caption
| Unknown | optional |
Alignment | align | Alignment of the map frame, left/right/center
| String | optional |
Layer | layer | List of layers to show, see [[Wikivoyage:How to use dynamic maps#Mapframe]]
| String | optional |
Static map image | staticmap | A PNG or SVG file to serve as the static map image
| File | optional |