QAnnotate ist eine Software zur Annotation und Kommentierung von Texten, die im Rahmen des Projekts Humanist Computer Interaction auf dem Prüfstand (Humanist) entwickelt wurde. Ihr Zweck ist die Erstellung und Bearbeitung einer Datenbank mit prinzipiell unbeschränkten Anzahl von Entitäten, mit denen sich wiederum beliebig viele, auch sich überschneidende Textpassagen verknüpft werden können. Das Dateisystem wird als Datenbank-Backend verwendet, um die Datenbankverwaltung mit Git zu ermöglichen. Das Dateiformat wurde so gestaltet, dass es sich gut mit einem Git-Repository verwalten lässt.
Disclaimer
Die aktuelle Version ist auf spezifische Anforderungen im Rahmen des Humanist-Projekts zugeschnitten: die Annotation und Kommentierung von Briefsammlungen, konkret: der Variae Cassiodors, einer Sammlung ostgotischer Königsbriefe aus der ersten Hälfte des 6. Jahrhunderts, die von Spätantike-HistorikerInnen der JGU bearbeitet wird, um daraus automatisch die Herausgabe eines kommentierten Bandes (LINK: 3.Buch der Variae) zu generieren.
Im Laufe des Projekts haben die sich ständig ändernden Anforderungen an die Software ein inkohärentes Design hervorgebracht, welches einerseits bestimmte Arten von Änderungen leicht integrierbar, andere wiederum nur unter größerem Aufwand möglich macht. Wir glauben dennoch, dass die Kernidee des Projekts – die Schaffung einer konfigurierbaren GUI mit einem Git-Datenbank-Backend – es wert ist, auch in Zukunft und in anderen Projekten weiterverfolgt zu werden.
Trotz dieser Unannehmlichkeiten kann und soll gerne mit der aktuellen Version experimentiert werden, sowohl mit dem ausführbaren Programm als auch mit der Codebasis,.
Zur Verfügung steht derzeit die vorkompilierte, ausführbare Datei: QAnnotate (for Windows)
Die Dokumentation der Software findet sich im QAnnotate GitHubRepository
Die Datei build.sh enthält Anweisungen zur Bearbeitung und Veränderung der Software. Die Datei qannotate.ini wird zur Identifikation des Datenbank-Ordners bei der Ausführung des Programms benötigt.
Erstellung eines Datenbank-Ordners
Zunächst wird der Datenbank-Ordner auf Ihrem lokalen Rechner angelegt.
• Erstellen Sie einen leeren Ordner auf Ihrem Rechner
• Laden Sie die Datei qannotate.ini aus dem QAnnotate Repository herunter und kopieren Sie diese in den von Ihnen erstellten Ordner.
Starten von QAnnotate
Laden Sie die aktuelle Version von QAnnotate herunter und entpacken Sie das zip-file auf Ihrem Rechner. Es ist keine Installation erforderlich, das Programm kann direkt gestartet werden.
• Gehen Sie im Menü auf Datei → Öffnen und wählen Sie den Datenbank-Ordner, den Sie zuvor erstellt haben.
• Auf der linken Seite sollte nun ein Objektverzeichnis zu sehen sein.
Objekte hinzufügen/bearbeiten
• Um ein neues Objekt bzw. eine neue Unterkategorie anzulegen, klicken Sie mit der rechten Maustaste auf ein Element im Objektverzeichnis.
• Um ein vorhandenes Objekt zu bearbeiten, doppelklicken Sie auf das Objekt im Objektverzeichnis.
Annotation von Texten
Die annotierbaren Originaltexte finden Sie innerhalb der Kategorie Texte → Liber <Nummer> im Objektverzeichnis. Immer wenn Sie einen Brief innerhalb dieser Kategorie erstellen, werden Sie aufgefordert, neben der Briefnummer auch den Inhaltstext einzugeben.
In den folgenden Schritten wird ein neuer annotierbarer Text erstellt:
• Erstellen Sie ein neues Buch unter Texte im Objektverzeichnis. Weisen Sie dem Buch eine Nummer zu.
• Erstellen Sie einen neuen Brief innerhalb der Unterkategorie Liber <Nummer>.
• Weisen Sie dem Brief eine Nummer zu und fügen Sie den zu annotierenden Text in das Feld Inhalt ein.
• Ein Doppelklick auf das resultierende Unterobjekt Epistula <Nummer> öffnet nun die GUI mit dem annotierbaren Text.
Objekte referenzieren
QAnnotate selbst beinhaltet nicht das Konzept querverweisender Links. Es ist lediglich als Fenster zu den Dateien innerhalb des Datenbankordners angelegt. Im Rahmen des Humanist-Projekts verwenden wir eine modifizierte Form der Wikipedia-Syntax, die von einem nachfolgenden Skript verarbeitet wird.
Lizenz
Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE.md
Beteiligte
Entwicklung: Torsten Schenk in Kollaboration mit dem geschichtswissenschaftlichen Fachteam am Arbeitsbereich Alte Geschichte am Historischen Seminar der JGU Mainz, Ein Großteil der GUI-Programmierung innerhalb des Projekts wurde von Christoph Kalchreuter durchgeführt.
zurück zur Humanist Projektseite am Institut
