Difference between revisions of "Template:Mapbox raw data/doc"
imported>Gareth |
imported>Gareth (new capabilities: multiple links and headings) |
||
| Line 63: | Line 63: | ||
}} | }} | ||
</pre> | </pre> | ||
| − | The same map using a standard maplink: | + | The same map using a standard <nowiki><maplink></nowiki>: |
<maplink zoom="16" text="Example map using ''maplink''> | <maplink zoom="16" text="Example map using ''maplink''> | ||
[ | [ | ||
| Line 119: | Line 119: | ||
] | ] | ||
</maplink> | </maplink> | ||
| + | </pre> | ||
| + | An example of <nowiki>{{Mapbox raw data}}</nowiki> with multiple links: | ||
| + | {{mapbox raw data|text-left=yes|above='''Multiple links within the<br />one box''' | ||
| + | |text=External data from OpenStreetMap combined with GeoJSON|data= | ||
| + | [ | ||
| + | { | ||
| + | "type": "ExternalData", | ||
| + | "service": "geoshape", | ||
| + | "ids": "Q13518258", | ||
| + | "properties": { | ||
| + | "stroke": "#ffb100", | ||
| + | "stroke-width": 6, | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | "type": "Feature", | ||
| + | "geometry": { "type": "Point", "coordinates": [4.75566, 44.104498] }, | ||
| + | "properties": { | ||
| + | "title": "Porte de Castellan" | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | "type": "Feature", | ||
| + | "geometry": { "type": "Point", "coordinates": [4.75829, 44.10258] }, | ||
| + | "properties": { | ||
| + | "title": "Porte Léon Roche" | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | |text2=External data from Commons|data2= | ||
| + | { | ||
| + | "type": "ExternalData", | ||
| + | "service": "page", | ||
| + | "title": "Parramatta Light Rail.map" | ||
| + | } | ||
| + | |text3=External data from OpenStreetMap|data3= | ||
| + | { | ||
| + | "type": "ExternalData", | ||
| + | "service": "geoline", | ||
| + | "ids": "Q6939836" | ||
| + | } | ||
| + | }} | ||
| + | <pre> | ||
| + | {{mapbox raw data|text-left=yes|above='''Multiple links within the<br />one box''' | ||
| + | |text=External data from OpenStreetMap combined with GeoJSON|data= | ||
| + | [ | ||
| + | { | ||
| + | "type": "ExternalData", | ||
| + | "service": "geoshape", | ||
| + | "ids": "Q13518258", | ||
| + | "properties": { | ||
| + | "stroke": "#ffb100", | ||
| + | "stroke-width": 6, | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | "type": "Feature", | ||
| + | "geometry": { "type": "Point", "coordinates": [4.75566, 44.104498] }, | ||
| + | "properties": { | ||
| + | "title": "Porte de Castellan" | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | "type": "Feature", | ||
| + | "geometry": { "type": "Point", "coordinates": [4.75829, 44.10258] }, | ||
| + | "properties": { | ||
| + | "title": "Porte Léon Roche" | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | |text2=External data from Commons|data2= | ||
| + | { | ||
| + | "type": "ExternalData", | ||
| + | "service": "page", | ||
| + | "title": "Parramatta Light Rail.map" | ||
| + | } | ||
| + | |text3=External data from OpenStreetMap|data3= | ||
| + | { | ||
| + | "type": "ExternalData", | ||
| + | "service": "geoline", | ||
| + | "ids": "Q6939836" | ||
| + | } | ||
| + | }} | ||
</pre> | </pre> | ||
| Line 127: | Line 210: | ||
*Include multiple links to external data from Wikimedia Commons | *Include multiple links to external data from Wikimedia Commons | ||
*Use Wikidata queries to obtain information for the map | *Use Wikidata queries to obtain information for the map | ||
| + | *Include up to five links within the one box | ||
| + | *Include non-linked heading text | ||
==Parameters== | ==Parameters== | ||
| + | ;text-left | ||
| + | :Set this to <code>yes</code> to change the text in the box from centre-aligned to left-aligned | ||
| + | ;above | ||
| + | :Text that appears above the links; useful for headings etc. | ||
| + | |||
| + | The following parameters can be used to add up to five links in a single box by adding the numbers 2, 3, 4 or 5 to the end of the parameter name - e.g. <code>data2</code>, <code>text2</code> | ||
;data | ;data | ||
| − | :A link to external data from Wikimedia Commons or OpenStreetMap and/or any valid GeoJSON data; the only required parameter | + | :A link to external data from Wikimedia Commons or OpenStreetMap and/or any valid GeoJSON data; the template's only required parameter |
;text | ;text | ||
| − | :Text to display for the link; default is "View map" | + | :Text to display for the link; default is "View map" (or "Use the text parameter to specify the text of this link" when a numbered version of the data parameter is used) |
| − | |||
| − | |||
;zoom | ;zoom | ||
:Zoom level, from <code>1</code> to <code>18</code> (larger numbers zoom in further); will be automatically determined if not set | :Zoom level, from <code>1</code> to <code>18</code> (larger numbers zoom in further); will be automatically determined if not set | ||
Revision as of 20:39, 7 April 2017
| This is a documentation subpage for Template:Mapbox raw data. It contains usage information, categories and other content that is not part of the original template page. |
This is a version of Template:Mapbox that accepts raw map data. It allows the full power of <maplink> to be utilised.
Usage
{{Mapbox raw data}} styles a maplink and puts it in a box to the right of the page.
An example: Template:Sidebox
{{mapbox raw data|zoom=16|text=Example map using ''Mapbox raw data''|text-left=yes|data=
[
{
"type": "ExternalData",
"service": "geoshape",
"ids": "Q13518258",
"properties": {
"stroke": "#ffb100",
"stroke-width": 6,
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75566, 44.104498] },
"properties": {
"title": "Porte de Castellan"
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75829, 44.10258] },
"properties": {
"title": "Porte Léon Roche"
}
}
]
}}
The same map using a standard <maplink>: <maplink zoom="16" text="Example map using maplink> [
{
"type": "ExternalData",
"service": "geoshape",
"ids": "Q13518258",
"properties": {
"stroke": "#ffb100",
"stroke-width": 6,
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75566, 44.104498] },
"properties": {
"title": "Porte de Castellan"
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75829, 44.10258] },
"properties": {
"title": "Porte Léon Roche"
}
}
] </maplink>
<maplink zoom="16" text="Example map using ''maplink''">
[
{
"type": "ExternalData",
"service": "geoshape",
"ids": "Q13518258",
"properties": {
"stroke": "#ffb100",
"stroke-width": 6,
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75566, 44.104498] },
"properties": {
"title": "Porte de Castellan"
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75829, 44.10258] },
"properties": {
"title": "Porte Léon Roche"
}
}
]
</maplink>
An example of {{Mapbox raw data}} with multiple links: Template:Sidebox
{{mapbox raw data|text-left=yes|above='''Multiple links within the<br />one box'''
|text=External data from OpenStreetMap combined with GeoJSON|data=
[
{
"type": "ExternalData",
"service": "geoshape",
"ids": "Q13518258",
"properties": {
"stroke": "#ffb100",
"stroke-width": 6,
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75566, 44.104498] },
"properties": {
"title": "Porte de Castellan"
}
},
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [4.75829, 44.10258] },
"properties": {
"title": "Porte Léon Roche"
}
}
]
|text2=External data from Commons|data2=
{
"type": "ExternalData",
"service": "page",
"title": "Parramatta Light Rail.map"
}
|text3=External data from OpenStreetMap|data3=
{
"type": "ExternalData",
"service": "geoline",
"ids": "Q6939836"
}
}}
While Template:Mapbox and the similar Template:Maplink attempt to make simple maps easier to insert into a page, Mapbox raw data uses exactly the same data format for the map itself as the standard <maplink> function. Compared to Template:Mapbox, Mapbox raw data can do the following:
- Use GeoJSON data directly
- Use a combination of data sources together (direct GeoJSON, external data from Wikimedia Commons and external data from OpenStreetMap)
- Style data (excluding data from Commons)
- Include multiple links to external data from Wikimedia Commons
- Use Wikidata queries to obtain information for the map
- Include up to five links within the one box
- Include non-linked heading text
Parameters
- text-left
- Set this to
yesto change the text in the box from centre-aligned to left-aligned - above
- Text that appears above the links; useful for headings etc.
The following parameters can be used to add up to five links in a single box by adding the numbers 2, 3, 4 or 5 to the end of the parameter name - e.g. data2, text2
- data
- A link to external data from Wikimedia Commons or OpenStreetMap and/or any valid GeoJSON data; the template's only required parameter
- text
- Text to display for the link; default is "View map" (or "Use the text parameter to specify the text of this link" when a numbered version of the data parameter is used)
- zoom
- Zoom level, from
1to18(larger numbers zoom in further); will be automatically determined if not set - latitude
- longitude
- Specify the centre point of the map; will be automatically determined if not set