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

[svn at osgeo.org]

Author: tbonfort
Date: 2009-06-21 14:47:46 -0400 (Sun, 21 Jun 2009)
New Revision: 9115

Modified:
   trunk/docs/en/mapfile/style.txt
   trunk/docs/en/mapfile/symbol.txt
Log:
document the move of gap, pattern, caps and joins from symbolObj to styleObj


Modified: trunk/docs/en/mapfile/style.txt
===================================================================
--- trunk/docs/en/mapfile/style.txt	2009-06-21 18:20:48 UTC (rev 9114)
+++ trunk/docs/en/mapfile/style.txt	2009-06-21 18:47:46 UTC (rev 9115)
@@ -70,6 +70,17 @@
 
       The associated RFC document for this feature is :ref:`RFC19`.
 
+GAP [int]
+    Given in pixels. This defines a distance between symbols for 
+    TrueType lines.  As of MapServer 5.0 this also applies to PixMap symbols.
+
+    When drawing the symbol along a line segment, a negative GAP will will add 
+    180 degress to the angle. The TrueType and PixMap symbols are always oriented 
+    along the line.  A GAP of 0 (the default value) will cause MapServer to use
+    the symbol as a brush to draw the line.
+    
+    .. versionadded:: 6.0 moved from :ref:`SYMBOL`
+
 GEOMTRANSFORM [start|end|vertices|bbox|centroid]
     
     - Used to indicate that the current feature will be transformed before the actual
@@ -84,6 +95,25 @@
       vertices of the underlying geometry. When used with ANGLE AUTO, the marker is
       oriented by the half angle formed by the two adjacent line segments.
 
+LINECAP [butt|round|square|triangle]
+    Sets the line cap type for the cartoline symbol. Default is butt. Works 
+    with the CARTOLINE symbol only!
+    
+    .. versionadded:: 6.0 moved from :ref:`SYMBOL`
+
+LINEJOIN [round|miter|bevel]
+    Sets the line join type for the cartoline symbol. Default is "none" - 
+    lines will not be joined . Works with the CARTOLINE symbol only!
+    
+    .. versionadded:: 6.0 moved from :ref:`SYMBOL`
+
+LINEJOINMAXSIZE [int]
+    Sets the max length of the miter line join type. The value represents a 
+    coefficient which multiplies a current symbol size. Default is 3. 
+    Works with the CARTOLINE symbol only!
+    
+    .. versionadded:: 6.0 moved from :ref:`SYMBOL`
+
 MAXSIZE [integer]
     Maximum size in pixels to draw a symbol. Default is 50.
 
@@ -119,6 +149,12 @@
 
       The associated RFC document for this feature is :ref:`RFC19`.
 
+PATTERN [num on] [num off] [num on] ... END
+    
+    Defines a dash style or pattern for line symbologies.
+    
+    .. versionadded:: 6.0 moved from :ref:`SYMBOL`
+
 SIZE [integer|attribute]
 
     - Height, in layer SIZEUNITS, of the symbol/pattern to be used. Only useful with 

Modified: trunk/docs/en/mapfile/symbol.txt
===================================================================
--- trunk/docs/en/mapfile/symbol.txt	2009-06-21 18:20:48 UTC (rev 9114)
+++ trunk/docs/en/mapfile/symbol.txt	2009-06-21 18:47:46 UTC (rev 9115)
@@ -43,7 +43,13 @@
 FONT [string]
     Name of TrueType font to use as defined in the :ref:`FONTSET`.
 
+
 GAP [int]
+    .. deprecated:: 6.0
+
+    This keyword has been deprecated in version 6.0. It has been replaced by the
+    same keyword in the :ref:`STYLE`.
+    
     Given in pixels. This defines a distance between symbols for 
     TrueType lines.  As of MapServer 5.0 this also applies to PixMap symbols.
 
@@ -51,6 +57,7 @@
     180 degress to the angle. The TrueType and PixMap symbols are always oriented 
     along the line.  A GAP of 0 (the default value) will cause MapServer to use
     the symbol as a brush to draw the line.
+    
 
 IMAGE [string]
     Image (GIF or PNG) to use as a marker or brush for type PIXMAP symbols.
@@ -59,19 +66,39 @@
     Alias for this font to be used in :ref:`CLASS` objects
 
 LINECAP [butt|round|square|triangle]
+    .. deprecated:: 6.0
+
+    This keyword has been deprecated in version 6.0. It has been replaced by the
+    same keyword in the :ref:`STYLE`.
+    
     Sets the line cap type for the cartoline symbol. Default is butt. Works 
     with the CARTOLINE symbol only!
 
 LINEJOIN [round|miter|bevel]
+    .. deprecated:: 6.0
+
+    This keyword has been deprecated in version 6.0. It has been replaced by the
+    same keyword in the :ref:`STYLE`.
+    
     Sets the line join type for the cartoline symbol. Default is "none" - 
     lines will not be joined . Works with the CARTOLINE symbol only!
 
 LINEJOINMAXSIZE [int]
+    .. deprecated:: 6.0
+
+    This keyword has been deprecated in version 6.0. It has been replaced by the
+    same keyword in the :ref:`STYLE`.
+    
     Sets the max length of the miter line join type. The value represents a 
     coefficient which multiplies a current symbol size. Default is 3. 
     Works with the CARTOLINE symbol only!
 
 PATTERN [num on] [num off] [num on] ... END
+    .. deprecated:: 6.0
+
+    This keyword has been deprecated in version 6.0. It has been replaced by the
+    same keyword in the :ref:`STYLE`.
+    
     Defines a dash style or pattern.  Implemented in MapServer 5.0,
     to replace the deprecated STYLE parameter.