Basis-Setup
Das Basis-Setup macht mit ediarum eine Arbeitsumgebung für wissenschaftliche Editionen verfügbar. Nach erfolgreichem Setup können Editor:innen in dieser visuellen, Word-ähnlichen Umgebung TEI-konforme XML-Daten mit Registern, Kommentaren u.ä. erstellen.
Ü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.
Überblick über das Basis-Setup
ediarum steht auf github zur Verfügung, in Form von Konfigurationskomponenten für den Oxygen XML Author (den sogenannten Frameworks) und für die XML-Datenbank eXist-db (den sogenannten Apps).
Installationstipps eXist-db und Oxygen
Die Installationsanleitungen für eXist-db und Oxygen finden Sie auf deren Webseiten. Die hier versammelten zusätzlichen Tipps basieren auf der Erfahrung der ediarum-Entwickler:innen und können bei typischen Installationsproblemen hilfreich sein.
Datenbank einrichten
Sie installieren sich die eXist-App ediarum.DB. Mithilfe dieser App generieren Sie in Ihrer Datenbank ein eigenes Projekt, das alle benötigten Settings für das Zusammenspiel von Datenbank und Oxygen XML Author enthält.
Arbeitsumgebung in Oxygen XML Author einrichten
Sie verbinden Oxygen XML Author mit eXist-db (Datenbank) und machen alle in ediarum enthaltenen Funktionalitäten verfügbar.
ediarum.DB App updaten
Über das Dashboard der eXist-db können Sie ediarum.DB mithilfe der XAR-Datei updaten/downgraden.
Ein externes Add-On updaten
Sie überprüfen Ihre in Oxygen installierten Add-Ons (z.B. ediarum.BASE.edit oder ediarum.REGISTER.edit) auf Updates.
Grundlagen und Funktion von ediarum.PDF
ediarum.PDF ist ein in ediarum.BASE.edit integriertes Feature, um direkt aus der Arbeitsoberfläche von Oxygen XML heraus XML-Dokumente als PDF auszugeben.
Framework als Add-On erstellen und installieren
Sie speichern das erstellte Framework als Add-On, um es auf anderen Rechnern installieren und zentral updaten zu können.
Editionsspezifische Konfiguration
Wenn für Ihre Edition ein umfassenderes XML-Schema benötigt wird als das mit ediarum abgedeckte, können Sie das Schema und die Arbeitsumgebung erweitern. Sie können außerdem zusätzliche Register erstellen.
Über Oxygen-Frameworks und ediarum-Spezifika
Das grundsätzliche Vorgehen für die Konfiguration via sogenannter "Frameworks" finden Sie in der Oxygen-Dokumentation. Ediarum stellt für diese Konfiguration einige Standardbausteine bereit.
ediarum-ID-Generator anpassen
Der durch ediarum implementierte ID-Generator kann bei Bedarf deaktiviert oder nachträglich angepasst werden.
Ein eigenes Register anlegen
Wenn Sie ein Register benötigen, das nicht bereits als Standardregister in ediarum enthalten ist, legen Sie dieses in eXist-db in der ediarum.DB-App an und verknüpfen es anschließend mit Oxygen.
Literaturbestände aus Zotero als Register einbinden
Wenn Sie ihre Literaturbestände über Zotero verwalten, können Sie diese auch als Register in ediarum einbinden und so auf die entsprechende Literatur verweisen.
Die Projekt-Website aufrufen.
In ediarum.BASE ist die Verlinkung zur Homepage der Projekt-Website aus Oxygen heraus als Standard implementiert und muss nur noch aktiviert werden.
Ein projektspezifisches Layout anlegen.
Sie können die Nutzeroberfläche von Oxygen an die Bedürfnisse Ihres Projektes anpassen.
Eigene Aktionen anlegen
Wenn Ihnen die von Oxygen oder ediarum mitgelieferten Aktionen nicht ausreichen, können Sie auch selber neue Aktionen definieren und in Ihr Framework einbinden.
ediarum.PDF im angepassten Projekt verwenden
Sie können ediarum.PDF in Ihr eigenes Framework einbinden, um hier die PDF-Ausgabe nach projektspezifischen Bedürfnissen frei anzupassen.
Tipps und Fehler
Einige Tipps und Lösungshilfen zu häufig auftretenden Fehlermeldungen.
Fehler
Einige häufig auftretende Fehler bei der Arbeit mit ediarum und Oxygen XML und die zugehörigen häufigsten Fehlerquellen. Diese sollen einen Ansatzpunkt bei der Fehlersuche bieten.
Tipps
Tipps und wiederkehrende Routinen, die beim Arbeiten und der Fehlersuche mit ediarum und Oxygen XML helfen.
eXist-db – Tipps und Troubleshooting
Fehler und Tipps zur Installation und Nutzung der eXist-db.