===== Anleitung für die Arbeit mit dem Lunes CMS =====


==== Anmeldung ====

Anmeldelink für die Vokabelverwaltung: https://lunes.tuerantuer.org/admin/

==== Dashboard ====

**Hinweis vorab:** Im CMS sollte vorsichtig und bewusst gearbeitet werden. Es ist kein CMS, in dem eine Vorschau oder Ähnliches vorhanden ist. Bedeutet: gelöscht ist gelöscht und verschoben ist verschoben. Sobald etwas als veröffentlicht markiert ist, ist es auch in der App einsichtig.

{{:dashboard_intern.jpeg|}}

Nach dem Login öffnet sich die Dashboard Übersicht. Das Dashboard hat für interne Nutzer:innen mehr Funktionen zur Verfügung. Auf der linken Seite des Dashboards befindet sich das Hauptmenü. Mit diesem kann leicht zwischen den unterschiedlichen Funktionsbereichen hin und her navigiert werden.

{{:profil.jpeg|}} 

Hier kann das Passwort geändert werden. Auch der Logout und die Möglichkeit zum Benutzerprofil zu gelangen befindet sich hier. 


{{:sprache.jpeg|}} 

Hier kann die Sprache geändert werden. Momentan ist Deutsch und Englisch verfügbar.

===== Authentifizierung und Autorisierung =====

Erstellung einer Instanz in drei Schritten:

==== 1. Anlegen einer Gruppe ====

{{:gruppe.jpeg|}}

1. Klick auf "Gruppe hinzufügen".

2. Name und Berechtigungen sowie optional ein Icon hinterlegen

**Hinweis:** Eine Gruppe sollte alle Berechtigungen für die folgenden Inhaltstypen erhalten:
Alternatives Wort, Modulgruppe, Vokabeln, Bild, Modul

Beispiel:

{{:lunes_instanz_erstellen.png|}}

==== 2. Anlegen eines Users ====

{{:benutzer_hinzufuegen.jpeg|}}

1. Klick auf "Benutzer hinzufügen"

{{:passwort.jpeg|}}

2. Benutzernamen eingeben und initiales und sicheres Passwort auswählen

3. Danach öffnet sich ein Interface, in dem man beispielsweise persönliche Informationen wie Name oder Adresse eines Users speichern kann. 

**Hinweis:** Wichtig ist für die Funktionsweise des Backends vor allem der Reiter Berechtigungen. Der User muss einen Mitarbeiterstatus besitzen. Es sollte aber in keinem Fall der Administrator-Status Haken ausgewählt sein.

4. Füge den User der jeweiligen Gruppe hinzu. Es müssen keine weiteren Berechtigungen individuell festgelegt werden.

5. Passwort für Login und Codes für interne Lerngemeinschaften ohne o, O, 0, l, I, v, r
Beispiel:

{{:user_erstellen.png|}}

==== 3. Erstellen eines API-Keys ====

Unter Vokabelverwaltung einen API-Key erstellen. Die Anleitung befindet sich weiter unten unter "API-Key".
===== Vokabelverwaltung =====


==== Modulgruppen ====
Die Modulgruppen fassen unsere unterschiedlichen Berufsbilder zu sinnvollen Bereichen zusammen. Derzeit gibt es 9 veröffentlichte Bereiche in der Lunes App. Modulgruppen können selbst keine Vokabeln enthalten, sondern nur Module. 

  * Der Name und die Beschreibung einer Modulgruppe können jederzeit geändert werden.
  * Per Drag & Drop kann die Reihenfolge der Modulgruppen in der Vokabelverwaltung geändert werden.

Hinzufügen einer Modulgruppe:

1. Klick auf "Modulgruppe hinzufügen".
{{:modulgruppe_hinzufuegen.jpeg|}}

2. Name, Icon und Beschreibung hinzufügen. 

3. Damit die Modulgruppe in der Lunes App sichtbar wird, den Haken bei „veröffentlicht“ setzen. 

**Hinweis:** Die Icons für die übergeordneten Modulgruppen (1.Ebene) werden individuell von Ulrike gestaltet. 
{{:modulgruppe_maske.jpeg|}}

==== Module ====

  * Ein Lernmodul kann einer oder mehreren Modulgruppen zugeordnet sein.
  * Einem Modul können Vokabeln hinzugefügt werden: Wünschenswert sind mindestens 5 und maximal 12-15 Vokabeln. Erst ab 4 Vokabeln kann ein Modul im CMS veröffentlicht werden.
  * Icons können bei flaticon.com heruntergeladen werden. Format: PNG in 512×512. Anleitung: [[flaticon]]
  * Die Module alphabetisch ordnen. Zuerst die „Grundlagen [xy]“-Module alphabetisch untereinander, darunter dann alle anderen Module ebenfalls alphabetisch.
  * Wenn neue Module hinzukommen ist es wichtig, dass die neuen Module entsprechend einsortiert werden und nicht an die bestehenden Module verschoben werden. Dadurch, dass die Module in verschiedenen Bereichen zum Einsatz kommen, kann es sonst auch in anderen Bereichen zu Verschiebungen kommen.

 
Neues Modul anlegen:
{{:modul_hinzufuegen.jpeg|}}

1. Klick auf "Modul hinzufügen"

{{:modul_bearbeiten.jpeg|}}

2. Benennung des Moduls und Hinzufügen einer Beschreibung sowie eines Icons


3. Auswählen der Vokabeln, die das Modul umfassen soll

{{:modulgruppen_auswaehlen.jpeg|}}

4. Auswählen von mindestens einer Modulgruppe
==== Vokabeln ====

Neue Vokabel hinzufügen:

1.Klick auf "Vokabeln hinzufügen"
{{:vokabel_hinzufuegen.jpeg|}}

2. Maske für das Anlegen einer Vokabel öffnet sich.

{{:vokabel_maske.jpeg|}}


3. Wortart auswählen. Derzeit sind nur Substantive angelegt und veröffentlicht.

4. Wort eingeben

5. Artikel auswählen

6. Audio hinzufügen: Solange noch keine Audiodatei vorhanden ist, wird die Vokabel von einer Computerstimme vorgelesen. In regelmäßigen Abständen werden für neue Vokabeln eingesprochene Audio-Dateien hochgeladen.

**Hinweis:** Noch wird bei einer nachträglichen Änderung am Wort die Audiodatei nicht automatisch gelöscht. Bitte daran denken die Audiodatei zu löschen damit eine neue passende erzeugt wird. 

7. Bild hinzufügen:

{{:bild_hinzufuegen.jpeg|}}

Mit einem Klick auf den Abschnitt „Bilder“ können Fotos zur Vokabel hinzugefügt werden. 

**Hinweis:** 
1. Es muss mindestens ein Bild vorhanden sein, damit die Vokabel an die App ausgeliefert wird. Erkennabr ist ein vorhandes Bild am grünen Haken in der Vokabelübersicht. Mehrere Bilder sind möglich und je nach Vokabel auch sinnvoll (z.B. unterschiedliche Perspektiven). 

2. Bitte nur Bilder verwenden, die unter der CC-O Lizenz veröffentlicht werden dürfen oder selbst gemacht wurden.

3. Hinzugefügte Bilder auch über Alt-Taste einsehbar.

8. Alternative Wörter:

{{:alternative_woerter.jpeg|}}

Hier werden Synonyme der Vokabel angelegt.

**Hinweis:** Momentan werden die "Alternativen Wörter" auch dafür verwendet, mehrere mögliche Artikel abzubilden.

==== API-Keys ====

Neuer API-Key hinzufügen:

1. Klick auf "API-Key hinzufügen"

{{:api-key.jpeg|}}

2. Organisation bei "Gruppe" auswählen, für die der Key erstellt werden soll
{{:api-key-anlegen.jpeg|}}

Wichtiger Hinweis: **Der API-Key wird nicht in der Datenbank gespeichert.** Nach der Erstellung wird dieser nur einmal angezeigt.

3. Deshalb den API-Key per Copy & Paste in eine verschlüsselte Passwort-Datenbank hinterlegen.
Das Format des Keys ist XXX.XXXXXXX (also 10 Zeichen inklusive einem Punkt nach drei Zeichen).
Optional kann ein QR-Code erstellt werden mit kostenlosen Online-Services wie bspw. QR Code Generator. Einfach unter Freier Text den Key eingeben und den QR Code generieren.

**Beispiel für einen erstellten API-Key:**

{{:lunes_api_key_beispiel.png|}}
==== Feedback Einträge ====

Nutzer:innen können direkt in der App Feedback geben. Dieses wird hier gesammelt angezeigt. 
{{:feedback.jpeg|}}

Das Feedback kann sich auf unterschiedliche Inhaltstypen beziehen: Vokabel, Modul oder Modulgruppe. Nach diesen unterschiedlichen Inhaltstypen kann gefiltert werden. Auch kann danach gefiltert werden, wer Feedback als gelesen markiert hat. Das ist besonders praktisch, wenn man nur nach seinem eingearbeiteten Feedback sucht. 

== Ablauf Feedback Einarbeitung: ==
 
  - Das Feedback wird erst als gelesen markiert, wenn es bereits geprüft und eingearbeitet ist. 
  - Feedback, welches lediglich Sonderzeichen oder keine relevanten Informationen enthält, kann gelöscht werden. 
  - Neue Feedbackeinträge werden in regelmäßigen Abständen geprüft (in der Regel ein Mal die Woche).
  - Es sollte kein Feedback unbearbeitet bleiben. Ist Feedback momentan noch nicht einarbeitungsfähig, wird es in die entsprechende Content Überarbeitung Liste übertragen und dann als gelesen markiert.