]> granicus.if.org Git - postgis/commitdiff
Add a "TopoGeometry Editors" section
authorSandro Santilli <strk@keybit.net>
Fri, 7 Dec 2012 09:24:20 +0000 (09:24 +0000)
committerSandro Santilli <strk@keybit.net>
Fri, 7 Dec 2012 09:24:20 +0000 (09:24 +0000)
I've added a toTopoGeom entry in this section for the sole purpose
of redirecting to the one in "TopoGeometry Constructors".
It's two overloaded functions, documented togheter in the latter
section. If there's any better way to deal with this I'm looking
forward for enhancements.

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

doc/extras_topology.xml

index 52ddeb29448ea64875cdf179057b645c38e0e571..a31e1e49a2f22c9c2fed85c0c8676c3584721e35 100644 (file)
@@ -2698,6 +2698,54 @@ SELECT ST_GetFaceGeometry('topo_boston_test', f.face_id)
                        </refsection>
                </refentry>
 
+               <refentry id="TopoElementArray_Agg">
+          <refnamediv>
+            <refname>TopoElementArray_Agg</refname>
+            <refpurpose>Returns a <varname>topoelementarray</varname> for a set of element_id, type arrays (topoelements)</refpurpose>
+          </refnamediv>
+        
+          <refsynopsisdiv>
+            <funcsynopsis>
+              <funcprototype>
+                <funcdef>topoelementarray <function>TopoElementArray_Agg</function></funcdef>
+                <paramdef><type>topoelement set</type> <parameter>tefield</parameter></paramdef>
+              </funcprototype>
+            </funcsynopsis>
+          </refsynopsisdiv>
+          
+               <refsection>
+                <title>Description</title>
+            
+                <para>Used to create a <xref linkend="topoelementarray" /> from a set of <xref linkend="topoelement" />.</para>
+                
+                <!-- use this format if new function -->
+                <para>Availability: 2.0.0</para>
+                       </refsection>
+               
+               
+                       <refsection>
+                               <title>Examples</title>
+                               <programlisting>SELECT topology.TopoElementArray_Agg(ARRAY[e,t]) As tea
+  FROM generate_series(1,3) As e CROSS JOIN generate_series(1,4) As t;
+  tea
+--------------------------------------------------------------------------
+{{1,1},{1,2},{1,3},{1,4},{2,1},{2,2},{2,3},{2,4},{3,1},{3,2},{3,3},{3,4}}</programlisting>
+                       </refsection>
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="topoelement"/>, <xref linkend="topoelementarray"/></para>
+                       </refsection>
+          </refentry>
+       </sect1>
+
+       <sect1 id="TopoGeometry_Editors">
+    <sect1info>
+        <abstract>
+            <para>This section covers the topology functions for editing existing topogeometries.</para>
+        </abstract>
+    </sect1info>
+         <title>TopoGeometry Editors</title>
+
                <refentry id="clearTopoGeom">
                        <refnamediv>
                                <refname>clearTopoGeom</refname>
@@ -2743,45 +2791,21 @@ UPDATE nei_topo SET topo = ST_Buffer(clearTopoGeom(topo), -10);
         </para>
                        </refsection>
                </refentry>
-               
-               <refentry id="TopoElementArray_Agg">
-          <refnamediv>
-            <refname>TopoElementArray_Agg</refname>
-            <refpurpose>Returns a <varname>topoelementarray</varname> for a set of element_id, type arrays (topoelements)</refpurpose>
-          </refnamediv>
-        
-          <refsynopsisdiv>
-            <funcsynopsis>
-              <funcprototype>
-                <funcdef>topoelementarray <function>TopoElementArray_Agg</function></funcdef>
-                <paramdef><type>topoelement set</type> <parameter>tefield</parameter></paramdef>
-              </funcprototype>
-            </funcsynopsis>
-          </refsynopsisdiv>
-          
-               <refsection>
+
+    <refentry>
+                       <refnamediv>
+        <refname>toTopoGeom</refname>
+                               <refpurpose>Adds a geometry shape to an existing topo geometry</refpurpose>
+                       </refnamediv>
+                       <refsection>
                 <title>Description</title>
-            
-                <para>Used to create a <xref linkend="topoelementarray" /> from a set of <xref linkend="topoelement" />.</para>
-                
-                <!-- use this format if new function -->
-                <para>Availability: 2.0.0</para>
-                       </refsection>
-               
+<para>
+Refer to <xref linkend="toTopoGeom" />  
+</para>
+      </refsection>
+    </refentry>
+
                
-                       <refsection>
-                               <title>Examples</title>
-                               <programlisting>SELECT topology.TopoElementArray_Agg(ARRAY[e,t]) As tea
-  FROM generate_series(1,3) As e CROSS JOIN generate_series(1,4) As t;
-  tea
---------------------------------------------------------------------------
-{{1,1},{1,2},{1,3},{1,4},{2,1},{2,2},{2,3},{2,4},{3,1},{3,2},{3,3},{3,4}}</programlisting>
-                       </refsection>
-                       <refsection>
-                               <title>See Also</title>
-                               <para><xref linkend="topoelement"/>, <xref linkend="topoelementarray"/></para>
-                       </refsection>
-          </refentry>
        </sect1>
        
        <sect1 id="TopoGeom_Accessors">
@@ -2882,6 +2906,7 @@ UPDATE nei_topo SET topo = ST_Buffer(clearTopoGeom(topo), -10);
                                <para><xref linkend="GetTopoGeomElementArray"/>, <xref linkend="topoelement"/></para>
                        </refsection>
                </refentry>
+
        </sect1>