newsletter

admin/content/2-installation.typ

@@ -145,9 +145,8 @@ Um die Konfiguration mittels ENV-Variablen an die Anwendungen weitergeben zu kö
 Die env-Datei im Frontend muss vor dem build-Prozess erstellt sein, da dort die Werte fest in den Code übernommen werden. Weiterhin muss die Datei im Frontend `.env.production` heißen. Die bestehende Datei kann modifiziert werden. Bei einer Änderung muss die App neu gebaut werden.
 
 Die env-Datei im Backend muss vor der Ausführung von `npm run start` angelegt sein. Bei einer Änderung der Einträge muss der Server lediglich neu gestartet werden.
-
-#pagebreak()
-
+\
+\
 *App*
 ```sh
 git clone https://forgejo.jk-effects.cloud/Ehrenamt/ff-admin.git
@@ -268,4 +267,8 @@ Informationen zu neuen Versionen können innerhalb der App im Account des Eigent
 Die Releases beinhalten Informationen zu einem Update und was zu beachten ist. So enthalten die Release-Informationen beispielsweise Vorbereitungen vor einem Update.
 \
 \
-Bei Verwendung mittels Git, müssen die Repos neu bezogen werden. Anschließend müssen die Dependencies neu installiert und die Anwendungen neu gebaut werden.
+Bei Verwendung mittels Git, müssen die Repos neu bezogen werden. Anschließend müssen die Dependencies neu installiert und die Anwendungen neu gebaut werden.
+
+== WebApp
+
+FF Admin ist als WebApp verfügbar. Dadurch lässt sich die Anwendung auf einem Smartphone oder Desktop über den Browser installieren.

admin/content/4-modules/3-protocol.typ

@@ -26,4 +26,4 @@ Jedes Protokoll kann gedruckt werden. Die erstellten pdf-Dateien können herunte
 *Hinweis:* Die Wolke in der rechten oberen Ecke zeigt den Status der Synchronisation an. Durch Klicken auf eine Wolke mit einem Pfeil kann die Synchronisation manuell durchgeführt werden. Ansonsten wird alle 10 Sekunden synchronisiert.
 \
 \
-*Hinweis:* Ein Protokoll kann derzeit nicht kollaborativ geschrieben werden. Bei paralleler Arbeit am Protokoll überschreiben sich die Status der Bearbeiter immer gegenseitig.
+*Hinweis:* Ein Protokoll kann derzeit nicht kollaborativ geschrieben werden. Bei paralleler Arbeit am Protokoll überschreiben sich die Inhalte der Bearbeiter immer gegenseitig.

admin/content/4-modules/4-newsletter.typ

@@ -1 +1,31 @@
-== Newsletter
+#import "@preview/wrap-it:0.1.1": *
+
+== Newsletter
+
+#figure(
+  image("../../images/newsletter-overview.png", width: 100%),
+)
+Ein weiteres Modul ermöglicht den Versand von Newslettern. Die Newsletter können per E-Mail versendet oder als PDF exportiert werden. Die Newsletter können mit eigenen Texten und Terminen gestaltet werden.
+\
+\
+Ein Newsletter kann mit einem Titel und einer Zusammenfassung beschrieben werden. Diese Inhalte sind nicht direkt in den Exporten enthalten und dienen in erster Linie der besseren Übersicht.
+
+Die *Daten*, die für einen Newsletter angegeben werden können, sind eine Überschrift, ein (Einleitungs-)Text und eine Signatur.
+
+Zusätzlich können *Termine* ausgewählt werden, die dann direkt im Newsletter aufgelistet werden. Für jeden Termin können Titel und Beschreibung geändert werden. Dient ein Newsletter der reinen Informationsvermittlung, kann der Text verwendet werden. Es müssen keine Termine hinzugefügt werden.
+
+Die *Empfänger* des Newsletters können automatisiert über Abfragen (@query) erfasst werden. Die Empfänger werden dann mit ihrem bevorzugten Empfangs-Kommunikationskanal angezeigt. Die Empfänger werden aus der Abfrage anhand einer vorhandenen `memberId` oder `id` Spalte ermittelt. 
+
+Zusätzlich können Empfänger manuell hinzugefügt werden, wenn diese nicht in der Abfrage enthalten sind.
+
+Der *Export* kann als pdf oder als Mailversand erfolgen. Jedes Mitglied, das eine Mailadresse für den Empfang angegeben hat, erhält eine Mail mit dem Hauptteil des Newsletters. Für alle anderen wird ein PDF erzeugt. Das PDF enthält in der Fußzeile den Namen und optional eine Adresse, falls eine solche für den Versand des Newsletters beim Mitglied angegeben ist.
+
+Um den Ausdruck zu vereinfachen, werden alle erzeugten PDFs in einem einzigen PDF zusammengefasst.
+
+Zusätzlich wird eine ICS-Datei erstellt, die alle Termine enthält, die dem Newsletter hinzugefügt wurden. Diese wird ebenfalls direkt mit der Mail versendet. Zusätzlich wird noch ein PDF erstellt, welches in der Fußzeile an den Verein adressiert ist und somit an alle Mitglieder z.B. in einer WhatsApp Gruppe verteilt werden kann.
+\
+\
+*Hinweis:* Die Wolke in der rechten oberen Ecke zeigt den Status der Synchronisation an. Durch Klicken auf eine Wolke mit einem Pfeil kann die Synchronisation manuell durchgeführt werden. Ansonsten wird alle 10 Sekunden synchronisiert.
+\
+\
+*Hinweis:* Ein Newsletter kann derzeit nicht kollaborativ geschrieben werden. Bei paralleler Arbeit am Newsletter überschreiben sich die Inhalte der Bearbeiter immer gegenseitig.