Add possible values to place layer doc

This commit is contained in:
Lukas Martinelli 2016-11-30 12:38:47 +00:00
parent 6fb20ab650
commit ee9d4348e0

View File

@ -7,21 +7,59 @@ layer:
We suggest you use different font styles and sizes to create a text hierarchy. We suggest you use different font styles and sizes to create a text hierarchy.
fields: fields:
name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI. name: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI.
name_en: The english `name:en` value if available. name_en: The English `name:en` value or local `name` if not available.
capital:
description: |
The **capital** field marks the
[`admin_level`](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative#admin_level)
of the boundary the place is a capital of.
values: [2, 4]
class: | class: |
Distinguish between `country`, `state` and other city classes like description: |
`city`, `town`, `village`, `hamlet`, `suburb`, `neighbourhood` or `isolated_dwelling`. Distinguish between continents, countries, states and
Use this to separately style the different places according to their importance (usually country and state different places like settlements or smaller entities.
than cities). Use this to separately style the different places and build
rank: | a text hierarchy according to their importance.
Countries, states and the most important cities all have a `rank` to boost their importance on the map. than cities).
The `rank` field for counries and states ranges from `1` to `6` while the `rank` field for values:
cities ranges from `1` to `10` for the most important cities and continues from `10` serially based - continent
on the local importance of the city (derived from population and city class). - country
Use the `rank` field to build a text hierarchy. - state
The rank value is a combination of the Natural Earth `scalerank`, `labelrank` and `datarank` values for countries - settlement
and states and for cities consists out of a shifted Natural Earth `scalerank` combined with a local rank - subregion
within a grid for cities that do not have a Natural Earth `scalerank`. - other
subclass:
description: |
Use **subclass** to do more precise styling.
Original value of the
[`place`](http://wiki.openstreetmap.org/wiki/Key:place) tag.
values:
- continent
- country
- state
- city
- town
- village
- hamlet
- suburb
- neighbourhood
- isolated_dwelling
rank:
description: |
Countries, states and the most important cities all have a
**rank** to boost their importance on the map.
The **rank** field for counries and states ranges from
`1` to `6` while the **rank** field for cities ranges from
`1` to `10` for the most important cities
and continues from `10` serially based on the
local importance of the city (derived from population and city class).
You can use the **rank** to limit density of labels or improve
the text hierarchy.
The rank value is a combination of the Natural Earth
`scalerank`, `labelrank` and `datarank` values for countries
and states and for cities consists out of a shifted
Natural Earth `scalerank` combined with a local rank
within a grid for cities that do not have a Natural Earth `scalerank`.
buffer_size: 128 buffer_size: 128
datasource: datasource:
geometry_field: geometry geometry_field: geometry