Skip to content

Update README #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dch0ph wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

Update README #161

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
147a695
Update README
dch0ph Jan 24, 2026
577bda4
Update README for symbolizer properties clarification
dch0ph Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ and the next targeted release of Mapnik.

## Meaning

The structure of the file is as such:
The structure of `reference.json` is:

* `version`: the version of Mapnik targeted. Same as the containing directory.
* `style`: properties of the `Style` XML element
* `layer`: properties of the `Layer` XML element
* `symbolizers/*`: properties that apply to **all** symbolizers
* `symbolizers/symbolizer`: properties that apply to **each** type of symbolizer
* `symbolizers/`_\<symbolizer\>_: properties that are specific to a given symbolizer
* `colors`: named colors supported by Mapnik. see `include/mapnik/css_color_grammar.hpp`

### Property stability
Expand All @@ -38,6 +38,7 @@ then the `status` is `stable`. Possible values are:
- **deprecated:** `property` should not be used and will be removed in upcoming major version of Mapnik
- **experimental:** `property` should not be used and may change, be re-named, or disappear at any time

`datasources.json` separately details the properties of the possible data sources (since version 2.3.0).

## Using

Expand Down Expand Up @@ -82,5 +83,5 @@ Tests require python and node.js:

## Users

* [carto.js](https://github.com/mapbox/carto)
* Mapnik itself (the util/validate-mapnik-instance.py is used to check binding consistency like in [#1427](https://github.com/mapnik/mapnik/issues/1427))
* [carto.js](https://github.com/cartocss/carto)
* Mapnik itself (the utility [mapnik-reference-validate.py](https://gist.github.com/springmeyer/3410845) can be used to check binding consistency like in [#1427](https://github.com/mapnik/mapnik/issues/1427))