Skip to content

Commit

Permalink
Update documentation for OMT v3.15 (#92)
Browse files Browse the repository at this point in the history
Update Schema based on OpenMapTiles release v3.15

Updated `{layer}.md` and `etl_{layer}.png` and `mapping_{layer}.png` files.
  • Loading branch information
TomPohys authored Apr 29, 2024
1 parent 247c2a1 commit 78c8ba6
Show file tree
Hide file tree
Showing 22 changed files with 150 additions and 48 deletions.
6 changes: 3 additions & 3 deletions layers/aerodrome_label.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ sql_query: SELECT id, geometry, name, name_en, name_de, NULLIF(tags->'name_int',

### name

The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the aerodrome.
The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the aerodrome. Language-specific values are in `name:xx`.

### name_en

English name `name:en` if available, otherwise `name`.
English name `name:en` if available, otherwise `name`. This is deprecated and will be removed in a future release in favor of `name:en`.

### name_de

German name `name:de` if available, otherwise `name` or `name:en`.
German name `name:de` if available, otherwise `name` or `name:en`. This is deprecated and will be removed in a future release in favor of `name:de`.

### class

Expand Down
12 changes: 10 additions & 2 deletions layers/boundary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ category: layer
title: boundary
etl_graph: media/etl_boundary.png
mapping_graph: media/mapping_boundary.png
sql_query: SELECT geometry, admin_level, adm0_l, adm0_r, disputed, disputed_name, claimed_by, maritime FROM layer_boundary(ST_SetSRID('BOX3D(-20037508.34 -20037508.34, 20037508.34 20037508.34)'::box3d, 3857), 14)
sql_query: SELECT geometry, admin_level, adm0_l, adm0_r, disputed, disputed_name, claimed_by, maritime, class, name, NULLIF(tags->'name_int', '') AS "name_int", NULLIF(tags->'name:latin', '') AS "name:latin", NULLIF(tags->'name:nonlatin', '') AS "name:nonlatin" FROM layer_boundary(ST_SetSRID('BOX3D(-20037508.34 -20037508.34, 20037508.34 20037508.34)'::box3d, 3857), 14)
---
Contains administrative boundaries as linestrings.
Contains administrative boundaries as linestrings and aboriginal lands as polygons.
Until z4 [Natural Earth data](http://www.naturalearthdata.com/downloads/) is used after which
OSM boundaries ([`boundary=administrative`](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative))
are present from z5 to z14 (also for maritime boundaries with `admin_level <= 2` at z4).
Expand All @@ -15,6 +15,14 @@ but for most styles it makes sense to just style `admin_level=2` and `admin_leve

## Fields

### class

Use the **class** to differentiate between different kinds of boundaries. The class for `boundary=aboriginal_lands` is `aboriginal_lands`.

### name

The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value (area features only).

### admin_level

OSM [admin_level](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative#admin_level)
Expand Down
3 changes: 2 additions & 1 deletion layers/housenumber.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ sql_query: SELECT geometry, housenumber FROM layer_housenumber(ST_SetSRID('BOX3D
---
Everything in OpenStreetMap which contains a `addr:housenumber` tag useful for labelling housenumbers on a map.
This adds significant size to *z14*. For buildings the centroid of the building is used as housenumber.
Duplicates within a tile are dropped if they have the same street/block_number (records without name tag are prioritized for preservation).

## Fields

### housenumber

Value of the [`addr:housenumber`](http://wiki.openstreetmap.org/wiki/Key:addr) tag.
Value of the [`addr:housenumber`](http://wiki.openstreetmap.org/wiki/Key:addr) tag. If there are multiple values separated by semi-colons, the first and last value separated by a dash.



Expand Down
4 changes: 2 additions & 2 deletions layers/mountain_peak.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ sql_query: SELECT osm_id, geometry, name, name_en, name_de, NULLIF(tags->'name_i

### name

The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the peak.
The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the peak. Language-specific values are in `name:xx`.

### name_en

English name `name:en` if available, otherwise `name`.
English name `name:en` if available, otherwise `name`. This is deprecated and will be removed in a future release in favor of `name:en`.

### name_de

Expand Down
16 changes: 8 additions & 8 deletions layers/park.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ etl_graph: media/etl_park.png
mapping_graph: media/mapping_park.png
sql_query: SELECT geometry, class, name, name_en, name_de, NULLIF(tags->'name_int', '') AS "name_int", NULLIF(tags->'name:latin', '') AS "name:latin", NULLIF(tags->'name:nonlatin', '') AS "name:nonlatin", rank FROM layer_park(ST_SetSRID('BOX3D(-20037508.34 -20037508.34, 20037508.34 20037508.34)'::box3d, 3857), 14, 1)
---
The park layer contains parks from OpenStreetMap tagged with
[`boundary=national_park`](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dnational_park),
[`boundary=protected_area`](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dprotected_area),
or [`leisure=nature_reserve`](http://wiki.openstreetmap.org/wiki/Tag:leisure%3Dnature_reserve).
The park layer in OpenMapTiles contains natural and protected areas from OpenStreetMap,
such as parks tagged with [`boundary=national_park`](https://wiki.openstreetmap.org/wiki/Tag:boundary%3Dnational_park),
[`boundary=protected_area`](https://wiki.openstreetmap.org/wiki/Tag:boundary%3Dprotected_area),
or [`leisure=nature_reserve`](https://wiki.openstreetmap.org/wiki/Tag:leisure%3Dnature_reserve).

## Fields

### class

Use the **class** to differentiate between different parks.
Use the **class** to differentiate between different kinds of features in the `parks` layer.
The class for `boundary=protected_area` parks is the lower-case of the
[`protection_title`](http://wiki.openstreetmap.org/wiki/key:protection_title)
value with blanks replaced by `_`.
Expand All @@ -26,15 +26,15 @@ values is similarly assigned.

### name

The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the park (point features only).
The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the park (point features only). Language-specific values are in `name:xx`.

### name_en

English name `name:en` if available, otherwise `name` (point features only).
English name `name:en` if available, otherwise `name` (point features only). This is deprecated and will be removed in a future release in favor of `name:en`.

### name_de

German name `name:de` if available, otherwise `name` or `name:en` (point features only).
German name `name:de` if available, otherwise `name` or `name:en` (point features only). This is deprecated and will be removed in a future release in favor of `name:de`.

### rank

Expand Down
12 changes: 8 additions & 4 deletions layers/place.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ We suggest you use different font styles and sizes to create a text hierarchy.

### name

The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI.
The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the place. Language-specific values are in `name:xx`.

### name_en

English name `name:en` if available, otherwise `name`.
English name `name:en` if available, otherwise `name`. This is deprecated and will be removed in a future release in favor of `name:en`.

### name_de

German name `name:de` if available, otherwise `name` or `name:en`.
German name `name:de` if available, otherwise `name` or `name:en`. This is deprecated and will be removed in a future release in favor of `name:de`.

### capital

Expand All @@ -48,7 +48,9 @@ Original value of the
Distinguish between continents, countries, states, islands and
places like settlements or smaller entities.
Use **class** to separately style the different places and build
a text hierarchy according to their importance.
a text hierarchy according to their importance. For places derived
from boundaries, the original value of the
[`boundary`](http://wiki.openstreetmap.org/wiki/Key:boundary) tag.

Possible values:

Expand All @@ -60,11 +62,13 @@ Possible values:
- `town`
- `village`
- `hamlet`
- `borough`
- `suburb`
- `quarter`
- `neighbourhood`
- `isolated_dwelling`
- `island`
- `aboriginal_lands`


### iso_a2
Expand Down
8 changes: 5 additions & 3 deletions layers/poi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ a of a variety of OpenStreetMap tags. Mostly contains amenities, sport, shop and

### name

The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI.
The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI. Language-specific values are in `name:xx`.

### name_en

English name `name:en` if available, otherwise `name`.
English name `name:en` if available, otherwise `name`. This is deprecated and will be removed in a future release in favor of `name:en`.

### name_de

German name `name:de` if available, otherwise `name` or `name:en`.
German name `name:de` if available, otherwise `name` or `name:en`. This is deprecated and will be removed in a future release in favor of `name:de`.

### class

Expand All @@ -33,6 +33,7 @@ and `kindergarten`. Or use the class `shop` to style all shops.
Possible values:

- `shop`
- `office`
- `town_hall`
- `golf`
- `fast_food`
Expand Down Expand Up @@ -66,6 +67,7 @@ Possible values:
- `swimming`
- `castle`
- `atm`
- `fuel`


### subclass
Expand Down
3 changes: 2 additions & 1 deletion layers/transportation.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ Possible values:
The network type derived mainly from [`network`](http://wiki.openstreetmap.org/wiki/Key:network) tag of the road.
See more info about [`us-*`](http://wiki.openstreetmap.org/wiki/Road_signs_in_the_United_States),
[`ca-transcanada`](https://en.wikipedia.org/wiki/Trans-Canada_Highway),
or [`gb-*`](http://wiki.openstreetmap.org/wiki/United_Kingdom_Tagging_Guidelines#UK_roads).
[`gb-*`](http://wiki.openstreetmap.org/wiki/United_Kingdom_Tagging_Guidelines#UK_roads),
or [`ie-*`](http://wiki.openstreetmap.org/wiki/Ireland/Roads).

### brunnel

Expand Down
108 changes: 93 additions & 15 deletions layers/transportation_name.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: layer
title: transportation_name
etl_graph: media/etl_transportation_name.png
mapping_graph: media/mapping_transportation_name.png
sql_query: SELECT geometry, name, name_en, name_de, NULLIF(tags->'name_int', '') AS "name_int", NULLIF(tags->'name:latin', '') AS "name:latin", NULLIF(tags->'name:nonlatin', '') AS "name:nonlatin", ref, ref_length, network::text, class::text, subclass, brunnel, layer, level, indoor, route_1, route_2, route_3, route_4, route_5, route_6 FROM layer_transportation_name(ST_SetSRID('BOX3D(-20037508.34 -20037508.34, 20037508.34 20037508.34)'::box3d, 3857), 14)
sql_query: SELECT geometry, name, name_en, name_de, NULLIF(tags->'name_int', '') AS "name_int", NULLIF(tags->'name:latin', '') AS "name:latin", NULLIF(tags->'name:nonlatin', '') AS "name:nonlatin", ref, ref_length, network::text, class::text, subclass, brunnel, layer, level, indoor, route_1_network, route_1_ref, route_1_name, route_1_colour, route_2_network, route_2_ref, route_2_name, route_2_colour, route_3_network, route_3_ref, route_3_name, route_3_colour, route_4_network, route_4_ref, route_4_name, route_4_colour, route_5_network, route_5_ref, route_5_name, route_5_colour, route_6_network, route_6_ref, route_6_name, route_6_colour FROM layer_transportation_name(ST_SetSRID('BOX3D(-20037508.34 -20037508.34, 20037508.34 20037508.34)'::box3d, 3857), 14)
---
This is the layer for labelling the highways. Only highways that are named `name=*` and are long enough
to place text upon appear. The OSM roads are stitched together if they contain the same name
Expand All @@ -19,11 +19,11 @@ The OSM [`name`](http://wiki.openstreetmap.org/wiki/Highways#Names_and_reference

### name_en

English name `name:en` if available, otherwise `name`.
English name `name:en` if available, otherwise `name`. This is deprecated and will be removed in a future release in favor of `name:en`.

### name_de

German name `name:de` if available, otherwise `name` or `name:en`.
German name `name:de` if available, otherwise `name` or `name:en`. This is deprecated and will be removed in a future release in favor of `name:de`.

### ref

Expand All @@ -46,8 +46,14 @@ Possible values:
- `us-highway`
- `us-state`
- `ca-transcanada`
- `ca-provincial-arterial`
- `ca-provincial`
- `gb-motorway`
- `gb-trunk`
- `gb-primary`
- `ie-motorway`
- `ie-national`
- `ie-regional`
- `road (default)`


Expand Down Expand Up @@ -133,29 +139,101 @@ Possible values:
- `1`


### route_1
### route_1_network

1st route concurrency.
1st route concurrency network.

### route_2
### route_1_ref

2nd route concurrency.
1st route concurrency ref.

### route_3
### route_1_name

3rd route concurrency.
1st route concurrency name.

### route_4
### route_1_colour

4th route concurrency.
1st route concurrency colour.

### route_5
### route_2_network

5th route concurrency.
2nd route concurrency network.

### route_6
### route_2_ref

6th route concurrency.
2nd route concurrency ref.

### route_2_name

2nd route concurrency name.

### route_2_colour

2nd route concurrency colour.

### route_3_network

3rd route concurrency network.

### route_3_ref

3rd route concurrency ref.

### route_3_name

3rd route concurrency name.

### route_3_colour

3rd route concurrency colour.

### route_4_network

4th route concurrency network.

### route_4_ref

4th route concurrency ref.

### route_4_name

4th route concurrency name.

### route_4_colour

4th route concurrency colour.

### route_5_network

5th route concurrency network.

### route_5_ref

5th route concurrency ref.

### route_5_name

5th route concurrency name.

### route_5_colour

5th route concurrency colour.

### route_6_network

6th route concurrency network.

### route_6_ref

6th route concurrency ref.

### route_6_name

6th route concurrency name.

### route_6_colour

6th route concurrency colour.



Expand Down
10 changes: 8 additions & 2 deletions layers/water.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,21 @@ For smaller area then planet, NE lakes keep their Natural Earth IDs.
### class

All water polygons from [OpenStreetMapData](http://osmdata.openstreetmap.de/) have the class `ocean`.
Water bodies with the [`water=river`](http://wiki.openstreetmap.org/wiki/Tag:water=river) tag are classified as river. Wet and dry docks
tagged [`waterway=dock`](http://wiki.openstreetmap.org/wiki/Tag:waterway=dock) are classified as a `dock`.
The water-covered areas of flowing water bodies with the [`water=river`](http://wiki.openstreetmap.org/wiki/Tag:water=river),
[`water=canal`](http://wiki.openstreetmap.org/wiki/Tag:water=canal),
[`water=stream`](http://wiki.openstreetmap.org/wiki/Tag:water=stream),
[`water=ditch`](http://wiki.openstreetmap.org/wiki/Tag:water=ditch), or
[`water=drain`](http://wiki.openstreetmap.org/wiki/Tag:water=drain) tags are classified as river. Wet and dry docks
tagged [`waterway=dock`](http://wiki.openstreetmap.org/wiki/Tag:waterway=dock) are classified as a `dock`.
Various minor waterbodies are classified as a `pond`.
Swimming pools tagged [`leisure=swimming_pool`](https://wiki.openstreetmap.org/wiki/Tag:leisure=swimming_pool) are classified as a `swimming_pool`
All other water bodies are classified as `lake`.

Possible values:

- `dock`
- `river`
- `pond`
- `lake`
- `ocean`
- `swimming_pool`
Expand Down
Loading

0 comments on commit 78c8ba6

Please sign in to comment.