Skip to content

Latest commit

 

History

History
141 lines (89 loc) · 7.1 KB

CONTRIBUTING.md

File metadata and controls

141 lines (89 loc) · 7.1 KB
Raw

Contributing

Adding new sources

See FAQ.md for information about which licenses are compatible with this index.

The 'source' documents for this project are the .geojson files in sources. To add a new imagery source, add a new file to this directory.

Each source must be a GeoJSON Feature and must minimally have name, type, url, privacy_policy_url, license_url and category properties. To improve readability, the keys of the GeoJSON document should be ordered consistently: type, properties, then geometry.

We further recommend to add the licence related properties.

See schema.json for the full list of available properties.

Source URL

The source url property should contain a url with replacement tokens. An application will replace the tokens as needed to download image tiles. Whenever possible, use https URLs.

Supported TMS tokens:

  • {zoom}, {x}, {y} for Z/X/Y tile coordinates
  • {-y} for flipped TMS-style Y coordinates
  • {switch:a,b,c} for DNS server multiplexing
  • {apikey} for an app specific apikey

Example: https://{switch:a,b,c}.tile.openstreetmap.org/{zoom}/{x}/{y}.png

Supported WMS tokens:

  • {proj} - requested projection (e.g. EPSG:3857)
  • {wkid} - same as proj, but without the prefix (e.g. 3857)
  • {width}, {height} - requested image dimensions (e.g. 256, 512)
  • {bbox} - requested bounding box

Example: http://geodienste-hamburg.de/HH_WMS_Geobasisdaten?FORMAT=image/jpeg&VERSION=1.1.1&SERVICE=WMS&REQUEST=GetMap&LAYERS=13&STYLES=&SRS={proj}&WIDTH={width}&HEIGHT={height}&BBOX={bbox}

Alternatively, with following binder wizard a template can be created based on a WMS GetCapabilities query.

Binder

Make sure you submit the most appropriate image format for the images: usually, jpeg for photography and png for maps. See #435 for a case where bmp was better.

Imagery Extent

Local (i.e. not worldwide) sources should define an appropriate extent as the geometry for the GeoJSON feature. Polygons and bounding boxes can be created by using a tool like http://geojson.io/

See FAQ.md for information about how to draw a bounding polygon.

Alternatively, polygons can be created based on administrative boundaries using the following binder notebook.

Binder

Imagery Dates

Valid imagery dates may be defined with start_date and end_date properties:

    "start_date": "2012",
    "end_date": "2014",

Specifying reduced accuracy dates is complex. For simplicity, the schema allows a subset of ISO 8601 defined in RFC 3339 except that a reduced precision date is allowed. For example, 2013-04-15T14:02:54.05+00:00 is a fully specified ISO 8601 date-time, 2013-04-15 could be used for just the date, or 2013-04 for just the month, 2013 for just the year.

To specify imagery taken sometime in 2019, use "start_date": "2019", "end_date": "2019".

Implementations must not round down the end date (e.g. consider 2013 the same as the start of 2013. Note that this is the opposite of what we did before, and layers before 2015 could have overly wide date ranges.

Categories

Sources should be classified into one of the following categories of different types of layers:

  • photo – For satellite and aerial imagery.
  • historicphoto – Same as above, but for photo layers which are either quite old1 or when there exists a more recent photo source for the same region from the same imagery provider.
  • map – A map which is not mostly based on OSM data.
  • historicmap – Same as above, but for map layers which are either quite old1 or when there exists a more recent version of the map for the same region from the same provider.
  • elevation – A map focused on displaying terrain cartography, such as elevation contour lines or shaded relief maps.
  • osmbasedmap – A map which is mostly based on OSM data.
  • qa – A map or overlay with the main intent to help with quality assurance of OSM data.
  • other – Imagery layers wich don't fit into any of the above categories.
Icon

An imagery source can have an icon by setting the icon property to a URL of an image. This image should be sized such that it can be displayed also at a small scale, e.g. in the list of imagery layers next to the name.

Submitting your modifications

Follow this workflow to create and submit a change to the editor layer index. Whenever branches are mentioned, replace master with gh-pages.

After you've made a modification, and submit a pull request including those json files. Tests will be run automatically, though if you'd like to manually test as it would appear in the iD editor you can try at https://rapideditor.github.io/imagery-index/index.html.

We previously required contributors to run local checks with make check, and run make to rebuild the combined files. This is now handled automatically for every pull request, and should not be done anymore.

Translations

Imagery sources optionally support localization of the name, description, and attribution text. To set an imagery source as being translatable, include the property i18n: true.

Translations are managed using the Transifex platform. After signing up, you can go to iD's project page, select a language and click Translate to start translating.

The translation strings for this project are located in a resource called imagery.

Working with translation files

To work with translation files, install the Transifex Client software.

The Transifex Client uses a file ~/.transifex.rc to store your username and password.

Note that you can also use a Transifex API Token in place of your username and password. In this usage, the username is api and the password is the generated API token.

Once you have installed the client and setup the ~/.transifex.rc file, you can use the following commands:

  • tx push -s - upload latest source /i18n/en.yaml file to Transifex
  • tx pull -a - download latest translation files to /i18n/<lang>.yaml

For convenience you can also run these commands as make txpush or make txpull.

Footnotes

  1. Imagery sources should be considered by their usability from a mapping perspective: If the map or imagery is significantly older than available alternatives (such as the default global background layers), it should be put in the corresponding "historic" category. ↩ ↩2