Moved several version functions to the new PostGIS reference.

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

diff --git a/doc/Makefile.in b/doc/Makefile.in
index 0528e133bcfa1c8509140f25d04802f0abce2087..24c3fbb1d259e57bd499f1cd9fb88a821a9784e5 100644 (file)
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -21,7 +21,8 @@ XSLTPROC_COMMONOPTS = \
        --param admon.graphics 1 \
        --param admon.textlabel 0 \
        --param simplesect.in.toc 0 \
-       --param use.id.as.filename 1
+       --param use.id.as.filename 1 \
+       --param chunk.quietly 1
 
 XSLTPROC_HTMLOPTS = \
        --stringparam html.stylesheet style.css \
@@ -33,16 +34,16 @@ CHUNK_HTML_DOCBOOK_XSL=$(XSLBASE)/html/chunk.xsl
 PGSQL_DOCDIR=@PGSQL_DOCDIR@
 PGSQL_MANDIR=@PGSQL_MANDIR@
 
-# If XSLTPROC or XSLBASE were not found during configure, we cannot\r
-# build the documentation\r
-ifeq ($(XSLTPROC),)\r
-all: requirements_not_met_xsltproc\r
-else \r
-ifeq ($(XSLBASE),)\r
-all: requirements_not_met_xslbase \r
-else\r
-all: html/postgis.html\r
-endif\r
+# If XSLTPROC or XSLBASE were not found during configure, we cannot
+# build the documentation
+ifeq ($(XSLTPROC),)
+all: requirements_not_met_xsltproc
+else 
+ifeq ($(XSLBASE),)
+all: requirements_not_met_xslbase 
+else
+all: html/postgis.html
+endif
 endif
 
 postgis-out.xml: postgis.xml introduction.xml installation.xml faq.xml using_postgis.xml performance_tips.xml reference.xml reference_new.xml reporting.xml release_notes.xml ../Version.config

diff --git a/doc/reference.xml b/doc/reference.xml
index 98ea670dd975821213f117111914aea3d077bb9d..cbea4698daf5175ddbca9a23f49e009b35aa9d5b 100644 (file)
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -970,41 +970,6 @@ GROUP BY gid, field1,field2;
           </listitem>
         </varlistentry>
 
-        <varlistentry>
-          <term>postgis_version()</term>
-
-          <listitem>
-            <para>Returns PostGIS version number and compile-time
-            options</para>
-
-            <note>
-              <para>Prior to version 1.1.0 this was a procedural function,
-              thus possibly returning inaccurate information (in case of
-              incomplete database upgrades).</para>
-            </note>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry id="postgis_lib_version">
-          <term>postgis_lib_version()</term>
-
-          <listitem>
-            <para>Returns the version number of the PostGIS library.</para>
-
-            <para>Availability: 0.9.0</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>postgis_lib_build_date()</term>
-
-          <listitem>
-            <para>Returns build date of the PostGIS library.</para>
-
-            <para>Availability: 1.0.0RC1</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>postgis_script_build_date()</term>
 
@@ -1044,69 +1009,13 @@ GROUP BY gid, field1,field2;
 
             <note>
               <para>Starting with version 1.1.0 this function returns the same
-              value of <link
-              linkend="postgis_lib_version">postgis_lib_version()</link>. Kept
+              value of <xref linkend="PostGIS_Lib_Version" />. Kept
               for backward compatibility.</para>
             </note>
 
             <para>Availability: 0.9.0</para>
           </listitem>
         </varlistentry>
-
-        <varlistentry>
-          <term>postgis_geos_version()</term>
-
-          <listitem>
-            <para>Returns the version number of the GEOS library, or NULL if
-            GEOS support is not enabled.</para>
-
-            <para>Availability: 0.9.0</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>postgis_jts_version()</term>
-
-          <listitem>
-            <para>Returns the version number of the JTS library, or NULL if
-            JTS support is not enabled.</para>
-
-            <para>Availability: 1.1.0</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>postgis_proj_version()</term>
-
-          <listitem>
-            <para>Returns the version number of the PROJ4 library, or NULL if
-            PROJ4 support is not enabled.</para>
-
-            <para>Availability: 0.9.0</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>postgis_uses_stats()</term>
-
-          <listitem>
-            <para>Returns true if STATS usage has been enabled, false
-            otherwise.</para>
-
-            <para>Availability: 0.9.0</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry id="postgis_full_version">
-          <term>postgis_full_version()</term>
-
-          <listitem>
-            <para>Reports full postgis version and build configuration
-            infos.</para>
-
-            <para>Availability: 0.9.0</para>
-          </listitem>
-        </varlistentry>
       </variablelist>
     </sect2>
 

diff --git a/doc/reference_new.xml b/doc/reference_new.xml
index 87fa8dd60384610ae95a89f2511584dadac18840..0811707c7c9645f7e671ffd0fc5514bfcd682eee 100644 (file)
--- a/doc/reference_new.xml
+++ b/doc/reference_new.xml
@@ -271,6 +271,357 @@ Check constraints:
       </refsection>
     </refentry>
 
+
+    <refentry id="PostGIS_Full_Version">
+      <refnamediv>
+        <refname>PostGIS_Full_Version</refname>
+
+        <refpurpose>Reports full postgis version and build configuration
+        infos.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_Full_Version</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Reports full postgis version and build configuration
+        infos.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_Full_Version();
+                               postgis_full_version                               
+----------------------------------------------------------------------------------
+ POSTGIS="1.3.3" GEOS="3.1.0-CAPI-1.5.0" PROJ="Rel. 4.4.9, 29 Oct 2004" USE_STATS
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_GEOS_Version" />, <xref
+        linkend="PostGIS_JTS_Version" />, <xref
+        linkend="PostGIS_Lib_Version" />, <xref
+        linkend="PostGIS_PROJ_Version" />, <xref
+        linkend="PostGIS_Version" /></para>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_GEOS_Version">
+      <refnamediv>
+        <refname>PostGIS_GEOS_Version</refname>
+
+        <refpurpose>Returns the version number of the GEOS
+        library.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_GEOS_Version</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Returns the version number of the GEOS library, or
+        <varname>NULL</varname> if GEOS support is not enabled.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_GEOS_Version();
+ postgis_geos_version 
+----------------------
+ 3.1.0-CAPI-1.5.0
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_Full_Version" />, <xref
+        linkend="PostGIS_JTS_Version" />, <xref
+        linkend="PostGIS_Lib_Version" />, <xref
+        linkend="PostGIS_PROJ_Version" />, <xref
+        linkend="PostGIS_Version" /></para>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_JTS_Version">
+      <refnamediv>
+        <refname>PostGIS_JTS_Version</refname>
+
+        <refpurpose>Returns the version number of the JTS
+        library.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_JTS_Version</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Returns the version number of the JTS library, or
+        <varname>NULL</varname> if JTS support is not enabled.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_JTS_Version();
+ postgis_jts_version 
+---------------------
+ 1.8
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_Full_Version" />, <xref
+        linkend="PostGIS_GEOS_Version" />, <xref
+        linkend="PostGIS_Lib_Version" />, <xref
+        linkend="PostGIS_PROJ_Version" />, <xref
+        linkend="PostGIS_Version" /></para>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_Lib_Build_Date">
+      <refnamediv>
+        <refname>PostGIS_Lib_Build_Date</refname>
+    
+        <refpurpose>Returns build date of the PostGIS library.</refpurpose>
+      </refnamediv>
+    
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>Postgis_Lib_Build_Date</function></funcdef>
+    
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+    
+      <refsection>
+        <title>Description</title>
+    
+        <para>Returns build date of the PostGIS library.</para>
+      </refsection>
+    
+      <refsection>
+        <title>Examples</title>
+    
+        <programlisting>SELECT PostGIS_Lib_Build_Date();
+ postgis_lib_build_date 
+------------------------
+ 2008-06-21 17:53:21
+(1 row)</programlisting>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_Lib_Version">
+      <refnamediv>
+        <refname>PostGIS_Lib_Version</refname>
+
+        <refpurpose>Returns the version number of the PostGIS
+        library.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_Lib_Version</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Returns the version number of the PostGIS library.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_Lib_Version();
+ postgis_lib_version 
+---------------------
+ 1.3.3
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_Full_Version" />, <xref
+        linkend="PostGIS_GEOS_Version" />, <xref
+        linkend="PostGIS_JTS_Version" />, <xref
+        linkend="PostGIS_PROJ_Version" />, <xref
+        linkend="PostGIS_Version" /></para>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_PROJ_Version">
+      <refnamediv>
+        <refname>PostGIS_PROJ_Version</refname>
+
+        <refpurpose>Returns the version number of the PROJ4
+        library.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_PROJ_Version</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Returns the version number of the PROJ4 library, or
+        <varname>NULL</varname> if PROJ4 support is not enabled.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_PROJ_Version();
+  postgis_proj_version   
+-------------------------
+ Rel. 4.4.9, 29 Oct 2004
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_Full_Version" />, <xref
+        linkend="PostGIS_GEOS_Version" />, <xref
+        linkend="PostGIS_JTS_Version" />, <xref
+        linkend="PostGIS_Lib_Version" />, <xref
+        linkend="PostGIS_Version" /></para>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_Uses_Stats">
+      <refnamediv>
+        <refname>PostGIS_Uses_Stats</refname>
+
+        <refpurpose>Returns <varname>TRUE</varname> if STATS usage has been
+        enabled.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_Uses_Stats</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Returns <varname>TRUE</varname> if STATS usage has been enabled,
+        <varname>FALSE</varname> otherwise.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_Uses_Stats();
+ postgis_uses_stats 
+--------------------
+ t
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_Version" /></para>
+      </refsection>
+    </refentry>
+
+    <refentry id="PostGIS_Version">
+      <refnamediv>
+        <refname>PostGIS_Version</refname>
+
+        <refpurpose>Returns PostGIS version number and compile-time
+        options.</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>PostGIS_Version</function></funcdef>
+
+            <paramdef></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+
+      <refsection>
+        <title>Description</title>
+
+        <para>Returns PostGIS version number and compile-time options.</para>
+      </refsection>
+
+      <refsection>
+        <title>Examples</title>
+
+        <programlisting>SELECT PostGIS_Version();
+            postgis_version            
+---------------------------------------
+ 1.3 USE_GEOS=1 USE_PROJ=1 USE_STATS=1
+(1 row)</programlisting>
+      </refsection>
+
+      <refsection>
+        <title>See Also</title>
+
+        <para><xref linkend="PostGIS_Full_Version" />, <xref
+        linkend="PostGIS_GEOS_Version" />, <xref
+        linkend="PostGIS_JTS_Version" />, <xref
+        linkend="PostGIS_Lib_Version" />, <xref
+        linkend="PostGIS_PROJ_Version" /></para>
+      </refsection>
+    </refentry>
+
     <refentry id="UpdateGeometrySRID">
       <refnamediv>
         <refname>UpdateGeometrySRID</refname>