Module:OSM/doc
 | This is a documentation subpage for Module:OSM. It may contain usage information, categories and other content that is not part of the original module page. |
Goal
[edit]On this page Wikipedia:WikiProject_OpenStreetMap it becomes clear different approaches have been tried before to link from Wikipedia to Openstreetmap.
But why is this so hard? Well, there are a few problems, one of them is that ids for nodes, ways and relations on Openstreetmap are not guaranteed to be stable. When ways are split the id will point to a shorter stretch and the other part will get a new id. Sometimes points of interest which start as nodes, are converted to (closed) ways. Some contributors delete items, which get recreated by them a bit further along. Or somebody notices it's missing and recreates it fresh.
So pointing directly to the OSM objects themselves doesn't work all that well. Let's say it's not future proof. It may work at the moment you define the link and a good while after, or it may fail the next day already.
Wikidata
[edit]Luckily Wikidata came along and this forms a part of the puzzle that can help solve this problem. What we can do is add tags which refer back to Wikidata items on the Openstreetmap side.
Now if a way is split, both parts will continue with the proper wikidata tag.
Overpass API
[edit]But now we have a new problem. How to find those elements in the Openstreetmap DB, which got wikidata tags assigned to them?
Well there is a tool to help with this. It has the whole database of Openstreetmap, updated on a minutely basis and it's fast to query, on condition the queries can be kept simple. It's called Overpass API.
Overpass Turbo
[edit]Looking at raw data, is not very instructive either, so another tool was built around it, which is called Overpass Turbo.
Query
[edit]Developing these queries takes some trial and error. What this module does for you, is to automate the process and come up with a query that works, with sensible default values.
For example if you omit the Wikidata id, the id of the corresponding article will be used.
But it's also possible to write your own custom queries, or to specify further filters. Normally all objects' types, nodes, ways and relations will be fetched, but it's possible to limit to only ways, for example.
in style
[edit]Adding a style sheet allows you to present the data in a more suitable way. An attempt is being made to add a style sheet that makes sense, but it's possible to define your own.
Usage
[edit]- Search Openstreetmap independently of wikidata tags
{{#invoke:OSM|overpass}}
- Search Openstreetmap for items which have wikidata=Q....
{{#invoke:OSM|wd}}
- Search Openstreetmap for items which have name:etymology:wikidata=Q....
{{#invoke:OSM|etym}}
- Search Openstreetmap for items which have subject:wikidata=Q....
{{#invoke:OSM|subject}}
- Search Openstreetmap for items which have artist:wikidata=Q....
{{#invoke:OSM|artist}}
- Search Openstreetmap for items which have architect:wikidata=Q....
{{#invoke:OSM|architect}}
- Search Openstreetmap for items which have operator:wikidata=Q....
{{#invoke:OSM|operator}}
- Search Openstreetmap for items which have brand:wikidata=Q....
{{#invoke:OSM|brand}}
- Search Openstreetmap for public transport lines related to the current article
{{#invoke:OSM|pt}}
Parameters
[edit]- display : Text shown on outgoing link
- link : defaults to yes, but can be set to no for use in other templates
- timeout : defaults to 15 seconds, needs to be set higher for more complicated queries
- id : can link to a 1 or more Q-numbers of wikidata items, defaults to the Q-number id of the calling page
- query : makes it possible to extend the query, which can be used to limit the search to highways or tombstones
- prim : only fetch node, way and/or relation primitives
- coord : coordinates and a zoom factor in this format: 47.0618984;15.4370248;17 from which a bbox will be determined.
- limitToBBOX: defaults to yes. If coord is set the query is limited to the resulting bbox
- run : defaults to yes. Use no if you want the user to be able to move the map or change the query before searching
- style : it's possible to define a MapCSS style to present the result in a nicer way
Test values
[edit]1 of 10 tests failed.
| Text | Expected | Actual | |
|---|---|---|---|
|
{{#invoke:OSM|brand|id=Q3195848|display=Toon vestigingen op een kaart|style=node{ text: name; icon-image: url('https://upload.wikimedia.org/wikipedia/commons/0/07/Kewlox_logo.png'); icon-width: 32;} }} | Toon vestigingen op een kaart | Toon vestigingen op een kaart |
|
|
{{#invoke:OSM|brand|id=Q3195848|display=Show locations on map}} | Show locations on map | Show locations on map |
| Text | Expected | Actual | |
|---|---|---|---|
|
|
{{#invoke:OSM|pt|id=Q18012220|display=De Lijn 352 on map}} | De Lijn 352 on map | De Lijn 352 on map |
| Text | Expected | Actual | |
|---|---|---|---|
|
|
{{#invoke:OSM|subject|id=Q1356304|display=Statues of Ernest Claes|coord=51.1936;3.23812;18}} | Statues of Ernest Claes | Statues of Ernest Claes |
| Text | Expected | Actual | |
|---|---|---|---|
|
|
{{#invoke:OSM|wd|id=Q650206;Q713300|display=Vresse and Florenville}} | Vresse and Florenville | Vresse and Florenville |
|
|
{{#invoke:OSM|wd|id=Q20748715|display=Church of Vresse|coord=49.71513;5.23446;14}} | Church of Vresse | Church of Vresse |
|
|
{{#invoke:OSM|wd|id=Q1716059|prim=w|display=Cemetery of Arlon on a map}} | Cemetery of Arlon on a map | Cemetery of Arlon on a map |