diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..84044e759aebb6994b82376a3c4f3cb268e639e4 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# LernraumPlugin + +Das LernraumPlugin stellt Funktionen zum Buchen von Lernräumen und +Arbeitstischen bereit, die aus Studiengruppen und dem persönlichen Profil +heraus genutzt werden können. + +Anhand spezieller Eigenschaften von Lernräumen und Arbeitstischen können +die Buchungsdauer, die minimale Gruppengröße für Buchungen, die maximale Anzahl +an Tagen, an denen ein Lernraum im Voraus gebucht werden kann, sowie +Öffnungszeiten festgelegt werden. + +Mittels Buchungsbeschränkungen ist es möglich, das Buchen von bestimmten +Lernräumen und Arbeitstischen nur für bestimmte Studiengänge oder Mitglieder +bestimmter Einrichtungen zu erlauben. Zudem gibt es eine „Blacklist“-Funktion, +mit der Personen das Buchen von Lernräumen generell verboten werden kann. + +Zusätzlich bietet die Funktion zur Kontingentierung die Möglichkeit, die Zeit, +die einer Person pro Woche/Monat/Semester für Lernraum-Buchungen zur Verfügung +steht, festzulegen. + +Intern greift das Plugin auf Funktionen der neuen Raumverwaltung zurück, +die in Stud.IP 4.5 eingebaut wurde. + + +## Hinweise zur Einrichtung + +Nach der Installation des Plugins sind noch keine Lernräume oder Arbeitstische +im Stud.IP vorhanden. Diese müssen erst noch angelegt werden. Dazu stellt das +Plugin in der Raumverwaltung im Reiter „Übersicht“ die beiden neuen +Navigationspunkte „Lernräume“ und „Arbeitstische“ bereit. + +Das Plugin stellt unter Admin -> System -> Konfiguration im Bereich +„LernraumPlugin“ mehrere Einstellmöglichkeiten bereit. Den Zeitbereich für die +Kontingentierung, sowie die im Kontingent enthaltenen Stunden können hier +eingestellt werden. + + +## Mitarbeit + +Der Quellcode des Plugins ist im GitLab von data-quest verfügbar: + +https://gitlab.data-quest.de/studip-plugins-oeffentlich/LernraumPlugin + + +### Fehler melden + +Fehler im Plugin können über das GitLab von data-quest gemeldet werden: + +https://gitlab.data-quest.de/studip-plugins-oeffentlich/LernraumPlugin/-/issues