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

[postgis-commits at postgis.refractions.net]

Author: kneufeld
Date: 2009-01-21 17:16:10 -0800 (Wed, 21 Jan 2009)
New Revision: 3551

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 00:44:07 UTC (rev 3550)
+++ trunk/doc/reference.xml	2009-01-22 01:16:10 UTC (rev 3551)
@@ -177,15 +177,6 @@
         </varlistentry>
 
         <varlistentry>
-          <term>A |&amp;&gt; B</term>
-
-          <listitem>
-            <para>The "|&amp;&gt;" operator returns true if A's bounding box
-            overlaps or is above B's bounding box.</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>A &lt;&lt;| B</term>
 
           <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2009-01-22 00:44:07 UTC (rev 3550)
+++ trunk/doc/reference_new.xml	2009-01-22 01:16:10 UTC (rev 3551)
@@ -7700,7 +7700,11 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overright" />, <xref linkend="ST_Geometry_Overbelow" /></para>
+		    <para>
+		    	<xref linkend="ST_Geometry_Overabove" />,
+		    	<xref linkend="ST_Geometry_Overright" />, 
+		    	<xref linkend="ST_Geometry_Overbelow" />,
+		    	<xref linkend="ST_Geometry_Overleft" /></para>
 		  </refsection>
 		</refentry>
 
@@ -7765,7 +7769,11 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overright" />, <xref linkend="ST_Geometry_Overbelow" /></para>
+		    <para>
+		    	<xref linkend="ST_Geometry_Overlaps" />, 
+		    	<xref linkend="ST_Geometry_Overabove" />,
+		    	<xref linkend="ST_Geometry_Overright" />, 
+		    	<xref linkend="ST_Geometry_Overbelow" /></para>
 		  </refsection>
 		</refentry>
 
@@ -7830,7 +7838,11 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overright" /></para>
+		    <para>
+		    	<xref linkend="ST_Geometry_Overlaps" />,
+		    	<xref linkend="ST_Geometry_Overabove" />,
+		    	<xref linkend="ST_Geometry_Overright" />, 
+		    	<xref linkend="ST_Geometry_Overleft" /></para>
 		  </refsection>
 		</refentry>
 
@@ -7895,10 +7907,83 @@
 		  <refsection>
 		    <title>See Also</title>
 		
-		    <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overbelow" /></para>
+		    <para>
+		    	<xref linkend="ST_Geometry_Overlaps" />,
+		    	<xref linkend="ST_Geometry_Overabove" />,
+		    	<xref linkend="ST_Geometry_Overbelow" />, 
+		    	<xref linkend="ST_Geometry_Overleft" /></para>
 		  </refsection>
 		</refentry>
+
+		<refentry id="ST_Geometry_Overabove">	
+		  <refnamediv>
+		    <refname>|&amp;&gt;</refname>
 		
+		    <refpurpose>Returns <varname>TRUE</varname> if A overlaps or is 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>|&amp;&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>|&amp;&gt;</varname> operator returns <varname>TRUE</varname> if the bounding box of geometry A
+            overlaps or is above the bounding box of geometry B, or more accurately, overlaps or is NOT below 
+            the bounding box of geometry B.</para>
+		  </refsection>
+		
+		  <refsection>
+		    <title>Examples</title>
+		
+		    <programlisting>SELECT tbl1.column1, tbl2.column1, tbl1.column2 |&amp;&gt; tbl2.column2 AS overlaps
+FROM 
+  ( VALUES
+	(1, 'LINESTRING(6 0, 6 4)'::geometry)) AS tbl1,
+  ( VALUES
+	(2, 'LINESTRING(0 0, 3 3)'::geometry), 
+	(3, 'LINESTRING(0 1, 0 5)'::geometry), 
+	(4, 'LINESTRING(1 2, 4 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_Overlaps" />,
+		    	<xref linkend="ST_Geometry_Overright" />,
+		    	<xref linkend="ST_Geometry_Overbelow" />, 
+		    	<xref linkend="ST_Geometry_Overleft" /></para>
+		  </refsection>
+		</refentry>
+		
 		<refentry id="ST_Geometry_EQ">	
 		  <refnamediv>
 		    <refname>&#61;</refname>