How to Use / API

Startseite und Einstiegsmöglichkeiten

Um einen Überblick über die Forschungsplattform und ihre Funktionen zu bekommen, lohnt sich zunächst ein Blick auf die Startseite. Dort stehen Ihnen verschiedene Einstiegsmöglichkeiten zur Verfügung.

Möchten Sie sich über die PROPYLÄEN-Plattform informieren, finden Sie unter "Projekt" in der Navigationsleiste im Abschnitt Was sind die PROPYLÄEN? eine kurze Vorstellung der PROPYLÄEN, darunter Informationen zur Organisationsstruktur, zu erfolgten Veröffentlichungen und Partnerprojekten. Der Abschnitt Technische Konzeption informiert über die Infrastruktur der Plattform und die zentralen Prinzipien und Workflows der Forschungsdatenerstellung.

Näheres zu den Teilprojekten (Tagebücher, Briefe von und an Goethe sowie Begegnungen und Gespräche), zu den zu edierenden und auf der Plattform bereits verfügbaren Quellen sowie zur jeweils zuletzt erschienenen Druckausgabe erfahren Sie, indem Sie ein Projekt in der Menüleiste im Kopf der Startseite anklicken. Vom Teilprojektbereich aus können Sie direkt in eine teilprojektspezifische Suche einsteigen.

Möchten Sie von der Startseite aus unmittelbar mit einer Suche beginnen, gelingt dies am schnellsten über die Suchleiste oder durch Klick auf "Alle Biographica". Über den Button „Recherche“ kommen Sie zudem von jeder Seite aus zum Suchbereich.

Zusätzlich ist ein thematischer Einstieg in die Welt Goethes und die Zeugnisse der Plattform über die Schaufenstertexte und die (in zufälliger Reihenfolge geladenen) Zitate möglich.

Zeugnisse recherchieren

Die Suche nach/in bestimmten Zeugnissen ist sowohl über die Suchleiste und den „Alle-Biographica“-Button auf der Startseite als auch über die Rechercheseite möglich (Klick auf „Recherche“ oben rechts). Je nach Teilprojekt lassen sich aktuell unterschiedliche Bestandteile (wie bspw. Titeldaten, Transkriptionen, Regesten, Kommentare) durchsuchen. Näheres zum derzeit durchsuchbaren Inhalt wird auf den einzelnen Teilprojektseiten erläutert.

Die Suche unterscheidet nicht zwischen Groß- und Kleinschreibung. Flektierte Formen des Suchbegriffs werden jedoch auch gefunden. Die Eingabe eines Wortes in moderner Orthographie schließt auch Treffer in historischen Schreibweisen ein. Trennen Sie mehrere Suchwörter durch Leerzeichen oder Komma (UND-Verknüpfung), so wird nach Zeugnissen gesucht, in denen alle eingegebenen Begriffe vorkommen. Soll exakt nach einer Folge von durch Leerzeichen getrennten Suchwörtern gesucht werden, muss der Ausdruck in Anführungszeichen eingeschlossen werden. Das Trunkierungszeichen * dient als Platzhalter für eine beliebige Anzahl an Zeichen. Es kann am Anfang, in der Mitte oder am Ende eines Begriffsfragments platziert werden. Die genannten Operationen sind kombinierbar.

Die Suche kann auf eines oder mehrere Teilprojekte, den Bearbeitungsstand eines Zeugnisses (Status-Icons) sowie einzelne Jahre bzw. Zeiträume eingeschränkt werden.

Mit Klick auf einen Eintrag in der Ergebnisliste gelangen Sie zur Detailansicht des gewählten Zeugnisses. Dort bietet die Fußleiste die Möglichkeit, zwischen aufeinanderfolgenden Suchtreffern zu navigieren sowie zur Ergebnisliste zurückzukehren.

Der weitere Ausbau der Suchfunktionalitäten bildet einen aktuellen Schwerpunkt der Weiterentwicklungen der Plattform. Unter anderem werden weitere Facetten und individuelle Sortiermöglichkeiten der Ergebnisliste im Laufe der Projektlaufzeit hinzukommen.

Zeugnisse betrachten

Goethes Biographica sowie die dazugehörigen Erläuterungen, Hinweise zur Überlieferung und Digitalisate können in zweispaltiger Ansicht betrachtet werden. So lassen sich die kommentierenden Teile und die Digitalisate jederzeit dem Text gegenüberstellen. Alle Bereiche lassen sich auch in einspaltiger Ansicht betrachten. Für Goethes Tagebücher und Briefe steht zusätzlich die zweispaltige Ansicht zur Verfügung. Der Wechsel von einspaltigem zu mehrspaltigem Layout erfolgt links oben per Klick auf „Zweite Spalte verbergen“ bzw. „Zweite Spalte anzeigen“.

In Goethes Briefen und Tagebüchern sind in der zweispaltigen Ansicht dem Text die jeweiligen Erläuterungen gegenübergestellt. Klicken Sie im Text auf einen optisch hervorgehobenen Abschnitt, rückt die dazugehörige Kommentarzeile in der zweiten Spalte ins Sichtfeld und wird farblich hervorgehoben. Dies ist auch umgekehrt möglich.

Auch Digitalisate lassen sich in einer zweiten Spalte dem Text zuschalten. Der eingebettete Viewer ermöglicht Zoomen, Drehen und die Ansicht im Vollbild. Des Weiteren können die Einstellungen zu Helligkeit, Kontrast und Farben angepasst werden. Unterhalb der Digitalisate wird die besitzhaltende Institution genannt. Mit einem Klick auf den Button "Nutzungsbedingungen" gelangen Sie zu einer Übersicht mit den Lizenzbestimmungen aller digitalisatbereitstellenden Institutionen.

Am Fuß der Textspalte der Von-Briefe und Tagebücher befindet sich der textkritische Apparat. Wenn Sie mit der Maus über die Fußnotenzeichen im Text fahren, wird die dazugehörige Anmerkung eingeblendet. Bei Klick auf die Fußnote springen Sie zur Anmerkung nach unten und von dort aus mit Klick auf den Pfeil wieder zurück zur Textstelle.

Die Fußleiste der Zeugnisansicht bietet die Möglichkeit, zwischen chronologisch aufeinanderfolgenden Zeugnissen zu navigieren sowie zur Zeugnisübersicht zurückzukehren.

Wir empfehlen für die korrekte Anzeige die aktuellen Versionen der Browser Mozilla Firefox oder Google Chrome.

Benutzungshinweise und Verzeichnisse einbeziehen

In der Zeugnisansicht ist unterhalb eines Zeugnistitels ein Menü hinterlegt, das editorische Begleittexte enthält, die für jedes Teilprojekt spezifisch sind. Hier finden Sie zum einen die Editionsrichtlinien der Teilprojekte und weitere Hinweise zur Benutzung. Zum anderen sind Verzeichnisse über die verwendeten Abkürzungen, Maße und Einheiten oder Konkordanzen enthalten. Im Fall der Tagebücher gelangen Sie dort ferner zu einer Übersicht mit allen Digitalisaten aller Tagebücher.

TEI-Schnittstelle

Die Forschungsdaten der Zeugnisse werden auch in Form einer Datenschnittstelle (API) zur Verfügung gestellt. Das Ausgabeformat ist XML/TEI. Mit Änderungen der nachfolgend erläuterten Parameter können die ausgegebenen Zeugnisse pro Abfrage verändert werden.

Basis-URL

api.goethe-biographica.de/exist/apps/api/v1.0/tei/get-records.xql

1. Einzelzeugnis

Der Aufruf eines gezielten Zeugnisses via Zeugnis-ID ist folgendermaßen möglich:

Beispiel

https://api.goethe-biographica.de/exist/apps/api/v1.0/tei/get-records.xql?edition=ra&record-id=RA02_0001_01572

 

Der Aufruf lediglich der Metadaten eines Einzelzeugnisses erfolgt durch den Zusatz "&metadata".

Beispiel

https://api.goethe-biographica.de/exist/apps/api/v1.0/tei/get-records.xql?edition=ra&record-id=RA02_0001_01572&metadata

 

Der Aufruf lediglich des Regests eines Einzelzeugnisses erfolgt durch den Zusatz "&regest".

Beispiel

https://api.goethe-biographica.de/exist/apps/api/v1.0/tei/get-records.xql?edition=ra&record-id=RA02_0001_01572&regest

 

 

2. Verfasser:in, Absendeort und Schreibdatum

Die Abfrage von Zeugnissen bestimmter Verfasser:innen, Absendeorte und Zeugnisdatierungen erfolgt durch diese Parameter:

Bei Kombination unterschiedlicher Parameter wird die Schnittmenge der gefundenen Zeugnisse ausgegeben. Die gleichzeitige Abfrage von Zeugnissen mehrerer Personen, Orte oder Datierungen in einer Abfrage ist nicht möglich. Sie muss mit separaten Abfragen vorgenommen werden.

Beispiele

3. Zeugnisstapel

Stapelaufrufe von Zeugnissen gelingen durch die Angabe des ersten (start) und des letzten (end) aufzurufenden Zeugnisses der Datenbank unter Einbezug folgender Parameter:

Hinweis: Die Kombination von Stapelabruf und weiteren Parametern (z.B. Person und Ort) ist nicht möglich. Stapelabfragen sind auf je 100 Zeugnisse pro Abfrage begrenzt.

Beispiel

Aufruf der ersten drei Briefe an Goethe: https://api.goethe-biographica.de/exist/apps/api/v1.0/tei/get-records.xql?edition=ra&start=0&end=2.

TEI-Datendump

Die TEI-Dateien der Briefe an Goethe zwischen September 1786 und Dezember 1797 können zudem bereits als ZIP-Datei [10.8 MB] heruntergeladen und unter der Lizenz CC BY 4.0 international nachgenutzt werden. Hinweise zur Benutzung sind in den Transkriptionsrichtlinien der Briefe an Goethe zu finden. Kontaktieren Sie uns gern bei Rückfragen: kontakt(at)goethe-biographica.de.

IIIF-Schnittstelle

Die getManifest-API des Goethe- und Schiller-Archivs ermöglicht es, IIIF-Manifeste zu Digitalisaten von Handschriften einzuholen. Die Dokumente umfassen Briefe von und an Goethe sowie dessen Tagebücher.

Basis-URL

ores.klassik-stiftung.de/ords/rest_api/iiif/v1/

1. Tagebücher Goethes

Archivalieneinheit

Um das Manifest für eine Archivalieneinheit, die aus einem oder mehreren Tagebüchern bestehen kann, abzurufen, ist der folgende Suffix nötig:

/propy_gt/{ARCHIVALlENEINHEIT-ID}/manifest

Die erforderliche ID einer Archivalieneinheit ist in der Archivdatenbank der Klassik Stiftung Weimar zu finden. Die relevante Nummer ist am Ende des Zitierlinks eines Eintrags hinter "P2_ID" zu sehen.

Beispiel

ores.klassik-stiftung.de/ords/rest_api/iiif/v1/propy_gt/11307/manifest

Tagebucheintrag

Um an die Digitalisate eines Tagebucheintrags zu gelangen, muss der folgende Suffix an die Basis-URL angehängt werden:

/propy_gt/0/0/{TAGEBUCHEINTRAG-ID}/manifest

Die passende ID des Eintrags ist über die PROPYLÄEN-Plattform zu finden. In der Detailansicht eines Tagebucheintrags ist die ID im Link-Button neben dem Titel zu sehen, beispielsweise "GT01_0007" im Eintrag https://goethe-biographica.de/id/GT01_0007.

Beispiel

https://ores.klassik-stiftung.de/ords/rest_api/iiif/v1/propy_gt/0/0/GT01_1010/manifest

2. Briefe von Goethe

Um an die Digitalisate eines Briefes von Goethe zu gelangen, muss der folgende Suffix an die Basis-URL angehängt werden:

/propy_gb/{BRIEF-ID}/manifest

Die entsprechende ID ist über das Repertorium der Goethe-Briefe zu finden. In der Vollanzeige eines Briefes ist die ID am Ende des Zitierlinks hinter "P2_ID" zu finden.

Beispiel

ores.klassik-stiftung.de/ords/rest_api/iiif/v1/propy_gb/10664/manifest

3. Briefe an Goethe

Um an die Digitalisate eines Briefes an Goethe zu gelangen, muss der folgende Suffix an die Basis-URL angehängt werden:

/propy_ra/{BRIEF-ID}/manifest

Die entsprechende ID ist über die PROPYLÄEN-Plattform zu finden. In der Detailansicht eines Briefes ist die ID am Ende des Link-Buttons neben dem Titel zu finden, beispielsweise "00008" im Brief https://goethe-biographica.de/id/RA01_0007_00008.

Beispiel

ores.klassik-stiftung.de/ords/rest_api/iiif/v1/propy_ra/00008/manifest

CMIF

Die Metdaten der Briefe an und von Goethe sind in Form des Correspondence Metadata Interchange Format (CMIF) auf Zenodo versioniert und dauerhaft zugänglich sowie im Rahmen des Projektes correspSearch recherchierbar:

Briefe an Goethe: Zenodo, correspSeach

Briefe von Goethe: Zenodo, correspSearch