Dieses Handbuch bezieht sich momentan nur auf die Desktop Version. Die Webseite wird hinzugefügt werden, wenn ich sie entwickelt habe.
Die Desktop Version (auch Applikation genannt) ist in fünf Tabs gegliedert, die in der Leiste oben links ersichtlich sind. Das wechseln zwischen Tabs funktioniert einfach durch anklicken des gewünschten Ziel-Tabs.
Die Eingaben werden zwar im UTF-8 Format gespeichert, es sollten dennoch keine Unicode Zeichen, wie Emojis, eingefügt werden, da dies die Applikation zum Absturz bringt (Python kann Unicode Zeichen nicht richtig darstellen). Sonderzeichen ihrer Anzeigesprache (wie die deutschen Umlaute) scheinen dennoch zu funktionieren.
Sollten Fehler auftreten, befinden sich weiter Informationen dazu in der log.txt Datei, die von der Applikation automatisch angelegt wird. Diese ist vor allem für den Entwickler zur Fehlerbehebung sehr hilfreich. Bitte beachten Sie, das die Datei beim erneuten Start der Applikation überschrieben wird. Sollten Sie also einem Fehler begegnen, kopieren Sie sich bitte die log.txt Datei, wenn Sie den Fehler auch auf Github melden wollen. Ich würde mich sehr darüber freün und natürlich versuchen ihn zu beheben.
Die folgenden Tabs sind momentan enthalten:
Laden Sie Python herunter, wenn Sie es nicht bereits installiert haben. Getestet wurde das Programm mit Version 3.13.1.
Linux Benutzer sollten Python uber den Packetmanager iher Distribution installieren.
Für Windows Benutzer befindet sich der Download auf der offiziellen Seite der Python Software Foundation.
WICHTIG für Windows Benutzer: aktivieren Sie bei der Installation die Option Python zum PATH hinzufügen (add python to PATH)!
Entscheiden Sie sich für einen Installationsordner für die Applikation. Soll die Datenbank von mehrern Benutzer verwendet werden, empfiehlt es sich, als Installationsordner einen geteilten Netzwerk- oder Cloudordner zu verweden. Beispielsweise ein Netzlaufwerk oder ein Gruppenordner in Nextcloud (meine Wahl).
Dann sollten Sie eine Ordner namens src im Installationsordner erstellen. Dieser wird als Speicherort für den Qüllcode dienen.
Laden Sie nun den Qüllcode herunter. Dafür haben Sie folgenden Möglichkeiten:
src Ordner entzippen. ODERsrc Ordner klonen und den Commit des zu installierenden Releases auschecken.Als nächstes öffnen Sie den src Ordner im Terminal (Windows: CMD oder Terminal auf Windows 11) und erstellen eine virtülle Umgebung für Python:
Das funktioniert folgendermassen: python -m venv NAME, wobei Sie NAME mit dem gewünschten Namen der virtüllen Umgebung ersetzen. Standard ist (zumindest für mich venv oder env.
Nun müssen Sie die Packete aus der requirements-Desktop.txt Datei installiert werden. Am einfachsten geht das mit dem Befehl NAME\Scripts\pip.exe install -r requirements-Desktop.txt auf Windows und NAME/bin/pip install -r requirements-Desktop.txt auf Linux. Achten Sie wieder darauf, NAME mit dem von Ihnen gewählten Namen zu ersetzen
Windows benutzer können ihr Terminal/ ihre CMD jetzt schliessen.
Als nächstes sollten wir Ihnen eine Möglichkeit geben, die Applikation einfacher zu starten. Auf Windows wäre das etwas eine Verknüpfung, auf Linux ein Script für ihre Shell.
öffnen Sie zunächst den Installationsordner im Explorer und machen einen Rechtsklick auf eine leere Fläche. Wählen Sie nun Neu -> Verknüpfung aus. Geben Sie nun den Pfad des Installationsordners ein (Sie können ihn aus der Addressleiste oben im Explorer kopieren) ein und fügen Sie folgendes hinzu: src\NAME\Scripts\pythonw.exe. Klicken Sie auf weiter und wahelen Sie einen Namen wie Lerchbacher Bücherdatenbank.
Machen Sie nun einen Rechtsklick auf die neue Verknüpfung und wählen Sie "Eigenschaften". Nun müssen wir zwei Kleinigkeiten ändern:
Als erstes wenden wir uns dem Ziel zu: fügen Sie am Ende der Zeile, ausserhalb der Anführungszeichen, folgendes hinzu: src\Desktop\main.py.
Danach ändern wir etwas in Ausfüheren in: ersetzen Sie src\NAME\Scripts\ durch src\Desktop.
Jetzt sollten Sie in der Lage sein, die Applikation über die Verknüpfung zu starten.
Unter Linux ist meine Empfehlung, ein einfaches Skript für Ihre Shell zu schreiben, dass die Applikation startet. Dieses sollte sich direkt im Installationsordner befinden. Ich kenne mich nicht gut mit den verschiedenen Shells aus, deshalb könnte es sein, dass mein Beispiel bei Ihnen nicht funktioniert. In dem Fall, fragen Sie bitte eine Person, die sich mit der Shell auskennt, ob sie ihnen helfen kann. Ersetzen Sie ausserdem SHELL durch ihre Shell und NAME durch den Namen der venv.
#!/bin/SHELL
src/NAME/bin/python src/Desktop/main.py
Zum Schluss müssen Sie das Skript noch ausfürbar machen. Das funktioniert mit dem Befehl chmod +x SKRIPT, wobei SKRIPT der Name des Skripts ist.
Der übersicht Tab zeigt die 12 zuletzt hinzugefügten Bücher und Autoren an. Ebenfalls finden Sie hier eine Anzeige der aktuell installierten Version, sowie den Link zum zur Version passenden Handbuch.
Bücher und Autoren lassen sich über den "Mehr anzeigen" Knopf ausklappen. Dadurch werden mehr Informationen und Optionen angezeigt, wie etwas "Bearbeiten" und "Löschen".
Der Bücher Tab enthält eine Liste alle Bücher, die in der Datenbank gespeichert sind. Ebenfalls findet sich dort die Möglichkeit, neue Bücher hinzuzufügen. Auch hier lassen sich Bücher über den "Mehr anzeigen" Knopf ausklappen. Dadurch werden mehr Informationen und Optionen angezeigt, wie etwas "Bearbeiten" und "Löschen".
Ein Klick auf den Knopf "Neues Buch hinzufügen" öffnent einen leeren Buch-Bearbeitungs Dialog.
Der selbige wird auch geöffnet, sollten Sie bei einem Buch "Bearbeiten" wählen.
In diesem finden sich eine Vielzahl an Eingabefeldern. Die Felder, die mit einem * markiert sind, müssen immer ausgefüllt werden, die übrigen sind optional. Alle sind beschriftet, aber wir gehen Sie hier trotzdem einmal durch.
Dieses Feld speichert den Titel eines Buches.
Dieses Feld erlaub ihnen, eine beliebige Anzahl an Autoren zum Buch hinzuzufügen. Bitte beachten Sie, dass mindestens 1 Autor angegeben werden muss! Sollten Sie also ein Buch von einem unbekannten Autor eintragen wollen, empfiehlt es sich, einen "Unbekannt" Autor hinzuzufügen. (Siehe 5. Autoren)
Neben der Möglichkeit, nach Büchern zu suchen, finden Sie hier ebenfalls einen Knopf, um einen neuen Autor zu erstellen.
Sehen wir es uns nun etwas genauer an:
> Knopf verschiebt alle markierten Autoren von der linken auf die rechte Seite.< Knopf verschiebt alle markierten Autoren von der rechten auf die linke Seite.>> Knopf verschiebt alle Autoren von der linken auf die rechte Seite, egal ob gewählt oder nicht.<< Knopf verschiebt alle Autoren von der rechten auf die linke Seite, egal ob gewählt oder nicht.Hier könne Sie den Verlag / Herausgeber des Buches eintragen
Dieses Feld bietet die Möglichkeit, die ISBN-13 des Buches einzugeben. Die Beistriche zwischen den verschiedenen Segmenten werden automatisch gesetzt. Die Länge dieses Feldes wurde, Aufgrund des einzugebenden Wertes, auf 13 Zeichen, ausgenommen der Beistriche, begrenzt. Schreiben Sie bitte nicht zu schnell, da die Formatierung etwas langsam ist. Zur Referenz, die ISBN-13 hat die Form xxx-x-xxx-xxxxx-x. Sollten Sie nur eine kürzere ISBN finden, die mit 3 beginnt, können Sie einfach 978 davorstellen um Sie zu auf das neue Format zu übertrage (es handelt sich dabei um ältere Versionen des ISBN-Formats).
Hier könne Sie die Auflage des Buches eintragen. Der akzeptierte Wertebereich liegt zwischen 1 und 20.
Dieses Feld speichert den Buchtypen des Buches. Dieser kann aus der Liste gewählt werden, die beim Klicken auf den kleinen Pfeil rechts angezeigt wird. Bitte prüfen Sie vor Erstellen des Buches, ob der gewünschte Buchtyp bereits existiert (6. Buchtypen) Das Feld verfügt ausserdem über eine Autovervollständigung für die möglichen Buchtypen. Sie können also den Anfang eines Typen eingeben und bekommen einen Vorschlag zur Vervollständigung.
Hier könne Sie Kategorien oder Stichwörter zum Buch eintragen. Die einzelnen Einträge können Leerzeichen enthalten und werden durch Semikolone(';') getrennt.
Dieses Feld speichert den Raum des Buches. Dieser kann aus der Liste gewählt werden, die beim Klicken auf den kleinen Pfeil rechts angezeigt wird. Bitte prüfen Sie vor Erstellen des Buches, ob der gewünschte Raum bereits existiert (7. Räume) Das Feld verfügt ausserdem über eine Autovervollständigung für die möglichen Räume. Sie können also den Anfang eines Raumes eingeben und bekommen einen Vorschlag zur Vervollständigung.
Hier können Sie das Regal eintragen, in dem das Buch normalerweise steht.
Speichert, ob das Buch im Moment verliehen ist oder nicht. Den Zustand des Felder ändern Sie durch anklicken.
Dieses Feld wird nur angezeigt, wenn im vorherigen Feld angegeben wurde, dass das Buch momentan verliehen ist. Hier kann eingetragen werden, an welche Person das Buch vergeben wurde.
Am unteren Ende der Bearbeitungs- und Erstellungsdialoge befinden sich der "Speichern" und der "Abbrechen" Knopf.
Der Speichern Knopf speichert die Daten der Felder in der Datenbank ab und schliesst den Dialog. Wurde der Dialog über den "Neues Buch hinzufügen" Knopf geöffnet, wird ein neues Buch erstellt. Das drücken von "Enter", während dieser Dialog geöffnet ist, speichert ebenfalls.
Der Abbrechen Knopf schliesst den Dialog, ohne die gemachten änderungen/Eintragungen in der Datenbank zu speichern.
Diese beiden Knöpfe werden in der ganzen Applikation mehrmals verwendet.
Der Autoren Tab enthält eine Liste alle Autoren, die in der Datenbank gespeichert sind. Ebenfalls findet sich dort die Möglichkeit, neue Autoren hinzuzufügen. Auch hier lassen sich Autoren über den "Mehr anzeigen" Knopf ausklappen. Dadurch werden mehr Informationen und Optionen angezeigt, wie etwas "Bearbeiten" und "Löschen".
Ein Klick auf den Knopf "Neuen Autor hinzufügen" öffnet einen leeren Autoren-Bearbeitungs-Dialog.
Der selbige wird auch geöffnet, sollten Sie bei einem Autor "Bearbeiten" wählen.
In diesem finden sich einige Eingabefelder. Alle sind beschriftet, aber wir gehen Sie hier trotzdem einmal durch.
Dieses Feld ist für den Namen des Autors.
Hier können Sie die Nationalität des Autors eintragen.
In diesem Feld können Sie das Geburtsdatum des Autors angeben.
Es gibt hier 1 Sonderdatum: wird der 12.12.2200 eingetragen, erkennt die Applikation dies als "Unbekanntes Geburtsdatum"
In diesem Feld können Sie das Sterbedatum des Autors angeben.
Es gibt hier 2 Sonderdaten:
- wird der 12.12.2200 eingetragen, erkennt die Applikation dies als "Unbekanntes Sterbedatum"
- wird der 5.5.2200 eingetragen, erkennt die Applikation dies als "Ist noch am Leben"
Hier können Sie auswählen, ob der Autor ein Nobelpreisträger ist. ändern des Zustands des Feldes funktioniert durch anklicken.
Am unteren Ende der Bearbeitungs- und Erstellungsdialoge befinden sich der "Speichern" und der "Abbrechen" Knopf.
Der Speichern Knopf speichert die Daten der Felder in der Datenbank ab und schliesst den Dialog. Wurde der Dialog über den "Neuen Autor hinzufügen" Knopf geöffnet, wird ein neuer Autor erstellt. Das drücken von "Enter", während dieser Dialog geöffnet ist, speichert ebenfalls.
Der Abbrechen Knopf schliesst den Dialog, ohne die gemachten änderungen/Eintragungen in der Datenbank zu speichern.
Diese beiden Knöpfe werden in der ganzen Applikation mehrmals verwendet.
In diesem Tab finden Sie eine Auflistung aller in der Datenbank gespeicherten Buchtypen. über den "Neen Buchtypen hinzufügen" Knopf könne Sie einen neuen Buchtypen anlegen. über den "Bearbeiten" Knopf neben jedem Buchtypen lässt sich der Name des Typen ändern und über den "Löschen" Knopf aus der Datenbank entfernen. Das drücken von "Enter", während dieser Dialog geöffnet ist, speichert ebenfalls.
Hier können Sie den Namen des Buchtypen ändern, bzw. einen neuen mit dem angegebenen Namen erstellen.
In diesem Tab finden Sie eine Auflistung aller in der Datenbank gespeicherten Räume. über den "Neuen Raum hinzufügen" Knopf könne Sie einen neuen Raum anlegen. über den "Bearbeiten" Knopf neben jedem Raum lässt sich der Name des Raumes ändern und über den "Löschen" Knopf aus der Datenbank entfernen. Das drücken von "Enter", während dieser Dialog geöffnet ist, speichert ebenfalls.
Hier können Sie den Namen des Raumes ändern, bzw. einen neuen mit dem angegebenen Namen erstellen.
Der Suchen Tab stellt ihnen die Möglichkeit, die Datenbank zu dursuchen, zur verfügung.
Sie können wählen, ob sie eine generelle Suche nach einem Stichwort, oder eine Suche nach einem bestimmten Art von Eintrag in der Datenbank (Buch, Autor, Buchtyp oder Raum) durchführen möchten.
Wenn Sie ihre Auswahl ändern, wird Ihnen eine andere Sammlung an Suchfeldern angezeigt. Diese Unterscheiden sich nur minimal von den Bearbeitungs-Dialogen der einzelnen Eintragstypen.
Leergelassene Suchfelder werden meist ignoriert (Aussnahmen siehe unten).
Die Unterschiede werden im Folgenden erläutert:
Mit dieser Option könne Sie eine Suche nach einem bestimmten Stichwort in den Titeln/Namen aller Einträge in der Datenbank durchführen. Die Ergebnisse werden nach Eintragstyp gegliedert angezeigt.
Diese Option lässt Sie nach Büchern suchen. Die Suchfelder, die hier angezeigt werden, sind eine Kopie des Bearbeitungs-Dialoges für Bücher, abgesehen vom "Verliehen" Feld.
Dieses wurde durch ein Textfeld mit Autovervollständigung ersetzt (Ja, Nein).
Diese Option lässt Sie nach Autoren suchen. Die Suchfelder, die hier angezeigt werden, sind eine Kopie des Bearbeitungs-Dialoges für Autoren.
Die änderungen an diesen Suchfeldern betreffen:
1. die Sonderdaten der Datumsfelder:
bei beiden Feldern wurde das Datum 1.1.2200 als Equivalenz zum Leerlassen des Feldes hinzugefügt. Bitte lassen Sie die Datumsfelder nicht frei! Dies führt zu einem Fehler in der Applikation.
2. Das "Ist ein Nobelpreisträger?" Feld: Dieses wurde durch ein Textfeld mit Autovervollständigung ersetzt (Ja, Nein).
Hier können Sie nach Buchtypen suchen, die den Inhalt des Eingabefelds in ihrem Titel haben.
Hier können Sie nach Räumen suchen, die den Inhalt des Eingabefelds in ihrem Titel haben.
^