From 799fa47aba8d7eaf7ca852eb2c9f3f16c47d5aba Mon Sep 17 00:00:00 2001 From: Olivier Courtin Date: Sun, 28 Mar 2010 08:33:41 +0000 Subject: [PATCH] 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 git-svn-id: http://svn.osgeo.org/postgis/trunk@5466 b70326c6-7e19-0410-871a-916f4a2858ee --- doc/installation.xml | 8 ++++---- doc/postgis.xml | 4 ++-- doc/reference_accessor.xml | 4 ++-- doc/reference_editor.xml | 2 +- doc/reference_measure.xml | 2 +- doc/reference_misc.xml | 2 +- doc/reference_operator.xml | 5 +++-- doc/reference_output.xml | 12 ++++++------ doc/reference_processing.xml | 8 ++++---- doc/reference_transaction.xml | 2 ++ doc/reference_type.xml | 5 +++-- doc/using_postgis_dataman.xml | 10 +++++----- doc/xsl/postgis_aggs_mm.xml.xsl | 30 +++++++++++++++--------------- 13 files changed, 49 insertions(+), 45 deletions(-) diff --git a/doc/installation.xml b/doc/installation.xml index 963b6d4d0..876ae9a54 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -276,7 +276,7 @@ tar -xvzf postgis-&last_release_version;.tar.gz - --prefix=PREFIX + --prefix=PREFIX This is the location the PostGIS libraries and SQL scripts will be @@ -298,7 +298,7 @@ tar -xvzf postgis-&last_release_version;.tar.gz - --with-pgconfig=FILE + --with-pgconfig=FILE PostgreSQL provides a utility called pg_config @@ -312,7 +312,7 @@ tar -xvzf postgis-&last_release_version;.tar.gz - --with-geosconfig=FILE + --with-geosconfig=FILE GEOS, a required geometry library, provides a utility called @@ -326,7 +326,7 @@ tar -xvzf postgis-&last_release_version;.tar.gz - --with-projdir=DIR + --with-projdir=DIR Proj4 is a reprojection library required by PostGIS. Use this diff --git a/doc/postgis.xml b/doc/postgis.xml index 32e7bc0c7..522b1fbbe 100644 --- a/doc/postgis.xml +++ b/doc/postgis.xml @@ -1,6 +1,6 @@ - diff --git a/doc/reference_accessor.xml b/doc/reference_accessor.xml index b1cbffd4f..ee141960d 100644 --- a/doc/reference_accessor.xml +++ b/doc/reference_accessor.xml @@ -134,7 +134,7 @@ MULTIPOINT(-1 1 1,1 1 0.75) ST_CoordDim - Return the coordinate dimension of the ST_Geometry value. + Return the coordinate dimension of the ST_Geometry value. @@ -1579,7 +1579,7 @@ POINT(3 2) Description - Returns the spatial reference identifier for the ST_Geometry as defined in spatial_ref_sys table. + Returns the spatial reference identifier for the ST_Geometry as defined in spatial_ref_sys table. spatial_ref_sys table is a table that catalogs all spatial reference systems known to PostGIS and is used for transformations from one spatial reference system to another. So verifying you have the right spatial reference system identifier is important if you plan to ever transform your geometries. diff --git a/doc/reference_editor.xml b/doc/reference_editor.xml index d6596980f..6772ec2b0 100644 --- a/doc/reference_editor.xml +++ b/doc/reference_editor.xml @@ -94,7 +94,7 @@ float a float b float d - float e> + float e float xoff float yoff diff --git a/doc/reference_measure.xml b/doc/reference_measure.xml index 7cef4b9fb..7218071f6 100644 --- a/doc/reference_measure.xml +++ b/doc/reference_measure.xml @@ -1499,7 +1499,7 @@ postgis=# SELECT ST_MaxDistance('POINT(0 0)'::geometry, 'LINESTRING ( 2 2, 2 2 ) Returns minimum distance in meters between two lon/lat geometries. Uses a spherical earth and radius of 6370986 meters. - Faster than ST_Distance_Spheroid, but less + Faster than ST_Distance_Spheroid , but less accurate. PostGIS versions prior to 1.5 only implemented for points. diff --git a/doc/reference_misc.xml b/doc/reference_misc.xml index 13b62bd70..e760fcd1d 100644 --- a/doc/reference_misc.xml +++ b/doc/reference_misc.xml @@ -594,7 +594,7 @@ fulltable_size geomsize pergeom point_inside_circle(<geometry>,<circle_center_x>,<circle_center_y>,<radius>). Returns the true if the geometry is a point and is inside the circle. Returns false otherwise. - This only works for points as the name suggests + This only works for points as the name suggests diff --git a/doc/reference_operator.xml b/doc/reference_operator.xml index 47bc63f61..20fd93bb2 100644 --- a/doc/reference_operator.xml +++ b/doc/reference_operator.xml @@ -945,8 +945,7 @@ FROM geometries. Availability: 1.5.0 changed behavior - - + This operator has changed behavior in PostGIS 1.5 from testing for actual geometric equality to only @@ -958,6 +957,8 @@ FROM linkend="ST_Equals" /> and to check for bounding box equality ; operator is a safer option. + + Examples diff --git a/doc/reference_output.xml b/doc/reference_output.xml index 0c710ad59..3475feb56 100644 --- a/doc/reference_output.xml +++ b/doc/reference_output.xml @@ -904,42 +904,42 @@ F000000000000000000000000000000000000000000000000'); Examples -Default format. +Default format. SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)')); st_aslatlontext ---------------------------- 2°19'29.928"S 3°14'3.243"W -Providing a format (same as the default). +Providing a format (same as the default). SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D°M''S.SSS"C')); st_aslatlontext ---------------------------- 2°19'29.928"S 3°14'3.243"W -Characters other than D, M, S, C and . are just passed through. +Characters other than D, M, S, C and . are just passed through. SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D degrees, M minutes, S seconds to the C')); st_aslatlontext -------------------------------------------------------------------------------------- 2 degrees, 19 minutes, 30 seconds to the S 3 degrees, 14 minutes, 3 seconds to the W -Signed degrees instead of cardinal directions. +Signed degrees instead of cardinal directions. SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D°M''S.SSS"')); st_aslatlontext ---------------------------- -2°19'29.928" -3°14'3.243" -Decimal degrees. +Decimal degrees. SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D.DDDD degrees C')); st_aslatlontext ----------------------------------- 2.3250 degrees S 3.2342 degrees W -Excessively large values are normalized. +Excessively large values are normalized. SELECT (ST_AsLatLonText('POINT (-302.2342342 -792.32498)')); st_aslatlontext diff --git a/doc/reference_processing.xml b/doc/reference_processing.xml index e1d735904..71a1dd49e 100644 --- a/doc/reference_processing.xml +++ b/doc/reference_processing.xml @@ -62,16 +62,16 @@ The optional third parameter (currently only applies to geometry) can either specify number of segments used to approximate a quarter circle (integer case, defaults to 8) or a list of blank-separated key=value pairs (string case) to tweak operations as follows: -'quad_segs=#' : number of segments used to approximate a quarter circle (defaults to 8). +'quad_segs=#' : number of segments used to approximate a quarter circle (defaults to 8). -'endcap=round|flat|square' : endcap style (defaults to "round", needs GEOS-3.2 or higher for a different value). 'butt' is also accepted as a synonym for 'flat'. +'endcap=round|flat|square' : endcap style (defaults to "round", needs GEOS-3.2 or higher for a different value). 'butt' is also accepted as a synonym for 'flat'. -'join=round|mitre|bevel' : join style (defaults to "round", needs GEOS-3.2 or higher for a different value). 'miter' is also accepted as a synonym for 'mitre'. +'join=round|mitre|bevel' : join style (defaults to "round", needs GEOS-3.2 or higher for a different value). 'miter' is also accepted as a synonym for 'mitre'. -'mitre_limit=#.#' : mitre ratio limit (only affects mitred join style). 'miter_limit' is also accepted as a synonym for 'mitre_limit'. +'mitre_limit=#.#' : mitre ratio limit (only affects mitred join style). 'miter_limit' is also accepted as a synonym for 'mitre_limit'. diff --git a/doc/reference_transaction.xml b/doc/reference_transaction.xml index c35313ace..306db3b06 100644 --- a/doc/reference_transaction.xml +++ b/doc/reference_transaction.xml @@ -136,6 +136,7 @@ text DisableLongTransactions + @@ -185,6 +186,7 @@ Long transactions support disabled text EnableLongTransactions + diff --git a/doc/reference_type.xml b/doc/reference_type.xml index 387318cbb..35b2c4d1e 100644 --- a/doc/reference_type.xml +++ b/doc/reference_type.xml @@ -1,6 +1,5 @@ - PostgreSQL PostGIS Types This section lists the PostgreSQL data types installed by PostGIS. Note we describe the casting behavior of these which is very @@ -15,9 +14,11 @@ but no geometry. What happens is that both functions are equally good to use with geometry since geometry has an autocast for both -- so you end up with an ambiguous function error. To force PostgreSQL to choose, you do a CAST(mygeom As box3d) or mygeom::box3d. - At least as of PostgreSQL 8.3 - Everything can be CAST to text (presumably because of the magical unknown type), so no defined CASTS for that need to be present for you to CAST an object to text. + At least as of PostgreSQL 8.3 - Everything can be CAST to text (presumably because of the magical unknown type), so no defined CASTS for that need to be present for you to CAST an object to text. + PostgreSQL PostGIS Types + box2d diff --git a/doc/using_postgis_dataman.xml b/doc/using_postgis_dataman.xml index d3aad3fea..d94901328 100644 --- a/doc/using_postgis_dataman.xml +++ b/doc/using_postgis_dataman.xml @@ -365,11 +365,11 @@ The GEOMETRY type calculates a meaningless cartesian distance between Reykjavik The new GEOGRAPHY type allows you to store data in longitude/latitude coordinates, but at a cost: there are fewer functions defined on GEOGRAPHY than there are on GEOMETRY; those functions that are defined take more CPU time to execute. The type you choose should be conditioned on the expected working area of the application you are building. Will your data span the globe or a large continental area, or is it local to a state, county or municipality? - If your data is contained in a small area, you might find that choosing an appropriate projection and using GEOMETRY is the best solution, in terms of performance and functionality available. - If your data is global or covers a continental region, you may find that GEOGRAPHY allows you to build a system without having to worry about projection details. - You store your data in longitude/latitude, and use the functions that have been defined on GEOGRAPHY. - If you don't understand projections, and you don't want to learn about them, and you're prepared to accept the limitations in functionality available in GEOGRAPHY, then it might be easier for you to use GEOGRAPHY than GEOMETRY. - Simply load your data up as longitude/latitude and go from there. + If your data is contained in a small area, you might find that choosing an appropriate projection and using GEOMETRY is the best solution, in terms of performance and functionality available. + If your data is global or covers a continental region, you may find that GEOGRAPHY allows you to build a system without having to worry about projection details. + You store your data in longitude/latitude, and use the functions that have been defined on GEOGRAPHY. + If you don't understand projections, and you don't want to learn about them, and you're prepared to accept the limitations in functionality available in GEOGRAPHY, then it might be easier for you to use GEOGRAPHY than GEOMETRY. + Simply load your data up as longitude/latitude and go from there. Refer to for compare between what is supported for Geography vs. Geometry. For a brief listing and description of Geography functions, refer to diff --git a/doc/xsl/postgis_aggs_mm.xml.xsl b/doc/xsl/postgis_aggs_mm.xml.xsl index 9efe0f809..6f75cc895 100644 --- a/doc/xsl/postgis_aggs_mm.xml.xsl +++ b/doc/xsl/postgis_aggs_mm.xml.xsl @@ -36,7 +36,7 @@ - - + - @@ -67,7 +67,7 @@ - - + - @@ -98,7 +98,7 @@ - - + - @@ -125,7 +125,7 @@ - - + - @@ -153,7 +153,7 @@ - - + - @@ -179,7 +179,7 @@ - - + - @@ -210,7 +210,7 @@ - - + - @@ -228,10 +228,10 @@ Below is an alphabetical listing of spatial specific functions in PostGIS and the kinds of spatial types they work with or OGC/SQL compliance they try to conform to. - A means the function works with the type or subtype natively. - A means it works but with a transform cast built-in using cast to geometry, transform to a "best srid" spatial ref and then cast back. Results may not be as expected for large areas or areas at poles - and may accumulate floating point junk. - A means the function works with the type because of a auto-cast to another such as to box3d rather than direct type support. + A means the function works with the type or subtype natively. + A means it works but with a transform cast built-in using cast to geometry, transform to a "best srid" spatial ref and then cast back. Results may not be as expected for large areas or areas at poles + and may accumulate floating point junk. + A means the function works with the type because of a auto-cast to another such as to box3d rather than direct type support. @@ -370,7 +370,7 @@ - - + - @@ -402,7 +402,7 @@ - - + - @@ -429,7 +429,7 @@ - - + - @@ -456,7 +456,7 @@ - - + - -- 2.40.0