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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-07-24 04:58:18 -0700 (Thu, 24 Jul 2008)
New Revision: 2883

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over ST_GeomFromText and provide examples

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-07-24 10:22:16 UTC (rev 2882)
+++ trunk/doc/reference.xml	2008-07-24 11:58:18 UTC (rev 2883)
@@ -2356,18 +2356,7 @@
         </listitem>
       </varlistentry>
 
-
       <varlistentry>
-        <term>ST_GeomFromText</term>
-
-        <listitem>
-          <para>Return a specified ST_Geometry value.</para>
-
-          <para>SQL-MM 3: 5.1.40</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term>ST_GeomFromWKB</term>
 
         <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-07-24 10:22:16 UTC (rev 2882)
+++ trunk/doc/reference_new.xml	2008-07-24 11:58:18 UTC (rev 2883)
@@ -700,7 +700,7 @@
   </sect1>
   
   <sect1>
-      <title>Geometry Constructors</title>	
+      <title>Geometry Constructors</title>
 		<refentry id="ST_BdPolyFromText">
 		  <refnamediv>
 			<refname>ST_BdPolyFromText</refname>
@@ -873,7 +873,98 @@
             this function with standard OGC interface</para>
 		  </refsection>
 		</refentry>
+	  <refentry id="ST_GeomFromText">
+		  <refnamediv>
+			<refname>ST_GeomFromText</refname>
+			<refpurpose>Return a specified ST_Geometry value from Well-Known Text representation (WKT).</refpurpose>
+		  </refnamediv>
 		
+		  <refsynopsisdiv>
+			<funcsynopsis>
+			  <funcprototype>
+				<funcdef>geometery <function>ST_GeomFromText</function></funcdef>
+				<paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+			  </funcprototype>
+			  <funcprototype>
+				<funcdef>geometery <function>ST_GeomFromText</function></funcdef>
+				<paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+				<paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
+			  </funcprototype>
+			</funcsynopsis>
+		  </refsynopsisdiv>
+		
+		  <refsection>
+			<title>Description</title>
+		
+			<para>Constructs a PostGIS ST_Geometry object from the OGC Well-Known text representation.</para>
+		
+			<!-- optionally mention that this function uses indexes if appropriate -->
+			<note>
+			    <para>There are 2 variants of ST_GeomFromText function, the first takes no SRID and returns a geometry
+					with no defined spatial reference system.  The second takes a spatial reference id as the second argument
+					and returns an ST_Geometry that includes this srid as part of its meta-data.  The srid must be defined
+					in the spatial_ref_sys table.</para>
+			</note>
+		
+			<!-- Optionally mention OpenGIS compliancy if appropriate -->
+			<para><inlinemediaobject>
+				<imageobject>
+				  <imagedata fileref="images/check.png" />
+				</imageobject>
+			  </inlinemediaobject> This method implements the <ulink
+			url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple Features
+			Implementation Specification for SQL.</ulink></para>
+			<para><inlinemediaobject>
+				<imageobject>
+				  <imagedata fileref="images/check.png" />
+				</imageobject>
+			  </inlinemediaobject> This method implements the SQL/MM specification:
+			SQL-MM 3: 5.1.40</para>
+		  </refsection>
+		
+		  <refsection>
+			<title>Examples</title>
+<programlisting>SELECT ST_GeomFromText('LINESTRING(-71.160281 42.258729,-71.160837 42.259113,-71.161144 42.25932)');
+SELECT ST_GeomFromText('LINESTRING(-71.160281 42.258729,-71.160837 42.259113,-71.161144 42.25932)',4269);
+
+SELECT ST_GeomFromText('MULTILINESTRING((-71.160281 42.258729,-71.160837 42.259113,-71.161144 42.25932))');
+
+SELECT ST_GeomFromText('POINT(-71.064544 42.28787)');
+
+SELECT ST_GeomFromText('POLYGON((-71.1776585052917 42.3902909739571,-71.1776820268866 42.3903701743239,
+-71.1776063012595 42.3903825660754,-71.1775826583081 42.3903033653531,-71.1776585052917 42.3902909739571))');
+
+SELECT ST_GeomFromText('MULTIPOLYGON(((-71.1031880899493 42.3152774590236,
+-71.1031627617667 42.3152960829043,-71.102923838298 42.3149156848307,
+-71.1023097974109 42.3151969047397,-71.1019285062273 42.3147384934248,
+-71.102505233663 42.3144722937587,-71.10277487471 42.3141658254797,
+-71.103113945163 42.3142739188902,-71.10324876416 42.31402489987,
+-71.1033002961013 42.3140393340215,-71.1033488797549 42.3139495090772,
+-71.103396240451 42.3138632439557,-71.1041521907712 42.3141153348029,
+-71.1041411411543 42.3141545014533,-71.1041287795912 42.3142114839058,
+-71.1041188134329 42.3142693656241,-71.1041112482575 42.3143272556118,
+-71.1041072845732 42.3143851580048,-71.1041057218871 42.3144430686681,
+-71.1041065602059 42.3145009876017,-71.1041097995362 42.3145589148055,
+-71.1041166403905 42.3146168544148,-71.1041258822717 42.3146748022936,
+-71.1041375307579 42.3147318674446,-71.1041492906949 42.3147711126569,
+-71.1041598612795 42.314808571739,-71.1042515013869 42.3151287620809,
+-71.1041173835118 42.3150739481917,-71.1040809891419 42.3151344119048,
+-71.1040438678912 42.3151191367447,-71.1040194562988 42.3151832057859,
+-71.1038734225584 42.3151140942995,-71.1038446938243 42.3151006300338,
+-71.1038315271889 42.315094347535,-71.1037393329282 42.315054824985,
+-71.1035447555574 42.3152608696313,-71.1033436658644 42.3151648370544,
+-71.1032580383161 42.3152269126061,-71.103223066939 42.3152517403219,
+-71.1031880899493 42.3152774590236)),
+((-71.1043632495873 42.315113108546,-71.1043583974082 42.3151211109857,
+-71.1043443253471 42.3150676015829,-71.1043850704575 42.3150793250568,-71.1043632495873 42.315113108546)))',4326);
+</programlisting>
+		  </refsection>
+		  <refsection>
+			<title>See Also</title>
+			<para><xref linkend="ST_GeomFromEWKT" />, <xref linkend="ST_GeomFromWKB" /></para>
+		  </refsection>
+	</refentry>
+		
 	<refentry id="ST_MakeLine">
 		<refnamediv>
 		<refname>ST_MakeLine</refname>