Das CMIF wird entwickelt und dokumentiert durch die TEI Correspondence SIG. Die folgende Dokumentation ist eine nach HTML konvertierte Fassung der Originalversion, welche im GitHub-Repository der TEI Correspondence SIG unter der Lizenz CC-BY 4.0 veröffentlicht wurde.
Das "Correspondence Metadata Interchange Format" (CMIF) ermöglicht es Wissenschaftlern, digitale Verzeichnisse von Briefen aus ihren wissenschaftlichen Ausgaben zu erstellen und online bereitzustellen. Das CMIF wurde von der TEI Correspondence SIG entwickelt und ist eine stark reduzierte und eingeschränkte Teilmenge der TEI-Richtlinien, die hauptsächlich auf dem TEI-Element correspDesc
basiert.
Die Grundlage für ein digitales Verzeichnis von Briefen nach dem CMI-Format ist eine TEI-XML-Datei. Hier können Sie Vorlagen mit Kurzbeschreibungen herunterladen.
Die TEI-XML-Datei enthält so viele correspDesc-Elemente
, wie der Anbieter in seiner wissenschaftlichen Ausgabe Briefe, Postkarten usw. hat. Ein bestimmtes correspDesc-Element
im CMI-Format ist restriktiver und reduziert in Bezug auf seinen Wortschatz, als es die TEI-Richtlinien im Allgemeinen erlauben. Dies ermöglicht den Austausch zwischen den jeweiligen TEI-Dokumenten.
correspDesc-Elements
im CMI-Format. Empfänger und Absender werden auf die gleiche Weise dokumentiert. Das Beispiel stammt aus einem Beispiel der TEI-Korrespondenz SIG.Für Personen und Orte in der "Korrespondenzbeschreibung" (Absender, Adressat, Absenderadresse etc.) sollte eine ID aus einer Normdatei angegeben werden, um diese Einheiten projektübergreifend zu identifizieren und die Korrespondenzmetadaten in Netzwerkanalysen oder Webservices (z.B. correspSearch) zu verwenden. Mögliche Normdateien für Personen könnten sein:
Für Orte, an denen die TEI-Korrespondenz SIG empfiehlt, empfiehlt sich die Verwendung der kostenlosen lizenzierten Geodatenbank GeoNames.
Korrespondenz-Metadaten
Die folgende Tabelle enthält detaillierte Informationen zu den einzelnen Teilen eines correspDesc-Elements
im CMI-Format:
/@key
Nummer oder ID des Briefes in der (gedruckten oder digitalen) wissenschaftlichen Ausgabe. Die Nummer des Buchstabens in @key zu notieren, wird besonders für gedruckte Ausgaben empfohlen.
Mögliche WerteZ.B. "128
"
/@ref
URL des Briefes, falls online verfügbar. Die URL sollte ein offizieller und permanenter Link sein. Wenn verschiedene Versionen eines Briefes verfügbar sind, sollte ein kanonischer Link verwendet werden.
Mögliche WerteZ.B. "http://edition-humboldt.de/H0002656
"
/@source
Verlinkungen mit Hilfe einer UUID (mit "#" vorangestellt) zu den bibliographischen Informationen (d.h. woher die Korrespondenzmetadaten stammen). Weitere Informationen finden Sie unter bibl/@xml:id
unten.
Z.B. "#c3f497f0-488d-4233-9448-130ba8109bd8
"
/correspAction
Enthält die Daten, die sich auf den Sende-/Empfangsprozess eines Briefes, einer Postkarte usw. beziehen.
Mögliche WerteNur folgende untergeordnete Elemente (kein Text erlaubt): persName, orgName, placeName, placeName, date.
/correspAction/@type
Art der Korrespondenzaktion.
Mögliche WerteErlaubt: "sent
", "received
"
/correspAction/persName
Persönlicher Name des Absenders oder Empfängers.
Mögliche WertePflichtfeld; wenn der Absender oder Empfänger unbekannt ist, geben Sie dies bitte durch die Zeichenkette "Unbekannt
" an.
/correspAction/persName/@ref
Autoritätskontrollierte ID des Absenders oder Empfängers.
Mögliche WerteWird dringend empfohlen, falls vorhanden. Mögliche Normdateien: VIAF, GND, LC, BNF und NDL (siehe oben).
/correspAction/orgName
Name der Institution, Firma etc.
Mögliche WerteOptional, wenn PersName
nicht anwendbar ist.
/correspAction/placeName
Name des Ortes, von dem aus ein Brief gesendet wurde oder an den er gesendet wird.
Mögliche WerteWenn vorhanden.
/correspAction/placeName/@ref
Norm-ID des Ortes, von dem aus ein Brief gesendet wurde oder an den er gesendet wird.
Mögliche WerteEmpfohlen, wenn vorhanden. Mögliche Normdateien: GeoNames (siehe oben).
/correspAction/date
Maschinenlesbares Datum, an dem der Brief gesendet oder empfangen wurde.
Mögliche WerteFalls vorhanden. Das CMIF unterstützt die Attribute @when
, @from
, @to
, @notBefore
und @notAfter
. Um den Austausch zu erleichtern, unterstützt das CMIF (im Gegensatz zu den TEI-Richtlinien) nur die folgenden Datumsformate:
Die entsprechenden Elemente werden in TEI/teiHeader/profileDesc
vermerkt - wie in den TEI-Richtlinien beschrieben.
Neben den Korrespondenzmetadaten muss der Anbieter einige Informationen über die CMIF-Datei und den digitalen Index der Briefe selbst in das teiHeader/fileDesc-Element
aufnehmen. Alle Elemente dort sind obligatorisch, wenn nicht anders angegeben.
//titleStmt/title
Titel des digitalen Briefindexes.
Mögliche WerteFreitextfeld.
//titleStmt/editor
Ansprechpartner für das digitale Verzeichnis der Briefe.
Mögliche WerteWenn vorhanden mit einer E-Mail-Adresse in editor/email
.
//publicationStmt/publisher
Herausgeber der Briefmetadaten gemäß der Creative Commons Lizenz CC-BY 4.0.
Mögliche WerteFreitextfeld.
//publicationStmt/availability/licence
Lizenzerklärung.
Mögliche WerteObligatorisch: "This file is licensed under the terms of the Creative Commons License CC-BY 4.0
".
//publicationStmt/availability/licence/@target
URL der Lizenz.
Mögliche WerteObligatorisch: "https://creativecommons.org/licenses/by/4.0/
".
//publicationStmt/date/@when
Zeitstempel der letzten Aktualisierung dieser Datei.
Mögliche WerteFormat: xsd:dateTime.
//publicationStmt/idno
URL dieses digitalen Briefverzeichnisses.
Mögliche WerteDie URL dient als eindeutige Kennung für die CMIF-Datei und stellt sicher, dass die Datei immer bis zu ihrem Ursprung zurückverfolgt werden kann.
//publicationStmt/idno/@type
Typ des oben genannten Identifikators.
Mögliche WerteObligatorisch: "URL
" .
//sourceDesc/bibl
Bibliographische Informationen über die Edition, aus der die Korrespondenzmetadaten abgeleitet sind.
Mögliche WerteKeine Angaben.
//sourceDesc/bibl/@xml:id
Technische ID des bibl-Elements, d.h. der bibliographischen Informationen. Es muss eine UUID verwendet werden. Die correspDesc-Elemente müssen von dieser UUID referenziert werden (siehe oben @source).
Mögliche WerteZ.B. "#c3f497f0-488d-4233-9448-130ba8109bd8
". UUID kann einfach von vielen Online-Tools generiert werden. Wenn das CMIF über ein Skript erstellt wird (wie es in digitalen wissenschaftlichen Ausgaben üblich ist), wird empfohlen, eine "statische" UUID zu verwenden, d.h. die nicht bei jeder Aktualisierung der CMIF-Daten neu generiert wird.
//sourceDesc/bibl/@type
Art der Edition.
Mögliche WerteDie folgenden Werte sind erlaubt: "print
", "online
".
Weitere Informationen finden Sie in den Häufig gestellten Fragen
Weitere Beispiele für das CMI-Format finden Sie im GitHub-Repository der TEI Correspondence SIG
Ein Blogartikel auf digiversity informiert über die Weitentwicklungsmöglichkeiten des CMI-Formats.