Skip to content

Commit 1d292ff

Browse files
authored
Merge pull request #161 from dch0ph/dch0ph-update-readme
Update README
2 parents 6b86212 + 33f0ff4 commit 1d292ff

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44

55
It is useful for building parsers, tests, compilers, and syntax highlighting/checking for languages.
66

7-
[![Build Status](https://travis-ci.org/mapnik/mapnik-reference.svg)](https://travis-ci.org/mapnik/mapnik-reference)
8-
9-
Default branch is `gh-pages` which is displayed at http://mapnik.org/mapnik-reference
7+
Default branch is `gh-pages`, which is displayed at http://mapnik.org/mapnik-reference
108

119
## Versioning
1210

@@ -20,13 +18,13 @@ and the next targeted release of Mapnik.
2018

2119
## Meaning
2220

23-
The structure of the file is as such:
21+
The structure of `reference.json` is:
2422

2523
* `version`: the version of Mapnik targeted. Same as the containing directory.
2624
* `style`: properties of the `Style` XML element
2725
* `layer`: properties of the `Layer` XML element
28-
* `symbolizers/*`: properties that apply to **all** symbolizers
29-
* `symbolizers/symbolizer`: properties that apply to **each** type of symbolizer
26+
* `symbolizers`: properties that apply to all symbolizers (removed from version 2.1.0 onwards)
27+
* `symbolizers/`_\<symbolizer\>_: properties that are specific to a given symbolizer
3028
* `colors`: named colors supported by Mapnik. see `include/mapnik/css_color_grammar.hpp`
3129

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

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

4241
## Using
4342

@@ -82,5 +81,5 @@ Tests require python and node.js:
8281

8382
## Users
8483

85-
* [carto.js](https://github.com/mapbox/carto)
86-
* Mapnik itself (the util/validate-mapnik-instance.py is used to check binding consistency like in [#1427](https://github.com/mapnik/mapnik/issues/1427))
84+
* [carto.js](https://github.com/cartocss/carto)
85+
* [Mapnik documentation](http://mapnik.org/mapnik-reference)

0 commit comments

Comments
 (0)