self-hosted/postgis
self-hosted/postgis
1
0
Fork 0
mirror of https://git.osgeo.org/gitea/postgis/postgis synced 2024-10-24 09:02:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
postgis/doc
History
Sandro Santilli 6e07fa28af Fix order of TopoGeometry property names 
git-svn-id: http://svn.osgeo.org/postgis/trunk@10639 b70326c6-7e19-0410-871a-916f4a2858ee
2012-11-04 14:40:11 +00:00
..
html Added docs for ST_InvDistWeight4ma() and ST_MinDist4ma(). Changed 2012-09-19 18:48:31 +00:00
man Document the new -s from:to syntax of shp2pgsql [#994] 2011-12-21 16:17:55 +00:00
po Update po files after changes in installation.xml 2012-10-12 07:50:07 +00:00
rfc Remove more orphaned box2d support functions 2011-10-26 22:58:21 +00:00
xsl Put in Enhanced note about ST_DumpPoints -- should in theory be faster. Revise expertbot xsl script (prevent url from abutting the title) 2012-10-30 21:16:49 +00:00
bnf-wkb.txt Document ISO WKT/WKB (#1451) 2012-09-20 22:24:16 +00:00
bnf-wkt.txt Document ISO WKT/WKB (#1451) 2012-09-20 22:24:16 +00:00
doxygen.cfg.in #836 PostGIS raster in 2.0 is not being output in Trunk Doxygen 2011-02-17 04:31:14 +00:00
extras.xml revmoe history table out of docs for now 2011-09-05 15:44:49 +00:00
extras_historytable.xml Move ST_AsRaster and ST_Band to raster contructor section 2011-09-06 02:11:07 +00:00
extras_tigergeocoder.xml #1627 : more cleanup of extension install, add configure of tiger extension script to configure.ac. Fix comment in tiger comments preventing install 2012-10-10 22:59:09 +00:00
extras_topology.xml Fix order of TopoGeometry property names 2012-11-04 14:40:11 +00:00
faq.xml some wording changes, add tutorial faq 2012-10-31 19:33:35 +00:00
faq_raster.xml Fix gdal binaries link 2012-10-29 22:24:20 +00:00
geography.txt #824 more corrections from Kashif Rasul 2011-02-10 11:59:20 +00:00
installation.xml some wording changes, add tutorial faq 2012-10-31 19:33:35 +00:00
introduction.xml Add Nathan Wagner to credits 2012-10-30 21:38:48 +00:00
Makefile.comments.in Install topology_comments.sql as well 2012-02-13 20:44:33 +00:00
Makefile.in Add pdf-localized rule for building localized pdf manual 2012-10-12 14:26:02 +00:00
performance_tips.xml Documentation URLs, visible whitespace, and minor touchups (#1548) from mwtoews 2012-02-07 17:23:50 +00:00
postgis.xml might as well change last geos version to latest release we technically don't even support 3.3.0 2012-06-20 03:32:51 +00:00
README Update doc/README (#1721) 2012-03-27 09:56:17 +00:00
reference.xml try to force paragraph at top using sectinfo abstract. Make note about deprecation more threatening. 2009-11-28 07:13:35 +00:00
reference_accessor.xml #1859 commit doc corrections from Kashif Rasul. 2012-06-10 06:25:35 +00:00
reference_constructor.xml More Double quote tag attribute values for poxml support 2012-09-14 20:52:10 +00:00
reference_editor.xml Add changed section for 2.1 and mark ST_Segmentize as having a breaking change 2012-09-14 03:10:41 +00:00
reference_exception.xml fix example 2010-01-29 18:22:35 +00:00
reference_lrs.xml More Double quote tag attribute values for poxml support 2012-09-14 20:52:10 +00:00
reference_management.xml updategeometrysrid was describing old behavior. Update to new and provide alternative syntax 2012-10-14 05:13:50 +00:00
reference_measure.xml minor adjustments to terminology to improve searchin 2012-10-24 03:41:56 +00:00
reference_misc.xml Remove now obsolete note. 2012-09-20 23:44:47 +00:00
reference_operator.xml Add link to OpenGeo workshop on KNN to KNN operator. 2012-09-22 03:55:57 +00:00
reference_output.xml More Double quote tag attribute values for poxml support 2012-09-14 20:52:10 +00:00
reference_processing.xml Put in Enhanced note about ST_DumpPoints -- should in theory be faster. Revise expertbot xsl script (prevent url from abutting the title) 2012-10-30 21:16:49 +00:00
reference_raster.xml Removed code that is no longer used and updated docs with default 2012-11-02 20:40:25 +00:00
reference_transaction.xml Documentation URLs, visible whitespace, and minor touchups (#1548) from mwtoews 2012-02-07 17:23:50 +00:00
reference_type.xml Documentation URLs, visible whitespace, and minor touchups (#1548) from mwtoews 2012-02-07 17:23:50 +00:00
release_notes.xml revert release note changes see if it fixes doc build issue 2012-10-25 06:00:07 +00:00
reporting.xml Documentation URLs, visible whitespace, and minor touchups (#1548) from mwtoews 2012-02-07 17:23:50 +00:00
template.xml More Double quote tag attribute values for poxml support 2012-09-14 20:52:10 +00:00
using_postgis_app.xml Fix syntax error in MS example 2012-02-10 16:18:05 +00:00
using_postgis_dataman.xml more ids and descriptive titles 2012-10-27 05:53:31 +00:00
using_raster_dataman.xml fix id again (maybe old conflicted with another id) 2012-10-25 05:18:27 +00:00
xmlformat.conf performed an overhaul of the installation guide ... hopefully it's easier to follow. 2009-05-27 17:14:08 +00:00
ZMSgeoms.txt #821: doc typos errata from Kashif Rasul 2011-02-09 12:54:23 +00:00

README 

PostGIS Documentation
=====================

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 publish several formats, including HTML and PDF.

Make targets
------------

``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/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 an 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 ``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 stylesheets
 * MathML 3 DTD - http://www.w3.org/Math/DTD/

To generate the images:
 * ImageMagick - http://www.imagemagick.org/

To generate a PDF:
 * dblatex - http://dblatex.sourceforge.net

To generate the developer's documentation:
 * Doxygen - http://www.stack.nl/~dimitri/doxygen/
 * Graphviz - http://www.graphviz.org/

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