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

[svn at osgeo.org]

Author: hobu
Date: 2008-12-02 23:39:24 -0500 (Tue, 02 Dec 2008)
New Revision: 8175

Modified:
   trunk/docs/cgi/mapcontext.txt
   trunk/docs/howto/building-mapserver-its-main-dependencies-from-scratches-under-linux.txt
   trunk/docs/howto/runsub.txt
Log:
convert to ReST

Modified: trunk/docs/cgi/mapcontext.txt
===================================================================
--- trunk/docs/cgi/mapcontext.txt	2008-12-03 04:28:38 UTC (rev 8174)
+++ trunk/docs/cgi/mapcontext.txt	2008-12-03 04:39:24 UTC (rev 8175)
@@ -10,9 +10,12 @@
     http://localhost/mapserver.cgi?MODE=map&MAP=/path/to/mapfile.map&CONTEXT=
                          /path/to/contextfile.xml&LAYERS=layer_name1 layers_name2 
    
-*Note* All layers created from a context file have their status set to ON. To be 
-able to display layers, the user needs to add the LAYERS argument in the URL.
+.. note::
 
+    All layers created from a context file have their status set to ON. To be
+    able to display layers, the user needs to add the LAYERS argument in the
+    URL.
+
 Support for Context Files Accessed Through a URL
 ------------------------------------------------
 

Modified: trunk/docs/howto/building-mapserver-its-main-dependencies-from-scratches-under-linux.txt
===================================================================
--- trunk/docs/howto/building-mapserver-its-main-dependencies-from-scratches-under-linux.txt	2008-12-03 04:28:38 UTC (rev 8174)
+++ trunk/docs/howto/building-mapserver-its-main-dependencies-from-scratches-under-linux.txt	2008-12-03 04:39:24 UTC (rev 8175)
@@ -54,7 +54,8 @@
 Configuration
 =============
 
-After copying the script on the disk and making it executable, you should open it with an editor and change some configuration variables.
+After copying the script on the disk and making it executable, you should open
+it with an editor and change some configuration variables.
 
 More detailed instructions are in the script comments.
 

Modified: trunk/docs/howto/runsub.txt
===================================================================
--- trunk/docs/howto/runsub.txt	2008-12-03 04:28:38 UTC (rev 8174)
+++ trunk/docs/howto/runsub.txt	2008-12-03 04:39:24 UTC (rev 8175)
@@ -1,42 +1,70 @@
-<h2>Introduction</h2>
-<p>
-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.
-</p>
+.. _runsub:
 
-<h2>Basic Example</h2>
-<p>
-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:
-</p>
+*****************************************************************************
+ Run-time Substitution
+*****************************************************************************
 
-<pre>
-LAYER
-  NAME 'covertypes'
-  ...
-  CLASSITEM 'type'
-  CLASS # highlighted presentation
-    EXPRESSION '%ctype%'
-    ...
-  END
-  CLASS # default presentation
-    ...
-  END
-END
-</pre>
+:Author:        Steve Lime
+:Contact:       steve.lime at DNR.STATE.MN.US
+:Revision: $Revision$
+:Date: $Date$
+:Last Updated: 2005/12/12
 
-<p>
-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 fot a slight performance hit. Often you would set a default class to draw features that don't match, but that is not required.
-</p>
+.. contents:: Table of Contents
+    :depth: 2
+    :backlinks: top
 
-<h2>Parameters Supported</h2>
 
-<p>
-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):
-</p>
+Introduction
+-----------------------------------------------------------------------------
 
-<p><ul>
-<li> LAYER: DATA (must validate against DATAPATTERN)
-<li> LAYER: TILEINDEX
-<li> LAYER: CONNECTION
-<li> LAYER: FILTER
-<li> CLASS EXPRESSION
-</ul></p>
\ No newline at end of file
+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