[mapserver-commits] r12048 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Fri Aug 12 08:21:54 EDT 2011
Author: havatv
Date: 2011-08-12 05:21:54 -0700 (Fri, 12 Aug 2011)
New Revision: 12048
Modified:
branches/branch-6-0/docs/en/mapfile/label.txt
trunk/docs/en/mapfile/label.txt
Log:
Reduced line lengths to below 80 by breaking lines - label
Modified: branches/branch-6-0/docs/en/mapfile/label.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/label.txt 2011-08-12 12:08:25 UTC (rev 12047)
+++ branches/branch-6-0/docs/en/mapfile/label.txt 2011-08-12 12:21:54 UTC (rev 12048)
@@ -7,20 +7,23 @@
.. index:: LABEL
ALIGN [left|center|right]
- Since version 5.4 . Specifies text alignment for multiline labels (see WRAP_)
- Note that the alignment algorithm is far from precise, so don't expect
- fabulous results (especially for *right* alignment) if you're not using
- a fixed width font.
+ Since version 5.4 . Specifies text alignment for multiline labels
+ (see WRAP_) Note that the alignment algorithm is far from precise,
+ so don't expect fabulous results (especially for *right*
+ alignment) if you're not using a fixed width font.
ANGLE [double|auto|follow|attribute]
- Angle, given in degrees, to draw the label.
- - AUTO allows MapServer to compute the angle. Valid for LINE layers only.
- - FOLLOW was introduced in version 4.10 and tells MapServer to compute a
- curved label for appropriate linear features (see :ref:`RFC11` for specifics).
- - [*Attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for angle values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named "MYANGLE"
- that holds angle values for each record, your LABEL object might contain:
+ - AUTO allows MapServer to compute the angle. Valid for LINE
+ layers only.
+ - FOLLOW was introduced in version 4.10 and tells MapServer to
+ compute a curved label for appropriate linear features (see
+ :ref:`RFC11` for specifics).
+ - [*Attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for angle values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYANGLE" that holds angle values for each
+ record, your LABEL object might contain:
.. code-block:: mapfile
@@ -70,10 +73,11 @@
COLOR [r] [g] [b] | [attribute]
- Color to draw text with.
- - [*Attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for color values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named "MYCOLOR"
- that holds color values for each record, your LABEL object might contain:
+ - [*Attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for color values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYCOLOR" that holds color values for each
+ record, your LABEL object might contain:
.. code-block:: mapfile
@@ -95,12 +99,14 @@
(present on most systems). The library is always detected if present on
the system, but if not the label will not be drawn.
- Required for displaying international characters in MapServer. More
- information can be found in the :ref:`Label Encoding document <labelencoding>`.
+ Required for displaying international characters in
+ MapServer. More information can be found in the :ref:`Label
+ Encoding document <labelencoding>`.
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.
+ - [*Attribute*] was introduced in version 5.6 to specfify the font
+ alias.
.. _FORCE:
@@ -114,7 +120,7 @@
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
- characters
+ characters.
.. csv-table:: Interaction with WRAP_ keyword
@@ -125,8 +131,16 @@
The associated RFC document for this feature is :ref:`RFC40`.
MAXOVERLAPANGLE [double]
- Angle threshold to use in filtering out ANGLE FOLLOW labels in which characters overlap (floating point value in degrees). This filtering will be enabled by default starting with MapServer 6.0. The default MAXOVERLAPANGLE value will be 22.5 degrees, which also matches the default in GeoServer. Users will be free to tune the value up or down depending on the type of data they are dealing with and their tolerance to bad overlap in labels.
- As per RFC 60, if MAXOVERLAPANGLE is set to 0, then we fall back on pre-6.0 behavior which was to use maxoverlapangle = 0.4*MS_PI (40% of 180 degrees = 72degree).
+ Angle threshold to use in filtering out ANGLE FOLLOW labels in
+ which characters overlap (floating point value in degrees). This
+ filtering will be enabled by default starting with MapServer
+ 6.0. The default MAXOVERLAPANGLE value will be 22.5 degrees, which
+ also matches the default in GeoServer. Users will be free to tune
+ the value up or down depending on the type of data they are
+ dealing with and their tolerance to bad overlap in labels.
+ As per RFC 60, if MAXOVERLAPANGLE is set to 0, then we fall back
+ on pre-6.0 behavior which was to use maxoverlapangle = 0.4*MS_PI
+ (40% of 180 degrees = 72degree).
The associated RFC document for this feature is :ref:`RFC60`.
@@ -140,11 +154,12 @@
Minimum distance between duplicate labels. Given in pixels.
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 polygons
- features the smallest dimension of the bounding box is used. "Auto"
- keyword tells MapServer to only label features that are larger than
- their corresponding label. Available for cached labels only.
+ 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
+ polygons features the smallest dimension of the bounding box is
+ used. "Auto" keyword tells MapServer to only label features that
+ are larger than their corresponding label. Available for cached
+ labels only.
MINSIZE [double]
Minimum font size to use when scaling text (pixels). Default is 4.
@@ -163,11 +178,11 @@
OUTLINECOLOR [r] [g] [b] | [attribute]
- Color to draw a one pixel outline around the characters in the text.
- - [*attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for color values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named
- "MYOUTCOLOR" that holds color values for each record, your LABEL object
- might contain:
+ - [*attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for color values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYOUTCOLOR" that holds color values for each
+ record, your LABEL object might contain:
.. code-block:: mapfile
@@ -192,43 +207,48 @@
Can text run off the edge of the map? Default is true.
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" position. "Auto" tells
- MapServer to calculate a label position that will not interfere with other
- labels. With points, MapServer selects from the 8 outer
- positions (i.e. excluding cc). With polygons, MapServer selects from
- cc (added in MapServer 5.4), uc, lc, cl and cr as possible positions.
- With lines, it only uses lc or uc, until it finds a position that doesn't
- collide with labels that have already been drawn. If all positions cause
- a conflict, then the label is not drawn (Unless the label's FORCE_ a
- parameter is set to "true"). "Auto" placement is only available with cached labels.
+ Position of the label relative to the labeling point (layers
+ only). First letter is "Y" position, second letter is "X"
+ position. "Auto" tells MapServer to calculate a label position
+ that will not interfere with other labels. With points, MapServer
+ selects from the 8 outer positions (i.e. excluding cc). With
+ polygons, MapServer selects from cc (added in MapServer 5.4), uc,
+ lc, cl and cr as possible positions. With lines, it only uses lc
+ or uc, until it finds a position that doesn't collide with labels
+ that have already been drawn. If all positions cause a conflict,
+ then the label is not drawn (Unless the label's FORCE_ a parameter
+ is set to "true"). "Auto" placement is only available with cached
+ labels.
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 is also possible
- to bind the priority to an attribute (item_name) using square brackets
- around the [item_name]. e.g. "PRIORITY [someattribute]"
+ The priority parameter (added in v5.0) takes an integer value
+ between 1 (lowest) and 10 (highest). The default value is 1. It
+ is also possible to bind the priority to an attribute (item_name)
+ using square brackets around the [item_name]. e.g. "PRIORITY
+ [someattribute]"
- Labels are stored in the label cache and rendered in order of priority,
- with the highest priority levels rendered first.
- Specifying an out of range PRIORITY value inside a map file will result in
- a parsing error. An out of range value set via MapScript or coming from a
- shape attribute will be clamped to the min/max values at rendering time.
- There is no expected impact on performance for using label priorities.
+ Labels are stored in the label cache and rendered in order of
+ priority, with the highest priority levels rendered first.
+ Specifying an out of range PRIORITY value inside a map file will
+ result in a parsing error. An out of range value set via
+ MapScript or coming from a shape attribute will be clamped to the
+ min/max values at rendering time. There is no expected impact on
+ performance for using label priorities.
[*Attribute*] was introduced in version 5.6.
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 along a given
- line at an interval of REPEATDISTANCE pixels.
+ - Introduced in version 5.6. The label will be repeated on every
+ line of a multiline shape and will be repeated multiple times
+ along a given line at an interval of REPEATDISTANCE pixels.
The associated RFC document for this feature is :ref:`RFC57`.
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.
+ 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.
SHADOWSIZE [x][y]|[attribute][attribute]|[x][attribute]|[attribute][y]
Shadow offset in pixels, see SHADOWCOLOR.
@@ -253,13 +273,15 @@
gives the size of the font to be used at the map scale
1:`SYMBOLSCALEDENOM`.
- - Starting from version 5.4, the value can also be a fractional value (and not
- only integer).
- - [*Attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for size values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named "MYSIZE"
- that holds size values for each record, your LABEL object might contain:
+ - Starting from version 5.4, the value can also be a fractional
+ value (and not only integer).
+ - [*Attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for size values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYSIZE" that holds size values for each
+ record, your LABEL object might contain:
+
.. code-block:: mapfile
LABEL
@@ -296,15 +318,18 @@
TYPE [bitmap|truetype]
- Type of font to use. Generally bitmap fonts are faster to draw then
- TrueType fonts. However, TrueType fonts are scalable and available in a
- variety of faces. Be sure to set the FONT parameter if you select TrueType.
+ Type of font to use. Generally bitmap fonts are faster to draw
+ then TrueType fonts. However, TrueType fonts are scalable and
+ available in a variety of faces. Be sure to set the FONT parameter
+ if you select TrueType.
- Note that bitmap fonts are only supported with the AGG and GD renderers.
+ .. note::
+ Bitmap fonts are only supported with the AGG and GD
+ renderers.
.. _WRAP:
WRAP [character]
- Character that represents an end-of-line condition in label text, thus
- resulting in a multi-line label. Interacts with MAXLENGTH_ for conditional
- line wrapping after a given number of characters
+ Character that represents an end-of-line condition in label text,
+ thus resulting in a multi-line label. Interacts with MAXLENGTH_
+ for conditional line wrapping after a given number of characters
Modified: trunk/docs/en/mapfile/label.txt
===================================================================
--- trunk/docs/en/mapfile/label.txt 2011-08-12 12:08:25 UTC (rev 12047)
+++ trunk/docs/en/mapfile/label.txt 2011-08-12 12:21:54 UTC (rev 12048)
@@ -7,20 +7,23 @@
.. index:: LABEL
ALIGN [left|center|right]
- Since version 5.4 . Specifies text alignment for multiline labels (see WRAP_)
- Note that the alignment algorithm is far from precise, so don't expect
- fabulous results (especially for *right* alignment) if you're not using
- a fixed width font.
+ Since version 5.4 . Specifies text alignment for multiline labels
+ (see WRAP_) Note that the alignment algorithm is far from precise,
+ so don't expect fabulous results (especially for *right*
+ alignment) if you're not using a fixed width font.
ANGLE [double|auto|follow|attribute]
- Angle, given in degrees, to draw the label.
- - AUTO allows MapServer to compute the angle. Valid for LINE layers only.
- - FOLLOW was introduced in version 4.10 and tells MapServer to compute a
- curved label for appropriate linear features (see :ref:`RFC11` for specifics).
- - [*Attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for angle values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named "MYANGLE"
- that holds angle values for each record, your LABEL object might contain:
+ - AUTO allows MapServer to compute the angle. Valid for LINE
+ layers only.
+ - FOLLOW was introduced in version 4.10 and tells MapServer to
+ compute a curved label for appropriate linear features (see
+ :ref:`RFC11` for specifics).
+ - [*Attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for angle values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYANGLE" that holds angle values for each
+ record, your LABEL object might contain:
.. code-block:: mapfile
@@ -70,10 +73,11 @@
COLOR [r] [g] [b] | [attribute]
- Color to draw text with.
- - [*Attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for color values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named "MYCOLOR"
- that holds color values for each record, your LABEL object might contain:
+ - [*Attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for color values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYCOLOR" that holds color values for each
+ record, your LABEL object might contain:
.. code-block:: mapfile
@@ -95,12 +99,14 @@
(present on most systems). The library is always detected if present on
the system, but if not the label will not be drawn.
- Required for displaying international characters in MapServer. More
- information can be found in the :ref:`Label Encoding document <labelencoding>`.
+ Required for displaying international characters in
+ MapServer. More information can be found in the :ref:`Label
+ Encoding document <labelencoding>`.
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.
+ - [*Attribute*] was introduced in version 5.6 to specfify the font
+ alias.
.. _FORCE:
@@ -114,7 +120,7 @@
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
- characters
+ characters.
.. csv-table:: Interaction with WRAP_ keyword
@@ -125,8 +131,16 @@
The associated RFC document for this feature is :ref:`RFC40`.
MAXOVERLAPANGLE [double]
- Angle threshold to use in filtering out ANGLE FOLLOW labels in which characters overlap (floating point value in degrees). This filtering will be enabled by default starting with MapServer 6.0. The default MAXOVERLAPANGLE value will be 22.5 degrees, which also matches the default in GeoServer. Users will be free to tune the value up or down depending on the type of data they are dealing with and their tolerance to bad overlap in labels.
- As per RFC 60, if MAXOVERLAPANGLE is set to 0, then we fall back on pre-6.0 behavior which was to use maxoverlapangle = 0.4*MS_PI (40% of 180 degrees = 72degree).
+ Angle threshold to use in filtering out ANGLE FOLLOW labels in
+ which characters overlap (floating point value in degrees). This
+ filtering will be enabled by default starting with MapServer
+ 6.0. The default MAXOVERLAPANGLE value will be 22.5 degrees, which
+ also matches the default in GeoServer. Users will be free to tune
+ the value up or down depending on the type of data they are
+ dealing with and their tolerance to bad overlap in labels.
+ As per RFC 60, if MAXOVERLAPANGLE is set to 0, then we fall back
+ on pre-6.0 behavior which was to use maxoverlapangle = 0.4*MS_PI
+ (40% of 180 degrees = 72degree).
The associated RFC document for this feature is :ref:`RFC60`.
@@ -140,11 +154,12 @@
Minimum distance between duplicate labels. Given in pixels.
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 polygons
- features the smallest dimension of the bounding box is used. "Auto"
- keyword tells MapServer to only label features that are larger than
- their corresponding label. Available for cached labels only.
+ 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
+ polygons features the smallest dimension of the bounding box is
+ used. "Auto" keyword tells MapServer to only label features that
+ are larger than their corresponding label. Available for cached
+ labels only.
MINSIZE [double]
Minimum font size to use when scaling text (pixels). Default is 4.
@@ -163,11 +178,11 @@
OUTLINECOLOR [r] [g] [b] | [attribute]
- Color to draw a one pixel outline around the characters in the text.
- - [*attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for color values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named
- "MYOUTCOLOR" that holds color values for each record, your LABEL object
- might contain:
+ - [*attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for color values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYOUTCOLOR" that holds color values for each
+ record, your LABEL object might contain:
.. code-block:: mapfile
@@ -192,43 +207,48 @@
Can text run off the edge of the map? Default is true.
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" position. "Auto" tells
- MapServer to calculate a label position that will not interfere with other
- labels. With points, MapServer selects from the 8 outer
- positions (i.e. excluding cc). With polygons, MapServer selects from
- cc (added in MapServer 5.4), uc, lc, cl and cr as possible positions.
- With lines, it only uses lc or uc, until it finds a position that doesn't
- collide with labels that have already been drawn. If all positions cause
- a conflict, then the label is not drawn (Unless the label's FORCE_ a
- parameter is set to "true"). "Auto" placement is only available with cached labels.
+ Position of the label relative to the labeling point (layers
+ only). First letter is "Y" position, second letter is "X"
+ position. "Auto" tells MapServer to calculate a label position
+ that will not interfere with other labels. With points, MapServer
+ selects from the 8 outer positions (i.e. excluding cc). With
+ polygons, MapServer selects from cc (added in MapServer 5.4), uc,
+ lc, cl and cr as possible positions. With lines, it only uses lc
+ or uc, until it finds a position that doesn't collide with labels
+ that have already been drawn. If all positions cause a conflict,
+ then the label is not drawn (Unless the label's FORCE_ a parameter
+ is set to "true"). "Auto" placement is only available with cached
+ labels.
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 is also possible
- to bind the priority to an attribute (item_name) using square brackets
- around the [item_name]. e.g. "PRIORITY [someattribute]"
+ The priority parameter (added in v5.0) takes an integer value
+ between 1 (lowest) and 10 (highest). The default value is 1. It
+ is also possible to bind the priority to an attribute (item_name)
+ using square brackets around the [item_name]. e.g. "PRIORITY
+ [someattribute]"
- Labels are stored in the label cache and rendered in order of priority,
- with the highest priority levels rendered first.
- Specifying an out of range PRIORITY value inside a map file will result in
- a parsing error. An out of range value set via MapScript or coming from a
- shape attribute will be clamped to the min/max values at rendering time.
- There is no expected impact on performance for using label priorities.
+ Labels are stored in the label cache and rendered in order of
+ priority, with the highest priority levels rendered first.
+ Specifying an out of range PRIORITY value inside a map file will
+ result in a parsing error. An out of range value set via
+ MapScript or coming from a shape attribute will be clamped to the
+ min/max values at rendering time. There is no expected impact on
+ performance for using label priorities.
[*Attribute*] was introduced in version 5.6.
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 along a given
- line at an interval of REPEATDISTANCE pixels.
+ - Introduced in version 5.6. The label will be repeated on every
+ line of a multiline shape and will be repeated multiple times
+ along a given line at an interval of REPEATDISTANCE pixels.
The associated RFC document for this feature is :ref:`RFC57`.
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.
+ 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.
SHADOWSIZE [x][y]|[attribute][attribute]|[x][attribute]|[attribute][y]
Shadow offset in pixels, see SHADOWCOLOR.
@@ -253,13 +273,15 @@
gives the size of the font to be used at the map scale
1:`SYMBOLSCALEDENOM`.
- - Starting from version 5.4, the value can also be a fractional value (and not
- only integer).
- - [*Attribute*] was introduced in version 5.0, to specify the item name in
- the attribute table to use for size values. The hard brackets [] are
- required. For example, if your shapefile's DBF has a field named "MYSIZE"
- that holds size values for each record, your LABEL object might contain:
+ - Starting from version 5.4, the value can also be a fractional
+ value (and not only integer).
+ - [*Attribute*] was introduced in version 5.0, to specify the item
+ name in the attribute table to use for size values. The hard
+ brackets [] are required. For example, if your shapefile's DBF
+ has a field named "MYSIZE" that holds size values for each
+ record, your LABEL object might contain:
+
.. code-block:: mapfile
LABEL
@@ -296,15 +318,18 @@
TYPE [bitmap|truetype]
- Type of font to use. Generally bitmap fonts are faster to draw then
- TrueType fonts. However, TrueType fonts are scalable and available in a
- variety of faces. Be sure to set the FONT parameter if you select TrueType.
+ Type of font to use. Generally bitmap fonts are faster to draw
+ then TrueType fonts. However, TrueType fonts are scalable and
+ available in a variety of faces. Be sure to set the FONT parameter
+ if you select TrueType.
- Note that bitmap fonts are only supported with the AGG and GD renderers.
+ .. note::
+ Bitmap fonts are only supported with the AGG and GD
+ renderers.
.. _WRAP:
WRAP [character]
- Character that represents an end-of-line condition in label text, thus
- resulting in a multi-line label. Interacts with MAXLENGTH_ for conditional
- line wrapping after a given number of characters
+ Character that represents an end-of-line condition in label text,
+ thus resulting in a multi-line label. Interacts with MAXLENGTH_
+ for conditional line wrapping after a given number of characters
More information about the mapserver-commits
mailing list