Mit DoCTA arbeiten

Einmalig einrichten

1. GitHub-Konto anlegen, falls du noch keines hast, und der Projektbetreuung deinen Benutzernamen schicken.
2. GitHub Desktop installieren und anmelden. Unter File → Clone Repository → URL diese Adresse eingeben und Clone wählen:

   https://github.com/DigitalHumanitiesCraft/DoCTA.git

   Klonen legt den Projektordner samt Versionsgeschichte auf deinem Rechner an.
3. Visual Studio Code installieren. Dort über File → Open Folder den geklonten DoCTA-Ordner öffnen. Über Terminal → New Terminal öffnest du das Eingabefenster für die folgenden Befehle. Gib sie einzeln ein und warte jeweils auf den Abschluss.

Windows

Installiere im Microsoft Store den Python Install Manager der Python Software Foundation. Öffne danach ein neues Terminal und installiere Python:

py install 3.14

Im VS-Code-Terminal des DoCTA-Ordners richtest du einmalig die Programmumgebung ein:

py -3.14 -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r editor-requirements.txt

macOS

Installiere Python 3.14 von python.org. Öffne anschließend ein neues VS-Code-Terminal im DoCTA-Ordner und führe aus:

python3.14 -m venv .venv
./.venv/bin/python -m pip install -r editor-requirements.txt

Die Einrichtung benötigt Internetzugriff. Die Pakete werden in der eigenen Programmumgebung .venv gespeichert.

Bei jeder Arbeitssitzung starten

Öffne den DoCTA-Ordner in VS Code und starte im Terminal unter Windows:

.\.venv\Scripts\python.exe pipeline/local_editor.py --open-browser

Auf macOS:

./.venv/bin/python pipeline/local_editor.py --open-browser

DoCTA öffnet sich im Browser. Lass das Terminal offen. Dieser Python-Server ermöglicht das Speichern. Die VS-Code-Erweiterung Live Server ist dafür nicht erforderlich. Quellenbilder können Internetzugriff benötigen.

Mit deinen Quellen arbeiten

Öffne unter Quellen ein Dokument. Bild und Transkription stehen nebeneinander. Über Ganze Seite setzt du den Bildausschnitt zurück.

Text korrigieren

Bearbeiten wählen, Kürzel eintragen und eine Zeile anklicken. Korrigiere anhand des Bildes. Enter übernimmt den Entwurf, erst Änderungen speichern speichert ihn dauerhaft. Lade zur Kontrolle neu. Eine falsche gespeicherte Lesung korrigierst du durch eine weitere gespeicherte Änderung. Schalte Bearbeiten anschließend wieder aus.

Personen und Begriffe annotieren

1. Markiere eine Stelle innerhalb einer Textzeile. Wähle Person, Begriff, Ort oder Datumsangabe. Falls das Auswahlfeld fehlt, nutze Auswahl annotieren.
2. Trage dein Kürzel ein. Suche bei Personen, Begriffen oder Orten einen passenden Eintrag oder wähle Neuer Registereintrag und speichere ihn mit Eintrag speichern. Jede Zuordnung entscheidest du selbst.
3. Wähle anschließend Fundstelle speichern. Der Registereintrag beschreibt die Person oder den Begriff, die Fundstelle verknüpft ihn mit dieser Textstelle. Deshalb sind beide Speicherschritte nötig.
4. Unter Index findest du deine Personen, Orte und Begriffe wieder. Die Fundstellen führen zurück zum Text. Datumsangaben bearbeitest du direkt an ihrer Stelle.

Eine vorhandene Markierung anklicken, um sie zu ändern oder mit Fundstelle entfernen zu löschen. Der Quellentext bleibt erhalten. Nach einer Textkorrektur prüfe die betroffenen Annotationen erneut.

Sichern und beenden

Speichere offene Textkorrekturen und Fundstellen jeweils ausdrücklich. Beende DoCTA im Terminal mit Strg+C beziehungsweise Ctrl+C. Sichere den gesamten Projektordner auf einem separaten Laufwerk. Ungespeicherte Browserentwürfe gehören nicht zur Sicherung.

Deine Bearbeitungen bleiben zunächst auf deinem Rechner. Ein Git-Commit hält einen lokalen Versionsstand fest. Erst Push origin lädt ihn in das öffentliche Repository. Stimme vorher ab, welche Daten veröffentlicht werden dürfen.

Die README erklärt GitHub-Austausch, Updates und Wiederherstellung.

Bei Fragen oder Fehlermeldungen melde dich mit Quelle, Seite und der ausgeführten Handlung, gerne mit Screenshot. Bewahre ungespeicherte Eingaben vor einem Neuladen separat auf.