View source for Template:OverpassTurboStolpersteine/doc

{{Documentation subpage}}
==Introduction==

With this template you can generate a link to an Overpass turbo query, which shows all [[Stolpersteine]] in a specific area. This is mainly used on [[DE:Städte mit Stolpersteinen]]. In most cases you just need to set the name of your city. If this doesn't work as espected (because there are several cities with the same name), you can set the admin_level of the administrative boundary to be more precise. Alternativly you can exactly define the area by entering the OSM-ID of the administrative boundary. You can also define your own area by entering the corner coordinates. There are also several optional parameters for customizing the result.

Please write to [[User:Klumbumbus]], if you have any suggestions or questions to this template.

== Usage ==

{| class="wikitable"
!| Parameter || Description || Additional hints
|-
!colspan="3" style="text-align:left"| Required parameter (to define the area) <span style="border-color: crimson; border-style: solid; border-width: 2px; margin: 2px">&nbsp; use only one of these four &nbsp; </span>
|-
| '''name''' || The name of the [[Tag:boundary=administrative|administrative boundary]] in which you want to search for Stolpersteine e.g. the name of your town or city. || Note : you no longer need to replace spaces by a plus sign, as in "name=Frankfurt+am+Main"; <br /> and you no longer need to URL-encoded other non-ASCII characters, as in "name=Baden-W%C3%BCrttemberg"<br /> In presence of any "+" or "%", the name given is assumed to be already URL-encoded for HTTP query strings.
|-
| '''relation''' || The OSM-ID of a relation which defines an area, e.g. the OSM-ID of the administrative boundary relation of your town or city. ||
|-
| '''way''' || The OSM-ID of a way which defines an area. || This works only for closed ways which also have a name. For further information see [https://github.com/drolbr/Overpass-API/issues/77 here].
|-
| '''coordinates''' || You can specify a custom area with three or more points. || Type for each point lat and lon separated by a plus sign (+) or space ( ). Use a dot (.) as decimal separator. Example: ''coordinates=50.0+7.0+51.0+7.0+51.0+8.0''
|-
!colspan="3" style="text-align:left"| Optional parameters
|-
| '''admin_level''' || This defines the number of the [[admin_level]] of the administrative boundary. Use this only together with ''name''. || You can use this if you don't get the correct result by just adding the name, e.g because of several towns with the same name. Alternatively you can use ''relation'', ''way'' or ''coordinates''.
|-
| '''lg''' || The language of the mouseover text of the link. || Currently beside english only german (''de'') is supported. Please let me know if you want to add your language to the template, or add it yourself if you are familiar with template editing.
* ''de'' results in: "Stolpersteine {{{ in ''name'' }}} mit Overpass turbo suchen und anzeigen"
* If unset by default english is used which is "Search and display Stolpersteine {{{ in ''name'' }}} with Overpass turbo".
|-
| '''icon''' || If set to "yes" Overpass turbo will display a [[File:Stolpersteinicon.png|16px]] Stolperstein icon for each Stolperstein. You can also enter the URL of any other icon. || If you don't want to display an icon do not set icon=no but ommit the icon parameter completely. The default blue circle with yellow fill is used then.
|-
| '''text''' || This will add a text label to each Stolperstein. The text is the value of the osm-key you define in this parameter. || Examples: If you set text=name then the text label shows the name of the Stolperstein. If you set text=memorial:ref, then the text label shows the value of memorial:ref of the Stolperstein.
|-
| '''display&nbsp;area''' || If set to yes, the map will also show the area in which the Stolpersteine were searched. || If you use this and export the data to an external editor (e.g. JOSM), you will not just export the Stolperstein nodes, but also the complete area relation with all its ways with all their nodes! Also note that if you use this the number of POIs shown down right in the corner of the Overpass turbo map is no longer the number of Stolpersteine! There are also counted nodes of the area relation which have at least one tag (these nodes are hidden on the map for better view). With this parameter you can check if the area in which Overpass api searches for Stolpersteine is correct. For example if you use ''<nowiki>name=Berlin|display area=yes</nowiki>'' {{OverpassTurboStolpersteine|display area=yes|name=Berlin}}, you will see, that beside the capital of germany there are also some cities in the USA, with the name Berlin (you may check ''Don't display small features as POIs'' in the settings of Overpass turbo to see these areas on low zoom). In this case Overpass api searches also in these areas. To avoid this you can either add ''admin_level=4'' {{OverpassTurboStolpersteine|display area=yes|name=Berlin|admin_level=4}} or use ''relation=62422'' {{OverpassTurboStolpersteine|display area=yes|relation=62422}} instead of ''name''. This parameter does not work if you use ''coordinates''.
|-
| '''run on load''' || If set to "no" the query will not run automatically, when you click on the link. || If the query runs automatically on load and it finds data, then also the map automatically jumps to the position of the data. Otherwise you need to set ''lat/lon/zoom'' or the user needs to use the ''zoom to data'' button after manually running the query. This parameter is ignored if ''fullscreen=yes'' is set.
|-
| '''lat''' || The latitude. || If you do not automatically run on load, you can specify the latitude of the center of the shown map. If you use this you also need to use ''lon'' and ''zoom''. This parameter is ignored if ''fullscreen=yes'' is set.
|-
| '''lon''' || The longitude. || If you do not automatically run on load, you can specify the longitude of the center of the shown map. If you use this you also need to use ''lat'' and ''zoom''. This parameter is ignored if ''fullscreen=yes'' is set.
|-
| '''zoom''' || The zoom level. || If you do not automatically run on load, you can specify the zoom level of the shown map. If you use this you also need to use ''lat'' and ''lon''. This parameter is ignored if ''fullscreen=yes'' is set.
|-
|'''fullscreen''' || If set to "yes" the query will load on a fullscreen map. || This means all the overpass turbo buttons and the side panel with the query code are hidden. The query always runs automatically on load because there is no run button.
|-
|'''json''' || If set to "yes" the output data will be in json format instead of xml. || If you want to export the data to JOSM you need the xml format. This parameter is not useful in combination with ''fullscreen'' since there is no export button on fullscreen map.
|-
|'''meta''' || If set to "no" the tool tip which appears when you click on a Stolperstein in Overpass turbo will not display the meta data of the node. || Meta data is: timestamp, version, changeset, user name and user id.
|-
|'''date''' || Instead searching for Stolpersteine in the current state of the database, you can specify a date in the past. || Example: ''2012-09-14T15:00:00Z'' This processes the query as if it were posed on 14th September 2012 at 15:00.
|-
|'''diff1''' || This parameter lets the database determine the difference of two queries at different points in the past. || Example: ''2013-12-12T15:00:00Z'' This processes the query as if it were posed on 12th December 2013 at 15:00, then processes the same query with current data and finally outputs the difference between the two results. If you want to use a second date in the past instead of the comparison with the current state, then use the parameter ''diff2'' for the second date. Note that you will not be able to export the received data to JOSM.
|-
|'''diff2''' || The Second date in the past. || If unset, then diff1 will use the current state as second date. Example: ''2013-12-15T15:00:00Z'' Together with ''diff1=2013-12-12T15:00:00Z'' this processes the query as if it were posed on 12th December 2013 at 15:00, then processes the same query as if it were posed on 14th December 2013 at 15:00 and finally outputs the difference between the two results. Note that you will not be able to export the received data to JOSM. You can use this for example if you just want to display the Stolpersteine of the last laying.
|-
|'''adiff1''' || Similar to ''diff2''. || The ''adiff'' does basically the same like ''diff'', but for all elements that aren't contained in the newer result, it is indicated what happened to them. This is printed if you switch from map tab do data tab top right in Overpass turbo. If an element has been deleted, then its last deletion date is printed and the indication "visible=false". If an element has changed such that it no longer matches the query then its last change date is printed and the indication "visible=true". This does not work for json as output format.
|-
|'''adiff2''' || Similar to ''diff2''. ||
|}

==Examples==
{| class="wikitable"
!| Code || Result || Description
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz}} || use of ''name''
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Frankfurt+am+Main}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Frankfurt+am+Main}} || name with spaces (URL-encoded)
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Frankfurt am Main}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Frankfurt am Main}} || name with spaces (not URL-encoded)
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Baden-W%C3%BCrttemberg}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Baden-W%C3%BCrttemberg}} || name with non-ASCII characters (URL-encoded)
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Baden-Württemberg}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Baden-Württemberg}} || name with non-ASCII characters (not URL-encoded)
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6}} || use of ''name'' and ''admin_level''
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594}} || use of ''relation''
|-
| <nowiki>{{OverpassTurboStolpersteine|way=35460156}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|way=35460156}} || use of ''way''
|-
| <nowiki>{{OverpassTurboStolpersteine|coordinates=50.0+7.0+51.0+7.0+51.0+8.0}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|coordinates=50.0+7.0+51.0+7.0+51.0+8.0}} || use of ''coordinates'' (URL-encoded)
|-
| <nowiki>{{OverpassTurboStolpersteine|coordinates=50.0 7.0 51.0 7.0 51.0 8.0}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|coordinates=50.0 7.0 51.0 7.0 51.0 8.0}} || use of ''coordinates'' (not URL-encoded)
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|lg=de}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|lg=de}} || german mouse over text of the link
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|icon=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|icon=yes}} || with [[File:Stolpersteinicon.png|16px]] Stolperstein icon
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|icon=https://openclipart.org/download/25597/Circle.svg}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|icon=https://openclipart.org/download/25597/Circle.svg}} || with custom icon
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|text=name}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|text=name}} || with name as text label
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|display area=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|display area=yes}} || area is also displayed
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|run on load=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|run on load=no}} || no auto run
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|run on load=no|lat=50.84|lon=12.9|zoom=11}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|run on load=no|lat=50.84|lon=12.9|zoom=11}} || no auto run with defined ''lat'', ''lon'' and ''zoom''
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|fullscreen=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|fullscreen=yes}} || fullscreen map
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|json=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|json=yes}} || output format json
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|meta=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|meta=no}} || no meta data
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|date=2012-09-14T15:00:00Z}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|date=2012-09-14T15:00:00Z}} || with old date
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|diff1=2013-12-12T15:00:00Z|diff2=2013-12-14T15:00:00Z}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|diff1=2013-12-12T15:00:00Z|diff2=2013-12-14T15:00:00}} || difference between two dates
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|icon=yes|lg=de|text=name|display area=yes|meta=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|icon=yes|lg=de|text=name|display area=yes|meta=no}} || combination of several parameters

<!-- The following examples are just for debugging, not for displaying.
|-
|colspan="3"| '''The following are just for debugging!'''
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|text=memorial:type}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|text=memorial:type}} || memorial:type as text
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|fullscreen=yes|icon=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|fullscreen=yes|icon=yes}} || relation+fullscreen+icon
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|fullscreen=yes|icon=yes|run on load=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|fullscreen=yes|icon=yes|run on load=no}} || relation+fullscreen+icon+no auto run
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|fullscreen=yes|run on load=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|fullscreen=yes|run on load=no}} || relation+fullscreen+no auto run
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6|icon=yes|run on load=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6|icon=yes|run on load=no}} || name+admin_level+icon+no auto run
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|lg=de}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|lg=de}} || relation+lg=de
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Praha|admin_level=8|lg=en}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Praha|admin_level=8|lg=en}} || lg=en
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Praha|admin_level=8|lg=xyz}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Praha|admin_level=8|lg=xyz}} || lg=xyz
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6|icon=no}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6|icon=no}} || icon=no
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|icon=yes|lat=51.12|lon=8.8|zoom=11}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|icon=yes|lat=51.12|lon=8.8|zoom=11}} || icon+lat/lon/zoom
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|icon=yes|lat=51.12|lon=8.8}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|icon=yes|lat=51.12|lon=8.8}} || missing zoom
|-
| <nowiki>{{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6|display area=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|name=Chemnitz|admin_level=6|display area=yes}} || name+admin_level+display area
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|display area=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|display area=yes}} || relation+display area
|-
| <nowiki>{{OverpassTurboStolpersteine|way=35460156|display area=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|way=35460156|display area=yes}} || way+display area
|-
| <nowiki>{{OverpassTurboStolpersteine|coordinates=50.0+7.0+51.0+7.0+51.0+8.0+52.0+8.0+52.0+9.0}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|coordinates=50.0+7.0+51.0+7.0+51.0+8.0+52.0+8.0+52.0+9.0}} || 5 coordinates
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|json=yes|fullscreen=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|json=yes|fullscreen=yes}} || json+fullscreen
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|meta=no|fullscreen=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|meta=no|fullscreen=yes}} || no meta+fullscreen
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|diff1=2013-12-12T15:00:00Z}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|diff1=2013-12-12T15:00:00Z}} || only diff1
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|diff1=2013-12-12T15:00:00Z|diff2=2013-12-14T15:00:00|json=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|diff1=2013-12-12T15:00:00Z|diff2=2013-12-14T15:00:00|json=yes}} || diff and json
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|adiff1=2014-08-21T12:00:00Z}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|adiff1=2014-08-21T12:00:00Z}} || only adiff1
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|adiff1=2014-08-21T12:00:00Z|adiff2=2014-08-22T12:00:00Z}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|adiff1=2014-08-21T12:00:00Z|adiff2=2014-08-22T12:00:00Z}} || adiff1 and adiff2
|-
| <nowiki>{{OverpassTurboStolpersteine|relation=62594|icon=yes|lg=de|text=name|display area=yes|meta=no|fullscreen=yes}}</nowiki> || style="text-align:center"| {{OverpassTurboStolpersteine|relation=62594|icon=yes|lg=de|text=name|display area=yes|meta=no|fullscreen=yes}} || combination of several parameters on fullscreen map
-->
|}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Overpass API/Templates]]
</includeonly>