Skip to content

Commit 617dcb0

Browse files
authored
document include_ids and compress in configuration readme (#832)
1 parent 5c8d73b commit 617dcb0

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/CONFIGURATION.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ It also includes these global settings:
3131
* `minzoom` - the minimum zoom level at which any tiles will be generated
3232
* `maxzoom` - the maximum zoom level at which any tiles will be generated
3333
* `basezoom` - the zoom level for which tilemaker will generate tiles internally (should usually be the same as `maxzoom`)
34-
* `include_ids` - whether you want to store the OpenStreetMap IDs for each way/node within your vector tiles
35-
* `compress` - whether to compress vector tiles (Any of "gzip","deflate" or "none"(default))
34+
* `include_ids` - whether you want to store the OpenStreetMap IDs for each way/node within your vector tiles. This option is not compatible with the merging options defined by the `combine_xxx` settings (see the dedicated paragraph below)
35+
* `compress` - for mbtiles output, whether to compress vector tiles (Any of "gzip","deflate" or "none"(default)). For pmtiles output, compression is hardcoded to gzip
3636
* `combine_below` - whether to merge adjacent linestrings of the same type: will be done at zoom levels below that specified here (e.g. `"combine_below": 14` to merge at z1-13)
3737
* `name`, `version` and `description` - about your project (these are written into the MBTiles file)
3838
* `high_resolution` (optional) - whether to use extra coordinate precision at the maximum zoom level (makes tiles a bit bigger)
@@ -115,7 +115,16 @@ For example:
115115
}
116116
}
117117
}
118-
118+
119+
### Including IDs
120+
121+
Be careful when using both the `include_ids: true` setting to include IDs and the `combine_xxx` settings to lighten tiles : they are not compatible. During the merging process, items with identical tags are combined in a collection, with only 1 ID being retained for all the merged items. If you need to have the exact ID for each item (for example, for a clickable map), you need to remove the merging settings in the target levels and layers:
122+
123+
* set `combine_points: false` (`true` is the default value) in the target layers
124+
* set `combine_below` and `combine_polygons_below` below the target zoom level (or remove them)
125+
126+
If you need the include OSM types as well, you will need to modify the `process.lua` script, check issue [#740](https://github.com/systemed/tilemaker/issues/740) for more information.
127+
119128
## Lua processing reference
120129

121130
Your Lua file can supply these functions for tilemaker to call:

0 commit comments

Comments
 (0)