[mapserver-commits] r12098 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Aug 23 09:11:01 EDT 2011
Author: havatv
Date: 2011-08-23 06:11:01 -0700 (Tue, 23 Aug 2011)
New Revision: 12098
Modified:
branches/branch-6-0/docs/en/mapfile/label.txt
trunk/docs/en/mapfile/label.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 13:03:28 UTC (rev 12097)
+++ branches/branch-6-0/docs/en/mapfile/label.txt 2011-08-23 13:11:01 UTC (rev 12098)
@@ -1,10 +1,13 @@
.. _label:
+.. index:: LABEL
+
*****************************************************************************
LABEL
*****************************************************************************
-.. index:: LABEL
+.. index::
+ pair: LABEL; ALIGN
ALIGN [left|center|right]
Since version 5.4 . Specifies text alignment for multiline labels
@@ -12,6 +15,9 @@
so don't expect fabulous results (especially for *right*
alignment) if you're not using a fixed width font.
+.. index::
+ pair: LABEL; ANGLE
+
ANGLE [double|auto|follow|attribute]
- Angle, given in degrees, to draw the label.
- AUTO allows MapServer to compute the angle. Valid for LINE
@@ -41,7 +47,7 @@
The associated RFC document for this feature is :ref:`RFC19`.
.. index::
- pair: LABEL; ANTIALIAS
+ pair: LABEL; ANTIALIAS
ANTIALIAS [true|false]
Should text be antialiased? Note that this requires more available
@@ -66,11 +72,17 @@
.. deprecated:: 6.0 Use STYLE object and `GEOMTRANSFORM labelpoly`.
+.. index::
+ pair: LABEL; BUFFER
+
BUFFER [integer]
Padding, in pixels, around labels. Useful for maintaining spacing around
text to enhance readability. Available only for cached labels.
Default is 0.
+.. index::
+ pair: LABEL; COLOR
+
COLOR [r] [g] [b] | [attribute]
- Color to draw text with.
- [*Attribute*] was introduced in version 5.0, to specify the item
@@ -93,6 +105,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: LABEL; ENCODING
+
ENCODING [string]
Supported encoding format to be used for labels. If the format is not
supported, the label will not be drawn. Requires the iconv library
@@ -103,20 +118,28 @@
MapServer. More information can be found in the :ref:`Label
Encoding document <labelencoding>`.
+.. index::
+ pair: LABEL; FONT
+
FONT [name|attribute]
- Font alias (as defined in the FONTSET) to use for labeling.
- [*Attribute*] was introduced in version 5.6 to specfify the font
alias.
+.. index::
+ pair: LABEL; FORCE
+
.. _FORCE:
FORCE [true|false]
Forces labels for a particular class on, regardless of collisions.
Available only for cached labels. Default is false.
+.. index::
+ pair: LABEL; MAXLENGTH
+
.. _MAXLENGTH:
-
MAXLENGTH [integer]
Introduced in mapserver 5.4, this keyword interacts with the WRAP_
keyword so that line breaks only occur after the defined number of
@@ -130,6 +153,9 @@
The associated RFC document for this feature is :ref:`RFC40`.
+.. index::
+ pair: LABEL; MAXOVERLAPANGLE
+
MAXOVERLAPANGLE [double]
Angle threshold to use in filtering out ANGLE FOLLOW labels in
which characters overlap (floating point value in degrees). This
@@ -144,15 +170,24 @@
The associated RFC document for this feature is :ref:`RFC60`.
+.. index::
+ pair: LABEL; MAXSIZE
+
MAXSIZE [double]
Maximum font size to use when scaling text (pixels). Default is 256.
Starting from version 5.4, the value can also be a fractional value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: LABEL; MINDISTANCE
+
MINDISTANCE [integer]
Minimum distance between duplicate labels. Given in pixels.
+.. index::
+ pair: LABEL; MINFEATURESIZE
+
MINFEATURESIZE [integer|auto]
Minimum size a feature must be to be labeled. Given in pixels. For
line data the overall length of the displayed line is used, for
@@ -161,12 +196,18 @@
are larger than their corresponding label. Available for cached
labels only.
+.. index::
+ pair: LABEL; MINSIZE
+
MINSIZE [double]
Minimum font size to use when scaling text (pixels). Default is 4.
Starting from version 5.4, the value can also be a fractional value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: LABEL; OFFSET
+
OFFSET [x][y]
Offset values for labels, relative to the lower left hand corner of the
label and the label point. Given in pixels. In the case of rotated text
@@ -174,6 +215,9 @@
be compensated for.
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: LABEL; OUTLINECOLOR
+
.. _OUTLINECOLOR:
OUTLINECOLOR [r] [g] [b] | [attribute]
@@ -198,14 +242,23 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: LABEL; OUTLINEWIDTH
+
OUTLINEWIDTH [integer]
Width of the outline if OUTLINECOLOR_ has been set. Defaults to 1.
Currently only the AGG renderer supports values greater than 1, and
renders these as a 'halo' effect: recommended values are 3 or 5.
+.. index::
+ pair: LABEL; PARTIALS
+
PARTIALS [true|false]
Can text run off the edge of the map? Default is true.
+.. index::
+ pair: LABEL; POSITION
+
POSITION [ul|uc|ur|cl|cc|cr|ll|lc|lr|auto]
Position of the label relative to the labeling point (layers
only). First letter is "Y" position, second letter is "X"
@@ -220,6 +273,9 @@
is set to "true"). "Auto" placement is only available with cached
labels.
+.. index::
+ pair: LABEL; PRIORITY
+
PRIORITY [integer]|[item_name]|[attribute]
The priority parameter (added in v5.0) takes an integer value
between 1 (lowest) and 10 (highest). The default value is 1. It
@@ -237,6 +293,9 @@
[*Attribute*] was introduced in version 5.6.
+.. index::
+ pair: LABEL; REPEATDISTANCE
+
REPEATDISTANCE [integer]
- Introduced in version 5.6. The label will be repeated on every
line of a multiline shape and will be repeated multiple times
@@ -244,12 +303,18 @@
The associated RFC document for this feature is :ref:`RFC57`.
+.. index::
+ pair: LABEL; SHADOWCOLOR
+
SHADOWCOLOR [r] [g] [b]
Color of drop shadow. An label with the same text will be rendered
in this color before the main label is drawn, resulting in a
shadow effect on the the label characters. The offset of the
renderered shadow is set with SHADOWSIZE.
+.. index::
+ pair: LABEL; SHADOWSIZE
+
SHADOWSIZE [x][y]|[attribute][attribute]|[x][attribute]|[attribute][y]
Shadow offset in pixels, see SHADOWCOLOR.
@@ -263,6 +328,9 @@
SHADOWSIZE [shadowsize] [shadowsize]
+.. index::
+ pair: LABEL; SIZE
+
SIZE [double]|[tiny|small|medium|large|giant]|[attribute]
- Text size. Use a number to give the size in pixels of your
TrueType font based label, or any of the other 5 listed keywords
@@ -296,6 +364,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: LABEL; STYLE
+
:ref:`STYLE`
The start of a `STYLE` object.
@@ -317,6 +388,9 @@
.. versionadded:: 6.0
+.. index::
+ pair: LABEL; TYPE
+
TYPE [bitmap|truetype]
Type of font to use. Generally bitmap fonts are faster to draw
then TrueType fonts. However, TrueType fonts are scalable and
@@ -327,6 +401,9 @@
Bitmap fonts are only supported with the AGG and GD
renderers.
+.. index::
+ pair: LABEL; WRAP
+
.. _WRAP:
WRAP [character]
Modified: trunk/docs/en/mapfile/label.txt
===================================================================
--- trunk/docs/en/mapfile/label.txt 2011-08-23 13:03:28 UTC (rev 12097)
+++ trunk/docs/en/mapfile/label.txt 2011-08-23 13:11:01 UTC (rev 12098)
@@ -1,10 +1,13 @@
.. _label:
+.. index:: LABEL
+
*****************************************************************************
LABEL
*****************************************************************************
-.. index:: LABEL
+.. index::
+ pair: LABEL; ALIGN
ALIGN [left|center|right]
Since version 5.4 . Specifies text alignment for multiline labels
@@ -12,6 +15,9 @@
so don't expect fabulous results (especially for *right*
alignment) if you're not using a fixed width font.
+.. index::
+ pair: LABEL; ANGLE
+
ANGLE [double|auto|follow|attribute]
- Angle, given in degrees, to draw the label.
- AUTO allows MapServer to compute the angle. Valid for LINE
@@ -41,7 +47,7 @@
The associated RFC document for this feature is :ref:`RFC19`.
.. index::
- pair: LABEL; ANTIALIAS
+ pair: LABEL; ANTIALIAS
ANTIALIAS [true|false]
Should text be antialiased? Note that this requires more available
@@ -66,11 +72,17 @@
.. deprecated:: 6.0 Use STYLE object and `GEOMTRANSFORM labelpoly`.
+.. index::
+ pair: LABEL; BUFFER
+
BUFFER [integer]
Padding, in pixels, around labels. Useful for maintaining spacing around
text to enhance readability. Available only for cached labels.
Default is 0.
+.. index::
+ pair: LABEL; COLOR
+
COLOR [r] [g] [b] | [attribute]
- Color to draw text with.
- [*Attribute*] was introduced in version 5.0, to specify the item
@@ -93,6 +105,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: LABEL; ENCODING
+
ENCODING [string]
Supported encoding format to be used for labels. If the format is not
supported, the label will not be drawn. Requires the iconv library
@@ -103,20 +118,28 @@
MapServer. More information can be found in the :ref:`Label
Encoding document <labelencoding>`.
+.. index::
+ pair: LABEL; FONT
+
FONT [name|attribute]
- Font alias (as defined in the FONTSET) to use for labeling.
- [*Attribute*] was introduced in version 5.6 to specfify the font
alias.
+.. index::
+ pair: LABEL; FORCE
+
.. _FORCE:
FORCE [true|false]
Forces labels for a particular class on, regardless of collisions.
Available only for cached labels. Default is false.
+.. index::
+ pair: LABEL; MAXLENGTH
+
.. _MAXLENGTH:
-
MAXLENGTH [integer]
Introduced in mapserver 5.4, this keyword interacts with the WRAP_
keyword so that line breaks only occur after the defined number of
@@ -130,6 +153,9 @@
The associated RFC document for this feature is :ref:`RFC40`.
+.. index::
+ pair: LABEL; MAXOVERLAPANGLE
+
MAXOVERLAPANGLE [double]
Angle threshold to use in filtering out ANGLE FOLLOW labels in
which characters overlap (floating point value in degrees). This
@@ -144,15 +170,24 @@
The associated RFC document for this feature is :ref:`RFC60`.
+.. index::
+ pair: LABEL; MAXSIZE
+
MAXSIZE [double]
Maximum font size to use when scaling text (pixels). Default is 256.
Starting from version 5.4, the value can also be a fractional value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: LABEL; MINDISTANCE
+
MINDISTANCE [integer]
Minimum distance between duplicate labels. Given in pixels.
+.. index::
+ pair: LABEL; MINFEATURESIZE
+
MINFEATURESIZE [integer|auto]
Minimum size a feature must be to be labeled. Given in pixels. For
line data the overall length of the displayed line is used, for
@@ -161,12 +196,18 @@
are larger than their corresponding label. Available for cached
labels only.
+.. index::
+ pair: LABEL; MINSIZE
+
MINSIZE [double]
Minimum font size to use when scaling text (pixels). Default is 4.
Starting from version 5.4, the value can also be a fractional value
(and not only integer).
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: LABEL; OFFSET
+
OFFSET [x][y]
Offset values for labels, relative to the lower left hand corner of the
label and the label point. Given in pixels. In the case of rotated text
@@ -174,6 +215,9 @@
be compensated for.
See :ref:`LAYER` :ref:`SYMBOLSCALEDENOM <symbolscaledenom>`.
+.. index::
+ pair: LABEL; OUTLINECOLOR
+
.. _OUTLINECOLOR:
OUTLINECOLOR [r] [g] [b] | [attribute]
@@ -198,14 +242,23 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: LABEL; OUTLINEWIDTH
+
OUTLINEWIDTH [integer]
Width of the outline if OUTLINECOLOR_ has been set. Defaults to 1.
Currently only the AGG renderer supports values greater than 1, and
renders these as a 'halo' effect: recommended values are 3 or 5.
+.. index::
+ pair: LABEL; PARTIALS
+
PARTIALS [true|false]
Can text run off the edge of the map? Default is true.
+.. index::
+ pair: LABEL; POSITION
+
POSITION [ul|uc|ur|cl|cc|cr|ll|lc|lr|auto]
Position of the label relative to the labeling point (layers
only). First letter is "Y" position, second letter is "X"
@@ -220,6 +273,9 @@
is set to "true"). "Auto" placement is only available with cached
labels.
+.. index::
+ pair: LABEL; PRIORITY
+
PRIORITY [integer]|[item_name]|[attribute]
The priority parameter (added in v5.0) takes an integer value
between 1 (lowest) and 10 (highest). The default value is 1. It
@@ -237,6 +293,9 @@
[*Attribute*] was introduced in version 5.6.
+.. index::
+ pair: LABEL; REPEATDISTANCE
+
REPEATDISTANCE [integer]
- Introduced in version 5.6. The label will be repeated on every
line of a multiline shape and will be repeated multiple times
@@ -244,12 +303,18 @@
The associated RFC document for this feature is :ref:`RFC57`.
+.. index::
+ pair: LABEL; SHADOWCOLOR
+
SHADOWCOLOR [r] [g] [b]
Color of drop shadow. An label with the same text will be rendered
in this color before the main label is drawn, resulting in a
shadow effect on the the label characters. The offset of the
renderered shadow is set with SHADOWSIZE.
+.. index::
+ pair: LABEL; SHADOWSIZE
+
SHADOWSIZE [x][y]|[attribute][attribute]|[x][attribute]|[attribute][y]
Shadow offset in pixels, see SHADOWCOLOR.
@@ -263,6 +328,9 @@
SHADOWSIZE [shadowsize] [shadowsize]
+.. index::
+ pair: LABEL; SIZE
+
SIZE [double]|[tiny|small|medium|large|giant]|[attribute]
- Text size. Use a number to give the size in pixels of your
TrueType font based label, or any of the other 5 listed keywords
@@ -296,6 +364,9 @@
The associated RFC document for this feature is :ref:`RFC19`.
+.. index::
+ pair: LABEL; STYLE
+
:ref:`STYLE`
The start of a `STYLE` object.
@@ -317,6 +388,9 @@
.. versionadded:: 6.0
+.. index::
+ pair: LABEL; TYPE
+
TYPE [bitmap|truetype]
Type of font to use. Generally bitmap fonts are faster to draw
then TrueType fonts. However, TrueType fonts are scalable and
@@ -327,6 +401,9 @@
Bitmap fonts are only supported with the AGG and GD
renderers.
+.. index::
+ pair: LABEL; WRAP
+
.. _WRAP:
WRAP [character]
More information about the mapserver-commits
mailing list