TandemPlugin: Added installation documentation

git-svn-id: https://server2.data-quest.de/svn/studip-plugins/TandemPlugin@2517 6a1f69d7-6018-4d13-bf90-b098e98c258d

doc/INSTALL.de.md

+# Installationsanleitung TandemPlugin
+
+## Systemanforderungen
+
+- mindestens Stud.IP Version 3.5
+- moderner Webbrowser (Firefox oder Chromium werden empfohlen)
+
+## Installation
+
+Das Plugin kann wie jedes andere Plugin in Stud.IP über die Plugin-Administrationsseite installiert werden.
+
+Während des Installationsvorgangs legt das Plugin automatisch alle benötigten Tabellen in der Stud.IP Datenbank an. Zudem wird eine Rolle "TandemAdmin" und ein Cronjob zum Entfernen alter Tandem-Gesuche angelegt.
+
+Nach der Aktivierung des Plugins fügt sich dieses zur Rolle "TandemAdmin" hinzu.
+
+## Konfiguration
+
+Nach der Installation können Stud.IP Nutzer der Rolle TandemAdmin zugewiesen werden. Nutzer dieser Gruppe werden über neu gebildete und aufgelöste Tandems per Mail informiert und können gebildete, angefragte und abgelehnte Tandems sehen und exportieren. Zudem können sie Konfigurationsoptionen des TandemPlugins ändern.
+
+Root-Nutzer können standardmäßig gebildete, angefragte und abgelehnte Tandems sehen und exportieren und zudem noch Konfigurationsoptionen des TandemPlugins ändern. Damit ein Root-Nutzer Mails über neu gebildete und aufgelöste Tandems erhalten, müssen diese ebenfalls der Rolle TandemAdmin hinzugefügt werden.
+
+### Konfigurationsoption "Filterung der Suchergebnisse anhand des Geschlechtes"
+
+Mit dieser Option können Suchergebnisse anhand des Geschlechts gefiltert werden, sodass zum Beispiel Nutzerinnen, welche nur Tandempartnerinnen suchen, nur andere Nutzerinnen angezeigt bekommen, passende Nutzer hingegen nicht. 
+
+Um diese Funktion sinnvoll nutzen zu können, ist es notwendig, dass das Geschlecht von Stud.IP Nutzern eingetragen ist, da ansonsten bei der Eingrenzung der Tandem-Gesuche auf ein Geschlecht keine Resultate angezeigt werden können.
+
+### Konfigurationsoption "Entfernung alter Gesuche"
+
+Um keine "Karteileichen" im Stud.IP System zu hinterlassen werden Gesuche, welche ein bestimmtes Alter erreicht haben, automatisch durch den Cronjob des TandemPlugin gelöscht. Standardmäßig gilt ein Gesuch als zu alt, wenn es älter als drei Monate ist und in dieser Zeit kein Tandem gebildet wurde. Das Maximalalter von Gesuchen ohne Tandem kann zwischen einem und 24 Monaten betragen und wird über diese Konfigurationsoption eingestellt. Die Einstellung wird im gesamten TandemPlugin angewendet.
+
+### Speicherort der Konfiguration
+
+Die Konfiguration des TandemPlugins wird in der Stud.IP Datenbank in der Tabelle "config" gespeichert. Sie können anhand dem Wert "tandemplugin" im Feld "section" erkannt werden.

plugin.manifest

 pluginname=TandemPlugin
 pluginclassname=TandemPlugin
 origin=data-quest
-version=0.4
+version=0.5
 description=Dieses Plugin ermglicht es, Sprachtandems innerhalb der Stud.IP Platform zu bilden.
 studipMinVersion=3.5