[postgis-commits] svn - r3118 - in trunk/doc: . xsl

postgis-commits at postgis.refractions.net postgis-commits at postgis.refractions.net
Wed Oct 15 23:35:03 PDT 2008


Author: robe
Date: 2008-10-15 23:35:03 -0700 (Wed, 15 Oct 2008)
New Revision: 3118

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
   trunk/doc/xsl/postgis_aggs_mm.xml.xsl
Log:
Move over ST_Boundary to new section,  copy comment about SQL-MM srid to xsl header

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-10-15 21:44:19 UTC (rev 3117)
+++ trunk/doc/reference.xml	2008-10-16 06:35:03 UTC (rev 3118)
@@ -95,24 +95,7 @@
     <sect2>
       <title>Geometry Processing Functions</title>
 	  <variablelist>
-        <varlistentry>
-          <term>ST_Boundary(geometry)</term>
 
-          <listitem>
-            <para>Returns the closure of the combinatorial boundary of this
-            Geometry. The combinatorial boundary is defined as described in
-            section 3.12.3.2 of the OGC SPEC. Because the result of this
-            function is a closure, and hence topologically closed, the
-            resulting boundary can be represented using representational
-            geometry primitives as discussed in the OGC SPEC, section
-            3.12.2.</para>
-
-            <para>Performed by the GEOS module</para>
-
-            <para>OGC SPEC s2.1.1.1</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>ST_Shift_Longitude(geometry)</term>
 
@@ -1514,16 +1497,6 @@
 
     <variablelist>
       <varlistentry>
-        <term>ST_Boundary</term>
-
-        <listitem>
-          <para>Return the boundary of the ST_Geometry value.</para>
-
-          <para>SQL-MM 3: 5.1.14</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term>ST_CoordDim</term>
 
         <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-10-15 21:44:19 UTC (rev 3117)
+++ trunk/doc/reference_new.xml	2008-10-16 06:35:03 UTC (rev 3118)
@@ -1597,7 +1597,97 @@
   </sect1>
    
   <sect1>
-    <title>Geometry Accessors</title>  		
+    <title>Geometry Accessors</title> 		
+	<refentry id="ST_Boundary">
+      <refnamediv>
+        <refname>ST_Boundary</refname>
+    
+        <refpurpose>Returns the closure of the combinatorial boundary of this
+            Geometry.</refpurpose>
+      </refnamediv>
+    
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>geometry <function>ST_Boundary</function></funcdef>
+    
+            <paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+    
+      <refsection>
+        <title>Description</title>
+    
+        <para>Returns the closure of the combinatorial boundary of this
+            Geometry. The combinatorial boundary is defined as described in
+            section 3.12.3.2 of the OGC SPEC. Because the result of this
+            function is a closure, and hence topologically closed, the
+            resulting boundary can be represented using representational
+            geometry primitives as discussed in the OGC SPEC, section
+            3.12.2.</para>
+		<para>Performed by the GEOS module</para>
+		<important>
+          <para>Do not call with a <varname>GEOMETRYCOLLECTION</varname> as an argument</para>
+        </important>
+		
+		<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> OGC SPEC s2.1.1.1</para>
+    
+        <para><inlinemediaobject>
+            <imageobject>
+              <imagedata fileref="images/check.png" />
+            </imageobject>
+          </inlinemediaobject> This method implements the SQL/MM specification: SQL-MM 3: 5.1.14</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_AsText(ST_Boundary(ST_GeomFromText('LINESTRING(1 1,0 0, -1 1)')));
+st_astext
+----------- 
+MULTIPOINT(1 1,-1 1)
+
+SELECT ST_AsText(ST_Boundary(ST_GeomFromText('POLYGON((1 1,0 0, -1 1, 1 1))')));
+st_astext
+----------
+LINESTRING(1 1,0 0,-1 1,1 1)
+
+--Using a 3d polygon
+SELECT ST_AsEWKT(ST_Boundary(ST_GeomFromEWKT('POLYGON((1 1 1,0 0 1, -1 1 1, 1 1 1))')));
+
+st_asewkt
+-----------------------------------
+LINESTRING(1 1 1,0 0 1,-1 1 1,1 1 1)
+
+--Using a 3d multilinestring
+SELECT ST_AsEWKT(ST_Boundary(ST_GeomFromEWKT('MULTILINESTRING((1 1 1,0 0 0.5, -1 1 1),(1 1 0.5,0 0 0.5, -1 1 0.5, 1 1 0.5) )')));
+
+st_asewkt
+----------
+MULTIPOINT(-1 1 1,1 1 0.75)
+</programlisting>
+    	</refsection>
+		<refsection>
+			<title>See Also</title>
+			
+			<para><xref linkend="ST_ExteriorRing" />, <xref linkend="ST_MakePolygon" /></para>
+		</refsection>
+	</refentry>
+	
     <refentry id="ST_Dimension">
       <refnamediv>
         <refname>ST_Dimension</refname>

Modified: trunk/doc/xsl/postgis_aggs_mm.xml.xsl
===================================================================
--- trunk/doc/xsl/postgis_aggs_mm.xml.xsl	2008-10-15 21:44:19 UTC (rev 3117)
+++ trunk/doc/xsl/postgis_aggs_mm.xml.xsl	2008-10-16 06:35:03 UTC (rev 3118)
@@ -41,6 +41,10 @@
 		<sect1>
 			<title>PostGIS SQL-MM Compliant Functions</title>
 			<para>The functions given below are PostGIS functions that conform to the SQL/MM 3 standard</para>
+			<note>
+			  <para>SQL-MM defines the default SRID of all geometry constructors as 0.
+			  PostGIS uses a default SRID of -1.</para>
+			</note>
 				<itemizedlist>
 			<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment  -->
 				<xsl:for-each select='sect1/refentry'>



More information about the postgis-commits mailing list