[mapserver-commits] r12524 - branches/branch-6-0/docs/en/cgi trunk/docs/en/cgi

svn at osgeo.org svn at osgeo.org
Tue Sep 6 16:09:55 EDT 2011


Author: havatv
Date: 2011-09-06 13:09:55 -0700 (Tue, 06 Sep 2011)
New Revision: 12524

Modified:
   branches/branch-6-0/docs/en/cgi/controls.txt
   trunk/docs/en/cgi/controls.txt
Log:
Added index entries (#4001) - cgi controls.  Also fixed some sorting issues.

Modified: branches/branch-6-0/docs/en/cgi/controls.txt
===================================================================
--- branches/branch-6-0/docs/en/cgi/controls.txt	2011-09-06 19:37:54 UTC (rev 12523)
+++ branches/branch-6-0/docs/en/cgi/controls.txt	2011-09-06 20:09:55 UTC (rev 12524)
@@ -1,3 +1,6 @@
+.. index::
+   simple: CGI controls
+
 .. _cgi_controls:
 
 *****************************************************************************
@@ -8,23 +11,38 @@
 Variables
 =========
 
+.. index::
+   pair: CGI; buffer
+
 BUFFER [distance]
     A distance, in the same coordinate system as the map file, used in 
     conjunction with MAPXY to create an new map extent. 
 
+.. index::
+   pair: CGI; context
+
 CONTEXT [filename]
     Path to a context file. Path is relative to the map file to be used, or 
     can also be a URL path (See the section "Map Context Support Through 
     CGI" below for more details). 
 
+.. index::
+   pair: CGI; icon
+
 ICON [layername],[classindex]
     Used in MODE=legendicon to generate a legend icon for a layer.  The 
     class index value is optional and defaults to 0.
 
+.. index::
+   pair: CGI; id
+
 ID [id-string]
     By default MapServer generates a uniq session id based on system time 
     and process id. This parameter overwrites the default. 
 
+.. index::
+   pair: CGI; img
+
 IMG
     The name associated with the inline map image used to record user clicks. 
     What actually is passed are two variables, img.x and img.y.
@@ -32,14 +50,23 @@
     For the CGI Applications this is an essential variable, see the examples 
     for sample usage.
 
+.. index::
+   pair: CGI; imgbox
+
 IMGBOX [x1] [y1] [x2] [y2]
     Coordinates (in pixels) of a box drag in the image. Most often used in 
     conjunction with Java based front ends to the MapServer.
 
+.. index::
+   pair: CGI; imgext
+
 IMGEXT [minx] [miny] [maxx] [maxy]
     The spatial extent of the existing inline image, that is, the image the 
     users can see in their browser.
 
+.. index::
+   pair: CGI; imgshape
+
 IMGSHAPE [x1 y1 x2 y2 x3 y3 ...] | [WKT]
     An arbitrary polygon shape (specified using **image coordinates**)
     to be used for query purposes.
@@ -51,17 +78,29 @@
 
     Used with modes NQUERY and NQUERYMAP. 
 
+.. index::
+   pair: CGI; imgsize
+
 IMGSIZE [cols] [rows]
     The size (in pixels) of the exiting inline image.
 
+.. index::
+   pair: CGI; imgxy
+
 IMGXY [x] [y]
     Coordinates (in pixels) of a single mouse click. Used most often in 
     conjunction with Java based front ends to the MapServer.
 
+.. index::
+   pair: CGI; layer
+
 LAYER [name]
     The name of a layer as it appears in the map file. Sending mapserv a layer 
     name sets that layer's STATUS to ON.
 
+.. index::
+   pair: CGI; layers
+
 LAYERS [name name ...]
     The names of the layers to be turned on. Layer names must be seperated by 
     spaces.
@@ -69,18 +108,23 @@
     Version 4.4 and above: passing 'LAYERS=all' will automatically turn on all 
     layers.
 
+.. index::
+   pair: CGI; map
+
 MAP [filename]
     Path, relative to the CGI directory, of the map file to be used.
 
+.. index::
+   pair: CGI; mapext
+
 MAPEXT [minx] [miny] [maxx] [maxy] , MAPEXT (shape)
     The spatial extent of the map to be created.
 
     Can be set to shape as an alternative option. In this case mapextent is 
     set to the extent of a selected shape. Used with queries. 
 
-MAPSIZE [cols] [rows]
-    The size (in pixels) of the image to be created. Useful for allowing users 
-    to change the resolution of the output map dynamically.
+.. index::
+   pair: CGI; mapshape
 
 MAPSHAPE [x1 y1 x2 y2 x3 y3 ...] | [WKT]
     An arbitrary polygon shape (specified using **map coordinates**)
@@ -93,6 +137,16 @@
 
     Used with modes NQUERY and NQUERYMAP.
 
+.. index::
+   pair: CGI; mapsize
+
+MAPSIZE [cols] [rows]
+    The size (in pixels) of the image to be created. Useful for allowing users 
+    to change the resolution of the output map dynamically.
+
+.. index::
+   pair: CGI; mapxy
+
 MAPXY [x] [y] , MAPXY (shape)
     A point, in the same coordinate system as the shapefiles, to be used in 
     conjuction with a buffer or a scale to construct a map extent.
@@ -100,54 +154,100 @@
     Can be set to shape as an alternative option. In this case mapextent is 
     set to the extent of a selected shape. Used with queries. 
 
+.. index::
+   pair: CGI; minx
+
+.. index::
+   pair: CGI; miny
+
+.. index::
+   pair: CGI; maxx
+
+.. index::
+   pair: CGI; maxy
+
 MINX | MINY | MAXX | MAXY [number]
     Minimum/Maximum x/y coordinate of the spatial extent for a new map/query. 
     This set of parameters are the pieces of MAPEXT.
 
+.. index::
+   pair: CGI; mode
+
 MODE [value]
     Mode of operation. The following options are supported (note that all of 
     the query modes also support map-only modes, e.g. ITEMQUERYMAP, which 
     for brevity are not all listed):
 
+    .. index::
+       triple: CGI; mode; browse
+
     BROWSE
         Fully interactive interface where maps (and interactive pages) are 
         created. This is the default mode. 
 
-    QUERY
-        A spatial search (finds closest) is triggered by a click in a map.
+    .. index::
+       triple: CGI; mode; featurenquery
 
-    NQUERY
-        A spatial search (finds all) is triggered by a click in a map or by 
-        user-define selection box.
+    FEATURENQUERY
+        A spatial search that uses multiple features from SLAYER to query 
+        other layers.
 
-    ITEMQUERY
-        A text search of attribute data is triggered using a layer QSTRING. 
-        Returns 1st match.
+    .. index::
+       triple: CGI; mode; featurequery
 
-    ITEMNQUERY
-        A text search of attribute data is triggered using a QSTRING. 
-        Returns all matches.
-
     FEATUREQUERY
         A spatial search that uses one feature from SLAYER to query other 
         layers.
 
-    FEATURENQUERY
-        A spatial search that uses multiple features from SLAYER to query 
-        other layers.
+    .. index::
+       triple: CGI; mode; indexquery
 
-    ITEMFEATUREQUERY
+    INDEXQUERY
+        Looks up a feature based on the values of SHAPEINDEX and TILEINDEX 
+        parameters. SHAPEINDEX is required, TILEINDEX is optional and is only 
+        used with tiled shapefile layers. 
+
+    .. index::
+       triple: CGI; mode; itemfeaturenquery
+
+    ITEMFEATURENQUERY
         A text search of attribute data is triggered using a QSTRING. Returns 
-        first match. Layer to be searched is defined using slayer parameter. 
+        all matches. Layer to be searched is defined using slayer parameter. 
         The results of this search are applied to other searchable layers 
         (which can be limited using the QLAYER parameter).
 
-    ITEMFEATURENQUERY
+    .. index::
+       triple: CGI; mode; itemfeaturequery
+
+    ITEMFEATUREQUERY
         A text search of attribute data is triggered using a QSTRING. Returns 
-        all matches. Layer to be searched is defined using slayer parameter. 
+        first match. Layer to be searched is defined using slayer parameter. 
         The results of this search are applied to other searchable layers 
         (which can be limited using the QLAYER parameter).
 
+    .. index::
+       triple: CGI; mode; itemnquery
+
+    ITEMNQUERY
+        A text search of attribute data is triggered using a QSTRING. 
+        Returns all matches.
+
+    .. index::
+       triple: CGI; mode; itemquery
+
+    ITEMQUERY
+        A text search of attribute data is triggered using a layer QSTRING. 
+        Returns 1st match.
+
+    .. index::
+       triple: CGI; mode; legend
+
+    LEGEND
+        The created legend is returned. Used within an <img ... > tag. 
+
+    .. index::
+       triple: CGI; mode; legendicon
+
     LEGENDICON
         A legend icon is returned.  The ICON parameter must also be used
         to specify the layername and a class index.  Class index value is 
@@ -157,44 +257,79 @@
 
           mapserv.exe?map=/ms4w/apps/gmap/htdocs/gmap75.map&MODE=legendicon&ICON=popplace,0
 
+    .. index::
+       triple: CGI; mode; map
+
     MAP
         The created map is returned. Used within an <img ... > tag. 
 
+    .. index::
+       triple: CGI; mode; nquery
+
+    NQUERY
+        A spatial search (finds all) is triggered by a click in a map or by 
+        user-define selection box.
+
+    .. index::
+       triple: CGI; mode; query
+
+    QUERY
+        A spatial search (finds closest) is triggered by a click in a map.
+
+    .. index::
+       triple: CGI; mode; reference
+
     REFERENCE
         The created reference map is returned. Used within an <img ... > tag. 
 
+    .. index::
+       triple: CGI; mode; scalebar
+
     SCALEBAR
         The created scalebar is returned. Used within an <img ... > tag. 
 
-    LEGEND
-        The created legend is returned. Used within an <img ... > tag. 
+    .. index::
+       triple: CGI; mode; zoomin
 
     ZOOMIN
         Switch to mode BROWSE with ZOOMDIR=1 
 
+    .. index::
+       triple: CGI; mode; zoomout
+
     ZOOMOUT
         Switch to mode BROWSE with ZOOMDIR=-1 
 
-    INDEXQUERY
-        Looks up a feature based on the values of SHAPEINDEX and TILEINDEX 
-        parameters. SHAPEINDEX is required, TILEINDEX is optional and is only 
-        used with tiled shapefile layers. 
+    .. index::
+       triple: CGI; mode; coordinate
 
     COORDINATE
         To be clarified. 
 
-QLAYER [name]
-    Query layer. The name of the layer to be queried as it appears in the map 
-    file. If not specified then all layers are searched in turn.
+.. index::
+   pair: CGI; qitem
 
 QITEM [name] (optional)
     The name of an attribute in a layer attribute table to query on. The 
     parameter is optional and used in conjunction with the QSTRING for 
     attribute queries. 
 
+.. index::
+   pair: CGI; qlayer
+
+QLAYER [name]
+    Query layer. The name of the layer to be queried as it appears in the map 
+    file. If not specified then all layers are searched in turn.
+
+.. index::
+   pair: CGI; qstring
+
 QSTRING [expression]
     Attribute queries: Query string passed to the query function. 
 
+.. index::
+   pair: CGI; queryfile
+
 QUERYFILE [filename]
     Used with BROWSE or NQUERY mode. This option identifies a query file to 
     load before any regular processing. In BROWSE mode this result in a query 
@@ -204,6 +339,9 @@
     so you have access to query maps AND attribute information. 
     See the SAVEQUERY option.
 
+.. index::
+   pair: CGI; ref
+
 REF
     The name associated with the inline reference map image used to record 
     user clicks. What actually is passed are two variables, ref.x and ref.y.
@@ -211,15 +349,24 @@
     For the CGI Applications this is an essential variable when reference 
     maps are used, see the examples for sample usage. 
 
+.. index::
+   pair: CGI; refxy
+
 REFXY [x] [y]
     Coordinates (in pixels) of a single mouse click in the reference image. 
     Used in conjunction with Java based front ends to the MapServer. 
 
+.. index::
+   pair: CGI; savequery
+
 SAVEQUERY
     When used with any of the query modes this tells the MapServer to save the 
     query results to a temporary file for use in subsequent operations 
     (see QUERYFILE). Useful for making queries persistent.
 
+.. index::
+   pair: CGI; scaledenom
+
 SCALEDENOM [number]
     Scale to create a new map at. Used with mapxy. Scale is given as the
     denominator of the actual scale fraction, for example for a map at a scale
@@ -232,6 +379,9 @@
     with mapxy. 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.
 
+.. index::
+   pair: CGI; searchmap
+
 SEARCHMAP
     It is possible to do pan/zoom interfaces using querymaps. In these cases 
     you will likey want information about the contents of the new map rather 
@@ -239,18 +389,30 @@
     searchmap is specified the new map is created and it's extent is used 
     to query layers. Useful with NQUERY mode only.
 
+.. index::
+   pair: CGI; shapeindex
+
 SHAPEINDEX [index]
     Used for index queries (in conjunction with INDEXQUERY). 
 
+.. index::
+   pair: CGI; slayer
+
 SLAYER [name]
     Select layer. The name of the layer to be used for any of the feature 
     (i.e. staged) query modes. The select layer must be a polygon layer. The 
     selection feature(s) are available for presentation to the user.
 
+.. index::
+   pair: CGI; tileindex
+
 TILEINDEX [index]
     Used for index queries (in conjunction with INDEXQUERY), used with tiled 
     shapefile layers. 
 
+.. index::
+   pair: CGI; zoom
+
 ZOOM [number]
     Zoom scaling to apply to the creation of the new map. Values greater than 
     0 resulting in zooming in, 0 is a pan, and values less than zero are for 
@@ -260,14 +422,24 @@
     The zoom is limited by the MINZOOM/MAXZOOM settings compiled into the 
     MapServer (-25/25) by default.
 
+.. index::
+   pair: CGI; zoomdir
+
 ZOOMDIR [1 | 0 | -1]
     Direction to zoom. See above. 
 
+.. index::
+   pair: CGI; zoomsize
+
 ZOOMSIZE [number]
     Absolute magnitude of a zoom. Used with ZOOMDIR.
 
     ZOOMDIR is limited to MAXZOOM compiled into the MapServer (25 by default).
 
+
+.. index::
+   single: Change map file parameters  
+
 Changing map file parameters via a form or a URL
 ================================================
 
@@ -356,6 +528,9 @@
 feature. You can repeat the process to create additional features. This is 
 really intended for very small (point, rectangle) amounts of data.
 
+.. index::
+   single: Apache variables  
+
 Specifying the location of mapfiles using an Apache variables
 =============================================================
 
@@ -377,6 +552,9 @@
 
 
 
+.. index::
+   single: ROSA-Applet controls  
+
 ROSA-Applet Controls
 ====================
 

Modified: trunk/docs/en/cgi/controls.txt
===================================================================
--- trunk/docs/en/cgi/controls.txt	2011-09-06 19:37:54 UTC (rev 12523)
+++ trunk/docs/en/cgi/controls.txt	2011-09-06 20:09:55 UTC (rev 12524)
@@ -1,3 +1,6 @@
+.. index::
+   simple: CGI controls
+
 .. _cgi_controls:
 
 *****************************************************************************
@@ -8,23 +11,38 @@
 Variables
 =========
 
+.. index::
+   pair: CGI; buffer
+
 BUFFER [distance]
     A distance, in the same coordinate system as the map file, used in 
     conjunction with MAPXY to create an new map extent. 
 
+.. index::
+   pair: CGI; context
+
 CONTEXT [filename]
     Path to a context file. Path is relative to the map file to be used, or 
     can also be a URL path (See the section "Map Context Support Through 
     CGI" below for more details). 
 
+.. index::
+   pair: CGI; icon
+
 ICON [layername],[classindex]
     Used in MODE=legendicon to generate a legend icon for a layer.  The 
     class index value is optional and defaults to 0.
 
+.. index::
+   pair: CGI; id
+
 ID [id-string]
     By default MapServer generates a uniq session id based on system time 
     and process id. This parameter overwrites the default. 
 
+.. index::
+   pair: CGI; img
+
 IMG
     The name associated with the inline map image used to record user clicks. 
     What actually is passed are two variables, img.x and img.y.
@@ -32,14 +50,23 @@
     For the CGI Applications this is an essential variable, see the examples 
     for sample usage.
 
+.. index::
+   pair: CGI; imgbox
+
 IMGBOX [x1] [y1] [x2] [y2]
     Coordinates (in pixels) of a box drag in the image. Most often used in 
     conjunction with Java based front ends to the MapServer.
 
+.. index::
+   pair: CGI; imgext
+
 IMGEXT [minx] [miny] [maxx] [maxy]
     The spatial extent of the existing inline image, that is, the image the 
     users can see in their browser.
 
+.. index::
+   pair: CGI; imgshape
+
 IMGSHAPE [x1 y1 x2 y2 x3 y3 ...] | [WKT]
     An arbitrary polygon shape (specified using **image coordinates**)
     to be used for query purposes.
@@ -51,17 +78,29 @@
 
     Used with modes NQUERY and NQUERYMAP. 
 
+.. index::
+   pair: CGI; imgsize
+
 IMGSIZE [cols] [rows]
     The size (in pixels) of the exiting inline image.
 
+.. index::
+   pair: CGI; imgxy
+
 IMGXY [x] [y]
     Coordinates (in pixels) of a single mouse click. Used most often in 
     conjunction with Java based front ends to the MapServer.
 
+.. index::
+   pair: CGI; layer
+
 LAYER [name]
     The name of a layer as it appears in the map file. Sending mapserv a layer 
     name sets that layer's STATUS to ON.
 
+.. index::
+   pair: CGI; layers
+
 LAYERS [name name ...]
     The names of the layers to be turned on. Layer names must be seperated by 
     spaces.
@@ -69,18 +108,23 @@
     Version 4.4 and above: passing 'LAYERS=all' will automatically turn on all 
     layers.
 
+.. index::
+   pair: CGI; map
+
 MAP [filename]
     Path, relative to the CGI directory, of the map file to be used.
 
+.. index::
+   pair: CGI; mapext
+
 MAPEXT [minx] [miny] [maxx] [maxy] , MAPEXT (shape)
     The spatial extent of the map to be created.
 
     Can be set to shape as an alternative option. In this case mapextent is 
     set to the extent of a selected shape. Used with queries. 
 
-MAPSIZE [cols] [rows]
-    The size (in pixels) of the image to be created. Useful for allowing users 
-    to change the resolution of the output map dynamically.
+.. index::
+   pair: CGI; mapshape
 
 MAPSHAPE [x1 y1 x2 y2 x3 y3 ...] | [WKT]
     An arbitrary polygon shape (specified using **map coordinates**)
@@ -93,6 +137,16 @@
 
     Used with modes NQUERY and NQUERYMAP.
 
+.. index::
+   pair: CGI; mapsize
+
+MAPSIZE [cols] [rows]
+    The size (in pixels) of the image to be created. Useful for allowing users 
+    to change the resolution of the output map dynamically.
+
+.. index::
+   pair: CGI; mapxy
+
 MAPXY [x] [y] , MAPXY (shape)
     A point, in the same coordinate system as the shapefiles, to be used in 
     conjuction with a buffer or a scale to construct a map extent.
@@ -100,54 +154,100 @@
     Can be set to shape as an alternative option. In this case mapextent is 
     set to the extent of a selected shape. Used with queries. 
 
+.. index::
+   pair: CGI; minx
+
+.. index::
+   pair: CGI; miny
+
+.. index::
+   pair: CGI; maxx
+
+.. index::
+   pair: CGI; maxy
+
 MINX | MINY | MAXX | MAXY [number]
     Minimum/Maximum x/y coordinate of the spatial extent for a new map/query. 
     This set of parameters are the pieces of MAPEXT.
 
+.. index::
+   pair: CGI; mode
+
 MODE [value]
     Mode of operation. The following options are supported (note that all of 
     the query modes also support map-only modes, e.g. ITEMQUERYMAP, which 
     for brevity are not all listed):
 
+    .. index::
+       triple: CGI; mode; browse
+
     BROWSE
         Fully interactive interface where maps (and interactive pages) are 
         created. This is the default mode. 
 
-    QUERY
-        A spatial search (finds closest) is triggered by a click in a map.
+    .. index::
+       triple: CGI; mode; featurenquery
 
-    NQUERY
-        A spatial search (finds all) is triggered by a click in a map or by 
-        user-define selection box.
+    FEATURENQUERY
+        A spatial search that uses multiple features from SLAYER to query 
+        other layers.
 
-    ITEMQUERY
-        A text search of attribute data is triggered using a layer QSTRING. 
-        Returns 1st match.
+    .. index::
+       triple: CGI; mode; featurequery
 
-    ITEMNQUERY
-        A text search of attribute data is triggered using a QSTRING. 
-        Returns all matches.
-
     FEATUREQUERY
         A spatial search that uses one feature from SLAYER to query other 
         layers.
 
-    FEATURENQUERY
-        A spatial search that uses multiple features from SLAYER to query 
-        other layers.
+    .. index::
+       triple: CGI; mode; indexquery
 
-    ITEMFEATUREQUERY
+    INDEXQUERY
+        Looks up a feature based on the values of SHAPEINDEX and TILEINDEX 
+        parameters. SHAPEINDEX is required, TILEINDEX is optional and is only 
+        used with tiled shapefile layers. 
+
+    .. index::
+       triple: CGI; mode; itemfeaturenquery
+
+    ITEMFEATURENQUERY
         A text search of attribute data is triggered using a QSTRING. Returns 
-        first match. Layer to be searched is defined using slayer parameter. 
+        all matches. Layer to be searched is defined using slayer parameter. 
         The results of this search are applied to other searchable layers 
         (which can be limited using the QLAYER parameter).
 
-    ITEMFEATURENQUERY
+    .. index::
+       triple: CGI; mode; itemfeaturequery
+
+    ITEMFEATUREQUERY
         A text search of attribute data is triggered using a QSTRING. Returns 
-        all matches. Layer to be searched is defined using slayer parameter. 
+        first match. Layer to be searched is defined using slayer parameter. 
         The results of this search are applied to other searchable layers 
         (which can be limited using the QLAYER parameter).
 
+    .. index::
+       triple: CGI; mode; itemnquery
+
+    ITEMNQUERY
+        A text search of attribute data is triggered using a QSTRING. 
+        Returns all matches.
+
+    .. index::
+       triple: CGI; mode; itemquery
+
+    ITEMQUERY
+        A text search of attribute data is triggered using a layer QSTRING. 
+        Returns 1st match.
+
+    .. index::
+       triple: CGI; mode; legend
+
+    LEGEND
+        The created legend is returned. Used within an <img ... > tag. 
+
+    .. index::
+       triple: CGI; mode; legendicon
+
     LEGENDICON
         A legend icon is returned.  The ICON parameter must also be used
         to specify the layername and a class index.  Class index value is 
@@ -157,44 +257,79 @@
 
           mapserv.exe?map=/ms4w/apps/gmap/htdocs/gmap75.map&MODE=legendicon&ICON=popplace,0
 
+    .. index::
+       triple: CGI; mode; map
+
     MAP
         The created map is returned. Used within an <img ... > tag. 
 
+    .. index::
+       triple: CGI; mode; nquery
+
+    NQUERY
+        A spatial search (finds all) is triggered by a click in a map or by 
+        user-define selection box.
+
+    .. index::
+       triple: CGI; mode; query
+
+    QUERY
+        A spatial search (finds closest) is triggered by a click in a map.
+
+    .. index::
+       triple: CGI; mode; reference
+
     REFERENCE
         The created reference map is returned. Used within an <img ... > tag. 
 
+    .. index::
+       triple: CGI; mode; scalebar
+
     SCALEBAR
         The created scalebar is returned. Used within an <img ... > tag. 
 
-    LEGEND
-        The created legend is returned. Used within an <img ... > tag. 
+    .. index::
+       triple: CGI; mode; zoomin
 
     ZOOMIN
         Switch to mode BROWSE with ZOOMDIR=1 
 
+    .. index::
+       triple: CGI; mode; zoomout
+
     ZOOMOUT
         Switch to mode BROWSE with ZOOMDIR=-1 
 
-    INDEXQUERY
-        Looks up a feature based on the values of SHAPEINDEX and TILEINDEX 
-        parameters. SHAPEINDEX is required, TILEINDEX is optional and is only 
-        used with tiled shapefile layers. 
+    .. index::
+       triple: CGI; mode; coordinate
 
     COORDINATE
         To be clarified. 
 
-QLAYER [name]
-    Query layer. The name of the layer to be queried as it appears in the map 
-    file. If not specified then all layers are searched in turn.
+.. index::
+   pair: CGI; qitem
 
 QITEM [name] (optional)
     The name of an attribute in a layer attribute table to query on. The 
     parameter is optional and used in conjunction with the QSTRING for 
     attribute queries. 
 
+.. index::
+   pair: CGI; qlayer
+
+QLAYER [name]
+    Query layer. The name of the layer to be queried as it appears in the map 
+    file. If not specified then all layers are searched in turn.
+
+.. index::
+   pair: CGI; qstring
+
 QSTRING [expression]
     Attribute queries: Query string passed to the query function. 
 
+.. index::
+   pair: CGI; queryfile
+
 QUERYFILE [filename]
     Used with BROWSE or NQUERY mode. This option identifies a query file to 
     load before any regular processing. In BROWSE mode this result in a query 
@@ -204,6 +339,9 @@
     so you have access to query maps AND attribute information. 
     See the SAVEQUERY option.
 
+.. index::
+   pair: CGI; ref
+
 REF
     The name associated with the inline reference map image used to record 
     user clicks. What actually is passed are two variables, ref.x and ref.y.
@@ -211,15 +349,24 @@
     For the CGI Applications this is an essential variable when reference 
     maps are used, see the examples for sample usage. 
 
+.. index::
+   pair: CGI; refxy
+
 REFXY [x] [y]
     Coordinates (in pixels) of a single mouse click in the reference image. 
     Used in conjunction with Java based front ends to the MapServer. 
 
+.. index::
+   pair: CGI; savequery
+
 SAVEQUERY
     When used with any of the query modes this tells the MapServer to save the 
     query results to a temporary file for use in subsequent operations 
     (see QUERYFILE). Useful for making queries persistent.
 
+.. index::
+   pair: CGI; scaledenom
+
 SCALEDENOM [number]
     Scale to create a new map at. Used with mapxy. Scale is given as the
     denominator of the actual scale fraction, for example for a map at a scale
@@ -232,6 +379,9 @@
     with mapxy. 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.
 
+.. index::
+   pair: CGI; searchmap
+
 SEARCHMAP
     It is possible to do pan/zoom interfaces using querymaps. In these cases 
     you will likey want information about the contents of the new map rather 
@@ -239,18 +389,30 @@
     searchmap is specified the new map is created and it's extent is used 
     to query layers. Useful with NQUERY mode only.
 
+.. index::
+   pair: CGI; shapeindex
+
 SHAPEINDEX [index]
     Used for index queries (in conjunction with INDEXQUERY). 
 
+.. index::
+   pair: CGI; slayer
+
 SLAYER [name]
     Select layer. The name of the layer to be used for any of the feature 
     (i.e. staged) query modes. The select layer must be a polygon layer. The 
     selection feature(s) are available for presentation to the user.
 
+.. index::
+   pair: CGI; tileindex
+
 TILEINDEX [index]
     Used for index queries (in conjunction with INDEXQUERY), used with tiled 
     shapefile layers. 
 
+.. index::
+   pair: CGI; zoom
+
 ZOOM [number]
     Zoom scaling to apply to the creation of the new map. Values greater than 
     0 resulting in zooming in, 0 is a pan, and values less than zero are for 
@@ -260,14 +422,24 @@
     The zoom is limited by the MINZOOM/MAXZOOM settings compiled into the 
     MapServer (-25/25) by default.
 
+.. index::
+   pair: CGI; zoomdir
+
 ZOOMDIR [1 | 0 | -1]
     Direction to zoom. See above. 
 
+.. index::
+   pair: CGI; zoomsize
+
 ZOOMSIZE [number]
     Absolute magnitude of a zoom. Used with ZOOMDIR.
 
     ZOOMDIR is limited to MAXZOOM compiled into the MapServer (25 by default).
 
+
+.. index::
+   single: Change map file parameters  
+
 Changing map file parameters via a form or a URL
 ================================================
 
@@ -356,6 +528,9 @@
 feature. You can repeat the process to create additional features. This is 
 really intended for very small (point, rectangle) amounts of data.
 
+.. index::
+   single: Apache variables  
+
 Specifying the location of mapfiles using an Apache variables
 =============================================================
 
@@ -377,6 +552,9 @@
 
 
 
+.. index::
+   single: ROSA-Applet controls  
+
 ROSA-Applet Controls
 ====================
 



More information about the mapserver-commits mailing list