Python-EFL-Client: Documentation

Signed-off-by: Nicole Vreden <damba@mecka.net>

1 files changed, 45 insertions, 0 deletions

diff --git a/doc/asciidoc/user.txt b/doc/asciidoc/user.txt
new file mode 100644
index 0000000..e192d79
--- /dev/null
+++ b/doc/asciidoc/user.txt
@@ -0,0 +1,45 @@
+Benutzer koennen...
+-------------------
+...Medien finden...
+~~~~~~~~~~~~~~~~~~~
+...indem sie einen Suchbegriff in das Textfeld eingeben und auf "Find..."
+klicken.
+Die Suchergebnisse werden in einer Liste dargestellt.
+
+Gueltige Suchkriterien sind:
+
+* Name des Interpreten
+* Titel
+* leeres Suchfeld
+
+Es ist auch moeglich, nur einen Teilbegriff einzugeben. Wird das Textfeld leer
+gelassen, werden alle in der DB gespeicherten Medien ausgegeben.
+
+...Medien auswaehlen...
+~~~~~~~~~~~~~~~~~~~~~~~
+...indem sie ein Medium aus der Liste anklicken. Der Client merkt sich,
+welches Medium zuletzt angeklickt wurde. Ist die Ergebnisliste zu lang um
+komplett angezeigt zu werden, wird ein Scrollbalken eingeblendet.
+
+Hat der Benutzer seine Wahl getroffen kann er den gewaehlten...
+
+...Titel abspielen...
+~~~~~~~~~~~~~~~~~~~~~
+...indem er auf den Button "Play" klickt. Die Suchmaske wird ausgeblendet und
+der Stream wird gestartet.
+
+Klickt der Benutzer in das Video wird die Suchmaske wieder eingeblendet und
+transparent ueber das Video gelegt. Es kann nun eine neue Mediensuche gestartet
+werden.
+
+Soll das gleiche Video weiterhin abgespielt und kein anderes Medium gewaehlt
+werden, kann die Suchmaske durch Klick auf den "Hide"-Button wieder ausgeblendet
+werden.
+
+Moechte der Benutzer den...
+
+...Stream unterbrechen...
+~~~~~~~~~~~~~~~~~~~~~~~~~
+...kann er dies tun indem er den "Stopp"-Button anklickt.
+
+image::img/gui.png[]