From 656273bb6cb5351c66f0dd09cece329ef291c69c Mon Sep 17 00:00:00 2001
From: Regina Obe <lr@pcorp.us>
Date: Fri, 27 Nov 2009 19:46:38 +0000
Subject: [PATCH] Add geometry_dump and special index to list all functions
 that take as input or output geometry_dump objects

git-svn-id: http://svn.osgeo.org/postgis/trunk@4918 b70326c6-7e19-0410-871a-916f4a2858ee
---
 doc/reference_type.xml          | 22 +++++++++++++++++++++-
 doc/xsl/postgis_aggs_mm.xml.xsl | 27 +++++++++++++++++++++++++++
 2 files changed, 48 insertions(+), 1 deletion(-)

diff --git a/doc/reference_type.xml b/doc/reference_type.xml
index 92d3a6700..b49a53f5e 100644
--- 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 f1869e66f..3dd99874e 100644
--- a/doc/xsl/postgis_aggs_mm.xml.xsl
+++ b/doc/xsl/postgis_aggs_mm.xml.xsl
@@ -104,6 +104,33 @@
 				</xsl:for-each>
 				</itemizedlist>
 		</sect1>
+		
+		<sect1 id="PostGIS_Geometry_DumpFunctions">
+			<title>PostGIS Geometry Dump Functions</title>
+			<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>
+				<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'>
+					<xsl:sort select="@id"/>
+					<xsl:variable name='comment'>
+						<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'&#x0d;&#x0a;', ' '), '&#09;', ' '))"/>
+					</xsl:variable>
+					<xsl:variable name="refid">
+						<xsl:value-of select="@id" />
+					</xsl:variable>
+					<xsl:variable name="refname">
+						<xsl:value-of select="refnamediv/refname" />
+					</xsl:variable>
+
+			<!-- If at least one proto function accepts or returns a geography -->
+					<xsl:choose>
+						<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'geometry_dump') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geometry_dump')">
+							<listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="$comment" /></listitem>
+						</xsl:when>
+					</xsl:choose>
+				</xsl:for-each>
+				</itemizedlist>
+		</sect1>
 
 		<sect1 id="PostGIS_3D_Functions">
 			<title>PostGIS Functions that support 3D</title>
-- 
2.50.1