[mapserver-commits] r11875 - branches/branch-6-0/docs/en/mapfile trunk/docs/en/mapfile

[svn at osgeo.org]

Author: havatv
Date: 2011-07-07 02:10:54 -0700 (Thu, 07 Jul 2011)
New Revision: 11875

Modified:
   branches/branch-6-0/docs/en/mapfile/symbol.txt
   trunk/docs/en/mapfile/symbol.txt
Log:
Added cross reference to SYMBOLSET in the symbol documentation (#3350).  Also did some small style fixes.

Modified: branches/branch-6-0/docs/en/mapfile/symbol.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/symbol.txt	2011-07-07 08:50:36 UTC (rev 11874)
+++ branches/branch-6-0/docs/en/mapfile/symbol.txt	2011-07-07 09:10:54 UTC (rev 11875)
@@ -6,9 +6,10 @@
 
 - Symbol definitions can be included within the main map file or, more
   commonly, in a separate file. Symbol definitions in a separate file
-  are designated using the SYMBOLSET keyword, as part of the
-  :ref:`MAP object <map>`.  This recommended setup is ideal for
-  re-using symbol definitions across multiple MapServer applications.
+  are designated using the :ref:`SYMBOLSET <SYMBOLSET>` keyword, as
+  part of the :ref:`MAP object <map>`.  This recommended setup is
+  ideal for re-using symbol definitions across multiple MapServer
+  applications.
 - There are 3 main types of symbols in MapServer: Markers, 
   Lines and Shadesets.
 - Symbol 0 is always the degenerate case for a particular class of 
@@ -40,9 +41,9 @@
     to font character.
 
 FILLED [true|false]
-    Sets the symbol to be filled with a user defined color (See the 
-    :ref:`STYLE` object). For marker symbols, if OUTLINECOLOR was specified 
-    then the symbol is outlined with it.
+    Sets the symbol to be filled with a user defined color (See the
+    :ref:`STYLE` object). For marker symbols, if `OUTLINECOLOR` was
+    specified then the symbol is outlined with it.
 
 FONT [string]
     Name of TrueType font to use as defined in the :ref:`FONTSET`.
@@ -54,7 +55,8 @@
     .. deprecated:: 6.0
 
 IMAGE [string]
-    Image (GIF or PNG) to use as a marker or brush for type PIXMAP symbols.
+    Image (GIF or PNG) to use as a marker or brush for type `pixmap`
+    symbols.
 
 NAME [string]
     Alias for the symbol.  To be used in :ref:`CLASS` :ref:`STYLE`
@@ -107,7 +109,7 @@
       size for this symbol will be assumed to be 5.
 
 STYLE [num on] [num off] [num on] ... END
-    Renamed to PATTERN in MapServer 5.0.
+    Renamed to `PATTERN` in MapServer 5.0.
     
     .. deprecated:: 5.0
 
@@ -120,6 +122,11 @@
     the same as the parent image (i.e.  color 0). This is user
     configurable.
 
+    .. note::
+
+      The default (AGG) renderer does not support the `TRANSPARENT`
+      parameter. It is supported by the GD renderer (GIF).
+
 TYPE [ellipse|hatch|pixmap|simple|truetype|vector]
     -  `ellipse`: radius values in the x and y directions define an ellipse.
     -  `hatch`: produces hatched lines throughout the (polygon) shape.

Modified: trunk/docs/en/mapfile/symbol.txt
===================================================================
--- trunk/docs/en/mapfile/symbol.txt	2011-07-07 08:50:36 UTC (rev 11874)
+++ trunk/docs/en/mapfile/symbol.txt	2011-07-07 09:10:54 UTC (rev 11875)
@@ -6,9 +6,10 @@
 
 - Symbol definitions can be included within the main map file or, more
   commonly, in a separate file. Symbol definitions in a separate file
-  are designated using the SYMBOLSET keyword, as part of the
-  :ref:`MAP object <map>`.  This recommended setup is ideal for
-  re-using symbol definitions across multiple MapServer applications.
+  are designated using the :ref:`SYMBOLSET <SYMBOLSET>` keyword, as
+  part of the :ref:`MAP object <map>`.  This recommended setup is
+  ideal for re-using symbol definitions across multiple MapServer
+  applications.
 - There are 3 main types of symbols in MapServer: Markers, 
   Lines and Shadesets.
 - Symbol 0 is always the degenerate case for a particular class of 
@@ -40,9 +41,9 @@
     to font character.
 
 FILLED [true|false]
-    Sets the symbol to be filled with a user defined color (See the 
-    :ref:`STYLE` object). For marker symbols, if OUTLINECOLOR was specified 
-    then the symbol is outlined with it.
+    Sets the symbol to be filled with a user defined color (See the
+    :ref:`STYLE` object). For marker symbols, if `OUTLINECOLOR` was
+    specified then the symbol is outlined with it.
 
 FONT [string]
     Name of TrueType font to use as defined in the :ref:`FONTSET`.
@@ -54,7 +55,8 @@
     .. deprecated:: 6.0
 
 IMAGE [string]
-    Image (GIF or PNG) to use as a marker or brush for type PIXMAP symbols.
+    Image (GIF or PNG) to use as a marker or brush for type `pixmap`
+    symbols.
 
 NAME [string]
     Alias for the symbol.  To be used in :ref:`CLASS` :ref:`STYLE`
@@ -107,7 +109,7 @@
       size for this symbol will be assumed to be 5.
 
 STYLE [num on] [num off] [num on] ... END
-    Renamed to PATTERN in MapServer 5.0.
+    Renamed to `PATTERN` in MapServer 5.0.
     
     .. deprecated:: 5.0
 
@@ -120,6 +122,11 @@
     the same as the parent image (i.e.  color 0). This is user
     configurable.
 
+    .. note::
+
+      The default (AGG) renderer does not support the `TRANSPARENT`
+      parameter. It is supported by the GD renderer (GIF).
+
 TYPE [ellipse|hatch|pixmap|simple|truetype|vector]
     -  `ellipse`: radius values in the x and y directions define an ellipse.
     -  `hatch`: produces hatched lines throughout the (polygon) shape.