Über diese Anleitung
Das Basis-Setup macht ediarum zunächst in der Standardvariante verfügbar, ohne besondere Konfigurationen für Ihr Editionsprojekt und ohne dass Sie Programmierkenntnisse benötigen.
Über ediarum
Nutzung:
Ediarum ist eine Arbeitsumgebung für wissenschaftliche digitale Editionen. Editor:innen können in dieser Arbeitsumgebung TEI-XML-basierte Transkriptionen von Textquellen erstellen und bearbeiten, ohne über vertiefte XML-Kenntnisse zu verfügen. Dabei können die Editor:innen Textphänomene auszeichnen, Sacherläuterungen einfügen, Links zu Registern setzen, Registereinträge pflegen und mit Normdaten ausstatten. Das Basis-Setup stellt mit ediarum.BASE.edit ein auf historische (früh-)neuzeitliche Quellen ausgerichtetes Datenmodell zur Verfügung, das auf dem Basisformat des Deutschen Textarchivs basiert (DTA-Basisformat).
Technische Komponenten:
Auf technischer Ebene stellt ediarum folgende Komponenten zur Verfügung:
- ediarum.BASE.edit: Framework für Oxygen XML Author für Text-Transkriptionen
- Enthält ediarum.jar, eine Java Bibliothek zur Erweiterung des oXygen XML Editors mit ediarum-Komponenten.
- ediarum.REGISTER.edit: Framework für Oxygen XML Author für Register
- ediarum.DB: eXistdb App für die Datenverwaltung passend zu ediarum.BASE.edit und ediarum.REGISTER.edit
Setup-Varianten
Diese Anleitung beschreibt das Basis-Setup von ediarum. Sie beschreibt nicht die editionsspezifische Konfiguration und Erweiterung, liefert aber einige Grundinformationen dazu.
Basis-Setup: Sie bringen ediarum zum Laufen, sodass die mitgelieferten Eingabefunktionalitäten für das mitgelieferte XML-Schema zur Verfügung stehen. Das Basis-Setup umfasst auch die Einrichtung eines Personenregisters und eines Ortsregisters sowie der entsprechenden Eingabefunktionalitäten.
Editionsspezifische Konfiguration und Erweiterung: Wenn ediarum läuft, können Sie der Arbeitsumgebung eigene Funktionalitäten hinzufügen, z.B. für editionsspezifische TEI-Elemente. Sie können mitgelieferte Eingabefunktionalitäten für weitere Register (z.B. Werkregister) aktivieren oder eigene Register hinzufügen.
An wen sich diese Anleitung richtet
Das Basis-Setup von ediarum können Sie durchführen, wenn Sie grundlegende IT-Kenntnisse in den Digital Humanities haben. Wenn das Setup einmal abgeschlossen ist, können Sie es als Add-On an die Editor:innen Ihrer Editions-Arbeitsgruppe weitergeben.
Vorwissen, um das Setup durchzuführen:
- Grundverständnis von XML, XML-Schemata
- Kenntnis des Dashboards der eXist-db, d.h. der graphischen Oberfläche für die Arbeit mit Ihrer Datenbank
- Grundverständnis von github
Vorwissen, um mit ediarum editorisch zu arbeiten:
- Grundverständnis von XML und TEI
- Vertrautheit mit Oxygen XML Author
Voraussetzungen
- Oxygen XML Author ist installiert, mindestens in der Version 24.0 (alternativ: Oxygen XML Editor).
- eXist-db ist installiert, in der Version 5.3.1 (oder höher).
Feedback
Wir sind jederzeit froh über Feedback zu dieser Anleitung an jan.wierzoch@bbaw.de.
Wir planen, in naher Zukunft die XML-Dateien zu dieser Anleitung auf github zur Verfügung zu stellen, sodass Sie direkt Ergänzungen beitragen können.
Was ist neu in dieser Dokument-Version?
v2.0 vom 08.05.2024
- Neuer Abschnitt zum ID-Generator bei der Projekterstellung sowie zur Anpassungen des Namespace von Projekten in ediarum ("ediarum-ID-Generator anpassen.
- Neuer Abschnitt: "ediarum.DB App updaten.
- Neuer Abschnitt: ediarum.PDF (Grundlagen in "Grundlagen und Funktion von ediarum.PDF" und Einrichtung in "ediarum.PDF im angepassten Projekt verwenden").
- Neuer Abschnitt: "Framework als Add-On erstellen und installieren" zum ausspielen, installieren, updaten und deinstallieren von Add-Ons.
- Neuer Abschnitt: "Ein externes Add-On updaten".
- Neuer Abschnitt: "ediarum-Register mit Oxygen-Projekt verknüpfen" (inklusive einer genaueren Beschreibung der Editorvariablen).
- Neuer Abschnitt: "Ein projektspezifisches Layout anlegen.".
- Neuer Abschnitt: "Die Projekt-Website aufrufen.".
- Neues Kapitel: "Tipps und Fehler" mit Unterkapiteln:
-
"Fehler
- Oxygen zeigt ein falsches Layout
- Fehler beim Verweis in das Register
- URLs werden als ptr-Elemente eingefügt
-
"Tipps
- Ist das Framework aktiv?
- Die Projektdatei laden
- "eXist-db – Tipps und Troubleshooting
-
"Fehler
- Es wurde ein Hinweis auf das neue Beispiel-Projekt Repo (ediarum.BASE.template) hinzugefügt.
- Screenshots für eXist-Version 5 aktualisiert.
- kleinere Bugfixes und Anpassungen
v1.3 vom 12.10.2021
- Umstellung auf eXist-DB Version 5 und ediarum.DB Version 4
- Kapitel "Literaturbestände aus Zotero als Register einbinden" erweitert
- Neues Concept "Eigene Aktionen anlegen". (Wird später erweitert.)
- Erläuterung der durch ediarum eingerichteten Ordnerstruktur in Projekt in der Datenbank anlegen
- kleinere Bugfixes und Anpassungen
Änderungsverlauf
Dokument-Version | Publikations-Datum | Software-Versionen | Änderungen |
---|---|---|---|
v2.0 | 08.05.2024 |
Oxygen XML Author v24.0 eXist-db v5.3.1 ediarum.BASE.edit v2.0.0 ediarum.DB v4.1.0 ediarum.REGISTER.edit v2.0.0 |
Anpassungen nach Weiterentwicklungen von ediarum (u.a. Breaking Change ID-Generator). |
v1.3 | 12.10.2020 |
Oxygen XML Author v20.1 eXist-db v5.2 ediarum.BASE.edit v1.1.1 ediarum.DB v4.0.1 ediarum.REGISTER.edit v1.0.3 |
Anpassungen nach Lokalisierung und eXist-db Update. |
v1.1.2_localization | 03.12.2020 (not published, for internal use only) |
Oxygen XML Author v20.1 eXist-db v3.5 oder v4.4 ediarum.BASE.edit v1.1.1 ediarum.DB v3.2.5 ediarum.REGISTER.edit v1.0.1 |
Korrekturen aufgrund des ediarum-Workshops 09.-11.03. 2020. |
v1.2 | 12.02.2020 |
Oxygen XML Author v20.1 eXist-db v3.5 oder v4.4 ediarum.BASE.edit v1.1.1 ediarum.DB v3.2.5 ediarum.REGISTER.edit v1.0.1 |
Erstpublikation auf https://www.ediarum.org |