Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Branch: master
Pull request Compare This branch is 1136 commits ahead, 28 commits behind bnordgren:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
html
man
rfc Remove more orphaned box2d support functions
xsl
Makefile.comments.in
Makefile.in
README
ZMSgeoms.txt
doxygen.cfg.in
extras.xml
extras_historytable.xml
extras_tigergeocoder.xml
extras_topology.xml
faq.xml
faq_raster.xml
geography.txt
installation.xml
introduction.xml
performance_tips.xml
postgis.xml
reference.xml
reference_accessor.xml
reference_constructor.xml
reference_editor.xml
reference_exception.xml
reference_lrs.xml
reference_management.xml
reference_measure.xml
reference_misc.xml
reference_operator.xml
reference_output.xml
reference_processing.xml
reference_raster.xml
reference_transaction.xml
reference_type.xml
release_notes.xml
reporting.xml
template.xml
using_postgis_app.xml
using_postgis_dataman.xml
using_raster_dataman.xml
xmlformat.conf

README

====================================================
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                      # same as "make comments"
  make install              # same as "make comments-install"
  make uninstall            # same as "make comments-uninstall"
  
  make 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 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 generated files except comments
  make maintainer-clean     # removes all generated files (including comments)


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

To generate the html files and the comments:
  xsltproc                  (http://xmlsoft.org/XSLT/xsltproc2.html)
  DocBook XSL scripts
  MathML 3 DTD              (http://www.w3.org/Math/DTD/)

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
Something went wrong with that request. Please try again.