postgis

mirror of https://git.osgeo.org/gitea/postgis/postgis synced 2024-10-23 08:32:42 +00:00

History

Regina Obe 2ec311afe7 Link several functions back to new Topology_Load_Tiger since that demonstrates use of these functions git-svn-id: http://svn.osgeo.org/postgis/trunk@7837 b70326c6-7e19-0410-871a-916f4a2858ee		2011-09-11 02:42:32 +00:00
..
html	more examples	2011-09-06 16:24:07 +00:00
man	Commit rework of #885 (pgsql2shp fields conversion from predefined list).	2011-06-29 22:40:54 +00:00
rfc	Mark "chip" functions for deletion	2011-08-09 15:43:11 +00:00
xsl	more clarification of behavior change in 2.0 of bbox storage	2011-08-16 13:19:18 +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	minor wording changes and reference to configuration part of documentation	2011-09-10 14:09:02 +00:00
extras_topology.xml	Link several functions back to new Topology_Load_Tiger since that demonstrates use of these functions	2011-09-11 02:42:32 +00:00
faq.xml	Put legacy.sql in varname tag so prints out as courier and stands out more. Some clarification on the geography/geometry choice question	2011-06-07 13:04:23 +00:00
faq_raster.xml	#1062 apply typo patch from Kasif Rasul	2011-06-25 20:24:14 +00:00
geography.txt	#824 more corrections from Kashif Rasul	2011-02-10 11:59:20 +00:00
installation.xml	minor wording changes and reference to configuration part of documentation	2011-09-10 14:09:02 +00:00
introduction.xml	Update credits and release notes to include change in geometry_columns and management functions, add ST_OffSetCurve to release_notes.xml, add Rafal Magda to people credits list	2011-07-03 05:03:45 +00:00
Makefile.comments.in	add raster_comments.sql to be copied to contrib directory as well	2010-10-13 08:12:16 +00:00
Makefile.in	Honour DESTDIR in documentation Makefile. Patch by Bryce L Nordgren.	2011-09-10 11:49:43 +00:00
performance_tips.xml	Commit jlivni documentation addition and update with minor comment for PostgreSQL 8.4 users and notice about obsolete settings. Also put in hyperlinks back to the current interactive version of PostgreSQL manual for each part.	2009-08-28 11:34:17 +00:00
postgis.xml	fix typo	2011-09-04 02:50:40 +00:00
README	#824 more corrections from Kashif Rasul	2011-02-10 11:59:20 +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	#924 - document breaking change	2011-06-22 23:10:36 +00:00
reference_constructor.xml	minor updates to ST_MakeLine to clarify pre-9.0 and 9.0+ approaches	2011-07-27 19:21:09 +00:00
reference_editor.xml	oops	2011-02-06 00:39:03 +00:00
reference_exception.xml	fix example	2010-01-29 18:22:35 +00:00
reference_lrs.xml	#824 more corrections from Kashif Rasul	2011-02-10 11:59:20 +00:00
reference_management.xml	Drop dangling reference to Probe_Geometry_Columns (see #1083 )	2011-07-04 15:50:40 +00:00
reference_measure.xml	note about ST_length geography breaking change -- in 1.5 used to return perimeter of a polygon now returns 0 just like geometry	2011-06-23 22:29:56 +00:00
reference_misc.xml	Putting renamed 3D-functions in legacy.sql.c and some clarifying notes about the renaming	2011-03-28 18:46:28 +00:00
reference_operator.xml	#1160 : documentation clarification of behavior	2011-08-16 12:51:30 +00:00
reference_output.xml	change ST_AsX3d from using methodsynopsis back to funcsynopsis. This was an attempt before to stylize default args which didn't work out.	2011-06-26 18:18:23 +00:00
reference_processing.xml	more examples for ST_Offsetcurve	2011-07-26 15:39:31 +00:00
reference_raster.xml	correct some mistatements about export functions	2011-09-06 21:01:35 +00:00
reference_transaction.xml	Fix a lot of DocBook errors. Use DocBook + MathML DTD. Fix xsl/postgis_aggs_mm.xml.xsl to produce valid Docbook. Now make check output in docs is clean. cf #471	2010-03-28 08:33:41 +00:00
reference_type.xml	move raster types to raster section (there are way too many now to try to lump into reference_type and do case statements to exclude from postgis_comments). Revise raster_comments to look for types in reference_raster. Add docu for ST_Reclass and reclassarg type. Need at least one more example to show how to use recalssargs.	2011-06-01 08:17:27 +00:00
release_notes.xml	Update credits and release notes to include change in geometry_columns and management functions, add ST_OffSetCurve to release_notes.xml, add Rafal Magda to people credits list	2011-07-03 05:03:45 +00:00
reporting.xml	documentaiton is in DocBook XML not SGML (well not anymore anyway).	2011-02-10 06:10:57 +00:00
template.xml	revise template to give example of optional argument	2011-07-02 16:29:57 +00:00
using_postgis_app.xml	#609 revise JDBC to use non-deprecated calling syntax	2011-06-13 11:25:09 +00:00
using_postgis_dataman.xml	add pgsql2shp -m switch to dumper help	2011-04-04 15:19:40 +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

====================================================
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