Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ DataCite Metadata Schema Documentation

This repository holds the official DataCite Metadata Schema documentation for versions:

- Schema 4.7 (released FIXME 2026)
- Schema 4.6 (released 5 December 2024)
- Schema 4.5 (released 22 January 2024)

Expand Down
34 changes: 34 additions & 0 deletions docs/appendices/appendix-1/relatedIdentifierType.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,22 @@ PURL
<relatedIdentifier relatedIdentifierType="PURL" relationType="Cites">http://purl.oclc.org/foo/bar</relatedIdentifier>


.. _RAiD:

RAiD
~~~~~~~~~~~~~~~~~~~~~~~~~

**Full Name:** Research Activity Identifier

**Description:** The Research Activity Identifier (RAiD) is a persistent identifier (PID) and global registry dedicated to research projects. RAiD is governed by `ISO standard 23527:2022 <https://www.iso.org/standard/75931.html>`_, with the `Australian Research Data Commons (ARDC) <https://ardc.edu.au/>`_ as the Registration Authority and lead developer of the system. RAiD provides a system to store, update, share, and link project information across the research community.

**Example:**

.. code:: xml

<relatedIdentifier relatedIdentifierType="RAiD" relationType="IsPartOf" resourceTypeGeneral="Project">https://raid.org/10.26259/5c43ca8f</relatedIdentifier>


.. _RRID:

RRID
Expand All @@ -288,6 +304,24 @@ RRID
<relatedIdentifier relatedIdentifierType="RRID" relationType="Cites">RRID:SCR_014641</relatedIdentifier>


.. _SWHID:

SWHID
~~~~~~~~~~~~~~~~~~~~~~~~~

**Full Name:** SoftWare Hash Identifier

**Description:** SWHIDs (from “SoftWare Hash IDentifiers”) are persistent, intrinsic identifiers for software source code artifacts such as source code files, source trees, commits, and other objects typically found in version control systems.

A SWHID consists of two separate parts, a mandatory core identifier that can point to any software artifact (or “object”) available in the Software Heritage archive, and an optional list of qualifiers that allows to specify the context where the object is meant to be seen and point to a subpart of the object itself.

**Example:**

.. code:: xml

<relatedIdentifier relatedIdentifierType="SWHID" relationType="Cites">swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2</relatedIdentifier>


.. _UPC:

UPC
Expand Down
82 changes: 49 additions & 33 deletions docs/appendices/appendix-1/relationType.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Note: Some relationTypes are processed as citations and references. Read more ab
IsCitedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that B includes A in a citation
**Definition:** Indicates that B includes A in a citation

**Example and Usage Notes:**

Expand All @@ -37,7 +37,7 @@ IsCitedBy
Cites
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that A includes B in a citation
**Definition:** Indicates that A includes B in a citation

**Example and Usage Notes:**

Expand All @@ -53,7 +53,7 @@ Cites
IsSupplementTo
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that A is a supplement to B
**Definition:** Indicates that A is a supplement to B

**Example and Usage Notes:**

Expand All @@ -69,7 +69,7 @@ IsSupplementTo
IsSupplementedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that B is a supplement to A
**Definition:** Indicates that B is a supplement to A

**Example and Usage Notes:**

Expand All @@ -85,7 +85,7 @@ IsSupplementedBy
IsContinuedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is continued by the work B
**Definition:** Indicates A is continued by the work B

**Example and Usage Notes:**

Expand All @@ -99,7 +99,7 @@ IsContinuedBy
Continues
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a continuation of the work B
**Definition:** Indicates A is a continuation of the work B

**Example and Usage Notes:**

Expand All @@ -113,7 +113,7 @@ Continues
Describes
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A describes B
**Definition:** Indicates A describes B

**Example and Usage Notes:**

Expand All @@ -127,7 +127,7 @@ Describes
IsDescribedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is described by B
**Definition:** Indicates A is described by B

**Example and Usage Notes:**

Expand All @@ -141,7 +141,7 @@ IsDescribedBy
HasMetadata
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates resource A has additional metadata B
**Definition:** Indicates resource A has additional metadata B

**Example and Usage Notes:**

Expand All @@ -155,7 +155,7 @@ HasMetadata
IsMetadataFor
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates additional metadata A for a resource B
**Definition:** Indicates additional metadata A for a resource B

**Example and Usage Notes:**

Expand All @@ -169,7 +169,7 @@ IsMetadataFor
HasVersion
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A has a version B
**Definition:** Indicates A has a version B

**Example and Usage Notes:**

Expand All @@ -185,7 +185,7 @@ The registered resource such as a software package or code repository has a vers
IsVersionOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a version of B
**Definition:** Indicates A is a version of B

**Example and Usage Notes:**

Expand All @@ -201,7 +201,7 @@ The registered resource is an instance of a target resource (indicates that A is
IsNewVersionOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a new edition of B, where the new edition has been modified or updated
**Definition:** Indicates A is a new edition of B, where the new edition has been modified or updated

**Example and Usage Notes:**

Expand All @@ -215,7 +215,7 @@ IsNewVersionOf
IsPreviousVersionOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a previous edition of B
**Definition:** Indicates A is a previous edition of B

**Example and Usage Notes:**

Expand All @@ -229,7 +229,7 @@ IsPreviousVersionOf
IsPartOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a portion of B; may be used for elements of a series
**Definition:** Indicates A is a portion of B; may be used for elements of a series

**Example and Usage Notes:**

Expand All @@ -249,7 +249,7 @@ May be used for individual software modules; note that code repository-to-versio
HasPart
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A includes the part B
**Definition:** Indicates A includes the part B

**Example and Usage Notes:**

Expand All @@ -269,7 +269,7 @@ May be used for individual software modules; note that code repository-to-versio
IsPublishedIn
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is published inside B, but is independent of other things published inside of B
**Definition:** Indicates A is published inside B, but is independent of other things published inside of B

**Example and Usage Notes:**

Expand All @@ -283,7 +283,7 @@ IsPublishedIn
IsReferencedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is used as a source of information by B
**Definition:** Indicates A is used as a source of information by B

**Example and Usage Notes:**

Expand All @@ -299,7 +299,7 @@ IsReferencedBy
References
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates B is used as a source of information for A
**Definition:** Indicates B is used as a source of information for A

**Example and Usage Notes:**

Expand All @@ -315,7 +315,7 @@ References
IsDocumentedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates B is documentation about/explaining A
**Definition:** Indicates B is documentation about/explaining A

**Example and Usage Notes:**

Expand All @@ -331,7 +331,7 @@ May be used for software documentation.
Documents
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is documentation about/explaining B
**Definition:** Indicates A is documentation about/explaining B

**Example and Usage Notes:**

Expand All @@ -347,7 +347,7 @@ May be used for software documentation.
IsCompiledBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates B is used to compile or create A
**Definition:** Indicates B is used to compile or create A

**Example and Usage Notes:**

Expand All @@ -363,7 +363,7 @@ May be used to indicate either a traditional text compilation, or the compiler p
Compiles
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates B is the result of a compile or creation event using A
**Definition:** Indicates B is the result of a compile or creation event using A

**Example and Usage Notes:**

Expand All @@ -379,7 +379,7 @@ May be used for software and text, as a compiler can be a computer program or a
IsVariantFormOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a variant or different form of B
**Definition:** Indicates A is a variant or different form of B

**Example and Usage Notes:**

Expand All @@ -397,7 +397,7 @@ May be used for different software operating systems or compiler formats, for ex
IsOriginalFormOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is the original form of B
**Definition:** Indicates A is the original form of B

**Example and Usage Notes:**

Expand All @@ -413,7 +413,7 @@ May be used for different software operating systems or compiler formats, for ex
IsIdenticalTo
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that A is identical to B, for use when there is a need to register two separate instances of the same resource
**Definition:** Indicates that A is identical to B, for use when there is a need to register two separate instances of the same resource

**Example and Usage Notes:**

Expand All @@ -429,7 +429,7 @@ IsIdenticalTo should be used for a resource that is the same as the registered r
IsReviewedBy
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that A is reviewed by B
**Definition:** Indicates that A is reviewed by B

**Example and Usage Notes:**

Expand All @@ -443,7 +443,7 @@ IsReviewedBy
Reviews
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates that A is a review of B
**Definition:** Indicates that A is a review of B

**Example and Usage Notes:**

Expand All @@ -457,7 +457,7 @@ Reviews
IsDerivedFrom
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates B is a source upon which A is based
**Definition:** Indicates B is a source upon which A is based

**Example and Usage Notes:**

Expand All @@ -475,7 +475,7 @@ In this example, the dataset is derived from a larger dataset and data values ha
IsSourceOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a source upon which B is based
**Definition:** Indicates A is a source upon which B is based

**Example and Usage Notes:**

Expand Down Expand Up @@ -585,7 +585,7 @@ May be used to indicate the relationship between an instrument and where it has
IsTranslationOf
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A is a translation of B
**Definition:** Indicates A is a translation of B

**Example and Usage Notes:**

Expand All @@ -601,7 +601,7 @@ When a resource is shared in one language, then later translated to another, use
HasTranslation
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** indicates A has a translation B
**Definition:** Indicates A has a translation B

**Example and Usage Notes:**

Expand All @@ -611,4 +611,20 @@ When a resource is released at the same time in multiple languages, use "HasTran

.. code:: xml

<relatedIdentifier relatedIdentifierType="DOI"relationType="HasTranslation">10.21384/g01j-jm06</relatedIdentifier>
<relatedIdentifier relatedIdentifierType="DOI" relationType="HasTranslation">10.21384/g01j-jm06</relatedIdentifier>


.. _relationType_Other:

Other
~~~~~~~~~~~~~~~~~~~~~~~~~

**Definition:** Indicates that A is related to B and the relationship does not fit into an existing category.

**Example and Usage Notes:**

If selected, supply a value for :ref:`12.g` (or :ref:`20.c` for RelatedItem).

.. code:: xml

<relatedIdentifier relatedIdentifierType="DOI" relationType="Other" relationTypeInformation="is output of" resourceTypeGeneral="Project">10.21384/p27z-6n52</relatedIdentifier>
Loading