Skip to content

Commit 17fa0fe

Browse files
committed
📝 Update the ‘Citations’ section
* Update CodeMeta * Update DataCite Metadata Schema
1 parent 4588c1d commit 17fa0fe

3 files changed

Lines changed: 75 additions & 29 deletions

File tree

‎CHANGELOG.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ Added
2929
Changed
3030
~~~~~~~
3131

32+
* 📝 Update the ‘Citations’ section
33+
34+
* Update CodeMeta
35+
* Update DataCite Metadata Schema
36+
3237
* 📝 Update string matching
3338

3439
* Replace deprecated fuzzywuzzy lib with thefuzz

‎docs/productive/cite/data.rst‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ Cite data
88
DataCite Metadata Schema
99
------------------------
1010

11-
The DataCite Metadata Working Group published the DataCite Metadata Schema
12-
Documentation for the publication and citation of research data in 2019:
13-
`DataCite Metadata Schema 4.3 <https://schema.datacite.org/meta/kernel-4.3/>`_
14-
together with a XSD (XML Schema Definition): `metadata.xsd
15-
<https://schema.datacite.org/meta/kernel-4.3/metadata.xsd>`_.
11+
The DataCite Metadata Working Group published the `DataCite Metadata Schema
12+
<https://schema.datacite.org/meta/kernel-4.7/>`_ for the publication and
13+
citation of research data in 2019 together with a XSD (XML Schema Definition):
14+
`metadata.xsd <https://schema.datacite.org/meta/kernel-4.7/metadata.xsd>`_.
1615

1716
A simple datacite example can look like this:
1817

‎docs/productive/cite/software/codemeta.rst‎

Lines changed: 66 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,75 @@
55
CodeMeta
66
========
77

8-
`CodeMeta <https://codemeta.github.io/>`__ is an exchange scheme for general
9-
software metadata and reference implementation for JSON for Linking Data
10-
(`JSON-LD <https://json-ld.org/>`_).
118

12-
A ``codemeta.json`` file is expected in the root directory of the software
13-
repository. The file can look like this:
9+
`CodeMeta <https://codemeta.github.io/>`__ provides a common metadata vocabulary
10+
for software that supports research, citation and interoperability across
11+
platforms. It is currently being used in major initiatives such as
12+
`FAIRCORE4EOSC <https://faircore4eosc.eu>`_ to make research software FAIR
13+
(Findable, Accessible, Interoperable, Reusable).
14+
15+
Using existing standards such as the Schema.org types `SoftwareApplication
16+
<https://schema.org/SoftwareApplication>`_ and `SoftwareSourceCode
17+
<https://schema.org/SoftwareSourceCode>`_, as well as JSON for Linking Data
18+
(`JSON-LD <https://json-ld.org/>`_), CodeMeta identifies precisely the version
19+
used in scientific and other research, thereby enabling the reproducibility of
20+
results.
21+
22+
A :file:`codemeta.json` file is expected in the root directory of the software
23+
repository. The file might look like this, for example:
1424

1525
.. code-block:: javascript
1626
17-
{
18-
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
19-
"@type": "SoftwareSourceCode",
20-
"author": [{
21-
"@type": "Person",
22-
"givenName": "Stephan",
23-
"familyName": "Druskat",
24-
"@id": "http://orcid.org/0000-0003-4925-7248"
25-
}],
26-
"name": "My Research Tool",
27-
"softwareVersion": "2.0",
28-
"identifier": "https://doi.org/10.5281/zenodo.1234",
29-
"datePublished": "2017-12-18",
30-
"codeRepository": "https://github.com/research-software/my-research-tool"
31-
}
27+
{
28+
"@context": "https://w3id.org/codemeta/3.0",
29+
"type": "SoftwareSourceCode",
30+
"applicationCategory": "Universal",
31+
"author": [
32+
{
33+
"id": "http://orcid.org/0000-0002-1825-0097",
34+
"type": "Person",
35+
"affiliation": {
36+
"type": "Organization",
37+
"name": "Department of Research Software Engineering"
38+
},
39+
"email": "veit.schiele@example.org",
40+
"familyName": "Schiele",
41+
"givenName": "Veit"
42+
},
43+
{
44+
"type": "Role",
45+
"schema:author": "http://orcid.org/0000-0002-1825-0097",
46+
"roleName": "Developer"
47+
}
48+
],
49+
"codeRepository": "git+https://github.com/cusy/my-research-tool.git",
50+
"dateCreated": "2026-09-07",
51+
"dateModified": "2026-09-07",
52+
"datePublished": "2026-09-07",
53+
"description": "My research tool reliably answers every question with 42.",
54+
"license": "https://spdx.org/licenses/BSD-3-Clause",
55+
"name": "My Research Tool",
56+
"operatingSystem": [
57+
"Linux",
58+
"Windows",
59+
"MacOS"
60+
],
61+
"programmingLanguage": "Python",
62+
"releaseNotes": "Change log: this and that",
63+
"review": {
64+
"type": "Review",
65+
"reviewBody": "Review about my tool."
66+
},
67+
"softwareRequirements": "https://www.python.org/downloads/release/python-3147/",
68+
"version": "2026.1.0",
69+
"developmentStatus": "active",
70+
"issueTracker": "https://github.com/cusy/my-research-tool/issues",
71+
"referencePublication": "https://doi.org/10.1000/xyz123"
72+
}
3273
3374
.. seealso::
34-
* `CodeMeta generator <https://codemeta.github.io/codemeta-generator/>`_
35-
* `Codemeta Terms <https://codemeta.github.io/terms/>`_
36-
* `GitHub Repository
37-
<https://github.com/codemeta/codemeta-generator/>`_
75+
* `The Research Software MetaData Guidelines for End-Users
76+
<https://fair-impact.github.io/RSMD-guidelines/>`_
77+
* `CodeMeta generator <https://codemeta.github.io/codemeta-generator/>`_
78+
* `Codemeta Terms <https://codemeta.github.io/terms/>`_
79+
* `GitHub Repository <https://github.com/codemeta/codemeta-generator/>`_

0 commit comments

Comments
 (0)