diff --git a/ff-webpage.pdf b/ff-webpage.pdf index ab6be0b..13863fe 100644 Binary files a/ff-webpage.pdf and b/ff-webpage.pdf differ diff --git a/webpage/content/3-strapi.typ b/webpage/content/3-strapi.typ index 4d46ce9..6bc0f00 100644 --- a/webpage/content/3-strapi.typ +++ b/webpage/content/3-strapi.typ @@ -1,63 +1,14 @@ = Strapi *Disclaimer:* Fehler, die auf der Webseite angezeigt werden, können auf eine fehlerhafte Konfiguration in Strapi hinweisen. - -== Einrichtung - -Um die Webseite nutzen zu können, müssen Global die Navigation sowie die Startseite konfiguriert sein. \ \ -Wichtig ist, dass ein paar Einstellungen vor der ersten Verwendung vorgenommen werden. Dazu zählen: +*Allgemeine Bezeichnungen:* +- Slug: Einzigartige Bezeichnung als Identifikation in der URL. +- Identifier: Wert, zur Identifikation in Referenz-Feldern. -1. *Admin Benutzer erstellen*: Erstellen Sie einen Admin Benutzer, um auf das CMS zugreifen zu können. +#include "./3-strapi/1-setup.typ" -2. *Einstellungen anpassen*: In den Einstellungen müssen unter dem Punkt `Users & Permissions Plugin` die Rollen und Berechtigungen angepasst werden. Unter `Roles > Public` muss die Berechtigung `find`, `findOne` und falls vorhanden auch `distinctYears` und `findByYear` für alle Modelle aktiviert werden. +#include "./3-strapi/2-models.typ" -3. *Medienverwaltung*: Es empfiehlt sich unter `Global Settings > Media Library` alle Optionen auf true zu stellen. Dadurch wird zum Beispiel auch die automatische Rotation von Bildern aktiviert. - -4. *Rollen und Berechtigungen*: Unter `Administration Panel > Roles` können die Rollen und Berechtigungen für die Benutzer angepasst werden. Es empfiehlt sich, die Standardrollen zu übernehmen und nur die Berechtigungen anzupassen. Diese können aber auch beliebig erweitert werden. Dieser Punkt betrifft nur die Erstellung von Inhalten in der Adminstrationsoberfläche. - -5. *Nutzer einladen*: Unter `Administration Panel > Users` können weitere Nutzer eingeladen werden. Diese erhalten dann eine E-Mail mit einem Link, um sich ein Passwort zu setzen. - -6. *Erstellung von Inhalten*: Nachdem die Einstellungen vorgenommen wurden, können Inhalte erstellt werden. Dazu können die Inhalte über die Oberfläche zu den bestehenden Modellen erstellt werden. - -7. *Einrichtung Sammlungsreferenz*: Die Sammlungsreferenz ist ein eigenes Modell, das die Verknüpfung von Artikeln, Einsätzen, Fahrzeugen und Terminen ermöglicht. Die Werte für Collection können sind die Referenzen auf die genannten Listen. Diese Werte müssen Plural sein und können nur die Werte `articles`, `operations`, `vehicles` und `events` annehmen.\ - Es empfiehlt sich diese Werte direkt zu setzen, da diese dann als Referenz in anderen Modellen genutzt werden können. - -=== Verwendung der Modelle - -Beispiele zu den beschriebenen Inhalten finden sie in der Demo. - -=== Allgemeine Bezeichnungen - -- *Slug*: Einzigartige Bezeichnung als Identifikation in der URL. -- *Identifier*: Wert, zu Identifikation in Referenz-Feldern. - -=== Modelle - -1. *Global*: Hier wird festgelegt, wie die Navigation und der Footer aufgebaut sind. Die Navigation nutzt Informationen zu verwiesenen Seiten und Pfaden zu diesen Seiten. Die Werte der Pfade sollten mit den Werten aus der Sammlungsreferenz übereinstimmen. Dadurch wird gewährleistet, dass Detailansichten der Artikel, Einsätze, Fahrzeuge und Termine korrekt angezeigt werden können. - -2. *Startseite*: Hier können die Inhalte der Startseite angepasst werden. - - *Backdrop*: Bildschirmfüllendes Bild, das im Hintergrund angezeigt wird. - - Das in Global angegebene Logo wird unten im Eck über den Backdrop gelegt. - -3. *Artikel*: Verwaltung und Erstellung von Artikeln. - -4. *Einsätze*: Verwaltung und Erstellung von Einsätzen. - -5. *Fahrzeuge*: Verwaltung und Erstellung von Fahrzeugen. - -6. *Sammlungs Referenz*: Verwaltung und Erstellung von Referenzen auf Artikel, Einsätze, Termine und Fahrzeuge. - - *Image Item*: Soll das Element in der Liste ein Bild anzeigen. - - *Date List*: Sollen die Listenelemente gruppiert nach Jahren angezeigt und navigiert werden. - - *Numbered Item*: Soll bei den ListenElementen ohne Bild statt dem Tag als große Zahl eine Nummerierung erfolgen. - - *Inverse Count*: Soll die Zählweise umgekehrt sein. (Sinnvoll bei Einsätzen) - -7. *Seiten*: Verwaltung und Erstellung von Seiten mit Dynamischen Inhalten. - - *Hero*: Bild mit Text als Einleitung. - -8. *Termine*: Verwaltung und Erstellung von Terminen. - -9. *User*: wird nicht benötigt - -== Verwendung \ No newline at end of file +#include "./3-strapi/3-usage.typ" \ No newline at end of file diff --git a/webpage/content/3-strapi/1-setup.typ b/webpage/content/3-strapi/1-setup.typ new file mode 100644 index 0000000..220f8f3 --- /dev/null +++ b/webpage/content/3-strapi/1-setup.typ @@ -0,0 +1,50 @@ +#import "@preview/wrap-it:0.1.1": * + +== Einrichtung + +Um die Webseite nutzen zu können, müssen die Datenspeicher Global mit der Navigation sowie die Startseite ausgefüllt sein. +\ +\ +Wichtig ist, dass ein paar Einstellungen vor der ersten Verwendung vorgenommen werden müssen. Dazu zählen: + +1. *Admin Benutzer erstellen*: Erstellen Sie einen Admin-Benutzer, um auf das CMS zugreifen zu können. Dazu muss die URL zum Content Management System geöffnet werden. Dort kann direkt der erste Benutzer als Admin angelegt werden. + +#wrap-content( + figure( + image("../../images/role-permissions.png", width: 6.5cm), + ), + align: right +)[ +2. *Einstellungen anpassen*: In den Einstellungen müssen unter dem Punkt `Users & Permissions Plugin` die Rollen und Berechtigungen angepasst werden. Unter `Roles > Public` müssen die Berechtigungen `find`, `findOne` und falls vorhanden `distinctYears` und `findByYear` für bestimmte Vorlagen aktiviert werden. Dadurch kann die Website später ohne weitere Einstellungen lesend auf die veröffentlichten Inhalte zugreifen. Die Leseberechtigungen müssen für `Article`, `Collection-lookup`, `Event`, `Global`, `Homepage`, `Operation`, `Page`, `Vehicle` und `Upload` aktiviert werden. +] + +#wrap-content( + figure( + image("../../images/media-library.png", width: 6.5cm), + ), + align: right +)[ +3. *Medienverwaltung*: Es wird empfohlen, unter `Global Settings > Media Library` alle Optionen auf true zu setzen. Dadurch wird z.B. auch die automatische Bilddrehung aktiviert. Dadurch werden die Bilder automatisch in die richtige Ausrichtung gedreht und in der Größe optimiert. +] + +4. *Rollen und Berechtigungen*: Unter `Administration Panel > Roles` können die Rollen und Berechtigungen für die Benutzer angepasst werden. Es wird empfohlen, die Standardrollen zu übernehmen und nur die Berechtigungen anzupassen. Diese können jedoch beliebig erweitert werden. Dieser Punkt betrifft nur die Erstellung von Inhalten in der Administrationsoberfläche. + +#wrap-content( + figure( + image("../../images/invite.png", width: 6.5cm), + ), + align: right +)[ +5. *Nutzer einladen*: Unter `Administration Panel > Users` können weitere Benutzer eingeladen werden. Diese erhalten dann eine E-Mail mit einem Link, über den sie ein Passwort festlegen können. Die eingeladenen Benutzer erhalten dann eine E-Mail, über die sie ihr Passwort setzen können. Rollen können hier direkt bei der Einladung vergeben werden, so dass nach der Registrierung direkt mit der Bearbeitung begonnen werden kann. Theoretisch können Benutzer auch eingeladen und direkt editiert werden, um ein Passwort zu setzen. Dies kann verwendet werden, wenn die E-Mail-Adresse nicht existiert. +] + +6. *Erstellung von Inhalten*: Nachdem die Einstellungen vorgenommen wurden, können die Inhalte erstellt werden. Dazu können die Inhalte über die Schnittstelle zu den bestehenden Modellen erstellt werden. + +#wrap-content( + figure( + image("../../images/reference.png", width: 6.5cm), + ), + align: right +)[ +7. *Einrichtung Sammlungsreferenz*: Die Sammlungsreferenz ist ein eigenes Modell, das die Darstellung von Artikeln, Einsätzen, Fahrzeugen und Terminen regelt. Die Sammlungswerte sind die Verweise auf die verfügbaren Listen. Es wird empfohlen, diese Werte direkt zu definieren, damit sie in anderen Modellen als Referenz verwendet werden können. +] diff --git a/webpage/content/3-strapi/2-models.typ b/webpage/content/3-strapi/2-models.typ new file mode 100644 index 0000000..767752d --- /dev/null +++ b/webpage/content/3-strapi/2-models.typ @@ -0,0 +1,35 @@ +== Modelle + +=== Global: +Hier wird festgelegt, wie die Navigation und der Footer aufgebaut sind. Die Navigation nutzt Informationen zu verwiesenen Seiten und Pfaden zu diesen Seiten. Die Werte der Pfade sollten mit den Werten aus der Sammlungsreferenz übereinstimmen. Dadurch wird gewährleistet, dass Detailansichten der Artikel, Einsätze, Fahrzeuge und Termine korrekt angezeigt werden können. + +=== Startseite: +Hier können die Inhalte der Startseite angepasst werden. + - Backdrop: Bildschirmfüllendes Bild, das im Hintergrund angezeigt wird. + - Das in Global angegebene Logo wird unten im Eck über den Backdrop gelegt. + +=== Artikel: +Verwaltung und Erstellung von Artikeln. + +=== Einsätze: +Verwaltung und Erstellung von Einsätzen. + +=== Fahrzeuge: +Verwaltung und Erstellung von Fahrzeugen. + +=== Sammlungs Referenz: +Verwaltung und Erstellung von Referenzen auf Artikel, Einsätze, Termine und Fahrzeuge. + - Image Item: Soll das Element in der Liste ein Bild anzeigen. + - Date List: Sollen die Listenelemente gruppiert nach Jahren angezeigt und navigiert werden. + - Numbered Item: Soll bei den ListenElementen ohne Bild statt dem Tag als große Zahl eine Nummerierung erfolgen. + - Inverse Count: Soll die Zählweise umgekehrt sein. (Sinnvoll bei Einsätzen) + +=== Seiten: +Verwaltung und Erstellung von Seiten mit Dynamischen Inhalten. + - Hero: Bild mit Text als Einleitung. + +=== Termine: + Verwaltung und Erstellung von Terminen. + +=== User: +wird nicht benötigt diff --git a/webpage/content/3-strapi/3-usage.typ b/webpage/content/3-strapi/3-usage.typ new file mode 100644 index 0000000..a84fae0 --- /dev/null +++ b/webpage/content/3-strapi/3-usage.typ @@ -0,0 +1,2 @@ + +== Verwendung \ No newline at end of file diff --git a/webpage/images/invite.png b/webpage/images/invite.png new file mode 100644 index 0000000..e28347e Binary files /dev/null and b/webpage/images/invite.png differ diff --git a/webpage/images/media-library.png b/webpage/images/media-library.png new file mode 100644 index 0000000..f6b6166 Binary files /dev/null and b/webpage/images/media-library.png differ diff --git a/webpage/images/reference.png b/webpage/images/reference.png new file mode 100644 index 0000000..755415f Binary files /dev/null and b/webpage/images/reference.png differ diff --git a/webpage/images/role-permissions.png b/webpage/images/role-permissions.png new file mode 100644 index 0000000..7fbbce6 Binary files /dev/null and b/webpage/images/role-permissions.png differ