diff --git a/docs/appendices/appendix-1/accessType.rst b/docs/appendices/appendix-1/accessType.rst new file mode 100644 index 0000000..fb6480c --- /dev/null +++ b/docs/appendices/appendix-1/accessType.rst @@ -0,0 +1,26 @@ +accessType +===================================== + +*Used by:* + +* :ref:`21.1.c` +* :ref:`22.a` + +*Options:* + +.. contents:: :local: + :backlinks: none + +.. _public: + +Public +~~~~~~~~~~~~~~~~~ + +**Description:** The resource is publicly available for anyone to access. + +.. _restricted: + +Restricted +~~~~~~~~~~~~~~~~~ + +**Description:** The resource is not publicly available. Access is limited to authorized users or systems, based on defined access controls or processes. diff --git a/docs/appendices/appendix-1/contributorType.rst b/docs/appendices/appendix-1/contributorType.rst index 93aa94a..ab18ade 100644 --- a/docs/appendices/appendix-1/contributorType.rst +++ b/docs/appendices/appendix-1/contributorType.rst @@ -185,6 +185,16 @@ Example: Space Research & Planetary Sciences Division of the University of Bern Source: doi:10.26302/SSHADE/EXPERIMEN T_OP_20201104_001 +.. _Reviewer: + +Reviewer +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Description:** A person or organization responsible for conducting an assessment or evaluation of the content of the resource. + +**Usage Notes:** May be used for crediting a person or organization who reviews an award, publication, or other research output, including those who perform peer review. + + .. _RightsHolder: RightsHolder diff --git a/docs/appendices/appendix-1/index.rst b/docs/appendices/appendix-1/index.rst index 439e77c..30fb102 100644 --- a/docs/appendices/appendix-1/index.rst +++ b/docs/appendices/appendix-1/index.rst @@ -11,3 +11,4 @@ Controlled list values that enhance the prospect that the resource’s metadata relatedIdentifierType relationType descriptionType + accessType diff --git a/docs/appendices/appendix-1/relatedIdentifierType.rst b/docs/appendices/appendix-1/relatedIdentifierType.rst index 9e11f83..3a97da6 100644 --- a/docs/appendices/appendix-1/relatedIdentifierType.rst +++ b/docs/appendices/appendix-1/relatedIdentifierType.rst @@ -240,6 +240,22 @@ LSID urn:lsid:ubio.org:namebank:11815 +.. _PatentNumber: + +PatentNumber +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Full Name:** Patent number + +**Description:** A unique identifier assigned by a patent authority to a granted patent or published patent application. + +**Example:** + +.. code:: xml + + WO2025188512A1 + + .. _PMID: PMID diff --git a/docs/appendices/appendix-1/relationType.rst b/docs/appendices/appendix-1/relationType.rst index 45c37ec..95d3aed 100644 --- a/docs/appendices/appendix-1/relationType.rst +++ b/docs/appendices/appendix-1/relationType.rst @@ -23,6 +23,8 @@ IsCitedBy **Definition:** Indicates that B includes A in a citation +**Inverse relationType:** :ref:`Cites` + **Example and Usage Notes:** *Recommended for discovery.* @@ -39,6 +41,8 @@ Cites **Definition:** Indicates that A includes B in a citation +**Inverse relationType:** :ref:`IsCitedBy` + **Example and Usage Notes:** *Recommended for discovery.* @@ -55,6 +59,8 @@ IsSupplementTo **Definition:** Indicates that A is a supplement to B +**Inverse relationType:** :ref:`IsSupplementedBy` + **Example and Usage Notes:** *Recommended for discovery.* @@ -71,6 +77,8 @@ IsSupplementedBy **Definition:** Indicates that B is a supplement to A +**Inverse relationType:** :ref:`IsSupplementTo` + **Example and Usage Notes:** *Recommended for discovery.* @@ -87,6 +95,8 @@ IsContinuedBy **Definition:** Indicates A is continued by the work B +**Inverse relationType:** :ref:`Continues` + **Example and Usage Notes:** .. code:: xml @@ -101,6 +111,8 @@ Continues **Definition:** Indicates A is a continuation of the work B +**Inverse relationType:** :ref:`IsContinuedBy` + **Example and Usage Notes:** .. code:: xml @@ -115,6 +127,8 @@ Describes **Definition:** Indicates A describes B +**Inverse relationType:** :ref:`IsDescribedBy` + **Example and Usage Notes:** .. code:: xml @@ -129,6 +143,8 @@ IsDescribedBy **Definition:** Indicates A is described by B +**Inverse relationType:** :ref:`Describes` + **Example and Usage Notes:** .. code:: xml @@ -143,6 +159,8 @@ HasMetadata **Definition:** Indicates resource A has additional metadata B +**Inverse relationType:** :ref:`IsMetadataFor` + **Example and Usage Notes:** .. code:: xml @@ -157,6 +175,8 @@ IsMetadataFor **Definition:** Indicates additional metadata A for a resource B +**Inverse relationType:** :ref:`HasMetadata` + **Example and Usage Notes:** .. code:: xml @@ -171,6 +191,8 @@ HasVersion **Definition:** Indicates A has a version B +**Inverse relationType:** :ref:`IsVersionOf` + **Example and Usage Notes:** The registered resource such as a software package or code repository has a versioned instance (indicates A has the instance B). It may be used, e.g., to relate an un-versioned code repository to one of its specific software versions. @@ -187,6 +209,8 @@ IsVersionOf **Definition:** Indicates A is a version of B +**Inverse relationType:** :ref:`HasVersion` + **Example and Usage Notes:** The registered resource is an instance of a target resource (indicates that A is an instance of B). It may be used, e.g., to relate a specific version of a software package to its software code repository. @@ -203,6 +227,8 @@ IsNewVersionOf **Definition:** Indicates A is a new edition of B, where the new edition has been modified or updated +**Inverse relationType:** :ref:`IsPreviousVersionOf` + **Example and Usage Notes:** .. code:: xml @@ -217,6 +243,8 @@ IsPreviousVersionOf **Definition:** Indicates A is a previous edition of B +**Inverse relationType:** :ref:`IsNewVersionOf` + **Example and Usage Notes:** .. code:: xml @@ -231,6 +259,8 @@ IsPartOf **Definition:** Indicates A is a portion of B; may be used for elements of a series +**Inverse relationType:** :ref:`HasPart` + **Example and Usage Notes:** *Recommended for discovery.* @@ -251,6 +281,8 @@ HasPart **Definition:** Indicates A includes the part B +**Inverse relationType:** :ref:`IsPartOf` + **Example and Usage Notes:** *Recommended for discovery.* @@ -271,6 +303,8 @@ IsPublishedIn **Definition:** Indicates A is published inside B, but is independent of other things published inside of B +**Inverse relationType:** N/A + **Example and Usage Notes:** .. code:: xml @@ -285,6 +319,8 @@ IsReferencedBy **Definition:** Indicates A is used as a source of information by B +**Inverse relationType:** :ref:`References` + **Example and Usage Notes:** *Recommended for discovery.* @@ -301,6 +337,8 @@ References **Definition:** Indicates B is used as a source of information for A +**Inverse relationType:** :ref:`IsReferencedBy` + **Example and Usage Notes:** *Recommended for discovery.* @@ -317,6 +355,8 @@ IsDocumentedBy **Definition:** Indicates B is documentation about/explaining A +**Inverse relationType:** :ref:`Documents` + **Example and Usage Notes:** May be used for software documentation. @@ -333,6 +373,8 @@ Documents **Definition:** Indicates A is documentation about/explaining B +**Inverse relationType:** :ref:`IsDocumentedBy` + **Example and Usage Notes:** May be used for software documentation. @@ -349,6 +391,8 @@ IsCompiledBy **Definition:** Indicates B is used to compile or create A +**Inverse relationType:** :ref:`Compiles` + **Example and Usage Notes:** May be used to indicate either a traditional text compilation, or the compiler program used to generate executable software. @@ -365,6 +409,8 @@ Compiles **Definition:** Indicates B is the result of a compile or creation event using A +**Inverse relationType:** :ref:`IsCompiledBy` + **Example and Usage Notes:** May be used for software and text, as a compiler can be a computer program or a person. @@ -381,6 +427,8 @@ IsVariantFormOf **Definition:** Indicates A is a variant or different form of B +**Inverse relationType:** :ref:`IsOriginalFormOf` + **Example and Usage Notes:** Use for a different form of one thing. @@ -399,6 +447,8 @@ IsOriginalFormOf **Definition:** Indicates A is the original form of B +**Inverse relationType:** :ref:`IsVariantFormOf` + **Example and Usage Notes:** May be used for different software operating systems or compiler formats, for example. @@ -415,6 +465,8 @@ 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 +**Inverse relationType:** N/A + **Example and Usage Notes:** IsIdenticalTo should be used for a resource that is the same as the registered resource but is saved on another location, maybe another institution. @@ -431,6 +483,8 @@ IsReviewedBy **Definition:** Indicates that A is reviewed by B +**Inverse relationType:** :ref:`Reviews` + **Example and Usage Notes:** .. code:: xml @@ -445,6 +499,8 @@ Reviews **Definition:** Indicates that A is a review of B +**Inverse relationType:** :ref:`IsReviewedBy` + **Example and Usage Notes:** .. code:: xml @@ -459,6 +515,8 @@ IsDerivedFrom **Definition:** Indicates B is a source upon which A is based +**Inverse relationType:** :ref:`IsSourceOf` + **Example and Usage Notes:** IsDerivedFrom should be used for a resource that is a derivative of an original resource. @@ -477,6 +535,8 @@ IsSourceOf **Definition:** Indicates A is a source upon which B is based +**Inverse relationType:** :ref:`IsDerivedFrom` + **Example and Usage Notes:** IsSourceOf is the original resource from which a derivative resource was created. @@ -495,6 +555,8 @@ IsRequiredBy **Definition:** Indicates A is required by B +**Inverse relationType:** :ref:`Requires` + **Example and Usage Notes:** May be used to indicate software dependencies. @@ -511,6 +573,8 @@ Requires **Definition:** Indicates A requires B +**Inverse relationType:** :ref:`IsRequiredBy` + **Example and Usage Notes:** May be used to indicate software dependencies. @@ -527,6 +591,8 @@ Obsoletes **Definition:** Indicates A replaces B +**Inverse relationType:** :ref:`IsObsoletedBy` + **Example and Usage Notes:** .. code:: xml @@ -541,6 +607,8 @@ IsObsoletedBy **Definition:** Indicates A is replaced by B +**Inverse relationType:** :ref:`Obsoletes` + **Example and Usage Notes:** .. code:: xml @@ -555,6 +623,8 @@ IsCollectedBy **Definition:** Indicates A is collected by B +**Inverse relationType:** :ref:`Collects` + **Example and Usage Notes:** May be used to indicate the relationship between a dataset and an instrument that is used to collect, measure, obtain, or observe data (as in, dataset A is IsCollectedBy instrument B). @@ -571,6 +641,8 @@ Collects **Definition:** Indicates A collects B +**Inverse relationType:** :ref:`IsCollectedBy` + **Example and Usage Notes:** May be used to indicate the relationship between an instrument and where it has been used to collect, measure, obtain, or observe data (as in, instrument A collects dataset B). @@ -587,6 +659,8 @@ IsTranslationOf **Definition:** Indicates A is a translation of B +**Inverse relationType:** :ref:`HasTranslation` + **Example and Usage Notes:** When a resource is shared in one language, then later translated to another, use "IsTranslationOf" to link the translation to the original. @@ -603,6 +677,8 @@ HasTranslation **Definition:** Indicates A has a translation B +**Inverse relationType:** :ref:`IsTranslationOf` + **Example and Usage Notes:** When a resource is shared in one language, then later translated to another, use "HasTranslation" to link the original resource to its translation. @@ -614,6 +690,38 @@ When a resource is released at the same time in multiple languages, use "HasTran 10.21384/g01j-jm06 +.. _IsOutputOf: + +IsOutputOf +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Definition:** Indicates A is an output of B + +**Inverse relationType:** :ref:`HasOutput` + +**Example and Usage Notes:** May be used to connect the outputs of awards, projects, and software to their sources. + +.. code:: xml + + 10.21384/g01j-jm06 + + +.. _HasOutput: + +HasOutput +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Definition:** Indicates A has an output B + +**Inverse relationType:** :ref:`IsOutputOf` + +**Example and Usage Notes:** May be used to connect awards, projects, and software to their associated outputs. + +.. code:: xml + + 10.21384/828a-cm38 + + .. _relationType_Other: Other @@ -621,6 +729,8 @@ Other **Definition:** Indicates that A is related to B and the relationship does not fit into an existing category. +**Inverse relationType:** N/A + **Example and Usage Notes:** If selected, supply a value for :ref:`12.g` (or :ref:`20.c` for RelatedItem). diff --git a/docs/appendices/appendix-1/resourceTypeGeneral.rst b/docs/appendices/appendix-1/resourceTypeGeneral.rst index dcbad32..23fbb2c 100644 --- a/docs/appendices/appendix-1/resourceTypeGeneral.rst +++ b/docs/appendices/appendix-1/resourceTypeGeneral.rst @@ -49,12 +49,28 @@ Award **Suggested Dublin Core Mapping:** N/A +.. _BlogPost: + +BlogPost +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Description:** A piece of writing or other item of content published on a blog. + +**Examples and Usage Notes:** + +.. code:: xml + + + +**Suggested Dublin Core Mapping:** Text + + .. _Book: Book ~~~~~~~~~~~~~~~~~~~~~~~~~ -**Description:** A medium for recording information in the form of writing or images, typically composed of many pages bound together and protected by a cover. +**Description:** A non-serial publication that is complete in one volume or a designated finite number of volumes **Examples and Usage Notes:** diff --git a/docs/appendices/appendix-2.rst b/docs/appendices/appendix-2.rst index daec78b..606a79a 100644 --- a/docs/appendices/appendix-2.rst +++ b/docs/appendices/appendix-2.rst @@ -5,6 +5,22 @@ Appendix 2 provides the update contents of earlier versions of the schema. .. contents:: :local: +`Version 4.7 `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rubric:: Schema changes + +* Addition of :ref:`Poster` and :ref:`Presentation` to the :doc:`/appendices/appendix-1/resourceTypeGeneral` controlled list values. +* Addition of :ref:`RAiD` and :ref:`SWHID` to the :doc:`/appendices/appendix-1/relatedIdentifierType` controlled list values. +* Addition of new :doc:`/appendices/appendix-1/relationType`: :ref:`relationType_Other` +* Addition of new sub-properties: :ref:`12.g` for :ref:`12` and :ref:`20.c` for :ref:`20` + +.. rubric:: Documentation changes + +* Documentation of existing `xml:lang` sub-properties on their property pages. +* Updated examples in :doc:`Appendix 1: Controlled List Definitions - resourceTypeGeneral `. +* Updated the :ref:`Guidance_missing_values`. + `Version 4.6 `_ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/conf.py b/docs/conf.py index b008dec..840f8cd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,8 +7,8 @@ copyright = "Creative Commons Attribution 4.0 International (CC BY 4.0)" license_url = "https://creativecommons.org/licenses/by/4.0/" -release = '4.7' -version = '4.7' +release = '4.8' +version = '4.8' # -- General configuration @@ -101,7 +101,7 @@ } latex_documents = [ - ('index', 'DataCite-MetadataKernel_v4.7.tex', + ('index', 'DataCite-MetadataKernel_v4.8.tex', u'DataCite Metadata Schema Documentation', u'DataCite Metadata Working Group', 'howto'), ] diff --git a/docs/index.rst b/docs/index.rst index 49f4951..518790d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ DataCite Metadata Schema Documentation for the Publication and Citation of Resea .. note:: - DataCite Metadata Working Group. (2026). DataCite Metadata Schema for the Publication and Citation of Research Data and Other Research Outputs. Version 4.7. DataCite e.V. https://doi.org/10.14454/qdd3-ps68 + DataCite Metadata Working Group. (2026). DataCite Metadata Schema for the Publication and Citation of Research Data and Other Research Outputs. Version 4.8. DataCite e.V. https://doi.org/10.14454/kwsj-rh55 Contributors from the DataCite Metadata Working Group: @@ -47,30 +47,10 @@ Contributors from the DataCite Metadata Working Group: Wendy RobertsonORCID logo -.. |Mike Shallcross| raw:: html - - Mike ShallcrossORCID logo - .. |Kelly Stathis| raw:: html Kelly StathisORCID logo -.. |Nicola Tarocco| raw:: html - - Nicola TaroccoORCID logo - -.. |Hana Vyčítalová| raw:: html - - Hana VyčítalováORCID logo - -.. |Melissa Harrison| raw:: html - - Melissa HarrisonORCID logo - -.. |Peyton Tvrdy| raw:: html - - Peyton TvrdyORCID logo - .. |Dorothea Strecker| raw:: html Dorothea StreckerORCID logo @@ -87,9 +67,17 @@ Contributors from the DataCite Metadata Working Group: Adam Vials MooreORCID logo -.. |Sara El-Gebali| raw:: html +.. |Gretchen Gueguen| raw:: html + + Gretchen GueguenORCID logo + +.. |Jia Liu| raw:: html - Sara El-GebaliORCID logo + Jia LiuORCID logo + +.. |Myung-Ja K. Han| raw:: html + + Myung-Ja K. HanORCID logo .. |British Library| raw:: html @@ -131,26 +119,6 @@ Contributors from the DataCite Metadata Working Group: University of IowaROR logo -.. |Inter-university Consortium for Political and Social Research| raw:: html - - Inter-university Consortium for Political and Social ResearchROR logo - -.. |CERN| raw:: html - - CERNROR logo - -.. |National Library of Technology (Czech Republic)| raw:: html - - National Library of Technology (Czech Republic)ROR logo - -.. |EMBL-EBI| raw:: html - - EMBL-EBIROR logo - -.. |National Transportation Library, United States Department of Transportation| raw:: html - - National Transportation Library, United States Department of TransportationROR logo - .. |Berlin School of Library and Information Science, Humboldt-Universität zu Berlin| raw:: html Berlin School of Library and Information Science, Humboldt-Universität zu BerlinROR logo @@ -167,6 +135,18 @@ Contributors from the DataCite Metadata Working Group: JiscROR logo +.. |Center for Open Science| raw:: html + + Center for Open ScienceROR logo + +.. |Computer Network Information Center of the Chinese Academy of Sciences| raw:: html + + Computer Network Information Center of the Chinese Academy of SciencesROR logo + +.. |University of Illinois Urbana-Champaign| raw:: html + + University of Illinois Urbana-ChampaignROR logo + .. |DataCite| raw:: html DataCiteROR logo @@ -179,21 +159,18 @@ Contributors from the DataCite Metadata Working Group: * |Isabel Bernal|, |Spanish National Research Council (CSIC)| * |Anusuriya Devaraju|, |Commonwealth Scientific and Industrial Research Organisation (CSIRO)| * |Kirsten Elger|, |GFZ German Research Centre for Geosciences| + * |Gretchen Gueguen|, |Center for Open Science| * |Ted Habermann|, |Metadata Game Changers| - * |Melissa Harrison|, |EMBL-EBI| + * |Myung-Ja K. Han|, |University of Illinois Urbana-Champaign| * |Robin Kraus|, |TIB Hanover| + * |Jia Liu|, |Computer Network Information Center of the Chinese Academy of Sciences| * |Ian Mathews|, |Redivis| * |Andrea Medina-Smith|, |Sage Data| * |Adam Vials Moore|, |Jisc| * |Joseph Padfield|, |The National Gallery| * |Anne Raugh|, |University of Maryland| - * |Mike Shallcross|, |Inter-university Consortium for Political and Social Research| * |Dorothea Strecker|, |Berlin School of Library and Information Science, Humboldt-Universität zu Berlin| - * |Nicola Tarocco|, |CERN| - * |Peyton Tvrdy|, |National Transportation Library, United States Department of Transportation| - * |Hana Vyčítalová|, |National Library of Technology (Czech Republic)| * |Kelly Stathis|, |DataCite| - * |Sara El-Gebali|, |DataCite| .. only:: latex @@ -203,21 +180,18 @@ Contributors from the DataCite Metadata Working Group: * Isabel Bernal, Spanish National Research Council (CSIC) * Anusuriya Devaraju, Commonwealth Scientific and Industrial Research Organisation (CSIRO) * Kirsten Elger, GFZ German Research Centre for Geosciences + * Gretchen Gueguen, Center for Open Science * Ted Habermann, Metadata Game Changers - * Melissa Harrison, EMBL-EBI + * Myung-Ja K. Han, University of Illinois Urbana-Champaign * Robin Kraus, TIB Hanover + * Jia Liu, Computer Network Information Center of the Chinese Academy of Sciences * Ian Mathews, Redivis * Andrea Medina-Smith, Sage Data * Adam Vials Moore, Jisc * Joseph Padfield, The National Gallery * Anne Raugh, University of Maryland - * Mike Shallcross, Inter-university Consortium for Political and Social Research * Dorothea Strecker, Berlin School of Library and Information Science, Humboldt-Universität zu Berlin - * Nicola Tarocco, CERN - * Peyton Tvrdy, National Transportation Library, United States Department of Transportation - * Hana Vyčítalová, National Library of Technology (Czech Republic) * Kelly Stathis, DataCite - * Sara El-Gebali, DataCite Contents diff --git a/docs/introduction/about-schema.rst b/docs/introduction/about-schema.rst index 71a4949..d06eab5 100644 --- a/docs/introduction/about-schema.rst +++ b/docs/introduction/about-schema.rst @@ -5,7 +5,7 @@ About the DataCite Metadata Schema .. note:: - **Citation:** DataCite Metadata Working Group. (2026). DataCite Metadata Schema Documentation for the Publication and Citation of Research Data and Other Research Outputs. Version 4.7. DataCite e.V. https://doi.org/10.14454/qdd3-ps68 + **Citation:** DataCite Metadata Working Group. (2026). DataCite Metadata Schema Documentation for the Publication and Citation of Research Data and Other Research Outputs. Version 4.8. DataCite e.V. https://doi.org/10.14454/kwsj-rh55 Note that the schema and this documentation will always have the same version number. diff --git a/docs/introduction/version-update.rst b/docs/introduction/version-update.rst index 945bab0..2c41e09 100644 --- a/docs/introduction/version-update.rst +++ b/docs/introduction/version-update.rst @@ -1,48 +1,46 @@ -Version 4.7 Update +Version 4.8 Update ==================== .. note:: To access the documentation in PDF or Epub format, access the menu in the bottom left corner or the links below: - - PDF: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.7/pdf/ - - Epub: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.7/epub/ + - PDF: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.8/pdf/ + - Epub: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.8/epub/ These changes are in response to requests from DataCite community members—people like you that have used the metadata schema and have imagined ways in which it might work better for their particular use cases. We are indebted to everyone who has provided us with their feedback, allowing us to improve our service for the broader DataCite community. +If you have ideas for the DataCite Metadata Schema, we invite you to contribute on `DataCite Suggestions `_ + .. contents:: :local: :backlinks: none Schema changes ----------------------------- +* Addition of a new :ref:`21` property, with sub-properties: + + * :ref:`21.1` + * :ref:`21.1.a` + * :ref:`21.1.b` + * :ref:`21.1.c` + * :ref:`21.1.d` +* Addition of a new :ref:`22` property, with sub-property: -* Addition of :ref:`Poster` and :ref:`Presentation` to the :doc:`/appendices/appendix-1/resourceTypeGeneral` controlled list values. + * :ref:`22.a` +* Addition of :ref:`BlogPost` to the :doc:`/appendices/appendix-1/resourceTypeGeneral` controlled list values. - * These values may be used in :ref:`10.a` and other places where resourceTypeGeneral is used (:ref:`12.f`, :ref:`20.a`). -* Addition of :ref:`RAiD` and :ref:`SWHID` to the :doc:`/appendices/appendix-1/relatedIdentifierType` controlled list values. + * This value may be used in :ref:`10.a` and other places where resourceTypeGeneral is used (:ref:`12.f`, :ref:`20.a`). +* Addition of :ref:`PatentNumber` to the :doc:`/appendices/appendix-1/relatedIdentifierType` controlled list values. - * These values may be used in :ref:`12.a` and other places where relatedIdentifierType is used (:ref:`20.1.a`). -* Addition of new :doc:`/appendices/appendix-1/relationType`: :ref:`relationType_Other` -* Addition of new sub-properties: + * This value may be used in :ref:`12.a` and other places where relatedIdentifierType is used (:ref:`20.1.a`). +* Addition of new :doc:`/appendices/appendix-1/contributorType`: :ref:`Reviewer` + + * This value may be used in :ref:`7.a` and other places where contributorType is used (:ref:`20.12.a`). +* Addition of new :doc:`/appendices/appendix-1/relationType` pair: :ref:`IsOutputOf` and :ref:`HasOutput` - * :ref:`12.g` for :ref:`12` - * :ref:`20.c` for :ref:`20` Documentation changes ----------------------------- - -* Documentation of existing `xml:lang` sub-properties on their property pages: - - * :ref:`2.1.lang` for :ref:`2.1` - * :ref:`3.lang` for :ref:`3` - * :ref:`4.lang` for :ref:`4` - * :ref:`6.lang` for :ref:`6` - * :ref:`7.1.lang` for :ref:`7.1` - * :ref:`16.lang` for :ref:`16` - * :ref:`17.lang` for :ref:`17` - * :ref:`20.2.1.lang` for :ref:`20.2.1` - * :ref:`20.3.lang` for :ref:`20.3` - * :ref:`20.12.1.lang` for :ref:`20.12.1` - -* Updated examples in :doc:`Appendix 1: Controlled List Definitions - resourceTypeGeneral `. -* Updated the :ref:`Guidance_missing_values`. +* Addition of :doc:`Appendix 1: Controlled List Definitions - accessType ` to accompany :ref:`22.a` and :ref:`21.1.c`. +* Updated definition for :ref:`Book` in the :doc:`/appendices/appendix-1/resourceTypeGeneral` controlled list values. +* Updated guidance in :doc:`Appendix 1: Controlled List Definitions - relationType ` to indicate reciprocal relationships. \ No newline at end of file diff --git a/docs/mappings/dublincore-local.rst b/docs/mappings/dublincore-local.rst index 78b8319..1543976 100644 --- a/docs/mappings/dublincore-local.rst +++ b/docs/mappings/dublincore-local.rst @@ -181,6 +181,8 @@ Table 5: DataCite - Dublin Core local extension - – * - :ref:`12.f` - – + * - :ref:`12.g` + - – * - :ref:`13` - `dc.format.extent `_ * - :ref:`14` @@ -271,6 +273,8 @@ Table 5: DataCite - Dublin Core local extension - – * - :ref:`20.b` - – + * - :ref:`20.c` + - – * - :ref:`20.1` - `dc.relation `_ * - :ref:`20.1.a` @@ -306,4 +310,20 @@ Table 5: DataCite - Dublin Core local extension * - :ref:`20.12.a` - – * - :ref:`20.12.1` - - `dc.relation `_.{relationType}.contributor.{contributorType} \ No newline at end of file + - `dc.relation `_.{relationType}.contributor.{contributorType} + * - :ref:`21` + - – + * - :ref:`21.1` + - – + * - :ref:`21.1.a` + - – + * - :ref:`21.1.b` + - – + * - :ref:`21.1.c` + - – + * - :ref:`21.1.d` + - – + * - :ref:`22` + - `dc.accessRights `_ + * - :ref:`22.a` + - – diff --git a/docs/mappings/dublincore-qualified.rst b/docs/mappings/dublincore-qualified.rst index e6239a3..e76a43a 100644 --- a/docs/mappings/dublincore-qualified.rst +++ b/docs/mappings/dublincore-qualified.rst @@ -1,7 +1,7 @@ DataCite to Dublin Core Qualified Mapping ================================================================= -This mapping can be used to convert records described following version 4.7 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. +This mapping can be used to convert records described following version 4.8 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. .. _Table 4: @@ -181,6 +181,8 @@ Table 4: DataCite to Dublin Core Qualified Mapping - – * - :ref:`12.f` - – + * - :ref:`12.g` + - – * - :ref:`13` - `dc.format.extent `_ * - :ref:`14` @@ -271,6 +273,8 @@ Table 4: DataCite to Dublin Core Qualified Mapping - – * - :ref:`20.b` - – + * - :ref:`20.c` + - – * - :ref:`20.1` - `dc.relation `_ * - :ref:`20.1.a` @@ -307,6 +311,22 @@ Table 4: DataCite to Dublin Core Qualified Mapping - – * - :ref:`20.12.1` - – + * - :ref:`21` + - – + * - :ref:`21.1` + - – + * - :ref:`21.1.a` + - – + * - :ref:`21.1.b` + - – + * - :ref:`21.1.c` + - – + * - :ref:`21.1.d` + - – + * - :ref:`22` + - `dc.accessRights `_ + * - :ref:`22.a` + - – .. rubric:: Footnotes diff --git a/docs/mappings/dublincore.rst b/docs/mappings/dublincore.rst index 380ab9e..cc88409 100644 --- a/docs/mappings/dublincore.rst +++ b/docs/mappings/dublincore.rst @@ -1,7 +1,7 @@ DataCite to Dublin Core Mapping ======================================== -These mappings can be used to convert records described following version 4.7 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. +These mappings can be used to convert records described following version 4.8 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. .. toctree:: :titlesonly: @@ -9,7 +9,7 @@ These mappings can be used to convert records described following version 4.7 of dublincore-qualified dublincore-local -The first mapping in :ref:`Table 4` can be used to convert records described following version 4.7 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. +The first mapping in :ref:`Table 4` can be used to convert records described following version 4.8 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. The second mapping in :ref:`Table 5` provides an example of a local DataCite Dublin Core extension. diff --git a/docs/properties/access.rst b/docs/properties/access.rst new file mode 100644 index 0000000..f0acbe3 --- /dev/null +++ b/docs/properties/access.rst @@ -0,0 +1,60 @@ +.. _22: + +22. Access +==================== + +**Obligation:** Optional + +**Occurrences:** 0-1 + +**Definition:** Access information relevant to the resource as a whole. + +**Allowed values, examples, other constraints:** + +Include information on how to access the resource, including any restrictions on access. + +To describe access conditions for specific content URLs, use :ref:`21.1.c` (part of :ref:`21`). + +To provide copyright or licensing information, use the :ref:`16` property. To provide an embargo date, use the :ref:`8` property with dateType :ref:`Available`. + +*Sub-properties:* + +.. contents:: :local: + :backlinks: none + +.. rubric:: Example + +.. tabs:: + + .. code-tab:: xml + + Available to researchers at XYZ institution + + .. code-tab:: json + + "access": { + "accessType": "Restricted" + "access": "Available to researchers at XYZ institution" + } + + + +.. _22.a: + +22.a accessType +~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 1 + +**Definition:** The type of access for which the resource is available. + +**Allowed values, examples, other constraints:** + +If Access is used, accessType is mandatory. + +*Controlled List Values:* + + * :ref:`public` + * :ref:`restricted` + +See :doc:`Appendix 1: Controlled List Definitions - accessType ` for definitions. \ No newline at end of file diff --git a/docs/properties/contributor.rst b/docs/properties/contributor.rst index 217d6b6..ac4aae1 100644 --- a/docs/properties/contributor.rst +++ b/docs/properties/contributor.rst @@ -115,6 +115,7 @@ If Contributor is used, then contributorType is mandatory. * :ref:`RelatedPerson` * :ref:`Researcher` * :ref:`ResearchGroup` +* :ref:`Reviewer` * :ref:`RightsHolder` * :ref:`Sponsor` * :ref:`Supervisor` diff --git a/docs/properties/distribution.rst b/docs/properties/distribution.rst new file mode 100644 index 0000000..48f04f6 --- /dev/null +++ b/docs/properties/distribution.rst @@ -0,0 +1,169 @@ +.. _21: + +21. Distribution +==================== + +**Obligation:** Optional + +**Occurrences:** 0-n + +**Definition:** Represents a form of a resource that can be accessed or retrieved, such as downloadable files. This property can be repeated if different variations are available. + +**Allowed values, examples, other constraints:** + +The use of this property indicates directly downloadable distributions. There is no expectation that different downloadable distributions must contain exactly equivalent information. Different distributions might include or exclude different subsets of the entire resource. + +*Sub-properties:* + +.. contents:: :local: + :backlinks: none + +.. rubric:: Example + +.. tabs:: + + .. code-tab:: xml + + + + https://example.org/readme.txt + https://example.org/data.json" + + + https://example.org/package.zip + + + + .. code-tab:: json + + "distributions": [ + [ + { + "contentUrl": "https://example.org/readme.txt", + "byteSize": 838861, + "mediaType": "text/plain", + "accessType": "Public", + "contentName": "readme.txt" + }, + { + "contentUrl": "https://example.org/data.json", + "byteSize": 5242880, + "mediaType": "application/json", + "accessType": "Restricted", + "contentName": "data.json" + } + ], + [ + { + "contentUrl": "https://example.org/package.zip", + "byteSize": 6081741, + "mediaType": "application/zip", + "accessType": "Public", + "contentName": "package.json" + } + ] + ] + +.. _21.1: + +21.1 contentURL +~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 1-n + +**Definition:** The URL leading to content provided by a repository using a valid protocol. + +**Allowed values, examples, other constraints:** + +If Distribution is used, at least one contentURL is mandatory. URLs should use schemes that are registered with IANA (e.g., https, ftp). [#f1]_ + +A contentURL can either represent an entire distribution, or a part of it. Collections of files can be represented either using a single contentURL (e.g., an archive format or a BagIt package) or as multiple contentURLs. + +Examples: + +* ``https://example.org/files/2023-06_ocean-temperature_pacific.csv`` +* ``ftp://example.org/files/survey-responses_2022_deidentified.txt`` +* ``https://example.org/files/census-microdata_2016.tar.gz`` +* ``https://example.org/api/download?id=550e8400-e29b-41d4-a716-446644550000`` +* ``https://data.example.org/records/98765/export`` + +.. _21.1.a: + +21.1.a byteSize +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** The size of the object retrievable via the contentURL in bytes. + +**Allowed values, examples, other constraints:** + +The size in bytes can be approximated (as an integer) when the precise size is not known. + +Example: + +* 1048576 (for 1 Megabyte) + +.. _21.1.b: + +21.1.b mediaType +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** Media type of the object retrievable via the contentURL. + +**Allowed values, examples, other constraints:** + +Media types (formerly known as MIME types) from the list maintained by IANA are strongly recommended. [#f2]_ Where no suitable IANA-registered media type exists, an appropriate community-accepted media type may be used. + +Examples: + +* application/zip +* audio/mpeg + +.. _21.1.c: + +21.1.c accessType +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** The type of access for which the object at the contentURL is available. + +**Allowed values, examples, other constraints:** + +To describe access conditions for the overall resource, use the :ref:`22` property. + +To provide copyright or licensing information, use the :ref:`16` property. To provide an embargo date, use the :ref:`8` property with dateType :ref:`Available`. + +*Controlled List Values:* + + * :ref:`public` + * :ref:`restricted` + +See :doc:`Appendix 1: Controlled List Definitions - accessType ` for definitions. + +.. _21.1.d: + +21.1.d contentName +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** A name or label assigned to the object represented by the contentURL. This may be the file name, a human-readable title, or other descriptive label. + +**Allowed values, examples, other constraints:** + +Example: + +* ``2023-06_ocean-temperature_pacific.csv`` +* ``survey-responses_2022_deidentified.txt`` +* ``census-microdata_2016.tar.gz`` +* ``Dmelanogaster_assembly_r6.48.fasta.gz`` +* ``Sentinel2_AmazonBasin_20230615.tif`` + + +.. rubric:: Footnotes +.. [#f1] See the IANA's list of `Uniform Resource Identifier (URI) Schemes `_. +.. [#f2] See the IANA's list of `Media Types `_ and the MDN's documentation on `Media types (MIME types) `_ for guidance. \ No newline at end of file diff --git a/docs/properties/index.rst b/docs/properties/index.rst index f05193d..4c44975 100644 --- a/docs/properties/index.rst +++ b/docs/properties/index.rst @@ -24,4 +24,6 @@ DataCite Metadata Properties geolocation fundingreference relateditem + distribution + access diff --git a/docs/properties/overview.rst b/docs/properties/overview.rst index 9b6c921..ad1a5e2 100644 --- a/docs/properties/overview.rst +++ b/docs/properties/overview.rst @@ -39,7 +39,7 @@ Properties and sub-properties have naming and numbering conventions as follows: - properties begin with a capital letter (e.g., ``Creator``) - sub-properties begin with a lower case letter, with subsequent words using capital letters (e.g., ``creatorName``, ``nameType``) [#f1]_ -Each property is numbered. The major properties are numbered 1-20. +Each property is numbered. The major properties are numbered 1-22. Occurrences ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -188,6 +188,10 @@ Table 2: DataCite Recommended and Optional Properties +----+-----------------------------------------------------------------------------------------+------------+ | 20 | :ref:`RelatedItem <20>` | O | +----+-----------------------------------------------------------------------------------------+------------+ +| 21 | :ref:`Distribution <21>` | O | ++----+-----------------------------------------------------------------------------------------+------------+ +| 22 | :ref:`Access <22>` | O | ++----+-----------------------------------------------------------------------------------------+------------+ .. rubric:: Footnotes diff --git a/docs/properties/relatedidentifier.rst b/docs/properties/relatedidentifier.rst index d420139..b905536 100644 --- a/docs/properties/relatedidentifier.rst +++ b/docs/properties/relatedidentifier.rst @@ -80,6 +80,7 @@ If relatedIdentifier is used, relatedIdentifierType is mandatory. * :ref:`ISTC` * :ref:`LISSN` * :ref:`LSID` +* :ref:`PatentNumber` * :ref:`PMID` * :ref:`PURL` * :ref:`RAiD` @@ -147,6 +148,8 @@ Note: Some relationTypes are processed as citations and references. Read more ab * :ref:`Collects` * :ref:`IsTranslationOf` * :ref:`HasTranslation` +* :ref:`IsOutputOf` +* :ref:`HasOutput` * :ref:`relationType_Other` See :doc:`Appendix 1: Controlled List Definitions - relationType ` for definitions, examples and usage notes. @@ -211,6 +214,7 @@ Use the controlled list values as stated in :ref:`10.a`: * :ref:`Audiovisual` * :ref:`Award` +* :ref:`BlogPost` * :ref:`Book` * :ref:`BookChapter` * :ref:`Collection` diff --git a/docs/properties/relateditem.rst b/docs/properties/relateditem.rst index 1c2299d..b08fb93 100644 --- a/docs/properties/relateditem.rst +++ b/docs/properties/relateditem.rst @@ -3,6 +3,8 @@ 20. RelatedItem ==================== +**Obligation:** Optional + **Occurrences:** 0-n **Definition:** Information about a resource related to the one being registered. @@ -37,6 +39,7 @@ Use the controlled list values as stated in :ref:`10.a`: * :ref:`Audiovisual` * :ref:`Award` +* :ref:`BlogPost` * :ref:`Book` * :ref:`BookChapter` * :ref:`Collection` @@ -123,6 +126,8 @@ Use the controlled list values as stated in :ref:`12.b`: * :ref:`Collects` * :ref:`IsTranslationOf` * :ref:`HasTranslation` +* :ref:`IsOutputOf` +* :ref:`HasOutput` * :ref:`relationType_Other` relationType :ref:`IsPublishedIn` can be used to include series information, like title, volume, issue, page, etc. @@ -185,6 +190,7 @@ Use the controlled list values as stated in :ref:`12.a`: * :ref:`ISTC` * :ref:`LISSN` * :ref:`LSID` +* :ref:`PatentNumber` * :ref:`PMID` * :ref:`PURL` * :ref:`RAiD` diff --git a/docs/properties/resourcetype.rst b/docs/properties/resourcetype.rst index a7dc2c0..8bc2c05 100644 --- a/docs/properties/resourcetype.rst +++ b/docs/properties/resourcetype.rst @@ -49,6 +49,7 @@ Free text. The recommended content is a single term of some detail so that a pai * :ref:`Audiovisual` * :ref:`Award` +* :ref:`BlogPost` * :ref:`Book` * :ref:`BookChapter` * :ref:`Collection`