Document existing utilities and modules

src/index.md

@@ -0,0 +1,95 @@
+Utils, Utils.*
+  : Hilfsfunktionionen _unabhängig von Foundation_
+  
+Utils
+  : Yesod Hilfsfunktionen und Instanzen, Text-HTML-Widget-Konvertierungen
+    (`DisplayAble`), Crud, `NTop`, Utility-Funktionen für `MonadPlus`, `Maybe`,
+    `MaybeT`, `Map`, und Attrs-Lists
+    
+Utils.TH
+  : Template Haskell code-generatoren von unabhängigen Hilfsfunktionen (`deriveSimpleWith`)
+  
+Utils.DB
+  : Derived persistent functions (`existsBy`, `getKeyBy404`, ...)
+  
+Utils.Form
+  : `renderAForm`, Field-Settings helper, `FormIdentifier`, `Button`-Klasse,
+    unabhängige konkrete Buttons
+    
+Utils.PathPiece
+  : (Template-Haskell)-Hilfsfunktionen für Formulierung von PathPiece-Instanzen
+    
+Utils.Lens
+  : Automatisch erzeugt Linsen für eigene und Yesod-Typen, `Control.Lens`-Export
+  
+Utils.DateTime
+  : Template Haskell code-generatoren zum compile-time einbinden von Zeitzone
+    und `TimeLocale`
+  
+Handler.Utils, Handler.Utils.*
+  : Hilfsfunktionien, importieren `Import`
+  
+Handler.Utils
+  : `Handler.Utils.*`, Unsortierte _Foundation-abhängige_ Hilfsfunktionen
+  
+Handler.Utils.DateTime
+  : Nutzer-spezifisches `DateTime`-Formatieren
+
+Handler.Utils.Form
+  : Konkrete Buttons, spezielle Felder (inkl. Datei-Upload-Felder),
+    Optionslisten (`optionsPersistCryptoId`), `forced`-Felder (erzwungenes
+    Ergebnis, deaktiviertes Feld), `multiAction`
+    
+Handler.Utils.Rating
+  : `Rating` (kodiert eine Rating-Datei), Parsen und PrettyPrinten von
+    Rating-Dateien
+    
+Handler.Utils.Sheet
+  : `fetchSheet`
+  
+Handler.Utils.StudyFeatures
+  : Parsen von LDAP StudyFeatures-Strings
+  
+Handler.Utils.Submission
+  : `assignSubmissions`, `sinkSubmission` State-Maschinen die (bereits geparste)
+    ZIP-Archive auseinandernehmen und (in einer Transaction) in die Datenbank
+    speichern
+    
+Handler.Utils.Submission.TH
+  : Template Haskell zum parsen und einkompilieren von Dateiname-Blacklist für
+    `sinkSubmission`; Patterns in `config/submission-blacklist`
+    
+Handler.Utils.Table
+  : Hilfsfunktion zum direkten Benutzen von Colonnade (kein `dbTable`)
+  
+Handler.Utils.Table.Pagination
+  : Here be Dragons
+  
+    Paginated database-backed tables with support for sorting, filtering,
+    numbering, forms, further database-requests within cells
+    
+    Includes helper functions for mangling pagination-, sorting-, and filter-settings
+    
+    Includes helper functions for constructing common types of cells
+  
+Handler.Utils.Table.Pagination.Types
+  : `Sortable`-Headedness for colonnade
+  
+Handler.Utils.Templates
+  : Modals
+  
+Handler.Utils.Term
+  : Formularfelder für Terms
+  
+Handler.Utils.Zip
+  : Conduit-basiertes ZIP Parsen und Erstellen
+  
+Handler.Common
+  : Handler aus dem Scaffolding; Implementierungen von Handlern, die _jede
+    Website_ irgendwann braucht
+    
+CryptoID
+  : Definiert CryptoIDs für custom Typen (aus Model)
+  
+Model.Migration
+  : Manuelle Datenbank-Migration