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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2009-01-09 05:17:28 -0800 (Fri, 09 Jan 2009)
New Revision: 3504

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over ST_Zmflag

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2009-01-08 17:22:47 UTC (rev 3503)
+++ trunk/doc/reference.xml	2009-01-09 13:17:28 UTC (rev 3504)
@@ -413,15 +413,6 @@
 
       <variablelist>
 
-        <varlistentry id="zmflag">
-          <term>ST_zmflag(geometry)</term>
-
-          <listitem>
-            <para>Returns ZM (dimension semantic) flag of the geometries as a
-            small int. Values are: 0=2d, 1=3dm, 2=3dz, 3=4d.</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>ST_nrings(geometry)</term>
 

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2009-01-08 17:22:47 UTC (rev 3503)
+++ trunk/doc/reference_new.xml	2009-01-09 13:17:28 UTC (rev 3504)
@@ -4358,7 +4358,7 @@
 	  <refsection>
 	    <title>Examples</title>
 	    <programlisting>SELECT ST_Z(ST_GeomFromEWKT('POINT(1 2 3 4)'));
- st_y 
+ st_z 
 ------
     3
 (1 row)
@@ -4374,7 +4374,71 @@
 	  </refsection>
 	</refentry>
 
+	<refentry id="ST_Zmflag">
+	  <refnamediv>
+	    <refname>ST_Zmflag</refname>
+	
+	    <refpurpose>Returns ZM (dimension semantic) flag of the geometries as a
+            small int. Values are: 0=2d, 1=3dm, 2=3dz, 3=4d.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+	    <funcsynopsis>
+	      <funcprototype>
+	        <funcdef>smallint <function>ST_Zmflag</function></funcdef>
+	        <paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+	      </funcprototype>
+	    </funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+	    <title>Description</title>
+	
+	    <para>Returns ZM (dimension semantic) flag of the geometries as a
+            small int. Values are: 0=2d, 1=3dm, 2=3dz, 3=4d.</para>
+		
+		<!-- Optionally mention 3d support -->
+	    <para><inlinemediaobject>
+	        <imageobject>
+	          <imagedata fileref="images/check.png" />
+	        </imageobject>
+	      </inlinemediaobject> This function supports 3d and will not drop the z-index.</para>
+	  </refsection>
+	  
+	
+	  <refsection>
+	    <title>Examples</title>
+	
+	    <programlisting>SELECT ST_Zmflag(ST_GeomFromEWKT('LINESTRING(1 2, 3 4)'));
+ st_zmflag
+-----------
+         0
+		
+SELECT ST_Zmflag(ST_GeomFromEWKT('LINESTRINGM(1 2 3, 3 4 3)'));
+ st_zmflag
+-----------
+         1
+	
+SELECT ST_Zmflag(ST_GeomFromEWKT('CIRCULARSTRING(1 2 3, 3 4 3, 5 6 3)'));
+ st_zmflag
+-----------
+         2
+SELECT ST_Zmflag(ST_GeomFromEWKT('POINT(1 2 3 4)'));
+ st_zmflag
+-----------
+         3
+</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+	    <title>See Also</title>
+	
+	    <para><xref linkend="ST_CoordDim" /></para>
+	  </refsection>
+	</refentry>
 
+
   </sect1>
   
   <sect1 id="Geometry_Editors">