[PATCH] More datacage ref doc

[Wald Commits]

# HG changeset patch
# User Sascha L. Teichmann <teichmann at intevation.de>
# Date 1382029004 -7200
# Node ID e07dc8854a8f2fbdcefb4b487b19a8eff233f026
# Parent  aff189df381b15399295da36ef3f6cb1e0f007ad
More datacage ref doc.

diff -r aff189df381b -r e07dc8854a8f artifacts/doc/datacage_ref_de.rst
--- a/artifacts/doc/datacage_ref_de.rst	Thu Oct 17 18:37:56 2013 +0200
+++ b/artifacts/doc/datacage_ref_de.rst	Thu Oct 17 18:56:44 2013 +0200
@@ -8,6 +8,51 @@
 Übersicht
 ---------
 
+Der Datenkorb ist im Kern ein Dive4Elements/River eingebetteter Webdienst,
+der dazu dient, ein XML-Dokument zu generieren, das seinerseits benutzt
+werden kann, um Daten so identifizierbar zu machen, dass sie zu
+Projekten innerhalb von Dive4Elements/River hinzugeladen werden können.
+
+Das vom Datenkorb erzeugte XML-Dokument wird dann vom D4E/River-Client in
+eine Baumansicht innerhalb der graphischen Benutzeroberfläche
+transformiert.
+
+Die Grundlage für das XML-Doument, das an die Oberfäche gesandt wird,
+ist ein XML-Dokument namens ``meta-data.xml``, das im ``conf``-Verzeichnis
+des Servers als Template für die Ausgabe-XML benutzt wird.
+
+Dieses Referenzhandbuch beschreibt die Strukturen innerhalb von
+``metadata.xml``.
+
+Grundstruktur
+-------------
+
+Das Grundgerüst einer validen ``meta-data.xml`` sieht sieh so aus:
+
+.. code:: xml
+
+  <xml version="1.0" encoding="UTF-8">
+  <dc:template xmlns:dc="http://www.intevation.org/2011/Datacage">
+    <datacage>
+       ...
+    </datacage>
+  </dc:template>
+
+Dies erzeugt folgendes Dokument:
+
+.. code:: xml
+
+  <xml version="1.0" encoding="UTF-8">
+  <datacage>
+       ...
+  </datacage>
+
+Elemente, die nicht aus dem Namespace ``dc`` stammen, werden durchkopiert.
+``dc``-Elemente dienen der Steuerung des Templating. Generell kann sagen,
+dass das ``meta-data.xml``-Template mittels einer
+rekursiven Tiefensuche (siehe http://de.wikipedia.org/wiki/Tiefensuche)
+über seine Elemente abgearbeitet wird.
+
 Daten
 -----
 Im Datenkorb stehen zwei Arten von Daten zur Auswertung zur Verfügung.
@@ -18,7 +63,6 @@
 erzeugt und in einem Stapel verwaltet. Die konkreten Werte stehen erst durch
 Auffaltung als Variablen zur Verfügung.
 
-
 ``Variablen``
 ~~~~~~~~~~~~~
 Variablen sind die Werte, die aktuell zur Auswertung zur Verfügung stehen. Sie haben
@@ -95,7 +139,10 @@
 der dort definierten Datenbank geholt. Die Spaltennamen der Projektion des SQL-Statements
 werden übernommen und später beim Auffalten des Datensatzes benutzt.
 
-``dc:container-context`` **TODO**
+``dc:container-context`` Tabellarische Daten aus der Programm-Umgebung
+......................................................................
+
+**TODO**
 
 ``dc:properties`` **TODO**