[PATCH] Datacage ref doc: More doc for functions

[Wald Commits]

# HG changeset patch
# User Sascha L. Teichmann <teichmann at intevation.de>
# Date 1382447244 -7200
# Node ID 0e56d7b4b38cfd78c6cddcf6671c834955944a6b
# Parent  24a1b6b2fc7f63f2f629307078031a00f4ca9870
Datacage ref doc: More doc for functions.

diff -r 24a1b6b2fc7f -r 0e56d7b4b38c artifacts/doc/datacage_ref_de.rst
--- a/artifacts/doc/datacage_ref_de.rst	Tue Oct 22 12:21:21 2013 +0200
+++ b/artifacts/doc/datacage_ref_de.rst	Tue Oct 22 15:07:24 2013 +0200
@@ -339,6 +339,8 @@
 realisiert werden. Nach Verlassen des `dc:filter`-Elementes ist wieder der vormalige
 Datensatz aktuell.
 
+.. _dc:group:
+
 ``dc:group`` Datensätzen in Gruppen ordnen
 ..........................................
 
@@ -646,24 +648,57 @@
 Datenkorb-Funktionen
 --------------------
 
-``dc:contains`` **TODO**
+``dc:has-result`` Prüfen, ob der aktuelle Datensatz nicht leer ist
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``dc:has-result()`` liefert logisch wahr zurück, falls der aktuelle
+Datensatz nicht leer ist, sprich Datenzeilen enthält. Ansonsten wird
+logisch falsch zurück gegeben. Mittels dieser Funktion können leere
+Knoten im Resultatdokument verhindert werden. Die typische Nutzung
+ist daher innerhalb des ``test``-Attributs eines ``<dc:if>``-Elements.
+
+``dc:contains`` Prüfen, ob Suchbegriff in einer Liste vorhanden ist
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``dc:contains(Nadel, Heuhaufen)`` prüft ob das Suchobjekt Nadel in
+der Liste Heufhaufen zu finden ist. Liefert logisch wahr falls die
+Nadel gefunden wurde, ansonsten logisch falsch. Typischer Anwendungsfall:
+``dc:contains($outs, 'longitudinal-section')`` prüft, ob in der Liste
+der aktuellen Outs der Eintrag 'longitudinal-section' zu finden ist.
+
+``dc:replace`` Textersatz in Strings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``dc:replace(Heuhaufen, Nadel, Ersatz)`` ersetzt in im String Heuhaufen alle
+Vorkommen des Strings Nadel durch den String Ersatz. ``dc:replace('Banane', 'a', 'e')``
+resultiert folglich in dem String ``Benene``.
+
+``dc:replace-all`` Textersatz in Strings mit regulären Ausdrücken
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``dc:replace-all(Heuhaufen, Nadel, Ersatz)`` ersetzt in im String Heuhaufen alle
+Vorkommen des regulären Ausdrucks durch den String Ersatz. Auf im regulären Ausdruck
+gebildete Gruppen ``()`` kann mit ``$1``, ``$2``, ``$3`` usw. im Ersatztext zurückgegriffen werden.
+``dc:replace-all('KlausGabiPeter', '(Klaus|Peter)', '>$1<')`` resultiert demnach
+in ``>Klaus<Gabi>Peter<``.
+
+``dc:group-key`` Wert des aktuellen Gruppierungsschlüssels
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Siehe hierzu `dc:group`_.
+
+``dc:dump-variables`` Aktuelle Variablenbelegung als String
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``dc:dump-variables()`` liefert einen String mit der aktuellen Belegung aller Variablen.
+Dies ist zusammen mit ``dc:message`` nützlich, um eine Ablaufverfolgung zu implementieren.
 
 ``dc:fromValue`` **TODO**
 
 ``dc:toValue`` **TODO**
 
-``dc:replace`` **TODO**
-
-``dc:replace-all`` **TODO**
-
-``dc:has-result`` **TODO**
-
-``dc:group-key`` **TODO**
-
 ``dc:date-format`` **TODO**
 
-``dc:dump-variables`` **TODO**
-
 ``dc:get`` **TODO**
 
 ``dc:max-number`` **TODO**