[mapserver-commits] r12097 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Tue Aug 23 09:03:28 EDT 2011
Author: havatv
Date: 2011-08-23 06:03:28 -0700 (Tue, 23 Aug 2011)
New Revision: 12097
Modified:
branches/branch-6-0/docs/en/mapfile/join.txt
trunk/docs/en/mapfile/join.txt
Log:
Added indexes (#4001)
Modified: branches/branch-6-0/docs/en/mapfile/join.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/join.txt 2011-08-23 12:55:44 UTC (rev 12096)
+++ branches/branch-6-0/docs/en/mapfile/join.txt 2011-08-23 13:03:28 UTC (rev 12097)
@@ -4,7 +4,7 @@
JOIN
*****************************************************************************
-.. index:: Join
+.. index:: JOIN
Description
===========
@@ -14,6 +14,9 @@
use joins to affect the look of a map. The primary purpose is to enable lookup
tables for coded data (e.g. 1 => Forest) but there are other possible uses.
+.. index::
+ pair: JOIN; Supported formats
+
Supported Formats
=================
@@ -24,41 +27,65 @@
Mapfile Parameters:
===================
+.. index::
+ pair: JOIN; CONNECTION
+
CONNECTION [string]
Parameters required for the join table's database connection (not required
- for DBF or CSV joins). The following is an example connection for :ref:`PostgreSQL
- <input_postgis>`:
+ for DBF or CSV joins). The following is an example connection for
+ :ref:`PostgreSQL <input_postgis>`:
.. code-block:: mapfile
CONNECTION "host=127.0.0.1 port=5432 user=postgres password=postgres dbname=somename"
CONNECTIONTYPE POSTGRESQL
+.. index::
+ pair: JOIN; CONNECTIONTYPE
+
CONNECTIONTYPE [csv|postgresql]
Type of connection (not required for DBF joins). For PostgreSQL
use `postgresql`, for CSV use `csv`.
+.. index::
+ pair: JOIN; FOOTER
+
FOOTER [filename]
Template to use *after* a layer's set of results have been sent. In other
words, this header HTML will be displayed after the contents of the
`TEMPLATE` HTML.
+.. index::
+ pair: JOIN; FROM
+
FROM [item]
Join item in the dataset. This is case sensitive.
+.. index::
+ pair: JOIN; HEADER
+
HEADER [filename]
Template to use *before* a layer's set of results have been sent. In other
words, this header HTML will be displayed before the contents of the
`TEMPLATE` HTML.
+.. index::
+ pair: JOIN; NAME
+
NAME [string]
Unique name for this join. Required.
+.. index::
+ pair: JOIN; TABLE
+
TABLE [filename|tablename]
For file-based joins this is the name of XBase or comma delimited file
(relative to the location of the mapfile) to join TO. For PostgreSQL
support this is the name of the PostgreSQL table to join TO.
+.. index::
+ pair: JOIN; TEMPLATE
+
TEMPLATE [filename]
Template to use with one-to-many joins. The template is processed once
for each record and can only contain substitutions for items in the joined
@@ -66,9 +93,15 @@
[joinname_columnname], where joinname is the NAME specified for the JOIN
object.
+.. index::
+ pair: JOIN; TO
+
TO [item]
Join item in the table to be joined. This is case sensitive.
+.. index::
+ pair: JOIN; TYPE
+
TYPE [ONE-TO-ONE|ONE-TO-MANY]
The type of join. Default is one-to-one.
Modified: trunk/docs/en/mapfile/join.txt
===================================================================
--- trunk/docs/en/mapfile/join.txt 2011-08-23 12:55:44 UTC (rev 12096)
+++ trunk/docs/en/mapfile/join.txt 2011-08-23 13:03:28 UTC (rev 12097)
@@ -4,7 +4,7 @@
JOIN
*****************************************************************************
-.. index:: Join
+.. index:: JOIN
Description
===========
@@ -14,6 +14,9 @@
use joins to affect the look of a map. The primary purpose is to enable lookup
tables for coded data (e.g. 1 => Forest) but there are other possible uses.
+.. index::
+ pair: JOIN; Supported formats
+
Supported Formats
=================
@@ -24,41 +27,65 @@
Mapfile Parameters:
===================
+.. index::
+ pair: JOIN; CONNECTION
+
CONNECTION [string]
Parameters required for the join table's database connection (not required
- for DBF or CSV joins). The following is an example connection for :ref:`PostgreSQL
- <input_postgis>`:
+ for DBF or CSV joins). The following is an example connection for
+ :ref:`PostgreSQL <input_postgis>`:
.. code-block:: mapfile
CONNECTION "host=127.0.0.1 port=5432 user=postgres password=postgres dbname=somename"
CONNECTIONTYPE POSTGRESQL
+.. index::
+ pair: JOIN; CONNECTIONTYPE
+
CONNECTIONTYPE [csv|postgresql]
Type of connection (not required for DBF joins). For PostgreSQL
use `postgresql`, for CSV use `csv`.
+.. index::
+ pair: JOIN; FOOTER
+
FOOTER [filename]
Template to use *after* a layer's set of results have been sent. In other
words, this header HTML will be displayed after the contents of the
`TEMPLATE` HTML.
+.. index::
+ pair: JOIN; FROM
+
FROM [item]
Join item in the dataset. This is case sensitive.
+.. index::
+ pair: JOIN; HEADER
+
HEADER [filename]
Template to use *before* a layer's set of results have been sent. In other
words, this header HTML will be displayed before the contents of the
`TEMPLATE` HTML.
+.. index::
+ pair: JOIN; NAME
+
NAME [string]
Unique name for this join. Required.
+.. index::
+ pair: JOIN; TABLE
+
TABLE [filename|tablename]
For file-based joins this is the name of XBase or comma delimited file
(relative to the location of the mapfile) to join TO. For PostgreSQL
support this is the name of the PostgreSQL table to join TO.
+.. index::
+ pair: JOIN; TEMPLATE
+
TEMPLATE [filename]
Template to use with one-to-many joins. The template is processed once
for each record and can only contain substitutions for items in the joined
@@ -66,9 +93,15 @@
[joinname_columnname], where joinname is the NAME specified for the JOIN
object.
+.. index::
+ pair: JOIN; TO
+
TO [item]
Join item in the table to be joined. This is case sensitive.
+.. index::
+ pair: JOIN; TYPE
+
TYPE [ONE-TO-ONE|ONE-TO-MANY]
The type of join. Default is one-to-one.
More information about the mapserver-commits
mailing list