[postgis-commits] svn - r3558 - trunk/doc

[postgis-commits at postgis.refractions.net]

Author: kneufeld
Date: 2009-01-22 10:02:34 -0800 (Thu, 22 Jan 2009)
New Revision: 3558

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
moved over |>> from reference.xml to reference_new.xml in the documentation

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2009-01-22 17:46:20 UTC (rev 3557)
+++ trunk/doc/reference.xml	2009-01-22 18:02:34 UTC (rev 3558)
@@ -159,15 +159,6 @@
 
       <variablelist>
         <varlistentry>
-          <term>A |&gt;&gt; B</term>
-
-          <listitem>
-            <para>The "|&gt;&gt;" operator returns true if A's bounding box is
-            strictly above B's bounding box.</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>A ~= B</term>
 
           <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2009-01-22 17:46:20 UTC (rev 3557)
+++ trunk/doc/reference_new.xml	2009-01-22 18:02:34 UTC (rev 3558)
@@ -7975,7 +7975,7 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Right" />, <xref linkend="ST_Geometry_Below" /></para>
+		    <para><xref linkend="ST_Geometry_Right" />, <xref linkend="ST_Geometry_Above" />, <xref linkend="ST_Geometry_Below" /></para>
 		  </refsection>
 		</refentry>
 
@@ -8039,7 +8039,7 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Left" />, <xref linkend="ST_Geometry_Right" /></para>
+		    <para><xref linkend="ST_Geometry_Left" />, <xref linkend="ST_Geometry_Right" />, <xref linkend="ST_Geometry_Above" /></para>
 		  </refsection>
 		</refentry>
 		
@@ -8103,7 +8103,7 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Left" />, <xref linkend="ST_Geometry_Below" /></para>
+		    <para><xref linkend="ST_Geometry_Left" />, <xref linkend="ST_Geometry_Above" />, <xref linkend="ST_Geometry_Below" /></para>
 		  </refsection>
 		</refentry>
 
@@ -8176,6 +8176,70 @@
 		  </refsection>
 		</refentry>
 		
+		<refentry id="ST_Geometry_Above">	
+		  <refnamediv>
+		    <refname>|&gt;&gt;</refname>
+		
+		    <refpurpose>Returns <varname>TRUE</varname> if A is strictly above B.</refpurpose>
+		  </refnamediv>
+		
+		  <refsynopsisdiv>
+		    <funcsynopsis>
+		      <funcprototype>
+		        <!-- TODO: Ideally, it would be nice if this coule be reordered to 
+		        "boolean (geometry A |>> geometry B)" instead of 
+		        "boolean |>>( geometry A, geometry B)" -->
+		        <funcdef>boolean <function>|&gt;&gt;</function></funcdef>
+		
+		        <paramdef>
+		          <type>geometry </type>
+		
+		          <parameter>A</parameter>
+		        </paramdef>
+		
+		        <paramdef>
+		          <type>geometry </type>
+		
+		          <parameter>B</parameter>
+		        </paramdef>
+		      </funcprototype>
+		    </funcsynopsis>
+		  </refsynopsisdiv>
+		
+		  <refsection>
+		    <title>Description</title>
+		
+		    <para>The <varname>|&gt;&gt;</varname> operator returns <varname>TRUE</varname> if the bounding box of geometry A
+            is strickly to the right of the bounding box of geometry B.</para>
+		  </refsection>
+		
+		  <refsection>
+		    <title>Examples</title>
+		
+		    <programlisting>SELECT tbl1.column1, tbl2.column1, tbl1.column2 |&gt;&gt; tbl2.column2 AS overlaps
+FROM 
+  ( VALUES
+	(1, 'LINESTRING (1 4, 1 7)'::geometry)) AS tbl1,
+  ( VALUES
+	(2, 'LINESTRING (0 0, 4 2)'::geometry), 
+	(3, 'LINESTRING (6 1, 6 5)'::geometry), 
+	(4, 'LINESTRING (2 3, 5 6)'::geometry)) AS tbl2;
+
+ column1 | column1 | overlaps 
+---------+---------+----------
+       1 |       2 | t
+       1 |       3 | f
+       1 |       4 | f
+(3 rows)</programlisting>
+		  </refsection>
+		
+		  <refsection>
+		    <title>See Also</title>
+		
+		    <para><xref linkend="ST_Geometry_Left" />, <xref linkend="ST_Geometry_Right" />, <xref linkend="ST_Geometry_Below" /></para>
+		  </refsection>
+		</refentry>
+
 		<refentry id="ST_Geometry_EQ">	
 		  <refnamediv>
 		    <refname>&#61;</refname>