Other Open Access

Citation File Format (CFF) - Specifications

Druskat, Stephan; Chue Hong, Neil; Haines, Robert; Baker, James

Other(s)
Gruenpeter, Morane; Silva, Raniere; Bast, Radovan; Crusoe, Michael R.

The Citation File Format (CFF) is a human- and machine-readable - and human-writable - format for CITATION files. These files provide citation metadata for (research and scientific) software. The format aims to support use cases for software citation described in [1]. CFF is serialized in YAML 1.2, and is therefore Unicode-based and cross-language (in terms of both natural language scripts and programming languages). This specification, together with the Unicode standard for characters, aims to provide all the information necessary to understand CFF, and to use (i.e., write) and re-use (i.e., read, validate, convert from) it. These specifications are maintained openly at https://github.com/citation-file-format/citation-file-format.

 

[1] A. M. Smith, D. S. Katz, K. E. Niemeyer, and FORCE11 Software Citation Working Group, “Software citation principles,” PeerJ Computer Science, vol. 2, p. e86, Sep. 2016 [Online]. Available: https://doi.org/10.7717/peerj-cs.86

Files (134.2 kB)
Name Size
cff-specifications-1.0.3.pdf
md5:2c4b616c4bd2e2c38854504f794904c5
134.2 kB Download
  • A. M. Smith, D. S. Katz, K. E. Niemeyer, and FORCE11 Software Citation Working Group, "Software citation principles," PeerJ Computer Science, vol. 2, p. e86, Sep. 2016 [Online]. Available: https://doi.org/10.7717/peerj-cs.86
  • J.-M. Hufflen, "Names in bibtex and mlBibTeX," TUGboat, vol. 27, no. 2, pp. 243–253, Nov. 2006 [Online]. Available: https://www.tug.org/TUGboat/tb27-2/tb87hufflen.pdf
  • O. Ben-Kiki, C. Evans, and I. döt Net, "YAML Ain't Markup Language (YAML) Version 1.2. 3rd Edition, Patched at 2009-10-01." 2009 [Online]. Available: http://yaml.org/spec/1.2/spec.html
  • R. Wilson, "Encouraging citation of software - introducing CITATION files." 2013 [Online]. Available: https://www.software.ac.uk/blog/2013-09-02-encouraging-citation-software-introducing-citation-files
  • S. Druskat, "Track 2 Lightning Talk: Should CITATION files be standardized?" in Proceedings of the Workshop on Sustainable Software for Science: Practice and Experiences (WSSSPE5.1), 2017 [Online]. Available: https://doi.org/10.6084/m9.figshare.3827058
212
92
views
downloads
All versions This version
Views 21251
Downloads 9228
Data volume 12.2 MB3.8 MB
Unique views 16846
Unique downloads 6024

Share

Cite as