[mapserver-commits] r8222 - in trunk/docs: . development
development/editing development/rfc development/tests
input/vector installation mapfile mapscript/php ogc
svn at osgeo.org
svn at osgeo.org
Tue Dec 9 16:07:22 EST 2008
Author: hobu
Date: 2008-12-09 16:07:21 -0500 (Tue, 09 Dec 2008)
New Revision: 8222
Added:
trunk/docs/development/doc_style_guide.txt
Removed:
trunk/docs/input/vector/introduction.txt
trunk/docs/style_guide.txt
Modified:
trunk/docs/development/editing/vim.txt
trunk/docs/development/index.txt
trunk/docs/development/rfc/index.txt
trunk/docs/development/tests/autotest.txt
trunk/docs/development/tests/mapscript.txt
trunk/docs/glossary.txt
trunk/docs/index.txt
trunk/docs/input/vector/index.txt
trunk/docs/input/vector/ogr.txt
trunk/docs/installation/php.txt
trunk/docs/mapfile/class.txt
trunk/docs/mapfile/index.txt
trunk/docs/mapfile/layer.txt
trunk/docs/mapfile/map.txt
trunk/docs/mapscript/php/by_example.txt
trunk/docs/ogc/mapcontext.txt
Log:
more reorg, clean up warnings
Copied: trunk/docs/development/doc_style_guide.txt (from rev 8219, trunk/docs/style_guide.txt)
===================================================================
--- trunk/docs/development/doc_style_guide.txt (rev 0)
+++ trunk/docs/development/doc_style_guide.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -0,0 +1,35 @@
+*****************************************************************************
+ Documentation Style Guide
+*****************************************************************************
+
+:Author: Howard Butler
+:Contact: hobu.inc at gmail.com
+:Revision: $Revision$
+:Date: $Date$
+:Last Updated: 2008/11/23
+
+.. contents:: Table of Contents
+ :depth: 2
+ :backlinks: top
+
+
+MapServer instead of mapserver, map server, Map Server or map Server.
+
+MapScript instead of mapscript, Mapscript, or map script.
+
+PostGIS instead of postgis.
+
+HowTo instead of howto or HOWTO.
+
+
+ReStructured Text Formatting
+----------------------------
+
+All text should be hard breaks at or around the 80 column mark, just as
+the source code.
+
+no ``.. sectnum::`` in the contents directives
+
+
+Email addresses should be manually spam protected:
+hobu.inc at gmail.com instead of hobu.inc at gmail.com
\ No newline at end of file
Property changes on: trunk/docs/development/doc_style_guide.txt
___________________________________________________________________
Name: svn:keywords
+ Id Author Rev Date
Modified: trunk/docs/development/editing/vim.txt
===================================================================
--- trunk/docs/development/editing/vim.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/development/editing/vim.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -56,7 +56,7 @@
`Vim code folding <http://www.vim.org/htmldoc/usr_28.html>`__ can be an
extremely handy way to simplify the task of editing complex MapServer mapfiles
-inside the Vim editor. A Vim command file called `*map_fold.vim*`_ is attached
+inside the Vim editor. A Vim command file called `map_fold.vim`_ is attached
to this document, which defines a folding mode for mapfiles. This file also
lives at http://iconocla.st/code/dot/map_fold.vim.
Modified: trunk/docs/development/index.txt
===================================================================
--- trunk/docs/development/index.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/development/index.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -14,3 +14,4 @@
tests/index
rfc/index
editing/index
+ doc_style_guide
Modified: trunk/docs/development/rfc/index.txt
===================================================================
--- trunk/docs/development/rfc/index.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/development/rfc/index.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -31,6 +31,7 @@
ms-rfc-21
ms-rfc-22a
ms-rfc-23
+ ms-rfc-24
ms-rfc-25
ms-rfc-26
ms-rfc-27
Modified: trunk/docs/development/tests/autotest.txt
===================================================================
--- trunk/docs/development/tests/autotest.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/development/tests/autotest.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,4 +1,4 @@
-.. _raster:
+.. _autotest:
*****************************************************************************
Regression Testing
Modified: trunk/docs/development/tests/mapscript.txt
===================================================================
--- trunk/docs/development/tests/mapscript.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/development/tests/mapscript.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,4 +1,4 @@
-.. _vector:
+.. _mapscript_tests:
*****************************************************************************
MapScript Unit Testing
Modified: trunk/docs/glossary.txt
===================================================================
--- trunk/docs/glossary.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/glossary.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,3 +1,8 @@
+
+***************************************************
+ Glossary
+***************************************************
+
.. glossary::
CGI
Modified: trunk/docs/index.txt
===================================================================
--- trunk/docs/index.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/index.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -82,3 +82,6 @@
utilities/index
cgi/index
development/index
+ download
+ documentation
+ glossary
Modified: trunk/docs/input/vector/index.txt
===================================================================
--- trunk/docs/input/vector/index.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/input/vector/index.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -18,6 +18,7 @@
What is vector data? This quote from is a good description of what vector data is:
.. pull-quote::
+
Vector: "An abstraction of the real world where positional data is
represented in the form of coordinates. In vector data, the basic units
of spatial information are points, lines and polygons. Each of these
@@ -33,16 +34,16 @@
From: http://coris.noaa.gov/glossary/glossary_l_z.html#v
-The rest of this document is the data format guide. This guide is structured to
-show the fundamentals of each MapServer supported data format. Each section
-discusses one format, ranging from one to several pages in length. The sections
-typically start with a summary of the most important information about the
-format, followed by examples of file listings, connection methods, ogrinfo usage
-and MapServer map file syntax examples.
+The rest of this document is the data format guide. This guide is structured
+to show the fundamentals of each MapServer supported data format. Each section
+discusses one format, ranging from one to several pages in length. The
+sections typically start with a summary of the most important information
+about the format, followed by examples of file listings, connection methods,
+ogrinfo usage and MapServer map file syntax examples.
-Each section has been designed to stand alone, so you may notice that certain
-warnings and comments are repeated or redundant. This is intentional. Each
-format is presented in rough order of popular use, based on a survey of the
+Each section has been designed to stand alone, so you may notice that certain
+warnings and comments are repeated or redundant. This is intentional. Each
+format is presented in rough order of popular use, based on a survey of the
MapServer community.
The following formats are included:
Deleted: trunk/docs/input/vector/introduction.txt
===================================================================
--- trunk/docs/input/vector/introduction.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/input/vector/introduction.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,53 +0,0 @@
-What is vector data? This quote from is a good description of what vector data is:
-
- Vector: "An abstraction of the real world where positional data is
- represented in the form of coordinates. In vector data, the basic units
- of spatial information are points, lines and polygons. Each of these
- units is composed simply as a series of one or more coordinate points.
- For example, a line is a collection of related points, and a polygon is a
- collection of related lines. Vector images are defined mathematically as a
- series of points joined by lines. Vector-based drawings are resolution
- independent. This means that they appear at the maximum resolution of the
- output device, such as a printer or monitor. Each object is self-contained,
- with properties such as color, shape, outline, size, and position on the
- screen."
-
- From: http://coris.noaa.gov/glossary/glossary_l_z.html#v
-
-
-MapServer can access vector file formats and database connections. It can also
-access raster or image data. This is a summary of the vector and database
-formats with particular focus on how to use them in a MapServer map file and
-access them using command line tools like **ogrinfo**.
-
-MapServer and vector data access
-------------------------------------
-
-MapServer has two main methods for accessing data:
-
-* Through built-in, format-specific, data access capabilities.
-
- The most basic form of data access uses the built-in capabilities that
- were linked into MapServer when it was compiled. These capabilities are
- limited to only a few types of vector data, such as ESRI Shapefile,
- PostGIS, Oracle Spatial and ArcSDE. The default, built-in, format for
- MapServer is the ESRI Shapefile format.
-
-* Using the capabilities of third-party data access libraries.
-
- One of the most powerful features of MapServer is the ability to use data formats through a pseudo plug-in environment. The most significant third
- party library being used is GDAL/OGR. This includes raster (GDAL) and
- vector (OGR) data.
-
-Using OGR
-------------------------------------
-
-OGR is used behind the scenes by MapServer when requested. MapServer does not
-require OGR in order to run. Some users may never need the additional
-capabilities OGR offers, but many users find them absolutely necessary. Because
-MapServer is capable of accessing data via OGR, there is less need to program
-specific types of data format support directly into MapServer. Instead, further
-additions can be made to OGR and then be used by MapServer. In essence, the
-background libraries allow MapServer to bring the data into an internal,
-memory-based format that MapServer can use. For the most part, using
-OGR-related formats is seamless and intuitive.
\ No newline at end of file
Modified: trunk/docs/input/vector/ogr.txt
===================================================================
--- trunk/docs/input/vector/ogr.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/input/vector/ogr.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -826,4 +826,5 @@
.. _`OGR formats page`: http://www.gdal.org/ogr/ogr_formats.html
.. _`DGN driver page`: http://www.gdal.org/ogr/drv_dgn.html
.. _`OGR Utilities Page`: http://www.gdal.org//ogr/ogr_utilities.html
-.. _`GDAL Wiki`: http://trac.osgeo.org/gdal/wiki/
\ No newline at end of file
+.. _`GDAL Wiki`: http://trac.osgeo.org/gdal/wiki/
+.. _`Mapserver site`: http://mapserver.osgeo.org
\ No newline at end of file
Modified: trunk/docs/installation/php.txt
===================================================================
--- trunk/docs/installation/php.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/installation/php.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,8 +1,5 @@
.. _php_install:
-.. index::
- pair: php; installation
-
*****************************************************************************
PHP MapScript Installation
*****************************************************************************
@@ -15,6 +12,10 @@
:depth: 2
:backlinks: top
+
+.. index::
+ pair: php; installation
+
Introduction
============
@@ -64,7 +65,7 @@
- Questions regarding the module should be forwarded to the `MapServer mailing list`_.
Obtaining, Compiling, and Installing PHP and the PHP/MapScript Module
-====================================================================
+======================================================================
.. index::
pair: php; download
@@ -208,7 +209,7 @@
2. Download `PHP4`_ and extract it to your Apache folder (eg. D:/Apache/PHP4).
3. Create a temp directory to store MapServer created GIFs. NOTE: This directory
- is specified in the IMAGEPATH parameter of the WEB Object in the `mapfile`_.
+ is specified in the IMAGEPATH parameter of the WEB Object in the :ref:`mapfile`.
For this example we will call the temp directory "ms_tmp" (eg. E:/tmp/ms_tmp).
4. Locate the file *httpd.conf* in the conf directory of Apache, and open it
@@ -281,9 +282,12 @@
with your PHP scripts. Usual extensions needed to be associated are phtml and php.
You must repeat this step for each extension.
-11. Create a temp directory in Explorer to store MapServer created GIFs. NOTE: This
- directory is specified in the IMAGEPATH parameter of the WEB Object in the `mapfile`_.
- For this example we will call the temp directory *ms_tmp* (eg. C:/tmp/ms_tmp).
+11. Create a temp directory in Explorer to store MapServer created GIFs.
+
+ .. note::
+ This directory is specified in the IMAGEPATH parameter of the WEB
+ Object in the :ref:`mapfile`. For this example we will call the temp
+ directory *ms_tmp* (eg. C:/tmp/ms_tmp).
12. Open the Internet Service Manager again.
Modified: trunk/docs/mapfile/class.txt
===================================================================
--- trunk/docs/mapfile/class.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/mapfile/class.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -119,7 +119,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
MAXSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is MAXSCALEDENOM instead.
@@ -143,7 +143,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
MINSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is MINSCALEDENOM instead.
Modified: trunk/docs/mapfile/index.txt
===================================================================
--- trunk/docs/mapfile/index.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/mapfile/index.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -36,6 +36,7 @@
feature
fontset
Include
+ grid
join
label
layer
Modified: trunk/docs/mapfile/layer.txt
===================================================================
--- trunk/docs/mapfile/layer.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/mapfile/layer.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -202,7 +202,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
LABELMAXSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is LABELMAXSCALEDENOM
@@ -223,7 +223,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
LABELMINSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is LABELMINSCALEDENOM
@@ -272,7 +272,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
MAXSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is MAXSCALEDENOM instead.
@@ -308,7 +308,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
MINSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is MINSCALEDENOM
@@ -353,7 +353,7 @@
PROCESSING [string]
Passes a processing directive to be used with this layer. The supported
processing directives vary by layer type, and the underlying driver that
- processes them. Here we see the SCALE and BANDs directives used to
+ processes them. Here we see the SCALE and BANDs directivMap Scalees used to
autoscale raster data and alter the band mapping. All raster processing
options are described in :ref:`raster`.
@@ -421,7 +421,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
SYMBOLSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is SYMBOLSCALEDENOM
Modified: trunk/docs/mapfile/map.txt
===================================================================
--- trunk/docs/mapfile/map.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/mapfile/map.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -255,7 +255,7 @@
.. seealso::
- :term:`Map scale`
+ :term:`Map Scale`
SCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is SCALEDENOM
Modified: trunk/docs/mapscript/php/by_example.txt
===================================================================
--- trunk/docs/mapscript/php/by_example.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/mapscript/php/by_example.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,3 +1,5 @@
+.. _php_example:
+
*****************************************************************************
By Example
*****************************************************************************
Modified: trunk/docs/ogc/mapcontext.txt
===================================================================
--- trunk/docs/ogc/mapcontext.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/ogc/mapcontext.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -16,7 +16,7 @@
Introduction
============
-
+
The term 'map context' comes from the Open Geospatial Constortium's (OGC) `Web
Map Context Specification v1.0.0`_, which coincides with the OGC `Web Map
Server Specification (WMS) v1.1.1`_. A map context is a XML document that
@@ -189,7 +189,7 @@
- *wms_dimension_%s_unitsymbol* : Symbol for dimension units. The default
value is t. %s = the name of the dimension.
- .. verisonadded:: 4.10
+ .. versionadded:: 4.10
- *wms_dimension_%s_uservalue* : User dimension value. MapServer will check
for wms_time and wms_timedefault metadata when this is not specified. %s =
Deleted: trunk/docs/style_guide.txt
===================================================================
--- trunk/docs/style_guide.txt 2008-12-09 20:36:57 UTC (rev 8221)
+++ trunk/docs/style_guide.txt 2008-12-09 21:07:21 UTC (rev 8222)
@@ -1,37 +0,0 @@
-*****************************************************************************
- MapServer Documentation Style Guide
-*****************************************************************************
-
-:Author: Howard Butler
-:Contact: hobu.inc at gmail.com
-:Revision: $Revision: 8058 $
-:Date: $Date: 2008-11-23 14:02:50 -0600 (Sun, 23 Nov 2008) $
-:Last Updated: 2008/11/23
-
-.. sectnum::
-
-.. contents:: Table of Contents
- :depth: 2
- :backlinks: top
-
-
-MapServer instead of mapserver, map server, Map Server or map Server.
-
-MapScript instead of mapscript, Mapscript, or map script.
-
-PostGIS instead of postgis.
-
-HowTo instead of howto or HOWTO.
-
-
-ReStructured Text Formatting
-----------------------------
-
-All text should be hard breaks at or around the 80 column mark, just as
-the source code.
-
-no ``.. sectnum::`` in the contents directives
-
-
-Email addresses should be manually spam protected:
-hobu.inc at gmail.com instead of hobu.inc at gmail.com
\ No newline at end of file
More information about the mapserver-commits
mailing list