[mapserver-commits] r7470 - trunk/docs/references/templatereference
svn at osgeo.org
svn at osgeo.org
Thu Mar 20 10:28:12 EDT 2008
Author: jmckenna
Date: 2008-03-20 10:28:12 -0400 (Thu, 20 Mar 2008)
New Revision: 7470
Modified:
trunk/docs/references/templatereference/templatereference.txt
Log:
try and remove weird formatting for the definition lists
Modified: trunk/docs/references/templatereference/templatereference.txt
===================================================================
--- trunk/docs/references/templatereference/templatereference.txt 2008-03-20 13:42:36 UTC (rev 7469)
+++ trunk/docs/references/templatereference/templatereference.txt 2008-03-20 14:28:12 UTC (rev 7470)
@@ -75,26 +75,21 @@
-------
[version]
-
The MapServer version number.
[id]
-
Unique session id. The id can be passed in via a form but is more commonly generated
by the software. In that case the id is a concatenation of UNIX time (or NT equivalent)
and the process id. Unless you're getting more requests in a second than the system
has process ids the id can be considered unique. ;->
[host]
-
Hostname of the web server.
[port]
-
Port the web server is listening to.
[post or get variable name], [post or get variable name_esc]
-
The contents of any variables passed to the MapServer, whether they were used or not,
can be echoed this way. One use might be to have the user set a map title or north
arrow style in an interactive map composer. The system doesn't care about the values,
@@ -105,13 +100,11 @@
Also available as escaped version.
[web_meta data key],[web_meta data key_esc]
-
Web object meta data access (e.g [web_projection]
Also available as escaped version.
[errmsg], [errmsg_esc]
-
Current error stack output. Various error messages are delimited by semi-colons.
Also available as escaped version.
@@ -120,7 +113,6 @@
--------------
[img]
-
Path (relative to document root) of the new image, just the image name if I
MAGE_URL is not set in the mapfile.
@@ -129,11 +121,9 @@
image (if a QUERYMAP object is defined in the `mapfile`_.
[ref]
-
Path (relative to document root) of the new reference image.
[legend]
-
Path (relative to document root) of new legend image rendered by the MapServer.
Since version 3.5.1 a new HTML Legend template is provided by MapServer. If a
@@ -141,47 +131,38 @@
legend as. See the `HTML Legend howto`_ for details.
[scalebar]
-
Path (relative to document root) of new scalebar image.
[queryfile]
-
Path to the query file (if savequery was set as a `CGI Parameter`_).
[map]
-
Path to the map file (if savemap was set as a `CGI Parameter`_).
Image Geometry
--------------
[center]
-
Computed image center in pixels. Useful for setting imgxy form variable when
map sizes change.
[center_x], [center_y]
-
Computed image center X or Y coordinate in pixels.
[mapsize], [mapsize_esc]
-
Current image size in cols and rows (separated by spaces).
Also available as escaped version.
[mapwidth], [mapheight]
-
Current image width or height.
[scale]
-
Current image scale. The exact value is not appropriate for user information
but essential for some applications. The value can be rounded e.g. using
JavaScript or server side post processing.
[cellsize]
-
Size of an pixel in the current image in map units. Useful for distance
measurement tools in user interfaces.
@@ -189,27 +170,22 @@
------------
[mapx], [mapy]
-
X and Y coordinate of mouse click.
[mapext], [mapext_esc]
-
Full mapextent (separated by spaces).
Also available as escaped version.
[minx], [miny], [maxx], [maxy]
-
Minimum / maximum X or Y coordinate of new map extent.
[dx], [dy]
-
The differences of minimum / maximum X or Y coordinate of new map extent.
Useful for creating cachable extents (i.e. 0 0 dx dy) with legends and scalebars
[rawext], [rawext_esc]
-
Raw mapextent, that is the extent before fitting to a window size (separated
by spaces). In cases where input came from imgbox (via Java or whatever) rawext
refers to imgbox coordinates transformed to map units.
@@ -219,29 +195,24 @@
Useful for spatial query building.
[rawminx], [rawminy], [rawmaxx], [rawmaxy]
-
Minimum / maximum X or Y coordinate of a raw map/search extent.
The following substitutions are only available if the MapServer was compiled with
PROJ support and a projection is defined in the `mapfile`_.
[maplon], [maplat]
-
Longitude / latitude value of mouse click. Available only when projection enabled.
[mapext_latlon], [mapext_latlon_esc]
-
Full mapextent (separated by spaces). Available only when projection enabled.
Also available as escaped version.
[minlon], [minlat], [maxlon] [maxlat]
-
Minimum / maximum longitude or latitude value of mapextent. Available only when
projection enabled.
[refext], [refext_esc]
-
Reference map extent (separated by spaces).
Also available as escaped version.
@@ -253,34 +224,29 @@
-----
[layers] | [layers_esc]
-
All active layers space delimited. Used for a "POST" request.
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`_
which status is currently not default.
Also available as escaped version.
[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
for default layers.
[layername_meta data key]
-
Layer meta data access (e.g. [streets_build] the underscore is essential).
Zoom
----
[zoom_minzoom to maxzoom_check|select]
-
Used for making the zoom factor persistent. Zoom values can range from -25
to 25 by default. The string is replaced with the HTML keyword "checked",
"selected" or "" depending on the current zoom value.
@@ -289,7 +255,6 @@
while a [zoom_13_select] in the same HTML template file is not.
[zoomdir\_-1|0|1_check|select]
-
Used for making the zoom direction persistent. Use check with a radio control
or select with a selection list. See the demo for an example. The string
is replaced with the HTML keyword "checked", "selected" or "" depending on
@@ -302,34 +267,27 @@
a result of a query.
[shpext], [shpext_esc]
-
Extent of current shape plus a 5 percent buffer. Available only when processing
query results.
[shpminx], [shpminy], [shpmaxx], [shpmaxy]
-
Minimum / maximum X or Y coordinate of shape extent. Available only when
processing query results.
[shpmid]
-
Middle of the extent of current shape. Available only when processing query results.
[shpmidx], [shpmidy]
-
X or Y coordinate of middle of the extent of the current shape. Available only
when processing query results.
[shpidx]
-
Index value of the current shape. Available only when processing query results.
[shpclass]
-
Classindex value of the current shape. Available only when processing query results.
[shpxy formatting options]
-
The list of shape coordinates, with list formatting options, especially useful
for SVG.
@@ -341,32 +299,25 @@
Available attributes (h = header, f=footer, s=seperator):
cs=
-
Coordinate seperator, default is comma (",").
xh=, xf=
-
Characters to put before and after the x coordinates (defaults are xh="" and xf=" ").
yh= yf=
-
Characters to put before and after the y coordinates (defaults are no characters).
ph=, pf=, ps=
-
Characters to put before and after and seperators between feature parts (e.g.
holes, defaults are no characters).
sh=, sf=
-
Characters to put before and after a feature (defaults are no characters)
precision=
-
The number of decimal places to output for coordinates (default is 0).
proj=
-
The output projection definition for the coordinates (default is none),
a special value of "image" will convert to image coordinates.
@@ -376,12 +327,10 @@
[shpxy xh="(" yf=")"] will result in: (x1 y1),(x2 y2),(x3 y3)
[tileindex]
-
Index value of the current tile. If no tiles used for the current shape
this is replaced by \"-1\". Available only when processing query results.
[DBASE item name],[DBASE item name_esc],[DBASE item name_raw]
-
Item name from the attribute table of a queried layer. Only attributes for the
active query layers are accessible. Case must be the same as what is stored
in the DBASE file. ArcView, for example, uses all caps for shapefile field
@@ -392,7 +341,6 @@
available.
[Join name_DBASE item name],[Join name_DBASE item name_esc], [Join name_DBASE item name_raw]
-
One-to-one joins: First the join name (as specified in the `mapfile`_ has to
be given, second the tables fields can be accessed similar to the layers
attribute data. Available only when processing query results.
@@ -401,13 +349,11 @@
addition the escaped version (for use in URLs) as well as the raw data is available.
[join_Join name]
-
One-to-many joins: The more complex variant. If the join type is multiple
(one-to-many) the template is replaced by the set of header, template file
and footer specified in the `mapfile`_.
[metadata_meta data key], [metadata_meta data key_esc]
-
Queried layer meta data access (e.g [metadata_projection]
Also available as escaped version.
@@ -418,32 +364,26 @@
ARE available for display to the user.
[nr]
-
Total number of results. Useful in web header and footers. Available only
when processing query results.
[nl]
-
Number of layers returning results. Useful in web header and footers. Available
only when processing query results.
[nlr]
-
Total number of results within the current layer. Useful in web header and footers.
Available only when processing query results.
[rn]
-
Result number within all layers. Starts at 1. Useful in web header and footers.
Available only when processing query results.
[lrn]
-
Result number within the current layer. Starts at 1. Useful in query templates.
Available only when processing query results.
[cl]
-
Current layer name. Useful in layer headers and footers. Available only when processing
query results.
@@ -529,7 +469,7 @@
Copyright Information
---------------------
-Copyright (c) 2001, 2002, 2003, 2004, Frank Koormann, Steve Lime.
+Copyright (c) 2008, Frank Koormann, Steve Lime.
This documentation is covered by the same Open Source license as the MapServer
software itself. See MapServer's `License and Credits`__ page for the complete
More information about the mapserver-commits
mailing list