[mapserver-commits] r12105 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Aug 23 18:11:49 EDT 2011
Author: havatv
Date: 2011-08-23 15:11:49 -0700 (Tue, 23 Aug 2011)
New Revision: 12105
Modified:
branches/branch-6-0/docs/en/mapfile/label.txt
branches/branch-6-0/docs/en/mapfile/layer.txt
branches/branch-6-0/docs/en/mapfile/outputformat.txt
branches/branch-6-0/docs/en/mapfile/querymap.txt
branches/branch-6-0/docs/en/mapfile/scalebar.txt
branches/branch-6-0/docs/en/mapfile/style.txt
branches/branch-6-0/docs/en/mapfile/web.txt
trunk/docs/en/mapfile/label.txt
trunk/docs/en/mapfile/layer.txt
trunk/docs/en/mapfile/outputformat.txt
trunk/docs/en/mapfile/querymap.txt
trunk/docs/en/mapfile/scalebar.txt
trunk/docs/en/mapfile/style.txt
trunk/docs/en/mapfile/web.txt
Log:
Added indexes (#4001)
Modified: branches/branch-6-0/docs/en/mapfile/label.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/label.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/label.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,7 +1,8 @@
+.. index::
+ single: LABEL
+
.. _label:
-.. index:: LABEL
-
*****************************************************************************
LABEL
*****************************************************************************
Modified: branches/branch-6-0/docs/en/mapfile/layer.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/layer.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/layer.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -406,9 +406,6 @@
END
.. index::
- pair: LAYER;
-
-.. index::
pair: LAYER; MINGEOWIDTH
MINGEOWIDTH [double]
Modified: branches/branch-6-0/docs/en/mapfile/outputformat.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/outputformat.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/outputformat.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,8 +1,8 @@
-.. _outputformat:
-
.. index::
single: OUTPUTFORMAT
+.. _outputformat:
+
*****************************************************************************
OUTPUTFORMAT
*****************************************************************************
Modified: branches/branch-6-0/docs/en/mapfile/querymap.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/querymap.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/querymap.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,3 +1,6 @@
+.. index::
+ single: QUERYMAP
+
.. _querymap:
*****************************************************************************
@@ -4,17 +7,27 @@
QUERYMAP
*****************************************************************************
-.. index:: QUERYMAP
+.. index::
+ pair: QUERYMAP; COLOR
COLOR [r] [g] [b]
Color in which features are highlighted. Default is yellow.
+.. index::
+ pair: QUERYMAP; SIZE
+
SIZE [x][y]
Size of the map in pixels. Defaults to the size defined in the map object.
+.. index::
+ pair: QUERYMAP; STATUS
+
STATUS [on|off]
Is the query map to be drawn?
+.. index::
+ pair: QUERYMAP; STYLE
+
STYLE [normal|hilite|selected]
Sets how selected features are to be handled. Layers not queried are
drawn as usual.
@@ -22,4 +35,4 @@
* Normal: Draws all features according to the settings for that layer.
* Hilite: Draws selected features using COLOR. Non-selected features are
drawn normally.
- * Selected: draws only the selected features normally.
\ No newline at end of file
+ * Selected: draws only the selected features normally.
Modified: branches/branch-6-0/docs/en/mapfile/scalebar.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/scalebar.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/scalebar.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,5 +1,8 @@
.. _scalebar:
+.. index::
+ single: SCALEBAR
+
*****************************************************************************
SCALEBAR
*****************************************************************************
@@ -9,18 +12,30 @@
hard-code width and height in the <IMG> tag in the template file. Future
versions will make the image size available.
+.. index::
+ pair: SCALEBAR; ALIGN
+
ALIGN [left|center|right]
Defines how the scalebar is aligned within the scalebar image. Default
is center. Available in versions 5.2 and higher.
.. versionadded:: 5.2
+.. index::
+ pair: SCALEBAR; BACKGROUNDCOLOR
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for scalebar background, not the image background.
+.. index::
+ pair: SCALEBAR; COLOR
+
COLOR [r] [g] [b]
Color to use for drawing all features if attribute tables are not used.
+.. index::
+ pair: SCALEBAR; IMAGECOLOR
+
IMAGECOLOR [r] [g] [b]
Color to initialize the scalebar with (i.e. background).
@@ -31,32 +46,56 @@
.. deprecated:: 4.6
+.. index::
+ pair: SCALEBAR; INTERVALS
+
INTERVALS [integer]
Number of intervals to break the scalebar into. Default is 4.
-LABEL
- Signals the start of a :ref:`LABEL` object
+.. index::
+ pair: SCALEBAR; LABEL
+:ref:`LABEL`
+ Signals the start of a :ref:`LABEL` object.
+
+.. index::
+ pair: SCALEBAR; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b]
Color to use for outlining individual intervals. Set any component
to -1 for no outline which is the default.
+.. index::
+ pair: SCALEBAR; POSITION
+
POSITION [ul|uc|ur|ll|lc|lr]
Where to place an embedded scalebar in the image. Default is lr.
+.. index::
+ pair: SCALEBAR; POSTLABELCACHE
+
POSTLABELCACHE [true|false]
For use with embedded scalebars only. Tells the MapServer to embed the
scalebar after all labels in the cache have been drawn. Default is false.
+.. index::
+ pair: SCALEBAR; SIZE
+
SIZE [x][y]
Size in pixels of the scalebar. Labeling is not taken into account.
+.. index::
+ pair: SCALEBAR; STATUS
+
STATUS [on|off|embed]
Is the scalebar image to be created, and if so should it be embedded into
the image? Default is off. (Please note that embedding scalebars require
that you define a markerset. In essence the scalebar becomes a custom
marker that is handled just like any other annotation.)
+.. index::
+ pair: SCALEBAR; STYLE
+
STYLE [integer]
Chooses the scalebar style. Valid styles are 0 and 1.
@@ -67,6 +106,9 @@
.. deprecated:: 4.6
+.. index::
+ pair: SCALEBAR; UNITS
+
UNITS [feet|inches|kilometers|meters|miles|nauticalmiles]
Output scalebar units, default is miles. Used in conjunction with the
map's units to develop the actual graphic. Note that decimal degrees
Modified: branches/branch-6-0/docs/en/mapfile/style.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/style.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/style.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,3 +1,6 @@
+.. index::
+ single: STYLE
+
.. _style:
*****************************************************************************
@@ -13,6 +16,9 @@
way of defining the appearance of an object (a :ref:`CLASS` or a
:ref:`LABEL`).
+.. index::
+ pair: STYLE; ANGLE
+
ANGLE [double|attribute|AUTO]
Angle, given in degrees, to rotate the symbol (counter clockwise).
Default is 0 (no rotation). If you have an attribute that
@@ -69,14 +75,23 @@
.. deprecated:: 5.0
+.. index::
+ pair: STYLE; ANTIALIAS
+
ANTIALIAS [true|false]
Should TrueType fonts be antialiased. Only useful for GD (gif)
rendering. Default is false. Has no effect for the other
renderers (where anti-aliasing can not be turned off).
+.. index::
+ pair: STYLE; BACKGROUNDCOLOR
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for non-transparent symbols.
+.. index::
+ pair: STYLE; COLOR
+
COLOR [r] [g] [b] | [attribute]
- Color to use for drawing features. `r`, `g` and `b` shall be
@@ -98,6 +113,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: STYLE; GAP
+
GAP [double]
`GAP` specifies the distance between `SYMBOL`\s (center to center)
for decorated lines and polygon fills in layer `SIZEUNITS`. For
@@ -134,6 +152,9 @@
specify the center to center distance, but in version 6.0 it is
the amount of space between the symbols that is specified.
+.. index::
+ pair: STYLE; GEOMTRANSFORM
+
GEOMTRANSFORM [bbox|end|labelpnt|labelpoly|start|vertices]
Used to indicate that the current feature will be transformed
before the actual style is applied. Introduced in version 5.4.
@@ -153,18 +174,27 @@
used with `ANGLE` AUTO, the marker is oriented by the half angle
formed by the two adjacent line segments.
+.. index::
+ pair: STYLE; LINECAP
+
LINECAP [butt|round|square]
Sets the line cap type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; LINEJOIN
+
LINEJOIN [round|miter|bevel]
Sets the line join type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; LINEJOINMAXSIZE
+
LINEJOINMAXSIZE [int]
Sets the max length of the `miter` `LINEJOIN` type. The value
@@ -174,30 +204,45 @@
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; MAXSIZE
+
MAXSIZE [double]
Maximum size in pixels to draw a symbol. Default is 500. Starting
from version 5.4, the value can also be a decimal value (and not
only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; MAXWIDTH
+
MAXWIDTH [double]
Maximum width in pixels to draw the line work. Default is 32.
Starting from version 5.4, the value can also be a decimal value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; MINSIZE
+
MINSIZE [double]
Minimum size in pixels to draw a symbol. Default is 0. Starting
from version 5.4, the value can also be a decimal value (and not
only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; MINWIDTH
+
MINWIDTH [double]
Minimum width in pixels to draw the line work. Default is 0.
Starting from version 5.4, the value can also be a decimal value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; OFFSET
+
OFFSET [x][y]
Geometry offset values in layer `SIZEUNITS`.
@@ -214,6 +259,9 @@
along the direction of the line. A negative `n` shifts the line
to the left when seen along the direction of the line.
+.. index::
+ pair: STYLE; OPACITY
+
OPACITY [integer|attribute]
Opacity to draw the current style (applies to 5.2+, :ref:`AGG`
only, does not apply to pixmap symbols)
@@ -221,6 +269,9 @@
- [*attribute*] was introduced in version 5.6, to specify the
attribute to use for opacity values.
+.. index::
+ pair: STYLE; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b] | [attribute]
- Color to use for outlining polygons and certain marker symbols
@@ -247,6 +298,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: STYLE; PATTERN
+
PATTERN [double on] [double off] [double on] [double off] ... END
Currently used to defines a dash pattern for line work (lines,
@@ -272,6 +326,9 @@
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; SIZE
+
SIZE [double|attribute]
Height, in layer `SIZEUNITS`, of the symbol/pattern to be used.
@@ -313,6 +370,9 @@
.. deprecated:: 5.0
+.. index::
+ pair: STYLE; SYMBOL
+
SYMBOL [integer|string|filename|attribute]
The symbol name or number to use for all features if attribute
tables are not used. The number is the index of the symbol in the
@@ -329,6 +389,9 @@
[*attribute*] was introduced in version 5.6, to use an attribute
to specify the symbol name. The hard brackets [] are required.
+.. index::
+ pair: STYLE; WIDTH
+
WIDTH [double|attribute]
`WIDTH` refers to the thickness of line work drawn, in layer
Modified: branches/branch-6-0/docs/en/mapfile/web.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/web.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ branches/branch-6-0/docs/en/mapfile/web.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,3 +1,6 @@
+.. index::
+ single: WEB
+
.. _web:
*****************************************************************************
@@ -4,6 +7,9 @@
WEB
*****************************************************************************
+.. index::
+ pair: WEB; BROWSEFORMAT
+
BROWSEFORMAT [mime-type]
Format of the interface output, using MapServer CGI. *(added to MapServer 4.8.0)*
The default value is "text/html". Example:
@@ -12,30 +18,51 @@
BROWSEFORMAT "image/svg+xml"
+.. index::
+ pair: WEB; EMPTY
+
EMPTY [url]
URL to forward users to if a query fails. If not defined the value for
ERROR is used.
+.. index::
+ pair: WEB; ERROR
+
ERROR [url]
URL to forward users to if an error occurs. Ugly old MapServer error
messages will appear if this is not defined
+.. index::
+ pair: WEB; FOOTER
+
FOOTER [filename]
Template to use AFTER anything else is sent. Multiresult query modes only.
+.. index::
+ pair: WEB; HEADER
+
HEADER [filename]
Template to use BEFORE everything else has been sent. Multiresult query
modes only.
+.. index::
+ pair: WEB; IMAGEPATH
+
IMAGEPATH [path]
Path to the temporary directory fro writing temporary files and images.
Must be writable by the user the web server is running as. Must end
with a / or \ depending on your platform.
+.. index::
+ pair: WEB; IMAGEURL
+
IMAGEURL [path]
Base URL for IMAGEPATH. This is the URL that will take the web browser
to IMAGEPATH to get the images.
+.. index::
+ pair: WEB; LEGENDFORMAT
+
LEGENDFORMAT [mime-type]
Format of the legend output, using MapServer CGI. *(added to MapServer 4.8.0)*
The default value is "text/html". Example:
@@ -54,8 +81,8 @@
.. deprecated:: 5.0
.. index::
- pair: MAXSCALEDENOM; WEB
-
+ pair: WEB; MAXSCALEDENOM
+
MAXSCALEDENOM [double]
Minimum scale at which this interface is valid. When a user requests a map
at a smaller scale, MapServer automatically returns the map at this scale.
@@ -64,8 +91,10 @@
scale of 1:24,000 use 24000. Implemented in MapServer 5.0, to replace the
deprecated MAXSCALE parameter.
- .. deprecated:: 5.0
-
+ .. seealso::
+
+ :term:`Map scale`
+
MAXSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is MAXSCALEDENOM instead.
The deprecated MAXSCALE is the minimum scale at which this interface is
@@ -74,15 +103,19 @@
too far out. 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.
- .. seealso::
-
- :term:`Map scale`
+ .. deprecated:: 5.0
+.. index::
+ pair: WEB; MAXTEMPLATE
+
MAXTEMPLATE [file|url]
Template to be used if below the minimum scale for the app (the
denominator of the requested scale is larger than MAXSCALEDENOM),
useful for nesting apps.
+.. index::
+ pair: WEB; METADATA
+
METADATA
This keyword allows for arbitrary data to be stored as name value pairs.
This is used with OGC WMS to define things such as layer title. It can
@@ -98,8 +131,8 @@
END
.. index::
- pair: MINSCALEDENOM; WEB
-
+ pair: WEB; MINSCALEDENOM
+
MINSCALEDENOM [double]
Maximum scale at which this interface is valid. When a user reqests a
map at a larger scale, MapServer automatically returns the map at this
@@ -123,11 +156,17 @@
.. deprecated:: 5.0
+.. index::
+ pair: WEB; MINTEMPLATE
+
MINTEMPLATE
Template to be used if above the maximum scale for the app (the
denominator of the requested scale is smaller than MINSCALEDENOM),
useful for nesting apps.
+.. index::
+ pair: WEB; QUERYFORMAT
+
QUERYFORMAT [mime-type]
Format of the query output. *(added to MapServer 4.8.0)* This works for
mode=query (using query templates in CGI mode), but not for mode=browse.
@@ -137,12 +176,15 @@
QUERYFORMAT "image/svg+xml"
+.. index::
+ pair: WEB; TEMPLATE
+
TEMPLATE [filename|url]
Template file or URL to use in presenting the results to the user in an
interactive mode (i.e. map generates map and so on ... )
.. index::
- pair: VALIDATION; WEB
+ pair: WEB; VALIDATION
VALIDATION
Signals the start of a `VALIDATION` block.
Modified: trunk/docs/en/mapfile/label.txt
===================================================================
--- trunk/docs/en/mapfile/label.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/label.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,7 +1,8 @@
+.. index::
+ single: LABEL
+
.. _label:
-.. index:: LABEL
-
*****************************************************************************
LABEL
*****************************************************************************
Modified: trunk/docs/en/mapfile/layer.txt
===================================================================
--- trunk/docs/en/mapfile/layer.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/layer.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -406,9 +406,6 @@
END
.. index::
- pair: LAYER;
-
-.. index::
pair: LAYER; MINGEOWIDTH
MINGEOWIDTH [double]
Modified: trunk/docs/en/mapfile/outputformat.txt
===================================================================
--- trunk/docs/en/mapfile/outputformat.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/outputformat.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,8 +1,8 @@
-.. _outputformat:
-
.. index::
single: OUTPUTFORMAT
+.. _outputformat:
+
*****************************************************************************
OUTPUTFORMAT
*****************************************************************************
Modified: trunk/docs/en/mapfile/querymap.txt
===================================================================
--- trunk/docs/en/mapfile/querymap.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/querymap.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,3 +1,6 @@
+.. index::
+ single: QUERYMAP
+
.. _querymap:
*****************************************************************************
@@ -4,17 +7,27 @@
QUERYMAP
*****************************************************************************
-.. index:: QUERYMAP
+.. index::
+ pair: QUERYMAP; COLOR
COLOR [r] [g] [b]
Color in which features are highlighted. Default is yellow.
+.. index::
+ pair: QUERYMAP; SIZE
+
SIZE [x][y]
Size of the map in pixels. Defaults to the size defined in the map object.
+.. index::
+ pair: QUERYMAP; STATUS
+
STATUS [on|off]
Is the query map to be drawn?
+.. index::
+ pair: QUERYMAP; STYLE
+
STYLE [normal|hilite|selected]
Sets how selected features are to be handled. Layers not queried are
drawn as usual.
@@ -22,4 +35,4 @@
* Normal: Draws all features according to the settings for that layer.
* Hilite: Draws selected features using COLOR. Non-selected features are
drawn normally.
- * Selected: draws only the selected features normally.
\ No newline at end of file
+ * Selected: draws only the selected features normally.
Modified: trunk/docs/en/mapfile/scalebar.txt
===================================================================
--- trunk/docs/en/mapfile/scalebar.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/scalebar.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,5 +1,8 @@
.. _scalebar:
+.. index::
+ single: SCALEBAR
+
*****************************************************************************
SCALEBAR
*****************************************************************************
@@ -9,18 +12,30 @@
hard-code width and height in the <IMG> tag in the template file. Future
versions will make the image size available.
+.. index::
+ pair: SCALEBAR; ALIGN
+
ALIGN [left|center|right]
Defines how the scalebar is aligned within the scalebar image. Default
is center. Available in versions 5.2 and higher.
.. versionadded:: 5.2
+.. index::
+ pair: SCALEBAR; BACKGROUNDCOLOR
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for scalebar background, not the image background.
+.. index::
+ pair: SCALEBAR; COLOR
+
COLOR [r] [g] [b]
Color to use for drawing all features if attribute tables are not used.
+.. index::
+ pair: SCALEBAR; IMAGECOLOR
+
IMAGECOLOR [r] [g] [b]
Color to initialize the scalebar with (i.e. background).
@@ -31,32 +46,56 @@
.. deprecated:: 4.6
+.. index::
+ pair: SCALEBAR; INTERVALS
+
INTERVALS [integer]
Number of intervals to break the scalebar into. Default is 4.
-LABEL
- Signals the start of a :ref:`LABEL` object
+.. index::
+ pair: SCALEBAR; LABEL
+:ref:`LABEL`
+ Signals the start of a :ref:`LABEL` object.
+
+.. index::
+ pair: SCALEBAR; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b]
Color to use for outlining individual intervals. Set any component
to -1 for no outline which is the default.
+.. index::
+ pair: SCALEBAR; POSITION
+
POSITION [ul|uc|ur|ll|lc|lr]
Where to place an embedded scalebar in the image. Default is lr.
+.. index::
+ pair: SCALEBAR; POSTLABELCACHE
+
POSTLABELCACHE [true|false]
For use with embedded scalebars only. Tells the MapServer to embed the
scalebar after all labels in the cache have been drawn. Default is false.
+.. index::
+ pair: SCALEBAR; SIZE
+
SIZE [x][y]
Size in pixels of the scalebar. Labeling is not taken into account.
+.. index::
+ pair: SCALEBAR; STATUS
+
STATUS [on|off|embed]
Is the scalebar image to be created, and if so should it be embedded into
the image? Default is off. (Please note that embedding scalebars require
that you define a markerset. In essence the scalebar becomes a custom
marker that is handled just like any other annotation.)
+.. index::
+ pair: SCALEBAR; STYLE
+
STYLE [integer]
Chooses the scalebar style. Valid styles are 0 and 1.
@@ -67,6 +106,9 @@
.. deprecated:: 4.6
+.. index::
+ pair: SCALEBAR; UNITS
+
UNITS [feet|inches|kilometers|meters|miles|nauticalmiles]
Output scalebar units, default is miles. Used in conjunction with the
map's units to develop the actual graphic. Note that decimal degrees
Modified: trunk/docs/en/mapfile/style.txt
===================================================================
--- trunk/docs/en/mapfile/style.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/style.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,3 +1,6 @@
+.. index::
+ single: STYLE
+
.. _style:
*****************************************************************************
@@ -13,6 +16,9 @@
way of defining the appearance of an object (a :ref:`CLASS` or a
:ref:`LABEL`).
+.. index::
+ pair: STYLE; ANGLE
+
ANGLE [double|attribute|AUTO]
Angle, given in degrees, to rotate the symbol (counter clockwise).
Default is 0 (no rotation). If you have an attribute that
@@ -69,14 +75,23 @@
.. deprecated:: 5.0
+.. index::
+ pair: STYLE; ANTIALIAS
+
ANTIALIAS [true|false]
Should TrueType fonts be antialiased. Only useful for GD (gif)
rendering. Default is false. Has no effect for the other
renderers (where anti-aliasing can not be turned off).
+.. index::
+ pair: STYLE; BACKGROUNDCOLOR
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for non-transparent symbols.
+.. index::
+ pair: STYLE; COLOR
+
COLOR [r] [g] [b] | [attribute]
- Color to use for drawing features. `r`, `g` and `b` shall be
@@ -98,6 +113,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: STYLE; GAP
+
GAP [double]
`GAP` specifies the distance between `SYMBOL`\s (center to center)
for decorated lines and polygon fills in layer `SIZEUNITS`. For
@@ -134,6 +152,9 @@
specify the center to center distance, but in version 6.0 it is
the amount of space between the symbols that is specified.
+.. index::
+ pair: STYLE; GEOMTRANSFORM
+
GEOMTRANSFORM [bbox|end|labelpnt|labelpoly|start|vertices]
Used to indicate that the current feature will be transformed
before the actual style is applied. Introduced in version 5.4.
@@ -153,18 +174,27 @@
used with `ANGLE` AUTO, the marker is oriented by the half angle
formed by the two adjacent line segments.
+.. index::
+ pair: STYLE; LINECAP
+
LINECAP [butt|round|square]
Sets the line cap type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; LINEJOIN
+
LINEJOIN [round|miter|bevel]
Sets the line join type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; LINEJOINMAXSIZE
+
LINEJOINMAXSIZE [int]
Sets the max length of the `miter` `LINEJOIN` type. The value
@@ -174,30 +204,45 @@
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; MAXSIZE
+
MAXSIZE [double]
Maximum size in pixels to draw a symbol. Default is 500. Starting
from version 5.4, the value can also be a decimal value (and not
only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; MAXWIDTH
+
MAXWIDTH [double]
Maximum width in pixels to draw the line work. Default is 32.
Starting from version 5.4, the value can also be a decimal value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; MINSIZE
+
MINSIZE [double]
Minimum size in pixels to draw a symbol. Default is 0. Starting
from version 5.4, the value can also be a decimal value (and not
only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; MINWIDTH
+
MINWIDTH [double]
Minimum width in pixels to draw the line work. Default is 0.
Starting from version 5.4, the value can also be a decimal value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: STYLE; OFFSET
+
OFFSET [x][y]
Geometry offset values in layer `SIZEUNITS`.
@@ -214,6 +259,9 @@
along the direction of the line. A negative `n` shifts the line
to the left when seen along the direction of the line.
+.. index::
+ pair: STYLE; OPACITY
+
OPACITY [integer|attribute]
Opacity to draw the current style (applies to 5.2+, :ref:`AGG`
only, does not apply to pixmap symbols)
@@ -221,6 +269,9 @@
- [*attribute*] was introduced in version 5.6, to specify the
attribute to use for opacity values.
+.. index::
+ pair: STYLE; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b] | [attribute]
- Color to use for outlining polygons and certain marker symbols
@@ -247,6 +298,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: STYLE; PATTERN
+
PATTERN [double on] [double off] [double on] [double off] ... END
Currently used to defines a dash pattern for line work (lines,
@@ -272,6 +326,9 @@
.. versionadded:: 6.0 moved from :ref:`SYMBOL`
+.. index::
+ pair: STYLE; SIZE
+
SIZE [double|attribute]
Height, in layer `SIZEUNITS`, of the symbol/pattern to be used.
@@ -313,6 +370,9 @@
.. deprecated:: 5.0
+.. index::
+ pair: STYLE; SYMBOL
+
SYMBOL [integer|string|filename|attribute]
The symbol name or number to use for all features if attribute
tables are not used. The number is the index of the symbol in the
@@ -329,6 +389,9 @@
[*attribute*] was introduced in version 5.6, to use an attribute
to specify the symbol name. The hard brackets [] are required.
+.. index::
+ pair: STYLE; WIDTH
+
WIDTH [double|attribute]
`WIDTH` refers to the thickness of line work drawn, in layer
Modified: trunk/docs/en/mapfile/web.txt
===================================================================
--- trunk/docs/en/mapfile/web.txt 2011-08-23 16:37:37 UTC (rev 12104)
+++ trunk/docs/en/mapfile/web.txt 2011-08-23 22:11:49 UTC (rev 12105)
@@ -1,3 +1,6 @@
+.. index::
+ single: WEB
+
.. _web:
*****************************************************************************
@@ -4,6 +7,9 @@
WEB
*****************************************************************************
+.. index::
+ pair: WEB; BROWSEFORMAT
+
BROWSEFORMAT [mime-type]
Format of the interface output, using MapServer CGI. *(added to MapServer 4.8.0)*
The default value is "text/html". Example:
@@ -12,30 +18,51 @@
BROWSEFORMAT "image/svg+xml"
+.. index::
+ pair: WEB; EMPTY
+
EMPTY [url]
URL to forward users to if a query fails. If not defined the value for
ERROR is used.
+.. index::
+ pair: WEB; ERROR
+
ERROR [url]
URL to forward users to if an error occurs. Ugly old MapServer error
messages will appear if this is not defined
+.. index::
+ pair: WEB; FOOTER
+
FOOTER [filename]
Template to use AFTER anything else is sent. Multiresult query modes only.
+.. index::
+ pair: WEB; HEADER
+
HEADER [filename]
Template to use BEFORE everything else has been sent. Multiresult query
modes only.
+.. index::
+ pair: WEB; IMAGEPATH
+
IMAGEPATH [path]
Path to the temporary directory fro writing temporary files and images.
Must be writable by the user the web server is running as. Must end
with a / or \ depending on your platform.
+.. index::
+ pair: WEB; IMAGEURL
+
IMAGEURL [path]
Base URL for IMAGEPATH. This is the URL that will take the web browser
to IMAGEPATH to get the images.
+.. index::
+ pair: WEB; LEGENDFORMAT
+
LEGENDFORMAT [mime-type]
Format of the legend output, using MapServer CGI. *(added to MapServer 4.8.0)*
The default value is "text/html". Example:
@@ -54,8 +81,8 @@
.. deprecated:: 5.0
.. index::
- pair: MAXSCALEDENOM; WEB
-
+ pair: WEB; MAXSCALEDENOM
+
MAXSCALEDENOM [double]
Minimum scale at which this interface is valid. When a user requests a map
at a smaller scale, MapServer automatically returns the map at this scale.
@@ -64,8 +91,10 @@
scale of 1:24,000 use 24000. Implemented in MapServer 5.0, to replace the
deprecated MAXSCALE parameter.
- .. deprecated:: 5.0
-
+ .. seealso::
+
+ :term:`Map scale`
+
MAXSCALE [double] - deprecated
Since MapServer 5.0 the proper parameter to use is MAXSCALEDENOM instead.
The deprecated MAXSCALE is the minimum scale at which this interface is
@@ -74,15 +103,19 @@
too far out. 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.
- .. seealso::
-
- :term:`Map scale`
+ .. deprecated:: 5.0
+.. index::
+ pair: WEB; MAXTEMPLATE
+
MAXTEMPLATE [file|url]
Template to be used if below the minimum scale for the app (the
denominator of the requested scale is larger than MAXSCALEDENOM),
useful for nesting apps.
+.. index::
+ pair: WEB; METADATA
+
METADATA
This keyword allows for arbitrary data to be stored as name value pairs.
This is used with OGC WMS to define things such as layer title. It can
@@ -98,8 +131,8 @@
END
.. index::
- pair: MINSCALEDENOM; WEB
-
+ pair: WEB; MINSCALEDENOM
+
MINSCALEDENOM [double]
Maximum scale at which this interface is valid. When a user reqests a
map at a larger scale, MapServer automatically returns the map at this
@@ -123,11 +156,17 @@
.. deprecated:: 5.0
+.. index::
+ pair: WEB; MINTEMPLATE
+
MINTEMPLATE
Template to be used if above the maximum scale for the app (the
denominator of the requested scale is smaller than MINSCALEDENOM),
useful for nesting apps.
+.. index::
+ pair: WEB; QUERYFORMAT
+
QUERYFORMAT [mime-type]
Format of the query output. *(added to MapServer 4.8.0)* This works for
mode=query (using query templates in CGI mode), but not for mode=browse.
@@ -137,12 +176,15 @@
QUERYFORMAT "image/svg+xml"
+.. index::
+ pair: WEB; TEMPLATE
+
TEMPLATE [filename|url]
Template file or URL to use in presenting the results to the user in an
interactive mode (i.e. map generates map and so on ... )
.. index::
- pair: VALIDATION; WEB
+ pair: WEB; VALIDATION
VALIDATION
Signals the start of a `VALIDATION` block.
More information about the mapserver-commits
mailing list