[mapserver-commits] r8176 - in trunk/docs: cgi howto

[svn at osgeo.org]

Author: hobu
Date: 2008-12-02 23:40:06 -0500 (Tue, 02 Dec 2008)
New Revision: 8176

Added:
   trunk/docs/cgi/runsub.txt
Removed:
   trunk/docs/howto/runsub.txt
Modified:
   trunk/docs/cgi/index.txt
Log:
move to cgi section

Modified: trunk/docs/cgi/index.txt
===================================================================
--- trunk/docs/cgi/index.txt	2008-12-03 04:39:24 UTC (rev 8175)
+++ trunk/docs/cgi/index.txt	2008-12-03 04:40:06 UTC (rev 8176)
@@ -18,6 +18,7 @@
    mapserv
    mapcontext
    controls
+   runsub
    
    
 

Copied: trunk/docs/cgi/runsub.txt (from rev 8175, trunk/docs/howto/runsub.txt)
===================================================================
--- trunk/docs/cgi/runsub.txt	                        (rev 0)
+++ trunk/docs/cgi/runsub.txt	2008-12-03 04:40:06 UTC (rev 8176)
@@ -0,0 +1,70 @@
+.. _runsub:
+
+*****************************************************************************
+ Run-time Substitution
+*****************************************************************************
+
+:Author:        Steve Lime
+:Contact:       steve.lime at DNR.STATE.MN.US
+:Revision: $Revision$
+:Date: $Date$
+:Last Updated: 2005/12/12
+
+.. contents:: Table of Contents
+    :depth: 2
+    :backlinks: top
+
+
+Introduction
+-----------------------------------------------------------------------------
+
+Run-time substitution for the MapServer CGI has been around since version 4.0
+and it's use has continued to expand. In short, it allows you to alter
+portions of a mapfile based on data passed via a CGI request. This
+functionality is only available via the standard CGI application. Within
+MapScript this is easy to do since the developer has complete control over how
+input is handled.
+
+Basic Example
+-----------------------------------------------------------------------------
+
+Let's say you'd like the user to dynamically set a
+portion of an expression so they could highlight a certain land cover class,
+and you have a form element (called ctype) that allows them to choose between:
+forest, water, wetland and developed. You could then set up a layer like so:
+
+::
+
+    LAYER 
+        NAME 'covertypes' 
+        ... 
+        CLASSITEM 'type' 
+        CLASS # highlighted presentation 
+            EXPRESSION '%ctype%' 
+            ... 
+        END 
+        CLASS # default presentation 
+            ... 
+        END
+    END
+
+When a request is processed the value for ctype is substituted for the
+string %ctype% and the mapfile is processed as normal. If no ctype is passed
+in the EXPRESSION will never be true so it doesn't really hurt anything except
+for a slight performance hit. Often you would set a default class to draw
+features that don't match, but that is not required. 
+
+Parameters Supported
+-----------------------------------------------------------------------------
+
+Not every mapfile parameter supports run-time substitution and care has
+been taken to try and support those that make the most sense. Remember, you
+also can do run-time configuration using the map_object_property type syntax
+detailed elsewhere (todo- add link). Below is a list of properties that do
+allow run-time substitution (todo- add MapServer version): 
+
+* LAYER: DATA (must validate against DATAPATTERN)
+* LAYER: TILEINDEX 
+* LAYER: CONNECTION
+* LAYER: FILTER
+* CLASS EXPRESSION

Deleted: trunk/docs/howto/runsub.txt
===================================================================
--- trunk/docs/howto/runsub.txt	2008-12-03 04:39:24 UTC (rev 8175)
+++ trunk/docs/howto/runsub.txt	2008-12-03 04:40:06 UTC (rev 8176)
@@ -1,70 +0,0 @@
-.. _runsub:
-
-*****************************************************************************
- Run-time Substitution
-*****************************************************************************
-
-:Author:        Steve Lime
-:Contact:       steve.lime at DNR.STATE.MN.US
-:Revision: $Revision$
-:Date: $Date$
-:Last Updated: 2005/12/12
-
-.. contents:: Table of Contents
-    :depth: 2
-    :backlinks: top
-
-
-Introduction
------------------------------------------------------------------------------
-
-Run-time substitution for the MapServer CGI has been around since version 4.0
-and it's use has continued to expand. In short, it allows you to alter
-portions of a mapfile based on data passed via a CGI request. This
-functionality is only available via the standard CGI application. Within
-MapScript this is easy to do since the developer has complete control over how
-input is handled.
-
-Basic Example
------------------------------------------------------------------------------
-
-Let's say you'd like the user to dynamically set a
-portion of an expression so they could highlight a certain land cover class,
-and you have a form element (called ctype) that allows them to choose between:
-forest, water, wetland and developed. You could then set up a layer like so:
-
-::
-
-    LAYER 
-        NAME 'covertypes' 
-        ... 
-        CLASSITEM 'type' 
-        CLASS # highlighted presentation 
-            EXPRESSION '%ctype%' 
-            ... 
-        END 
-        CLASS # default presentation 
-            ... 
-        END
-    END
-
-When a request is processed the value for ctype is substituted for the
-string %ctype% and the mapfile is processed as normal. If no ctype is passed
-in the EXPRESSION will never be true so it doesn't really hurt anything except
-for a slight performance hit. Often you would set a default class to draw
-features that don't match, but that is not required. 
-
-Parameters Supported
------------------------------------------------------------------------------
-
-Not every mapfile parameter supports run-time substitution and care has
-been taken to try and support those that make the most sense. Remember, you
-also can do run-time configuration using the map_object_property type syntax
-detailed elsewhere (todo- add link). Below is a list of properties that do
-allow run-time substitution (todo- add MapServer version): 
-
-* LAYER: DATA (must validate against DATAPATTERN)
-* LAYER: TILEINDEX 
-* LAYER: CONNECTION
-* LAYER: FILTER
-* CLASS EXPRESSION