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
Bborie Park 5fc94286f9 Allow correct handling of sect2 tags in chunked html 
git-svn-id: http://svn.osgeo.org/postgis/trunk@11465 b70326c6-7e19-0410-871a-916f4a2858ee
2013-05-14 22:38:13 +00:00
..
html dustymugs must have made a correction to pseudo_color -- no black background anymore, also add in visualizations for new named color ramps and liink fromST_AsPNNG TOST_COLRMap 2013-05-13 04:14:54 +00:00
man Properly escape dashes in man pages 2013-04-17 06:58:45 +00:00
po #2323. Commit it and br .po for sfcgal doc 2013-05-12 19:40:59 +00:00
rfc Remove more orphaned box2d support functions 2011-10-26 22:58:21 +00:00
xsl one more try 2013-05-11 16:05:28 +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 add new use_pagc_addess_parser switch in list 2013-04-15 21:14:09 +00:00
extras_topology.xml Fix areal TopoJSON output to group and order polygon rings (#2228) 2013-03-21 16:15:51 +00:00
faq.xml give license faq a permanent pretty anchor. 2013-04-10 20:06:50 +00:00
faq_raster.xml fix link 2013-03-29 15:55:25 +00:00
geography.txt #824 more corrections from Kashif Rasul 2011-02-10 11:59:20 +00:00
installation.xml Related to #2321. SFCGAL doc entry in installation.xml. 2013-05-11 13:24:16 +00:00
introduction.xml Added ST_TPI(raster). Ticket #2163. Thanks to Nathaniel Clay for writing 2013-05-07 15:39:40 +00:00
Makefile.comments.in Change PGCONFIG to PG_CONFIG 2013-04-16 15:21:42 +00:00
Makefile.in Allow correct handling of sect2 tags in chunked html 2013-05-14 22:38:13 +00:00
performance_tips.xml ST_Force_XXX renamed to ST_ForceXXX 2013-05-10 15:00:38 +00:00
postgis.xml bump trunk to 2.1.0beta3dev 2013-05-12 04:19:28 +00:00
README Update doc/README (#1721) 2012-03-27 09:56:17 +00:00
reference.xml Add SFCGAL support cf #2254. Include SFCGAL support, postgis backend handling (GEOS/SFCGAL). Regress tests, documentation prototypes and also additional force_sfs function. 2013-05-09 19:38:17 +00:00
reference_accessor.xml #2118: add enhanced note to ST_Boundary (to note Nathan Wagner ST_Triangle support feature) 2013-05-05 16:34:08 +00:00
reference_constructor.xml #1818 slight doc change move the FromGeoHash family to constructor section and link back to ST_GeoHash output and amend credits to Jason Smith 2013-05-05 22:35:47 +00:00
reference_editor.xml cf #2318, add a optional additional version parameter in ST_ForceSFS, handle both 1.1 and 1.2. default is 1.1 2013-05-10 17:17:18 +00:00
reference_exception.xml fix example 2010-01-29 18:22:35 +00:00
reference_lrs.xml Deprecate non-CamelCase linear referencing function (#1994) 2013-03-20 16:47:24 +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 Add SFCGAL support cf #2254. Include SFCGAL support, postgis backend handling (GEOS/SFCGAL). Regress tests, documentation prototypes and also additional force_sfs function. 2013-05-09 19:38:17 +00:00
reference_misc.xml get rid of use of xml tags in arg - messing up formatting of cheat sheet gen 2013-02-09 05:24:05 +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 #1818 slight doc change move the FromGeoHash family to constructor section and link back to ST_GeoHash output and amend credits to Jason Smith 2013-05-05 22:35:47 +00:00
reference_processing.xml Add SFCGAL support cf #2254. Include SFCGAL support, postgis backend handling (GEOS/SFCGAL). Regress tests, documentation prototypes and also additional force_sfs function. 2013-05-09 19:38:17 +00:00
reference_raster.xml Fixed Raster Processing section 2013-05-14 20:42:28 +00:00
reference_sfcgal.xml Use ST_MinkowskiSum rather than ST_Minkowski userland. 2013-05-10 16:23:22 +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.0.3 and 2.1 sections, break out 2.1 changed from new 2013-05-02 12:00:26 +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 Remove <inlineequation> element 2012-11-13 18:58:52 +00:00
using_raster_dataman.xml Updated raster2pgsql help and docs to reflect changes to 2012-12-14 20:27: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