Submitting documentation for a new PostGIS patch!

Back to PostGIS Dev Main

If you are submitting a patch for a new feature, keep in mind we only allow new feature patches for semi-major and major releases, not for minor releases. So for example if the latest stable version of PostGIS is 1.4 or 1.4 is in freeze mode (which usually happens about 2 months or more before planned release), then your new feature must go into 1.5.

For new features, we expect documentation as part of the submission. To document a new function, please do the following:

1. Make a copy of template.xml located in trunk/doc of the PostGIS subversion repository (​https://svn.osgeo.org/postgis/trunk/doc)
2. Fill in respective information for your new function and make sure to remove anything that is not relevant.
   1. If its not MM compliant please remove that section, but if it is please note the MM section.
   2. If it doesn't support curves, 3D etc., please remove that too.

3. Make very sure in the Availability part to note the PostGIS version this is slated for and if it relies on GEOS, the minimum GEOS version required. This is important so that it gets properly highlighted as new in the documentation and people know which version of GEOS they need to be running to have access to this function.

4. The refpurpose description is kind of important. You want it to be short but very meaningful. This is the description that shows on the index pages and also

gets added to postgis_comments.sql — which is what people looking at PgAdminIII or help in psql see.

5. Name your xml file accordingly e.g. mysuperfunc.xml.
6. Submit this file as part of your new function patch.