Help:Map Data

From MediaWiki.org
Jump to navigation Jump to search
PD Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info.
PD

Map data allows users to store GeoJSON data on wiki, similar to images. Other wikis may use this data to draw on top of the maps, together with other map customizations.

To create a new map data, go to Wikimedia Commons, and create a new page in the Data namespace with the .map suffix, such as Data:Sandbox/Name/Example.map. Feel free to experiment by creating pages with the Sandbox/<username>/ prefix. For now, page content can only be edited in the raw JSON format. Eventually, we hope there will be a powerful editor to simplify GeoJSON creation.

Data licensing[edit]

All data in the Data: namespace must be in Public Domain, licensed under Creative Commons Zero (CC0) license. To indicate this, every data page must have "license": "CC0-1.0", which means the data can be used under the CC0 version 1.0, or (at your option) any later version. By editing the data, you agree to the Terms of Use, and you irrevocably agree to release your contribution to the public domain under CC0. At some future time, the list of licenses supported by the Data namespace may be expanded.

Top-level fields[edit]

Map data has several required and optional top-level elements:

  • The required "license" field must always be set to "CC0-1.0" string value. For now, map data only supports CC0 (Public Domain dedication) license version 1.0 or later. More license support may be available in the future.
  • The optional "description" field must be set to a localized string value - an object with at least one key-value, where the key is a language code (e.g. "en"), and the value is a description string.
  • The optional "sources" field must be a Wiki markup string value that describes the source of the map data.
  • The optional "zoom" field must be an integer between 0 and 18. This value is only used for displaying map on its own page, not when including it in the articles.
  • The optional "latitude" and "longitude" fields specify the center of the map when displaying it on its own page, not when including it in the articles.
  • The required "data" field must be set to the valid GeoJSON content. Per GeoJSON specification, "properties" field may be set for every Feature object. The map data will use all of the Simple Style properties, such as "title", "description", "fill" (color), and others. Additionally, the "title" and "description" fields may be either strings or localized string objects (similar to the localized type in tabular data). This allows the same map data to appear differently depending on the user's language.

Usage[edit]

  • Use <mapframe> and <maplink> tags to show a map together with the custom map data defined in the .map page. For that, add this wiki markup (or similar <maplink> but without the width and height) to any wiki page in any project, and the content of the Data:Sample.map page from Commons will be drawn. The content will be localized based on the user's interface language settings.
<mapframe width=500 height=350 zoom=11 latitude=40.8 longitude=-74>
{
  "type": "ExternalData",
  "service": "page",
  "title": "Sample.map"
}
</mapframe>
  • While not a very common usage scenario, a Lua script on any wiki can get map data by calling mw.ext.data.get("Example.map"). The function returns data in almost the same format as the original JSON, except that all localized strings will be converted to regular strings, and the license field will also include a localized license name. To get the data in another language, pass language code as the second parameter. To get the data in the original, unmodified form, use "_" as the language code.

Examples[edit]

Simple map[edit]

<mapframe width=200 height=200 zoom=11>
{
  "type": "ExternalData",
  "service": "page",
  "title": "Neighbourhoods/New York City.map"
}
</mapframe>

Sample map data[edit]

{
    "license": "CC0-1.0",
    "description": { "en": "Manhattan Neighborhoods" },
    "sources": "http://example.com and [[Data]] page",
    "zoom": 11,
    "latitude": 40.8,
    "longitude": -74,
    "data": {
        "type": "FeatureCollection",
        "features": [
            {
                "type": "Feature",
                "properties": {
                    "title": {"en":"Alphabet City", "ru":"Алфабет-сити"}
                },
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [[
                    	[-73.980356454849,40.730425548938],
    ...

Restrictions and gotchas[edit]

  • Each string value except the "sources" must be no more than 400 symbols long. Special characters like new lines \n and tabs \t are not allowed.
  • The overall size of the page may not exceed 2MB.
  • Retrieving lines or shapes via Wikidata IDs within a data page will cause the map to break when it is called via maplink or mapframe. A workaround is to add the IDs directly in the maplink or mapframe code:
<mapframe width="500" height="500">
 [
  {
   "type": "ExternalData",
   "service": "geoshape",
   "ids": "Qxxxxx"
  },
  {
   "type": "ExternalData",
   "service": "page",
   "title": "Sample.map"
  }
 ]
</mapframe>

The sources are drawn in the order in which they are listed in the code - in the example above, the geoshape from Wikidata will appear beneath the components from the data page. This would be reversed if the data page was called before the Wikidata ID.

See also[edit]

  • P3896 - property for linking to .map pages from a related Wikidata item
  • Tabular data - similarly structured tabular data in the Data: namespace on commons.