diff --git a/Makefile b/Makefile index ca51ae4..8ff02da 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,5 @@ all: build/openmaptiles.tm2source/data.yml build/mapping.yaml build/tileset.sql -.PHONY: docs -docs: layers/railway/README.md layers/boundary/README.md layers/water/README.md layers/building/README.md layers/highway/README.md layers/highway_name/README.md layers/poi/README.md layers/place/README.md layers/waterway/README.md layers/water_name/README.md layers/landcover/README.md layers/landuse/README.md layers/housenumber/README.md - build/openmaptiles.tm2source/data.yml: mkdir -p build/openmaptiles.tm2source && generate-tm2source openmaptiles.yaml --host="postgres" --port=5432 --database="openmaptiles" --user="openmaptiles" --password="openmaptiles" > build/openmaptiles.tm2source/data.yml @@ -12,44 +9,5 @@ build/mapping.yaml: build/tileset.sql: mkdir -p build && generate-sql openmaptiles.yaml > build/tileset.sql -layers/poi/README.md: - generate-doc layers/poi/poi.yaml --diagram layers/poi/mapping > layers/poi/README.md - -layers/highway/README.md: - generate-doc layers/highway/highway.yaml --diagram layers/highway/mapping > layers/highway/README.md - -layers/highway_name/README.md: - generate-doc layers/highway_name/highway_name.yaml > layers/highway_name/README.md - -layers/railway/README.md: - generate-doc layers/railway/railway.yaml --diagram layers/railway/mapping > layers/railway/README.md - -layers/boundary/README.md: - generate-doc layers/boundary/boundary.yaml --diagram layers/boundary/mapping > layers/boundary/README.md - -layers/water_name/README.md: - generate-doc layers/water_name/water_name.yaml > layers/water_name/README.md - -layers/water/README.md: - generate-doc layers/water/water.yaml --diagram layers/water/mapping > layers/water/README.md - -layers/waterway/README.md: - generate-doc layers/waterway/waterway.yaml --diagram layers/waterway/mapping > layers/waterway/README.md - -layers/building/README.md: - generate-doc layers/building/building.yaml > layers/building/README.md - -layers/place/README.md: - generate-doc layers/place/place.yaml --diagram layers/place/mapping > layers/place/README.md - -layers/landuse/README.md: - generate-doc layers/landuse/landuse.yaml --diagram layers/landuse/mapping > layers/landuse/README.md - -layers/landcover/README.md: - generate-doc layers/landcover/landcover.yaml --diagram layers/landcover/mapping > layers/landcover/README.md - -layers/housenumber/README.md: - generate-doc layers/housenumber/housenumber.yaml > layers/housenumber/README.md - clean: - rm -f build/openmaptiles.tm2source/data.yml && rm -f build/mapping.yaml && rm -f build/tileset.sql && rm -f layers/**/README.md&& rm -f layers/**/*.png + rm -f build/openmaptiles.tm2source/data.yml && rm -f build/mapping.yaml && rm -f build/tileset.sql diff --git a/README.md b/README.md index 6fcdc06..46c3a96 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,19 @@ We welcome new standard layers from other data sources or import tools (like osm Each layer is documented and self contained. Click on the link for each layer to get more information. Layers can be chosen to create a **Tileset** like the `openmaptiles.yaml` tileset. -- [boundary](layers/boundary/README.md) -- [building](layers/building/README.md) -- [highway](layers/highway/README.md) -- [highway_name](layers/highway_name/README.md) -- [housenumber](layers/housenumber/README.md) -- [landcover](layers/landcover/README.md) -- [landuse](layers/landuse/README.md) -- [place](layers/place/README.md) -- [poi](layers/poi/README.md) -- [railway](layers/railway/README.md) -- [water](layers/water/README.md) -- [water_name](layers/water_name/README.md) -- [waterway](layers/waterway/README.md) +- [boundary](https://github.com/openmaptiles/openmaptiles/wiki/boundary) +- [building](https://github.com/openmaptiles/openmaptiles/wiki/building) +- [highway](https://github.com/openmaptiles/openmaptiles/wiki/highway) +- [highway_name](https://github.com/openmaptiles/openmaptiles/wiki/highway_name) +- [housenumber](https://github.com/openmaptiles/openmaptiles/wiki/housenumber) +- [landcover](https://github.com/openmaptiles/openmaptiles/wiki/landcover) +- [landuse](https://github.com/openmaptiles/openmaptiles/wiki/landuse) +- [place](https://github.com/openmaptiles/openmaptiles/wiki/place) +- [poi](https://github.com/openmaptiles/openmaptiles/wiki/poi) +- [railway](https://github.com/openmaptiles/openmaptiles/wiki/railway) +- [water](https://github.com/openmaptiles/openmaptiles/wiki/water) +- [water_name](https://github.com/openmaptiles/openmaptiles/wiki/water_name) +- [waterway](https://github.com/openmaptiles/openmaptiles/wiki/waterway) ### Define your own Layer diff --git a/layers/boundary/README.md b/layers/boundary/README.md deleted file mode 100644 index 98e6827..0000000 --- a/layers/boundary/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/boundary/mapping.png b/layers/boundary/mapping.png deleted file mode 100644 index 72032cd..0000000 Binary files a/layers/boundary/mapping.png and /dev/null differ diff --git a/layers/building/README.md b/layers/building/README.md deleted file mode 100644 index 9762193..0000000 --- a/layers/building/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# 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_height**: An approximated height from levels and height of building after the method of Paul Norman in [OSM Clear](https://github.com/ClearTables/osm-clear). For future 3D rendering of buildings. - - - diff --git a/layers/highway/README.md b/layers/highway/README.md deleted file mode 100644 index ee88c25..0000000 --- a/layers/highway/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/highway/mapping.png b/layers/highway/mapping.png deleted file mode 100644 index 363342b..0000000 Binary files a/layers/highway/mapping.png and /dev/null differ diff --git a/layers/highway_name/README.md b/layers/highway_name/README.md deleted file mode 100644 index e0c998c..0000000 --- a/layers/highway_name/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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`). - - - diff --git a/layers/housenumber/README.md b/layers/housenumber/README.md deleted file mode 100644 index 637bd3a..0000000 --- a/layers/housenumber/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# 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. - - - diff --git a/layers/landcover/README.md b/layers/landcover/README.md deleted file mode 100644 index a6e78f2..0000000 --- a/layers/landcover/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/landcover/mapping.png b/layers/landcover/mapping.png deleted file mode 100644 index 1662cf5..0000000 Binary files a/layers/landcover/mapping.png and /dev/null differ diff --git a/layers/landuse/README.md b/layers/landuse/README.md deleted file mode 100644 index 9b024be..0000000 --- a/layers/landuse/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/landuse/mapping.png b/layers/landuse/mapping.png deleted file mode 100644 index 0a4647c..0000000 Binary files a/layers/landuse/mapping.png and /dev/null differ diff --git a/layers/place/README.md b/layers/place/README.md deleted file mode 100644 index bd928b4..0000000 --- a/layers/place/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/place/mapping.png b/layers/place/mapping.png deleted file mode 100644 index ed7581c..0000000 Binary files a/layers/place/mapping.png and /dev/null differ diff --git a/layers/poi/README.md b/layers/poi/README.md deleted file mode 100644 index de80baf..0000000 --- a/layers/poi/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/poi/mapping.png b/layers/poi/mapping.png deleted file mode 100644 index 7b85381..0000000 Binary files a/layers/poi/mapping.png and /dev/null differ diff --git a/layers/railway/README.md b/layers/railway/README.md deleted file mode 100644 index 8a1bc51..0000000 --- a/layers/railway/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# railway - -The `railway` layer contains linestrings marking tracks from [OSM Railways](http://wiki.openstreetmap.org/wiki/Railways). -It contains tracks for [passenger and freight trains]() and smaller tracks for [Trams](http://wiki.openstreetmap.org/wiki/Tag:railway%3Dtram) or [similar](http://wiki.openstreetmap.org/wiki/Tag:railway%3Dlight_rail) vehicles. But also tracks for [subways](http://wiki.openstreetmap.org/wiki/Tag:railway%3Dsubway), [narrow-gauge trains](http://wiki.openstreetmap.org/wiki/Tag:railway%3Dnarrow_gauge) or [historic trains](http://wiki.openstreetmap.org/wiki/Tag:railway%3Dpreserved). -Non mainline tracks (marked with class `minor_rail`) used for [storage of trains](http://wiki.openstreetmap.org/wiki/Tag:service%3Dyard) and [maintenance](http://wiki.openstreetmap.org/wiki/Tag:service%3Dsiding) are contained in the highest zoom levels and should be styled more subtle than the mainline tracks with class `rail`. - -## Fields - -- **class**: Divides the track into mainline tracks (class `rail`) and less important tracks -used for maintenance (class `minor_rail`). -- **subclass**: Original value of the [`railway`](http://wiki.openstreetmap.org/wiki/Key:railway) can be one of -`rail`, `light_rail`, `subway`, `narrow_gauge`, `preserved`, `tram`. -- **properties**: Additional properties describing the nature of tracks. Can be either `bridge` or `tunnel`. - -## Mapping - -![](mapping.png) - - diff --git a/layers/railway/mapping b/layers/railway/mapping deleted file mode 100644 index d068987..0000000 --- a/layers/railway/mapping +++ /dev/null @@ -1,14 +0,0 @@ -digraph "Imposm Mapping" { - graph [rankdir=LR ranksep=3] - subgraph railway_linestring { - node [fixed_size=shape "width:"=20] - railway_linestring [shape=box] - key_railway [label=railway shape=box] - key_railway -> railway_linestring [label="rail -light_rail -subway -narrow_gauge -preserved -tram"] - } -} \ No newline at end of file diff --git a/layers/railway/mapping.png b/layers/railway/mapping.png deleted file mode 100644 index 52a4723..0000000 Binary files a/layers/railway/mapping.png and /dev/null differ diff --git a/layers/water/README.md b/layers/water/README.md deleted file mode 100644 index 1152e62..0000000 --- a/layers/water/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/water/mapping.png b/layers/water/mapping.png deleted file mode 100644 index f0f09e3..0000000 Binary files a/layers/water/mapping.png and /dev/null differ diff --git a/layers/water_name/README.md b/layers/water_name/README.md deleted file mode 100644 index a87f4eb..0000000 --- a/layers/water_name/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# 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*. - - - diff --git a/layers/waterway/README.md b/layers/waterway/README.md deleted file mode 100644 index 4898394..0000000 --- a/layers/waterway/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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 - -![](mapping.png) - - diff --git a/layers/waterway/mapping.png b/layers/waterway/mapping.png deleted file mode 100644 index 51a4f6e..0000000 Binary files a/layers/waterway/mapping.png and /dev/null differ