changeset 1029:a5e0384fe464

Do some Documentation of the Artifact-Database gnv-artifacts/trunk@1056 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 04 May 2010 14:24:23 +0000
parents 41234fcf4c7e
children c07d9f9a738c
files gnv-artifacts/ChangeLog gnv-artifacts/doc/conf/conf.xml
diffstat 2 files changed, 13 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog	Tue May 04 12:40:21 2010 +0000
+++ b/gnv-artifacts/ChangeLog	Tue May 04 14:24:23 2010 +0000
@@ -1,5 +1,9 @@
 2010-05-04  Tim Englich  <tim.englich@intevation.de>
 
+	* doc/conf/conf.xml: 
+	  Do some Documentation of the Artifact-Database.
+
+2010-05-04  Tim Englich  <tim.englich@intevation.de>
 	* src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java (appendSelectProducts): 
 	  BUGFIX: Added NULL-Check to Variable products to prevent NPEs if
 	  no Products are configured to the FIS.
--- a/gnv-artifacts/doc/conf/conf.xml	Tue May 04 12:40:21 2010 +0000
+++ b/gnv-artifacts/doc/conf/conf.xml	Tue May 04 14:24:23 2010 +0000
@@ -3,6 +3,8 @@
     <factories>
         <context-factory>de.intevation.gnv.artifacts.context.GNVArtifactContextFactory</context-factory>
         <artifact-factories>
+            <!-- All Artifactfactories which are available in this Database. 
+                 Each Artifactfactory represents one FIS. -->
             <artifact-factory name="fis_marnet" description="Factory to create an artifact to be used with the FIS Marnet"  
                               ttl="3600000" artifact="de.intevation.artifactdatabase.ProxyArtifact">de.intevation.gnv.artifacts.GNVProductArtifactFactory</artifact-factory>
             <artifact-factory name="fis_imis" description="Factory to create an artifact to be used with the FIS IMIS"  
@@ -43,6 +45,7 @@
                               ttl="3600000" artifact="de.intevation.artifactdatabase.ProxyArtifact">de.intevation.gnv.artifacts.GNVProductArtifactFactory</artifact-factory>
         </artifact-factories>
         <service-factories>
+            <!-- The Servicefactory which is responsible to handle MV-GNV-Interface-Calls -->
             <service-factory
                 name="metadata"
                 service="de.intevation.gnv.artifacts.services.MetaDataService"
@@ -498,7 +501,7 @@
 
         <!-- In this section the required Configuration for mapfile generation is
              given. -->
-            <map-generator>
+        <map-generator>
             <mapfile path="${artifacts.config.dir}/../mapfiles/mapfile.map" />
             <templates>
                 <path>${artifacts.config.dir}/maptemplates</path>
@@ -508,10 +511,13 @@
     </gnv>
 
     <mapserver>
+       <!-- This Section configures the required Informations to provide the 
+            WMS-Exports -->
         <server path="http://denmark.atlas/cgi-bin/mapserv" />
     </mapserver>
 
     <velocity>
+        <!-- This Section configures all required settings for velocity. -->
         <logfile path="/var/log/artifacts/velocity.log" />
     </velocity>
 
@@ -540,6 +546,8 @@
         <sleep-time>60000</sleep-time>
     </cleaner>
     <database>
+        <!-- This Section configures the Settings for connecting to the 
+             Artifact-Database instance. e.g. SQLite -->
         <user>SA</user>
         <password></password>
         <url>jdbc:h2:${artifacts.config.dir}/../artifactdb/artifacts.db</url>

http://dive4elements.wald.intevation.org