#4332: Improve Doc Function Reference categories
---------------------------+---------------------------
Reporter: mdavis | Owner: robe
Type: enhancement | Status: new
Priority: medium | Milestone: PostGIS 3.0.0
Component: documentation | Version: trunk
Keywords: |
---------------------------+---------------------------
This is a proposal to enhance the categorization of the PostGIS doc
[https://postgis.net/docs/manual-2.5/reference.html Function Reference]
page.
The current structure is getting a bit creaky, with categories having long
lists of only vaguely related functions.
The proposed new categories are listed below. There are some notes about
how the function links will be reorganized underneath them. Each category
section will get a short introductory description summarizing the criteria
for function inclusion. This is intended for user information and also to
help guide where to add new functions.
This issue can capture discussion and design iteration if any. The actual
doc change can be done once the design has settled.
1. Spatial Types
* Renamed from ''PostgreSQL PostGIS Geometry / Geography / Box Types''
1. Grand Unified Custom Variables (GUCs)
1. Version Functions
1. Table Definition Functions
1. Geometry Constructors
* functions like MakeXXX
* ST_LineFromMultiPoint, ST_Point
1. Geometry Accessors
* Dump functions
* ST_IsXXX
1. Geometry Validation
1. Geometry Editing
1. Transformations
* Affine transformation functions
* ST_Transform
* ST_FlipCoordinates
1. BBOX Functions
* Functions which return box types
* ST_MakeBox2D, Box2D, etc
* ST_EstimatedExtent
1. Geometry Input
* functions to read from formats
1. Geometry Output
* functions to write to formats
1. Operators - Spatial Relationship
1. Operators - Distance
1. Spatial Relationships
* Binary predicates
* ST_PointInsideCircle
1. Distance
1. Measurement
* Length, area
1. Overlay
* Union, Intersection, etc
* Or title = ''Spatial Analysis'' ?
1. ~~Geometry Processing~~
* REMOVE - contents moved into other sections
1. Geometry Constructions
* centroid, point-on-surface, boundary, boundingDiagonal, etc
* Delaunay / Voronoi
1. Linear Referencing
1. Clustering
1. SFCGAL Functions
1. Trajectory Functions
* Renamed from ''Temporal Support''
1. Long Transaction Functions
1. ~~Miscellaneous Functions~~
* Try and assign all of these to other categories and REMOVE
1. Troubleshooting Functions
* Renamed from ''Exceptional Functions''
--
Ticket URL: <https://trac.osgeo.org/postgis/ticket/4332>
PostGIS <http://trac.osgeo.org/postgis/>
The PostGIS Trac is used for bug, enhancement & task tracking, a user and developer wiki, and a view into the subversion code repository of PostGIS project.