Citation File Format

Citation File Format ist ein Schema für Software-Citation-Metadaten in maschinenlesbarem YAML-Format. Dabei sollte eine Datei CITATION.cff im Stammverzeichnis des Software-Repository abgelegt werden. Der Inhalt der Datei kann z.B. so aussehen:

cff-version: "1.1.0"
message: "If you use this tutorial, please cite it as below."
authors:
  -
    family-names: Schiele
    given-names: Veit
    orcid: "https://orcid.org/https://orcid.org/0000-0002-2448-8958"
identifiers:
  -
    type: doi
    value: "10.5281/zenodo.4147287"
keywords:
  - "data-science"
  - jupyter
  - "jupyter-notebooks"
  - "jupyter-kernels"
  - ipython
  - pandas
  - spack
  - pipenv
  - ipywidgets
  - "ipython-widget"
  - dvc
title: "Jupyter tutorial"
version: "0.8.0"
date-released: 2020-10-08
license: "BSD-3-Clause"
repository-code: "https://github.com/veit/jupyter-tutorial"

Ihr könnt einfach das obige Beispiel anpassen um eure eigene CITATION.cff-Datei zu erzeugen oder die Website cffinit verwenden.

Mit cff-validator steht euch eine GitHub-Action zur Verfügung, die CITATION.cff-Dateien mit dem R-Paket V8 überprüft.

Es gibt auch einige Tools zum Workflow von CITATION.cff-Dateien:

  • cffconvert konvertiert CITATION.cff-Dateien in BibTeX, RIS, CodeMeta- und andere Dateiformate

  • doi2cff erstellt eine CITATION.cff-Datei aus einem Zenodo DOI

Auch GitHub bietet einen Service um die Informationen aus der CITATION.cff-Datei eures GitHub-Repository im APA- und BibTex-Format zu kopieren.

Popup auf der Zielseite eines GitHub-Repositorys mit der Möglichkeit, ADA- und BibTex-Formate zu exportieren.

Siehe auch

Wenn ihr einen DOI mit Zenodo registriert, wird die CITATION.cff-Datei aus dem GitHub-Repository ebenfalls verwendet. Auch Zotero interpretiert die Citation File Format-Datei in GitHub-Repositories; Zotero kann jedoch auch ohne Citation File Format-Datei Metainformationen des Repository, wie Unternehmen, Programmiersprache etc., übernehmen.