[mapserver-commits] r12100 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Aug 23 09:37:01 EDT 2011
Author: havatv
Date: 2011-08-23 06:37:01 -0700 (Tue, 23 Aug 2011)
New Revision: 12100
Modified:
branches/branch-6-0/docs/en/mapfile/legend.txt
trunk/docs/en/mapfile/legend.txt
Log:
Added indexes (#4001)
Modified: branches/branch-6-0/docs/en/mapfile/legend.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/legend.txt 2011-08-23 13:31:07 UTC (rev 12099)
+++ branches/branch-6-0/docs/en/mapfile/legend.txt 2011-08-23 13:37:01 UTC (rev 12100)
@@ -1,14 +1,17 @@
.. _legend:
+.. index:: LEGEND
+
*****************************************************************************
LEGEND
*****************************************************************************
-.. index:: 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.
+.. index::
+ pair: LEGEND; IMAGECOLOR
+
IMAGECOLOR [r] [g] [b]
Color to initialize the legend with (i.e. the background).
@@ -19,30 +22,54 @@
.. deprecated:: 4.6
+.. index::
+ pair: LEGEND; KEYSIZE
+
+KEYSIZE [x][y]
+ Size of symbol key boxes in pixels. Default is 20 by 10.
+
+.. index::
+ pair: LEGEND; KEYSPACING
+
+KEYSPACING [x][y]
+ Spacing between symbol key boxes ([y]) and labels ([x]) in pixels.
+ Default is 5 by 5.
+
+.. index::
+ pair: LEGEND; LABEL
+
:ref:`LABEL`
Signals the start of a :ref:`LABEL` object
+.. index::
+ pair: LEGEND; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b]
Color to use for outlining symbol key boxes.
+.. index::
+ pair: LEGEND; POSITION
+
POSITION [ul|uc|ur|ll|lc|lr]
Where to place an embedded legend in the map. Default is lr.
-KEYSIZE [x][y]
- Size of symbol key boxes in pixels. Default is 20 by 10.
-
-KEYSPACING [x][y]
- Spacing between symbol key boxes ([y]) and labels ([x]) in pixels.
- Default is 5 by 5.
-
+.. index::
+ pair: LEGEND; POSTLABELCACHE
+
POSTLABELCACHE [true|false]
Tells MapServer to render this legend after all labels in the cache have
been drawn. Useful for adding neatlines and similar elements.
Default is false.
+.. index::
+ pair: LEGEND; STATUS
+
STATUS [on|off|embed]
Is the legend image to be created.
+.. index::
+ pair: LEGEND; TEMPLATE
+
TEMPLATE [filename]
HTML legend template file.
@@ -50,6 +77,9 @@
:ref:`html_legend`
+.. index::
+ pair: LEGEND; TRANSPARENT
+
TRANSPARENT [on|off]
Should the background color for the legend be transparent.
This flag is now deprecated in favor of declaring transparency within
Modified: trunk/docs/en/mapfile/legend.txt
===================================================================
--- trunk/docs/en/mapfile/legend.txt 2011-08-23 13:31:07 UTC (rev 12099)
+++ trunk/docs/en/mapfile/legend.txt 2011-08-23 13:37:01 UTC (rev 12100)
@@ -1,14 +1,17 @@
.. _legend:
+.. index:: LEGEND
+
*****************************************************************************
LEGEND
*****************************************************************************
-.. index:: 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.
+.. index::
+ pair: LEGEND; IMAGECOLOR
+
IMAGECOLOR [r] [g] [b]
Color to initialize the legend with (i.e. the background).
@@ -19,30 +22,54 @@
.. deprecated:: 4.6
+.. index::
+ pair: LEGEND; KEYSIZE
+
+KEYSIZE [x][y]
+ Size of symbol key boxes in pixels. Default is 20 by 10.
+
+.. index::
+ pair: LEGEND; KEYSPACING
+
+KEYSPACING [x][y]
+ Spacing between symbol key boxes ([y]) and labels ([x]) in pixels.
+ Default is 5 by 5.
+
+.. index::
+ pair: LEGEND; LABEL
+
:ref:`LABEL`
Signals the start of a :ref:`LABEL` object
+.. index::
+ pair: LEGEND; OUTLINECOLOR
+
OUTLINECOLOR [r] [g] [b]
Color to use for outlining symbol key boxes.
+.. index::
+ pair: LEGEND; POSITION
+
POSITION [ul|uc|ur|ll|lc|lr]
Where to place an embedded legend in the map. Default is lr.
-KEYSIZE [x][y]
- Size of symbol key boxes in pixels. Default is 20 by 10.
-
-KEYSPACING [x][y]
- Spacing between symbol key boxes ([y]) and labels ([x]) in pixels.
- Default is 5 by 5.
-
+.. index::
+ pair: LEGEND; POSTLABELCACHE
+
POSTLABELCACHE [true|false]
Tells MapServer to render this legend after all labels in the cache have
been drawn. Useful for adding neatlines and similar elements.
Default is false.
+.. index::
+ pair: LEGEND; STATUS
+
STATUS [on|off|embed]
Is the legend image to be created.
+.. index::
+ pair: LEGEND; TEMPLATE
+
TEMPLATE [filename]
HTML legend template file.
@@ -50,6 +77,9 @@
:ref:`html_legend`
+.. index::
+ pair: LEGEND; TRANSPARENT
+
TRANSPARENT [on|off]
Should the background color for the legend be transparent.
This flag is now deprecated in favor of declaring transparency within
More information about the mapserver-commits
mailing list