calendar & protocol

admin/content/4-modules/1-members.typ

@@ -4,7 +4,7 @@
 
 #wrap-content(
   figure(
-    image("../../images/member-base-data.png", width: 7cm),
+    image("../../images/member-base-data.png", width: 6.5cm),
   ),
 )[
 Die Mitgliederverwaltung ermöglicht die strukturierte Erfassung und Verwaltung von Mitgliederdaten. Bevor einzelne Mitgliederdatensätze angelegt werden können, müssen zunächst die Mitgliederstammdaten definiert werden. Diese Stammdaten dienen als Grundlage für die spätere Datenerfassung und ermöglichen eine einheitliche, standardisierte Verwaltung. Sind die Stammdaten einmal hinterlegt, können sie bei der Erfassung neuer Mitglieder verwendet werden.
@@ -24,4 +24,23 @@ Alle Stammdaten können frei ausgefüllt werden und einem Mitglied je nach Typ m
 #figure(
   image("../../images/member-edit-data.png", width: 100%),
 )
-Innerhalb der Mitgliederansicht können dann individuelle Mitgliederprofile angelegt und gepflegt werden. Diese enthalten persönliche Daten wie Name, Geburtsdatum sowie spezifische Informationen zur Mitgliedschaft wie Eintrittsdatum, Qualifikationen oder verliehene Auszeichnungen. Darüber hinaus bietet das System eine automatische Berechnung der Mitgliedschaftsdauer je zugewiesenem Status, um die aktive Zeit eines Mitglieds jederzeit nachvollziehen zu können.
+Innerhalb der Mitgliederansicht können dann individuelle Mitgliederprofile angelegt und gepflegt werden. Diese enthalten persönliche Daten wie Name, Geburtsdatum sowie spezifische Informationen zur Mitgliedschaft wie Eintrittsdatum, Qualifikationen oder verliehene Auszeichnungen. Darüber hinaus bietet das System eine automatische Berechnung der Mitgliedschaftsdauer je zugewiesenem Status, um die aktive Zeit eines Mitglieds jederzeit nachvollziehen zu können.
+\
+\
+Die Einträge zu einem Mitglied umfassen dann jeweils den Basisdatensatz und weitere Details, wie z.B. einen Zeitraum, in dem dieser Eintrag gültig ist oder war. Einige Eingabemöglichkeiten weisen Besonderheiten auf.
+\
+\
+*Mitgliedschaften* werden als Zeiträume eines bestimmten Status angegeben. Durch die Angabe eines neuen Zeitraums wird ein bisher aktiver Zeitraum beendet und das Enddatum auf den Tag vor Beginn des neuen Zeitraums gesetzt. Derzeit wird nicht geprüft, ob sich Zeiträume überschneiden. Zusätzlich kann bei einem Eintrag ein Grund für das Ende des Eintrags angegeben werden. Beispiele hierfür wären der Austritt oder der Tod eines Mitglieds.
+
+Bei einem *Kommunikationskanal* können nur die Felder ausgefüllt werden, die in den Stammdaten hinterlegt wurden. Zusätzlich kann angegeben werden, welche der Adressen bevorzugt verwendet werden soll. Dadurch ist es möglich, mehrere Telefonnummern oder Adressen zu erfassen, ohne die Übersicht zu verlieren. Weiterhin kann angegeben werden, ob ein Kommunikationskanal für den Versand eines Newsletters verwendet werden soll. Hierbei ist zu beachten, dass ein Newsletter derzeit nicht an eine Telefonnummer versendet werden kann. 
+
+Im Feuerwehrkontext kann bei einer Telefonnummer angegeben werden, ob diese für eine SMS-Alarmierung verwendet werden kann. Der Versand einer SMS an Mitglieder im Alarmfall ist nicht in FF Admin integriert und muss extern konfiguriert werden. Die Angabe erleichtert jedoch die Identifikation von Telefonnummern, die für diesen Anwendungsfall verwendet werden können.
+
+*Auszeichnungen* können einem Mitglied mit einem Übergabedatum zugeordnet werden. Dabei kann auch vermerkt werden, ob die Annahme vom Mitglied verweigert oder vom Verein verweigert wurde. Optional kann eine Notiz hinzugefügt werden. Die Notiz kann die Gründe für die Nichtannahme oder eine verspätete Übergabe enthalten.
+
+*Qualifikationen* können auch mit einem Zeitraum angelegt werden. Ein Eintrag kann weiterhin eine Notiz enthalten, z.B. eine Einschränkung der Qualifikation. Außerdem kann angegeben werden, warum die Qualifikation zurückgezogen wurde oder nicht mehr gültig ist.
+
+*Vereinsämter* können ebenfalls mit den Zeiträumen der Ausübung angelegt werden. Auch hier besteht die Möglichkeit, eine Notiz hinzuzufügen.
+\
+\
+*Anmerkung:* In jeder erfassbaren Datenkategorie können Einträge mehrfach vorkommen. Eine Überprüfung auf sich überschneidende Zeiträume oder Doppelerfassungen muss derzeit durch den Anwender erfolgen.

admin/content/4-modules/2-calendar.typ

@@ -1 +1,51 @@
-== Kalender
+#import "@preview/wrap-it:0.1.1": *
+
+== Kalender
+
+Der FF Admin beinhaltet ein Modul für die Verwaltung von Terminen. Diese Termine können den Mitgliedern oder anderen Interessierten über die integrierte öffentliche Ansicht oder direkt als WebCal-Link zur Verfügung gestellt werden. 
+
+#wrap-content(
+  figure(
+    image("../../images/calendar-type-form.png", width: 6.5cm),
+  ),
+)[
+Auch im Kalendermodul müssen Stammdaten angelegt werden.
+
+Die Stammdaten dienen dazu, die Kalendereinträge bestimmten Kategorien zuzuordnen. Die Kategorien enthalten eine Farbe und können dauerhaft öffentlich oder durch ein Passwort geschützt sein. Der Schutz einer Kategorie mit einem Passwort erschwert das automatisierte Testen und Auslesen von Terminen, da dann neben dem Namen der Kategorie auch das Passwort im Link angegeben werden muss.
+]
+
+#figure(
+  image("../../images/calendar.png", width: 100%),
+)
+
+#wrap-content(
+  figure(
+    image("../../images/calendar-form.png", width: 6.5cm),
+  ),
+)[
+Der Kalender ermöglicht die direkte Verwaltung von Terminen. Durch die Auswahl von Tagen in der Monatsansicht oder Zeiträumen in der Wochenansicht können Zeitbereiche direkt in das Formular zur Erstellung eines Termins übernommen werden.
+
+Der vorgewählte Zeitraum kann im erscheinenden Formular jederzeit geändert werden. Bei ganztägigen Terminen können dann nur noch direkte Datumsangaben und bei zeitbegrenzten Terminen Daten mit Uhrzeit ausgewählt werden.
+\
+\
+Weiterhin besteht ein Termin aus einem Termintyp bzw. einer Kategorie, einem Titel, einer Beschreibung und einem Ort.
+
+Die Textfelder sind frei wählbar und werden nicht auf Duplikate oder Korrektheit geprüft.
+]
+
+Alle Daten eines Termins sind analog zu diesem Formular in der öffentlichen Kalenderansicht sichtbar. Die Daten werden auch vollständig über WebCal übertragen.
+
+Die öffentliche Ansicht des Kalenders ist in FF Admin unter dem URL-Pfad `/public/calendar` verfügbar und zeigt alle Termine der Kategorien an, die mit `Standard Kalender Auslieferung` erstellt wurden. Die Ansicht kann als angemeldeter Nutzer über das Kalender-Icon im Kalender-Link-Dialog erreicht werden.
+
+Die Kategorien können weiterhin verwendet werden, um spezielle Links anzulegen, die Termine nur bestimmten Mitgliedern zur Verfügung stellen.
+
+#wrap-content(
+  figure(
+    image("../../images/calendar-publish.png", width: 6.5cm),
+  ),
+)[
+Die Freigabe des Kalenders mit einem WebCal-Link kann über eine eigene Dialogbox verwaltet werden. Die Dialogbox kann über das Link-Icon in der rechten oberen Ecke der Kalenderansicht geöffnet werden.
+\
+\
+Hier kann ausgewählt werden, welche Kategorien über einen Link verfügbar sein sollen. Die Kategorien werden - bei Bedarf mit der Passphrase - automatisch in den Link geschrieben. Sind Kategorien ausgewählt, kann zusätzlich die Standard-Auslieferung aktiviert werden. Ansonsten werden nur Termine der ausgewählten Kategorien ausgeliefert. Dieser kann dann kopiert und direkt in einen Kalender wie der von Google oder von Apple eingefügt werden.
+]

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

@@ -1 +1,29 @@
-== Protokolle
+#import "@preview/wrap-it:0.1.1": *
+
+== Protokolle
+
+#figure(
+  image("../../images/protocol-overview.png", width: 100%),
+)
+FF Admin bietet auch die Möglichkeit, Protokolle zu erfassen. Die Protokolle können An- und Abwesenheiten, Abstimmungen, Beschlüsse sowie die besprochenen Themen enthalten. Die Protokolle können auch als PDF exportiert werden.
+\
+\
+Jedes Protokoll enthält einen Titel sowie ein Datum mit Anfangs- und Endzeit. Zusätzlich kann eine Zusammenfassung verfasst werden, die beim Ausdruck des Protokolls an den Anfang gestellt wird.
+
+Die *Anwesenheit* kann nur Mitglieder erfassen, die in der Mitgliederverwaltung angelegt wurden. Bei den Anwesenheiten können Mitglieder gesucht und dem Protokoll hinzugefügt werden. Zusätzlich kann gespeichert werden, ob ein Mitglied entschuldigt oder unentschuldigt abwesend war.
+
+Je nach Anwesenheit werden die Mitglieder auf dem pdf unter verschiedenen Positionen ausgedruckt.
+
+*Abstimmungen* können ebenfalls erfasst werden. Eine Abstimmung besteht aus einem Titel und einer Beschreibung. Zusätzlich kann das Ergebnis mit der Anzahl der Ja-, Nein- und Enthaltungsstimmen angegeben werden.
+
+Die *Beschlüsse* sind als separate Auflistung von Sitzungen gedacht. Diese sollen noch einmal klar und gesondert hervorheben, was alles beschlossen wurde.
+
+Das *Protokoll* selbst besteht aus vielen Punkten, die in der Sitzung besprochen wurden. Es wird immer mit Titel und Beschreibung erfasst.
+
+Jedes Protokoll kann gedruckt werden. Die erstellten pdf-Dateien können heruntergeladen oder direkt in FF Admin angezeigt werden. Jedes pdf enthält die Daten des Protokolls und ordnet diese in Listen an.
+\
+\
+*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.