From 9d50115cb2ad9d50c8c656a893b529dff6d9b10c Mon Sep 17 00:00:00 2001 From: WorldTeacher Date: Tue, 28 Jan 2025 16:24:38 +0100 Subject: [PATCH] update documentation (p2) --- docs/Allgemeines.md | 6 +++--- docs/Ausleihhistorie.md | 2 +- docs/Ausleihsystem.md | 10 +++++----- docs/Bericht erstellen.md | 6 +++--- docs/Einstellungen.md | 14 ++++++-------- docs/Nutzeroberfläche.md | 16 +++++++--------- docs/ausleihe verlängern.md | 5 ++--- 7 files changed, 27 insertions(+), 32 deletions(-) diff --git a/docs/Allgemeines.md b/docs/Allgemeines.md index b963ff8..da4bbe2 100644 --- a/docs/Allgemeines.md +++ b/docs/Allgemeines.md @@ -4,8 +4,8 @@ Hier werden alle allgemeinen Informationen zur Anwendung aufgeführt, die nicht ## Datenbankbackup -Bei jedem schließen der Anwendung wird ein Backup der Datenbank erstellt. Dieses Backup wird im Sicherungspfad gespeichert, dieser ist in den Einstellungen einsehbar und änderbar. +Bei jedem Schließen der Anwendung wird ein Backup der Datenbank erstellt. Dieses Backup wird im Sicherungspfad gespeichert, der Sicherungspfad ist in den Einstellungen einsehbar und änderbar. -Sollte der normale Speicherpfad nicht existieren oder nicht erreichbar sein (im Falle eines Netzwerklaufwerks), wird der Backuppfad verwendet. Beim Schließen der Anwendung wird ein Fehler erscheinen, dass das erstellen des Backups nicht erfolgreich war. Solange der Originale Pfad nicht erreichbar ist, wird der Backuppfad verwendet. +Sollte der normale Speicherpfad nicht existieren oder nicht erreichbar sein (im Falle eines Netzwerklaufwerks), wird der Backuppfad verwendet. Beim Schließen der Anwendung wird ein Fehler angezeigt, dass das Erstellen des Backups nicht erfolgreich war. Solange der originale Pfad nicht erreichbar ist, wird der Backuppfad verwendet. -Sobald der Originale Pfad wieder erreichbar ist, wird die Datenbank in den Originalen Pfad kopiert, die veraltete Datenbank wird gelöscht und der Backuppfad wird wieder verwendet. +Sobald der originale Pfad wieder erreichbar ist, wird die Datenbank in den originalen Pfad kopiert, die veraltete Datenbank wird gelöscht und der Backuppfad wird wieder verwendet. diff --git a/docs/Ausleihhistorie.md b/docs/Ausleihhistorie.md index 8a9fd77..370244f 100644 --- a/docs/Ausleihhistorie.md +++ b/docs/Ausleihhistorie.md @@ -3,7 +3,7 @@ !!! info - Die Ausleihhistorie kann vom Ausleihsystem immer aufgerufen werden. Dazu kann man entweder das Menu öffnen (Fenster -> Ausleihhistorie) oder den festgelegten Shortcut verwenden. + Die Ausleihhistorie kann vom Ausleihsystem immer aufgerufen werden. Dazu kann man entweder das Menu öffnen (Fenster -> Ausleihhistorie) oder den festgelegten Shortcut verwenden. # Bedienung Hier werden alle Medien angezeigt. diff --git a/docs/Ausleihsystem.md b/docs/Ausleihsystem.md index d832f57..fca4cdb 100644 --- a/docs/Ausleihsystem.md +++ b/docs/Ausleihsystem.md @@ -4,7 +4,7 @@ ## Oberfläche -![Nutzeroberfläche ohne Bewerkungen](images/main_marked%20areas.png) +![Nutzeroberfläche ohne Bemerkungen](images/main_marked%20areas.png) Die Oberfläche kann generell in drei Bereiche unterteilt werden: @@ -46,13 +46,13 @@ Das Feld der Historie listet alle Medien auf, die im aktiven Prozess ausgeliehen ## Ausleihen -Um ein Medium auszuleihen, muss zuerst ein Nutzer geöffnet sein. Dazu entweder den Knopf neben Modus drücken, oder den Shortcut (Standard: `F5`) verwenden. +Um ein Medium auszuleihen, muss zuerst ein Nutzer geöffnet werden. Dazu entweder den Knopf neben Modus drücken, oder den Shortcut (Standard: `F5`) verwenden. Die Oberfläche sieht dann wie folgt aus: ![Ausleihe](images/main_loan_active.png) -Der Cursor wird automatisch auf die Matrikelnummer gesetzt. Hier kann entweder die vollständige Nummer, oder ein Teil eingegeben werden. Sollten mehrere Nummern oder Namen dem Teilfilter ensprechen, wird eine Auswahl angezeigt. (s. [MultiUser](MultiUser.md)) +Der Cursor wird automatisch auf die Matrikelnummer gesetzt. Hier kann entweder die vollständige Nummer oder ein Teil eingegeben werden. Sollten mehrere Nummern dem Teilfilter entsprechen, wird eine Auswahl angezeigt. (s. [MultiUser](MultiUser.md)) Nach der Auswahl wird das entsprechende Konto geöffnet und die Ausleihe kann durchgeführt werden. ![Ausleihe](images/activeLoan.png) @@ -60,7 +60,7 @@ Nach der Auswahl wird das entsprechende Konto geöffnet und die Ausleihe kann du Sollte der aktive Nutzer aktive Ausleihen haben, so wird die Anzahl der Medien neben "Anzahl Ausleihen" angezeigt. Das nächste Rückgabedatum wird ebenfalls angezeigt. Über einen Klick auf die Zahl der Ausleihen gelangen Sie zur [Übersicht der Ausleihen des Nutzers](Nutzeroberfläche.md). -Um ein Medium auszuleihen, muss die Signatur in die entsprechende Zeile eingegeben werden. Sollte die Signatur nicht in der Datenbank existieren, wird der definierte Katalog geprüft. Wird das Medium gefunden, wird es in die Datenbank übernommen und die Ausleihe wird durchgeführt. Sollte das Medium nicht gefunden werden, wird eine Fehlermeldung angezeigt. +Um ein Medium auszuleihen, muss die Signatur in die entsprechende Zeile eingegeben werden. Sollte die Signatur nicht in der Datenbank existieren, wird der zuvor festgelegte Katalog geprüft. Wird das Medium gefunden, wird es in die Datenbank übernommen und die Ausleihe wird durchgeführt. Sollte das Medium nicht gefunden werden, wird eine Fehlermeldung angezeigt. ![FehlerAusleihe](images/err_noBook.png) @@ -68,7 +68,7 @@ Um ein Medium auszuleihen, muss die Signatur in die entsprechende Zeile eingegeb Die Signatur muss mindestens ein Leerzeichen enthalten, ansonsten wird eine Fehlermeldung angezeigt. -Sonderfälle siehe [Sonderfälle Ausleihe](Ausleihe_Sonderfälle.md) +Sonderfälle siehe [AusleiheSonderfälle](Ausleihe_Sonderfälle.md) ## Rückgaben diff --git a/docs/Bericht erstellen.md b/docs/Bericht erstellen.md index 3ffe265..009a936 100644 --- a/docs/Bericht erstellen.md +++ b/docs/Bericht erstellen.md @@ -11,10 +11,10 @@ Diese Oberfläche kann immer von der [Hauptoberfläche](Ausleihsystem.md) geöff Um einen Bericht zu erstellen, müssen folgende Kriterien erfüllt sein: -- Zeitspanne festgelegt (Entweder über den Slider, oder über die Woche / Monat / Jahr Knöpfe) -- Datenformat ausgewählt +- Zeitspanne festgelegt (Entweder über den Slider, oder über die Buttons für Woche / Monat / Jahr) +- Dateiformat muss festgelegt worden sein. -Nachdem diese Kriterien erfüllt sind, kann der Bericht über den Knopf `Bericht erstellen` erstellt werden. Der Bericht wird erstellt, bei größeren Datensätzen kann es länger dauern, bis der Bericht erstellt ist. Eine Fortschrittsanzeige gibt an, wie weit der Prozess ist. +Bei größeren Datensätzen kann es länger dauern. Eine Fortschrittsanzeige gibt an, wie weit der Prozess ist. Wurde der Bericht erfolgreich erstellt, sieht die Oberfläche wie folgt aus: diff --git a/docs/Einstellungen.md b/docs/Einstellungen.md index 4a7c036..753372a 100644 --- a/docs/Einstellungen.md +++ b/docs/Einstellungen.md @@ -2,12 +2,12 @@ ![Einstellungen](images/settings.png) ## Bedienung -Hier werden die Einstellungen geändert. Sobald ein Wert geändert wird, ist es möglich die Einstellungen rückgängig zu machen, oder die Änderungen zu speichern. +Hier werden die Einstellungen geändert. Sobald ein Wert geändert wird, ist es möglich die Einstellungen rückgängig zu machen oder die Änderungen zu speichern. ## Einstellungsoptionen ### Name der Einrichtung -Hier kann der Name der Einrichtung geändert werden. Dieser wird in der Kopfzeile der Anwendung angezeigt, und im Katalog verwendet um Exemplare zu finden. +Hier kann der Name der Einrichtung geändert werden. Dieser wird in der Kopfzeile der Anwendung angezeigt und im Katalog verwendet um Exemplare zu finden. ### Leihdauer Hier kann die Leihdauer festgelegt werden. Standardmäßig ist diese auf 7 Tage gesetzt @@ -15,9 +15,7 @@ Hier kann die Leihdauer festgelegt werden. Standardmäßig ist diese auf 7 Tage ### Inaktive Nutzer löschen Hier kann festgelegt werden, wie lange Inaktive Nutzer im System bleiben. Dieser Zeitraum wird ab dem letzten Öffnen des Nutzerkontos berechnet. Standardmäßig ist dieser auf 365 Tage gesetzt. ### Erweiterter Rückgabemodus -Wird hier der Haken gesetzt, wird die Bedinung der Anwendung geändert. Anstatt dass F5 zwischen Ausleihe und Rückgabe wechselt, wird, wenn die Rückgabe offen und ein Nutzer Offen ist, die Rückgabe zurückgesetzt. Diese Aktion orientiert sich an aDIS, dem Ausleihsystem der Bibliothek - - +Wird hier der Haken gesetzt, ändert sich die Bedienung der Anwendung. Der Shortcut "F5" wechselt nicht länger zwischen Ausleihe und Rückgabe. Stattdessen führt ein Druck auf "F5" dazu, dass das offene Rückgabekonto geschlossen wird. Dies ist dann vorteilhaft, wenn mehrere Medien von verschiedenen Personen zurückgebucht werden sollen. ### Datenbank Hier werden die Datenbankoptionen geändert. @@ -32,7 +30,7 @@ Hier werden die Datenbankoptionen geändert. Hier werden die Einstellungen für die Berichte geändert. - **Tag**: Der Wochentag, an dem die Berichte erstellt werden sollen -- **Berichte** erstellen: Ist der Haken gesetzt, werden Berichte erstellt +- **Berichte** erstellen: Ist der Haken gesetzt, werden Berichte automatisch erstellt - **Speicherpfad**: Speicherort für Berichte, standardmäßig ist dieser auf den Ordner der Anwendung gesetzt (report) !!! Info Automatische Berichte werden in diesem Format erstellt: @@ -41,7 +39,7 @@ Hier werden die Einstellungen für die Berichte geändert. Wird die Anwendung am Tag der Berichterstellung mehrfach geöffnet, wird nur ein Bericht erstellt ### Shortcuts -Hier können die Shortcuts angepasst werden. Um einen Shortcut zu ändern, muss ein Doppelklick auf das entsprechende Feld in der Spalte "Aktuell" gemacht werden. +Hier können die Shortcuts angepasst werden. Eine Änderung kann über einen Doppelklick auf das Feld "Aktuell" initiiert werden. Anschließend kann der gewünschte Shortcut eingegeben werden. (Eine Änderung der Shortcuts erfordert einen Neustart der Anwendung) @@ -53,7 +51,7 @@ Beim Datenbanknamen wird allerdings nur der Name der Datenbank übernommen ## Hinweis -Einige Aktionen (bspw. Änderungen der Shortcuts) erfordern einen Neustart der Anwendung. Dies wird beim Speichern der Einstellungen mit folgendem Dialog dargestelt: +Einige Aktionen (bspw. Änderungen der Shortcuts) erfordern einen Neustart der Anwendung. Dies wird beim Speichern der Einstellungen mit folgendem Dialog dargestellt: ![restart](images/restart.png) diff --git a/docs/Nutzeroberfläche.md b/docs/Nutzeroberfläche.md index 038e43a..dfdc317 100644 --- a/docs/Nutzeroberfläche.md +++ b/docs/Nutzeroberfläche.md @@ -2,12 +2,11 @@ ![alt text](images/user_main.png) !!! info - Die Nutzeroberfläche kann nur geöffnet werden, wenn ein Nutzer offen ist. Ansonsten wird ein Fehler angezeigt. (s. unten) + Die Nutzeroberfläche kann nur geöffnet werden, wenn ein Nutzer ausgewählt wurde. Ansonsten wird ein Fehler angezeigt. (s. unten) ![Error](images/err_nouser.png) # Bedeutung der Felder - - (1) Nutzerdaten: Name des Nutzers, Matrikelnummer, E-Mail @@ -19,15 +18,14 @@ - (4) Medien: - Umfasst unter anderem Feld (5), welches ein neues Fenster zum [verlängern](ausleihe verlängern.md) der Ausleihe öffnet. - Mit einem Klick auf - - - Alle Ausleihen - - Aktuell entliehen - - Überzogen + Umfasst unter anderem Feld (5), welches ein neues Fenster zum [verlängern](ausleihe verlängern.md) der Ausleihe öffnet. + Mit einem Klick auf + - Alle Ausleihen + - Aktuell entliehen + - Überzogen werden die Einträge der Tabelle gefiltert. Zusätzlich kann mithilfe der Eingabezeile unter den Filteroptionen gezielt nach einem Titel oder einer Signatur gesucht werden. - (5) Verlängern: - Um Medien zu verlängern, müssen diese in der Tabelle angeklickt werden. Mit Strg können mehrere Medien gleichzeitig ausgewählt und verlängert werden. Hierzu wird ein neues Fenster geöffnet, siehe [Ausleihe verlängern](ausleihe verlängern.md). + Um Medien zu verlängern, müssen diese in der Tabelle angeklickt werden. Mit Strg können mehrere Medien gleichzeitig ausgewählt und verlängert werden. Hierzu wird ein neues Fenster geöffnet, siehe [Ausleihe verlängern](ausleihe verlängern.md). diff --git a/docs/ausleihe verlängern.md b/docs/ausleihe verlängern.md index 6f79498..12bdc96 100644 --- a/docs/ausleihe verlängern.md +++ b/docs/ausleihe verlängern.md @@ -2,8 +2,7 @@ ![Oberfläche](images/extend.png) ## Information -Die Ausleihe verlängern kann nur geöffnet werden, wenn ein Nutzer offen ist. - -Diese Oberfläche erlaubt es, eine oder mehrere Medien zu verlängern. Hierzu muss ein neues, in der Zukunft liegendes Datum ausgewählt und mit OK bestätigt werden. +Um eine Ausleihe zu verlängern, öffnen Sie zunächst den Nutzer und klicken Sie auf "Fenster" > "Nutzer". Wählen Sie den oder die zu verlängernden Titel aus und klicken Sie auf "Ausgewählte Verlängern". Um mehrere Titel auf einmal zu verlängern, halten Sie die Strg-Taste gedrückt und klicken Sie auf die gewünschten Titel. Anschließend klicken Sie auf "Ausgewählte Verlängern". +Hierzu muss ein neues, in der Zukunft liegendes Datum ausgewählt und mit OK bestätigt werden. In der Datenbank wird nun das neue Datum gespeichert und die Einträge in der Tabelle werden aktualisiert. \ No newline at end of file