[postgis-devel] [WKT Raster] API Reference

[Paragon Corporation]

Mateusz,
I like 3 at least for a long term solution because

1) you can deliver it as a pdf so gives a more polished look.
2) we have scripts in place that will autogenerate the postgresql
psql/pgadmin help descriptions for it so people can quickly get help in the
postgresql tools
3) we have scripts to autogenerate sql tests from that format
4) As you said it would be easier to integrate as a nice cohesive piece with
PostGIS documentation and can be easily deployed as part of the release.

Thanks,
Regina
 

-----Original Message-----
From: postgis-devel-bounces at postgis.refractions.net
[mailto:postgis-devel-bounces at postgis.refractions.net] On Behalf Of Mateusz
Loskot
Sent: Friday, April 17, 2009 4:49 AM
To: postgis-devel at postgis.refractions.net
Subject: [postgis-devel] [WKT Raster] API Reference

Hi,

I'd like to ask and perhaps discuss/chose best structure for WKT Raster API
Reference.

0. Are we documentig API? If we are, C API too or SQL only?

1. Integrated in Trac Wiki or separated as a bunch of HTML pages (perhaps
Doxygen'ed)?

2. If Trac, all one big Wiki page or C API/SQL function per Wiki page.
The first option is simple. For the second one, I've been thinking of
something like:

http://trac.osgeo.org/postgis/wiki/api/core/rt_raster_to_wkb

http://trac.osgeo.org/postgis/wiki/api/pg/RASTER_envelope

http://trac.osgeo.org/postgis/wiki/sql/RT_Width

3. Or, WKT Raster should grab doc engine from PostGIS and feed it with its
own meat, so in future it's easy to merge both, WKT Raster doc into PostGIS
doc?

Best regards,
--
Mateusz Loskot
Senior Programmer, Cadcorp
http://www.cadcorp.com