Citation File Format

Kontakt

Stephan Druskat

Deutsches Zentrum für Luft- und Raumfahrt (DLR)
Institut für Softwaretechnologie
Berlin

Dokumentation

Schema Guide

Software

Das Citation File Format (CFF) ermöglicht es Entwickler:innen von Forschungssoftware, diejenigen Metadaten in einem Sourcecode-Repository zu hinterlegen, die für die korrekte Zitierung der Software benötigt werden. Dies erschließt zum einen die Möglichkeit, über bekannte akademische Evaluierungsmetriken Anerkennung für die geleistete Arbeit zu erhalten, zum anderen ermöglicht korrekte Softwarezitierung das bessere Auffinden von Forschungssoftware und die Reproduzierbarkeit von komputationell erlangten Forschungsergebnissen.

CFF ist implementiert in YAML und verfügt über ein JSON Schema für die Validierung von CITATION.cff-Dateien. Das Format wird unterstützt durch eine Vielzahl dedizierter Tools zur Erstellung, Bearbeitung, Validierung und Konvertierung von CFF in andere Metadatenformate. Weiterhin wird es unterstützt durch Plattformen und Tools wie GitHub (zur Anzeige gerendeter Zitationsinformationen für Repositorien), Zenodo (für die Metadatengenerierung von Publikationseinträgen), Zotero und JabRef (als Quellformat für Zitationsmetadaten). CFF basiert auf den Software Citation Principles und ist kompatibel unter anderem mit CodeMeta.

Das Citation File Format-Projekt verwendet ausschließlich offene Lizenzen, sowohl für Software als auch für Dokumentation und wird entwickelt und gepflegt durch eine offene, internationale Community. Unterstützt wird es teilweise durch die Heimatinstitutionen der Entwickler:innen (Deutsches Zentrum für Luft- und Raumfahrt (DLR), Netherlands eScience Center, u.a.), als auch durch kleinere Förderungen und Grants (u.a. vom Software Sustainability Institute (UK), campusSOURCE (DE), Code for Science & Society (USA)).


cff-version: 1.2.0

message: "If you use this software, please cite it as below."

authors:

  - family-names: Druskat

    given-names: Stephan

    orcid: https://orcid.org/0000-0003-4925-7248

title: "My Research Software"

version: 2.0.4

doi: 10.5281/zenodo.1234

date-released: 2021-08-11

Example of a simple CITATION.cff file.

Anmerkung der Redaktion

Das Citation File Format wurde mit dem 2. Preis beim campusSOURCE Award 2022 ausgezeichnet. Den Teilnahmebeitrag und den Vortrag im Rahmen der Preisverleihung finden Sie auf der Preisträgerseite.