[mapserver-commits] r8712 - trunk/docs/tutorial

svn at osgeo.org svn at osgeo.org
Mon Mar 9 14:08:29 EDT 2009 

Author: pnaciona
Date: 2009-03-09 14:08:29 -0400 (Mon, 09 Mar 2009)
New Revision: 8712

Modified:
   trunk/docs/tutorial/example1-1.txt
Log:
update tutorial example 1.1

Modified: trunk/docs/tutorial/example1-1.txt
===================================================================
--- trunk/docs/tutorial/example1-1.txt	2009-03-09 18:02:08 UTC (rev 8711)
+++ trunk/docs/tutorial/example1-1.txt	2009-03-09 18:08:29 UTC (rev 8712)
@@ -21,11 +21,11 @@
 
 This is what the mapfile looks like: :ref:`Example1-1.map <example1-1-map>`.
 
-The `mapfile <http://mapserver.gis.umn.edu/doc/mapfile-reference.html>`_ is MapServer's basic configuration mechanism. It is made up of "objects" and each object can have keywords or other objects. It has a hierarchical structure such that some objects fall under other objects... on top of this hierarchy is the MAP object, all other objects belong to it. This example shows a very straightforward heirarchy of objects.  As you go through each example, the complexity of these hierarchical trees will increase.
+The :ref:`MAPFILE <mapfile>` is MapServer's basic configuration mechanism. It is made up of "objects" and each object can have keywords or other objects. It has a hierarchical structure such that some objects fall under other objects... on top of this hierarchy is the MAP object, all other objects belong to it. This example shows a very straightforward heirarchy of objects.  As you go through each example, the complexity of these hierarchical trees will increase.
 
 A few quick notes about mapfiles: we define each object in the mapfile with the object name and we close it with "END" and we precede comments with a pound (#) sign.
 
-Let's break &quot;example1-1.map&quot; down by objects. Its structure looks like this:
+Let's break "example1-1.map" down by objects. Its structure looks like this:
 
 ::
 
@@ -38,7 +38,8 @@
 Let's look at the keywords (parameters) within the MAP object:
 
 **MAP**
-       Every mapfile starts with the MAP object--the entire mapfile is the MAP object.
+       Every mapfile starts with the :ref:`MAP <map>` object--the entire 
+       mapfile is the MAP object.
 
 **IMAGETYPE**
              The keyword IMAGETYPE is used to define which image format the
@@ -65,7 +66,7 @@
 
 In this example our data is in geographic projection so the units are in decimal 
 degrees.  You can use the utility 
-`ogrinfo <http://gdal.osgeo.org/ogr/ogr_utilities.html>`_,
+`ogrinfo <http://gdal.osgeo.org/ogr_utilities.html>`_,
 which is part of the GDAL/OGR library package, to get the extent of a particular
 shapefile (or other supported vector formats).  Here is the command I used to 
 get the extent for this example:
@@ -117,10 +118,10 @@
 Now let's look at the LAYER object parameters:
 
 **LAYER**
-        Marks the beginning of a LAYER within the MAP object. You can specify 
-        as many layers as you'd like although you are limited to 100, by 
-        default. To change this limit, you will have to edit the map.h header
-        file (in the soure tree) and recompile MapServer.
+        Marks the beginning of a :ref:`LAYER <layer>` within the MAP object.
+        You can specify as many layers as you'd like although you are limited
+        to 100, by default. To change this limit, you will have to edit the 
+        map.h header file (in the soure tree) and recompile MapServer.
 
 **NAME**
         This is the layer identifier.  MapServer uses this name to toggle the 
@@ -129,17 +130,16 @@
 
 **DATA**
         The name of the data (shapefile in this case). MapServer supports 
-        vector data formats other than ESRI's shapefile through the use of OGR 
-        library (part of the GDAL software package). Please visit the GDAL 
-        project web site at `<http://www.gdal.org/>`_ and
-        read `<http://www.gdal.org/ogr/index.html>`_
+        vector data formats other than ESRI's shapefile through the use of OGR
+        library (part of the GDAL software package). Please visit the GDAL
+        project web site at `<http://gdal.osgeo.org/>`_ and
+        read `<http://gdal.osgeo.org/ogr/>`_
         to know more about the different vector formats MapServer supports.  
-        In addition, Jeff McKenna and Tyler Mitchell have written a detailed 
-        guide to using vector data in MapServer.  You can download this guide 
-        (PDF) from `<http://dl.maptools.org/dl/docs/mapserv/>`_.
+        In addition, Jeff McKenna and Tyler Mitchell have written a detailed
+        :ref:`guide to using vector data for MapServer <vector>`.
 
 **TYPE**
-        What type of data is it? If it's a vector data, you can specify whether 
+        What type of data is it? If it's a vector data, you can specify whether
         it is a POLYGON, LINE (you use LINE even if your data is technically a 
         POLYLINE), or a POINT. You can also specify RASTER or ANNOTATION data. 
         Here we want to display POLYGON.
@@ -151,9 +151,10 @@
 Let's look at the CLASS object parameters:
 
 **CLASS**
-        Marks the beginning of a CLASS object within the LAYER object. You can 
-        specify as many classes within a layer although you are limited to 50 
-        by default. You'll have to recompile MapServer to change this default value.
+        Marks the beginning of a :ref:`CLASS <class>` object within the LAYER
+        object. You can specify as many classes within a layer although you are
+        limited to 50 by default. You'll have to recompile MapServer to change 
+        this default value.
 
 **NAME**
         The descriptive identifier for this CLASS. LAYER objects can have 
@@ -165,9 +166,9 @@
 And finally, let's look at the STYLE object parameters:
 
 **STYLE**
-        Marks the beginning of the STYLE object.  You can define multiple 
-        styles within a class--this is useful when you want to overlay a style 
-        over another.
+        Marks the beginning of the :ref:`STYLE <style>` object.  You can
+        define multiple styles within a class--this is useful when you want to 
+        overlay a style over another.
 
 **COLOR**
         This is the fill color of the polygon. In case the TYPE is LINE, this
@@ -178,6 +179,4 @@
         MapServer doesn't draw polygon outlines by default, so if you want to
         see polygon boundaries, you will want to define an OUTLINECOLOR.
 
-This ends the first example in this tutorial. You are encouraged to change the values of the keywords in the mapfile. It will help you understand what these keywords do.
-
-example1-2
\ No newline at end of file
+This ends the first example in this tutorial. You are encouraged to change the values of the keywords in the mapfile. It will help you understand what these keywords do.
\ No newline at end of file

More information about the mapserver-commits mailing list