[mapserver-commits] r13106 - trunk/docs/en/tinyows

svn at osgeo.org svn at osgeo.org
Wed Feb 8 18:31:59 EST 2012


Author: halmueller
Date: 2012-02-08 15:31:59 -0800 (Wed, 08 Feb 2012)
New Revision: 13106

Modified:
   trunk/docs/en/tinyows/configfile.txt
   trunk/docs/en/tinyows/index.txt
   trunk/docs/en/tinyows/libxmlschemagmlbug.txt
   trunk/docs/en/tinyows/mapfileconfig.txt
   trunk/docs/en/tinyows/openlayershowtobasic.txt
   trunk/docs/en/tinyows/openlayershowtotransactional.txt
   trunk/docs/en/tinyows/serverinstallation.txt
Log:
format conversion and updates for TinyOWS documentation

Modified: trunk/docs/en/tinyows/configfile.txt
===================================================================
--- trunk/docs/en/tinyows/configfile.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/configfile.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -1,21 +1,23 @@
 .. _tinyows_configfile:
 
 *****************************************************************************
-Configuration File 
+Configuring TinyOWS with an XML File 
 *****************************************************************************
 
-Configuration is done via a single XML file called 'config.xml'.
+The simplest way to configure TinyOWS is with a single XML file called ``config.xml``.
 
-The default path is ''/usr/local/tinyows/config.xml'', you could
-also use TINYOWS_CONFIG_FILE environment var to set your own path.
+The default path is ``/usr/local/tinyows/config.xml``. You can
+also use ``TINYOWS_CONFIG_FILE`` environment variable to set your own path.
 
 
-== Configuration file simple Example ==
+Configuration file simple Example
+---------------------------------
 
-You could find an example of 'config.xml' file in demo directory:
+An example ``config.xml`` file is in the demo directory:
 
-{{{
-<tinyows online_resource="http://127.0.0.1/cgi-bin/tinyows"
+.. code-block:: xml
+
+ <tinyows online_resource="http://127.0.0.1/cgi-bin/tinyows"
          schema_dir="/usr/local/tinyows/schema/">
 
   <pg host="127.0.0.1" user="postgres" password="postgres" dbname="tinyows_demo" port="5432"/>
@@ -37,96 +39,103 @@
          name="france"
          title="French Administrative Sub Boundaries (IGN - GeoFLA Departements)" />
 
-</tinyows>
+ </tinyows>
 
-}}}
 
 
-----
-== Check Config.xml file ==
 
+Testing your config.xml file
+----------------------------
+
 Once you have a config.xml file related to your service,
-you could launch the --check option:
+launch TinyOWS with the --check option to validate your configuration
+file, test your database connection, and list the layers to be used:
 
-{{{
-./tinyows --check
-Config File:	 OK
-PG Connection:	 OK
-Available layers:
+.. code-block:: bash
+
+ ./tinyows --check
+ Config File:	 OK
+ PG Connection:	 OK
+ Available layers:
  - public.world  -> 4326 RW
  - public.france  -> 27582 RW
 
-}}}
 
 
-----
+Structure of the config.xml file
+--------------------------------
 
-== TinyOWS Element ==
+TinyOWS Element
+===============
 
 TinyOWS is the root element. 
 He is mandatory, and must contains some system informations about the service itself.
 Some globals service options could also be switched on or off at this level.
 
+==================== =========   =======  ===========
+Attribute            Required?   Default  Description
+==================== =========   =======  ===========
+online_resource      mandatory            URL where the service is located, e.g: ``http://127.0.0.1/cgi-bin/tinyows``
+schema_dir           mandatory            Path where TinyOWS schema dir is located e.g: ``/usr/local/tinyows/schema/``
+log                  optional             Path where TinyOWS logs input requests. e.g: ``/var/log/tinyows.log``. This file must be writable by the user that owns the TinyOWS process.
+log_level            optional    0        Bit field value to indicate what to log: 1: ERROR, 2: EVENT, 4: HTTP QUERY, 8: SQL
+degree_precision     optional    6        Indicate how many digits of decimal precision when positions are in latitude/longitude. 
+meter_precision      optional    0        Indicate how many digits of decimal precision to use when positions are in  meters.
+display_bbox         optional    1        Flag to indicate if bounding box should be computed for WFS GML ``GetFeature`` output. It's mandatory in WFS specification. But as it's time consuming it could be interesting to be able to deactivate it.
+estimated_extent     optional    0        Flag to indicate if TinyOWS should use estimated_extent (faster but less accurate).
+check_schema         optional    1        Flag to indicate if input data must be checked against schema before to be executed. Caution, schema validation is an important part of security. Disable this attribute at your peril.
+check_valid_geom     optional    1        Flag to indicate if geometry OGC SFS 1.1 validation should be done prior to execute a transaction.
+encoding             optional    UTF-8    Output encoding. Other values could be ISO-8859-1 for instance. No encoding conversion is done on data; this attribute is declarative.
+expose_pk            optional    0        Flag to indicate if TinyOWS should expose PK in schema (and so require them in Transaction query).
+==================== =========   =======  ===========
 
-=== TinyOWS attributes ===
 
-||Attribute||Mandatory||Description||
-||online_resource||Mandatory||URL where the service is located, e.g: ''http://127.0.0.1/cgi-bin/tinyows''||
-||schema_dir||Mandatory||Path where TinyOWS schema dir is located e.g: ''/usr/local/tinyows/schema/''||
-||log||Optional||Path where TinyOWS could log input requests. e.g: ''/var/log/tinyows.log'' (This file must have correct write permissions).||
-||log_level||Optional||Bit field value to indicate what to log: 1: ERROR, 2: EVENT, 4: HTTP QUERY, 8: SQL||
-||degree_precision||Optional||Indicate how many digits use to decimal precision when datas are lat/lon. Default is ''6''.||
-||meter_precision||Optional||Indicate how many digits use to decimal precision when datas are meters based. Default is ''0''.||
-||display_bbox||Optional||Flag to indicate if bbox should be computed for WFS GML !GetFeature output. It's mandatory in WFS specification. But as it's time consuming it could be interresting to be able to deactivate it. Default is ''1''.||
-||estimated_extent||Optional||Flag to indicate if TinyOWS should use estimated_extent (faster but less accurate). Default is ''0''|| 
-||check_schema||Optional||Flag to indicate if input data must be checked against schema before to be executed. Caution, schema validation is an important part on security stage. Default is ''1''.||
-||check_valid_geom||Optional||Flag to indicate if geometry OGC SFS 1.1 validation should be done prior to execute a transaction. Default is ''1''.||
-||encoding||Optional||Output encoding. Default is UTF-8. Others values could be ISO-8859-1 for instance. No encoding conversion is done on datas, encoding is declarative.||
-||expose_pk||Optional||Flag to indicate if TinyOWS should expose PK in schema (and so require them in Transcation query). Default is ''0''|| 
- 
+Limits Element
+==============
 
-----
+Limits Element provides a maximum for the server output.
+It could help to prevent a denial of service attack, or an abnormally
+large user query, from crashing your server.
+This element is optional.
 
-== Limits Element ==
+Limits attributes
 
-Limits Element is dedicated to put limitation on the whole server output.
-It could help to prevent DoS or stupid huge query from userland.
-This element is optional.
+==================== =========   =======  ===========
+Attribute            Required?   Default  Description
+==================== =========   =======  ===========
+features             optional             Use to set maximum number of features returned to WFS client, on ``GetFeature`` request
+geobbox              optional    WGS-84   Geographic bounding bbox, used to indicate maximum extent: East,West,North,South 
+==================== =========   =======  ===========
 
-=== Limits attributes ===
-||Attribute||Mandatory||Description||
-||features||Optional||Use to set maximum number of features returned to WFS client, on !GetFeature request||
-||geobbox||Optional||WGS 84 Geographic Bbox, used to indicate maximum extent: East,West,North,South|| 
+.. code-block:: xml
 
-=== Example ===
-{{{
-<tinyows>
+ <tinyows>
   ...
   <limits features="10000" />
   ...
-</tinyows>
-}}}
+ </tinyows>
 
 
-----
+PostgreSQL Connection
+=====================
 
-== PostgreSQL Connection ==
-
 PostgreSQL connection element.
 This element is mandatory.
 
-||Attribute||Mandatory||Description||
-||host||optional||Name (or IP) to PostgreSQL server (default is localhost)||
-||user||optional||PostgreSQL user to connect (default is the system user used to run the server)||
-||password||optional||PostgreSQL password connection||
-||dbname||optional||PostGIS database (by default, same as the system user used to run the server||
-||port||optional||PostgreSQL port number (by default 5432)||
-||encoding||optional||PostgreSQL DB encoding, cf http://www.postgresql.org/docs/9.0/static/multibyte.html#CHARSET-TABLE (by default UTF8)||
+==================== =========   ========= ===========
+Attribute            Required?   Default   Description
+==================== =========   ========= ===========
+host                 optional    localhost Name (or IP) to PostgreSQL server (default is localhost)
+user                 optional              PostgreSQL user to connect (default is the system user used to run the server)
+password             optional              PostgreSQL password connection
+dbname               optional              PostGIS database (by default, same as the system user used to run the server
+port                 optional    5432      PostgreSQL port number
+encoding             optional    UTF-8     PostgreSQL DB encoding, as specified in http://www.postgresql.org/docs/9.0/static/multibyte.html#CHARSET-TABLE
+==================== =========   ========= ===========
 
-=== Example ===
+.. code-block:: xml
 
-{{{
-<tinyows>
+ <tinyows>
   ...
   <pg host="127.0.0.1"
          user="postgres"
@@ -134,54 +143,68 @@
          dbname="gis_data"
          port="5432" />
    ...
-</tinyows>
-}}}
+ </tinyows>
 
 
-----
 
-== Metadata and Contact Elements ==
 
-Use to fill some Medatada's information about the service itself.
-Theses two elements are mandatory.
 
+Metadata and Contact Elements
+=============================
 
-=== Metadata attributes ===
-||Attribute||Mandatory||Description||
-|| name || Mandatory || Web Service Name ||
-|| title || Mandatory || Web Service Title ||
-|| keywords || Optional || Web Service Keywords list (use comma as separator)||
-|| fees || Optional || Web Service Fees ||
-|| access_constraints || Optional || Web Service Access Constraints||
+Used to provide information about the service itself.
+These two elements are mandatory.
 
 
-=== Abstract Element ===
-Abstract Element is an optional child element of Metadata.
-It's dedicaded to give some abstract metadata informations about the service itself.
+Metadata attributes
++++++++++++++++++++
 
+==================== =========   =======  ===========
+Attribute            Required?   Default  Description
+==================== =========   =======  ===========
+name                 mandatory            Web Service Name 
+title                mandatory            Web Service Title 
+keywords             optional             Web Service Keywords list (comma separated list)
+fees                 optional             Web Service Fees 
+access_constraints   optional             Web Service Access Constraints
+==================== =========   =======  ===========
 
-=== Contact attributes ===
-||Attribute||Mandatory||Description||
-|| name || Mandatory || Web Service Contact Name ||
-|| site || Mandatory || Web Service Contact URL  ||
-|| email || Mandatory || Web Service Contact Email ||
-|| individual_name || Optional || Web Service Contact Individual Name ||
-|| position || Optional || Web Service Contact Position ||
-|| phone || Optional || Web Service Contact Phone ||
-|| fax || Optional || Web Service Contact Fax ||
-|| online_resource || Optional || Web Service Contact URL (e.g additional Metadatas)||
-|| address || Optional || Web Service Contact Postal Address ||
-|| postcode || Optional || Web Service Contact Postcode ||
-|| city || Optional || Web Service Contact City ||
-|| administrative_area || Optional || Web Service Contact Administrative Area ||
-|| country || Optional || Web Service Contact Country ||
-|| hours_of_service || Optional || Web Service Contact Hours of Services ||
-|| contact_instructions || Optional || Web Service Contact Instructions ||
 
+Abstract Element
+++++++++++++++++
 
-=== Contact and Metadata example with only mandatory attributes: ===
+The Abstract element is an optional child element of Metadata. It
+is a place for a free-formatted text description of the service.
 
-{{{
+
+Contact attributes
+++++++++++++++++++
+
+==================== =========   =======  ===========
+Attribute            Required?   Default  Description
+==================== =========   =======  ===========
+name                 mandatory            Web Service Contact Name 
+site                 mandatory            Web Service Contact URL  
+email                mandatory            Web Service Contact Email 
+individual_name      optional             Web Service Contact Individual Name 
+position             optional             Web Service Contact Position 
+phone                optional             Web Service Contact Phone 
+fax                  optional             Web Service Contact Fax 
+online_resource      optional             Web Service Contact URL (e.g additional Metadatas)
+address              optional             Web Service Contact Postal Address 
+postcode             optional             Web Service Contact Postcode 
+city                 optional             Web Service Contact City 
+administrative_area  optional             Web Service Contact Administrative Area 
+country              optional             Web Service Contact Country 
+hours_of_service     optional             Web Service Contact Hours of Services 
+contact_instructions optional             Web Service Contact Instructions ||
+==================== =========   =======  ===========
+
+
+Contact and Metadata example with only mandatory attributes: 
+
+.. code-block:: xml
+
   <metadata name="TinyOWS Server"
             title="TinyOWS Server - Demo Service" />
 
@@ -189,35 +212,35 @@
            site="http://www.tinyows.org/"
            email="tinyows-users at lists.maptools.org" />
 
-}}}
 
-----
 
+Layer Element
+=============
 
-== Layer Element ==
-
 Layer element is used to set all layers provided by the service.
-Even if layer is not mandatory, if omitted, no layer at all will be provided.
+Although this element is technically optional, omitting it will cause no layer at all to be provided.
 
 
-=== Layer attributes ===
-||Attribute||Mandatory||Default|| Inherited values || Description||
-||ns_prefix||Mandatory|| - || Yes ||Layer's Namespace Prefix used in WFS ||
-||ns_uri||Mandatoty|| - || Yes || Layer's Namespace URI used in WFS || 
-||name||Mandatory|| - || No || Layer's Name||
-||title||Mandatory|| - || No || Layer's Title||
-||retrievable||Optional||false || Yes || If true layer is retrievable on WFS !GetFeature request ||
-||writable||Optional||false|| Yes || If true layer is editable with WFS Transaction request||
-||schema||Optional||'public'|| No || PostgreSQL Schema name.||
-||abstract||Optional|| - || No || Abstract text||
-||keywords||Optional|| - || No || Keywords (comma separated list)|| 
-||srid||Optional || - || Yes || Comma separated list of output SRID||  
-||geobbox||Optional|| - || Yes ||WGS 84 bbox of max extent: East,West,North,South||
+==================== =========   ======== ========= ============
+Attribute            Required?   Default  Inherits? Description
+==================== =========   ======== ========= ============
+ns_prefix            mandatory            Yes       Layer's Namespace Prefix used in WFS 
+ns_uri               mandatory            Yes       Layer's Namespace URI used in WFS
+name                 mandatory            No        Layer's Name
+title                mandatory            No        Layer's Title
+retrievable          optional    false    Yes       If true, layer is retrievable on WFS ``GetFeature`` request 
+writable             optional    false    Yes       If true, layer is editable with WFS Transaction request
+schema               optional    'public' No        PostgreSQL Schema name.
+abstract             optional             No        Abstract text
+keywords             optional             No        Keywords (comma separated list)
+srid                 optional             Yes       Comma separated list of output SRID  
+geobbox              optional             Yes       WGS-84 bbox of max extent: East,West,North,South
+==================== =========   ======== ========= ============
 
 
-=== Example ===
-{{{
-<tinyows>
+.. code-block:: xml
+
+ <tinyows>
   ...
       <layer retrievable="1"
          writable="1"
@@ -226,18 +249,19 @@
          name="world"
          title="World Administrative Boundaries" />
   ...
-</tinyows>
-}}}
+ </tinyows>
 
 
 
-=== Nested Layers ===
 
+Nested Layers
++++++++++++++
+
 Layer entities could be nested, properties in this case are inherited.
 
-=== Nested Layers Example ===
-{{{
-<tinyows>
+.. code-block:: xml
+
+ <tinyows>
   ...
       <layer retrievable="1"
          writable="1"
@@ -251,5 +275,5 @@
       </layer>
      
   ...
-</tinyows>
-}}}
+ </tinyows>
+

Modified: trunk/docs/en/tinyows/index.txt
===================================================================
--- trunk/docs/en/tinyows/index.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/index.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -27,9 +27,9 @@
    serverinstallation
    configfile
    mapfileconfig
-   servertuning
    openlayershowtobasic
    openlayershowtotransactional
+   servertuning
    libxmlschemagmlbug
 
 .. seealso::

Modified: trunk/docs/en/tinyows/libxmlschemagmlbug.txt
===================================================================
--- trunk/docs/en/tinyows/libxmlschemagmlbug.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/libxmlschemagmlbug.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -1,104 +1,109 @@
 .. _tinyows_libxmlschemagmlbug:
 
 *****************************************************************************
-LibXML2 XSD Schema GML Bug
+Working Around the LibXML2 XSD Schema GML Bug
 *****************************************************************************
 
 Issue
 -----------------------------------------------------------------------------
-LibXML2 is a great tool, but XSD Schema handling still need some continuous improve.
+TinyOWS makes use of GML, an XML-based language that encodes
+geometry. Frequently the input and the output of TinyOWS are in GML.
 
-GML 3.1.1 XSD Schema are not handled by any older release of LibXML2.
-(See https://bugzilla.gnome.org/show_bug.cgi?id=630130)
+As of February 2012, the current release of Libxml2 does not correctly
+handle GML 3.1.1 XSD Schema (see
+https://bugzilla.gnome.org/show_bug.cgi?id=630130). The trunk of
+Libxml2's repository does handle GML 3.1.1.
 
-Nota: On previous TinyOWS release, i've just slightly change the GML 3.1.1 XSD itself, to 'make it works'.
-But i didn't knew OGC LICENCE doesn't allow such a thing.
+Workaround and options
+----------------------
 
+For TinyOWS users, you have several options
 
-== Workaround and options ==
+- Take the latest trunk version from the official Libxml2 git repository:
 
-So for TinyOWS users, you've got theses options:
+.. code-block:: bash
 
- - Take the latest trunk version from official GIT
-{{{
-git clone git://git.gnome.org/libxml2
-}}}
+  git clone git://git.gnome.org/libxml2
 
 
 
- - Or patching yourself your LibXML2 release and compile TinyOWS linked.
+- Patch your own copy of LibXML2 release and link TinyOWS against your
+  local copy:
 
-{{{
---- xmlschemas.c.orig   2011-04-24 14:58:16.000000000 +0000
-+++ xmlschemas.c        2011-04-24 15:47:50.000000000 +0000
-@@ -15158,7 +15158,11 @@
+
+.. code-block:: bash
+
+  --- xmlschemas.c.orig   2011-04-24 14:58:16.000000000 +0000
+  +++ xmlschemas.c        2011-04-24 15:47:50.000000000 +0000
+  @@ -15158,7 +15158,11 @@
      }
      if ( (WXS_IS_LIST(type) || WXS_IS_UNION(type)) &&
          (WXS_IS_RESTRICTION(type) == 0) &&
--        (! WXS_IS_ANY_SIMPLE_TYPE(baseType))) {
-+        (
-+          (! WXS_IS_ANY_SIMPLE_TYPE(baseType))
-+          && (baseType->type != XML_SCHEMA_TYPE_SIMPLE)
-+        )
-+       ) {
+  -        (! WXS_IS_ANY_SIMPLE_TYPE(baseType))) {
+  +        (
+  +          (! WXS_IS_ANY_SIMPLE_TYPE(baseType))
+  +          && (baseType->type != XML_SCHEMA_TYPE_SIMPLE)
+  +        )
+  +       ) {
         xmlSchemaPCustomErr(ctxt,
             XML_SCHEMAP_ST_PROPS_CORRECT_1,
             WXS_BASIC_CAST type, NULL,
-}}}
+  }}}
 
 
 
- - Or choose to modify the XSD GML Schema itself (but you broke the OGC LICENCE if you do so)
+- Modify the XSD GML Schema itself (but you violate the OGC License if you do this!):
    
-{{{
-Index: schema/gml/3.1.1/base/valueObjects.xsd
-===================================================================
---- schema/gml/3.1.1/base/valueObjects.xsd (revision 550)
-+++ schema/gml/3.1.1/base/valueObjects.xsd (revision 561)
-@@ -200,11 +200,13 @@
-        <group name="ValueExtent">
-                <choice>
-+<!--
-                        <element ref="gml:CategoryExtent"/>
-                        <element ref="gml:QuantityExtent"/>
-+-->
-                        <element ref="gml:CountExtent"/>
-                </choice>
-        </group>
--       <!-- ======================================================================
--       <element name="QuantityExtent" type="gml:QuantityExtentType" substitutionGroup="gml:_Value"> -->
-+       <!-- ====================================================================== 
-+       <element name="QuantityExtent" type="gml:QuantityExtentType" substitutionGroup="gml:_Value"> 
-        <element name="QuantityExtent" type="gml:QuantityExtentType">
-                <annotation>
-@@ -212,5 +214,4 @@
-                </annotation>
-        </element>
--       <!-- -->
-        <complexType name="QuantityExtentType">
-                <annotation>
-@@ -223,6 +224,7 @@
-                </simpleContent>
-        </complexType>
-+-->
-        <!-- ======================================================================
--       <element name="CategoryExtent" type="gml:CategoryExtentType" substitutionGroup="gml:_Value"> -->
-+       <element name="CategoryExtent" type="gml:CategoryExtentType" substitutionGroup="gml:_Value"> 
-        <element name="CategoryExtent" type="gml:CategoryExtentType">
-                <annotation>
-@@ -230,5 +232,4 @@
-                </annotation>
-        </element>
--       <!-- -->
-        <complexType name="CategoryExtentType">
-                <annotation>
-@@ -241,4 +242,5 @@
-                </simpleContent>
-        </complexType>
-+-->
-        <!-- ======================================================================
-        <element name="CountExtent" type="gml:CountExtentType" substitutionGroup="gml:_Value"> -->
-}}}
 
+.. code-block:: bash
 
-  - Or choose to use only GML 2.1.2 in the meantime.
+ Index: schema/gml/3.1.1/base/valueObjects.xsd
+ ===================================================================
+ --- schema/gml/3.1.1/base/valueObjects.xsd (revision 550)
+ +++ schema/gml/3.1.1/base/valueObjects.xsd (revision 561)
+ @@ -200,11 +200,13 @@
+	 <group name="ValueExtent">
+		 <choice>
+ +<!--
+			 <element ref="gml:CategoryExtent"/>
+			 <element ref="gml:QuantityExtent"/>
+ +-->
+			 <element ref="gml:CountExtent"/>
+		 </choice>
+	 </group>
+ -       <!-- ======================================================================
+ -       <element name="QuantityExtent" type="gml:QuantityExtentType" substitutionGroup="gml:_Value"> -->
+ +       <!-- ====================================================================== 
+ +       <element name="QuantityExtent" type="gml:QuantityExtentType" substitutionGroup="gml:_Value"> 
+	 <element name="QuantityExtent" type="gml:QuantityExtentType">
+		 <annotation>
+ @@ -212,5 +214,4 @@
+		 </annotation>
+	 </element>
+ -       <!-- -->
+	 <complexType name="QuantityExtentType">
+		 <annotation>
+ @@ -223,6 +224,7 @@
+		 </simpleContent>
+	 </complexType>
+ +-->
+	 <!-- ======================================================================
+ -       <element name="CategoryExtent" type="gml:CategoryExtentType" substitutionGroup="gml:_Value"> -->
+ +       <element name="CategoryExtent" type="gml:CategoryExtentType" substitutionGroup="gml:_Value"> 
+	 <element name="CategoryExtent" type="gml:CategoryExtentType">
+		 <annotation>
+ @@ -230,5 +232,4 @@
+		 </annotation>
+	 </element>
+ -       <!-- -->
+	 <complexType name="CategoryExtentType">
+		 <annotation>
+ @@ -241,4 +242,5 @@
+		 </simpleContent>
+	 </complexType>
+ +-->
+	 <!-- ======================================================================
+	 <element name="CountExtent" type="gml:CountExtentType" substitutionGroup="gml:_Value"> -->
+
+
+- Or choose to use only GML 2.1.2 in the meantime.

Modified: trunk/docs/en/tinyows/mapfileconfig.txt
===================================================================
--- trunk/docs/en/tinyows/mapfileconfig.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/mapfileconfig.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -1,16 +1,23 @@
 .. _tinyows_mapfileconfig:
 
 *****************************************************************************
-Mapfile Configuration File Support for TinyOWS
+Configuring TinyOWS with a standard Mapfile 
 *****************************************************************************
 
 Mapfile Config File support for TinyOWS 
 -----------------------------------------------------------------------------
 
 TinyOWS supports a standard MapServer Mapfile. This allow a single
-file to configure both MapServer and TinyOWS. To indicate where your
+file to configure both MapServer and TinyOWS. This is principally of
+use when you want to write a single configuration file to control both
+MapServer and TinyOWS. TinyOWS does not handle all of the parameters
+in a Mapfile, but will ignore, without error, any parameters that are
+not implemented in TinyOWS.
+
+If you prefer, you can configure TinyOWS using an XML file (:ref:`tinyows_configfile`).
+
+To indicate where your
 Mapfile is located, use the ''TINYOWS_MAPFILE'' environment variable.
-  
 
 Here an example of a single Mapfile: 
 
@@ -45,73 +52,77 @@
 	END
     END
 
-Current concepts and limitations
-- Only PostGIS ''CONNECTIONTYPE'' are handled
-- We don't pretend to support right now all the WFS parameters available in Mapfile
-- But on the other hand you should be able to configure every part of TinyOWS from Mapfile  
-- Each ''CONNECTION'' string value in layers must be the same.
-- Mapfile ''PROJECTION'' content is not parsed, so use explicit ''wfs_srs'' 
-- Mapfile ''LAYER/FILTER'' is not parsed.
-- Defaults values are TinyOWS ones, even for common properties shared by both apps.
-- We don't use ''DATA'' element from Mapfile, so you have to use ''tinyows_table'' (and ''tinyows_schema'' if needed) in each layer.
-- If DUMP is not set to TRUE on a layer both Read and Write access are shutdown for these layer
+Current concepts and limitations:
 
-== Mapfile path of each TinyOWS config element ==
+- Only the PostGIS ``CONNECTIONTYPE`` is handled
+- TinyOWS does not support all of the WFS parameters available in a Mapfile. But on the other hand, you *are* able to configure every part of TinyOWS with a Mapfile.  
+- The ``CONNECTION`` string value in each layer must be the same.
+- Mapfile ``PROJECTION`` content is not parsed, so use explicit ``wfs_srs``. 
+- Mapfile ``LAYER`` and ``FILTER`` are not parsed.
+- Default values are TinyOWS ones, even for common properties shared by both TinyOWS and MapServer.
+- TinyOWS does not use ``DATA`` element from Mapfile, so you have to use ``tinyows_table`` (and ``tinyows_schema`` if needed) in each layer.
+- If ``DUMP`` is not set to ``TRUE`` on a layer, both read and write access are disabled for the layer.
 
-||Original TinyOWS XML Config File||!MapFile counterpart||
-||/tinyows at online_resource||/map/metadata at tinyows_onlineresource||
-||/tinyows at schema_dir||/map/metadata at tinyows_schema_dir||
-||/tinyows at log||/map/metadata at tinyows_log||
-||/tinyows at log_level||/map/metadata at tinyows_log_level||
-||/tinyows at degree_precision||/map/metadata at tinyows_degree_precision||
-||/tinyows at meter_precision||/map/metadata at tinyows_meter_precision||
-||/tinyows at display_bbox||/map/metadata at tinyows_display_bbox||
-||/tinyows at estimated_extent||/map/metadata at tinyows_estimated_extent||
-||/tinyows at check_schema||/map/metadata at tinyows_check_schema||
-||/tinyows at check_valid_geom||/map/metadata at tinyows_check_valid_geom||
-||/tinyows at encoding||/map/metadata at wfs_encoding||
-||/tinyows at db_encoding||/map/metadata at tinyows_db_encoding||
-||/tinyows at expose_pk||/map/metadata at tinyows_expose_pk||
-||/tinyows/limits at features||/map/metadata at wfs_maxfeatures||
-||/tinyows/limits at geobbox||/map/metadata at tinyows_geobbox||
-||/tinyows/pg at host||/map/layer at connection||
-||/tinyows/pg at user||/map/layer at connection||
-||/tinyows/pg at password||/map/layer at connection||
-||/tinyows/pg at dbname||/map/layer at connection||
-||/tinyows/pg at port||/map/layer at connection||
-||/tinyows/pg at encoding||/map/metadata at tinyows_db_encoding||
-||/tinyows/metadata at name||/map at name||
-||/tinyows/metadata at title||/map/metadata at wfs_title||
-||/tinyows/metadata at keywords||/map/metadata at wfs_keywordlist||
-||/tinyows/metadata/abstract||/map/metadata at wfs_abstract||
-||/tinyows/metadata at fees||/map/metadata at wfs_fees||
-||/tinyows/metadata at access_constraints||/map/metadata at wfs_accessconstraints||
-||/tinyows/layer at ns_prefix||/map/layer/metadata at wfs_namespace_prefix or /map/metadata at wfs_namespace_prefix||
-||/tinyows/layer at ns_uri||/map/layer/metadata at wfs_namespace_uri or /map/metadata at wfs_namespace_uri||
-||/tinyows/layer at name||/map/layer at name||
-||/tinyows/layer at title||/map/layer/metadata at wfs_title||
-||/tinyows/layer at retrievable||/map/layer/metadata at tinyows_retrievable and /map/layer at dump||
-||/tinyows/layer at writable||/map/layer/metadata at tinyows_writable and /map/layer at dump||
-||/tinyows/layer at schema||/map/layer/metadata at tinyows_schema||
-||/tinyows/layer at keywords||/map/layer/metadata at wfs_keywordlist||
-||/tinyows/layer/abstract||/map/layer/metadata at wfs_abstract||
-||/tinyows/layer at srid||/map/metadata at wfs_srs and /map/layer/metadata at wfs_srs||
-||/tinyows/layer at geobbox||/map/layer/metadata at tinyows_geobbox||
-||/tinyows/contact at name||/map/metadata at ows_contactorganization||
-||/tinyows/contact at site||
-||/tinyows/contact at email||/map/metadata at ows_contactelectronicmailaddress||
-||/tinyows/contact at individual_name||/map/metadata at ows_contactperson||
-||/tinyows/contact at position||/map/metadata at ows_contactposition||
-||/tinyows/contact at phone||/map/metadata at ows_contactvoicetelephone||
-||/tinyows/contact at fax||/map/metadata at ows_contactfacsimiletelephone||
-||/tinyows/contact at online_resource||
-||/tinyows/contact at address||/map/metadata at ows_address||
-||/tinyows/contact at city||/map/metadata at ows_city||
-||/tinyows/contact at administrative_area||
-||/tinyows/contact at country||/map/metadata at ows_country||
-||/tinyows/contact at hours_of_service||
-||/tinyows/contact at contact_instructions ||
+Mapfile path of each TinyOWS config element
+-------------------------------------------
 
+====================================== ==========================================================
+Original TinyOWS XML Config File       Mapfile counterpart
+====================================== ==========================================================
+/tinyows\@online_resource               /map/metadata\@tinyows_onlineresource
+/tinyows\@schema_dir                    /map/metadata\@tinyows_schema_dir
+/tinyows\@log                           /map/metadata\@tinyows_log
+/tinyows\@log_level                     /map/metadata\@tinyows_log_level
+/tinyows\@degree_precision              /map/metadata\@tinyows_degree_precision
+/tinyows\@meter_precision               /map/metadata\@tinyows_meter_precision
+/tinyows\@display_bbox                  /map/metadata\@tinyows_display_bbox
+/tinyows\@estimated_extent              /map/metadata\@tinyows_estimated_extent
+/tinyows\@check_schema                  /map/metadata\@tinyows_check_schema
+/tinyows\@check_valid_geom              /map/metadata\@tinyows_check_valid_geom
+/tinyows\@encoding                      /map/metadata\@wfs_encoding
+/tinyows\@db_encoding                   /map/metadata\@tinyows_db_encoding
+/tinyows\@expose_pk                     /map/metadata\@tinyows_expose_pk
+/tinyows/limits\@features               /map/metadata\@wfs_maxfeatures
+/tinyows/limits\@geobbox                /map/metadata\@tinyows_geobbox
+/tinyows/pg\@host                       /map/layer\@connection
+/tinyows/pg\@user                       /map/layer\@connection
+/tinyows/pg\@password                   /map/layer\@connection
+/tinyows/pg\@dbname                     /map/layer\@connection
+/tinyows/pg\@port                       /map/layer\@connection
+/tinyows/pg\@encoding                   /map/metadata\@tinyows_db_encoding
+/tinyows/metadata\@name                 /map\@name
+/tinyows/metadata\@title                /map/metadata\@wfs_title
+/tinyows/metadata\@keywords             /map/metadata\@wfs_keywordlist
+/tinyows/metadata/abstract             /map/metadata\@wfs_abstract
+/tinyows/metadata\@fees                 /map/metadata\@wfs_fees
+/tinyows/metadata\@access_constraints   /map/metadata\@wfs_accessconstraints
+/tinyows/layer\@ns_prefix               /map/layer/metadata\@wfs_namespace_prefix or /map/metadata\@wfs_namespace_prefix
+/tinyows/layer\@ns_uri                  /map/layer/metadata\@wfs_namespace_uri or /map/metadata\@wfs_namespace_uri
+/tinyows/layer\@name                    /map/layer\@name
+/tinyows/layer\@title                   /map/layer/metadata\@wfs_title
+/tinyows/layer\@retrievable             /map/layer/metadata\@tinyows_retrievable and /map/layer\@dump
+/tinyows/layer\@writable                /map/layer/metadata\@tinyows_writable and /map/layer\@dump
+/tinyows/layer\@schema                  /map/layer/metadata\@tinyows_schema
+/tinyows/layer\@keywords                /map/layer/metadata\@wfs_keywordlist
+/tinyows/layer/abstract                /map/layer/metadata\@wfs_abstract
+/tinyows/layer\@srid                    /map/metadata\@wfs_srs and /map/layer/metadata\@wfs_srs
+/tinyows/layer\@geobbox                 /map/layer/metadata\@tinyows_geobbox
+/tinyows/contact\@name                  /map/metadata\@ows_contactorganization
+/tinyows/contact\@site
+/tinyows/contact\@email                 /map/metadata\@ows_contactelectronicmailaddress
+/tinyows/contact\@individual_name       /map/metadata\@ows_contactperson
+/tinyows/contact\@position              /map/metadata\@ows_contactposition
+/tinyows/contact\@phone                 /map/metadata\@ows_contactvoicetelephone
+/tinyows/contact\@fax                   /map/metadata\@ows_contactfacsimiletelephone
+/tinyows/contact\@online_resource
+/tinyows/contact\@address               /map/metadata\@ows_address
+/tinyows/contact\@city                  /map/metadata\@ows_city
+/tinyows/contact\@administrative_area
+/tinyows/contact\@country               /map/metadata\@ows_country
+/tinyows/contact\@hours_of_service
+/tinyows/contact\@contact_instructions 
+====================================== ==========================================================
 
 
 
+

Modified: trunk/docs/en/tinyows/openlayershowtobasic.txt
===================================================================
--- trunk/docs/en/tinyows/openlayershowtobasic.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/openlayershowtobasic.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -1,7 +1,7 @@
 .. _tinyows_openlayershowtobasic:
 
 *****************************************************************************
-WFS with TinyOWS and OpenLayers 
+Sample: WFS with TinyOWS and OpenLayers 
 *****************************************************************************
 
 

Modified: trunk/docs/en/tinyows/openlayershowtotransactional.txt
===================================================================
--- trunk/docs/en/tinyows/openlayershowtotransactional.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/openlayershowtotransactional.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -1,7 +1,7 @@
 .. _tinyows_openlayershowtotransactional:
 
 *****************************************************************************
-WFS-T with TinyOWS and OpenLayers 
+Sample: WFS-T with TinyOWS and OpenLayers 
 *****************************************************************************
 
 

Modified: trunk/docs/en/tinyows/serverinstallation.txt
===================================================================
--- trunk/docs/en/tinyows/serverinstallation.txt	2012-02-08 23:23:30 UTC (rev 13105)
+++ trunk/docs/en/tinyows/serverinstallation.txt	2012-02-08 23:31:59 UTC (rev 13106)
@@ -9,7 +9,7 @@
 
 Requires
 -----------------------------------------------------------------------------
-TinyOWS need following librairies/applications:
+TinyOWS need following libraries/applications:
  * LibXML2 (2.6.20 version or later)
  * PostGIS (1.5.x version or later)
  * PostgreSQL (with libpq headers)
@@ -19,7 +19,7 @@
 Installing from a stable source release
 ~~~~~~~~~~~~~~~~~~~~~~
 
-An example of a typical download, configure, make, make install
+An example of a typical download, configure, make, make install:
 
   ::
 
@@ -31,13 +31,12 @@
     [user at host mapserver]$ make install
     [user at host mapserver]$ make install-demo
 
-And then copy tinyows binary in your cgi-bin directory
+Then copy the ``tinyows`` binary to your cgi-bin directory.
 
-Installing from SVN
+Installing the Current Trunk from SVN
 ~~~~~~~~~~~~~~~~~~~~~~
-Build from SVN need also following librairies/applications:
- * autoconf
- * SVN client
+To build from SVN, you must first install the ``autoconf`` utility,
+and a Subversion client.
 
   ::
 
@@ -49,7 +48,7 @@
     [user at host mapserver]$ make install
     [user at host mapserver]$ make install-demo
 
-And then copy tinyows binary in your cgi-bin directory
+Then copy the ``tinyows`` binary to your cgi-bin directory.
 
 Installing from SVN on Windows
 ~~~~~~~~~~~~~~~~~~~~~~



More information about the mapserver-commits mailing list