[mapserver-commits] r12088 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Aug 23 08:06:07 EDT 2011
Author: havatv
Date: 2011-08-23 05:06:06 -0700 (Tue, 23 Aug 2011)
New Revision: 12088
Modified:
branches/branch-6-0/docs/en/mapfile/map.txt
trunk/docs/en/mapfile/map.txt
Log:
Added indexes (#4001)
Modified: branches/branch-6-0/docs/en/mapfile/map.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/map.txt 2011-08-23 12:01:53 UTC (rev 12087)
+++ branches/branch-6-0/docs/en/mapfile/map.txt 2011-08-23 12:06:06 UTC (rev 12088)
@@ -1,5 +1,8 @@
.. _map:
+.. index::
+ single: MAP
+
*****************************************************************************
MAP
*****************************************************************************
@@ -8,6 +11,9 @@
The map object is started with the word `MAP`, and ended with the
word `END`.
+.. index::
+ pair: ANGLE; 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
@@ -35,7 +41,7 @@
.. _`Wiki Page`: http://trac.osgeo.org/mapserver/wiki/MapRotation
.. index::
- pair: CONFIG; MAP
+ pair: CONFIG; MAP
CONFIG [key] [value]
This can be used to specify several values at run-time, for both
@@ -45,16 +51,25 @@
(`GDAL`_/`OGR`_). The following options are available specifically
for MapServer:
+ .. index::
+ triple: MAP; CONFIG; CGI_CONTEXT_URL
+
CGI_CONTEXT_URL [value]
This `CONFIG` parameter can be used to enable loading a map
context from a URL. See the :ref:`Map Context
HowTo<map_context>` for more info.
+ .. index::
+ triple: MAP; CONFIG; MS_ENCRYPTION_KEY
+
MS_ENCRYPTION_KEY [filename]
This `CONFIG` parameter can be used to specify an encryption
key that is used with MapServer's :ref:`msencypt
utility<msencrypt>`.
+ .. index::
+ triple: MAP; CONFIG; MS_ERRORFILE
+
MS_ERRORFILE [filename]
This `CONFIG` parameter can be used to write MapServer errors
to a file (as of MapServer 5.0). With MapServer 5.x, a full
@@ -67,10 +82,16 @@
make the path relative to. For more on this see the `DEBUG`
parameter below.
+ .. index::
+ triple: MAP; CONFIG; MS_NONSQUARE
+
MS_NONSQUARE [yes|no]
This `CONFIG` parameter can be used to allow non-square WMS
requests.
+ .. index::
+ triple: MAP; CONFIG; ON_MISSING_DATA
+
ON_MISSING_DATA [FAIL|LOG|IGNORE]
This `CONFIG` parameter can be used to tell MapServer how to
handle missing data in tile indexes (as of MapServer 5.3-dev,
@@ -105,6 +126,9 @@
CONFIG "ON_MISSING_DATA" "IGNORE"
+ .. index::
+ triple: MAP; CONFIG; PROJ_LIB
+
PROJ_LIB [path]
This `CONFIG` parameter can be used to define the location of
your EPSG files for the :term:`Proj.4` library. Setting the
@@ -136,6 +160,9 @@
default operation being very conservative. See also
TEMPLATEPATTERN_.
+.. index::
+ pair: DEBUG; MAP
+
DEBUG [off|on|0|1|2|3|4|5]
Enables debugging of all of the layers in the current map.
@@ -219,6 +246,9 @@
.. versionadded:: 5.6
+.. index::
+ pair: EXTENT; MAP
+
EXTENT [minx] [miny] [maxx] [maxy]
The spatial extent of the map to be created. In most cases you
will need to specify this, although MapServer can sometimes
@@ -228,6 +258,9 @@
Filename of fontset file to use. Can be a path relative to the
mapfile, or a full path.
+.. index::
+ pair: IMAGECOLOR; MAP
+
IMAGECOLOR [r] [g] [b]
Color to initialize the map with (i.e. background color). When
transparency is enabled (*TRANSPARENT ON* in :ref:`OUTPUTFORMAT`)
@@ -246,6 +279,9 @@
.. _imagetype:
+.. index::
+ pair: IMAGETYPE; MAP
+
IMAGETYPE [gif|png|jpeg|wbmp|gtiff|swf|userdefined]
Output format to generate. See details in the :ref:`OUTPUTFORMAT`
section for available formats. The name here must match the 'NAME'
@@ -259,33 +295,54 @@
.. deprecated:: 4.6
+.. index::
+ pair: LAYER; MAP
+
:ref:`LAYER`
Signals the start of a :ref:`LAYER` object.
+.. index::
+ pair: LEGEND; MAP
+
:ref:`LEGEND`
Signals the start of a :ref:`LEGEND` object.
+.. index::
+ pair: MAXSIZE; MAP
+
MAXSIZE [integer]
Sets the maximum size of the map image. This will override the
default value. For example, setting this to 2048 means that you
can have up to 2048 pixels in both dimensions (i.e. max of
2048x2048). Default is 2048.
+.. index::
+ pair: NAME; MAP
+
NAME [name]
Prefix attached to map, scalebar and legend GIF filenames created
using this mapfile. It should be kept short.
+.. index::
+ pair: PROJECTION; MAP
+
:ref:`PROJECTION`
Signals the start of a :ref:`PROJECTION` object.
+.. index::
+ pair: QUERYMAP; MAP
+
:ref:`QUERYMAP`
Signals the start of a :ref:`QUERYMAP` object.
+.. index::
+ pair: REFERENCE; MAP
+
:ref:`REFERENCE`
Signals the start of a :ref:`REFERENCE` MAP object.
.. index::
- pair: RESOLUTION; MAP
+ pair: RESOLUTION; MAP
.. _resolution-parameter:
@@ -295,6 +352,9 @@
.. index::
pair: SCALEDENOM; MAP
+.. index::
+ pair: SCALEDENOM; MAP
+
SCALEDENOM [double]
Computed scale of the map. Set most often by the application.
Scale is given as the denominator of the actual scale fraction,
@@ -315,20 +375,35 @@
.. deprecated:: 5.0
+.. index::
+ pair: SCALEBAR; MAP
+
SCALEBAR
Signals the start of a :ref:`SCALEBAR` object.
+.. index::
+ pair: SHAPEPATH; MAP
+
SHAPEPATH [filename]
Path to the directory holding the shapefiles or tiles. There can
be further subdirectories under `SHAPEPATH`.
+.. index::
+ pair: SIZE; MAP
+
SIZE [x][y]
Size in pixels of the output image (i.e. the map).
+.. index::
+ pair: STATUS; MAP
+
STATUS [on|off]
Is the map active? Sometimes you may wish to turn this off to use
only the reference map or scale bar.
+.. index::
+ pair: SYMBOLSET; MAP
+
.. _SYMBOLSET:
SYMBOLSET [filename]
@@ -342,6 +417,12 @@
:ref:`SYMBOL`
Signals the start of a :ref:`SYMBOL` object.
+.. index::
+ pair: TEMPLATEPATTERN; MAP
+
+.. index::
+ pair: TEMPLATEPATTERN; MAP
+
.. _TEMPLATEPATTERN:
TEMPLATEPATTERN [regular expression]
@@ -360,10 +441,16 @@
Use *TRANSPARENT ON* in the :ref:`OUTPUTFORMAT`
declaration to specify if the output images should be transparent.
+.. index::
+ pair: UNITS; MAP
+
UNITS [feet|inches|kilometers|meters|miles|nauticalmiles|dd]
Units of the map coordinates. Used for scalebar and scale
computations. `Nauticalmiles` was added in MapServer 5.6.
+.. index::
+ pair: WEB; MAP
+
:ref:`WEB`
Signals the start of a :ref:`WEB` object.
Modified: trunk/docs/en/mapfile/map.txt
===================================================================
--- trunk/docs/en/mapfile/map.txt 2011-08-23 12:01:53 UTC (rev 12087)
+++ trunk/docs/en/mapfile/map.txt 2011-08-23 12:06:06 UTC (rev 12088)
@@ -1,5 +1,8 @@
.. _map:
+.. index::
+ single: MAP
+
*****************************************************************************
MAP
*****************************************************************************
@@ -8,6 +11,9 @@
The map object is started with the word `MAP`, and ended with the
word `END`.
+.. index::
+ pair: ANGLE; 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
@@ -35,7 +41,7 @@
.. _`Wiki Page`: http://trac.osgeo.org/mapserver/wiki/MapRotation
.. index::
- pair: CONFIG; MAP
+ pair: CONFIG; MAP
CONFIG [key] [value]
This can be used to specify several values at run-time, for both
@@ -45,16 +51,25 @@
(`GDAL`_/`OGR`_). The following options are available specifically
for MapServer:
+ .. index::
+ triple: MAP; CONFIG; CGI_CONTEXT_URL
+
CGI_CONTEXT_URL [value]
This `CONFIG` parameter can be used to enable loading a map
context from a URL. See the :ref:`Map Context
HowTo<map_context>` for more info.
+ .. index::
+ triple: MAP; CONFIG; MS_ENCRYPTION_KEY
+
MS_ENCRYPTION_KEY [filename]
This `CONFIG` parameter can be used to specify an encryption
key that is used with MapServer's :ref:`msencypt
utility<msencrypt>`.
+ .. index::
+ triple: MAP; CONFIG; MS_ERRORFILE
+
MS_ERRORFILE [filename]
This `CONFIG` parameter can be used to write MapServer errors
to a file (as of MapServer 5.0). With MapServer 5.x, a full
@@ -67,10 +82,16 @@
make the path relative to. For more on this see the `DEBUG`
parameter below.
+ .. index::
+ triple: MAP; CONFIG; MS_NONSQUARE
+
MS_NONSQUARE [yes|no]
This `CONFIG` parameter can be used to allow non-square WMS
requests.
+ .. index::
+ triple: MAP; CONFIG; ON_MISSING_DATA
+
ON_MISSING_DATA [FAIL|LOG|IGNORE]
This `CONFIG` parameter can be used to tell MapServer how to
handle missing data in tile indexes (as of MapServer 5.3-dev,
@@ -105,6 +126,9 @@
CONFIG "ON_MISSING_DATA" "IGNORE"
+ .. index::
+ triple: MAP; CONFIG; PROJ_LIB
+
PROJ_LIB [path]
This `CONFIG` parameter can be used to define the location of
your EPSG files for the :term:`Proj.4` library. Setting the
@@ -136,6 +160,9 @@
default operation being very conservative. See also
TEMPLATEPATTERN_.
+.. index::
+ pair: DEBUG; MAP
+
DEBUG [off|on|0|1|2|3|4|5]
Enables debugging of all of the layers in the current map.
@@ -219,6 +246,9 @@
.. versionadded:: 5.6
+.. index::
+ pair: EXTENT; MAP
+
EXTENT [minx] [miny] [maxx] [maxy]
The spatial extent of the map to be created. In most cases you
will need to specify this, although MapServer can sometimes
@@ -228,6 +258,9 @@
Filename of fontset file to use. Can be a path relative to the
mapfile, or a full path.
+.. index::
+ pair: IMAGECOLOR; MAP
+
IMAGECOLOR [r] [g] [b]
Color to initialize the map with (i.e. background color). When
transparency is enabled (*TRANSPARENT ON* in :ref:`OUTPUTFORMAT`)
@@ -246,6 +279,9 @@
.. _imagetype:
+.. index::
+ pair: IMAGETYPE; MAP
+
IMAGETYPE [gif|png|jpeg|wbmp|gtiff|swf|userdefined]
Output format to generate. See details in the :ref:`OUTPUTFORMAT`
section for available formats. The name here must match the 'NAME'
@@ -259,33 +295,54 @@
.. deprecated:: 4.6
+.. index::
+ pair: LAYER; MAP
+
:ref:`LAYER`
Signals the start of a :ref:`LAYER` object.
+.. index::
+ pair: LEGEND; MAP
+
:ref:`LEGEND`
Signals the start of a :ref:`LEGEND` object.
+.. index::
+ pair: MAXSIZE; MAP
+
MAXSIZE [integer]
Sets the maximum size of the map image. This will override the
default value. For example, setting this to 2048 means that you
can have up to 2048 pixels in both dimensions (i.e. max of
2048x2048). Default is 2048.
+.. index::
+ pair: NAME; MAP
+
NAME [name]
Prefix attached to map, scalebar and legend GIF filenames created
using this mapfile. It should be kept short.
+.. index::
+ pair: PROJECTION; MAP
+
:ref:`PROJECTION`
Signals the start of a :ref:`PROJECTION` object.
+.. index::
+ pair: QUERYMAP; MAP
+
:ref:`QUERYMAP`
Signals the start of a :ref:`QUERYMAP` object.
+.. index::
+ pair: REFERENCE; MAP
+
:ref:`REFERENCE`
Signals the start of a :ref:`REFERENCE` MAP object.
.. index::
- pair: RESOLUTION; MAP
+ pair: RESOLUTION; MAP
.. _resolution-parameter:
@@ -295,6 +352,9 @@
.. index::
pair: SCALEDENOM; MAP
+.. index::
+ pair: SCALEDENOM; MAP
+
SCALEDENOM [double]
Computed scale of the map. Set most often by the application.
Scale is given as the denominator of the actual scale fraction,
@@ -315,20 +375,35 @@
.. deprecated:: 5.0
+.. index::
+ pair: SCALEBAR; MAP
+
SCALEBAR
Signals the start of a :ref:`SCALEBAR` object.
+.. index::
+ pair: SHAPEPATH; MAP
+
SHAPEPATH [filename]
Path to the directory holding the shapefiles or tiles. There can
be further subdirectories under `SHAPEPATH`.
+.. index::
+ pair: SIZE; MAP
+
SIZE [x][y]
Size in pixels of the output image (i.e. the map).
+.. index::
+ pair: STATUS; MAP
+
STATUS [on|off]
Is the map active? Sometimes you may wish to turn this off to use
only the reference map or scale bar.
+.. index::
+ pair: SYMBOLSET; MAP
+
.. _SYMBOLSET:
SYMBOLSET [filename]
@@ -342,6 +417,12 @@
:ref:`SYMBOL`
Signals the start of a :ref:`SYMBOL` object.
+.. index::
+ pair: TEMPLATEPATTERN; MAP
+
+.. index::
+ pair: TEMPLATEPATTERN; MAP
+
.. _TEMPLATEPATTERN:
TEMPLATEPATTERN [regular expression]
@@ -360,10 +441,16 @@
Use *TRANSPARENT ON* in the :ref:`OUTPUTFORMAT`
declaration to specify if the output images should be transparent.
+.. index::
+ pair: UNITS; MAP
+
UNITS [feet|inches|kilometers|meters|miles|nauticalmiles|dd]
Units of the map coordinates. Used for scalebar and scale
computations. `Nauticalmiles` was added in MapServer 5.6.
+.. index::
+ pair: WEB; MAP
+
:ref:`WEB`
Signals the start of a :ref:`WEB` object.
More information about the mapserver-commits
mailing list