[mapserver-commits] r8203 - trunk/docs/input/vector

svn at osgeo.org svn at osgeo.org
Sun Dec 7 18:17:21 EST 2008 

Author: hobu
Date: 2008-12-07 18:17:21 -0500 (Sun, 07 Dec 2008)
New Revision: 8203

Modified:
   trunk/docs/input/vector/arcsde.txt
   trunk/docs/input/vector/dgn.txt
   trunk/docs/input/vector/inline.txt
   trunk/docs/input/vector/mapinfo.txt
   trunk/docs/input/vector/ntf.txt
   trunk/docs/input/vector/ogr.txt
Log:
formatting

Modified: trunk/docs/input/vector/arcsde.txt
===================================================================
--- trunk/docs/input/vector/arcsde.txt	2008-12-07 22:43:55 UTC (rev 8202)
+++ trunk/docs/input/vector/arcsde.txt	2008-12-07 23:17:21 UTC (rev 8203)
@@ -51,12 +51,19 @@
     PROCESSING "QUERYORDER=ATTRIBUTE" # <-- MapServer 4.10 and above
 
     # Within database one-to-one join support
-    PROCESSING "JOINTABLE=SDE_MASTER.GEOSERVWRITE.JOINTABLE" # <-- MapServer 5.0 and above
-    CLASSITEM "SDE_MASTER.GEOSERVWRITE.JOINTABLE.VAL" # <-- MapServer 5.0 and above
-    FILTER "SDE_MASTER.GEOSERVWRITE.JOINTABLE.AQ_TAG=SDE_MASTER.GEOSERVWRITE.JOINTESTLAYER.AQ_TAG" #<-- MapServer 5.0 and above
+    
+    # MapServer 5.0 and above
+    PROCESSING "JOINTABLE=SDE_MASTER.GEOSERVWRITE.JOINTABLE" 
+    
+    # MapServer 5.0 and above
+    CLASSITEM "SDE_MASTER.GEOSERVWRITE.JOINTABLE.VAL" 
 
+    # MapServer 5.0 and above
+    FILTER "SDE_MASTER.GEOSERVWRITE.JOINTABLE.AQ_TAG=SDE_MASTER.GEOSERVWRITE.JOINTESTLAYER.AQ_TAG" 
+
     # ObjectID column manipulation
-    PROCESSING "OBJECTID=OBJECTID"  # <-- MapServer 5.0 and above 
+    # MapServer 5.0 and above
+    PROCESSING "OBJECTID=OBJECTID"   
  
     TEMPLATE '/where/the/template/file/is/located'
     CLASS
@@ -72,42 +79,45 @@
 CONNECTION - Order is important!
 ...............................................................................
 
-* **sdemachine.iastate.edu** - The name of the machine you are connecting to.  
-  In some instances, this may need to be the IP address of the machine rather 
-  than the name if the server running MapServer is not configured to cascade DNS lookups
-* **port:5151** - The port number of SDE.  The *port:* is important as SDE expects you 
-  to define the **service** in this slot, and it can be other names like **sde:oracle** 
-  (for direct connect) or **esri_sde** (for systems with port 5151 defined as 
-  esri_sde in /etc/services)
-* **sde** - The database username that the SDE server is using to connect to your 
-  database.  It is often only important for SDE setups that are connecting to 
-  Oracle (and even then, not so important).  Just leave it as **sde** if you don't 
-  know what it should be.
-* **username** - The username that will be connecting to SDE.  This user must have 
-  been granted rights to select the layer that you will be specifying in the *DATA* 
-  directive.  You can use ArcCatalog or the SDE command-line utilities to grant 
-  the appropriate rights to layers.
+* **sdemachine.iastate.edu** - The name of the machine you are connecting to.
+  In some instances, this may need to be the IP address of the machine rather
+  than the name if the server running MapServer is not configured to cascade
+  DNS lookups
+* **port:5151** - The port number of SDE. The *port:* is important as SDE
+  expects you to define the **service** in this slot, and it can be other
+  names like **sde:oracle** (for direct connect) or **esri_sde** (for systems
+  with port 5151 defined as esri_sde in /etc/services)
+* **sde** - The database username that the SDE server is using to connect to
+  your database. It is often only important for SDE setups that are connecting
+  to Oracle (and even then, not so important). Just leave it as **sde** if you
+  don't know what it should be.
+* **username** - The username that will be connecting to SDE. This user must
+  have been granted rights to select the layer that you will be specifying in
+  the *DATA* directive. You can use ArcCatalog or the SDE command-line
+  utilities to grant the appropriate rights to layers.
 * **password** - Password of the user connecting to SDE.  **Case Sensitive**.
 
 DATA - Order is important!
 ...............................................................................
 
-* **HOBU.STATES_LAYER** - The layer name you are querying.  This the *full* 
-  name of the table in which the layer resides.  If you are using Oracle or 
-  Microsoft SQL Server as the DB for SDE, the schema name must also be supplied.
-* **SHAPE** - The column that contains the geometry.  SDE technically allows 
-  for storage of multiple geometry types in the same layer, but in practice 
-  this isn't desirable.  Also, expect to have problems if there are invalid 
-  or null geometries in the layer (or versions of the layer).
-* **SDE.DEFAULT** - As of MapServer 4.2, you can query against a specific 
-  version of the layer.  SDE supports multi-user editing with versions.  If a 
-  layer has been Registered with the GeoDatabase and Registered as Versioned 
-  (ArcGIS terms), MapServer can query against specified versions of those edits.  
-  If not specified, *SDE.DEFAULT* will be used for all queries. **Case Sensitive**.
+* **HOBU.STATES_LAYER** - The layer name you are querying. This the *full*
+  name of the table in which the layer resides. If you are using Oracle or
+  Microsoft SQL Server as the DB for SDE, the schema name must also be
+  supplied.
+* **SHAPE** - The column that contains the geometry. SDE technically allows
+  for storage of multiple geometry types in the same layer, but in practice
+  this isn't desirable. Also, expect to have problems if there are invalid or
+  null geometries in the layer (or versions of the layer).
+* **SDE.DEFAULT** - As of MapServer 4.2, you can query against a specific
+  version of the layer. SDE supports multi-user editing with versions. If a
+  layer has been Registered with the GeoDatabase and Registered as Versioned
+  (ArcGIS terms), MapServer can query against specified versions of those
+  edits. If not specified, *SDE.DEFAULT* will be used for all queries. **Case
+  Sensitive**.
 
 .. note::
-    Note! this is located in a different spot than MapServer 4.2, which had 
-    it on the CONNECTION string. 
+    The version parameter is located in a different spot than MapServer 4.2,
+    which had it on the CONNECTION string.
 
 TEMPLATE
 ...............................................................................
@@ -136,20 +146,21 @@
 ...............................................................................
 
 
-MapServer's SDE driver, as of MapServer 5.0, allows you to join a single 
-attribute table that has no geometries to the layer that you are rendering.  This 
-feature allows you to use the data in the joined table much as you would in a 
-composite query that was made with something like PostGIS or Oracle Spatial.  
-That is, the columns in the right table of the join are available for CLASSITEM, 
-LABELITEM and so on.  The biggest constraint, however, is that **fully qualified** 
-names must be used or it most likely will not work.  The join support is 
-activated through PROCESSING options.
+MapServer's SDE driver, as of MapServer 5.0, allows you to join a single
+attribute table that has no geometries to the layer that you are rendering.
+This feature allows you to use the data in the joined table much as you would
+in a composite query that was made with something like PostGIS or Oracle
+Spatial. That is, the columns in the right table of the join are available for
+CLASSITEM, LABELITEM and so on. The biggest constraint, however, is that
+**fully qualified** names must be used or it most likely will not work. The
+join support is activated through PROCESSING options.
 
 
-* **PROCESSING "JOINTABLE=SDE_MASTER.GEOSERVWRITE.JOINTABLE"** - The JOINTABLE 
-  processing option tells the driver which table you are joining the current layer to.
-* **CLASSITEM "SDE_MASTER.GEOSERVWRITE.JOINTABLE.VAL"** - A CLASSITEM or LABELITEM 
-  for a joined table using this mechanism must be fully qualified.
+* **PROCESSING "JOINTABLE=SDE_MASTER.GEOSERVWRITE.JOINTABLE"** - The JOINTABLE
+  processing option tells the driver which table you are joining the current
+  layer to.
+* **CLASSITEM "SDE_MASTER.GEOSERVWRITE.JOINTABLE.VAL"** - A CLASSITEM or
+  LABELITEM for a joined table using this mechanism must be fully qualified.
 * **FILTER "SDE_MASTER.GEOSERVWRITE.JOINTABLE.AQ_TAG=SDE_MASTER.GEOSERVWRITE.JOINTESTLAYER.AQ_TAG"** - 
   An important part of the join is defining how the join is to be made.  
   Use a FILTER to do so.

Modified: trunk/docs/input/vector/dgn.txt
===================================================================
--- trunk/docs/input/vector/dgn.txt	2008-12-07 22:43:55 UTC (rev 8202)
+++ trunk/docs/input/vector/dgn.txt	2008-12-07 23:17:21 UTC (rev 8203)
@@ -25,13 +25,15 @@
    parameter in the map file.
 *  DGN files typically contain POINT, LINE, POLYGON and 
    ANNOTATION feature types.
-*  DGN files contain "styling" information - how to colour and present 
+*  DGN files contain "styling" information - how to color and present 
    the data.  This is used, optionally, by specifying the 
    STYLEITEM "AUTO" parameter.
 
-NOTE: DGN files typically use white as a colour for their features 
-and therefore are not visible on maps with white backgrounds.
+.. note:: 
 
+    DGN files typically use white as a color for their features and therefore
+    are not visible on maps with white backgrounds.
+
 OGRINFO Examples
 -----------------
 Using ogrinfo on a single DGN file:
@@ -44,7 +46,10 @@
 	using driver `DGN' successful.
 	1: elements
 
-Note that no geometry/feature type for the layer is identified because it can be multiple types.
+.. note::
+    
+    No geometry/feature type for the layer is identified because it can be
+    multiple types.
 
 
 

Modified: trunk/docs/input/vector/inline.txt
===================================================================
--- trunk/docs/input/vector/inline.txt	2008-12-07 22:43:55 UTC (rev 8202)
+++ trunk/docs/input/vector/inline.txt	2008-12-07 23:17:21 UTC (rev 8203)
@@ -65,7 +65,8 @@
 Lines
 ~~~~~~
 
-Lines are simply a list of points strung together, but the layer must be TYPE LINE instead of TYPE POINT.
+Lines are simply a list of points strung together, but the layer must be TYPE
+LINE instead of TYPE POINT.
 
 ::
 
@@ -96,5 +97,6 @@
 Polygons
 ~~~~~~~~~
 
-Polygons are the same as the line example, just a list of points. 
-They require the TYPE POLYGON parameter.  Polygons alsorequire the final coordinate pair to be the same as the first, making it a closed polygon.
+Polygons are the same as the line example, just a list of points. They require
+the TYPE POLYGON parameter. Polygons also require the final coordinate pair to
+be the same as the first, making it a closed polygon.

Modified: trunk/docs/input/vector/mapinfo.txt
===================================================================
--- trunk/docs/input/vector/mapinfo.txt	2008-12-07 22:43:55 UTC (rev 8202)
+++ trunk/docs/input/vector/mapinfo.txt	2008-12-07 23:17:21 UTC (rev 8203)
@@ -7,7 +7,8 @@
 File listing
 -----------------
 
-The following files are also associated with .TAB files: .DAT, .ID, .MAP.  An example is::
+The following files are also associated with .TAB files: .DAT, .ID, .MAP. An
+example is::
 
 	border.DAT 
 	border.ID 
@@ -18,6 +19,7 @@
 
 Data Access / Connection Method
 ----------------------------------
+
 TAB and MID/MIF access is available in MapServer through OGR.
 
 *  The CONNECTIONTYPE OGR parameter must be used.
@@ -30,9 +32,11 @@
 *  MapInfo files already contain styling information.  This styling 
    information can be used optionally by specifying the 
    STYLEITEM "AUTO" parameter in the LAYER object of the map file.
-	
-	If you use STYLEITEM "AUTO" you must have an empty class in the layer.
 
+   .. note::
+	    
+	    If you use STYLEITEM "AUTO" you must have an empty class in the layer.
+
 OGRINFO Examples
 ------------------
 

Modified: trunk/docs/input/vector/ntf.txt
===================================================================
--- trunk/docs/input/vector/ntf.txt	2008-12-07 22:43:55 UTC (rev 8202)
+++ trunk/docs/input/vector/ntf.txt	2008-12-07 23:17:21 UTC (rev 8203)
@@ -4,7 +4,8 @@
  NTF
 *****************************************************************************
 
-NTF files are mostly used by the United Kingdom Ordnance Survey (OS).  For more on the Ordnance Survey, see their website at: http://www.ordnancesurvey.co.uk
+NTF files are mostly used by the United Kingdom Ordnance Survey (OS). For more
+on the Ordnance Survey, see their website at: http://www.ordnancesurvey.co.uk
 
 File listing
 -------------
@@ -84,13 +85,13 @@
 	  TYPE LINE
 	  CONNECTIONTYPE OGR
 	  CONNECTION "./ntf/llcontours.ntf"
-          DATA "LANDLINE_LINE"
+      DATA "LANDLINE_LINE"
 	  STATUS DEFAULT
 	  CLASS
 	    NAME "Contours"
-            STYLE
-	     COLOR 0 150 200
-            END
+        STYLE
+	        COLOR 0 150 200
+        END
 	  END
 	END
 

Modified: trunk/docs/input/vector/ogr.txt
===================================================================
--- trunk/docs/input/vector/ogr.txt	2008-12-07 22:43:55 UTC (rev 8202)
+++ trunk/docs/input/vector/ogr.txt	2008-12-07 23:17:21 UTC (rev 8203)
@@ -18,50 +18,57 @@
 Introduction
 ============
 
-Starting with version 3.5, MapServer included the ability to access vector data 
-sets in formats other than Shapefile in their native format using the OGR library. 
-The following document describes the process for implementing OGR support within 
-MapServer applications.
+Starting with version 3.5, MapServer included the ability to access vector
+data sets in formats other than Shapefile in their native format using the OGR
+library. The following document describes the process for implementing OGR
+support within MapServer applications.
 
-Note that experimental OGR support was included in MapServer version 3.4 but this 
-initial implementation had some limitations and is not covered in this document.
+.. note::
+    
+    Experimental OGR support was included in MapServer version 3.4 but this
+    initial implementation had some limitations and is not covered in this
+    document.
 
-This document assumes that you are already familiar with certain aspects of MapServer:
+This document assumes that you are already familiar with certain aspects of
+MapServer:
 
-- MapServer application development and especially setting up :ref:`.map files <mapfile>`.
+- MapServer application development and especially setting up :ref:`.map files
+  <mapfile>`.
 
-- Some compilation skills if you don't have ready access to a pre-compiled installation 
-  and need to compile your own copy of MapServer with OGR support. 
+- Some compilation skills if you don't have ready access to a pre-compiled
+  installation and need to compile your own copy of MapServer with OGR
+  support.
   
-- access to OGR utilities, such as *ogrinfo*, which are available in the `FWTools`_ and 
-  `MS4W`_ packages.
+- access to OGR utilities, such as *ogrinfo*, which are available in the
+  `FWTools`_ and `MS4W`_ packages.
                       
-Readers should also check out the :ref:`Vector Data Access Guide <vector>`, which has lots of 
-examples of how to access specific vector formats.
+Readers should also check out the :ref:`Vector Data Access Guide <vector>`,
+which has lots of examples of how to access specific vector formats.
                         
 What is OGR?
 ============
 
-The OGR Simple Features Library is a C++ open source library (and command-line 
-tools) providing read (and sometimes write) access to a variety of vector file 
-formats including ESRI Shapefiles, and MapInfo mid/mif and TAB formats.  
+The OGR Simple Features Library is a C++ open source library (and command-line
+tools) providing read (and sometimes write) access to a variety of vector file
+formats including ESRI Shapefiles, and MapInfo mid/mif and TAB formats.
 
-OGR is actually part of the GDAL library, so you will notice that some references 
-point to GDAL (such as the mailing list).
+OGR is actually part of the GDAL library, so you will notice that some
+references point to GDAL (such as the mailing list).
 
 What Does OGR Add to MapServer?
 -------------------------------
 
-The OGR Simple Features Library allows MapServer users to display several types 
-of vector data files in their native formats. For example, MapInfo Mid/Mif and 
-TAB data do not need to be converted to ESRI shapefiles when using OGR support 
-with MapServer.
+The OGR Simple Features Library allows MapServer users to display several
+types of vector data files in their native formats. For example, MapInfo
+Mid/Mif and TAB data do not need to be converted to ESRI shapefiles when using
+OGR support with MapServer.
 
 What Data Formats are Supported?
 --------------------------------
 
-See http://www.gdal.org/ogr/ogr_formats.html for the latest list of supported 
-formats. At the date this document was written, the following formats were supported:
+See http://www.gdal.org/ogr/ogr_formats.html for the latest list of supported
+formats. At the date this document was written, the following formats were
+supported:
 
 - `ArcInfo Coverages`_
 - `Comma Separated Value (.csv)`_
@@ -107,15 +114,14 @@
 - More information on the OGR Simple Features Project can be found at 
   http://www.gdal.org/ogr/.
 
-- The `GDAL mailing list`_ can be used for OGR related questions.  Always search
-  the list archives before sending new questions.
+- The `GDAL mailing list`_ can be used for OGR related questions. Always
+  search the list archives before sending new questions.
 
 - The `GDAL Wiki`_ has lots of good information for users and developers.
 
 - The #gdal IRC channel on irc.freenode.net might also be of help.  For info
   on IRC see the `MapServer IRC page`_.
 
-
 The main developer of the OGR library is Frank Warmerdam and the 
 integration of OGR within MapServer was done by Daniel Morissette.
 
@@ -226,8 +232,8 @@
     For RDBMS based drivers (such as PostGIS and Oracle) this is passed
     through to the underlying database.
 
-The OGRINFO utility can be used to find out the list of layers and their names in a 
-data source. 
+The OGRINFO utility can be used to find out the list of layers and their names
+in a data source.
 
 Examples of Layer Definitions Using OGR
 ---------------------------------------
@@ -310,7 +316,17 @@
 and `MS4W`_). It is an executable that can be used to obtain layer information 
 about OGR supported files. The parameters are:
 
-  ogrinfo [-ro] [-q] datasource_name [layer [layer...]]
+.. program:: ogrinfo 
+
+.. cmdoption:: -ro
+
+    opens the file as read only (optional)
+
+.. cmdoption:: -q
+    
+    executes in quiet mode, only the layer index line will be returned (optional)
+
+    ogrinfo [-ro] [-q] datasource_name [layer [layer...]]
       
   - -ro opens the file as read only (optional)

More information about the mapserver-commits mailing list