Prepare for 8.0.0 release:

- completed CHANGELOG - documented `status` key in README - added `status` key where needed in 3.0.0/reference cf #101
mapnik · Jun 10, 2015 · 9ddca92 · 9ddca92
1 parent 3aba9e5
commit 9ddca92
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 5 deletions.
diff --git a/3.0.0/reference.json b/3.0.0/reference.json
@@ -678,7 +678,8 @@
                 "expression":true,
                 "default-value": 0,
                 "default-meaning": "Will not be offset.",
-                "doc": "Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line)."
+                "doc": "Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line).",
+                "status": "unstable"
             },
             "rasterizer": {
                 "css": "line-rasterizer",
@@ -838,7 +839,8 @@
                 "expression":true,
                 "default-value": "ellipse",
                 "default-meaning": "The marker shape is an ellipse.",
-                "doc": "The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width)."
+                "doc": "The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width).",
+                "status": "deprecated"
             },
             "width": {
                 "css": "marker-width",
@@ -2060,7 +2062,8 @@
                 "expression": true,
                 "default-value": false,
                 "default-meaning": "Character will be removed when used to wrap a line.",
-                "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line."
+                "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line.",
+                "status": "unstable"
             },
             "spacing": {
                 "css": "text-spacing",
@@ -2230,7 +2233,8 @@
                 "type": "float",
                 "expression":true,
                 "default-meaning": "Labels with the same text will be rendered without restriction.",
-                "doc": "Minimum distance to the next label with the same text. Only works for line placement."
+                "doc": "Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin`",
+                "status": "deprecated"
             },
             "minimum-padding": {
                 "css": "text-min-padding",
@@ -2469,7 +2473,8 @@
                 "expression": true,
                 "default-value": true,
                 "default-meaning": "Only geometry with largest bbox is labeled.",
-                "doc": "Controls default labeling behavior on multigeometries. The default is true and means that only the geometry with largest bbox is labeled."
+                "doc": "Controls default labeling behavior on multigeometries. The default is true and means that only the geometry with largest bbox is labeled.",
+                "status": "experimental"
             }
         },
         "building": {

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@
 
 * Added `miter-revert` to `stroke-linejoin`
 * Renamed `left-only` and `right-only` of `text-upright` to use hyphens rather than underscores (https://github.com/mapnik/mapnik/pull/2682)
+* Added `repeat-wrap-character` (unstable, https://github.com/mapnik/mapnik/issues/2333)
+* Added `largest-bbox-only` (experimental)
+* Added `rotate-displacement`
+* Added `status` key to symbolizer property scheme (https://github.com/mapnik/mapnik-reference/issues/101)
 
 ### 7.0.1
 

diff --git a/README.md b/README.md
@@ -24,6 +24,16 @@ The structure of the file is as such:
 * `symbolizers/symbolizer`: properties that apply to **each** type of symbolizer
 * `colors`: named colors supported by Mapnik. see `include/mapnik/css_color_grammar.hpp`
 
+### Property stability
+The `status` key be used to define the stability of a property. By default, the `status`
+if `stable`. Possible values are:
+
+- **stable:** `property` is here to stay and its behavior is not anticipated to change
+- **unstable:** `property` is here to stay but its behavior/meaning of `property` may change
+- **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
+
+
 ## Using
 
 This is a valid [npm](http://npmjs.org/) module and therefore can easily be used with