View source for Template:User:mmd/Overpass example/doc

{{Documentation subpage}}

==Introduction==
Use overpass turbo ⟶ {{button|Export}} ⟶ section ''Query'' ⟶  ''osm wiki'' ⟶ {{button|download}} or {{button|copy}} to create a query with special wiki syntax. 

Template to generate overpass turbo examples for Wiki pages.

Features:

* display Overpass query source code in a source code box as-is
* adds a small Overpass Turbo icon to the upper right corner of the source code box. This icon directly links Overpass turbo without having to create dedicated overpass turbo sharelinks in the first place.

Please write to [[User:mmd]], 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 
|-
| '''query''' || Overpass QL or Overpass XML query || Note : [[Overpass_turbo/Extended_Overpass_Turbo_Queries|overpass turbo shortcuts]] needs to be properly escaped via <code><nowiki>{{((}}bbox{{))}}</nowiki></code>, any "|" (pipe) character in regular expression needs be rewritten as <code><nowiki>{{!}}</nowiki></code>
|-
!colspan="3" style="text-align:left"| Optional parameter 
|-
| '''loc'''   || [[Overpass_turbo/Development#Map_Location_.26_Zoom|Map Location & Zoom]] as defined for overpass turbo. || Only provide lat/lon/zoom level for parameter loc. Example:  <code>loc=47.0618984;15.4370248;17</code>
|}

== Examples ==
<source lang="cpp">
{{OverpassTurboExample|query=
  node({{((}}bbox{{))}})[place=village];
  foreach(
    is_in->.a;
    area.a[name][boundary=administrative][admin_level~"^[2-8]$"] -> .a;
    convert node ::=::,
              ::id = id(),
              is_in=a.set("{" + t[admin_level] + ":" + t[name] + "}");
   
    out;
  );
}}
</source>

Set the map viewport to New York by using the <code>loc</code> parameter:

<source lang="cpp">
{{OverpassTurboExample|loc=40.7553;-73.9638;13|query=
[bbox:{{((}}bbox{{))}}];
way[highway][name="6th Avenue"];node(w)->.n1;
way[highway][name="West 23rd Street"];node(w)->.n2;
node.n1.n2;
out meta;
}}
</source>

== TemplateData ==
<templatedata>
{
	"params": {
		"query": {
			"aliases": [
				"1"
			],
			"label": "Overpass API query with overpass turbo extensions",
			"description": "Use overpass turbo --> Export --> Query --> download/copy as osm wiki to create a query with special wiki syntax. To update an existing query, load the respective query first into overpass turbo, apply the changes, and export the query in wiki syntax in the same way.",
			"required": true,
			"type": "string"
		},
		"loc": {
			"aliases": [
				"2"
			],
			"label": "Location information",
			"required": false,
			"type": "string",
			"description": "lat;lon;zoom level"
		},
		"run": {
			"aliases": [
				"3"
			],
			"description": "Automatically execute query in overpass turbo",
			"type": "boolean"
		},
		"lang": {
			"label": "syntax highlight lang",
			"description": "xml -> xml; ql -> c/cpp; json -> json"
		}
	},
	"description": "This template will create an Overpass API example query, which is presented on a wiki page with syntax highlighting and a direct link to test and execute the query in overpass turbo.",
	"paramOrder": [
		"query",
		"loc",
		"run",
		"lang"
	],
	"format": "inline"
}
</templatedata>

== See also ==
* [[Template:OverpassTurboRosetta]]: show one example in many languages parallel to each other

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