mirror of
https://git.osgeo.org/gitea/postgis/postgis
synced 2024-10-24 00:52:40 +00:00
2091e07d93
The rule pulls all translations, then formats them to avoid style changes. After running the rule you can check what changed using your revision control system tools (git diff here). The commit also updates the only change that was pulled by the rule itself. git-svn-id: http://svn.osgeo.org/postgis/trunk@13084 b70326c6-7e19-0410-871a-916f4a2858ee |
||
|---|---|---|
| .. | ||
| .tx | ||
| html | ||
| man | ||
| po | ||
| rfc | ||
| xsl | ||
| bnf-wkb.txt | ||
| bnf-wkt.txt | ||
| 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 | ||
| Makefile.comments.in | ||
| Makefile.in | ||
| performance_tips.xml | ||
| postgis.xml | ||
| README | ||
| reference.xml | ||
| reference_accessor.xml | ||
| reference_constructor.xml | ||
| reference_editor.xml | ||
| reference_exception.xml | ||
| reference_guc.xml | ||
| reference_lrs.xml | ||
| reference_management.xml | ||
| reference_measure.xml | ||
| reference_misc.xml | ||
| reference_operator.xml | ||
| reference_output.xml | ||
| reference_processing.xml | ||
| reference_raster.xml | ||
| reference_sfcgal.xml | ||
| reference_transaction.xml | ||
| reference_type.xml | ||
| release_notes.xml | ||
| reporting.xml | ||
| template.xml | ||
| using_postgis_app.xml | ||
| using_postgis_dataman.xml | ||
| using_raster_dataman.xml | ||
| xmlformat.conf | ||
| ZMSgeoms.txt | ||
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