View source for Mapmask/doc

{{Documentation subpage}}
__NOTOC__ __NOEDITSECTION__
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
===Function=== 
This template overlays a dark polygonal mask on a dynamic map so that the subject area is more clearly delineated. Mask display can be turned on or off by toggling the "GPX tracks / Map mask" layer control.

===Usage===

See [[Wikivoyage:How to use dynamic maps#Adding boundaries and tracks]] for instructions on creating GPX tracks for use with this template.

The points of the mask polygon are marked with <code><nowiki>{{Mapmask|lat,long|lat,long| ... |lat,long}}</nowiki></code>

* '''Required parameters:'''
: <code> |lat,long </code> pairs of geographical co-ordinates for each corner of the masking polygon.

* '''Example:'''
: <code><nowiki> {{MapMask|43.28915,-78.19371|43.28928,-78.18969|43.28828,-78.18745|43.28543,-78.18724|43.28555,-78.19381}}</nowiki></code>

* '''A working example:''' 
: [https://tools.wmflabs.org/wikivoyage/w/poimap2.php?lat=40.695&lon=-73.982&zoom=14&layer=O&lang=en&name=Brooklyn/Downtown View full screen dynamic map for Brooklyn/Downtown]

===Useful tools===
* [http://pifpafpuf.de/cycleroute/map Route Editor] -- Online editor to create coordinates for Mapmask as a GPX track file.
* [http://osmrm.openstreetmap.de/index.jsp?lang=en_GB OSM Route Manager] -- Exporting OpenStreetMap routes as a GPX route file.
* [http://labs.easyblog.it/maps/gpx-simplify-optimizer/ GPX Optimizer] -- Simplifier/Optimizer for GPX files.
* [https://tools.wmflabs.org/wikivoyage/w/gpx2mapmask.php Gpx2mapmask] -- Converting GPX track or route file to Mapmask format.

=== Other examples ===
{{Module:Mapmask/doc}}


==== Nothing is shown ====
<nowiki>"{{Mapmask | 10,-30 | 50,-30 | 40,30 | 10,30 }}"</nowiki><br>
"{{Mapmask | 10,-30 | 50,-30 | 40,30 | 10,30 }}"

==== With 'text=' ====
<nowiki>{{Mapmask | zoom=2 | text= | 10,-30 | 50,-30 | 40,30 | 10,30 }}</nowiki><br>
{{Mapmask | zoom=2 | text= | 10,-30 | 50,-30 | 40,30 | 10,30 }}

==== With 'text="Something"' ====
<nowiki>{{Mapmask | zoom=2 | text=Something | 10,-30 | 50,-30 | 40,30 | 10,30 }}</nowiki><br>
{{Mapmask | zoom=2 | text=Something | 10,-30 | 50,-30 | 40,30 | 10,30 }}

==== tag=mapframe ====
Show highlighted, red-colored area.
<nowiki>{{Mapmask | tag=mapframe | align=left | zoom=2 | mask= | fill=#FF0000 | group= | width=420|height=420 |10,-30|50,-30|40,30|10,30}}</nowiki>
{{Mapmask | tag=mapframe | align=left | zoom=2 | mask= | fill=#FF0000 | group= | width=420|height=420 |10,-30|50,-30|40,30|10,30}}
<div style="clear:both;"></div>

==== Debuging ====
This will show data as pretty-printed JSON using the syntaxhighlight extension
<nowiki>{{Mapmask | tag=syntaxhighlight | pretty= | lang=json | 10,-30 | 50,-30 | 40,30 | 10,30 }}</nowiki><br>

===See also===

* {{tl|mapframe}} - Template used to add a dynamic map to an article.
* {{tl|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.

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Dynamic map templates]]
</includeonly>