Citation File Format
A YAML file with citation metadata for software or datasets
| Type | object |
|---|---|
| File match |
CITATION.cff
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/citation-file-format/latest.json |
| Source | https://raw.githubusercontent.com/citation-file-format/citation-file-format/1.2.0/schema.json |
Versions
Validate with Lintel
npx @lintel/lintel checkA file with citation metadata for software or datasets.
Properties
The author(s) of the software or dataset.
The version of CFF used for providing the citation metadata.
A message to the human reader of the file to let them know what to do with the citation metadata.
The name of the software or dataset.
A description of the software or dataset.
The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.
The contact person, group, company, etc. for the software or dataset.
The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).
Keywords that describe the work.
An SPDX license identifier.
A reference to a work.
71 nested properties
The author(s) of a work.
The title of the work.
The type of the work.
The abbreviation of a work.
The abstract of a work.
The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).
The title of a collection or proceedings.
The type of a collection.
The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The contact person, group, company, etc. for a work.
The copyright information pertaining to the work.
The data type of a data set.
The name of the database where a work was accessed/is stored.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The department where a work has been produced.
The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).
The edition of the work.
The editor(s) of a work.
The editor(s) of a series in which a work has been published.
The end page of the work.
An entry in the collection that constitutes the work.
The name of the electronic file containing the work.
The format in which a work is represented.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The ISBN of the work.
The ISSN of the work.
The issue of a periodical in which a work appeared.
The publication date of the issue of a periodical in which a work appeared.
The name of the issue of a periodical in which the work appeared.
The name of the journal/magazine/newspaper/periodical where the work was published.
Keywords pertaining to the work.
The language identifier(s) of the work according to ISO 639 language strings.
An SPDX license identifier.
The line of code in the file where the work ends.
The line of code in the file where the work starts.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The medium of the work.
The month in which a work has been published.
The NIHMSID of a work.
Notes pertaining to the work.
The accession number for a work.
The number of volumes making up the collection in which the work has been published.
The number of pages of the work.
The states for which a patent is granted.
The PMCID of a work.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The recipient(s) of a personal communication.
The scope of the reference, e.g., the section of the work it adheres to.
The section of a work that is referenced.
The sender(s) of a personal communication.
The start page of the work.
The publication status of the work.
The term being referenced if the work is a dictionary or encyclopedia.
The type of the thesis that is the work.
The translator(s) of a work.
The volume of the periodical in which a work appeared.
The title of the volume in which the work appeared.
The year in which a work has been published.
The year of the original publication.
The type of the work.
Definitions
An address.
An alias.
A city
The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.
The ISO 3166-1 alpha-2 country code for a country.
"1900-01-01""2020-12-31"
The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).
"10.5281/zenodo.1003150"
An email address.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
A fax number.
An identifier for a work.
A description for a specific identifier value.
"The version DOI for this version, which has a relation childOf with the concept DOI specified in the doi field in the root of this file.""The identifier provided by Archival Repository, which points to this version of the software."
An SPDX license identifier.
SPDX license list; releaseDate=2021-05-14; source=https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json
Identifier for an author, see https://orcid.org.
A person.
The person's affilitation.
The ISO 3166-1 alpha-2 country code for a country.
The person's family names.
The person's given names.
The person's name particle, e.g., a nobiliary particle or a preposition meaning 'of' or 'from' (for example 'von' in 'Alexander von Humboldt').
The person's name-suffix, e.g. 'Jr.' for Sammy Davis Jr. or 'III' for Frank Edwin Wright III.
Identifier for an author, see https://orcid.org.
A post code.
A post code.
A reference to a work.
The author(s) of a work.
The title of the work.
The type of the work.
The abbreviation of a work.
The abstract of a work.
The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).
The title of a collection or proceedings.
The type of a collection.
The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The contact person, group, company, etc. for a work.
The copyright information pertaining to the work.
The data type of a data set.
The name of the database where a work was accessed/is stored.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The department where a work has been produced.
The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).
The edition of the work.
The editor(s) of a work.
The editor(s) of a series in which a work has been published.
The end page of the work.
An entry in the collection that constitutes the work.
The name of the electronic file containing the work.
The format in which a work is represented.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The ISBN of the work.
The ISSN of the work.
The issue of a periodical in which a work appeared.
The publication date of the issue of a periodical in which a work appeared.
The name of the issue of a periodical in which the work appeared.
The name of the journal/magazine/newspaper/periodical where the work was published.
Keywords pertaining to the work.
The language identifier(s) of the work according to ISO 639 language strings.
An SPDX license identifier.
The line of code in the file where the work ends.
The line of code in the file where the work starts.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The medium of the work.
The month in which a work has been published.
The NIHMSID of a work.
Notes pertaining to the work.
The accession number for a work.
The number of volumes making up the collection in which the work has been published.
The number of pages of the work.
The states for which a patent is granted.
The PMCID of a work.
An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.
15 nested properties
The entity's name.
The ISO 3166-1 alpha-2 country code for a country.
The entity's location, e.g., when the entity is a conference.
Identifier for an author, see https://orcid.org.
A post code.
The recipient(s) of a personal communication.
The scope of the reference, e.g., the section of the work it adheres to.
The section of a work that is referenced.
The sender(s) of a personal communication.
The start page of the work.
The publication status of the work.
The term being referenced if the work is a dictionary or encyclopedia.
The type of the thesis that is the work.
The translator(s) of a work.
The volume of the periodical in which a work appeared.
The title of the volume in which the work appeared.
The year in which a work has been published.
The year of the original publication.
A region.
The Software Heritage identifier (without further qualifiers such as origin, visit, anchor, path).
"swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2""swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505""swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d""swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f""swh:1:snp:c7c108084bc0bf3d81436bf980b46e98bd338453"
A phone number.