self-hosted/postgis
self-hosted/postgis
1
0
Fork 0
mirror of https://git.osgeo.org/gitea/postgis/postgis synced 2024-10-24 00:52:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
postgis/doc
History
Regina Obe 67ffd6f4a1 #2603: add weighted and mask args 
git-svn-id: http://svn.osgeo.org/postgis/trunk@14178 b70326c6-7e19-0410-871a-916f4a2858ee
2015-10-03 18:28:58 +00:00
..
.tx Add reference_temporal.xml translation resource 2015-09-29 12:31:03 +00:00
html put in more description of minkowski sum, fix first example so fits in 200x200 grid, add second example 2015-09-03 17:19:23 +00:00
man Add -m reference in shp2pgsql manpage. See ticket #899. 2014-07-25 10:57:48 +00:00
po Fix check-local rule to properly setup symlinks 2015-09-29 21:25:59 +00:00
rfc Remove more orphaned box2d support functions 2011-10-26 22:58:21 +00:00
xsl #2324: Fix chart so 2D support only enabled with sfcgal is tagged with sfcgal icon 2015-09-03 22:33:20 +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 #2813 add address_standardizer as part of doxygen build 2014-07-06 03:17:34 +00:00
extras.xml Move topology and address standardizer entities out of extra 2014-10-14 10:05:25 +00:00
extras_address_standardizer.xml fix mismatched ids 2015-09-09 07:44:05 +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 try to fix illegal abstract (with note (instead of para)) and listltiem with no para 2015-09-30 04:33:44 +00:00
extras_topology.xml Minor spelling fixes (#3288) 2015-09-26 10:17:42 +00:00
faq.xml #2918, Use GeographicLib functions for geodetics 2015-05-19 14:37:01 +00:00
faq_raster.xml add other error you might see to the security raster faq 2015-05-02 07:01:51 +00:00
geography.txt #824 more corrections from Kashif Rasul 2011-02-10 11:59:20 +00:00
installation.xml try to fix illegal abstract (with note (instead of para)) and listltiem with no para 2015-09-30 04:33:44 +00:00
introduction.xml Add item about new topology API in liblwgeom 2015-07-19 10:11:16 +00:00
Makefile.comments.in Drop PGXSOVERRIDE temporary hack. PostgreSQL 9.0 is minimum req now. 2015-06-22 14:47:43 +00:00
Makefile.in Fix check-local rule to properly setup symlinks 2015-09-29 21:25:59 +00:00
performance_tips.xml ST_Force_XXX renamed to ST_ForceXXX 2013-05-10 15:00:38 +00:00
postgis.xml Add ST_IsValidTrajectory (#3129) 2015-05-28 15:18:23 +00:00
README Update doc/README (#1721) 2012-03-27 09:56:17 +00:00
reference.xml Add ST_IsValidTrajectory (#3129) 2015-05-28 15:18:23 +00:00
reference_accessor.xml ST_BoundingDiagonal (#3139) 2015-06-01 16:09:22 +00:00
reference_constructor.xml Add ST_Boundary in "see also" section for ST_MakePolygon 2015-06-13 08:08:39 +00:00
reference_editor.xml Make ST_Scale not use ST_Affine 2015-06-11 19:41:20 +00:00
reference_exception.xml fix example 2010-01-29 18:22:35 +00:00
reference_guc.xml fix typo in tag provide example for enable driver and database and system level 2015-09-29 03:30:28 +00:00
reference_lrs.xml Add ST_IsValidTrajectory (#3129) 2015-05-28 15:18:23 +00:00
reference_management.xml Fix typo in PopulateGeometryColumns docs 2015-08-20 15:00:02 +00:00
reference_measure.xml ST_Relate use integer instead of int for arg type. That's what PostgreSQL shows it as in final function and int is tripping up garden tests (doesn't know what int is). 2015-08-21 06:54:08 +00:00
reference_misc.xml Deprecate ST_Point_Inside_Circle (#2748) 2015-05-11 17:07:38 +00:00
reference_operator.xml Trim refpurpose section for <-> operator, move details down 2015-06-10 16:42:49 +00:00
reference_output.xml yes, our docs have to 1:1 match our functions :/ 2015-08-28 12:39:49 +00:00
reference_processing.xml Cross-link ST_Subdivide and ST_Split 2015-09-21 06:59:25 +00:00
reference_raster.xml #2603: add weighted and mask args 2015-10-03 18:28:58 +00:00
reference_sfcgal.xml give example of ST_3DArea 2015-09-03 23:20:38 +00:00
reference_temporal.xml Expose ST_CPAWithin to SQL 2015-06-23 18:56:11 +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 Add 2.2 release notes, en-link'en ticket numbers 2015-09-24 17:18:15 +00:00
reporting.xml Documentation URLs, visible whitespace, and minor touchups (#1548) from mwtoews 2012-02-07 17:23:50 +00:00
template.xml Define new &address_standardizer_required; xml constant and flag functions requiring it 2014-07-22 22:34:46 +00:00
using_postgis_app.xml Fix syntax error in MS example 2012-02-10 16:18:05 +00:00
using_postgis_dataman.xml #899 shp2pgsql attribute names mapping (including test 2014-07-24 17:37:10 +00:00
using_raster_dataman.xml #3043: Some raster2pgsql options are not documented 2015-09-26 16:42:54 +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