forked from postgis/postgis
michal
6e31f63111
|
||
|---|---|---|
| .. | ||
| .tx | ||
| html | ||
| man | ||
| po | ||
| rfc | ||
| xsl | ||
| Makefile.comments.in | ||
| Makefile.in | ||
| README | ||
| ZMSgeoms.txt | ||
| administration.xml | ||
| bnf-wkb.txt | ||
| bnf-wkt.txt | ||
| database_tuning.xml | ||
| doxygen.cfg.in | ||
| extras.xml | ||
| extras_address_standardizer.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_bbox.xml | ||
| reference_cluster.xml | ||
| reference_constructor.xml | ||
| reference_editor.xml | ||
| reference_exception.xml | ||
| reference_guc.xml | ||
| reference_input.xml | ||
| reference_lrs.xml | ||
| reference_management.xml | ||
| reference_measure.xml | ||
| reference_misc.xml | ||
| reference_operator.xml | ||
| reference_output.xml | ||
| reference_overlay.xml | ||
| reference_processing.xml | ||
| reference_raster.xml | ||
| reference_relationship.xml | ||
| reference_sfcgal.xml | ||
| reference_srs.xml | ||
| reference_trajectory.xml | ||
| reference_transaction.xml | ||
| reference_transformation.xml | ||
| reference_troubleshooting.xml | ||
| reference_type.xml | ||
| reference_validation.xml | ||
| reference_version.xml | ||
| release_notes.xml | ||
| reporting.xml | ||
| template.xml | ||
| texstyle.sty | ||
| using_postgis_app.xml | ||
| using_postgis_dataman.xml | ||
| using_postgis_query.xml | ||
| using_raster_dataman.xml | ||
| xmlformat.conf | ||
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