Application Programming Interface (API)
Software und technische Realisierung
Die Eingabe aller Texte und Daten erfolgt mit der Open-Source-Software ediarum, die seit 2012 von der DH-Initiative TELOTA an der BBAW entwickelt wird. Ediarum ist eine digitale Arbeitsumgebung, die es Wissenschaftler/innen ermöglicht, Transkriptionen von Manuskripten in TEI-konformem XML zu bearbeiten, mit einem Text- und Sachapparat zu versehen und anschließend im Druck und im Web zu veröffentlichen. Ediarum besteht aus verschiedenen Softwarekomponenten, die auf oXygen aufbauen und eine angepasste Benutzeroberfläche des XML-Authors zur Eingabe und Bearbeitung von digitalen Editionen bietet. Die Eingabeoberfläche wurde darüber hinaus für die individuellen Bedürfnisse des Projekts „Anpassungsstrategien der späten mitteleuropäischen Monarchie am preußischen Beispiel 1786 bis 1918“ erweitert. Die Texte und Daten werden in einer eXist XML-Datenbank gespeichert.
Die digitale Ausgabe erfolgt mit XQuery, XSLT, XPath und JavaScript und wird unter Verwendung von Bootstrap publiziert. Eine Volltextindizierung erfolgt durch Lucene. Geodaten werden in einer Tabelle (Excel) verwaltet. Die Website ist prinzipiell auf allen Endgeräten nutzbar (responsive), wir empfehlen jedoch für die intensive Nutzung einen Desktop-Computer.
Für die spezifischen Daten des hier präsentierten Akademienvorhabens wie die Organigramme, das Hofkalendarium und die Wohntopographie werden zurzeit neue Eingabe- und Ausgabekomponenten entwickelt.
Daten und Schnittstellen
Datenangebot und Schnittstellen für externe Webangebote
TEI-XML-Schnittstelle
Die Texte des Vorhabens können über die Schnittstelle https://actaborussica.bbaw.de/api/tei-xml bezogen und im Rahmen der freien Lizenz CC BY-SA 4.0 weiterverwendet werden. Darüber hinaus können die Texte unter den jeweiligen Menüpunkten einzeln heruntergeladen werden (siehe Zitierhinweise).
Die API generiert eine Liste aller verfügbaren Versionen der Daten. Um eine Liste der Dokumente einer bestimmten Version gezielt aufzurufen wird die Versionsnummer an die API-URI angehängt (z.B. https://actaborussica.bbaw.de/api/tei-xml/v1). Diese Liste aller verfügbaren Texte einer Version beinhaltet Angaben zu Titel, Dokumenttyp und URI, mittels der die Texte schließlich einzeln aufgerufen werden können. Folgend sind beispielhaft einige Quicklinks zu einzelnen Dokumenten der Version 6 aufgelistet:
Wohntopographie
Zur Georeferenzierung der historischen Karte und der historischen Adressen wird das freie Open-Source-Geographische-Informationssystem QGIS verwendet. Die Eingabe der Daten zu den Personen und Institutionen erfolgt in Excel und wird mittels QGIS als GeoJSON exportiert. Die Kartenanwendung wird mittels der open-source JavaScript-Bibliothek Leaflet.js umgesetzt. Zur Anzeige des historischen Stadtplans wird digilib genutzt. Zudem wird die historische Karte mittels gdal2tiles als tiled web map eingebunden.
Die Wohntopographie basiert anders als die anderen Daten nicht auf TEI-XML sondern auf JSON-Daten (bzw. GeoJSON). Diese können über die JSON-API abgerufen werden:
Die JSON-Api ist analog zur XML-Schnittstelle aufgebaut und generiert eine Liste der Versionen und der verschiedenen Dateien in ihren unterschiedlichen Versionen. Derzeit können so jedoch nur die Daten der Wohntopographie als GeoJSON abgerufen werden.BEACON-Datei
Die in unserem Datenbestand vorhandenen und mit der GND-Nummer ausgezeichneten Personen können als Liste im BEACON-Format abgerufen werden.
