[mapserver-commits] r8070 - trunk/docs/references/mapfile
svn at osgeo.org
svn at osgeo.org
Sun Nov 23 20:08:16 EST 2008
Author: hobu
Date: 2008-11-23 20:08:16 -0500 (Sun, 23 Nov 2008)
New Revision: 8070
Modified:
trunk/docs/references/mapfile/Include.txt
trunk/docs/references/mapfile/class.txt
trunk/docs/references/mapfile/feature.txt
trunk/docs/references/mapfile/fontset.txt
trunk/docs/references/mapfile/grid.txt
trunk/docs/references/mapfile/index.txt
trunk/docs/references/mapfile/join.txt
trunk/docs/references/mapfile/label.txt
trunk/docs/references/mapfile/layer.txt
trunk/docs/references/mapfile/legend.txt
trunk/docs/references/mapfile/mapObj.txt
trunk/docs/references/mapfile/outputformat.txt
trunk/docs/references/mapfile/projection.txt
trunk/docs/references/mapfile/querymap.txt
trunk/docs/references/mapfile/reference.txt
trunk/docs/references/mapfile/scalebar.txt
trunk/docs/references/mapfile/style.txt
trunk/docs/references/mapfile/web.txt
Log:
more sphinx
Modified: trunk/docs/references/mapfile/Include.txt
===================================================================
--- trunk/docs/references/mapfile/Include.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/Include.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,10 +1,19 @@
-When this directive is encountered parsing switches to the included file immediately. As a result the included file can be comprised of any valid mapfile syntax. For example:
+*****************************************************************************
+ INCLUDE
+*****************************************************************************
+When this directive is encountered parsing switches to the included file
+immediately. As a result the included file can be comprised of any valid
+mapfile syntax. For example:
+
::
INCLUDE 'myLayer.map'
-Performance does not seem to be seriously impacted with limited use, however in high performance instances you may want to use includes in a pre-processing step to build a production mapfile. The C pre-processor can also be used (albeit with a differnt syntax) and is far more powerful.
+Performance does not seem to be seriously impacted with limited use, however in
+high performance instances you may want to use includes in a pre-processing step
+to build a production mapfile. The C pre-processor can also be used (albeit with
+a different syntax) and is far more powerful.
Notes
-----
@@ -16,7 +25,8 @@
- Includes may be nested, up to 5 deep.
-- File location can be given as a full path to the file, or (in MapServer >= 4.10.1) as a path relative to the mapfile.
+- File location can be given as a full path to the file, or (in MapServer >= 4.10.1) as
+ a path relative to the mapfile.
- Debugging can be problematic since: 1) the file an error occurs in does
not get output to the user and 2) the line number counter is not reset
Modified: trunk/docs/references/mapfile/class.txt
===================================================================
--- trunk/docs/references/mapfile/class.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/class.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,9 @@
+.. _class:
+
+*****************************************************************************
+ CLASS
+*****************************************************************************
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for non-transparent symbols.
@@ -6,10 +12,8 @@
DEBUG [on|off]
Enables debugging of the class object. Verbose output is generated and sent
- to the standard error output (STDERR) or the MapServe r logfile if one is
- set using the LOG parameter in the `WEB`_ object.
-
-.. _`WEB`: /docs/reference/mapfile/web
+ to the standard error output (STDERR) or the MapServer logfile if one is
+ set using the LOG parameter in the :ref:`WEB` object.
EXPRESSION [string]
Four types of expressions are now supported to define class membership.
@@ -49,7 +53,7 @@
GROUP [string]
Allows for grouping of classes. It is only used when a CLASSGROUP at the
- `LAYER`_ level is set. If the CLASSGROUP parameter is set, only classes that
+ :ref:`LAYER`_ level is set. If the CLASSGROUP parameter is set, only classes that
have the same group name would be considered at rendering time. An example
of a layer with grouped classes might contain:
@@ -77,21 +81,17 @@
...
END # layer
-
-.. _`LAYER`: /docs/reference/mapfile/layer
KEYIMAGE [filename]
- Full filename of the legend image for the CLASS. This image is used when
+ Full filename of the legend image for the :ref:`CLASS`. This image is used when
building a legend (or requesting a legend icon via MapScript or the CGI
application).
LABEL
- Signals the start of a `LABEL`_ object.
-
-.. _`LABEL`: /docs/reference/mapfile/label
+ Signals the start of a :ref:`LABEL` object.
MAXSCALEDENOM [double]
- Maximum scale at which this CLASS is drawn. Scale is given as the
+ Maximum scale at which this :ref:`CLASS` is drawn. Scale is given as the
denominator of the actual scale fraction, for example for a map at a scale
of 1:24,000 use 24000. Implemented in MapServer 5.0, to replace the
deprecated MAXSCALE parameter.
@@ -106,7 +106,7 @@
Maximum size in pixels to draw a symbol. Default is 50.
MINSCALEDENOM [double]
- Minimum scale at which this CLASS is drawn. Scale is given as the
+ Minimum scale at which this :ref:`CLASS` is drawn. Scale is given as the
denominator of the actual scale fraction, for example for a map at a scale
of 1:24,000 use 24000. Implemented in MapServer 5.0, to replace the
deprecated MINSCALE parameter.
@@ -137,9 +137,7 @@
Sets the current display status of the class. Default turns the class on.
STYLE
- Signals the start of a `STYLE`_ object. A class can contain multiple styles.
-
-.. _`STYLE`: /docs/reference/mapfile/style
+ Signals the start of a :ref:`STYLE`_ object. A class can contain multiple styles.
SYMBOL [integer|string|filename]
The symbol name or number to use for all features if attribute tables are
Modified: trunk/docs/references/mapfile/feature.txt
===================================================================
--- trunk/docs/references/mapfile/feature.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/feature.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,9 @@
+.. _feature:
+
+*****************************************************************************
+ FEATURE
+*****************************************************************************
+
POINTS
A set of xy pairs terminated with an END, for example:
@@ -21,10 +27,7 @@
WKT "POLYGON((500 500, 3500 500, 3500 2500, 500 2500, 500 500))"
WKT "POINT(2000 2500)"
--------
-
-Note
----------
+.. note:
Inline features should be defined as their own layers in the mapfile. If
another CONNECTIONTYPE is specified in the same layer, MapServer will always
use the inline features to draw the layer and ignore the other CONNECTIONTYPEs.
\ No newline at end of file
Modified: trunk/docs/references/mapfile/fontset.txt
===================================================================
--- trunk/docs/references/mapfile/fontset.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/fontset.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,5 +1,7 @@
+.. _fontset:
+
*****************************************************************************
- Fontsets
+ FONTSET
*****************************************************************************
:Author: Kari Guerts
Modified: trunk/docs/references/mapfile/grid.txt
===================================================================
--- trunk/docs/references/mapfile/grid.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/grid.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,24 +1,41 @@
+.. _grid:
+
+*****************************************************************************
+ GRID
+*****************************************************************************
+
LABELFORMAT [DD|DDMM|DDMMSS|C format string]
- Format of the label. "DD" for degrees, "DDMM" for degrees minutes, and "DDMMSS" for degrees,
- minutes, seconds. A C-style formatting string is also allowed, such as "%g°" to show decimal degrees with a degree symbol. The default is decimal display of whatever SRS you're rendering the GRID with.
+ Format of the label. "DD" for degrees, "DDMM" for degrees minutes, and
+ "DDMMSS" for degrees, minutes, seconds. A C-style formatting string is
+ also allowed, such as "%g°" to show decimal degrees with a degree symbol.
+ The default is decimal display of whatever SRS you're rendering the GRID
+ with.
MINARCS [double]
- The minimum number of arcs to draw. Increase this parameter to get more lines. Optional.
+ The minimum number of arcs to draw. Increase this parameter to get
+ more lines. Optional.
MAXARCS [double]
- The maximum number of arcs to draw. Decrease this parameter to get fewer lines. Optional.
+ The maximum number of arcs to draw. Decrease this parameter to
+ get fewer lines. Optional.
MININTERVAL [double]
- The minimum number of intervals to try to use. The distance between the grid lines, in the units of the grid's coordinate system. Optional.
+ The minimum number of intervals to try to use. The distance between
+ the grid lines, in the units of the grid's coordinate system. Optional.
MAXINTERVAL [double]
- The maximum number of intervals to try to use. The distance between the grid lines, in the units of the grid's coordinate system. Optional.
+ The maximum number of intervals to try to use. The distance between
+ the grid lines, in the units of the grid's coordinate system. Optional.
MINSUBDIVIDE [double]
- The minimum number of segments to use when rendering an arc. If the lines should be very curved, use this to smooth the lines by adding more segments. Optional.
+ The minimum number of segments to use when rendering an arc. If the
+ lines should be very curved, use this to smooth the lines by adding more
+ segments. Optional.
MAXSUBDIVIDE [double]
- The maximum number of segments to use when rendering an arc. If the graticule should be very straight, use this to minimize the number of points for faster rendering. Optional, default 256.
+ The maximum number of segments to use when rendering an arc. If the
+ graticule should be very straight, use this to minimize the number of
+ points for faster rendering. Optional, default 256.
The following is an example of a GRID object in use:
Modified: trunk/docs/references/mapfile/index.txt
===================================================================
--- trunk/docs/references/mapfile/index.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/index.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -12,14 +12,25 @@
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
class
feature
- expressions
- fontset
grid
Include
+ join
+ label
+ layer
+ legend
+ map
+ outputformat
+ projection
+ querymap
+ reference
+ scalebar
+ style
+ variable_sub
+ web
Modified: trunk/docs/references/mapfile/join.txt
===================================================================
--- trunk/docs/references/mapfile/join.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/join.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,11 +1,13 @@
-.. contents:: Table of Contents
- :depth: 1
- :backlinks: top
+.. _join:
+*****************************************************************************
+ JOIN
+*****************************************************************************
+
Description
===========
-Joins are defined within a **LAYER** object. It is important to understand that JOINs are *ONLY* available once a query has been processed. You cannot use joins to affect the look of a map. The primary purpose is to enable lookup tables for coded data (e.g. 1 => Forest) but there are other possible uses.
+Joins are defined within a :ref:`layer` object. It is important to understand that JOINs are *ONLY* available once a query has been processed. You cannot use joins to affect the look of a map. The primary purpose is to enable lookup tables for coded data (e.g. 1 => Forest) but there are other possible uses.
Supported Formats
=================
Modified: trunk/docs/references/mapfile/label.txt
===================================================================
--- trunk/docs/references/mapfile/label.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/label.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,9 @@
+.. _label:
+
+*****************************************************************************
+ LABEL
+*****************************************************************************
+
ANGLE [double|auto|follow|attribute]
- Angle, given in degrees, to draw the label.
- AUTO allows MapServer to compute the angle. Valid for LINE layers only.
Modified: trunk/docs/references/mapfile/layer.txt
===================================================================
--- trunk/docs/references/mapfile/layer.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/layer.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,8 +1,12 @@
+.. _layer
+
+*****************************************************************************
+ LAYER
+*****************************************************************************
+
CLASS
- Signals the start of a `CLASS`_ object.
+ Signals the start of a :ref:`CLASS` object.
-.. _`CLASS`: /docs/reference/mapfile/class
-
CLASSITEM [attribute]
Item name in attribute table to use for class lookups.
Modified: trunk/docs/references/mapfile/legend.txt
===================================================================
--- trunk/docs/references/mapfile/legend.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/legend.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,22 +1,23 @@
-The size of the legend image is NOT known prior to creation so be careful not to hard-code width and height in the <IMG> tag in the template file.
+.. _legend:
------------
+*****************************************************************************
+ LEGEND
+*****************************************************************************
+The size of the legend image is NOT known prior to creation so be careful
+not to hard-code width and height in the <IMG> tag in the template file.
+
IMAGECOLOR [r] [g] [b]
Color to initialize the legend with (i.e. the background).
INTERLACE [on|off]
- **Deprecated** Default is [on]. This keyword is now depcrecated in favour
+ **Deprecated** Default is [on]. This keyword is now deprecated in favour
of using the FORMATOPTION "INTERLACE=ON" line in the
- `OUTPUTFORMAT`_ declaration.
+ :ref:`OUTPUTFORMAT` declaration.
-.. _`OUTPUTFORMAT`: /docs/reference/mapfile/outputformat
-
LABEL
- Signals the start of a `LABEL`_ object
+ Signals the start of a :ref:`LABEL` object
-.. _`LABEL`: /docs/reference/mapfile/label
-
OUTLINECOLOR [r] [g] [b]
Color to use for outlining symbol key boxes.
@@ -41,9 +42,9 @@
TEMPLATE [filename]
HTML legend template file. Refer to the `HTML Legend howto`_.
-.. _`HTML Legend howto`: http://ms.gis.umn.edu/docs/howto/html_legend
+.. _`HTML Legend howto`: ../output/html_legend
TRANSPARENT [on|off]
**Deprecated** Should the background color for the legend be transparent.
This flag is now deprecated in favour of declaring transparency within
- `OUTPUTFORMAT`_ declarations. Default is off.
+ :ref:`OUTPUTFORMAT` declarations. Default is off.
Modified: trunk/docs/references/mapfile/mapObj.txt
===================================================================
--- trunk/docs/references/mapfile/mapObj.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/mapObj.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,11 +1,25 @@
+.. _map:
+
+*****************************************************************************
+ MAP
+*****************************************************************************
+
ANGLE [double]
- Angle, given in degrees, to rotate the map. Default is 0. The rendered map will rotate in a clockwise direction. The following are important notes:
+ Angle, given in degrees, to rotate the map. Default is 0. The rendered
+ map will rotate in a clockwise direction. The following are important notes:
- - Requires a PROJECTION object specified at the MAP level and for each LAYER object (even if all layers are in the same projection).
+ - Requires a :ref:`PROJECTION` object specified at the MAP level and for each
+ :ref:`LAYER` object (even if all layers are in the same projection).
- Requires MapScript (SWIG, PHPMapscript). Does not work with CGI mode.
- - If using the LABEL object's ANGLE or the LAYER object's LABELANGLEITEM parameters as well, these parameters are relative to the map's orientation (i.e. they are computed after the MAP object's ANGLE). For example, if you have specified an ANGLE for the map of 45, and then have a layer LABELANGLEITEM value of 45, the resulting label will not appear rotated (because the resulting map is rotated clockwise 45 degrees and the label is rotated counter-clockwise 45 degrees).
+ - If using the :ref:`LABEL` object's ANGLE or the :ref:`LAYER` object's LABELANGLEITEM
+ parameters as well, these parameters are relative to the map's orientation
+ (i.e. they are computed after the MAP object's ANGLE). For example, if you
+ have specified an ANGLE for the map of 45, and then have a layer
+ LABELANGLEITEM value of 45, the resulting label will not appear rotated
+ (because the resulting map is rotated clockwise 45 degrees and the label
+ is rotated counter-clockwise 45 degrees).
- More information can be found on the MapRotation `Wiki Page`_.
@@ -272,8 +286,6 @@
SYMBOL
Signals the start of a `SYMBOL`_ object.
-.. _`SYMBOL`: /docs/reference/symbology
-
.. _TEMPLATEPATTERN:
TEMPLATEPATTERN [regular expression]
@@ -292,6 +304,4 @@
Units of the map coordinates. Used for scalebar and scale computations.
WEB
- Signals the start of a `WEB`_ object.
-
-.. _`WEB`: /docs/reference/mapfile/web
\ No newline at end of file
+ Signals the start of a `WEB`_ object.
\ No newline at end of file
Modified: trunk/docs/references/mapfile/outputformat.txt
===================================================================
--- trunk/docs/references/mapfile/outputformat.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/outputformat.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,9 @@
+.. _outputformat:
+
+*****************************************************************************
+ OUTPUTFORMAT
+*****************************************************************************
+
A map file may have zero, one or more OUTPUTFORMAT object declarations,
defining available output formats supported including formats like PNG,
GIF, JPEG, GeoTIFF and Flash (SWF).
Modified: trunk/docs/references/mapfile/projection.txt
===================================================================
--- trunk/docs/references/mapfile/projection.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/projection.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,8 +1,17 @@
+*****************************************************************************
+ PROJECTION
+*****************************************************************************
+
To set up projections you must define two projection objects: one for the
output image (in the MAP object) and one for each layer (in the LAYER
-objects) to be projected. MapServer relies on the `PROJ.4`_ library for projections. Projection objects therefore consist of a series of PROJ.4 keywords, which are either specified within the object directly or referred to in an *epsg* file. An epsg file is a lookup file containing projection parameters, and is part of the PROJ.4 library.
+objects) to be projected. MapServer relies on the `PROJ.4`_ library for
+projections. Projection objects therefore consist of a series of PROJ.4 keywords,
+which are either specified within the object directly or referred to in an
+*epsg* file. An epsg file is a lookup file containing projection parameters,
+and is part of the PROJ.4 library.
-The following two examples both define the same projection (UTM zone 15, NAD83), but use 2 different methods:
+The following two examples both define the same projection (UTM zone 15, NAD83),
+but use 2 different methods:
**Example1: Inline Projection Parameters**
@@ -51,20 +60,30 @@
Important Notes
---------------
-- If all of your data in the mapfile is in the same projection, you DO NOT have to specify any projection objects. MapServer will assume that all of the data is in the same projection.
+- If all of your data in the mapfile is in the same projection, you DO NOT
+ have to specify any projection objects. MapServer will assume that all of
+ the data is in the same projection.
-- Think of the MAP-level projection object as your output projection. The EXTENT and UNITS values at the MAP-level must be in the output projection units. Also, if you have layers in other projections (other than the MAP-level projection) then you must define PROJECTION objects for those layers, to tell MapServer what projections they are in.
+- Think of the MAP-level projection object as your output projection. The EXTENT
+ and UNITS values at the MAP-level must be in the output projection units. Also,
+ if you have layers in other projections (other than the MAP-level projection)
+ then you must define PROJECTION objects for those layers, to tell MapServer
+ what projections they are in.
-- If you specify a MAP-level projection, and then only one other LAYER projection object, MapServer will assume that all of the other layers are in the specified MAP-level projection.
+- If you specify a MAP-level projection, and then only one other LAYER projection
+ object, MapServer will assume that all of the other layers are in the specified
+ MAP-level projection.
-- Always refer to the epsg file in lowercase, because it is a lowercase filename and on Linux/Unix systems this parameter is case sensitive.
+- Always refer to the epsg file in lowercase, because it is a lowercase filename
+ and on Linux/Unix systems this parameter is case sensitive.
For More Information
--------------------
-- If you get projection errors, refer to the `MapServer Error page`_ to check if your exact error has been discussed.
+- If you get projection errors, refer to the `MapServer Error page`_ to check
+ if your exact error has been discussed.
- - Search the MapServer-users `email list archives`_, odds are that someone has faced your exact issue before.
+- Search the MapServer-users `email list archives`_, odds are that someone has faced your exact issue before.
- See the `PROJ.4`_ user guides for complete descriptions of supported projections and coordinate systems.
- Refer to the `Cartographical Map Projections`_ page for background information on projections.
Modified: trunk/docs/references/mapfile/querymap.txt
===================================================================
--- trunk/docs/references/mapfile/querymap.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/querymap.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,7 @@
+*****************************************************************************
+ QUERYMAP
+*****************************************************************************
+
COLOR [r] [g] [b]
Color in which features are highlighted. Default is yellow.
Modified: trunk/docs/references/mapfile/reference.txt
===================================================================
--- trunk/docs/references/mapfile/reference.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/reference.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,6 +1,13 @@
-Three types of reference maps are supported. The most common would be one showing the extent of a map in an interactive interface. It is also possible to request reference maps as part of a query. Point queries will generate an image with a marker (see below) placed at the query point. Region based queries will depict the extent of the area of interest. Finally, feature based queries will display the selection feature(s) used.
+*****************************************************************************
+ REFERENCE
+*****************************************************************************
-----------
+Three types of reference maps are supported. The most common would be one
+showing the extent of a map in an interactive interface. It is also possible
+to request reference maps as part of a query. Point queries will generate an
+image with a marker (see below) placed at the query point. Region based queries
+will depict the extent of the area of interest. Finally, feature based queries
+will display the selection feature(s) used.
COLOR [r] [g] [b]
Color in which the reference box is drawn. Set any component to -1 for
Modified: trunk/docs/references/mapfile/scalebar.txt
===================================================================
--- trunk/docs/references/mapfile/scalebar.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/scalebar.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,7 @@
+*****************************************************************************
+ Scalebars
+*****************************************************************************
+
Scalebars currently do not make use of TrueType fonts. The size of the scalebar image is NOT known prior to rendering, so be careful not to hard-code width and height in the <IMG> tag in the template file. Future versions will make the image size available.
------------
Modified: trunk/docs/references/mapfile/style.txt
===================================================================
--- trunk/docs/references/mapfile/style.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/style.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,7 @@
+*****************************************************************************
+ STYLE
+*****************************************************************************
+
This object is new in 4.0 and is intended to seperate logic from looks. The final intent is to have named styles (Not yet supported) that will be re-usable through the mapfile. This is the new, preferred way of defining the appearance of an object, notably a class.
-----------
Modified: trunk/docs/references/mapfile/web.txt
===================================================================
--- trunk/docs/references/mapfile/web.txt 2008-11-24 00:35:16 UTC (rev 8069)
+++ trunk/docs/references/mapfile/web.txt 2008-11-24 01:08:16 UTC (rev 8070)
@@ -1,3 +1,9 @@
+.. _web:
+
+*****************************************************************************
+ WEB
+*****************************************************************************
+
EMPTY [url]
URL to forward users to if a query fails. If not defined the value for
ERROR is used.
More information about the mapserver-commits
mailing list