# HG changeset patch
# User Sascha L. Teichmann <sascha.teichmann@intevation.de>
# Date 1346021855 0
# Node ID 0b0522bf51b652282d2d2dfd277a5e5da25368a1
# Parent  70c41c5493b6678c509f0d461e14aebbdd9079ea
backend: Importer: Documented which hydrological files are taken into account.

flys-backend/trunk@5269 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 70c41c5493b6 -r 0b0522bf51b6 flys-backend/ChangeLog
--- a/flys-backend/ChangeLog	Sun Aug 26 19:17:56 2012 +0000
+++ b/flys-backend/ChangeLog	Sun Aug 26 22:57:35 2012 +0000
@@ -1,4 +1,8 @@
-2012-08-24	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
+2012-08-27	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
+
+	* doc/README.txt: Documented which hydrological files are taken into account.
+
+2012-08-26	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
 
 	* doc/README.txt: Documented the classification of the annotations.
 
diff -r 70c41c5493b6 -r 0b0522bf51b6 flys-backend/doc/README.txt
--- a/flys-backend/doc/README.txt	Sun Aug 26 19:17:56 2012 +0000
+++ b/flys-backend/doc/README.txt	Sun Aug 26 22:57:35 2012 +0000
@@ -46,6 +46,9 @@
 - Pegel, Stammdaten (*.glt, *.sta-Dateien):
   Der Import kann mit '-Dflys.backend.importer.skip.gauges=true'
   unterdrückt werden.
+  Die .glt-Datei, die neben der .wst-Datei liegt, wird zuerst
+  ausgelesen. Es werden nur *.sta-Datei von Pegeln geladen, die
+  in der .glt-Datei vermerkt sind.
 
   Wenn "-Dflys.backend.sta.parse.gauge.numbers=true' wird versucht,
   die offiziellen Pegelnummern aus den Stammdaten zu extrahieren.
@@ -63,30 +66,48 @@
 - Zusätzliche Längsschnitte (*.zus, *.wst-Dateien)
   Der Import kann mit '-Dflys.backend.importer.skip.extra.wsts=true'
   unterdrückt werden.
+  Es werden die *.zus- und *.wst-Dateien aus dem Verzeichnis
+  "../Zus.Längsschnitte" relativ zur gewaesser.wst-Datei betrachtet.
 
 - Fixierungen (*.wst-Dateien)
   Der Import kann mit '-Dflys.backend.importer.skip.fixations=true'
   unterdrückt werden.
+  Es werden die *.wst-Dateien aus dem Verzeichnis
+  "../Fixierungen" relativ zur gewaesser.wst-Datei betrachtet.
 
 - Amtliche Linien (*.wst-Dateien)
   Der Import kann mit '-Dflys.backend.importer.skip.official.lines=true'
   unterdrückt werden.
+  Es werden die "Amtl_Linien.wst"-Dateien aus dem Verzeichnis
+  "../Basisdaten" und "../Fixierungen" relativ zur gewaesser.wst-Datei betrachtet.
 
 - Profilspuren (*.prf-Dateien)
   Der Import kann mit '-Dflys.backend.importer.skip.prfs=true'
   unterdrückt werden.
+  Es werden rekursiv alle *.prf-Dateien aus "../../.." relativ
+  zur gewaesser.wst-Datei betrachtet. Vor dem Import werden
+  mithilfe eines Längen- und eines MD5-Summen-Vergleichs
+  inhaltliche Duplikate ausgeschlossen.
 
 - Hydraulische Kennzahlen (*.hyk)
   Der Import kann mit '-Dflys.backend.importer.skip.hyks=true'
   unterdrückt werden.
+  Es werden rekursiv alle *.hyk-Dateien aus "../../.." relativ
+  zur gewaesser.wst-Datei betrachtet. Vor dem Import werden
+  mithilfe eines Längen- und eines MD5-Summen-Vergleichs
+  inhaltliche Duplikate ausgeschlossen.
 
-- Hochwassermarken (*.zus)
+- Hochwassermarken (*.zus, *.wst)
   Der Import kann mit '-Dflys.backend.importer.skip.flood.water=true'
   unterdrückt werden.
+  Es werden die *.zus- und *.wst-Dateien aus dem Verzeichnis
+  "../HW-Marken" relativ zur gewaesser.wst-Datei betrachtet.
 
 - Hochwasserschutzanlagen (*.zus)
   Der Import kann mit '-Dflys.backend.importer.skip.flood.protection=true'
   unterdrückt werden.
+  Es werden die *.zus- und *.wst-Dateien aus dem Verzeichnis
+  "../HW-Schutzanlagen" relativ zur gewaesser.wst-Datei betrachtet.
 
   TODO INGO: