Skip to content

Commit a7dc096

Browse files
sdruskatsdruskat
committed
1 parent b1f8184 commit a7dc096

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

‎1.0.2/specifications.md‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ i.e., metadata that can be picked up in a CodeMeta JSON file;
213213
- optionally, a list of references which should be cited in different use cases or scopes, e.g., a software paper describing the abstract concepts of the software (`references`).
214214

215215

216-
### `cff-version`
216+
### `cff-version` (**required**)
217217

218218
`cff-version` must specify the exact version of the
219219
Citation File Format that is used for the file.
@@ -222,7 +222,7 @@ Citation File Format that is used for the file.
222222
cff-version: 1.0.2
223223
{% endhighlight %}
224224

225-
### `message`
225+
### `message` (**required**)
226226

227227
`message` must specify instructions to users on how
228228
to cite the software the CITATION.cff file is associated
@@ -232,7 +232,7 @@ with.
232232
message: "Please cite the following works when using this software."
233233
{% endhighlight %}
234234

235-
### Software citation metadata
235+
### Software citation metadata (**required**)
236236

237237
The primary citation metadata provided to users that wish to cite the software
238238
version which the CFF file is for. This metadata can be provided via a subset
@@ -269,28 +269,28 @@ Finally, following the software citation principle of *Persistence*, make sure t
269269

270270
CFF-Core provides the following keys for software citation metadata.
271271

272-
| CFF key | CFF data type | Description |
273-
|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
274-
| `abstract` | String | A description of the software (version) |
275-
| `authors` | Collection of [entity](#entity-objects) or [person](#person-objects) objects | The author(s) of the software |
276-
| `commit` | String | The commit hash or revision number of the software version |
277-
| `contact` | Collection of [entity](#entity-objects) or [person](#person-objects) objects | The contact person, group, company, etc. for the software version |
278-
| `date-released` | Date | The release date of the software version |
279-
| `doi` | String | The DOI of the work (not the resolver URL, i.e., *10.5281/zenodo.1003150*, not *http://doi.org/10.5281/zenodo.1003150*) |
280-
| `keywords` | Collection of strings | Keywords pertaining to the software version |
281-
| `license` | [SPDX](https://spdx.org/) [License List](https://spdx.org/licenses/) Identifier string (or name string for non-standard licenses) | The license the software version is licensed under |
282-
| `license-url` | String (URL) | The URL of the license text under which the software version is licensed (only for non-standard licenses not included in the [SPDX License List](https://spdx.org/licenses/)) |
283-
| `repository` | String (URL) | The URL to the software version in a repository (when the repository is neither a source code repository or a build artifact repository) |
284-
| `repository-code` | String (URL) | The URL to the software version in a source code repository |
285-
| `repository-artifact` | String (URL) | The URL to the software version in a build artifact/binary/release repository |
286-
| `title` | String | The name of the software (may include a specific name for the software version) |
287-
| `url` | String (URL) | The URL to a landing page/website for the software version |
288-
| `version` | String | The version of the software |
272+
| CFF key | CFF data type | Description | required |
273+
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------: |
274+
| `abstract` | String | A description of the software (version) | |
275+
| `authors` | Collection of [entity](#entity-objects) or [person](#person-objects) objects | The author(s) of the software | ● |
276+
| `commit` | String | The commit hash or revision number of the software version | |
277+
| `contact` | Collection of [entity](#entity-objects) or [person](#person-objects) objects | The contact person, group, company, etc. for the software version | |
278+
| `date-released` | Date | The release date of the software version | ● |
279+
| `doi` | String | The DOI of the work (not the resolver URL, i.e., *10.5281/zenodo.1003150*, not *http://doi.org/10.5281/zenodo.1003150*) | |
280+
| `keywords` | Collection of strings | Keywords pertaining to the software version | |
281+
| `license` | [SPDX](https://spdx.org/) [License List](https://spdx.org/licenses/) Identifier string (or name string for non-standard licenses) | The license the software version is licensed under | |
282+
| `license-url` | String (URL) | The URL of the license text under which the software version is licensed (only for non-standard licenses not included in the [SPDX License List](https://spdx.org/licenses/)) | |
283+
| `repository` | String (URL) | The URL to the software version in a repository (when the repository is neither a source code repository or a build artifact repository) | |
284+
| `repository-code` | String (URL) | The URL to the software version in a source code repository | |
285+
| `repository-artifact` | String (URL) | The URL to the software version in a build artifact/binary/release repository | |
286+
| `title` | String | The name of the software (may include a specific name for the software version) | ● |
287+
| `url` | String (URL) | The URL to a landing page/website for the software version | |
288+
| `version` | String | The version of the software | ● |
289289

290290
Table: CFF-Core keys and accepted data types for the provision of citation metadata.
291291
{: .text-right}
292292

293-
### `references`
293+
### `references` (**optional**)
294294

295295
Provides an optional list of references pertaining to the software version, or the software itself, e.g., a software paper describing the abstract concepts of the software, a paper describing an algorithm that has been implemented in the software version, etc.
296296

@@ -935,7 +935,9 @@ this.
935935

936936
{% highlight yaml %}
937937
cff-version: 1.0.2
938-
message: "If you dare use this commercial, closed-source, strangely versioned software in your research, please at least cite it as below."
938+
message:
939+
If you dare use this commercial, closed-source, strangely versioned
940+
software in your research, please at least cite it as below.
939941
authors:
940942
- family-names: Vader
941943
name-suffix: né Skywalker

0 commit comments

Comments
 (0)