[mapserver-commits] r12946 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Jan 3 07:11:14 EST 2012
Author: havatv
Date: 2012-01-03 04:11:14 -0800 (Tue, 03 Jan 2012)
New Revision: 12946
Modified:
branches/branch-6-0/docs/en/mapfile/label.txt
branches/branch-6-0/docs/en/mapfile/map.txt
branches/branch-6-0/docs/en/mapfile/outputformat.txt
branches/branch-6-0/docs/en/mapfile/scalebar.txt
branches/branch-6-0/docs/en/mapfile/style.txt
branches/branch-6-0/docs/en/mapfile/symbol.txt
trunk/docs/en/mapfile/label.txt
trunk/docs/en/mapfile/map.txt
trunk/docs/en/mapfile/outputformat.txt
trunk/docs/en/mapfile/scalebar.txt
trunk/docs/en/mapfile/style.txt
trunk/docs/en/mapfile/symbol.txt
Log:
Added index entries (#4001) - join, label, map, outputformat, scalebar, style, symbol
Modified: branches/branch-6-0/docs/en/mapfile/label.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/label.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ branches/branch-6-0/docs/en/mapfile/label.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -423,6 +423,12 @@
.. index::
pair: LABEL; TYPE
+.. index::
+ triple: LABEL; TYPE; bitmap
+
+.. index::
+ triple: LABEL; TYPE; truetype
+
TYPE [bitmap|truetype]
Type of font to use. Generally bitmap fonts are faster to draw
then TrueType fonts. However, TrueType fonts are scalable and
Modified: branches/branch-6-0/docs/en/mapfile/map.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/map.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ branches/branch-6-0/docs/en/mapfile/map.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -283,9 +283,21 @@
.. index::
pair: MAP; IMAGETYPE
+.. index::
+ triple: MAP; IMAGETYPE; jpeg
+
+.. index::
+ triple: MAP; IMAGETYPE; pdf
+
+.. index::
+ triple: MAP; IMAGETYPE; png
+
+.. index::
+ triple: MAP; IMAGETYPE; svg
+
.. _imagetype:
-IMAGETYPE [png|jpeg|pdf|...|userdefined]
+IMAGETYPE [jpeg|pdf|png|svg|...|userdefined]
Output format (raster or vector) to generate. The name used here
must match the 'NAME' of a user defined or internally available
:ref:`OUTPUTFORMAT`. For a complete list of available
@@ -441,7 +453,28 @@
.. index::
pair: MAP; UNITS
-UNITS [feet|inches|kilometers|meters|miles|nauticalmiles|dd]
+.. index::
+ triple: MAP; UNITS; dd
+
+.. index::
+ triple: MAP; UNITS; feet
+
+.. index::
+ triple: MAP; UNITS; inches
+
+.. index::
+ triple: MAP; UNITS; kilometers
+
+.. index::
+ triple: MAP; UNITS; meters
+
+.. index::
+ triple: MAP; UNITS; miles
+
+.. index::
+ triple: MAP; UNITS; nauticalmiles
+
+UNITS [dd|feet|inches|kilometers|meters|miles|nauticalmiles]
Units of the map coordinates. Used for scalebar and scale
computations. `Nauticalmiles` was added in MapServer 5.6.
Modified: branches/branch-6-0/docs/en/mapfile/outputformat.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/outputformat.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ branches/branch-6-0/docs/en/mapfile/outputformat.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -243,21 +243,48 @@
for non-raster formats like Flash. Not all formats support all
combinations. For instance GD supports only PC256. (optional)
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; PC256
+
- PC256: Produced a pseudocolored result with up to 256 colors in
the palette (legacy MapServer mode). Only supported for GD/GIF
and GD/PNG.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; RGB
+
- RGB: Render in 24bit Red/Green/Blue mode. Supports all colors
but does not support transparency.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; RGBA
+
- RGBA: Render in 32bit Red/Green/Blue/Alpha mode. Supports all
colors, and alpha based transparency. All features are rendered
against an initially transparent background.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; BYTE
+
- BYTE: Render raw 8bit pixel values (no presentation). Only
works for RASTER layers (through GDAL) and WMS layers currently.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; INT16
+
- INT16: Render raw 16bit signed pixel values (no presentation).
Only works for RASTER layers (through GDAL) and WMS layers currently.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; FLOAT32
+
- FLOAT32: Render raw 32bit floating point pixel values
(no presentation). Only works for RASTER layers (through GDAL)
and WMS layers currently.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; FEATURE
+
- FEATURE: Output is a non-image result, such as features written
via templates or OGR.
Modified: branches/branch-6-0/docs/en/mapfile/scalebar.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/scalebar.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ branches/branch-6-0/docs/en/mapfile/scalebar.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -109,6 +109,24 @@
.. index::
pair: SCALEBAR; UNITS
+.. index::
+ triple: SCALEBAR; UNITS; feet
+
+.. index::
+ triple: SCALEBAR; UNITS; inches
+
+.. index::
+ triple: SCALEBAR; UNITS; kilometers
+
+.. index::
+ triple: SCALEBAR; UNITS; meters
+
+.. index::
+ triple: SCALEBAR; UNITS; miles
+
+.. index::
+ triple: SCALEBAR; UNITS; nauticalmiles
+
UNITS [feet|inches|kilometers|meters|miles|nauticalmiles]
Output scalebar units, default is miles. Used in conjunction with the
map's units to develop the actual graphic. Note that decimal degrees
Modified: branches/branch-6-0/docs/en/mapfile/style.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/style.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ branches/branch-6-0/docs/en/mapfile/style.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -156,6 +156,24 @@
.. index::
pair: STYLE; GEOMTRANSFORM
+.. index::
+ triple: STYLE; GEOMTRANSFORM; bbox
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; end
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; labelpnt
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; labelpoly
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; start
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; vertices
+
GEOMTRANSFORM [bbox|end|labelpnt|labelpoly|start|vertices]
Used to indicate that the current feature will be transformed
before the actual style is applied. Introduced in version 5.4.
@@ -182,6 +200,15 @@
.. index::
pair: STYLE; LINECAP
+.. index::
+ triple: STYLE; LINECAP; butt
+
+.. index::
+ triple: STYLE; LINECAP; round
+
+.. index::
+ triple: STYLE; LINECAP; square
+
LINECAP [butt|round|square]
Sets the line cap type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
@@ -191,6 +218,15 @@
.. index::
pair: STYLE; LINEJOIN
+.. index::
+ triple: STYLE; LINEJOIN; round
+
+.. index::
+ triple: STYLE; LINEJOIN; miter
+
+.. index::
+ triple: STYLE; LINEJOIN; bevel
+
LINEJOIN [round|miter|bevel]
Sets the line join type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
Modified: branches/branch-6-0/docs/en/mapfile/symbol.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/symbol.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ branches/branch-6-0/docs/en/mapfile/symbol.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -29,20 +29,25 @@
:ref:`Construction of Cartographic Symbols <sym_construction>`
document.
-
.. index::
- pair: ANTIALIAS; SYMBOL
+ pair: SYMBOL; ANTIALIAS
ANTIALIAS [true|false]
Should TrueType fonts be antialiased. Only useful for GD (gif)
rendering. Default is false. Has no effect for the other
renderers (where anti-aliasing can not be turned off).
+.. index::
+ pair: SYMBOL; CHARACTER
+
CHARACTER [char]
Character used to reference a particular TrueType font character.
You'll need to figure out the mapping from the keyboard character
to font character.
+.. index::
+ pair: SYMBOL; FILLED
+
FILLED [true|false]
If `true`, the symbol will be filled with a user defined color
(using :ref:`STYLE` `COLOR`). Default is `false`.
@@ -56,19 +61,27 @@
treated as lines (the lines can be given a color using
:ref:`style` `COLOR` and a width using :ref:`style` `WIDTH`).
+.. index::
+ pair: SYMBOL; FONT
+
FONT [string]
Name of TrueType font to use as defined in the :ref:`FONTSET`.
-
GAP [int]
This keyword has been moved to :ref:`STYLE` in version 6.0.
.. deprecated:: 6.0
+.. index::
+ pair: SYMBOL; IAMGE
+
IMAGE [string]
Image (GIF or PNG) to use as a marker or brush for type `pixmap`
symbols.
+.. index::
+ pair: SYMBOL; NAME
+
NAME [string]
Alias for the symbol. To be used in :ref:`CLASS` :ref:`STYLE`
objects.
@@ -93,6 +106,9 @@
.. deprecated:: 6.0
+.. index::
+ pair: SYMBOL; POINTS
+
POINTS [x y] [x y] ... END
Signifies the start of a sequence of points that make up a symbol
@@ -124,6 +140,9 @@
.. deprecated:: 5.0
+.. index::
+ pair: SYMBOL; TRANSPARENT
+
TRANSPARENT [color index]
Sets a transparent color for the input image for pixmap symbols,
or determines whether all shade symbols should have a transparent
@@ -138,6 +157,27 @@
The default (AGG) renderer does not support the `TRANSPARENT`
parameter. It is supported by the GD renderer (GIF).
+.. index::
+ pair: SYMBOL; TYPE
+
+.. index::
+ triple: SYMBOL; TYPE; ellipse
+
+.. index::
+ triple: SYMBOL; TYPE; hatch
+
+.. index::
+ triple: SYMBOL; TYPE; pixmap
+
+.. index::
+ triple: SYMBOL; TYPE; simple
+
+.. index::
+ triple: SYMBOL; TYPE; truetype
+
+.. index::
+ triple: SYMBOL; TYPE; vector
+
TYPE [ellipse|hatch|pixmap|simple|truetype|vector]
- `ellipse`: radius values in the x and y directions define an ellipse.
- `hatch`: produces hatched lines throughout the (polygon) shape.
Modified: trunk/docs/en/mapfile/label.txt
===================================================================
--- trunk/docs/en/mapfile/label.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ trunk/docs/en/mapfile/label.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -423,6 +423,12 @@
.. index::
pair: LABEL; TYPE
+.. index::
+ triple: LABEL; TYPE; bitmap
+
+.. index::
+ triple: LABEL; TYPE; truetype
+
TYPE [bitmap|truetype]
Type of font to use. Generally bitmap fonts are faster to draw
then TrueType fonts. However, TrueType fonts are scalable and
Modified: trunk/docs/en/mapfile/map.txt
===================================================================
--- trunk/docs/en/mapfile/map.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ trunk/docs/en/mapfile/map.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -283,9 +283,21 @@
.. index::
pair: MAP; IMAGETYPE
+.. index::
+ triple: MAP; IMAGETYPE; jpeg
+
+.. index::
+ triple: MAP; IMAGETYPE; pdf
+
+.. index::
+ triple: MAP; IMAGETYPE; png
+
+.. index::
+ triple: MAP; IMAGETYPE; svg
+
.. _imagetype:
-IMAGETYPE [png|jpeg|pdf|...|userdefined]
+IMAGETYPE [jpeg|pdf|png|svg|...|userdefined]
Output format (raster or vector) to generate. The name used here
must match the 'NAME' of a user defined or internally available
:ref:`OUTPUTFORMAT`. For a complete list of available
@@ -441,7 +453,28 @@
.. index::
pair: MAP; UNITS
-UNITS [feet|inches|kilometers|meters|miles|nauticalmiles|dd]
+.. index::
+ triple: MAP; UNITS; dd
+
+.. index::
+ triple: MAP; UNITS; feet
+
+.. index::
+ triple: MAP; UNITS; inches
+
+.. index::
+ triple: MAP; UNITS; kilometers
+
+.. index::
+ triple: MAP; UNITS; meters
+
+.. index::
+ triple: MAP; UNITS; miles
+
+.. index::
+ triple: MAP; UNITS; nauticalmiles
+
+UNITS [dd|feet|inches|kilometers|meters|miles|nauticalmiles]
Units of the map coordinates. Used for scalebar and scale
computations. `Nauticalmiles` was added in MapServer 5.6.
Modified: trunk/docs/en/mapfile/outputformat.txt
===================================================================
--- trunk/docs/en/mapfile/outputformat.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ trunk/docs/en/mapfile/outputformat.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -243,21 +243,48 @@
for non-raster formats like Flash. Not all formats support all
combinations. For instance GD supports only PC256. (optional)
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; PC256
+
- PC256: Produced a pseudocolored result with up to 256 colors in
the palette (legacy MapServer mode). Only supported for GD/GIF
and GD/PNG.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; RGB
+
- RGB: Render in 24bit Red/Green/Blue mode. Supports all colors
but does not support transparency.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; RGBA
+
- RGBA: Render in 32bit Red/Green/Blue/Alpha mode. Supports all
colors, and alpha based transparency. All features are rendered
against an initially transparent background.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; BYTE
+
- BYTE: Render raw 8bit pixel values (no presentation). Only
works for RASTER layers (through GDAL) and WMS layers currently.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; INT16
+
- INT16: Render raw 16bit signed pixel values (no presentation).
Only works for RASTER layers (through GDAL) and WMS layers currently.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; FLOAT32
+
- FLOAT32: Render raw 32bit floating point pixel values
(no presentation). Only works for RASTER layers (through GDAL)
and WMS layers currently.
+
+ .. index::
+ triple: OUTPUTFORMAT; IMAGEMODE; FEATURE
+
- FEATURE: Output is a non-image result, such as features written
via templates or OGR.
Modified: trunk/docs/en/mapfile/scalebar.txt
===================================================================
--- trunk/docs/en/mapfile/scalebar.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ trunk/docs/en/mapfile/scalebar.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -109,6 +109,24 @@
.. index::
pair: SCALEBAR; UNITS
+.. index::
+ triple: SCALEBAR; UNITS; feet
+
+.. index::
+ triple: SCALEBAR; UNITS; inches
+
+.. index::
+ triple: SCALEBAR; UNITS; kilometers
+
+.. index::
+ triple: SCALEBAR; UNITS; meters
+
+.. index::
+ triple: SCALEBAR; UNITS; miles
+
+.. index::
+ triple: SCALEBAR; UNITS; nauticalmiles
+
UNITS [feet|inches|kilometers|meters|miles|nauticalmiles]
Output scalebar units, default is miles. Used in conjunction with the
map's units to develop the actual graphic. Note that decimal degrees
Modified: trunk/docs/en/mapfile/style.txt
===================================================================
--- trunk/docs/en/mapfile/style.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ trunk/docs/en/mapfile/style.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -156,6 +156,24 @@
.. index::
pair: STYLE; GEOMTRANSFORM
+.. index::
+ triple: STYLE; GEOMTRANSFORM; bbox
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; end
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; labelpnt
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; labelpoly
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; start
+
+.. index::
+ triple: STYLE; GEOMTRANSFORM; vertices
+
GEOMTRANSFORM [bbox|end|labelpnt|labelpoly|start|vertices]
Used to indicate that the current feature will be transformed
before the actual style is applied. Introduced in version 5.4.
@@ -229,6 +247,15 @@
.. index::
pair: STYLE; LINECAP
+.. index::
+ triple: STYLE; LINECAP; butt
+
+.. index::
+ triple: STYLE; LINECAP; round
+
+.. index::
+ triple: STYLE; LINECAP; square
+
LINECAP [butt|round|square]
Sets the line cap type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
@@ -238,6 +265,15 @@
.. index::
pair: STYLE; LINEJOIN
+.. index::
+ triple: STYLE; LINEJOIN; round
+
+.. index::
+ triple: STYLE; LINEJOIN; miter
+
+.. index::
+ triple: STYLE; LINEJOIN; bevel
+
LINEJOIN [round|miter|bevel]
Sets the line join type for lines. Default is `round`. See
:ref:`sym_construction` for explanation and examples.
Modified: trunk/docs/en/mapfile/symbol.txt
===================================================================
--- trunk/docs/en/mapfile/symbol.txt 2012-01-03 10:18:57 UTC (rev 12945)
+++ trunk/docs/en/mapfile/symbol.txt 2012-01-03 12:11:14 UTC (rev 12946)
@@ -31,7 +31,7 @@
.. index::
- pair: ANCHORPOINT; SYMBOL
+ pair: SYMBOL; ANCHORPOINT
ANCHORPOINT [x] [y]
Used to specify the location (within the symbol) that is to be
@@ -57,18 +57,24 @@
.. versionadded:: 6.2
.. index::
- pair: ANTIALIAS; SYMBOL
+ pair: SYMBOL; ANTIALIAS
ANTIALIAS [true|false]
Should TrueType fonts be antialiased. Only useful for GD (gif)
rendering. Default is false. Has no effect for the other
renderers (where anti-aliasing can not be turned off).
+.. index::
+ pair: SYMBOL; CHARACTER
+
CHARACTER [char]
Character used to reference a particular TrueType font character.
You'll need to figure out the mapping from the keyboard character
to font character.
+.. index::
+ pair: SYMBOL; FILLED
+
FILLED [true|false]
If `true`, the symbol will be filled with a user defined color
(using :ref:`STYLE` `COLOR`). Default is `false`.
@@ -82,19 +88,27 @@
treated as lines (the lines can be given a color using
:ref:`style` `COLOR` and a width using :ref:`style` `WIDTH`).
+.. index::
+ pair: SYMBOL; FONT
+
FONT [string]
Name of TrueType font to use as defined in the :ref:`FONTSET`.
-
GAP [int]
This keyword has been moved to :ref:`STYLE` in version 6.0.
.. deprecated:: 6.0
+.. index::
+ pair: SYMBOL; IMAGE
+
IMAGE [string]
Image (GIF or PNG) to use as a marker or brush for type `pixmap`
symbols.
+.. index::
+ pair: SYMBOL; NAME
+
NAME [string]
Alias for the symbol. To be used in :ref:`CLASS` :ref:`STYLE`
objects.
@@ -119,6 +133,9 @@
.. deprecated:: 6.0
+.. index::
+ pair: SYMBOL; POINTS
+
POINTS [x y] [x y] ... END
Signifies the start of a sequence of points that make up a symbol
@@ -150,6 +167,9 @@
.. deprecated:: 5.0
+.. index::
+ pair: SYMBOL; TRANSPARENT
+
TRANSPARENT [color index]
Sets a transparent color for the input image for pixmap symbols,
or determines whether all shade symbols should have a transparent
@@ -164,6 +184,27 @@
The default (AGG) renderer does not support the `TRANSPARENT`
parameter. It is supported by the GD renderer (GIF).
+.. index::
+ pair: SYMBOL; TYPE
+
+.. index::
+ triple: SYMBOL; TYPE; ellipse
+
+.. index::
+ triple: SYMBOL; TYPE; hatch
+
+.. index::
+ triple: SYMBOL; TYPE; pixmap
+
+.. index::
+ triple: SYMBOL; TYPE; simple
+
+.. index::
+ triple: SYMBOL; TYPE; truetype
+
+.. index::
+ triple: SYMBOL; TYPE; vector
+
TYPE [ellipse|hatch|pixmap|simple|truetype|vector]
- `ellipse`: radius values in the x and y directions define an ellipse.
- `hatch`: produces hatched lines throughout the (polygon) shape.
More information about the mapserver-commits
mailing list