[mapserver-commits] r8132 - trunk/docs/mapfile
svn at osgeo.org
svn at osgeo.org
Fri Nov 28 11:27:13 EST 2008
Author: jmckenna
Date: 2008-11-28 11:27:12 -0500 (Fri, 28 Nov 2008)
New Revision: 8132
Modified:
trunk/docs/mapfile/class.txt
trunk/docs/mapfile/label.txt
trunk/docs/mapfile/layer.txt
trunk/docs/mapfile/map.txt
trunk/docs/mapfile/style.txt
trunk/docs/mapfile/template.txt
Log:
convert internal links to referenced reST labels for sphinx conversion
Modified: trunk/docs/mapfile/class.txt
===================================================================
--- trunk/docs/mapfile/class.txt 2008-11-28 15:29:32 UTC (rev 8131)
+++ trunk/docs/mapfile/class.txt 2008-11-28 16:27:12 UTC (rev 8132)
@@ -53,7 +53,7 @@
GROUP [string]
Allows for grouping of classes. It is only used when a CLASSGROUP at the
- :ref:`LAYER`_ level is set. If the CLASSGROUP parameter is set, only classes that
+ :ref:`LAYER` level is set. If the CLASSGROUP parameter is set, only classes that
have the same group name would be considered at rendering time. An example
of a layer with grouped classes might contain:
@@ -137,7 +137,7 @@
Sets the current display status of the class. Default turns the class on.
STYLE
- Signals the start of a :ref:`STYLE`_ object. A class can contain multiple styles.
+ Signals the start of a :ref:`STYLE` object. A class can contain multiple styles.
SYMBOL [integer|string|filename]
The symbol name or number to use for all features if attribute tables are
Modified: trunk/docs/mapfile/label.txt
===================================================================
--- trunk/docs/mapfile/label.txt 2008-11-28 15:29:32 UTC (rev 8131)
+++ trunk/docs/mapfile/label.txt 2008-11-28 16:27:12 UTC (rev 8132)
@@ -8,7 +8,7 @@
- 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 `RFC 11`_ for specifics).
+ 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"
@@ -27,11 +27,8 @@
PARTIALS FALSE
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
-.. _`RFC 11`: /development/rfc/ms-rfc-11/
-.. _`RFC 19`: /development/rfc/ms-rfc-19/
-
ANTIALIAS [true|false]
Should text be antialiased? Note that this requires more available colors,
decreased drawing performance, and results in slightly larger output images.
@@ -70,10 +67,8 @@
PARTIALS FALSE
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
-.. _`RFC 19`: /development/rfc/ms-rfc-19/
-
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
@@ -135,7 +130,7 @@
PARTIALS FALSE
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
.. _`RFC 19`: /development/rfc/ms-rfc-19/
@@ -192,7 +187,7 @@
PARTIALS FALSE
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
TYPE [bitmap|truetype]
Type of font to use. Generally bitmap fonts are faster to draw then
Modified: trunk/docs/mapfile/layer.txt
===================================================================
--- trunk/docs/mapfile/layer.txt 2008-11-28 15:29:32 UTC (rev 8131)
+++ trunk/docs/mapfile/layer.txt 2008-11-28 16:27:12 UTC (rev 8132)
@@ -12,7 +12,7 @@
CLASSGROUP [string]
Specify the class's group that would be considered at rendering time.
- The `CLASS`_ object's GROUP parameter must be used in combination with
+ The :ref:`CLASS` object's GROUP parameter must be used in combination with
CLASSGROUP.
CONNECTION [string]
@@ -106,14 +106,10 @@
variable.
The DEBUG setting can also be specified for the entire map, by setting the
- DEBUG parameter in the `MAP`_ object.
+ DEBUG parameter in the :ref:`MAP` object.
- .. _`MAP`: /docs/reference/mapfile/mapObj
+ For more details on this debugging mechanism, please see :ref:`RFC28`.
- For more details on this debugging mechanism, please see `RFC 28`_.
-
- .. _`RFC 28`: /development/rfc/ms-rfc-28
-
*Debugging with MapServer versions < 5:*
Verbose output is generated and sent to the standard error output (STDERR)
@@ -127,10 +123,8 @@
used with WMS GetFeatureInfo operations. "false" by default.
FEATURE
- Signals the start of a `FEATURE`_ object.
+ Signals the start of a :ref:`FEATURE` object.
-.. _`FEATURE`: /docs/reference/mapfile/feature
-
.. _FILTER:
FILTER [string]
@@ -150,10 +144,8 @@
Multiresult query modes only.
GRID
- Signals the start of a `GRID`_ object.
+ Signals the start of a :ref:`GRID` object.
-.. _`GRID`: /docs/reference/mapfile/grid
-
GROUP [name]
Name of a group that this layer belongs to. The group name can then be
reference as a regular layer name in the template files, allowing to do
@@ -164,10 +156,8 @@
Multiresult query modes only.
JOIN
- Signals the start of a `JOIN`_ object.
+ Signals the start of a :ref:`JOIN` object.
-.. _`JOIN`: /docs/reference/mapfile/join
-
LABELANGLEITEM [attribute]
(As of MapServer 5.0 this parameter is no longer available. Please see
the :ref:`LABEL` object's ANGLE parameter)
@@ -325,15 +315,13 @@
PROCESSING "CLOSE_CONNECTION=DEFER"
PROJECTION
- Signals the start of a `PROJECTION`_ object.
+ Signals the start of a :ref:`PROJECTION` object.
-.. _`PROJECTION`: /docs/reference/mapfile/projection
-
REQUIRES [expression]
Sets context for displaying this layer (see LABELREQUIRES_).
SIZEUNITS [pixels|feet|inches|kilometers|meters|miles|
- Sets the unit of `CLASS`_ object SIZE values (default is pixels).
+ Sets the unit of :ref:`CLASS` object SIZE values (default is pixels).
Useful for simulating buffering.
.. _STATUS:
@@ -408,7 +396,7 @@
set the tolerance to zero.
TOLERANCEUNITS [pixels|feet|inches|kilometers|meters|miles|dd]
- Units of the TOLERANCE_ value. Default is pixels.
+ Units of the TOLERANCE value. Default is pixels.
TRANSPARENCY [integer|alpha] - deprecated
Since MapServer 5.0 the proper parameter to use is OPACITY instead. The
@@ -458,10 +446,8 @@
classifying. If you use it, it's a polygon with a fill color, otherwise
it's a polyline with only an OUTLINECOLOR.
- For CHART layers, see the `Dynamic Charting howto`_.
+ For CHART layers, see the :ref:`Dynamic Charting<dynamic_charting>` howto.
- .. _`Dynamic Charting howto`: /docs/howto/dynamic-charting
-
A circle must be defined by a a minimum bounding rectangle. That is, 2
points that define the smallest square that can contain it. These 2 points
are the two opposite corners of said box.
Modified: trunk/docs/mapfile/map.txt
===================================================================
--- trunk/docs/mapfile/map.txt 2008-11-28 15:29:32 UTC (rev 8131)
+++ trunk/docs/mapfile/map.txt 2008-11-28 16:27:12 UTC (rev 8132)
@@ -37,15 +37,11 @@
CGI_CONTEXT_URL [value]
The CONFIG parameter can be used to enable loading a map context from a URL. See the
- `Map Context howto`_ for more info.
+ :ref:`Map Context howto<map_context>` for more info.
- .. _`Map Context howto`: ../ogc/mapcontext
-
MS_ENCRYPTION_KEY [filename]
The CONFIG parameter can be used to specify an encryption key that is used with
- MapServer's `msencypt utility`_.
-
- .. _`msencypt utility`: ../utilties/msencrypt
+ MapServer's :ref:`msencypt utility<msencrypt>`.
MS_ERRORFILE [filename]
The CONFIG parameter can be used to write MapServer errors to a file (as of MapServer
@@ -171,12 +167,10 @@
variable.
The DEBUG setting can also be specified for a layer, by setting the DEBUG
- parameter in the `LAYER`_ object.
+ parameter in the :ref:`LAYER` object.
- For more details on this debugging mechanism, please see `RFC 28`_.
+ For more details on this debugging mechanism, please see :ref:`RFC28`.
- .. _`RFC 28`: /development/rfc/ms-rfc-28
-
*Debugging with MapServer versions < 5:*
Verbose output is generated and sent to the standard error output (STDERR)
@@ -213,7 +207,7 @@
or internally generated :ref:`OUTPUTFORMAT` section.
INTERLACE [on|off]
- *Deprecated* Use FORMATOPTION "INTERLACE=ON" in the `OUTPUTFORMAT`_
+ *Deprecated* Use FORMATOPTION "INTERLACE=ON" in the :ref:`OUTPUTFORMAT`
declaration to specify if the output images should be interlaced.
LAYER
Modified: trunk/docs/mapfile/style.txt
===================================================================
--- trunk/docs/mapfile/style.txt 2008-11-28 15:29:32 UTC (rev 8131)
+++ trunk/docs/mapfile/style.txt 2008-11-28 16:27:12 UTC (rev 8132)
@@ -15,7 +15,7 @@
ANGLE [double|attribute]
- Angle, given in degrees, to draw the line work. Default is 0. For symbols
of Type HATCH, this is the angle of the hatched lines. For its use with
- hatched lines, see Example#8 in the `SYMBOL examples`_.
+ hatched lines, see Example#8 in the :ref:`symbology examples <sym_examples>`.
- [*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"
@@ -32,11 +32,8 @@
WIDTH 3
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
-.. _`RFC 19`: /development/rfc/ms-rfc-19/
-.. _`SYMBOL examples`: /docs/reference/symbology/examples
-
ANGLEITEM [string]
- this parameter was removed in MapServer 5.0. You should use
the ANGLE [*attribute*] parameter instead.
@@ -65,7 +62,7 @@
OUTLINECOLOR 150 150 150
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
MAXSIZE [integer]
Maximum size in pixels to draw a symbol. Default is 50.
@@ -95,13 +92,13 @@
OUTLINECOLOR [MYOUTCOLOR]
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
SIZE [integer|attribute]
- Height, in pixels, of the symbol/pattern to be used. Only useful with
scalable symbols. Default is 1. For symbols of Type HATCH, the SIZE is the
distance between hatched lines. For its use with hatched lines, see
- Example#8 in the `SYMBOL examples`_.
+ Example#8 in the :ref:`symbology examples <sym_examples>`.
- [*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"
@@ -118,7 +115,7 @@
WIDTH 3
END
- The associated RFC document for this feature is `RFC 19`_.
+ The associated RFC document for this feature is :ref:`RFC19`.
SIZEITEM [string]
- this parameter was removed in MapServer 5.0. You should
@@ -141,4 +138,5 @@
WIDTH [integer]
Width refers to the thickness of line work drawn, in pixels. Default is 1.
For symbols of Type HATCH, the WIDTH is how thick the hatched lines are.
- For its use with hatched lines, see Example#8 in the `SYMBOL examples`_.
+ For its use with hatched lines, see Example#8 in the
+ :ref:`symbology examples <sym_examples>`.
Modified: trunk/docs/mapfile/template.txt
===================================================================
--- trunk/docs/mapfile/template.txt 2008-11-28 15:29:32 UTC (rev 8131)
+++ trunk/docs/mapfile/template.txt 2008-11-28 16:27:12 UTC (rev 8132)
@@ -412,7 +412,7 @@
Also available as escaped version.
[toggle_layers] | [toggle_layers_esc]
- List of all layers that can be toggled, i.e. all layers defined in the `mapfile`_
+ List of all layers that can be toggled, i.e. all layers defined in the :ref:`mapfile`
which status is currently not default.
Also available as escaped version.
@@ -420,7 +420,7 @@
[layername_check | select]
Used for making layers persistent across a map creation session. String is
replaced with the keyword "checked", "selected" or "" if layername is on.
- Layername is the name of a layer as it appears in the `mapfile`_. Does not work
+ Layername is the name of a layer as it appears in the :ref:`mapfile`. Does not work
for default layers.
[layername_meta data key]
More information about the mapserver-commits
mailing list