[mapserver-commits] r12090 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Aug 23 08:24:06 EDT 2011
Author: havatv
Date: 2011-08-23 05:24:06 -0700 (Tue, 23 Aug 2011)
New Revision: 12090
Modified:
branches/branch-6-0/docs/en/mapfile/class.txt
trunk/docs/en/mapfile/class.txt
Log:
Added indexes (#4001)
Modified: branches/branch-6-0/docs/en/mapfile/class.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/class.txt 2011-08-23 12:14:50 UTC (rev 12089)
+++ branches/branch-6-0/docs/en/mapfile/class.txt 2011-08-23 12:24:06 UTC (rev 12090)
@@ -4,14 +4,20 @@
CLASS
*****************************************************************************
+.. index::
+ pair: CLASS; BACKGROUNDCOLOR
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for non-transparent symbols.
+.. index::
+ pair: CLASS; COLOR
+
COLOR [r] [g] [b]
Color to use for drawing features.
.. index::
- pair: DEBUG; CLASS
+ pair: CLASS; DEBUG
DEBUG [on|off]
Enables debugging of the class object. Verbose output is generated
@@ -24,7 +30,7 @@
:ref:`rfc28`
.. index::
- pair: EXPRESSION; CLASS
+ pair: CLASS; EXPRESSION
EXPRESSION [string]
@@ -73,7 +79,7 @@
types within the different classes of a layer.
.. index::
- pair: GROUP; CLASS
+ pair: CLASS; GROUP
GROUP [string]
Allows for grouping of classes. It is only used when a
@@ -108,7 +114,7 @@
.. index::
- pair: KEYIMAGE; CLASS
+ pair: CLASS; KEYIMAGE
.. _KEYIMAGE:
@@ -117,11 +123,14 @@
is used when building a legend (or requesting a legend icon via
MapScript or the :ref:`CGI application <cgi>`).
+.. index::
+ pair: CLASS; LABEL
+
:ref:`LABEL`
Signals the start of a :ref:`LABEL` object.
.. index::
- pair: MAXSCALEDENOM; CLASS
+ pair: CLASS; MAXSCALEDENOM
MAXSCALEDENOM [double]
Minimum scale at which this :ref:`CLASS` is drawn. Scale is given
@@ -142,12 +151,15 @@
.. deprecated:: 5.0
+.. index::
+ pair: CLASS; MAXSIZE
+
MAXSIZE [integer]
Maximum size in pixels to draw a symbol. Default is 50.
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
.. index::
- pair: MINSCALEDENOM; CLASS
+ pair: CLASS; MINSCALEDENOM
MINSCALEDENOM [double]
Maximum scale at which this :ref:`CLASS` is drawn. Scale is given
@@ -168,18 +180,30 @@
.. deprecated:: 5.0
+.. index::
+ pair: CLASS; MINSIZE
+
MINSIZE [integer]
Minimum size in pixels to draw a symbol. Default is 0.
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: CLASS; NAME
+
NAME [string]
Name to use in legends for this class. If not set class won't show
up in legend.
+.. index::
+ pair: CLASS; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b]
Color to use for outlining polygons and certain marker
symbols. Line symbols do not support outline colors.
+.. index::
+ pair: CLASS; SIZE
+
SIZE [integer]
Height, in pixels, of the symbol/pattern to be used. Only useful
with scalable symbols. For `vector` (and `ellipse`) :ref:`SYMBOL`
@@ -188,16 +212,25 @@
default is the vertical size of the image. Default size is 1 for
TTF symbols.
+.. index::
+ pair: CLASS; STATUS
+
STATUS [on|off]
Sets the current display status of the class. Default turns the
class on.
+.. index::
+ pair: CLASS; STYLE
+
:ref:`STYLE`
Signals the start of a :ref:`STYLE` object. A class can contain
multiple styles. Multiple styles can be used create complex
symbols (by overlay/stacking). See :ref:`sym_construction` for
more information on advanced symbol construction.
+.. index::
+ pair: CLASS; SYMBOL
+
:ref:`SYMBOL` [integer|string|filename]
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
@@ -214,10 +247,16 @@
See :ref:`sym_construction` for more information on advanced
symbol construction.
+.. index::
+ pair: CLASS; TEMPLATE
+
:ref:`TEMPLATE <template>` [filename]
Template file or URL to use in presenting query results to the
user. See :ref:`template` for more info.
+.. index::
+ pair: CLASS; TEXT
+
TEXT [string]
Static text to label features in this class with. This overrides
values obtained from the `LABELITEM`. The string may be given as
@@ -230,6 +269,20 @@
TEXT '[FIRSTNAME] [LASTNAME]'
+.. index::
+ pair: CLASS; VALIDATION
+
+VALIDATION
+ Signals the start of a `VALIDATION` block.
+
+ As of MapServer 5.4.0, `VALIDATION` blocks are the preferred
+ mechanism for specifying validation patterns for CGI param runtime
+ substitutions. See :ref:`RUNSUB`.
+
+.. index::
+ single: stacked symbols
+
+
Although the recommended way of making stacked symbols to achieve
interesting effects is to use `STYLE`\s, you can also "stack" 2
symbols without using `STYLE`\s. You define the second symbol, which
@@ -238,6 +291,27 @@
The following parameters allow you to define the second symbol, and
they are equivalent to their non-overlay counterparts:
+.. index::
+ pair: CLASS; OVERLAYBACKGROUNDCOLOR
+
+.. index::
+ pair: CLASS; OVERLAYCOLOR
+
+.. index::
+ pair: CLASS; OVERLAYOUTLINECOLOR
+
+.. index::
+ pair: CLASS; OVERLAYSIZE
+
+.. index::
+ pair: CLASS; OVERLAYMINSIZE
+
+.. index::
+ pair: CLASS; OVERLAYMAXSIZE
+
+.. index::
+ pair: CLASS; OVERLAYSYMBOL
+
- OVERLAYBACKGROUNDCOLOR
- OVERLAYCOLOR
- OVERLAYOUTLINECOLOR
@@ -245,13 +319,3 @@
- OVERLAYMINSIZE
- OVERLAYMAXSIZE
- OVERLAYSYMBOL
-
-.. index::
- pair: VALIDATION; CLASS
-
-VALIDATION
- Signals the start of a `VALIDATION` block.
-
- As of MapServer 5.4.0, `VALIDATION` blocks are the preferred
- mechanism for specifying validation patterns for CGI param runtime
- substitutions. See :ref:`RUNSUB`.
Modified: trunk/docs/en/mapfile/class.txt
===================================================================
--- trunk/docs/en/mapfile/class.txt 2011-08-23 12:14:50 UTC (rev 12089)
+++ trunk/docs/en/mapfile/class.txt 2011-08-23 12:24:06 UTC (rev 12090)
@@ -4,14 +4,20 @@
CLASS
*****************************************************************************
+.. index::
+ pair: CLASS; BACKGROUNDCOLOR
+
BACKGROUNDCOLOR [r] [g] [b]
Color to use for non-transparent symbols.
+.. index::
+ pair: CLASS; COLOR
+
COLOR [r] [g] [b]
Color to use for drawing features.
.. index::
- pair: DEBUG; CLASS
+ pair: CLASS; DEBUG
DEBUG [on|off]
Enables debugging of the class object. Verbose output is generated
@@ -24,7 +30,7 @@
:ref:`rfc28`
.. index::
- pair: EXPRESSION; CLASS
+ pair: CLASS; EXPRESSION
EXPRESSION [string]
@@ -73,7 +79,7 @@
types within the different classes of a layer.
.. index::
- pair: GROUP; CLASS
+ pair: CLASS; GROUP
GROUP [string]
Allows for grouping of classes. It is only used when a
@@ -108,7 +114,7 @@
.. index::
- pair: KEYIMAGE; CLASS
+ pair: CLASS; KEYIMAGE
.. _KEYIMAGE:
@@ -117,11 +123,14 @@
is used when building a legend (or requesting a legend icon via
MapScript or the :ref:`CGI application <cgi>`).
+.. index::
+ pair: CLASS; LABEL
+
:ref:`LABEL`
Signals the start of a :ref:`LABEL` object.
.. index::
- pair: MAXSCALEDENOM; CLASS
+ pair: CLASS; MAXSCALEDENOM
MAXSCALEDENOM [double]
Minimum scale at which this :ref:`CLASS` is drawn. Scale is given
@@ -142,12 +151,15 @@
.. deprecated:: 5.0
+.. index::
+ pair: CLASS; MAXSIZE
+
MAXSIZE [integer]
Maximum size in pixels to draw a symbol. Default is 50.
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
.. index::
- pair: MINSCALEDENOM; CLASS
+ pair: CLASS; MINSCALEDENOM
MINSCALEDENOM [double]
Maximum scale at which this :ref:`CLASS` is drawn. Scale is given
@@ -168,18 +180,30 @@
.. deprecated:: 5.0
+.. index::
+ pair: CLASS; MINSIZE
+
MINSIZE [integer]
Minimum size in pixels to draw a symbol. Default is 0.
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: CLASS; NAME
+
NAME [string]
Name to use in legends for this class. If not set class won't show
up in legend.
+.. index::
+ pair: CLASS; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b]
Color to use for outlining polygons and certain marker
symbols. Line symbols do not support outline colors.
+.. index::
+ pair: CLASS; SIZE
+
SIZE [integer]
Height, in pixels, of the symbol/pattern to be used. Only useful
with scalable symbols. For `vector` (and `ellipse`) :ref:`SYMBOL`
@@ -188,16 +212,25 @@
default is the vertical size of the image. Default size is 1 for
TTF symbols.
+.. index::
+ pair: CLASS; STATUS
+
STATUS [on|off]
Sets the current display status of the class. Default turns the
class on.
+.. index::
+ pair: CLASS; STYLE
+
:ref:`STYLE`
Signals the start of a :ref:`STYLE` object. A class can contain
multiple styles. Multiple styles can be used create complex
symbols (by overlay/stacking). See :ref:`sym_construction` for
more information on advanced symbol construction.
+.. index::
+ pair: CLASS; SYMBOL
+
:ref:`SYMBOL` [integer|string|filename]
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
@@ -214,10 +247,16 @@
See :ref:`sym_construction` for more information on advanced
symbol construction.
+.. index::
+ pair: CLASS; TEMPLATE
+
:ref:`TEMPLATE <template>` [filename]
Template file or URL to use in presenting query results to the
user. See :ref:`template` for more info.
+.. index::
+ pair: CLASS; TEXT
+
TEXT [string]
Static text to label features in this class with. This overrides
values obtained from the `LABELITEM`. The string may be given as
@@ -230,6 +269,20 @@
TEXT '[FIRSTNAME] [LASTNAME]'
+.. index::
+ pair: CLASS; VALIDATION
+
+VALIDATION
+ Signals the start of a `VALIDATION` block.
+
+ As of MapServer 5.4.0, `VALIDATION` blocks are the preferred
+ mechanism for specifying validation patterns for CGI param runtime
+ substitutions. See :ref:`RUNSUB`.
+
+.. index::
+ single: stacked symbols
+
+
Although the recommended way of making stacked symbols to achieve
interesting effects is to use `STYLE`\s, you can also "stack" 2
symbols without using `STYLE`\s. You define the second symbol, which
@@ -238,6 +291,27 @@
The following parameters allow you to define the second symbol, and
they are equivalent to their non-overlay counterparts:
+.. index::
+ pair: CLASS; OVERLAYBACKGROUNDCOLOR
+
+.. index::
+ pair: CLASS; OVERLAYCOLOR
+
+.. index::
+ pair: CLASS; OVERLAYOUTLINECOLOR
+
+.. index::
+ pair: CLASS; OVERLAYSIZE
+
+.. index::
+ pair: CLASS; OVERLAYMINSIZE
+
+.. index::
+ pair: CLASS; OVERLAYMAXSIZE
+
+.. index::
+ pair: CLASS; OVERLAYSYMBOL
+
- OVERLAYBACKGROUNDCOLOR
- OVERLAYCOLOR
- OVERLAYOUTLINECOLOR
@@ -245,13 +319,3 @@
- OVERLAYMINSIZE
- OVERLAYMAXSIZE
- OVERLAYSYMBOL
-
-.. index::
- pair: VALIDATION; CLASS
-
-VALIDATION
- Signals the start of a `VALIDATION` block.
-
- As of MapServer 5.4.0, `VALIDATION` blocks are the preferred
- mechanism for specifying validation patterns for CGI param runtime
- substitutions. See :ref:`RUNSUB`.
More information about the mapserver-commits
mailing list