#1818 slight doc change move the FromGeoHash family to constructor section and link...

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

diff --git a/NEWS b/NEWS
index 2e065c959ce2703425ce8cf92c9d462f3586219c..f80f9d187660b09a04f3413c0384c193d7bf91eb 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -57,7 +57,7 @@ PostGIS 2.1.0
   - #1643, #2076, Upgrade tiger geocoder to support loading tiger 2011 and 2012 
     (Regina Obe / Paragon Corporation) Funded by Hunter Systems Group
   - GEOMETRYCOLLECTION support for ST_MakeValid (Sandro Santilli / Vizzuality)
-  - #1818, ST_GeomFromGeoHash and friends (J.Smith (darkpanda))
+  - #1818, ST_GeomFromGeoHash and friends (Jason Smith (darkpanda))
   - ST_PixelOfValue (Bborie Park / UC Davis)
   - Casts to/from PostgreSQL geotypes (point/path/polygon).
   - #2011, ST_DumpValues to output raster as array (Bborie Park / UC Davis)

diff --git a/doc/introduction.xml b/doc/introduction.xml
index 5c66a4823af07ef0e74bab7b917c35e9a1f33014..bf8c1411bbc1352224c21431f1d289cb346cd13b 100644 (file)
--- a/doc/introduction.xml
+++ b/doc/introduction.xml
@@ -189,8 +189,8 @@ Gino Lucrezi,
 Guillaume Lelarge,
 IIDA Tetsushi,
 Ingvild Nystuen,
+Jason Smith,
 Jeff Adams,
-J. Smith,
 Jose Carlos Martinez Llari,
 Kashif Rasul,
 Klaus Foerster,

diff --git a/doc/reference_constructor.xml b/doc/reference_constructor.xml
index e0e70e03413d3648e9f51aae1ede2d6d4f351df2..5e3642185fb47927a601a4cfd7525c3264980988 100644 (file)
--- a/doc/reference_constructor.xml
+++ b/doc/reference_constructor.xml
@@ -102,6 +102,63 @@
                        </refsection>
        </refentry>
        
+               <refentry id="ST_Box2dFromGeoHash">
+         <refnamediv>
+               <refname>ST_Box2dFromGeoHash</refname>
+
+               <refpurpose>Return a BOX2D from a GeoHash string.</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                       <funcprototype>
+                               <funcdef>box2d <function>ST_Box2dFromGeoHash</function></funcdef>
+                               <paramdef><type>text </type> <parameter>geohash</parameter></paramdef>
+                               <paramdef choice="opt"><type>integer </type> <parameter>precision=full_precision_of_geohash</parameter></paramdef>
+                       </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Return a BOX2D from a GeoHash string.</para>
+
+               <para>If no <varname>precision</varname> is specficified ST_Box2dFromGeoHash returns a BOX2D based on full precision of the input GeoHash string.</para>
+
+               <para>If <varname>precision</varname> is specified ST_Box2dFromGeoHash will use that many characters from the GeoHash to create the BOX2D. Lower precision values results in larger BOX2Ds and larger values increase the precision.</para>
+
+               <para>Availability: 2.1.0</para>
+         </refsection>
+
+         <refsection>
+               <title>Examples</title>
+               <programlisting><![CDATA[SELECT ST_Box2dFromGeoHash('9qqj7nmxncgyy4d0dbxqz0');
+
+                st_geomfromgeohash
+--------------------------------------------------
+ BOX(-115.172816 36.114646,-115.172816 36.114646)
+
+SELECT ST_Box2dFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 0);
+
+ st_box2dfromgeohash
+----------------------
+ BOX(-180 -90,180 90)
+
+ SELECT ST_Box2dFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 10);
+                            st_box2dfromgeohash
+---------------------------------------------------------------------------
+ BOX(-115.17282128334 36.1146408319473,-115.172810554504 36.1146461963654)
+               ]]>
+               </programlisting>
+         </refsection>
+        <refsection>
+               <title>See Also</title>
+
+               <para><xref linkend="ST_GeoHash" />, <xref linkend="ST_GeomFromGeoHash" />, <xref linkend="ST_PointFromGeoHash" /></para>
+         </refsection>
+       </refentry>
+       
        <refentry id="ST_GeogFromText">
                  <refnamediv>
                        <refname>ST_GeogFromText</refname>
@@ -439,7 +496,63 @@ SELECT ST_GeomFromEWKT('POLYHEDRALSURFACE(
                        <para><xref linkend="ST_GeomFromText" /></para>
                  </refsection>
        </refentry>
-       
+
+
+       <refentry id="ST_GeomFromGeoHash">
+         <refnamediv>
+               <refname>ST_GeomFromGeoHash</refname>
+
+               <refpurpose>Return a geometry from a GeoHash string.</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                       <funcprototype>
+                               <funcdef>geometry <function>ST_GeomFromGeoHash</function></funcdef>
+                               <paramdef><type>text </type> <parameter>geohash</parameter></paramdef>
+                               <paramdef choice="opt"><type>integer </type> <parameter>precision=full_precision_of_geohash</parameter></paramdef>
+                       </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Return a geometry from a GeoHash string. The geometry will be a polygon representing the GeoHash bounds.</para>
+
+               <para>If no <varname>precision</varname> is specficified ST_GeomFromGeoHash returns a polygon based on full precision of the input GeoHash string.</para>
+
+               <para>If <varname>precision</varname> is specified ST_GeomFromGeoHash will use that many characters from the GeoHash to create the polygon.</para>
+
+               <para>Availability: 2.1.0</para>
+         </refsection>
+
+         <refsection>
+               <title>Examples</title>
+               <programlisting><![CDATA[SELECT ST_AsText(ST_GeomFromGeoHash('9qqj7nmxncgyy4d0dbxqz0'));
+                                                        st_astext
+--------------------------------------------------------------------------------------------------------------------------
+ POLYGON((-115.172816 36.114646,-115.172816 36.114646,-115.172816 36.114646,-115.172816 36.114646,-115.172816 36.114646))
+
+SELECT ST_AsText(ST_GeomFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 4));
+                                                          st_astext
+------------------------------------------------------------------------------------------------------------------------------
+ POLYGON((-115.3125 36.03515625,-115.3125 36.2109375,-114.9609375 36.2109375,-114.9609375 36.03515625,-115.3125 36.03515625))
+
+SELECT ST_AsText(ST_GeomFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 10));
+                                                                                       st_astext
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ POLYGON((-115.17282128334 36.1146408319473,-115.17282128334 36.1146461963654,-115.172810554504 36.1146461963654,-115.172810554504 36.1146408319473,-115.17282128334 36.1146408319473))
+               ]]>
+               </programlisting>
+         </refsection>
+        <refsection>
+               <title>See Also</title>
+
+               <para><xref linkend="ST_GeoHash" />,<xref linkend="ST_Box2dFromGeoHash" />, <xref linkend="ST_PointFromGeoHash" /></para>
+         </refsection>
+       </refentry>
+
        <refentry id="ST_GeomFromGML">
          <refnamediv>
                <refname>ST_GeomFromGML</refname>
@@ -1884,6 +1997,61 @@ SELECT ST_Transform(ST_SetSRID(ST_Point(3637510, 3014852),2273),4326)::geography
                <para><xref linkend="Geography_Basics" />, <xref linkend="ST_MakePoint" />, <xref linkend="ST_SetSRID" />, <xref linkend="ST_Transform" /></para>
          </refsection>
        </refentry>
+       
+               <refentry id="ST_PointFromGeoHash">
+         <refnamediv>
+               <refname>ST_PointFromGeoHash</refname>
+
+               <refpurpose>Return a point from a GeoHash string.</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                       <funcprototype>
+                               <funcdef>point <function>ST_PointFromGeoHash</function></funcdef>
+                               <paramdef><type>text </type> <parameter>geohash</parameter></paramdef>
+                               <paramdef choice="opt"><type>integer </type> <parameter>precision=full_precision_of_geohash</parameter></paramdef>
+                       </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Return a point from a GeoHash string. The point represents the center point of the GeoHash.</para>
+
+               <para>If no <varname>precision</varname> is specficified ST_PointFromGeoHash returns a point based on full precision of the input GeoHash string.</para>
+
+               <para>If <varname>precision</varname> is specified ST_PointFromGeoHash will use that many characters from the GeoHash to create the point.</para>
+
+               <para>Availability: 2.1.0</para>
+         </refsection>
+
+         <refsection>
+               <title>Examples</title>
+               <programlisting><![CDATA[SELECT ST_AsText(ST_PointFromGeoHash('9qqj7nmxncgyy4d0dbxqz0'));
+          st_astext
+------------------------------
+ POINT(-115.172816 36.114646)
+
+SELECT ST_AsText(ST_PointFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 4));
+             st_astext
+-----------------------------------
+ POINT(-115.13671875 36.123046875)
+
+SELECT ST_AsText(ST_PointFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 10));
+                 st_astext
+-------------------------------------------
+ POINT(-115.172815918922 36.1146435141563)
+               ]]>
+               </programlisting>
+         </refsection>
+        <refsection>
+               <title>See Also</title>
+
+               <para> <xref linkend="ST_GeoHash" />, <xref linkend="ST_Box2dFromGeoHash" />, <xref linkend="ST_GeomFromGeoHash" /></para>
+         </refsection>
+       </refentry>
 
        <refentry id="ST_PointFromText">
                  <refnamediv>

diff --git a/doc/reference_output.xml b/doc/reference_output.xml
index aeff8cfdfd5a6063f8f02b74c98d7b5597550eb7..182344e042d660d0c609322e3c2bf6c55c4bba5e 100644 (file)
--- a/doc/reference_output.xml
+++ b/doc/reference_output.xml
@@ -981,174 +981,7 @@ SELECT ST_GeoHash(ST_SetSRID(ST_MakePoint(-126,48),4326),5);
         <refsection>
                <title>See Also</title>
 
-               <para></para>
-         </refsection>
-       </refentry>
-
-       <refentry id="ST_Box2dFromGeoHash">
-         <refnamediv>
-               <refname>ST_Box2dFromGeoHash</refname>
-
-               <refpurpose>Return a BOX2D from a GeoHash string.</refpurpose>
-         </refnamediv>
-
-         <refsynopsisdiv>
-               <funcsynopsis>
-                       <funcprototype>
-                               <funcdef>box2d <function>ST_Box2dFromGeoHash</function></funcdef>
-                               <paramdef><type>text </type> <parameter>geohash</parameter></paramdef>
-                               <paramdef choice="opt"><type>integer </type> <parameter>precision=full_precision_of_geohash</parameter></paramdef>
-                       </funcprototype>
-               </funcsynopsis>
-         </refsynopsisdiv>
-
-         <refsection>
-               <title>Description</title>
-
-               <para>Return a BOX2D from a GeoHash string.</para>
-
-               <para>If no <varname>precision</varname> is specficified ST_Box2dFromGeoHash returns a BOX2D based on full precision of the input GeoHash string.</para>
-
-               <para>If <varname>precision</varname> is specified ST_Box2dFromGeoHash will use that many characters from the GeoHash to create the BOX2D. Lower precision values results in larger BOX2Ds and larger values increase the precision.</para>
-
-               <para>Availability: 2.1.0</para>
-         </refsection>
-
-         <refsection>
-               <title>Examples</title>
-               <programlisting><![CDATA[SELECT ST_Box2dFromGeoHash('9qqj7nmxncgyy4d0dbxqz0');
-
-                st_geomfromgeohash
---------------------------------------------------
- BOX(-115.172816 36.114646,-115.172816 36.114646)
-
-SELECT ST_Box2dFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 0);
-
- st_box2dfromgeohash
-----------------------
- BOX(-180 -90,180 90)
-
- SELECT ST_Box2dFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 10);
-                            st_box2dfromgeohash
----------------------------------------------------------------------------
- BOX(-115.17282128334 36.1146408319473,-115.172810554504 36.1146461963654)
-               ]]>
-               </programlisting>
-         </refsection>
-        <refsection>
-               <title>See Also</title>
-
-               <para><xref linkend="ST_GeomFromGeoHash" />, <xref linkend="ST_PointFromGeoHash" /></para>
-         </refsection>
-       </refentry>
-
-       <refentry id="ST_PointFromGeoHash">
-         <refnamediv>
-               <refname>ST_PointFromGeoHash</refname>
-
-               <refpurpose>Return a point from a GeoHash string.</refpurpose>
-         </refnamediv>
-
-         <refsynopsisdiv>
-               <funcsynopsis>
-                       <funcprototype>
-                               <funcdef>point <function>ST_PointFromGeoHash</function></funcdef>
-                               <paramdef><type>text </type> <parameter>geohash</parameter></paramdef>
-                               <paramdef choice="opt"><type>integer </type> <parameter>precision=full_precision_of_geohash</parameter></paramdef>
-                       </funcprototype>
-               </funcsynopsis>
-         </refsynopsisdiv>
-
-         <refsection>
-               <title>Description</title>
-
-               <para>Return a point from a GeoHash string. The point represents the center point of the GeoHash.</para>
-
-               <para>If no <varname>precision</varname> is specficified ST_PointFromGeoHash returns a point based on full precision of the input GeoHash string.</para>
-
-               <para>If <varname>precision</varname> is specified ST_PointFromGeoHash will use that many characters from the GeoHash to create the point.</para>
-
-               <para>Availability: 2.1.0</para>
-         </refsection>
-
-         <refsection>
-               <title>Examples</title>
-               <programlisting><![CDATA[SELECT ST_AsText(ST_PointFromGeoHash('9qqj7nmxncgyy4d0dbxqz0'));
-          st_astext
-------------------------------
- POINT(-115.172816 36.114646)
-
-SELECT ST_AsText(ST_PointFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 4));
-             st_astext
------------------------------------
- POINT(-115.13671875 36.123046875)
-
-SELECT ST_AsText(ST_PointFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 10));
-                 st_astext
--------------------------------------------
- POINT(-115.172815918922 36.1146435141563)
-               ]]>
-               </programlisting>
-         </refsection>
-        <refsection>
-               <title>See Also</title>
-
-               <para><xref linkend="ST_Box2dFromGeoHash" />, <xref linkend="ST_GeomFromGeoHash" /></para>
-         </refsection>
-       </refentry>
-
-       <refentry id="ST_GeomFromGeoHash">
-         <refnamediv>
-               <refname>ST_GeomFromGeoHash</refname>
-
-               <refpurpose>Return a geometry from a GeoHash string.</refpurpose>
-         </refnamediv>
-
-         <refsynopsisdiv>
-               <funcsynopsis>
-                       <funcprototype>
-                               <funcdef>geometry <function>ST_GeomFromGeoHash</function></funcdef>
-                               <paramdef><type>text </type> <parameter>geohash</parameter></paramdef>
-                               <paramdef choice="opt"><type>integer </type> <parameter>precision=full_precision_of_geohash</parameter></paramdef>
-                       </funcprototype>
-               </funcsynopsis>
-         </refsynopsisdiv>
-
-         <refsection>
-               <title>Description</title>
-
-               <para>Return a geometry from a GeoHash string. The geometry will be a polygon representing the GeoHash bounds.</para>
-
-               <para>If no <varname>precision</varname> is specficified ST_GeomFromGeoHash returns a polygon based on full precision of the input GeoHash string.</para>
-
-               <para>If <varname>precision</varname> is specified ST_GeomFromGeoHash will use that many characters from the GeoHash to create the polygon.</para>
-
-               <para>Availability: 2.1.0</para>
-         </refsection>
-
-         <refsection>
-               <title>Examples</title>
-               <programlisting><![CDATA[SELECT ST_AsText(ST_GeomFromGeoHash('9qqj7nmxncgyy4d0dbxqz0'));
-                                                        st_astext
---------------------------------------------------------------------------------------------------------------------------
- POLYGON((-115.172816 36.114646,-115.172816 36.114646,-115.172816 36.114646,-115.172816 36.114646,-115.172816 36.114646))
-
-SELECT ST_AsText(ST_GeomFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 4));
-                                                          st_astext
-------------------------------------------------------------------------------------------------------------------------------
- POLYGON((-115.3125 36.03515625,-115.3125 36.2109375,-114.9609375 36.2109375,-114.9609375 36.03515625,-115.3125 36.03515625))
-
-SELECT ST_AsText(ST_GeomFromGeoHash('9qqj7nmxncgyy4d0dbxqz0', 10));
-                                                                                       st_astext
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
- POLYGON((-115.17282128334 36.1146408319473,-115.17282128334 36.1146461963654,-115.172810554504 36.1146461963654,-115.172810554504 36.1146408319473,-115.17282128334 36.1146408319473))
-               ]]>
-               </programlisting>
-         </refsection>
-        <refsection>
-               <title>See Also</title>
-
-               <para><xref linkend="ST_Box2dFromGeoHash" />, <xref linkend="ST_PointFromGeoHash" /></para>
+               <para><xref linkend="ST_GeomFromGeoHash" /></para>
          </refsection>
        </refentry>