[mapserver-commits] r11453 - trunk/docs/en/mapfile

[svn at osgeo.org]

Author: havatv
Date: 2011-04-04 09:17:12 -0700 (Mon, 04 Apr 2011)
New Revision: 11453

Modified:
   trunk/docs/en/mapfile/label.txt
Log:
Added STYLE, marked the no longer supported elements as deprecated.

Modified: trunk/docs/en/mapfile/label.txt
===================================================================
--- trunk/docs/en/mapfile/label.txt	2011-04-04 13:25:43 UTC (rev 11452)
+++ trunk/docs/en/mapfile/label.txt	2011-04-04 16:17:12 UTC (rev 11453)
@@ -47,13 +47,19 @@
 BACKGROUNDCOLOR [r] [g] [b]
     Color to draw a background rectangle (i.e. billboard). Off by default.
 
+    .. deprecated:: 6.0  Use STYLE object and `GEOMTRANSFORM labelpoly`.
+
 BACKGROUNDSHADOWCOLOR [r] [g] [b]
     Color to draw a background rectangle (i.e. billboard) shadow. Off by 
     default.
 
+    .. deprecated:: 6.0  Use STYLE object and `GEOMTRANSFORM labelpoly`.
+
 BACKGROUNDSHADOWSIZE [x][y]
     How far should the background rectangle be offset? Default is 1.
 
+    .. deprecated:: 6.0  Use STYLE object and `GEOMTRANSFORM labelpoly`.
+
 BUFFER [integer]
     Padding, in pixels, around labels. Useful for maintaining spacing around 
     text to enhance readability. Available only for cached labels. 
@@ -101,6 +107,7 @@
 
 .. _MAXLENGTH:
 
+
 MAXLENGTH [integer]
     Introduced in mapserver 5.4, this keyword interacts with the WRAP_
     keyword so that line breaks only occur after the defined number of
@@ -143,8 +150,8 @@
 .. _OUTLINECOLOR:
 
 OUTLINECOLOR [r] [g] [b] | [attribute]
-    - Color to draw a one pixel outline around the text.
-    - [*Attribute*] was introduced in version 5.0, to specify the item name in
+    - Color to draw a one pixel outline around the characters in the text.
+    - [*attribute*] was introduced in version 5.0, to specify the item name in
       the attribute table to use for color values.  The hard brackets [] are
       required.  For example, if your shapefile's DBF has a field named 
       "MYOUTCOLOR" that holds color values for each record, your LABEL object
@@ -209,9 +216,13 @@
 SHADOWCOLOR [r] [g] [b]
     Color of drop shadow.
 
+    .. deprecated:: 6.0  Use STYLE object and `GEOMTRANSFORM labelpoly`.
+
 SHADOWSIZE [x][y]
     Shadow offset in pixels.
 
+    .. deprecated:: 6.0  Use STYLE object and `GEOMTRANSFORM labelpoly`.
+
 SIZE [double]|[tiny|small|medium|large|giant]|[attribute]
     - Text size. Use "integer" to give the size in pixels of your TrueType font 
       based label, or any of the other 5 listed keywords to bitmap fonts.
@@ -236,6 +247,27 @@
 
       The associated RFC document for this feature is :ref:`RFC19`.
 
+:ref:`STYLE`
+    The start of a `STYLE` object.
+
+    Label specific mechanisms of the STYLE object are the
+    GEOMTRANSFORM options:
+
+    GEOMTRANSFORM [labelpnt|labelpoly]
+      Creates geometries that can be used for styling the label.
+
+      - labelpnt generates a point with its center at the middle of
+        the bounding rectangle of the text.
+
+      - labelpoly generates the bounding rectangle for the text, with
+        1 pixel of padding added in all directions.
+
+      The resulting geometries can be styled using the mechanisms
+      available in the `STYLE` object.
+
+    .. versionadded:: 6.0
+
+
 TYPE [bitmap|truetype]
     Type of font to use. Generally bitmap fonts are faster to draw then 
     TrueType fonts. However, TrueType fonts are scalable and available in a