[prev in list] [next in list] [prev in thread] [next in thread]
List: mysql-internals
Subject: bk commit - mysqldoc@docsrva tree (jon:1.3652)
From: jon () mysql ! com
Date: 2005-09-30 15:44:28
Message-ID: 20050930154428.DF036BAC7F () gigan ! site
[Download RAW message or body]
Below is the list of changes that have just been committed into a local
mysqldoc repository of jon. When jon does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html
ChangeSet
1.3652 05/10/01 01:44:25 jon@gigan.homedns.org +4 -0
Spatial Extensions:
- Add link to GIS forums (Edwin).
- Clean up diffs.
refman/spatial-extensions-in-mysql.xml
1.13 05/10/01 01:44:14 jon@gigan.homedns.org +793 -377
Add link to GIS forums.
Clean up diffs.
refman-5.1/spatial-extensions-in-mysql.xml
1.10 05/10/01 01:44:14 jon@gigan.homedns.org +25 -32
Add link to GIS forums.
Clean up diffs.
refman-5.0/spatial-extensions-in-mysql.xml
1.9 05/10/01 01:44:14 jon@gigan.homedns.org +25 -32
Add link to GIS forums.
Clean up diffs.
refman-4.1/spatial-extensions-in-mysql.xml
1.13 05/10/01 01:44:14 jon@gigan.homedns.org +9 -4
Add link to GIS forums.
# This is a BitKeeper patch. What follows are the unified diffs for the
# set of deltas contained in the patch. The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User: jon
# Host: gigan.
# Root: /home/jon/bk/mysqldoc2
--- 1.9/refman-5.1/spatial-extensions-in-mysql.xml 2005-09-07 07:15:55 +10:00
+++ 1.10/refman-5.1/spatial-extensions-in-mysql.xml 2005-10-01 01:44:14 +10:00
@@ -22,9 +22,10 @@
</remark>
<para>
- MySQL 4.1 introduces spatial extensions to allow the generation,
- storage, and analysis of geographic features. Currently, these
- features are available for <literal>MyISAM</literal> tables only.
+ MySQL supports spatial extensions to allow the generation, storage,
+ and analysis of geographic features. In MySQL ¤t-series;
+ these features are available for <literal>MyISAM</literal> tables
+ only.
</para>
<para>
@@ -65,6 +66,13 @@
</listitem>
</itemizedlist>
+
+ <para>
+ If you have questions or concerns about about the use of the spatial
+ extensions to MySQL, you can discuss these in the <ulink
+ url="http://forums.mysql.com/list.php?23">GIS forums</ulink> on
+ our website.
+ </para>
<section id="gis-introduction">
@@ -3397,15 +3405,15 @@
<title id="title-point-property-functions">&title-point-property-functions;</title>
+ <remark>
+ help_category Point properties@Geographic features
+ </remark>
+
<para>
A <literal>Point</literal> consists of X and Y coordinates,
which may be obtained using the following functions:
</para>
- <remark>
- help_category Point properties@Geographic features
- </remark>
-
<itemizedlist>
<listitem>
@@ -3812,11 +3820,11 @@
<itemizedlist>
- <remark>
- description_for_help_topic Area
- </remark>
-
<listitem>
+ <remark>
+ description_for_help_topic Area
+ </remark>
+
<para>
<indexterm type="function">
<primary>Area()</primary>
@@ -4057,11 +4065,6 @@
</itemizedlist>
- <remark>
- help_category GeometryCollection properties@Geographic
- features
- </remark>
-
</section>
<section id="geometrycollection-property-functions">
@@ -4072,6 +4075,11 @@
Add introductory descriptive sentence.
</remark>
+ <remark>
+ help_category GeometryCollection properties@Geographic
+ features
+ </remark>
+
<itemizedlist>
<listitem>
@@ -5270,26 +5278,11 @@
</para>
</listitem>
- </itemizedlist>
-
- <remark>
+ </itemizedlist><remark>
@node GIS writing a GIS application
- </remark>
-
- <remark>
@section Writing a GIS Application
- </remark>
-
- <remark>
@node GIS Java GIS Object Model
- </remark>
-
- <remark>
@section Java GIS Object Model
- </remark>
-
- <remark>
- for Mark!
</remark>
</section>
--- 1.12/refman-4.1/spatial-extensions-in-mysql.xml 2005-09-07 07:15:48 +10:00
+++ 1.13/refman-4.1/spatial-extensions-in-mysql.xml 2005-10-01 01:44:14 +10:00
@@ -65,6 +65,13 @@
</listitem>
</itemizedlist>
+
+ <para>
+ If you have questions or concerns about about the use of the spatial
+ extensions to MySQL, you can discuss these in the <ulink
+ url="http://forums.mysql.com/list.php?23">GIS forums</ulink> on
+ our website.
+ </para>
<section id="gis-introduction">
@@ -5270,14 +5277,12 @@
</para>
</listitem>
- </itemizedlist>
-
-<!--
+ </itemizedlist><remark>
@node GIS writing a GIS application
@section Writing a GIS Application
@node GIS Java GIS Object Model
@section Java GIS Object Model
--->
+ </remark>
</section>
--- 1.12/refman/spatial-extensions-in-mysql.xml 2005-09-11 09:54:07 +10:00
+++ 1.13/refman/spatial-extensions-in-mysql.xml 2005-10-01 01:44:14 +10:00
@@ -15,12 +15,15 @@
<primary>GIS</primary>
</indexterm>
-<!-- help_category Geographic features -->
+ <remark>
+ help_category Geographic features
+ </remark>
<para>
- MySQL 4.1 introduces spatial extensions to allow the generation,
- storage, and analysis of geographic features. Currently, these
- features are available for <literal>MyISAM</literal> tables only.
+ MySQL supports spatial extensions to allow the generation, storage,
+ and analysis of geographic features. Currently,
+ these features are available for <literal>MyISAM</literal> tables
+ only.
</para>
<para>
@@ -61,6 +64,13 @@
</listitem>
</itemizedlist>
+
+ <para>
+ If you have questions or concerns about about the use of the spatial
+ extensions to MySQL, you can discuss these in the <ulink
+ url="http://forums.mysql.com/list.php?23">GIS forums</ulink> on
+ our website.
+ </para>
<section id="gis-introduction">
@@ -341,9 +351,13 @@
instances).
</para>
-<!-- help_category Geographic features -->
-
-<!-- description_for_help_topic Geometry hierarchy -->
+ <remark>
+ help_category Geographic features
+ </remark>
+
+ <remark>
+ description_for_help_topic Geometry hierarchy
+ </remark>
<para>
<literal>Geometry</literal> is the base class. It's an abstract
@@ -424,7 +438,9 @@
<literal>MultiPolygon</literal> are instantiable classes.
</para>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
</section>
@@ -501,9 +517,13 @@
<emphasis role="bold">exterior</emphasis>.
</para>
-<!-- help_category MBR@Geographic features -->
-
-<!-- description_for_help_topic MBR definition -->
+ <remark>
+ help_category MBR@Geographic features
+ </remark>
+
+ <remark>
+ description_for_help_topic MBR definition
+ </remark>
<para>
Every geometry occupies some position in space. The exterior
@@ -521,9 +541,13 @@
formed by the minimum and maximum (X,Y) coordinates:
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic MBR definition -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic MBR definition
+ </remark>
<programlisting>
((MINX MINY, MAXX MINY, MAXX MAXY, MINX MAXY, MINX MINY))
@@ -822,7 +846,9 @@
<title id="title-gis-class-surface">&title-gis-class-surface;</title>
-<!-- TODO: need examples -->
+ <remark role="todo">
+ need examples
+ </remark>
<para>
A <literal>Surface</literal> is a two-dimensional geometry. It
@@ -830,13 +856,24 @@
<literal>Polygon</literal>.
</para>
-<!-- Simple surfaces in three-dimensional space are isomorphic to planar surfaces. \
-->
-
-<!-- Polyhedral surfaces are formed by 'stitching' together simple surfaces along \
-->
-
-<!-- their boundaries, polyhedral surfaces in three-dimensional space may not be \
-->
-
-<!-- planar as a whole. -->
+ <remark>
+ Simple surfaces in three-dimensional space are isomorphic to
+ planar surfaces.
+ </remark>
+
+ <remark>
+ Polyhedral surfaces are formed by 'stitching' together simple
+ surfaces along
+ </remark>
+
+ <remark>
+ their boundaries, polyhedral surfaces in three-dimensional space
+ may not be
+ </remark>
+
+ <remark>
+ planar as a whole.
+ </remark>
<para>
<emphasis role="bold"><literal>Surface</literal>
@@ -956,9 +993,15 @@
simple geometry.
</para>
-<!-- Interior, Closure and Exterior have the standard topological definitions. -->
-
-<!-- The combination of 1 and 3 make a Polygon a Regular Closed point set. -->
+ <remark>
+ Interior, Closure and Exterior have the standard topological
+ definitions.
+ </remark>
+
+ <remark>
+ The combination of 1 and 3 make a Polygon a Regular Closed point
+ set.
+ </remark>
</section>
@@ -1357,20 +1400,30 @@
<primary>Well-Known Text format</primary>
</indexterm>
-<!-- help_category WKT@Geographic features -->
-
-<!-- description_for_help_topic WKT definition -->
+ <remark>
+ help_category WKT@Geographic features
+ </remark>
+
+ <remark>
+ description_for_help_topic WKT definition
+ </remark>
<para>
The Well-Known Text (WKT) representation of Geometry is designed
to exchange geometry data in ASCII form.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- TODO: should explain the notation better, for example, to note the -->
-
-<!-- absence of comma between X and Y coordinates. -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark role="todo">
+ should explain the notation better, for example, to note the
+ </remark>
+
+ <remark>
+ absence of comma between X and Y coordinates.
+ </remark>
<para>
Examples of WKT representations of geometry objects are:
@@ -1430,7 +1483,9 @@
</listitem>
<listitem>
-<!-- TODO: change this example -->
+ <remark role="todo">
+ change this example
+ </remark>
<para>
A <literal>MultiLineString</literal> with two
@@ -1443,7 +1498,9 @@
</listitem>
<listitem>
-<!-- TODO: change this example -->
+ <remark role="todo">
+ change this example
+ </remark>
<para>
A <literal>MultiPolygon</literal> with two
@@ -1456,7 +1513,9 @@
</listitem>
<listitem>
-<!-- TODO: change this example -->
+ <remark role="todo">
+ change this example
+ </remark>
<para>
A <literal>GeometryCollection</literal> consisting of two
@@ -1581,13 +1640,21 @@
<title id="title-creating-a-spatially-enabled-mysql-database">&title-creating-a-spatially-enabled-mysql-database;</title>
-<!-- TODO: It would be useful to have a simple example here of table creation -->
-
-<!-- and row insertion, to give the reader a taste of what is to come -->
-
-<!-- TODO: This section has examples of use, but it also contains function -->
-
-<!-- descriptions that may be better placed in an API section. -->
+ <remark role="todo">
+ It would be useful to have a simple example here of table creation
+ </remark>
+
+ <remark>
+ and row insertion, to give the reader a taste of what is to come
+ </remark>
+
+ <remark role="todo">
+ This section has examples of use, but it also contains function
+ </remark>
+
+ <remark>
+ descriptions that may be better placed in an API section.
+ </remark>
<para>
This section describes the data types you can use for representing
@@ -1783,13 +1850,18 @@
of geometry values of each geometry type.
</para>
-<!-- help_category WKT@Geographic features -->
+ <remark>
+ help_category WKT@Geographic features
+ </remark>
<itemizedlist>
-<!-- description_for_help_topic GeomCollFromText GEOMETRYCOLLECTIONFROMTEXT -->
-
<listitem>
+ <remark>
+ description_for_help_topic GeomCollFromText
+ GEOMETRYCOLLECTIONFROMTEXT
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeomCollFromText()</primary>
@@ -1808,13 +1880,17 @@
Constructs a <literal>GEOMETRYCOLLECTION</literal> value
using its WKT representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic GeomFromText GeometryFromText -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic GeomFromText GeometryFromText
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeomFromText()</primary>
@@ -1833,13 +1909,18 @@
Constructs a geometry value of any type using its WKT
representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic LineFromText LineStringFromText. -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic LineFromText
+ LineStringFromText.
+ </remark>
+
<para>
<indexterm type="function">
<primary>LineFromText()</primary>
@@ -1858,13 +1939,18 @@
Constructs a <literal>LINESTRING</literal> value using its
WKT representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MLineFromText MultiLineStringFromText -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MLineFromText
+ MultiLineStringFromText
+ </remark>
+
<para>
<indexterm type="function">
<primary>MLineFromText()</primary>
@@ -1883,13 +1969,18 @@
Constructs a <literal>MULTILINESTRING</literal> value
using its WKT representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MPointFromText MultiPointFromText -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MPointFromText
+ MultiPointFromText
+ </remark>
+
<para>
<indexterm type="function">
<primary>MPointFromText()</primary>
@@ -1908,13 +1999,18 @@
Constructs a <literal>MULTIPOINT</literal> value using its
WKT representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MPolyFromText MultiPolygonFromText -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MPolyFromText
+ MultiPolygonFromText
+ </remark>
+
<para>
<indexterm type="function">
<primary>MPolyFromText()</primary>
@@ -1933,13 +2029,17 @@
Constructs a <literal>MULTIPOLYGON</literal> value using
its WKT representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic PointFromText -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic PointFromText
+ </remark>
+
<para>
<indexterm type="function">
<primary>PointFromText()</primary>
@@ -1952,13 +2052,17 @@
Constructs a <literal>POINT</literal> value using its WKT
representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic PolyFromText PolygonFromText -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic PolyFromText PolygonFromText
+ </remark>
+
<para>
<indexterm type="function">
<primary>PolyFromText()</primary>
@@ -1977,9 +2081,11 @@
Constructs a <literal>POLYGON</literal> value using its
WKT representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
</itemizedlist>
@@ -2051,13 +2157,18 @@
geometry values of each geometry type.
</para>
-<!-- help_category WKB@Geographic features -->
+ <remark>
+ help_category WKB@Geographic features
+ </remark>
<itemizedlist>
-<!-- description_for_help_topic GeomCollFromWKB GeometryCollectionFromWKB -->
-
<listitem>
+ <remark>
+ description_for_help_topic GeomCollFromWKB
+ GeometryCollectionFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeomCollFromWKB()</primary>
@@ -2076,13 +2187,17 @@
Constructs a <literal>GEOMETRYCOLLECTION</literal> value
using its WKB representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic GeomFromWKB GeometryFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic GeomFromWKB GeometryFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeomFromWKB()</primary>
@@ -2101,13 +2216,17 @@
Constructs a geometry value of any type using its WKB
representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic LineFromWKB LineStringFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic LineFromWKB LineStringFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>LineFromWKB()</primary>
@@ -2126,13 +2245,18 @@
Constructs a <literal>LINESTRING</literal> value using its
WKB representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic MLineFromWKB MultiLineStringFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MLineFromWKB
+ MultiLineStringFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>MLineFromWKB()</primary>
@@ -2151,13 +2275,17 @@
Constructs a <literal>MULTILINESTRING</literal> value
using its WKB representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic MPointFromWKB MultiPointFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MPointFromWKB MultiPointFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>MPointFromWKB()</primary>
@@ -2176,13 +2304,18 @@
Constructs a <literal>MULTIPOINT</literal> value using its
WKB representation and SRID.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic MPolyFromWKB MultiPolygonFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MPolyFromWKB
+ MultiPolygonFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>MPolyFromWKB()</primary>
@@ -2201,13 +2334,17 @@
Constructs a <literal>MULTIPOLYGON</literal> value using
its WKB representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic PointFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic PointFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>PointFromWKB()</primary>
@@ -2220,13 +2357,17 @@
Constructs a <literal>POINT</literal> value using its WKB
representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic PolyFromWKB PolygonFromWKB -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic PolyFromWKB PolygonFromWKB
+ </remark>
+
<para>
<indexterm type="function">
<primary>PolyFromWKB()</primary>
@@ -2245,9 +2386,11 @@
Constructs a <literal>POLYGON</literal> value using its
WKB representation and SRID.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
</itemizedlist>
@@ -2320,13 +2463,17 @@
<literal>GeomFromWKB()</literal> function family.
</para>
- <itemizedlist>
-
-<!-- help_category Geometry constructors@Geographic features -->
+ <remark>
+ help_category Geometry constructors@Geographic features
+ </remark>
-<!-- description_for_help_topic GEOMETRYCOLLECTION -->
+ <itemizedlist>
<listitem>
+ <remark>
+ description_for_help_topic GEOMETRYCOLLECTION
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeometryCollection()</primary>
@@ -2340,13 +2487,17 @@
any argument is not a well-formed WKB representation of a
geometry, the return value is <literal>NULL</literal>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic LINESTRING -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic LINESTRING
+ </remark>
+
<para>
<indexterm type="function">
<primary>LineString()</primary>
@@ -2363,13 +2514,17 @@
<literal>Point</literal> arguments is less than two, the
return value is <literal>NULL</literal>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MULTILINESTRING -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MULTILINESTRING
+ </remark>
+
<para>
<indexterm type="function">
<primary>MultiLineString()</primary>
@@ -2384,13 +2539,17 @@
argument is not a WKB <literal>LineString</literal>, the
return value is <literal>NULL</literal>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MULTIPOINT -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MULTIPOINT
+ </remark>
+
<para>
<indexterm type="function">
<primary>MultiPoint()</primary>
@@ -2405,13 +2564,17 @@
not a WKB <literal>Point</literal>, the return value is
<literal>NULL</literal>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MULTIPOLYGON -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MULTIPOLYGON
+ </remark>
+
<para>
<indexterm type="function">
<primary>MultiPolygon()</primary>
@@ -2426,13 +2589,17 @@
any argument is not a WKB <literal>Polygon</literal>, the
return value is <literal>NULL</literal>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic POINT -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic POINT
+ </remark>
+
<para>
<indexterm type="function">
<primary>Point()</primary>
@@ -2445,13 +2612,17 @@
Constructs a WKB <literal>Point</literal> using its
coordinates.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic POLYGON -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic POLYGON
+ </remark>
+
<para>
<indexterm type="function">
<primary>Polygon()</primary>
@@ -2468,9 +2639,11 @@
simple <literal>LineString</literal>) the return value is
<literal>NULL</literal>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
</itemizedlist>
@@ -2482,9 +2655,13 @@
<title id="title-creating-spatial-columns">&title-creating-spatial-columns;</title>
-<!-- help_category Geographic features -->
-
-<!-- description_for_help_topic GEOMETRY -->
+ <remark>
+ help_category Geographic features
+ </remark>
+
+ <remark>
+ description_for_help_topic GEOMETRY
+ </remark>
<para>
MySQL provides a standard way of creating spatial columns for
@@ -2494,7 +2671,9 @@
tables.
</para>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
<itemizedlist>
@@ -2504,7 +2683,9 @@
a table with a spatial column:
</para>
-<!-- example_for_help_topic GEOMETRY -->
+ <remark>
+ example_for_help_topic GEOMETRY
+ </remark>
<programlisting>
mysql> <userinput>CREATE TABLE geom (g GEOMETRY);</userinput>
@@ -2694,9 +2875,13 @@
from internal format into a WKT string.
</para>
-<!-- help_category WKT@Geographic features -->
-
-<!-- example_for_help_topic AsText -->
+ <remark>
+ help_category WKT@Geographic features
+ </remark>
+
+ <remark>
+ example_for_help_topic AsText
+ </remark>
<programlisting>
mysql> <userinput>SELECT AsText(g) FROM geom;</userinput>
@@ -2720,9 +2905,13 @@
the WKB value.
</para>
-<!-- help_category WKB@Geographic features -->
-
-<!-- example_for_help_topic AsBinary -->
+ <remark>
+ help_category WKB@Geographic features
+ </remark>
+
+ <remark>
+ example_for_help_topic AsBinary
+ </remark>
<programlisting>
SELECT AsBinary(g) FROM geom;
@@ -2806,13 +2995,17 @@
values between internal format and either WKT or WKB format:
</para>
- <itemizedlist>
-
-<!-- help_category WKB@Geographic features -->
+ <remark>
+ help_category WKB@Geographic features
+ </remark>
-<!-- description_for_help_topic AsBinary -->
+ <itemizedlist>
<listitem>
+ <remark>
+ description_for_help_topic AsBinary
+ </remark>
+
<para>
<indexterm type="function">
<primary>AsBinary()</primary>
@@ -2825,15 +3018,21 @@
Converts a value in internal geometry format to its WKB
representation and returns the binary result.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
-<!-- help_category WKT@Geographic features -->
+ <listitem>
+ <remark>
+ help_category WKT@Geographic features
+ </remark>
-<!-- description_for_help_topic AsText -->
+ <remark>
+ description_for_help_topic AsText
+ </remark>
- <listitem>
<para>
<indexterm type="function">
<primary>AsText()</primary>
@@ -2847,7 +3046,9 @@
representation and returns the string result.
</para>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
<programlisting>
mysql> <userinput>SET @g = 'LineString(1 1,2 2,3 3)';</userinput>
@@ -2926,13 +3127,17 @@
argument and accept a geometry value of any type.
</para>
- <itemizedlist>
-
-<!-- help_category Geometry properties@Geographic features -->
+ <remark>
+ help_category Geometry properties@Geographic features
+ </remark>
-<!-- description_for_help_topic Dimension -->
+ <itemizedlist>
<listitem>
+ <remark>
+ description_for_help_topic Dimension
+ </remark>
+
<para>
<indexterm type="function">
<primary>Dimension()</primary>
@@ -2948,9 +3153,13 @@
<xref linkend="gis-class-geometry"/>.)
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic Dimension -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic Dimension
+ </remark>
<programlisting>
mysql> <userinput>SELECT Dimension(GeomFromText('LineString(1 1,2 \
2)'));</userinput> @@ -2962,9 +3171,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic Envelope -->
-
<listitem>
+ <remark>
+ description_for_help_topic Envelope
+ </remark>
+
<para>
<indexterm type="function">
<primary>Envelope()</primary>
@@ -2979,7 +3190,9 @@
returned as a <literal>Polygon</literal> value.
</para>
-<!-- example_for_help_topic Envelope -->
+ <remark>
+ example_for_help_topic Envelope
+ </remark>
<programlisting>
mysql> <userinput>SELECT AsText(Envelope(GeomFromText('LineString(1 1,2 \
2)')));</userinput> @@ -2998,13 +3211,17 @@
<programlisting>
POLYGON((MINX MINY, MAXX MINY, MAXX MAXY, MINX MAXY, MINX MINY))
</programlisting>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic GeometryType -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic GeometryType
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeometryType()</primary>
@@ -3020,9 +3237,13 @@
<literal>Geometry</literal> subclasses.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic GeometryType -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic GeometryType
+ </remark>
<programlisting>
mysql> <userinput>SELECT GeometryType(GeomFromText('POINT(1 1)'));</userinput>
@@ -3034,9 +3255,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic SRID -->
-
<listitem>
+ <remark>
+ description_for_help_topic SRID
+ </remark>
+
<para>
<indexterm type="function">
<primary>SRID()</primary>
@@ -3056,9 +3279,13 @@
assuming Euclidean (planar) geometry.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic SRID -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic SRID
+ </remark>
<programlisting>
mysql> <userinput>SELECT SRID(GeomFromText('LineString(1 1,2 \
2)',101));</userinput> @@ -3079,9 +3306,11 @@
<itemizedlist>
-<!-- description_for_help_topic Boundary -->
-
<listitem>
+ <remark>
+ description_for_help_topic Boundary
+ </remark>
+
<para>
<indexterm type="function">
<primary>Boundary()</primary>
@@ -3095,13 +3324,17 @@
combinatorial boundary of the geometry value
<replaceable>g</replaceable>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic IsEmpty -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic IsEmpty
+ </remark>
+
<para>
<indexterm type="function">
<primary>IsEmpty()</primary>
@@ -3117,13 +3350,17 @@
<literal>NULL</literal>. If the geometry is empty, it
represents the empty point set.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic IsSimple -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic IsSimple
+ </remark>
+
<para>
<indexterm type="function">
<primary>IsSimple()</primary>
@@ -3152,20 +3389,24 @@
that cause an instance of that class to be classified as
not simple.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
</itemizedlist>
-<!-- help_category Point properties@Geographic features -->
-
</section>
<section id="point-property-functions">
<title id="title-point-property-functions">&title-point-property-functions;</title>
+ <remark>
+ help_category Point properties@Geographic features
+ </remark>
+
<para>
A <literal>Point</literal> consists of X and Y coordinates,
which may be obtained using the following functions:
@@ -3173,9 +3414,11 @@
<itemizedlist>
-<!-- description_for_help_topic X -->
-
<listitem>
+ <remark>
+ description_for_help_topic X
+ </remark>
+
<para>
<indexterm type="function">
<primary>X()</primary>
@@ -3189,9 +3432,13 @@
<replaceable>p</replaceable> as a double-precision number.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic X -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic X
+ </remark>
<programlisting>
mysql> <userinput>SELECT X(GeomFromText('Point(56.7 53.34)'));</userinput>
@@ -3203,9 +3450,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic Y -->
-
<listitem>
+ <remark>
+ description_for_help_topic Y
+ </remark>
+
<para>
<indexterm type="function">
<primary>Y()</primary>
@@ -3219,9 +3468,13 @@
<replaceable>p</replaceable> as a double-precision number.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic Y -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic Y
+ </remark>
<programlisting>
mysql> <userinput>SELECT Y(GeomFromText('Point(56.7 53.34)'));</userinput>
@@ -3248,13 +3501,17 @@
points that it contains, or obtain its length.
</para>
-<!-- help_category LineString properties@Geographic features -->
+ <remark>
+ help_category LineString properties@Geographic features
+ </remark>
<itemizedlist>
-<!-- description_for_help_topic EndPoint -->
-
<listitem>
+ <remark>
+ description_for_help_topic EndPoint
+ </remark>
+
<para>
<indexterm type="function">
<primary>EndPoint()</primary>
@@ -3269,9 +3526,13 @@
<replaceable>ls</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic EndPoint -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic EndPoint
+ </remark>
<programlisting>
mysql> <userinput>SET @ls = 'LineString(1 1,2 2,3 3)';</userinput>
@@ -3284,9 +3545,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic GLength -->
-
<listitem>
+ <remark>
+ description_for_help_topic GLength
+ </remark>
+
<para>
<indexterm type="function">
<primary>GLength()</primary>
@@ -3302,9 +3565,13 @@
reference.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic GLength -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic GLength
+ </remark>
<programlisting>
mysql> <userinput>SET @ls = 'LineString(1 1,2 2,3 3)';</userinput>
@@ -3317,9 +3584,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic IsClosed -->
-
<listitem>
+ <remark>
+ description_for_help_topic IsClosed
+ </remark>
+
<para>
<indexterm type="function">
<primary>NumPoints()</primary>
@@ -3334,9 +3603,13 @@
<replaceable>ls</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic NumPoints -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic NumPoints
+ </remark>
<programlisting>
mysql> <userinput>SET @ls = 'LineString(1 1,2 2,3 3)';</userinput>
@@ -3349,9 +3622,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic PointN -->
-
<listitem>
+ <remark>
+ description_for_help_topic PointN
+ </remark>
+
<para>
<indexterm type="function">
<primary>PointN()</primary>
@@ -3366,9 +3641,13 @@
<replaceable>ls</replaceable>. Point numbers begin at 1.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic PointN -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic PointN
+ </remark>
<programlisting>
mysql> <userinput>SET @ls = 'LineString(1 1,2 2,3 3)';</userinput>
@@ -3381,9 +3660,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic StartPoint -->
-
<listitem>
+ <remark>
+ description_for_help_topic StartPoint
+ </remark>
+
<para>
<indexterm type="function">
<primary>StartPoint()</primary>
@@ -3398,9 +3679,13 @@
<replaceable>ls</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic StartPoint -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic StartPoint
+ </remark>
<programlisting>
mysql> <userinput>SET @ls = 'LineString(1 1,2 2,3 3)';</userinput>
@@ -3450,7 +3735,9 @@
<title id="title-multilinestring-property-functions">&title-multilinestring-property-functions;</title>
-<!-- TODO: Add introductory descriptive sentence. -->
+ <remark role="todo">
+ Add introductory descriptive sentence.
+ </remark>
<itemizedlist>
@@ -3521,15 +3808,21 @@
<title id="title-polygon-property-functions">&title-polygon-property-functions;</title>
-<!-- TODO: Add introductory descriptive sentence. -->
-
-<!-- help_category Polygon properties@Geographic features -->
+ <remark role="todo">
+ Add introductory descriptive sentence.
+ </remark>
+
+ <remark>
+ help_category Polygon properties@Geographic features
+ </remark>
<itemizedlist>
-<!-- description_for_help_topic Area -->
-
<listitem>
+ <remark>
+ description_for_help_topic Area
+ </remark>
+
<para>
<indexterm type="function">
<primary>Area()</primary>
@@ -3545,9 +3838,13 @@
spatial reference system.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic Area -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic Area
+ </remark>
<programlisting>
mysql> <userinput>SET @poly = 'Polygon((0 0,0 3,3 0,0 0),(1 1,1 2,2 1,1 \
1))';</userinput> @@ -3560,9 +3857,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic ExteriorRing -->
-
<listitem>
+ <remark>
+ description_for_help_topic ExteriorRing
+ </remark>
+
<para>
<indexterm type="function">
<primary>ExteriorRing()</primary>
@@ -3578,9 +3877,13 @@
<literal>LineString</literal>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic ExteriorRing -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic ExteriorRing
+ </remark>
<programlisting>
mysql> <userinput>SET @poly =</userinput>
@@ -3594,9 +3897,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic InteriorRingN -->
-
<listitem>
+ <remark>
+ description_for_help_topic InteriorRingN
+ </remark>
+
<para>
<indexterm type="function">
<primary>InteriorRingN()</primary>
@@ -3612,9 +3917,13 @@
<literal>LineString</literal>. Ring numbers begin at 1.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic InteriorRingN -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic InteriorRingN
+ </remark>
<programlisting>
mysql> <userinput>SET @poly =</userinput>
@@ -3628,9 +3937,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic NumInteriorRings -->
-
<listitem>
+ <remark>
+ description_for_help_topic NumInteriorRings
+ </remark>
+
<para>
<indexterm type="function">
<primary>NumInteriorRings()</primary>
@@ -3645,9 +3956,13 @@
<replaceable>poly</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic NumInteriorRings -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic NumInteriorRings
+ </remark>
<programlisting>
mysql> <userinput>SET @poly =</userinput>
@@ -3669,7 +3984,9 @@
<title id="title-multipolygon-property-functions">&title-multipolygon-property-functions;</title>
-<!-- TODO: Add introductory descriptive sentence. -->
+ <remark role="todo">
+ Add introductory descriptive sentence.
+ </remark>
<itemizedlist>
@@ -3746,21 +4063,28 @@
</itemizedlist>
-<!-- help_category GeometryCollection properties@Geographic features -->
-
</section>
<section id="geometrycollection-property-functions">
<title id="title-geometrycollection-property-functions">&title-geometrycollection-property-functions;</title>
-<!-- TODO: Add introductory descriptive sentence. -->
+ <remark role="todo">
+ Add introductory descriptive sentence.
+ </remark>
+
+ <remark>
+ help_category GeometryCollection properties@Geographic
+ features
+ </remark>
<itemizedlist>
-<!-- description_for_help_topic GeometryN -->
-
<listitem>
+ <remark>
+ description_for_help_topic GeometryN
+ </remark>
+
<para>
<indexterm type="function">
<primary>GeometryN()</primary>
@@ -3776,9 +4100,13 @@
1.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic GeometryN -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic GeometryN
+ </remark>
<programlisting>
mysql> <userinput>SET @gc = 'GeometryCollection(Point(1 1),LineString(2 2, 3 \
3))';</userinput> @@ -3791,9 +4119,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic NumGeometries -->
-
<listitem>
+ <remark>
+ description_for_help_topic NumGeometries
+ </remark>
+
<para>
<indexterm type="function">
<primary>NumGeometries()</primary>
@@ -3808,9 +4138,13 @@
<replaceable>gc</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic NumGeometries -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic NumGeometries
+ </remark>
<programlisting>
mysql> <userinput>SET @gc = 'GeometryCollection(Point(1 1),LineString(2 2, 3 \
3))';</userinput> @@ -3833,7 +4167,9 @@
<title id="title-functions-that-create-new-geometries-from-existing-ones">&title-functions-that-create-new-geometries-from-existing-ones;</title>
-<!-- TODO: Add introductory descriptive sentence. -->
+ <remark role="todo">
+ Add introductory descriptive sentence.
+ </remark>
<section id="functions-that-produce-new-geometries">
@@ -4038,7 +4374,9 @@
<primary>Minimum Bounding Rectangle</primary>
</indexterm>
-<!-- help_category MBR@Geographic features -->
+ <remark>
+ help_category MBR@Geographic features
+ </remark>
<para>
MySQL provides some functions that can test relations between
@@ -4048,9 +4386,11 @@
<itemizedlist>
-<!-- description_for_help_topic MBRContains -->
-
<listitem>
+ <remark>
+ description_for_help_topic MBRContains
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBRContains()</primary>
@@ -4066,9 +4406,13 @@
<replaceable>g2</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic MBRContains -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic MBRContains
+ </remark>
<programlisting>
mysql> <userinput>SET @g1 = GeomFromText('Polygon((0 0,0 3,3 3,3 0,0 \
0))');</userinput> @@ -4082,9 +4426,11 @@
</programlisting>
</listitem>
-<!-- description_for_help_topic MBRDisjoint -->
-
<listitem>
+ <remark>
+ description_for_help_topic MBRDisjoint
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBRDisjoint()</primary>
@@ -4100,13 +4446,17 @@
<replaceable>g2</replaceable> are disjoint (do not
intersect).
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic MBREqual -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MBREqual
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBREqual()</primary>
@@ -4121,13 +4471,17 @@
<replaceable>g1</replaceable> and
<replaceable>g2</replaceable> are the same.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic MBRIntersects -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MBRIntersects
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBRIntersects()</primary>
@@ -4142,13 +4496,17 @@
<replaceable>g1</replaceable> and
<replaceable>g2</replaceable> intersect.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MBROverlaps -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MBROverlaps
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBROverlaps()</primary>
@@ -4163,13 +4521,17 @@
<replaceable>g1</replaceable> and
<replaceable>g2</replaceable> overlap.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MBRTouches -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MBRTouches
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBRTouches()</primary>
@@ -4184,13 +4546,17 @@
<replaceable>g1</replaceable> and
<replaceable>g2</replaceable> touch.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic MBRWithin -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic MBRWithin
+ </remark>
+
<para>
<indexterm type="function">
<primary>MBRWithin()</primary>
@@ -4206,9 +4572,13 @@
<replaceable>g2</replaceable>.
</para>
-<!-- end_description_for_help_topic -->
-
-<!-- example_for_help_topic MBRWithin -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+
+ <remark>
+ example_for_help_topic MBRWithin
+ </remark>
<programlisting>
mysql> <userinput>SET @g1 = GeomFromText('Polygon((0 0,0 3,3 3,3 0,0 \
0))');</userinput> @@ -4239,7 +4609,10 @@
<literal>Distance()</literal> and <literal>Related()</literal>.
</para>
-<!-- TODO: Crosses() is an exception here: It exists but MBRCrosses() does not. -->
+ <remark role="todo">
+ Crosses() is an exception here: It exists but MBRCrosses() does
+ not.
+ </remark>
<para>
These functions may be implemented in future releases with full
@@ -4251,13 +4624,17 @@
<literal>g1</literal> and <literal>g2</literal>.
</para>
- <itemizedlist>
-
-<!-- help_category Geometry relations@Geographic features -->
+ <remark>
+ help_category Geometry relations@Geographic features
+ </remark>
-<!-- description_for_help_topic Contains -->
+ <itemizedlist>
<listitem>
+ <remark>
+ description_for_help_topic Contains
+ </remark>
+
<para>
<indexterm type="function">
<primary>Contains()</primary>
@@ -4271,13 +4648,17 @@
<replaceable>g1</replaceable> completely contains
<replaceable>g2</replaceable>.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic Crosses -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Crosses
+ </remark>
+
<para>
<indexterm type="function">
<primary>Crosses()</primary>
@@ -4326,13 +4707,17 @@
</listitem>
</itemizedlist>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic Disjoint -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Disjoint
+ </remark>
+
<para>
<indexterm type="function">
<primary>Disjoint()</primary>
@@ -4346,13 +4731,17 @@
<replaceable>g1</replaceable> is spatially disjoint from
(does not intersect) <replaceable>g2</replaceable>.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic Distance -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Distance
+ </remark>
+
<para>
<indexterm type="function">
<primary>Distance()</primary>
@@ -4365,13 +4754,17 @@
Returns as a double-precision number the shortest distance
between any two points in the two geometries.
</para>
- </listitem>
-
-<!-- end_description_for_help_topic -->
-<!-- description_for_help_topic Equals -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Equals
+ </remark>
+
<para>
<indexterm type="function">
<primary>Equals()</primary>
@@ -4385,13 +4778,17 @@
<replaceable>g1</replaceable> is spatially equal to
<replaceable>g2</replaceable>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic Intersects -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Intersects
+ </remark>
+
<para>
<indexterm type="function">
<primary>Intersects()</primary>
@@ -4405,13 +4802,17 @@
<replaceable>g1</replaceable> spatially intersects
<replaceable>g2</replaceable>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic Overlaps -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Overlaps
+ </remark>
+
<para>
<indexterm type="function">
<primary>Overlaps()</primary>
@@ -4428,13 +4829,17 @@
their intersection results in a geometry of the same
dimension but not equal to either of the given geometries.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic Related -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Related
+ </remark>
+
<para>
<indexterm type="function">
<primary>Related()</primary>
@@ -4453,13 +4858,17 @@
Its specification will be noted here if this function is
implemented.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic Touches -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Touches
+ </remark>
+
<para>
<indexterm type="function">
<primary>Touches()</primary>
@@ -4477,13 +4886,17 @@
geometries intersects either the boundary or the interior of
the other.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
-
-<!-- description_for_help_topic Within -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
<listitem>
+ <remark>
+ description_for_help_topic Within
+ </remark>
+
<para>
<indexterm type="function">
<primary>Within()</primary>
@@ -4497,9 +4910,11 @@
<replaceable>g1</replaceable> is spatially within
<replaceable>g2</replaceable>.
</para>
- </listitem>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
+ </listitem>
</itemizedlist>
@@ -4551,9 +4966,14 @@
<title id="title-creating-spatial-indexes">&title-creating-spatial-indexes;</title>
-<!-- help_category Geographic features -->
-
-<!-- description_for_help_topic SPATIAL INDEX TABLE ALTER CREATE ADD KEY -->
+ <remark>
+ help_category Geographic features
+ </remark>
+
+ <remark>
+ description_for_help_topic SPATIAL INDEX TABLE ALTER CREATE ADD
+ KEY
+ </remark>
<para>
MySQL can create spatial indexes using syntax similar to that
@@ -4635,7 +5055,9 @@
<literal>fid</literal> for storing object ID values.
</para>
-<!-- end_description_for_help_topic -->
+ <remark>
+ end_description_for_help_topic
+ </remark>
<programlisting>
mysql> <userinput>DESCRIBE geom;</userinput>
@@ -4798,7 +5220,9 @@
<title id="title-mysql-gis-conformance-and-compatibility">&title-mysql-gis-conformance-and-compatibility;</title>
-<!-- TODO: Add introductory descriptive sentence. -->
+ <remark role="todo">
+ Add introductory descriptive sentence.
+ </remark>
<section id="gis-features-that-are-not-yet-implemented">
@@ -4819,22 +5243,19 @@
database.
</para>
-<!--
- @item Functions to add/drop spatial columns
- OpenGIS assumes that columns can be added or dropped using special
- @code{AddGeometryColumn()} and @code{DropGeometryColumn()}
- functions. In MySQL, this is done using the @code{ALTER TABLE},
- @code{CREATE INDEX}, and @code{DROP INDEX} statements instead.
- @item Factors related to Spatial Reference Systems and their IDs (SRIDs):
- @itemize @bullet
- @item
- Functions like @code{Length()} and @code{Area()} assume a planar
- coordinate system.
- @item
- All objects currently are considered to be in the same planar
- coordinate system.
- @end itemize
--->
+ <remark>
+ @item Functions to add/drop spatial columns OpenGIS assumes
+ that columns can be added or dropped using special
+ @code{AddGeometryColumn()} and @code{DropGeometryColumn()}
+ functions. In MySQL, this is done using the @code{ALTER
+ TABLE}, @code{CREATE INDEX}, and @code{DROP INDEX}
+ statements instead. @item Factors related to Spatial
+ Reference Systems and their IDs (SRIDs): @itemize @bullet
+ @item Functions like @code{Length()} and @code{Area()}
+ assume a planar coordinate system. @item All objects
+ currently are considered to be in the same planar coordinate
+ system. @end itemize
+ </remark>
</listitem>
<listitem>
@@ -4855,17 +5276,12 @@
</para>
</listitem>
- </itemizedlist>
-
-<!-- @node GIS writing a GIS application -->
-
-<!-- @section Writing a GIS Application -->
-
-<!-- @node GIS Java GIS Object Model -->
-
-<!-- @section Java GIS Object Model -->
-
-<!-- for Mark! -->
+ </itemizedlist><remark>
+ @node GIS writing a GIS application
+ @section Writing a GIS Application
+ @node GIS Java GIS Object Model
+ @section Java GIS Object Model
+ </remark>
</section>
--- 1.8/refman-5.0/spatial-extensions-in-mysql.xml 2005-09-07 07:15:52 +10:00
+++ 1.9/refman-5.0/spatial-extensions-in-mysql.xml 2005-10-01 01:44:14 +10:00
@@ -22,9 +22,10 @@
</remark>
<para>
- MySQL 4.1 introduces spatial extensions to allow the generation,
- storage, and analysis of geographic features. Currently, these
- features are available for <literal>MyISAM</literal> tables only.
+ MySQL supports spatial extensions to allow the generation, storage,
+ and analysis of geographic features. In MySQL ¤t-series;
+ these features are available for <literal>MyISAM</literal> tables
+ only.
</para>
<para>
@@ -65,6 +66,13 @@
</listitem>
</itemizedlist>
+
+ <para>
+ If you have questions or concerns about about the use of the spatial
+ extensions to MySQL, you can discuss these in the <ulink
+ url="http://forums.mysql.com/list.php?23">GIS forums</ulink> on
+ our website.
+ </para>
<section id="gis-introduction">
@@ -3397,15 +3405,15 @@
<title id="title-point-property-functions">&title-point-property-functions;</title>
+ <remark>
+ help_category Point properties@Geographic features
+ </remark>
+
<para>
A <literal>Point</literal> consists of X and Y coordinates,
which may be obtained using the following functions:
</para>
- <remark>
- help_category Point properties@Geographic features
- </remark>
-
<itemizedlist>
<listitem>
@@ -3812,11 +3820,11 @@
<itemizedlist>
- <remark>
- description_for_help_topic Area
- </remark>
-
<listitem>
+ <remark>
+ description_for_help_topic Area
+ </remark>
+
<para>
<indexterm type="function">
<primary>Area()</primary>
@@ -4057,11 +4065,6 @@
</itemizedlist>
- <remark>
- help_category GeometryCollection properties@Geographic
- features
- </remark>
-
</section>
<section id="geometrycollection-property-functions">
@@ -4072,6 +4075,11 @@
Add introductory descriptive sentence.
</remark>
+ <remark>
+ help_category GeometryCollection properties@Geographic
+ features
+ </remark>
+
<itemizedlist>
<listitem>
@@ -5270,26 +5278,11 @@
</para>
</listitem>
- </itemizedlist>
-
- <remark>
+ </itemizedlist><remark>
@node GIS writing a GIS application
- </remark>
-
- <remark>
@section Writing a GIS Application
- </remark>
-
- <remark>
@node GIS Java GIS Object Model
- </remark>
-
- <remark>
@section Java GIS Object Model
- </remark>
-
- <remark>
- for Mark!
</remark>
</section>
--
MySQL Internals Mailing List
For list archives: http://lists.mysql.com/internals
To unsubscribe: http://lists.mysql.com/internals?unsub=mysql-internals@progressive-comp.com
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic