From f4eac3d87fd377466cbdcbaf147314485fec517d Mon Sep 17 00:00:00 2001 From: Justin Bronn Date: Fri, 9 Apr 2010 20:51:01 +0000 Subject: [PATCH] Minor documentation tweaks for GeoDjango, including addition of link to main index, and removal of unsupported `:download:` directives. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12942 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/index.txt | 1 + .../gis/create_template_postgis-1.5.sh | 1 + docs/ref/contrib/gis/install.txt | 37 ++++++++++--------- docs/ref/contrib/gis/layermapping.txt | 9 +++-- docs/ref/contrib/gis/tutorial.txt | 2 +- 5 files changed, 28 insertions(+), 22 deletions(-) diff --git a/docs/index.txt b/docs/index.txt index d39dbadd6d..a91c07224e 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -168,6 +168,7 @@ Other batteries included * :ref:`Databrowse ` * :ref:`E-mail (sending) ` * :ref:`Flatpages ` + * :ref:`GeoDjango ` * :ref:`Humanize ` * :ref:`Internationalization ` * :ref:`Jython support ` diff --git a/docs/ref/contrib/gis/create_template_postgis-1.5.sh b/docs/ref/contrib/gis/create_template_postgis-1.5.sh index 88c1e84aaf..081b5f2656 100755 --- a/docs/ref/contrib/gis/create_template_postgis-1.5.sh +++ b/docs/ref/contrib/gis/create_template_postgis-1.5.sh @@ -6,4 +6,5 @@ psql -d postgres -c "UPDATE pg_database SET datistemplate='true' WHERE datname=' psql -d template_postgis -f $POSTGIS_SQL_PATH/postgis.sql # Loading the PostGIS SQL routines psql -d template_postgis -f $POSTGIS_SQL_PATH/spatial_ref_sys.sql psql -d template_postgis -c "GRANT ALL ON geometry_columns TO PUBLIC;" # Enabling users to alter spatial tables. +psql -d template_postgis -c "GRANT ALL ON geography_columns TO PUBLIC;" psql -d template_postgis -c "GRANT ALL ON spatial_ref_sys TO PUBLIC;" diff --git a/docs/ref/contrib/gis/install.txt b/docs/ref/contrib/gis/install.txt index 3f378fe924..55883d8ba5 100644 --- a/docs/ref/contrib/gis/install.txt +++ b/docs/ref/contrib/gis/install.txt @@ -89,7 +89,7 @@ Program Description Required ======================== ==================================== ================================ ========================== :ref:`GEOS ` Geometry Engine Open Source Yes 3.2, 3.1, 3.0 `PROJ.4`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 4.7, 4.6, 4.5, 4.4 -:ref:`GDAL ` Geospatial Data Abstraction Library No (but, required for SQLite) 1.6, 1.5, 1.4 +:ref:`GDAL ` Geospatial Data Abstraction Library No (but, required for SQLite) 1.7, 1.6, 1.5, 1.4 :ref:`GeoIP ` IP-based geolocation library No 1.4 `PostGIS`__ Spatial extensions for PostgreSQL Yes (PostgreSQL only) 1.5, 1.4, 1.3 `SpatiaLite`__ Spatial extensions for SQLite Yes (SQLite only) 2.4, 2.3 @@ -150,13 +150,13 @@ directly from Python using ctypes. First, download GEOS 3.2 from the refractions website and untar the source archive:: - $ wget http://download.osgeo.org/geos/geos-3.2.0.tar.bz2 - $ tar xjf geos-3.2.0.tar.bz2 + $ wget http://download.osgeo.org/geos/geos-3.2.1.tar.bz2 + $ tar xjf geos-3.2.1.tar.bz2 Next, change into the directory where GEOS was unpacked, run the configure script, compile, and install:: - $ cd geos-3.2.0 + $ cd geos-3.2.1 $ ./configure $ make $ sudo make install @@ -465,11 +465,11 @@ pysqlite2 Because SpatiaLite must be loaded as an external extension, it requires the ``enable_load_extension`` method, which is only available in versions 2.5+. -Thus, download pysqlite2 2.5, and untar:: +Thus, download pysqlite2 2.6, and untar:: - $ wget http://pysqlite.googlecode.com/files/pysqlite-2.5.6.tar.gz - $ tar xzf pysqlite-2.5.6.tar.gz - $ cd pysqlite-2.5.6 + $ wget http://pysqlite.googlecode.com/files/pysqlite-2.6.0.tar.gz + $ tar xzf pysqlite-2.6.0.tar.gz + $ cd pysqlite-2.6.0 Next, use a text editor (e.g., ``emacs`` or ``vi``) to edit the ``setup.cfg`` file to look like the following:: @@ -520,7 +520,7 @@ user. For example, you can use the following to become the ``postgres`` user:: versions 1.4 and 1.5 use ``/contrib/postgis-1.4/postgis.sql`` and ``/contrib/postgis-1.5/postgis.sql``, respectively. - The example below assumes 1.5, thus you may need to modify + The example below assumes PostGIS 1.5, thus you may need to modify ``POSTGIS_SQL_PATH`` and the name of the SQL file for the specific version of PostGIS you are using. @@ -540,20 +540,18 @@ modifications to these commands:: $ psql -d template_postgis -f $POSTGIS_SQL_PATH/spatial_ref_sys.sql # Enabling users to alter spatial tables. $ psql -d template_postgis -c "GRANT ALL ON geometry_columns TO PUBLIC;" + $ psql -d template_postgis -c "GRANT ALL ON geography_columns TO PUBLIC;" $ psql -d template_postgis -c "GRANT ALL ON spatial_ref_sys TO PUBLIC;" - - - These commands may be placed in a shell script for later use; for convenience the following scripts are available: =============== ========================================== PostGIS Version Shell Script =============== ========================================== -1.3 :download:`create_template_postgis-1.3.sh` -1.4 :download:`create_template_postgis-1.4.sh` -1.5 :download:`create_template_postgis-1.5.sh` +1.3 `create_template_postgis-1.3.sh`_ +1.4 `create_template_postgis-1.4.sh`_ +1.5 `create_template_postgis-1.5.sh`_ =============== ========================================== Afterwards, you may create a spatial database by simply specifying @@ -569,6 +567,11 @@ Afterwards, you may create a spatial database by simply specifying $ createuser --createdb +.. _create_template_postgis-1.3.sh: http://geodjango.org/docs/create_template_postgis-1.3.sh +.. _create_template_postgis-1.4.sh: http://geodjango.org/docs/create_template_postgis-1.4.sh +.. _create_template_postgis-1.5.sh: http://geodjango.org/docs/create_template_postgis-1.5.sh +.. _create_template_postgis-debian.sh: http://geodjango.org/docs/create_template_postgis-debian.sh + .. _create_spatialite_db: Creating a Spatial Database for SpatiaLite @@ -991,7 +994,7 @@ Optional packages to consider: .. note:: The PostGIS SQL files are not placed the PostgreSQL share directory in the - Ubuntu packages. Use the :download:`create_template_postgis-debian.sh` script + Ubuntu packages. Use the `create_template_postgis-debian.sh`_ script instead when :ref:`spatialdb_template`. .. _debian: @@ -1075,7 +1078,7 @@ Debian 5.0 . Thus when :ref:`spatialdb_template` either: If not running PostgreSQL 8.3, then replace ``8.3`` in the command above with the correct version. -* Or use the :download:`create_template_postgis-debian.sh` to create the spatial database. +* Or use the `create_template_postgis-debian.sh`_ to create the spatial database. .. _windows: diff --git a/docs/ref/contrib/gis/layermapping.txt b/docs/ref/contrib/gis/layermapping.txt index bb5fc3f92e..a423259c11 100644 --- a/docs/ref/contrib/gis/layermapping.txt +++ b/docs/ref/contrib/gis/layermapping.txt @@ -25,9 +25,10 @@ then inserting into a GeoDjango model. GIS data sources, like shapefiles, may be very large. If you find that :class:`LayerMapping` is using too much memory, set - ``DEBUG=False`` in your settings. When ``DEBUG=True`` Django automatically - logs *every* SQL query -- thus, when SQL statements contain geometries, it is - easy to consume more memory than usual. + :setting:`DEBUG` to ``False`` in your settings. When :setting:`DEBUG` + is set to ``True``, Django :ref:`automatically logs ` + *every* SQL query -- thus, when SQL statements contain geometries, it is + easy to consume more memory than is typical. Example ======= @@ -80,7 +81,7 @@ Here, :class:`LayerMapping` just transformed the three geometries from the shapefile in their original spatial reference system (WGS84) to the spatial reference system of the GeoDjango model (NAD83). If no spatial reference system is defined for the layer, use the ``source_srs`` keyword with a -:class:`django.contrib.gis.gdal.SpatialReference` object to specify one. +:class:`~django.contrib.gis.gdal.SpatialReference` object to specify one. ``LayerMapping`` API ==================== diff --git a/docs/ref/contrib/gis/tutorial.txt b/docs/ref/contrib/gis/tutorial.txt index fcf3e77d93..08cf627233 100644 --- a/docs/ref/contrib/gis/tutorial.txt +++ b/docs/ref/contrib/gis/tutorial.txt @@ -313,7 +313,7 @@ may also use the following to populate your spatial database: * `shp2pgsql`_: This utility is included with PostGIS and only supports ESRI shapefiles. -.. _ogr2ogr: http://www.gdal.org/ogr/ogr2ogr.html +.. _ogr2ogr: http://www.gdal.org/ogr2ogr.html .. _shp2pgsql: http://postgis.refractions.net/documentation/manual-1.5/ch04.html#shp2pgsql_usage .. _gdalinterface: