Skip to content

Commit

Permalink
Merge pull request #7 from drjwbaker/patch-2
Browse files Browse the repository at this point in the history
Update index.md
  • Loading branch information
sdruskat committed May 7, 2018
2 parents 348714c + 5a74c1e commit e194347
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@

# Citation File Format (CFF)

CFF is a human- and machine-readable file format in YAML 1.2 which provides
Citation File Format is a human- and machine-readable file format in [YAML 1.2](http://www.yaml.org/spec/1.2/spec.html) which provides
citation metadata for software. It is maintained openly on GitHub:
<https://github.com/citation-file-format>.

The current version is [{{ site.current }}](/{{ site.current }}/).
The current version is [{{ site.current }}](/{{ site.current }}/), for which there is a [detailed format specification](/{{ site.current }}/).

## Example

If you want to make your software easily citable, you can put a file called
`CITATION.cff` in the root of your repository. This file should provide at least the
minimally necessary metadata to cite your software. An example:
minimally necessary metadata to cite your software. For example:

{% highlight yaml %}
cff-version: 1.0.3
Expand All @@ -30,14 +30,13 @@ doi: 10.5281/zenodo.1234
date-released: 2017-12-18
{% endhighlight %}

This file can be used to provide much more information about your software. For
an overview of what kind of metadata for software can be supplied with the
A CFF file can also be used to record much more information about your software. For
an overview of what software metadata can be supplied with the
Citation File Format, please see [the current version of the format specifications](/{{ site.current }}/).

## Tools

There are a number of tools that can help you work with the Citation File Format.
For an overview, please see [the main GitHub repository](https://github.com/citation-file-format/citation-file-format).
There are a number of tools that can help you work with the Citation File Format to perform useful tasks: generate a `CITATION.cff` file from a [DOI](http://www.doi.org/), convert CFF files to formats required by reference management software', or validate `CITATION.cff` files. For further information, please see [the CFF GitHub repository](https://github.com/citation-file-format/citation-file-format#tools).

## Status

Expand All @@ -46,29 +45,29 @@ from non-standardized `CITATION` files as suggested by Robin
Wilson {% cite citation-files %}[^no-file-no-use] to full transitive credit encoded in JSON-LD
{% cite transitive-credit-json-ld %}.

Along this spectrum, CFF is located somewhere between these two extremes as it adds
Along this spectrum, Citation File Format is located somewhere between these two extremes as it adds
machine-readability and thus a greater re-use potential to `CITATION` files,
but does not offer transitive credit capabilities (yet), or support for all
citation use cases as outlined by {% cite principles --style ./_bibliography/apa-text.csl %}.

CFF aims at providing a practical solution, and human-friendly properties such
Citation File Format aims at providing a practical solution, and human-friendly properties such
as readability and writability, for the most common software citation use
cases, i.e., *1. Use software for a paper*, *2. Use software in/with new software*,
and *15. Store software entry* (cf. Table 2, {% cite principles --style ./_bibliography/apa-text.csl -l 6 %}).

The basic structure of CFF (i.e., having a *message* and one or more
The basic structure of Citation File Format (i.e., having a *message* and one or more
*references*) explicitly reflects the structure of plain-text `CITATION` files
and manifests its status as a compromise between what is currently *useful* and
*usable*, and what is *desired* (fully transitive credit and attribution).
*usable*, and what is *desired* (fully transitive credit and attribution). As such, it has value both as a discrete format with everyday application and as a input format populating other citation formats.

## Context

CFF is an indirect outcome of the discussion group "DS3. Development and
Software citations enhance the dissemination of code, improve software sustainability and ensure authors receive credit for development work. The Citation File Format is an indirect outcome of the discussion group "DS3. Development and
implementation of a standard format for CITATION files." at the [Workshop on
Sustainable Software for Science: Practice and Experiences
(WSSSPE5.1)](http://wssspe.researchcomputing.org.uk/wssspe5-1/) (6 September
2017, Manchester, UK). The group discussed the potential and outlined
requirements for a format for machine-readable CITATION files[^citation-files],
requirements for a format for machine-readable CITATION files,
and has authored a blog post on the subject, which will be published on the
[blog](http://software.ac.uk/blog/) of the [Software Sustainability
Institute](http://software.ac.uk/).
Expand All @@ -82,9 +81,9 @@ Members of the group were:
- Andrew Rowley (University of Manchester, UK)
- Alexander Konovalov (University of St. Andrews, UK)

One requirement for the blog post was to be able to make a concrete suggestion
One requirement for the [blog post](http://software.ac.uk/blog/) was to be able to make a concrete suggestion
for a format for these machine-readable CITATION files, which triggered the
development of CFF.
development of Citation File Format.

[^no-file-no-use]: Not providing a file with software citation metadata is not considered a valid option here.

Expand All @@ -95,4 +94,4 @@ Contributions to CFF are welcome! Please have a look at the

# References

{% bibliography --cited %}
{% bibliography --cited %}

0 comments on commit e194347

Please sign in to comment.