vlib/dox: add subpage for GRASS-PostGIS data provider

          clean up


git-svn-id: https://svn.osgeo.org/grass/grass/trunk@54084 15284696-431f-4ddb-bdfa-cd5b030d7da7

lib/vector/dglib/dglib.dox

@@ -1,8 +1,8 @@
 /*! \page dglib Directed Graph Library
 
-by GRASS Development Team
+by GRASS Development Team (http://grass.osgeo.org)
 
-http://grass.osgeo.org/dglib/
+\tableofcontents
 
 \section vlibDglibShortIntro Short introduction
 

lib/vector/neta/netalib.dox

@@ -2,6 +2,8 @@
 
 by GRASS Development Team (http://grass.osgeo.org)
 
+\tableofcontents
+
 This library is used for network-based analysis, see <tt>v.net.*</tt>
 modules for implementation issues.
 

lib/vector/vectorlib.dox

@@ -4,29 +4,19 @@ by GRASS Development Team (http://grass.osgeo.org)
 
 \tableofcontents
 
-\par Table of contents
-- \ref vlibBackground
-- \ref vlibIntro
-- \ref vlibVectorMap
-- \ref vlibVectorLevels
-- \ref vlibCategoriesLayers
-- \ref vlibAttributes
-- \ref vlibGeometry
- - \ref vlibFeatureTypes
-- \ref vlibStructures
-- \ref vlibFunc
-- \ref vlibAuthors
-- \ref vlibReferences
-- \ref vlibSeealso
-
-\par Subpages
+\par Related
 - \subpage vlibDescription
 - \subpage vlibFormat
 - \subpage vlibTopology
 - \subpage vlibIndices
 - \subpage vlibAscii
-- \subpage vlibOgr
 - \subpage vlibTin
+
+\par Data providers for external formats
+- \subpage vlibOgr
+- \subpage vlibPg
+
+\par Related libraries
 - \subpage veditlib
 - \subpage dglib
 - \subpage netalib

lib/vector/vectorlib_ascii.dox

@@ -2,6 +2,8 @@
 
 by GRASS Development Team (http://grass.osgeo.org)
 
+\tableofcontents
+
 \section vlibAsciiMain Vector ASCII Format Specifications
 
 The GRASS ASCII vector map format may contain a mix of primitives

lib/vector/vectorlib_files.dox

@@ -4,14 +4,6 @@ by GRASS Development Team (http://grass.osgeo.org)
 
 \tableofcontents
 
-\par Table of contents
-
-- \ref vlibDirectoryStructure
-- \ref vlibDblnFileFormat
-- \ref vlibCoorFileFormat
- - \ref vlibCoorFileHead
- - \ref vlibCoorFileBody
-
 \section vlibDirectoryStructure Directory structure
 
 Vector map is stored in a number of data files. Vector map directory

lib/vector/vectorlib_indices.dox

@@ -4,15 +4,6 @@ by GRASS Development Team (http://grass.osgeo.org)
 
 \tableofcontents
 
-\par Table of contents
-
-- \ref vlibSpidx
- - \ref vlibSidxFileFormat
-- \ref vlibCidx
- - \ref vlibCidxFileFormat
-  - \ref vlibCidxFileHead
-
-
 \section vlibSpidx Vector library spatial index management
 
 Spatial index (based on R*-tree) is created with topology, see \ref

lib/vector/vectorlib_libraries.dox

@@ -4,11 +4,6 @@ by GRASS Development Team (http://grass.osgeo.org)
 
 \tableofcontents
 
-\par Table of contents
-
-- \ref vlibsAboutIntro
-- \ref vlibsHistory
-
 \section vlibsAboutIntro Introduction
 
 Besides internal library functions there are two main libraries:

lib/vector/vectorlib_ogr.dox

@@ -1,17 +1,10 @@
-/*! \page vlibOgr OGR interface
+/*! \page vlibOgr GRASS-OGR data provider
 
 by GRASS Development Team (http://grass.osgeo.org)
 
-\par Table of contents
+\tableofcontents
 
-- \ref vlibOgrIface
- - \ref vlibFrmtFileFormat
- - \ref vlibFidxFileFormat
-
-
-\section vlibOgrIface OGR interface
-
-\subsection vLibPseudoTopo Pseudo-topology
+\section vLibPseudoTopo Pseudo-topology
 
 Reduced topology: each boundary is attached to one area only,
 i.e. smoothing, simplification, removing small areas etc. will not
@@ -21,7 +14,7 @@ Full topology is only available for native GRASS vectors or can only
 be built after all polygons are converted to areas and cleaned as done
 by <tt>v.in.ogr</tt>.
 
-\subsection vlibFrmtFileFormat Frmt file format specification
+\section vlibFrmtFileFormat Frmt file format specification
 
 Frmt is a plain text file which contains basic information about
 external format of linked vector map. Each line contains key, value
@@ -46,7 +39,7 @@ OGR layer pseudo-topology ('topo') is built including spatial index
 file ('sidx') and category index file ('cidx'). Additionally also
 feature index file (see \ref vlibFidxFileFormat) is created.
 
-\subsection vlibFidxFileFormat Fidx file format specification
+\section vlibFidxFileFormat Fidx file format specification
 
 Note: <tt>finfo</tt> is an instance of \ref Format_info structure.
 

lib/vector/vectorlib_pg.dox

@@ -0,0 +1,101 @@
+/*! \page vlibPg GRASS-PostGIS data provider
+
+by GRASS Development Team (http://grass.osgeo.org)
+
+\tableofcontents
+
+\section vlibPgInro Introduction
+
+<b>GRASS-PostGIS data provider</b> allows GRASS vector library to read and
+write PostGIS data directly without any external library (like in the
+case of \ref vlibOgr). GRASS-PostGIS data provider is implemented
+using <a
+href="http://www.postgresql.org/docs/9.2/static/libpq.html">libpq
+library</a>.
+
+Note that GRASS-PostGIS data provider is compiled only when GRASS is
+configured with <tt>--with-postgres</tt> switch.
+
+See the <a
+href="http://trac.osgeo.org/grass/wiki/Grass7/VectorLib/PostGISInterface">trac
+page</a> for more info.
+
+\section vlibFn List of functions
+
+Note that the functions listed bellow are lower level subroutines, in
+other word these functions are not consider for usage. They are
+internally used by the vector library when accessing PostGIS data. The
+programmer should use higher level functions instead. 
+
+- Vect_open_old() to open exising vector map (ie. PostGIS table when using GRASS-PostGIS data provider)
+- Vect_open_new() to create new vector map
+- Vect_close() to close vector map
+
+- Vect_rewind() to rewind the map for sequential access
+- Vect_read_next_line() for sequential access
+- Vect_read_line() for random access
+
+- Vect_write_line() to write a new feature
+- Vect_delete_line() to delete existing feature
+- Vect_rewrite_line() to modify exising feature
+
+- Vect_build() to build (pseudo-)topology
+
+Note that functions with <tt>V1_</tt> prefix access vector data
+without topology. Topological (pseudo-topological for simple features)
+access is provided by functions starting with <tt>V2_</tt> prefix.
+
+\par Open/Create PostGIS table as GRASS vector map
+
+- V1_open_old_pg()
+- V2_open_old_pg()
+
+- V1_open_new_pg()
+- V2_open_new_pg()
+
+- V1_close_pg()
+- V2_close_pg()
+
+\par Read feature from PostGIS table
+
+- V1_rewind_pg()
+- V2_rewind_pg()
+
+- V1_read_next_line_pg()
+- V2_read_next_line_pg()
+
+- V1_read_line_pg()
+- V2_read_line_sfa()
+- V2_read_line_pg()
+
+\par Write new feature to PostGIS table
+
+- V1_write_line_pg()
+- V2_write_line_sfa()
+- V2_write_line_pg()
+
+\par Delete exising feature from PostGIS table
+
+- V1_delete_line_pg()
+- V2_delete_line_sfa()
+
+\par Modify existing feature from PostGIS table
+
+- V1_rewrite_line_pg()
+- V2_rewrite_line_sfa()
+
+\par Build topology
+
+- Vect_open_topo_pg()
+- Vect__build_sfa()
+- Vect_build_pg()
+ 
+\section vlibPgSeeAlso See Also
+
+ - \ref vlibOgr
+
+\section vlibPgAuthors Authors
+
+Martin Landa <landa.martin gmail.com>
+
+*/

lib/vector/vectorlib_tin.dox

@@ -2,6 +2,8 @@
 
 by GRASS Development Team (http://grass.osgeo.org)
 
+\tableofcontents
+
 <em>This page needs to be enhanced.</em>
 
 \section vlibTinIntro Short introduction

lib/vector/vectorlib_topology.dox

@@ -2,17 +2,7 @@
 
 by GRASS Development Team (http://grass.osgeo.org)
 
-\par Table of contents
-
-- \ref vlibTopoManagement
- - \ref vlibTopoFileFormat
-  - \ref vlibTopoFileHead
-  - \ref vlibTopoFileBody
- - \ref vlibTopoLevels
- - \ref vlibTopoExamples
- - \ref vlibTopoMemory
-
-
+\tableofcontents
 
 \section vlibTopoManagement Vector library topology management
 

lib/vector/vedit/veditlib.dox

@@ -2,6 +2,8 @@
 
 by GRASS Development Team (http://grass.osgeo.org)
 
+\tableofcontents
+
 \section veditIntro Introduction to Vedit Library
 
 This library contains higher level functions for editing %vector
@@ -44,9 +46,6 @@ The library is used by <tt>v.edit</tt> module and wxGUI %vector digitizer.
 
 \subsection veditSelect Select features
 
-
-
-
  - Vedit_select_by_query()
 
 \subsection veditSnap Snapping