Add geometry_dump and special index to list all functions that take as input or outpu...

git-svn-id: http://svn.osgeo.org/postgis/trunk@4918 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/doc/reference_type.xml b/doc/reference_type.xml
index 92d3a6700be9c1c4a2ee2f76cff7d93ff6aeb231..b49a53f5e78e7679f37623493f80c683ea501611 100644 (file)
--- a/doc/reference_type.xml
+++ b/doc/reference_type.xml
@@ -71,7 +71,7 @@
                
                <refsection>
                        <title>Description</title>
-                       <para>GEOMETRY is a fundamental postgis spatial data type used to represent a feature in the Euclidean coordinate system.</para>
+                       <para>geometry is a fundamental postgis spatial data type used to represent a feature in the Euclidean coordinate system.</para>
                </refsection>
                
                <refsection>
@@ -79,6 +79,26 @@
                        <para><xref linkend="RefObject" /></para>
                </refsection>
        </refentry>
+       
+       <refentry id="geometry_dump">
+               <refnamediv>
+                       <refname>geometry_dump</refname>
+                       <refpurpose>A spatial datatype with two fields - geom (holding a geometry object) 
+                               and path[] (a 1-d array holding the position of the geometry within the dumped object.)</refpurpose>
+               </refnamediv>
+               
+               <refsection>
+               <title>Description</title>
+               <para>geometry_dump is a compound data type consisting of a geometry object referenced by the .geom field 
+                       and path[] a 1-dimensional integer array (starting at 1 e.g. path[1] to get first element) array that defines the navigation path within the dumped geometry to find this element.
+                       It is used by the ST_Dump* family of functions as an output type to explode a more complex geometry into its 
+                               constituent parts and location of parts.</para>
+               </refsection>
+               <refsection>
+                       <title>See Also</title>
+                       <para><xref linkend="PostGIS_Geometry_DumpFunctions" /></para>
+               </refsection>
+       </refentry>
 
        <refentry id="geography">
                <refnamediv>

diff --git a/doc/xsl/postgis_aggs_mm.xml.xsl b/doc/xsl/postgis_aggs_mm.xml.xsl
index f1869e66f8845b79cc842ddd7b9bc3b4f2057152..3dd99874e3f404a579097140545adb3466243a60 100644 (file)
--- a/doc/xsl/postgis_aggs_mm.xml.xsl
+++ b/doc/xsl/postgis_aggs_mm.xml.xsl
@@ -104,6 +104,33 @@
                                </xsl:for-each>\r
                                </itemizedlist>\r
                </sect1>\r
+               \r
+               <sect1 id="PostGIS_Geometry_DumpFunctions">\r
+                       <title>PostGIS Geometry Dump Functions</title>\r
+                       <para>The functions given below are PostGIS functions that take as input or return as output a set of or single <link linkend="PostGIS_Geometry_Dump">geometry_dump</link> data type object.</para>\r
+                               <itemizedlist>\r
+                       <!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment  -->\r
+                               <xsl:for-each select='sect1/refentry'>\r
+                                       <xsl:sort select="@id"/>\r
+                                       <xsl:variable name='comment'>\r
+                                               <xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'&#x0d;&#x0a;', ' '), '&#09;', ' '))"/>\r
+                                       </xsl:variable>\r
+                                       <xsl:variable name="refid">\r
+                                               <xsl:value-of select="@id" />\r
+                                       </xsl:variable>\r
+                                       <xsl:variable name="refname">\r
+                                               <xsl:value-of select="refnamediv/refname" />\r
+                                       </xsl:variable>\r
+\r
+                       <!-- If at least one proto function accepts or returns a geography -->\r
+                                       <xsl:choose>\r
+                                               <xsl:when test="contains(refsynopsisdiv/funcsynopsis,'geometry_dump') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geometry_dump')">\r
+                                                       <listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="$comment" /></listitem>\r
+                                               </xsl:when>\r
+                                       </xsl:choose>\r
+                               </xsl:for-each>\r
+                               </itemizedlist>\r
+               </sect1>\r
 \r
                <sect1 id="PostGIS_3D_Functions">\r
                        <title>PostGIS Functions that support 3D</title>\r