Add generated docs
|
@ -0,0 +1,19 @@
|
|||
# boundary
|
||||
|
||||
Contains administrative boundaries as linestrings (no maritime boundaries yet) as linestrings.
|
||||
Until z7 [Natural Earth data](http://www.naturalearthdata.com/downloads/10m-cultural-vectors/10m-admin-0-countries/)
|
||||
is used after which OSM boundaries ([`boundary=administrative`](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative)) are present from z8 to z14.
|
||||
OSM data contains all [`admin_level`](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative#admin_level)
|
||||
but for most styles it makes sense to just style `admin_level=2` and `admin_level=4`.
|
||||
|
||||
## Fields
|
||||
|
||||
- **admin_level**: OSM [admin_level](http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative#admin_level)
|
||||
indicating the level of importance of this boundary.
|
||||
At low zoom levels the Natural Earth boundaries are mapped to the equivalent admin levels.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 4.1 KiB |
|
@ -0,0 +1,12 @@
|
|||
# building
|
||||
|
||||
All [OSM Buildings](http://wiki.openstreetmap.org/wiki/Buildings). All building tags are imported ([`building=*`](http://wiki.openstreetmap.org/wiki/Key:building)). The buildings are not yet ready for 3D rendering support and any help to improve
|
||||
this is welcomed.
|
||||
|
||||
## Fields
|
||||
|
||||
- **render_min_height**: An approximated height from levels and height of the bottom of the building or building:part after the method of Paul Norman in [OSM Clear](https://github.com/ClearTables/osm-clear). For future 3D rendering of buildings.
|
||||
- **render_height**: An approximated height from levels and height of the building or building:part after the method of Paul Norman in [OSM Clear](https://github.com/ClearTables/osm-clear). For future 3D rendering of buildings.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# highway
|
||||
|
||||
Roads or [`highway`](http://wiki.openstreetmap.org/wiki/Key:highway) in OpenStreetMap lingo.
|
||||
This layer is directly derived from the OSM road hierarchy which is why it is called `highway`. Only
|
||||
at zoom level 4 to 7 some major highways from Natural Earth are used otherwise it is only OSM data.
|
||||
It contains all roads from motorways to primary, secondary and tertiary roads to residential roads and
|
||||
foot paths. Styling the roads is the most essential part of the map. If you can put enough effort into it
|
||||
makes sense to carefully style each `subclass`. For more comfortable styling you can also just style the roads
|
||||
by `class`. Roads can have different properties, a road can have `oneway=yes` and `bridge=yes` at the same time.
|
||||
These properties are reflected in the field `properties`.
|
||||
This layer is not meant for labelling the roads (the purpose of the layer `highway_name`).
|
||||
|
||||
The `highway` layer also contains polygons for things like plazas.
|
||||
|
||||
## Fields
|
||||
|
||||
- **class**: Either `motorway`, `major_road` (containing `trunk`, `primary`, `secondary` and `tertiary` roads) and `minor_road` (less important roads in the hierarchy like `residential` or `service`) or `path` for
|
||||
non vehicle paths (such as `cycleway` or `footpath`).
|
||||
- **subclass**: Original value of the [`highway`](http://wiki.openstreetmap.org/wiki/Key:highway) tag. Use this to do more
|
||||
precise styling.
|
||||
- **properties**: Additional properties describing the nature of road.
|
||||
The properties `bridge` and `tunnel` can be combined with `oneway` as well. So to style all bridges the same you
|
||||
should style both the properties `bridge` and `bridge:oneway`.
|
||||
Properties can be one of `bridge:oneway`, `tunnel:oneway`, `ramp`, `ford`, `bridge`, `tunnel` or`oneway`.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 52 KiB |
|
@ -0,0 +1,19 @@
|
|||
# highway_name
|
||||
|
||||
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
|
||||
to have better label placement than having many small linestrings.
|
||||
For motorways you should use the `ref` field to label them while for other roads you should use `name`.
|
||||
|
||||
## Fields
|
||||
|
||||
- **ref**: The OSM [`ref`](http://wiki.openstreetmap.org/wiki/Key:ref) tag of the motorway or road.
|
||||
- **ref_length**: Length of the `ref` field. Useful for having a shield icon as background for labeling motorways.
|
||||
- **name**: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Highways#Names_and_references) value of the highway.
|
||||
- **subclass**: Original value of the [`highway`](http://wiki.openstreetmap.org/wiki/Key:highway) tag. Use this to do more
|
||||
precise styling.
|
||||
- **class**: Either `motorway`, `major_road` (containing `trunk`, `primary`, `secondary` and `tertiary` roads) and `minor_road` (less important roads in the hierarchy like `residential` or `service`) or `path` for
|
||||
non vehicle paths (such as `cycleway` or `footpath`).
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# housenumber
|
||||
|
||||
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.
|
||||
|
||||
## Fields
|
||||
|
||||
- **housenumber**: Value of the [`addr:housenumber`](http://wiki.openstreetmap.org/wiki/Key:addr) tag.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# landcover
|
||||
|
||||
Landcover is used to describe the physical material at the surface of the earth. At lower zoom levels this is
|
||||
from Natural Earth data for glaciers and ice shelves and at higher zoom levels the landcover is implied
|
||||
by OSM tags (like `landuse` or `natural`).
|
||||
|
||||
## Fields
|
||||
|
||||
- **class**: More generalized groups of either `farmland`, `ice`, `wood`, `grass` or `wetland`.
|
||||
Use this to assign general colors to the landcover.
|
||||
- **subclass**: Original value of either the `landuse`, `natural` or `wetland` tag.
|
||||
Use this to do more precise styling.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 47 KiB |
|
@ -0,0 +1,17 @@
|
|||
# landuse
|
||||
|
||||
Landuse is used to describe use of land by humans.At lower zoom levels this is
|
||||
from Natural Earth data for residential (urban) areas and at higher zoom levels mostly OSM `landuse` tags.
|
||||
|
||||
## Fields
|
||||
|
||||
- **class**: More generalized groups of either `park`, `school`, `hospital`, `railway`,
|
||||
`cemetery`, `military`, `residential`. Use this to assign general for landuse.
|
||||
- **subclass**: Original value of either the `amenity`, `landuse`, `leisure` or `boundary` tag.
|
||||
Use this to do more precise styling.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 32 KiB |
|
@ -0,0 +1,29 @@
|
|||
# place
|
||||
|
||||
The place layer consists out of [countries](http://wiki.openstreetmap.org/wiki/Tag:place%3Dcountry),
|
||||
[states](http://wiki.openstreetmap.org/wiki/Tag:place%3Dstate) and [cities](http://wiki.openstreetmap.org/wiki/Key:place).
|
||||
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_en**: The english `name:en` value if available.
|
||||
- **name**: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI.
|
||||
- **rank**: 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).
|
||||
Use the `rank` field to build a 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`.
|
||||
- **class**: Distinguish between `country`, `state` and other city classes like
|
||||
`city`, `town`, `village`, `hamlet`, `suburb`, `neighbourhood` or `isolated_dwelling`.
|
||||
Use this to separately style the different places according to their importance (usually country and state different
|
||||
than cities).
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 23 KiB |
|
@ -0,0 +1,31 @@
|
|||
# poi
|
||||
|
||||
[Points of interests](http://wiki.openstreetmap.org/wiki/Points_of_interest) containing
|
||||
a of a variety of OpenStreetMap tags. Mostly contains amenities, sport, shop and tourist POIs.
|
||||
|
||||
## Fields
|
||||
|
||||
- **class**: More general classes of POIs. If there is no more general `class` for the `subclass`
|
||||
this field will contain the same value as `subclass`.
|
||||
But for example for schools you only need to style the class `school` to filter the subclasses `school`
|
||||
and `kindergarten`. Or use the class `shop` to style all shops.
|
||||
- **name_en**: The english `name:en` value if available.
|
||||
- **name**: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the POI.
|
||||
- **rank**: The POIs are ranked ascending according to their importance within a grid. The `rank` value shows the
|
||||
local relative importance of a POI within it's cell in the grid. This can be used to reduce label density at z14.
|
||||
Since all POIs already need to be contained at `z14` you can use `less than rank=10` epxression to limit
|
||||
POIs. At some point like z17 you can show all POIs.
|
||||
- **subclass**: Original value of either the
|
||||
[`amenity`](http://wiki.openstreetmap.org/wiki/Key:amenity),
|
||||
[`leisure`](http://wiki.openstreetmap.org/wiki/Key:leisure),
|
||||
[`landuse`](http://wiki.openstreetmap.org/wiki/Key:landuse),
|
||||
[`sport`](http://wiki.openstreetmap.org/wiki/Key:sport),
|
||||
[`tourism`](http://wiki.openstreetmap.org/wiki/Key:tourism)
|
||||
or [`shop`](http://wiki.openstreetmap.org/wiki/Key:shop)
|
||||
tag. Use this to do more precise styling.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 965 KiB |
|
@ -0,0 +1,18 @@
|
|||
# water
|
||||
|
||||
Water polygons representing oceans and lakes. Covered watered areas are excluded (`covered=yes`).
|
||||
Until z6 all water originates from Natural Earth. To get a more correct display of the south pole you should also
|
||||
style the covering ice shelves over the water.
|
||||
Water from OpenStreetMap after z7 is split into many smaller polygons to improve rendering performance.
|
||||
This however can lead to less rendering options in clients since these boundaries show up. So you might not be
|
||||
able to use border styling for ocean water features.
|
||||
|
||||
## Fields
|
||||
|
||||
- **class**: Either `ocean`, `lake` or `river`.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 16 KiB |
|
@ -0,0 +1,14 @@
|
|||
# water_name
|
||||
|
||||
Lake center lines for labelling lake bodies.
|
||||
This is based of the [osm-lakelines](https://github.com/lukasmartinelli/osm-lakelines) project
|
||||
which derives nice centerlines from OSM water bodies. Only the most important lakes contain labels.
|
||||
|
||||
## Fields
|
||||
|
||||
- **name_en**: The english `name:en` value if available.
|
||||
- **name**: The OSM [`name`](http://wiki.openstreetmap.org/wiki/Key:name) value of the water body.
|
||||
- **class**: At the moment only `lake` since no ocean parts are labelled. *Reserved for future use*.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# waterway
|
||||
|
||||
Rivers based of OpenStreetMap [waterways](http://wiki.openstreetmap.org/wiki/Waterways) for *z8* to *z14*
|
||||
and Natural Earth rivers and lake centerlines from *z3* to *z7*.
|
||||
Too short linestrings are filtered out for some zoom levels. Waterways do no not have a `subclass`.
|
||||
|
||||
## Fields
|
||||
|
||||
- **class**: The original value of the [`waterway`](http://wiki.openstreetmap.org/wiki/Key:waterway) tag.
|
||||
Can be one of [`stream`](http://wiki.openstreetmap.org/wiki/Tag:waterway%3Dstream),
|
||||
[`river`](http://wiki.openstreetmap.org/wiki/Tag:waterway%3Driver),
|
||||
[`canal`](http://wiki.openstreetmap.org/wiki/Tag:waterway%3Dcanal),
|
||||
[`drain`](http://wiki.openstreetmap.org/wiki/Tag:waterway%3Ddrain),
|
||||
[`ditch`](http://wiki.openstreetmap.org/wiki/Tag:waterway%3Dditch)`.
|
||||
|
||||
## Mapping
|
||||
|
||||

|
||||
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 7.0 KiB |