Opened 11 years ago

Closed 10 years ago

#337 closed task (wontfix)

[wktraster] Write online documentation for WKT Raster

Reported by: pracine Owned by: pracine
Priority: high Milestone: WKTRaster 0.1.6
Component: raster Version: master
Keywords: Cc: mloskot

Description


Change History (9)

comment:1 Changed 11 years ago by mloskot

Cc: mloskot added
Summary: [wkt raster] Write online documentationWrite online documentation for WKT Raster

comment:2 Changed 11 years ago by mloskot

Is it going to be based on DocBook? as PostGIS manual or as Wiki?

comment:3 Changed 11 years ago by mloskot

Summary: Write online documentation for WKT Raster[wktraster] Write online documentation for WKT Raster

comment:4 Changed 11 years ago by pracine

Status: newassigned

comment:5 Changed 11 years ago by pracine

Priority: mediumhigh

comment:6 Changed 11 years ago by robe

Was thinking. Would you guys mind if I started creating an xml file of the functions with examples similar to the PostGIS reference section. By guys I mean WKT Raster folk as well as PostGIS PSC/Developers.

I was thinking of packaging this in with the trunk so it gets put as part of the PostGIS 2.0.0 documentation, but keeping it as a separate file.

Something like wktraster_reference.xml and all the reference ids would be prefixed with RT e.t. RT_ST_AsBinary. Then later on we can merge it in with the rest of reference by like name. Having it follow right after the regular PostGIS reference section for now. I think we have stuff here that is already pretty useful. Just needs some polishing and more exposure. It will be easier to stress test the functions if they are in doc book format and also attract more attention if its part of the main manual. Then have an accompanying raster_comments.sql (separate for now since its not part of core).

Thoughts? If all are agreeable, I can start putting that together.

comment:7 Changed 11 years ago by pracine

Is really WKT Raster be part of PostGIS 2.0? If yes then it's probably a very good initiative. Otherwise maybe it's a better idea to keep everything together in the wiki.

comment:8 Changed 11 years ago by robe

I'm optimistic it will be. The reason I was thinking of keeping it as a separate xml file is that if we don't make the 2.0 wktraster cut, then we can flip it easily into its own standalone manual.

I figure we have 10 months to a year to go before we release 2.0 since some of the stuff we had planned for 2.0 made it to 1.5. I personally see no reason to rush the release of 2.0.

comment:9 Changed 10 years ago by pracine

Resolution: wontfix
Status: assignedclosed
Note: See TracTickets for help on using tickets.