Skip to content

Commit

Permalink
Fix citation-file-format/citation-file-format#25: Use SPDX identifier…
Browse files Browse the repository at this point in the history
…s for licenses

- [skip ci]
  • Loading branch information
sdruskat committed Oct 25, 2017
1 parent f6c4415 commit 649b545
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions 1.0-RC1/specifications.md
Expand Up @@ -372,7 +372,7 @@ CFF defines the following reference keys.
| `journal` | String | The name of the journal/magazine/newspaper/periodical where the work was published |
| `keywords` | Collection of strings | Keywords pertaining to the work |
| `languages` | Collection of ISO 639 [*language strings*](#language-strings) | The language of the work |
| `license` | String | The license under which a work is licensed |
| `license` | *[License string](#license-strings)* | The license under which a work is licensed |
| `license-url` | String (*URL*) | The URL of the license text under which a work is licensed |
| `location` | *[Entity object](#entity-objects)* | The location of the work |
| `loc-start` | Integer | The line of code in the file where the work starts |
Expand Down Expand Up @@ -677,7 +677,7 @@ file authors to find the optimal name split in any given case.

# Specified value strings

The keys `status` and `languages` can only take values
The keys `status`, `license`, and `languages` can only take values
from a fixed set of strings. These are specified below.

## Status strings
Expand All @@ -697,6 +697,28 @@ specifies the following value strings for the key `status`.
Table: Defined statuses for works.
{: .text-right}

## License strings

License strings must conform with the [SPDX Licenses list](https://spdx.org/licenses/), i.e.,
a license must be specified via the short identifier from the list. If a license is not
included in the SPDX Licenses list, the `license-url` should be provided as a fallback.

Example:

{% highlight yaml %}
references:
- type: software
authors:
- ...
title: My Research Tool
license: Apache-2.0
- type: software
authors:
- ...
title: Obscure Research Tool
license-url: http://r3s34archs0ft.com/eula
{% endhighlight %}

## Language strings

Natural languages as a value for the key `languages` are specified via their
Expand Down Expand Up @@ -795,8 +817,7 @@ references:
- nlp
- parser
- deep convolutional neural network
license: Apache License, Version 2.0
license-url: http://www.apache.org/licenses/LICENSE-2.0
license: Apache-2.0
url: https://sdruskat.github.io/my-research-tool
{% endhighlight %}

Expand Down

2 comments on commit 649b545

@mr-c
Copy link

@mr-c mr-c commented on 649b545 Oct 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@sdruskat
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, Michael :)!

Please sign in to comment.