postgis/doc

====================================================
Overview
====================================================

Postgis documentation is written in docbook xml.  The input file is postgis.xml, 
which in turn includes all the individual chapter xml files.  From that file we 
can convert to chunked html, single-file html and pdf.

Make targets are:

  make                      # defaults to creating  
                            #   - the images used in the generated documentation
                            #   - the documentation as a single html file
                            #   - a sql script used to apply COMMENTS for every postgis function
  
  make html/postgis.html    # generates a single-file html file called html/postgis.html
  make chunked-html         # generates a separate html file for every chapter or section break
  make pdf                  # generates a single pdf file with the postgis version as a filename
  make images               # generates all the images used in the html and pdf targets
  make comments             # generates a sql script that add COMMENTs for every function (derived from the documentation)
  make doxygen              # generates the developer's documentation using Doxygen
  
  make install              # copies PostGIS' utility (ie. shp2pgsql) man pages to the PostgreSQL's doc directory
  make uninstall            # removes PostGIS' utility man pages
  make comments-install     # copies the postgis-comments.sql script to the PostgreSQL's contrib directory
  make comments-uninstall   # removes the postgis-comments.sql script from the contrib directory
  
  make clean                # removes any generated files (except images and html files)
  make maintainer-clean     # clears out the generated images and html files


====================================================
Requirements
====================================================

To generate the html files:
  xsltproc                  (http://xmlsoft.org/XSLT/xsltproc2.html)
  DocBook XSL scripts

To generate the images:
  ImageMagick               (http://www.imagemagick.org/script/index.php)

To generate a pdf:
  dblatex                   (http://dblatex.sourceforge.net)

To generate the developer's documentation:
  doxygen                   (http://www.stack.nl/~dimitri/doxygen)


====================================================
How To
====================================================

To generate images used in the documentation, follow these instructions on the PostGIS wiki:
	http://trac.osgeo.org/postgis/wiki/DevWikiDocNewFeature
	
To run garden tests against functions, follow these instructions on the PostGIS dev wiki:
	http://trac.osgeo.org/postgis/wiki/DevWikiGardenTest