[mapserver-commits] r12515 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Mon Sep 5 04:46:09 EDT 2011
Author: havatv
Date: 2011-09-05 01:46:09 -0700 (Mon, 05 Sep 2011)
New Revision: 12515
Modified:
branches/branch-6-0/docs/en/mapfile/expressions.txt
trunk/docs/en/mapfile/expressions.txt
Log:
Added index entries (#4001) - expressions
Modified: branches/branch-6-0/docs/en/mapfile/expressions.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/expressions.txt 2011-09-05 07:12:58 UTC (rev 12514)
+++ branches/branch-6-0/docs/en/mapfile/expressions.txt 2011-09-05 08:46:09 UTC (rev 12515)
@@ -331,6 +331,9 @@
input and return logical values. A logical expression is either 'true'
or 'false'.
+.. index::
+ pair: Expressions; and
+
* ( ( Expression1 ) AND ( Expression2 ) )
( ( Expression1 ) && ( Expression2 ) )
@@ -339,6 +342,9 @@
Expression2) are true.
+.. index::
+ pair: Expressions; or
+
* ( ( Expression1 ) OR ( Expression2 ) )
( ( Expression1 ) || ( Expression2 ) )
@@ -346,6 +352,9 @@
returns true when at least one of the logical expressions (Expression1
or Expression2) is true.
+.. index::
+ pair: Expressions; not
+
* NOT ( Expression1 )
! ( Expression1 )
@@ -361,6 +370,9 @@
Syntactically, a sting is something encapsulated in single or double
quotes.
+.. index::
+ pair: Expressions; eq
+
* ( "String1" eq "String2" )
( "String1" == "String2" ) - deprecated since 6.0
@@ -373,24 +385,36 @@
returns true when the strings are equal. Case insensitive.
+.. index::
+ pair: Expressions; ne
+
* ( "String1" != "String2" )
( "String1" ne "String2" )
returns true when the strings are not equal.
+.. index::
+ pair: Expressions; lt
+
* ( "String1" < "String2" )
( "String1" lt "String2" )
returns true when "String1" is lexicographically smaller than "String2"
+.. index::
+ pair: Expressions; gt
+
* ( "String1" > "String2" )
( "String1" gt "String2" )
returns true when "String1" is lexicographically larger than "String2".
+.. index::
+ pair: Expressions; le
+
* ( "String1" <= "String2" )
( "String1" le "String2" )
@@ -398,6 +422,9 @@
returns true when "String1" is lexicographically smaller than or equal
to "String2"
+.. index::
+ pair: Expressions; ge
+
* ( "String1" >= "String2" )
( "String1" ge "String2" )
@@ -405,6 +432,9 @@
returns true when "String1" is lexicographically larger than or equal
to "String2".
+.. index::
+ pair: Expressions; in
+
* ( "String1" IN "token1,token2,...,tokenN" )
returns true when "String1" is equal to one of the given tokens.
@@ -436,6 +466,9 @@
The basic element for arithmetic operations is the number. Arithmetic
operations that return numbers will be covered in the next section.
+.. index::
+ pair: Expressions; eq
+
* ( n1 eq n2 )
( n1 == n2 ) - deprecated since 6.0
@@ -485,49 +518,97 @@
Spatial expressions that return a logical value (GEOS)
...............................................................................
+.. index::
+ pair: Expressions; eq
+
* ( shape1 eq shape2 )
returns true if shape1 and shape2 are equal
+.. index::
+ pair: Expressions; intersects
+
* ( shape1 intersects shape2 )
returns true if shape1 and shape2 intersect
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; disjoint
+
* ( shape1 disjoint shape2 )
returns true if shape1 and shape2 are disjoint
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; touches
+
* ( shape1 touches shape2 )
returns true if shape1 and shape2 touch
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; overlaps
+
* ( shape1 overlaps shape2 )
returns true if shape1 and shape2 overlap
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; crosses
+
* ( shape1 crosses shape2 )
returns true if shape1 and shape2 cross
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; within
+
* ( shape1 within shape2 )
returns true if shape1 is within shape2
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; contains
+
* ( shape1 contains shape2 )
returns true if shape1 contains shape2
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; dwithin
+
* ( shape1 dwithin shape2 )
returns true if the distance between shape1 and shape2
is equal to 0
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; beyond
+
* ( shape1 beyond shape2 )
returns true if the distance between shape1 and shape2
is greater than 0
+ .. versionadded:: 6.0
+
.. index::
pair: Expressions; String operations
@@ -543,16 +624,25 @@
Functions that return a string
...............................................................................
+.. index::
+ pair: Expressions; tostring
+
* tostring ( n1, "Format1" )
uses "Format1" to format the number n1 (C style formatting
- sprintf).
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; commify
+
* commify ( "String1" )
adds thousands separators (commas) to a long number to make it
more readable
+ .. versionadded:: 6.0
.. index::
pair: Expressions; String functions
@@ -560,6 +650,9 @@
String functions that return a number
...............................................................................
+.. index::
+ pair: Expressions; length
+
* length ( "String1" )
returns the number of characters of "String1"
@@ -571,10 +664,15 @@
Arithmetic operations and functions that return a number
...............................................................................
+.. index::
+ pair: Expressions; round
+
* round ( n1 , n2 )
returns n1 rounded to a multiple of n2: n2 * round(n1/n2)
+ .. versionadded:: 6.0
+
* n1 + n2
returns the sum of n1 and n2
@@ -625,14 +723,22 @@
Spatial functions that return a number (GEOS)
...............................................................................
+.. index::
+ pair: Expressions; area
+
* area ( shape1 )
returns the area of shape1
+ .. versionadded:: 6.0
+
Spatial functions that return a shape (GEOS)
...............................................................................
+.. index::
+ pair: Expressions; fromtext
+
* fromtext ( "String1" )
returns the shape corresponding to String1 (WKT - well known text)
@@ -641,17 +747,29 @@
fromText('POINT(500000 5000000)')
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; buffer
+
* buffer (shape1 , n1 )
returns the shape that results when shape1 is buffered with
bufferdistance n1
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; difference
+
* difference ( shape1 , shape2 )
returns the shape that results when the common area of
shape1 and shape2 is subtracted from shape1
+ .. versionadded:: 6.0
+
.. index::
pair: Expressions; Temporal expressions
@@ -685,6 +803,9 @@
For temporal values obtained this way, the following operations are
supported:
+.. index::
+ pair: Expressions; eq
+
* ( t1 eq t2 )
( t1 == t2 ) - deprecated since 6.0
@@ -693,30 +814,45 @@
returns true when the times are equal.
+.. index::
+ pair: Expressions; ne
+
* ( t1 != t2 )
( t1 ne t2 )
returns true when the times are not equal.
+.. index::
+ pair: Expressions; lt
+
* ( t1 < t2 )
( t1 lt t2 )
returns true when t1 is earlier than t2
+.. index::
+ pair: Expressions; gt
+
* ( t1 > t2 )
( t1 gt t2 )
returns true when t1 is later than t2.
+.. index::
+ pair: Expressions; le
+
* ( t1 <= t2 )
( t1 le t2 )
returns true when t1 is earlier than or equal to t2
+.. index::
+ pair: Expressions; ge
+
* ( t1 >= t2 )
( t1 ge t2 )
Modified: trunk/docs/en/mapfile/expressions.txt
===================================================================
--- trunk/docs/en/mapfile/expressions.txt 2011-09-05 07:12:58 UTC (rev 12514)
+++ trunk/docs/en/mapfile/expressions.txt 2011-09-05 08:46:09 UTC (rev 12515)
@@ -331,6 +331,9 @@
input and return logical values. A logical expression is either 'true'
or 'false'.
+.. index::
+ pair: Expressions; and
+
* ( ( Expression1 ) AND ( Expression2 ) )
( ( Expression1 ) && ( Expression2 ) )
@@ -339,6 +342,9 @@
Expression2) are true.
+.. index::
+ pair: Expressions; or
+
* ( ( Expression1 ) OR ( Expression2 ) )
( ( Expression1 ) || ( Expression2 ) )
@@ -346,6 +352,9 @@
returns true when at least one of the logical expressions (Expression1
or Expression2) is true.
+.. index::
+ pair: Expressions; not
+
* NOT ( Expression1 )
! ( Expression1 )
@@ -361,6 +370,9 @@
Syntactically, a sting is something encapsulated in single or double
quotes.
+.. index::
+ pair: Expressions; eq
+
* ( "String1" eq "String2" )
( "String1" == "String2" ) - deprecated since 6.0
@@ -373,24 +385,36 @@
returns true when the strings are equal. Case insensitive.
+.. index::
+ pair: Expressions; ne
+
* ( "String1" != "String2" )
( "String1" ne "String2" )
returns true when the strings are not equal.
+.. index::
+ pair: Expressions; lt
+
* ( "String1" < "String2" )
( "String1" lt "String2" )
returns true when "String1" is lexicographically smaller than "String2"
+.. index::
+ pair: Expressions; gt
+
* ( "String1" > "String2" )
( "String1" gt "String2" )
returns true when "String1" is lexicographically larger than "String2".
+.. index::
+ pair: Expressions; le
+
* ( "String1" <= "String2" )
( "String1" le "String2" )
@@ -398,6 +422,9 @@
returns true when "String1" is lexicographically smaller than or equal
to "String2"
+.. index::
+ pair: Expressions; ge
+
* ( "String1" >= "String2" )
( "String1" ge "String2" )
@@ -405,6 +432,9 @@
returns true when "String1" is lexicographically larger than or equal
to "String2".
+.. index::
+ pair: Expressions; in
+
* ( "String1" IN "token1,token2,...,tokenN" )
returns true when "String1" is equal to one of the given tokens.
@@ -436,6 +466,9 @@
The basic element for arithmetic operations is the number. Arithmetic
operations that return numbers will be covered in the next section.
+.. index::
+ pair: Expressions; eq
+
* ( n1 eq n2 )
( n1 == n2 ) - deprecated since 6.0
@@ -485,49 +518,97 @@
Spatial expressions that return a logical value (GEOS)
...............................................................................
+.. index::
+ pair: Expressions; eq
+
* ( shape1 eq shape2 )
returns true if shape1 and shape2 are equal
+.. index::
+ pair: Expressions; intersects
+
* ( shape1 intersects shape2 )
returns true if shape1 and shape2 intersect
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; disjoint
+
* ( shape1 disjoint shape2 )
returns true if shape1 and shape2 are disjoint
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; touches
+
* ( shape1 touches shape2 )
returns true if shape1 and shape2 touch
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; overlaps
+
* ( shape1 overlaps shape2 )
returns true if shape1 and shape2 overlap
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; crosses
+
* ( shape1 crosses shape2 )
returns true if shape1 and shape2 cross
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; within
+
* ( shape1 within shape2 )
returns true if shape1 is within shape2
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; contains
+
* ( shape1 contains shape2 )
returns true if shape1 contains shape2
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; dwithin
+
* ( shape1 dwithin shape2 )
returns true if the distance between shape1 and shape2
is equal to 0
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; beyond
+
* ( shape1 beyond shape2 )
returns true if the distance between shape1 and shape2
is greater than 0
+ .. versionadded:: 6.0
+
.. index::
pair: Expressions; String operations
@@ -543,16 +624,25 @@
Functions that return a string
...............................................................................
+.. index::
+ pair: Expressions; tostring
+
* tostring ( n1, "Format1" )
uses "Format1" to format the number n1 (C style formatting
- sprintf).
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; commify
+
* commify ( "String1" )
adds thousands separators (commas) to a long number to make it
more readable
+ .. versionadded:: 6.0
.. index::
pair: Expressions; String functions
@@ -560,6 +650,9 @@
String functions that return a number
...............................................................................
+.. index::
+ pair: Expressions; length
+
* length ( "String1" )
returns the number of characters of "String1"
@@ -571,10 +664,15 @@
Arithmetic operations and functions that return a number
...............................................................................
+.. index::
+ pair: Expressions; round
+
* round ( n1 , n2 )
returns n1 rounded to a multiple of n2: n2 * round(n1/n2)
+ .. versionadded:: 6.0
+
* n1 + n2
returns the sum of n1 and n2
@@ -625,14 +723,22 @@
Spatial functions that return a number (GEOS)
...............................................................................
+.. index::
+ pair: Expressions; area
+
* area ( shape1 )
returns the area of shape1
+ .. versionadded:: 6.0
+
Spatial functions that return a shape (GEOS)
...............................................................................
+.. index::
+ pair: Expressions; fromtext
+
* fromtext ( "String1" )
returns the shape corresponding to String1 (WKT - well known text)
@@ -641,17 +747,29 @@
fromText('POINT(500000 5000000)')
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; buffer
+
* buffer (shape1 , n1 )
returns the shape that results when shape1 is buffered with
bufferdistance n1
+ .. versionadded:: 6.0
+
+.. index::
+ pair: Expressions; difference
+
* difference ( shape1 , shape2 )
returns the shape that results when the common area of
shape1 and shape2 is subtracted from shape1
+ .. versionadded:: 6.0
+
.. index::
pair: Expressions; Temporal expressions
@@ -685,6 +803,9 @@
For temporal values obtained this way, the following operations are
supported:
+.. index::
+ pair: Expressions; eq
+
* ( t1 eq t2 )
( t1 == t2 ) - deprecated since 6.0
@@ -693,30 +814,45 @@
returns true when the times are equal.
+.. index::
+ pair: Expressions; ne
+
* ( t1 != t2 )
( t1 ne t2 )
returns true when the times are not equal.
+.. index::
+ pair: Expressions; lt
+
* ( t1 < t2 )
( t1 lt t2 )
returns true when t1 is earlier than t2
+.. index::
+ pair: Expressions; gt
+
* ( t1 > t2 )
( t1 gt t2 )
returns true when t1 is later than t2.
+.. index::
+ pair: Expressions; le
+
* ( t1 <= t2 )
( t1 le t2 )
returns true when t1 is earlier than or equal to t2
+.. index::
+ pair: Expressions; ge
+
* ( t1 >= t2 )
( t1 ge t2 )
More information about the mapserver-commits
mailing list