Correspondence Metadata Interchange-Format

Dokumentation

Überblick

Der Webservice correspSearch aggregiert und wertet digitale Briefverzeichnisse aus, die als TEI-XML-Datei im Correspondence Metadata Interchange-Format (CMI-Format) online bereitgestellt werden. Das CMI-Format wurde von der TEI Correspondence SIG entwickelt und ist ein stark reduziertes und restriktives Subset der TEI-Richtlinien, das im Wesentlichen auf dem TEI-Element correspDesc basiert.

Grundlage des digitalen Briefverzeichnisses ist eine TEI-XML-Datei. Sie können hier eine kommentierte Vorlage (XML-Datei) herunterladen.

Briefmetadaten

Die TEI-XML-Datei enthält genauso viele correspDesc-Elemente, wie Sie Briefe, Postkarten etc. in ihrer Edition haben. Ein einzelnes correspDesc-Element im CMI-Format ist restriktiver aufgebaut, als es die TEI-Richtlinien normalerweise für das Element correspDesc zu lassen. Dadurch wird der Austausch ermöglicht.

Die Grafik zeigt schematisch die unterschiedlichen Teile eines correspDesc-Elementes im CMI-Format. Der Empfänger wird dabei analog zum Absender notiert. Das gezeigte Beispiel entstammt einem Beispiel der TEI Correspondence SIG.

Bitte beachten Sie, dass der Webservice aufgrund von Norm-IDs nach Personen und Orten sucht. Möglichst viele Orte und Personen sollten daher mit einer Norm-ID versehen sein (weitere Informationen unten).

Die nachfolgende Tabelle gibt detailliert Auskunft zu den einzelnen Teilen eines correspDesc-Elementes im CMI-Format:

XPath (relativ zu correspDesc) Beschreibung Verwendung und Inhalt
/correspAction Umfasst die Daten eines Sende- oder Empfangsvorgangs Nur Kindelemente, kein Text erlaubt
/correspAction/@type Definiert Typ der Korrespondenzhandlung Erlaubt: "sent", "received"
/correspAction/persName Personenname des Senders bzw. Empfängers Obligatorisch, falls unbekannt muss "Unknown" notiert werden
/correspAction/persName/@ref Norm-ID des Senders bzw. Empfängers Falls vorhanden. Unterstützt werden die folgende Normdateien: VIAF, GND, LC, BNF und NDL. Bitte beachten Sie, dass der Webservice aufgrund der Norm-IDs nach Personen sucht. Weitere Informationen finden Sie in den "Häufig gestellten Fragen"
/correspAction/orgName Name der Institution Optional, falls persName nicht zutreffend ist
/correspAction/placeName Name des Sende- bzw. Empfangsortes Falls vorhanden.
/correspAction/placeName/@ref Norm-ID des Sende- bzw. Empfangsortes Falls vorhanden. Unterstützt werden die folgende Normdateien: derzeit nur GeoNames.
/correspAction/date Maschinenlesbares Sende- bzw. Empfangsdatum Falls vorhanden. Der Webservice unterstützt zur Datumsangabe die Attribute @when, @from, @to, @notBefore und @notAfter. Im Gegensatz zu den Richtlinien der TEI bezüglich der Datumsangaben dieser Attribute unterstützt der Webservice nur die folgenden Datumsformate:
  • JJJJ-MM-TT, z.B. 1804-03-01
  • JJJJ-MM, z.B. 1804-03
  • JJJJ, z.B. 1808
Alle anderen Angaben (z.B. 1808-03/04) können technisch leider nicht verarbeitet werden.

Die correspDesc-Elemente werden innerhalb von teiHeader/profileDesc notiert.

Angaben über das digitale Briefverzeichnis

Neben den eigentlichen Briefmetadaten müssen auch einige wenige Angaben zum digitalen Briefverzeichnis in teiHeader/fileDesc notiert werden. Alle Angaben sind obligatorisch, soweit nicht gegenteiliges vermerkt ist.

XPath Beschreibung Verwendung und Inhalt
//titleStmt/title Titel des digitalen Briefverzeichnisses Inhalt frei wählbar
//titleStmt/editor Administrativer Ansprechpartner für diese Datei Nach Möglichkeit mit E-Mail-Adresse in editor/email
//publicationStmt/publisher Urheber der Briefmetadaten im Sinne der Creative-Commons-Lizenz CC-BY 4.0 Inhalt frei wählbar
//publicationStmt/availability/licence Lizenzangabe Obligatorisch: "This file is licensed under the terms of the Creative Commons License CC-BY 4.0"
//publicationStmt/availability/licence/@target URL der Lizenz Obligatorisch: "https://creativecommons.org/licenses/by/4.0/"
//publicationStmt/date/@when Zeitstempel der letzten Aktualisierung: Format: xsd:dateTime
//publicationStmt/idno URL des Briefverzeichnisses Die URL dient als eindeutige "Signatur"
//publicationStmt/idno/@type Typ der Signatur Obligatorisch: "URL"
//sourceDesc/bibl Bibliographische Angabe der Edition, aus der das Briefverzeichnis erstellt wurde Keine Vorgaben.
//sourceDesc/bibl/@type Angabe, ob es sich um eine gedruckte oder online verfügbare Edition handelt. Folgende Werte sind erlaubt: "print", "online"

Validierung und Registrierung

Ihr digitales Briefverzeichnis im CMI-Format können Sie über unseren Validierungsservice überprüfen lassen. Wenn Sie es registrieren möchten, schicken Sie uns bitte eine kurze E-Mail mit der URL. Das Briefverzeichnis sollte unter der URL dauerhaft abrufbar sein, da der Webservice seinen Datenbestand regelmäßig aktualisiert.



Noch Fragen?

Antworten finden Sie in den Häufig gestellten Fragen

Weitere Informationen

Weitere Beispiele für das CMI-Format finden Sie im GitHub-Repository der TEI Correspondence SIG

Zukunft des CMI-Formats

Ein Blogartikel auf digiversity informiert über die Weitentwicklungsmöglichkeiten des CMI-Formats.