Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README.md

  • Loading branch information...
commit 8f66f8a4c9dd49c2d803919574207010dc7b3c52 1 parent 38722ba
Dane Springmeyer springmeyer authored
Showing with 7 additions and 6 deletions.
  1. +7 −6 README.md
13 README.md
View
@@ -1,8 +1,8 @@
# mapnik-reference
-`mapnik-reference` is a parse-able spec of what Mapnik can do - what symbolizers
-it supports and the properties they can contain. It's useful for building
-parsers, tests, compilers, and syntax highlighting/checking for languages.
+`mapnik-reference` is a parse-able spec of what Mapnik can do - what main structures
+it supports (like layers, styles, and symbolizers) and the properties they can contain.
+It's useful for building parsers, tests, compilers, and syntax highlighting/checking for languages.
## Versioning
@@ -21,7 +21,6 @@ The structure of the file is as such:
* `version`: the version of Mapnik targeted. Same as the containing directory.
* `style`: properties of the `Style` XML element
-* `font-set`: properties of the `FontSet` 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
@@ -29,7 +28,7 @@ The structure of the file is as such:
## Using
-This is a valid [npm](http://npmjs.org/) module and thus is pretty easy to use from
+This is a valid [npm](http://npmjs.org/) module and therefore can easily be used with
[node.js](http://nodejs.org/).
npm install mapnik-reference
@@ -43,7 +42,8 @@ var data = mapnik_reference.version['2.1.0'];
```
Other implementations will want to simply copy the [JSON](http://www.json.org/) file
-from the desired implementation, like `2.0.1/reference.json`.
+from the desired implementation, like `2.0.1/reference.json`. For python we could consider
+uploading to pypi if there is interest.
The file can then be parsed with any of the many [json parsers](http://www.json.org/).
@@ -56,3 +56,4 @@ Tests require python:
## 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))
Please sign in to comment.
Something went wrong with that request. Please try again.