From 8b169ecb006b9db6d25479130cc02aed9f5044c7 Mon Sep 17 00:00:00 2001
From: robin <binkrassdufass@gmail.com>
Date: Sat, 10 Jun 2023 13:11:58 +0000
Subject: [PATCH] more doc

---
 docs/md/projektkonfig/collections/meta.md | 22 ++++++++++-
 docs/md/projektkonfig/dashboard.md        | 45 ++++++++++++++++++-----
 2 files changed, 55 insertions(+), 12 deletions(-)

diff --git a/docs/md/projektkonfig/collections/meta.md b/docs/md/projektkonfig/collections/meta.md
index 82472c8..ad34e87 100644
--- a/docs/md/projektkonfig/collections/meta.md
+++ b/docs/md/projektkonfig/collections/meta.md
@@ -28,11 +28,29 @@ Folgende möglche Einträge für `views` gibt es derzeit:
 
 ### dashboardSimpleList
 
--   TODO
+Fürs dashboard type: table
+
+```yml
+type: dashboardSimpleList
+mediaQuery: "(max-width: 600px)"
+primaryText: email
+secondaryText: subject
+```
 
 ### dashboardTable
 
--   TODO
+Fürs dashboard type: table
+
+```yml
+type: dashboardTable
+mediaQuery: "(min-width: 600px)"
+columns:
+    - subject
+    - file
+    - file
+    - subject
+    - file
+```
 
 ## tablist
 
diff --git a/docs/md/projektkonfig/dashboard.md b/docs/md/projektkonfig/dashboard.md
index 856420d..765cece 100644
--- a/docs/md/projektkonfig/dashboard.md
+++ b/docs/md/projektkonfig/dashboard.md
@@ -8,23 +8,24 @@ Die bereitgestellte Konfiguration ist eine Spezifikation für ein Dashboard-Layo
 
 ## type
 
-Der Typ des Dashboard-Elements ist ein entscheidendes Attribut. 
-- ˋgraphˋ:
+Der Typ des Dashboard-Elements ist ein entscheidendes Attribut.
+
+-   ˋgraphˋ:
     Wenn der Typ "graph" ist, wird das Element als Diagramm dargestellt. Dies ermöglicht eine Vielzahl von Visualisierungen wie Linien-, Balken-, Kuchen-, Donut- oder Flächendiagramme, abhängig vom graphType.
 
-- ˋswiperˋ:
+-   ˋswiperˋ:
     Der Typ "swiper" erstellt ein Karussell-ähnliches Element, das eine Reihe von anderen Elementen enthält, die durchgeblättert werden können. Jedes Element innerhalb des "swiper"-Typs wird genauso konfiguriert wie ein normales Dashboard-Element, was bedeutet, dass sie jeweils ihren eigenen type, title, etc. haben können.
 
-- ˋreferenceˋ:
+-   ˋreferenceˋ:
     Die "reference"-Typ Elemente sind Verweise auf Collections.
 
-- ˋcomparisonˋ:
-    Außerdem gibt es den type "comparison", wobei man ein timespan auswählt und dieser timespan und der timespan davor mit einander auf einen bestimmten Wert verglichen werden. 
+-   ˋcomparisonˋ:
+    Außerdem gibt es den type "comparison", wobei man ein timespan auswählt und dieser timespan und der timespan davor mit einander auf einen bestimmten Wert verglichen werden.
 
-- ˋtableˋ:
-    Desweiteren gibt es einen type "table" wobei mit dem limit attribut gesetzt wird wie viele Einträge von der ausgewählten collection Angezeigt werden sollen. 
+-   ˋtableˋ:
+    Desweiteren gibt es einen type "table" wobei mit dem limit attribut gesetzt wird wie viele Einträge von der ausgewählten collection Angezeigt werden sollen.
 
-- ˋsectionTitleˋ
+-   ˋsectionTitleˋ
     Der "sectionTitle" type ist wie der name schon sagt, ein Titel für einen Abschnitt vom dashboard
 
 ## title
@@ -36,6 +37,7 @@ Der Titel eines Elements ist ein Objekt, das einen eval, value, contentBefore un
 Dies ist ein Untertitel für das Dashboard-Element.
 
 ## limit
+
 Eine Zahl, welche beim type table dafür genutzt wird, anzugeben, wie viele Einträge angezeigt werden sollen
 
 ## graphType
@@ -138,6 +140,10 @@ Dieses Feld kann verwendet werden, um den genauen Pfad zu der spezifischen Daten
 
 Dies ist das Feld, das den Zeitstempel in der Datensammlung repräsentiert. Es wird verwendet, um die Zeitskala für das Diagramm zu liefern. Hier ist das erwünschte Datumsfeld in der collection auszuwählen.
 
+## limit
+
+gibt an wie viele Elemente maximal returned werden sollen.
+
 # Code Beispiel
 
 ```yaml
@@ -217,6 +223,7 @@ dashboard:
                 field: paymentValue
                 title: toller titel #string or eval
                 subTitle: { de: "YTD Vergleich zum Vorjahr", en: "YTD comparison with last year" }
+
         - type: sectionTitle
           title: "Details"
 
@@ -354,6 +361,7 @@ dashboard:
                       dateTimeField: Date
                       field: paymentValue
                       collection: contact_form
+
         - containerProps:
               #optional class prop
               layout:
@@ -370,7 +378,6 @@ dashboard:
           subTitle: { de: "Umsatz", en: "sales volume" }
           xAxis: timeline
           timeInterval: "day"
-
           graphType: "area" # Art des Graphen, hier ein Flächendiagramm
           graphs:
               - field: paymentValue
@@ -423,6 +430,23 @@ dashboard:
                       dateTimeField: Date # Feld für den Zeitstempel der Daten
                       path: "this" # Pfad zu den Daten im Feld, hier das aktuelle Objekt
                       graphName: { de: "Umsatz", en: "sales volume" } # Name des Graphen, mehrsprachig
+        - type: table #shows entries from specified collection
+          containerProps:
+              #optional class prop
+              layout:
+                  breakBefore: false
+                  breakAfter: true
+                  size:
+                      default: "col-8"
+                      small: "col-12"
+                      large: "col-7"
+
+          # uses dashboardTable and dashboarSimpleList inside the collection
+          collection: contact_form
+          title: Konaktformular Titel
+          subTitle: subtitel oder so
+          limit: 4 #maximum of returned entries
+
         - collection: content # Sammlung, aus der die Daten für das nächste Element stammen
           type: reference # Art des Elements, hier ein Referenz-Element
           style: # Stil des Elements
@@ -438,6 +462,7 @@ dashboard:
           style:
               upper: rgba(3, 50, 59, 0.7)
               lower: rgba(3, 50, 59)
+
     minorItems: # Liste der Nebenelemente des Dashboards
         - collection: contact_form # Referenz auf collections
         - collection: contact_form # Wiederholung der vorherigen Nebenelemente