New postgresql type section per #300. Still need to modify postgis_comments.sql...

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

diff --git a/doc/postgis.xml b/doc/postgis.xml
index f107b069fab4c36194cc418fca3986dc60c8926d..32e7bc0c79d4293219e6e6c09d16a5d005bccfec 100644 (file)
--- a/doc/postgis.xml
+++ b/doc/postgis.xml
@@ -19,6 +19,7 @@
 <!ENTITY postgis_aggs_mm SYSTEM "postgis_aggs_mm.xml">
 <!ENTITY reporting SYSTEM "reporting.xml">
 <!ENTITY release_notes SYSTEM "release_notes.xml">
+<!ENTITY reference_type SYSTEM "reference_type.xml">
 <!ENTITY reference_management SYSTEM "reference_management.xml">
 <!ENTITY reference_constructor SYSTEM "reference_constructor.xml">
 <!ENTITY reference_accessor SYSTEM "reference_accessor.xml">

diff --git a/doc/reference.xml b/doc/reference.xml
index 3ad2a7cd06d5499e3af5902f6b62d7f1a992f448..9c94dbf331f980164783e1289e058133f327209d 100644 (file)
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -16,6 +16,7 @@
        deprecated in a future release.</para>
   </note>
 
+  &reference_type;
   &reference_management;
   &reference_constructor;
   &reference_accessor;

diff --git a/doc/reference_type.xml b/doc/reference_type.xml
new file mode 100644 (file)
index 0000000..fc9bc44
--- /dev/null
+++ b/doc/reference_type.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+  <sect1 id="PostGIS_Types">
+    <title>PostgreSQL PostGIS Types</title>
+
+       <refentry id="box2d">
+      <refnamediv>
+        <refname>box2d</refname>
+        <refpurpose>A box composed of x min, ymin,  xmax, ymax.  Often used to return the 2d enclosing box of a geometry. </refpurpose>
+      </refnamediv>
+
+      <refsection>
+        <title>Description</title>
+        <para>box2d is a spatial data type used to represent the enclosing box of a geometry or set of geometries. ST_Extent in earlier versions prior to PostGIS 1.4 would return a box2d.</para>
+      </refsection>
+    </refentry>
+       <refentry id="box3d">
+      <refnamediv>
+        <refname>box3d</refname>
+        <refpurpose>A box composed of x min, ymin, zmin, xmax, ymax, zmax.  Often used to return the 3d extent of a geometry or collection of geometries. </refpurpose>
+      </refnamediv>
+
+      <refsection>
+        <title>Description</title>
+        <para>box3d is a postgis spatial data type used to represent the enclosing box of a geometry or set of geometries. ST_Extent3D returns a box3d object.</para>
+      </refsection>
+    </refentry>
+       
+       <refentry id="box3d_extent">
+      <refnamediv>
+        <refname>box3d_extent</refname>
+        <refpurpose>A box composed of x min, ymin, zmin, xmax, ymax, zmax.  Often used to return the extent of a geometry.</refpurpose>
+      </refnamediv>
+
+      <refsection>
+        <title>Description</title>
+        <para>box3d_extent is a data type returned by ST_Extent. In versions prior to PostGIS 1.4, ST_Extent would return a box2d.</para>
+      </refsection>
+         <refsection>
+               <title>Casting Behavor</title>
+               <para>This section lists the automatic as well as explicit casts allowed for this data type</para>
+               <informaltable>
+                       <tgroup cols="2">
+                               <tbody>
+                                 <row>
+                                       <entry>Cast To</entry>
+                                       <entry>Behavior</entry>
+                                 </row>
+                                 <row>
+                                       <entry>box2d</entry>
+                                       <entry>automatic</entry>
+                                 </row>
+                                 <row>
+                                       <entry>box3d</entry>
+                                       <entry>automatic</entry>
+                                 </row>
+                                 <row>
+                                       <entry>geometry</entry>
+                                       <entry>automatic</entry>
+                                 </row>
+                               </tbody>
+                       </tgroup>
+               </informaltable>
+         </refsection>
+    </refentry>
+       
+       <refentry id="geometry">
+               <refnamediv>
+                       <refname>GEOMETRY</refname>
+                       <refpurpose>Planar spatial data type.</refpurpose>
+               </refnamediv>
+               
+               <refsection>
+                       <title>Description</title>
+                       <para>GEOMETRY is a fundamental postgis spatial data type used to represent a feature in the Euclidean coordinate system.</para>
+               </refsection>
+               
+               <refsection>
+                       <title>See Also</title>
+                       <para><xref linkend="RefObject" /></para>
+               </refsection>
+       </refentry>
+
+       <refentry id="geography">
+               <refnamediv>
+                       <refname>GEOGRAPHY</refname>
+                       <refpurpose>Ellipsoidal spatial data type.</refpurpose>
+               </refnamediv>
+               
+               <refsection>
+               <title>Description</title>
+               <para>GEOGRAPHY is a spatial data type used to represent a feature in the round-earth coordinate system.</para>
+               </refsection>
+               
+               <refsection>
+                       <title>See Also</title>
+                       <para><xref linkend="PostGIS_GeographyFunctions" />,<xref linkend="PostGIS_Geography" /></para>
+               </refsection>
+       </refentry>
+  </sect1>