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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2009-01-15 10:24:49 -0800 (Thu, 15 Jan 2009)
New Revision: 3533

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move ST_MLineFromText

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2009-01-15 18:17:01 UTC (rev 3532)
+++ trunk/doc/reference.xml	2009-01-15 18:24:49 UTC (rev 3533)
@@ -25,20 +25,6 @@
       <variablelist>
 
         <varlistentry>
-          <term>ST_MLineFromText(text,[&lt;srid&gt;])</term>
-
-          <listitem>
-            <para>Makes a Geometry from WKT with the given SRID. If SRID is
-            not give, it defaults to -1.</para>
-
-            <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
-            suite</para>
-
-            <para>Throws an error if the WKT is not a MULTILINESTRING</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>ST_MPolyFromText(text,[&lt;srid&gt;])</term>
 
           <listitem>
@@ -346,16 +332,6 @@
 
     <variablelist>  
       <varlistentry>
-        <term>ST_MLineFromText</term>
-
-        <listitem>
-          <para>Return a specified ST_MultiLineString value.</para>
-
-          <para>SQL-MM 3: 9.4.4</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term>ST_MLineFromWKB</term>
 
         <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2009-01-15 18:17:01 UTC (rev 3532)
+++ trunk/doc/reference_new.xml	2009-01-15 18:24:49 UTC (rev 3533)
@@ -2204,6 +2204,93 @@
 			<para><xref linkend="ST_AsEWKT" />, <xref linkend="ST_MakePoint" />, <xref linkend="ST_SetSRID" /></para>
 		</refsection>
 	</refentry>	
+	
+        <varlistentry>
+          <term>ST_MLineFromText(text,[&lt;srid&gt;])</term>
+
+          <listitem>
+            <para>Makes a Geometry from WKT with the given SRID. If SRID is
+            not give, it defaults to -1.</para>
+
+            <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
+            suite</para>
+
+            <para>Throws an error if the WKT is not a MULTILINESTRING</para>
+          </listitem>
+        </varlistentry>
+	  
+	<refentry id="ST_MLineFromText">
+	  <refnamediv>
+	    <refname>ST_MLineFromText</refname>
+	
+	    <refpurpose>Return a specified ST_MultiLineString value from WKT representation.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+	    <funcsynopsis>
+	      <funcprototype>
+	        <funcdef>geometry <function>ST_MLineFromText</function></funcdef>
+	        <paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+	        <paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
+	      </funcprototype>
+		  
+		  <funcprototype>
+	        <funcdef>geometry <function>ST_MLineFromText</function></funcdef>
+	        <paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+	      </funcprototype>
+
+	    </funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+	    <title>Description</title>
+	
+	     <para>Makes a Geometry from  Well-Known-Text (WKT) with the given SRID. If SRID is
+            not give, it defaults to -1.</para>
+
+         <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
+            suite</para>
+
+         <para>Returns null if the WKT is not a MULTILINESTRING</para>
+		 
+		 <note>
+			<para>If you are absolutely sure all your WKT geometries are points, don't use this function.  
+				It is slower than ST_GeomFromText since it adds an additional validation step.  
+			</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. OGC SPEC 3.2.6.2</ulink></para>
+	
+	    <!-- Optionally mention SQL/MM compliancy if appropriate -->
+	    <para><inlinemediaobject>
+	        <imageobject>
+	          <imagedata fileref="images/check.png" />
+	        </imageobject>
+	      </inlinemediaobject> This method implements the SQL/MM specification: SQL-MM 3: 9.4.4</para>
+
+	  </refsection>
+	  
+	
+	  <refsection>
+	    <title>Examples</title>
+	
+	    <programlisting>SELECT ST_MLineFromText('MULTILINESTRING((1 2, 3 4), (4 5, 6 7))');</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+	    <title>See Also</title>
+	
+	    <para><xref linkend="ST_GeomFromText" /></para>
+	  </refsection>
+	</refentry>
 		
 	<refentry id="ST_MPointFromText">
 	  <refnamediv>
@@ -2261,13 +2348,7 @@
 	          <imagedata fileref="images/check.png" />
 	        </imageobject>
 	      </inlinemediaobject> This method implements the SQL/MM specification: SQL-MM 3: 9.2.4</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>