Informationen zu CITATION-Dateien

Du kannst dem Stamm eines Repositorys eine CITATION.cff-Datei hinzufügen, um anderen mitzuteilen, wie sie deine Arbeit zitieren sollen. Das CITATION-Dateiformat ist Nur-Text mit von Personen und Computern lesbaren Informationen zum Zitieren.

Beispieldatei für CITATION.cff:

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"

Die GitHub-Zitataufforderung in deinem Repository zeigt den CITATION.cff-Beispielinhalt in den folgenden Formaten an:

APA

Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer software]. https://doi.org/10.5281/zenodo.1234

BibTeX

@software{Lisa_My_Research_Software_2017,
  author = {Lisa, Mona and Bot, Hew},
  doi = {10.5281/zenodo.1234},
  month = {12},
  title = {{My Research Software}},
  url = {https://github.com/github-linguist/linguist},
  version = {2.0.4},
  year = {2017}
}

Beachte, dass das obige Beispiel ein Softwarezitat generiert (d. h. Typ @software in BibTeX anstelle von @article).

Weitere Informationen findest du auf der Website zum CITATION-Dateiformat.

Wenn du dem Standardbranch deines Repositorys eine CITATION.cff-Datei hinzufügst, wird auf der rechten Randleiste der Startseite des Repositorys automatisch ein Link mit der Bezeichnung „Dieses Repository zitieren“ hinzugefügt. Dies erleichtert es anderen Benutzer*innen, dein Softwareprojekt mit den von dir bereitgestellten Informationen zu zitieren.

Screenshot: Startseite eines Repositorys. Der Link „Dieses Repository zitieren“ auf der rechten Randleiste ist orange umrandet, und darunter befindet sich ein erweitertes Dropdownmenü mit den Zitatdetails.

Zitieren von anderen Komponenten als Software

Wenn du die Zitatinformationen aus GitHub mit einer anderen Ressource (z. B. einem Forschungsartikel) verknüpfen möchtest, kannst du die Überschreibung von preferred-citation in CFF mit den folgenden Typen verwenden.

Resource	CFF-Typ	BibTeX-Typ	APA-Anmerkung
Journalartikel/-publikation	`article`	`@article`	Nicht verfügbar
Buch	`book`	`@book`	Nicht verfügbar
Broschüre (gebunden, aber nicht veröffentlicht)	`pamphlet`	`@booklet`	Nicht verfügbar
Konferenzartikel/-publikation	`conference-paper`	`@inproceedings`	[Konferenzpublikation]
Konferenzverfahren	`conference`, `proceedings`	`@proceedings`	Nicht verfügbar
Dataset	`data`, `database`	`@misc`	[Dataset]
Magazinartikel	`magazine-article`	`@article`	Nicht verfügbar
Manuell	`manual`	`@manual`	Nicht verfügbar
Verschiedene/allgemeine/andere	`generic` alle anderen CFF-Typen	`@misc`	Nicht verfügbar
Zeitungsartikel	`newspaper-article`	`@article`	Nicht verfügbar
Software	`software`, `software-code`, `software-container`, `software-executable`, `software-virtual-machine`	`@software`	[Computersoftware]
Bericht/technischer Bericht	`report`	`@techreport`	Nicht verfügbar
Veröffentlichung aufgehoben	`unpublished`	`@unpublished`	Nicht verfügbar

Erweiterte Datei „CITATION.cff“, die die Software beschreibt, aber mit einem Forschungsartikel als bevorzugtes Zitat verknüpft ist:

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"
preferred-citation:
  type: article
  authors:
  - family-names: "Lisa"
    given-names: "Mona"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  - family-names: "Bot"
    given-names: "Hew"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  doi: "10.0000/00000"
  journal: "Journal Title"
  month: 9
  start: 1 # First page number
  end: 10 # Last page number
  title: "My awesome research software"
  issue: 1
  volume: 1
  year: 2021

Die obige CITATION.cff-Beispieldatei erzeugt die folgenden Ausgaben in der GitHub Zitataufforderung:

APA

Lisa, M., & Bot, H. (2021). My awesome research software. Journal Title, 1(1), 1. https://doi.org/10.0000/00000

BibTeX

@article{Lisa_My_awesome_research_2021,
  author = {Lisa, Mona and Bot, Hew},
  doi = {10.0000/00000},
  journal = {Journal Title},
  month = {9},
  number = {1},
  pages = {1--10},
  title = {{My awesome research software}},
  volume = {1},
  year = {2021}
}

Zitieren eines Datasets

Wenn dein Repository ein Dataset enthält, kannst du oben in deiner Datei CITATION.cff die Option type: dataset festlegen, um eine Ausgabe der Datenzitatzeichenfolge an der GitHub Zitataufforderung zu erstellen.

Andere CITATION-Dateien

Das GitHub Zitatfeature erkennt auch eine kleine Anzahl zusätzlicher Dateien, die häufig von Communitys und Projekten verwendet werden, um zu beschreiben, wie ihre Arbeit zitiert werden soll.

GitHub erstellt in der Aufforderung Dieses Repository zitieren eine Verknüpfung mit diesen Dateien, versucht aber nicht, sie in andere Zitatformate zu parsen.

# Note these are case-insensitive and must be in the root of the repository
CITATION
CITATIONS
CITATION.bib
CITATIONS.bib
CITATION.md
CITATIONS.md

# CITATION files for R packages are typically found at inst/CITATION
inst/CITATION

Zitatformate

Derzeit werden die Dateiformate APA und BibTeX unterstützt.

Suchst du nach weiteren Zitatformaten? GitHub verwendet eine Ruby-Bibliothek, um die CITATION.cff Dateien zu analysieren. Du kannst weitere Formate im Repository ruby-cff anfordern oder selbst mitwirken.

Informationen zu CITATION-Dateien

In diesem Artikel