From a682d50d0d6e5857a0295a4f1f629baf85e393fc Mon Sep 17 00:00:00 2001 From: Brian Sperlongano Date: Sat, 30 Dec 2023 02:14:35 -0500 Subject: [PATCH] Document name_* deprecation strategy (#1605) This PR is a **documentation change only**. It documents the fact that `name:xx` values are present in the tiles and documents that `name_de` and `name_en` will be removed in a future release in favor of `name:de` and `name:en` respectively. --- layers/aerodrome_label/aerodrome_label.yaml | 6 +++--- layers/mountain_peak/mountain_peak.yaml | 4 ++-- layers/park/park.yaml | 6 +++--- layers/place/place.yaml | 6 +++--- layers/poi/poi.yaml | 6 +++--- layers/transportation_name/transportation_name.yaml | 4 ++-- layers/water_name/water_name.yaml | 6 +++--- layers/waterway/waterway.yaml | 6 +++--- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/layers/aerodrome_label/aerodrome_label.yaml b/layers/aerodrome_label/aerodrome_label.yaml index 3a48cf6b..47893d4f 100644 --- a/layers/aerodrome_label/aerodrome_label.yaml +++ b/layers/aerodrome_label/aerodrome_label.yaml @@ -5,9 +5,9 @@ layer: buffer_size: 64 srs: +proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over fields: - name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the aerodrome. - name_en: English name `name:en` if available, otherwise `name`. - name_de: German name `name:de` if available, otherwise `name` or `name:en`. + name: 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`. 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`. This is deprecated and will be removed in a future release in favor of `name:de`. class: description: | Distinguish between more and less important aerodromes. diff --git a/layers/mountain_peak/mountain_peak.yaml b/layers/mountain_peak/mountain_peak.yaml index a7c52db8..c7cb8ab2 100644 --- a/layers/mountain_peak/mountain_peak.yaml +++ b/layers/mountain_peak/mountain_peak.yaml @@ -8,8 +8,8 @@ layer: buffer_size: 64 srs: +proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over fields: - name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the peak. - name_en: English name `name:en` if available, otherwise `name`. + name: 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`. 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`. class: description: | diff --git a/layers/park/park.yaml b/layers/park/park.yaml index 8b2e498c..1ae0543a 100644 --- a/layers/park/park.yaml +++ b/layers/park/park.yaml @@ -22,9 +22,9 @@ layer: The class for other [`protection_title`](http://wiki.openstreetmap.org/wiki/key:protection_title) values is similarly assigned. The class for `boundary=aboriginal_lands` is `aboriginal_lands`. - name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the park (point features only). - name_en: English name `name:en` if available, otherwise `name` (point features only). - name_de: German name `name:de` if available, otherwise `name` or `name:en` (point features only). + name: 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). 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). This is deprecated and will be removed in a future release in favor of `name:de`. rank: Rank of the park within one tile, starting at 1 that is the most important park (point features only). datasource: geometry_field: geometry diff --git a/layers/place/place.yaml b/layers/place/place.yaml index aba01f28..e4d5a57c 100644 --- a/layers/place/place.yaml +++ b/layers/place/place.yaml @@ -12,9 +12,9 @@ layer: Apart from the roads this is also one of the more important layers to create a beautiful map. We suggest you use different font styles and sizes to create a text hierarchy. fields: - name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI. - name_en: English name `name:en` if available, otherwise `name`. - name_de: German name `name:de` if available, otherwise `name` or `name:en`. + name: 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`. 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`. This is deprecated and will be removed in a future release in favor of `name:de`. capital: description: | The **capital** field marks the diff --git a/layers/poi/poi.yaml b/layers/poi/poi.yaml index 937292a8..28fcaced 100644 --- a/layers/poi/poi.yaml +++ b/layers/poi/poi.yaml @@ -6,9 +6,9 @@ layer: buffer_size: 64 srs: +proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over fields: - name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI. - name_en: English name `name:en` if available, otherwise `name`. - name_de: German name `name:de` if available, otherwise `name` or `name:en`. + name: 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`. 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`. This is deprecated and will be removed in a future release in favor of `name:de`. class: description: | More general classes of POIs. If there is no more general `class` for the `subclass` diff --git a/layers/transportation_name/transportation_name.yaml b/layers/transportation_name/transportation_name.yaml index a5e9266b..ad664f9e 100644 --- a/layers/transportation_name/transportation_name.yaml +++ b/layers/transportation_name/transportation_name.yaml @@ -13,8 +13,8 @@ layer: srs: +proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over fields: name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Highways#Names_and_references) value of the highway. - name_en: English name `name:en` if available, otherwise `name`. - name_de: German name `name:de` if available, otherwise `name` or `name:en`. + name_en: 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`. This is deprecated and will be removed in a future release in favor of `name:de`. ref: The OSM [`ref`](http://wiki.openstreetmap.org/wiki/Key:ref) tag of the motorway or its network. ref_length: Length of the `ref` field. Useful for having a shield icon as background for labeling motorways. network: diff --git a/layers/water_name/water_name.yaml b/layers/water_name/water_name.yaml index 89b6098e..4162dd31 100644 --- a/layers/water_name/water_name.yaml +++ b/layers/water_name/water_name.yaml @@ -9,9 +9,9 @@ layer: This is based of the [osm-lakelines](https://github.com/openmaptiles/osm-lakelines) project which derives nice centerlines from OSM water bodies. Only the most important lakes contain labels. fields: - name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the water body. - name_en: English name `name:en` if available, otherwise `name`. - name_de: German name `name:de` if available, otherwise `name` or `name:en`. + name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the water body. Language-specific values are in `name:xx`. + name_en: 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`. This is deprecated and will be removed in a future release in favor of `name:de`. class: description: | Distinguish between `lake`, `ocean`, `bay`, `strait`, and `sea`. diff --git a/layers/waterway/waterway.yaml b/layers/waterway/waterway.yaml index 53ec3bce..d3440852 100644 --- a/layers/waterway/waterway.yaml +++ b/layers/waterway/waterway.yaml @@ -18,10 +18,10 @@ layer: buffer_size: 4 fields: name: | - The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the waterway. + The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the waterway. Language-specific values are in `name:xx`. The `name` field may be empty for NaturalEarth data or at lower zoom levels. - name_en: English name `name:en` if available, otherwise `name`. - name_de: German name `name:de` if available, otherwise `name` or `name:en`. + name_en: 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`. This is deprecated and will be removed in a future release in favor of `name:de`. class: description: | The original value of the [`waterway`](http://wiki.openstreetmap.org/wiki/Key:waterway) tag.