diff --git a/README.rst b/README.rst index 5d3f7da..d88a7ff 100644 --- a/README.rst +++ b/README.rst @@ -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) diff --git a/docs/appendices/appendix-1/relatedIdentifierType.rst b/docs/appendices/appendix-1/relatedIdentifierType.rst index 2cd7ee4..9e11f83 100644 --- a/docs/appendices/appendix-1/relatedIdentifierType.rst +++ b/docs/appendices/appendix-1/relatedIdentifierType.rst @@ -272,6 +272,22 @@ PURL http://purl.oclc.org/foo/bar +.. _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 `_, with the `Australian Research Data Commons (ARDC) `_ 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 + + https://raid.org/10.26259/5c43ca8f + + .. _RRID: RRID @@ -288,6 +304,24 @@ RRID RRID:SCR_014641 +.. _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 + + swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2 + + .. _UPC: UPC diff --git a/docs/appendices/appendix-1/relationType.rst b/docs/appendices/appendix-1/relationType.rst index 90ff6fb..45c37ec 100644 --- a/docs/appendices/appendix-1/relationType.rst +++ b/docs/appendices/appendix-1/relationType.rst @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -113,7 +113,7 @@ Continues Describes ~~~~~~~~~~~~~~~~~~~~~~~~~ -**Definition:** indicates A describes B +**Definition:** Indicates A describes B **Example and Usage Notes:** @@ -127,7 +127,7 @@ Describes IsDescribedBy ~~~~~~~~~~~~~~~~~~~~~~~~~ -**Definition:** indicates A is described by B +**Definition:** Indicates A is described by B **Example and Usage Notes:** @@ -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:** @@ -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:** @@ -169,7 +169,7 @@ IsMetadataFor HasVersion ~~~~~~~~~~~~~~~~~~~~~~~~~ -**Definition:** indicates A has a version B +**Definition:** Indicates A has a version B **Example and Usage Notes:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -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:** @@ -611,4 +611,20 @@ When a resource is released at the same time in multiple languages, use "HasTran .. code:: xml - 10.21384/g01j-jm06 \ No newline at end of file + 10.21384/g01j-jm06 + + +.. _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 + + 10.21384/p27z-6n52 \ No newline at end of file diff --git a/docs/appendices/appendix-1/resourceTypeGeneral.rst b/docs/appendices/appendix-1/resourceTypeGeneral.rst index 358e954..dcbad32 100644 --- a/docs/appendices/appendix-1/resourceTypeGeneral.rst +++ b/docs/appendices/appendix-1/resourceTypeGeneral.rst @@ -22,7 +22,9 @@ Audiovisual **Examples and Usage Notes:** May be used for films, video, etc. -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.17608/k6.auckland.4620790.v1 +.. code:: xml + + Video recording **Suggested Dublin Core Mapping:** MovingImage @@ -56,8 +58,6 @@ Book **Examples and Usage Notes:** -Example: - .. code:: xml Textbook @@ -74,9 +74,9 @@ BookChapter **Examples and Usage Notes:** -https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.15122/isbn.978-2-406-09313-8.p.0639 +.. code:: xml -https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.17613/m6631d + **Suggested Dublin Core Mapping:** Text @@ -90,7 +90,9 @@ Collection **Examples and Usage Notes:** A collection of samples, or various files making up a report -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.1594/pangaea.877589 +.. code:: xml + + Collection of datasets **Suggested Dublin Core Mapping:** Collection @@ -104,11 +106,9 @@ ComputationalNotebook **Examples and Usage Notes:** -Example: - .. code:: xml - Jupyter + Jupyter notebook **Suggested Dublin Core Mapping:** InteractiveResource @@ -122,11 +122,9 @@ ConferencePaper **Examples and Usage Notes:** -Example: - .. code:: xml - Experience Report + Experience report **Suggested Dublin Core Mapping:** Text @@ -140,11 +138,9 @@ ConferenceProceeding **Examples and Usage Notes:** -Example: - .. code:: xml - Annual Convention + **Suggested Dublin Core Mapping:** Text @@ -158,7 +154,9 @@ DataPaper **Examples and Usage Notes:** A data paper describes data provenance and methodologies used in the gathering, processing, organizing, and representing the data -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.17912/w2mw2d +.. code:: xml + + **Suggested Dublin Core Mapping:** Text @@ -172,7 +170,10 @@ Dataset **Examples and Usage Notes:** Data file or files -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.1594/pangaea.804876 +.. code:: xml + + Survey data + **Suggested Dublin Core Mapping:** Dataset @@ -186,8 +187,6 @@ Dissertation **Examples and Usage Notes:** -Example: - .. code:: xml PhD thesis @@ -204,7 +203,9 @@ Event **Examples and Usage Notes:** Descriptive information and/or content that is the basis for discovery of the purpose, location, duration, and responsible agents associated with an event such as a webcast or convention -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.7269/p3rn35sz +.. code:: xml + + Conference **Suggested Dublin Core Mapping:** Event @@ -218,7 +219,9 @@ Image **Examples and Usage Notes:** Digitised or born digital images, drawings or photographs -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.6083/m4qn65c5 +.. code:: xml + + Photograph **Suggested Dublin Core Mapping:** Image @@ -232,8 +235,6 @@ Instrument **Examples and Usage Notes:** Note that this is meant to be the instrument instance, e.g., the individual physical device, not the digital description or design of an instrument. -Example: - .. code:: xml Reflectometer @@ -250,7 +251,9 @@ InteractiveResource **Examples and Usage Notes:** Training modules, files that require use of a viewer (e.g., Flash), or query/response portals -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.7269/p3tb14tr +.. code:: xml + + **Suggested Dublin Core Mapping:** InteractiveResource @@ -264,11 +267,9 @@ Journal **Examples and Usage Notes:** -Example: - .. code:: xml - + **Suggested Dublin Core Mapping:** Text @@ -282,11 +283,9 @@ JournalArticle **Examples and Usage Notes:** -Example: - .. code:: xml - + **Suggested Dublin Core Mapping:** Text @@ -300,7 +299,9 @@ Model **Examples and Usage Notes:** Modelled descriptions of, for example, different aspects of languages or a molecular biology reaction chain -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.5285/4d866cd2-c907-4ce2-b070-084ca9779dc2 +.. code:: xml + + 3D model **Suggested Dublin Core Mapping:** N/A @@ -314,8 +315,6 @@ OutputManagementPlan **Examples and Usage Notes:** Includes data, software, and materials. -Example: - .. code:: xml Data Management Plan @@ -330,13 +329,11 @@ PeerReview **Description:** Evaluation of scientific, academic, or professional work by others working in the same field. -**Examples and Usage Notes:** https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.6084/m9.figshare.5742270 - -Example: +**Examples and Usage Notes:** .. code:: xml - Scientific Article + **Suggested Dublin Core Mapping:** Text @@ -350,11 +347,31 @@ PhysicalObject **Examples and Usage Notes:** Artifacts, specimens, material samples, and features-of-interest of any size. Note that digital representations of physical objects should use one of the other resourceTypeGeneral values. -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.7299/X78052RB +.. code:: xml + + Individual Sample **Suggested Dublin Core Mapping:** PhysicalObject +.. _Poster: + +Poster +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Description:** A display poster, typically containing text with illustrative figures and/or tables, usually reporting research results or proposing hypotheses, submitted for acceptance to and/or presented at a conference, seminar, symposium, workshop or similar event. + +**Examples and Usage Notes:** + +Posters may be physical or digital. + +.. code:: xml + + Conference poster + +**Suggested Dublin Core Mapping:** N/A + + .. _Preprint: Preprint @@ -364,15 +381,31 @@ Preprint **Examples and Usage Notes:** -Example: - .. code:: xml - Research Paper + Research paper **Suggested Dublin Core Mapping:** Text +.. _Presentation: + +Presentation +~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Description:** A set of slides containing text, tables or figures, designed to communicate ideas or research results, for viewing by an audience at a conference, symposium, seminar, lecture, workshop or other event. + +**Examples and Usage Notes:** + +For a video recording of a presentation, use “Audiovisual”. + +.. code:: xml + + Conference presentation slides + +**Suggested Dublin Core Mapping:** N/A + + .. _Project: Project @@ -382,8 +415,6 @@ Project **Examples and Usage Notes:** This resource type represents the project and includes research projects and studies. For a project deliverable or description of a project, use the corresponding resource type for the output—e.g., for a project report, dissertation, or study registration, use the resourceTypeGeneral “Report”, “Dissertation”, or “StudyRegistration” instead. -Examples: - .. code:: xml Field season @@ -405,11 +436,9 @@ Report **Examples and Usage Notes:** -Example: - .. code:: xml - Annual Report + Annual report **Suggested Dublin Core Mapping:** Text @@ -423,7 +452,9 @@ Service **Examples and Usage Notes:** Data management service, or long-term preservation service -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.21938/3I01ISNUCODNH1ZJBCVUWA +.. code:: xml + + **Suggested Dublin Core Mapping:** Service @@ -437,7 +468,9 @@ Software **Examples and Usage Notes:** Software supporting scholarly research -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.4225/03/5954F738EE5AA +.. code:: xml + + Simulation tool **Suggested Dublin Core Mapping:** Software @@ -451,7 +484,9 @@ Sound **Examples and Usage Notes:** Audio recording -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.7282/T3J67F05 +.. code:: xml + + Music **Suggested Dublin Core Mapping:** Sound @@ -465,11 +500,9 @@ Standard **Examples and Usage Notes:** -Example: - .. code:: xml - Dublin Core + **Suggested Dublin Core Mapping:** Text @@ -483,8 +516,6 @@ StudyRegistration **Examples and Usage Notes:** Includes pre-registrations, registered reports, and clinical trials. Study registrations are sometimes peer-reviewed and may include the hypothesis, expected results, study design, and/or analysis plan. -Example: - .. code:: xml Pre-registration @@ -501,7 +532,9 @@ Text **Examples and Usage Notes:** -Example: https://api.datacite.org/dois/application/vnd.datacite.datacite+xml/10.5682/9786065914018 +.. code:: xml + + Correspondence **Suggested Dublin Core Mapping:** Text @@ -513,7 +546,11 @@ Workflow **Description:** A structured series of steps which can be executed to produce a final outcome, allowing users a means to specify and enact their work in a more reproducible manner. -**Examples and Usage Notes:** Computational workflows involving sequential operations made on data by wrapped software and may be specified in a format belonging to a workflow management system, such as Taverna (http://www.taverna.org.uk/). [#f2]_ +**Examples and Usage Notes:** Computational workflows involving sequential operations made on data by wrapped software and may be specified in a format belonging to a workflow management system. + +.. code:: xml + + Protocol **Suggested Dublin Core Mapping:** N/A @@ -532,4 +569,3 @@ Other .. rubric:: Footnotes .. [#f1] Where there is direct correspondence with the Dublin Core Metadata, DataCite definitions have borrowed liberally from the DCMI definitions. See: http://dublincore.org/documents/dcmi-terms/index.shtml -.. [#f2] An education module on workflows prepared by DataONE is available at http://www.dataone.org/sites/all/documents/L10_AnalysisWorkflows.pptx diff --git a/docs/appendices/appendix-2.rst b/docs/appendices/appendix-2.rst index 2132f20..daec78b 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.6 `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rubric:: Schema changes + +* Addition of :ref:`Award` and :ref:`Project` to the :doc:`/appendices/appendix-1/resourceTypeGeneral` controlled list values. +* Addition of :ref:`CSTR` and :ref:`RRID` to the :doc:`/appendices/appendix-1/relatedIdentifierType` controlled list values. +* Addition of new :doc:`/appendices/appendix-1/contributorType`: :ref:`Translator` +* Addition of new :doc:`/appendices/appendix-1/relationType` pair: :ref:`HasTranslation` and :ref:`IsTranslationOf` +* Addition of new :doc:`/appendices/appendix-1/dateType`: :ref:`Coverage` + +.. rubric:: Documentation changes + +* Clarification of the allowed values for :ref:`9`. +* Updated the guidance for using :ref:`xmllang`. + `Version 4.5 `_ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/conf.py b/docs/conf.py index 135af66..b008dec 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.6' -version = '4.6' +release = '4.7' +version = '4.7' # -- General configuration @@ -101,7 +101,7 @@ } latex_documents = [ - ('index', 'DataCite-MetadataKernel_v4.6.tex', + ('index', 'DataCite-MetadataKernel_v4.7.tex', u'DataCite Metadata Schema Documentation', u'DataCite Metadata Working Group', 'howto'), ] diff --git a/docs/index.rst b/docs/index.rst index 5d82256..49f4951 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. (2024). DataCite Metadata Schema for the Publication and Citation of Research Data and Other Research Outputs. Version 4.6. DataCite e.V. https://doi.org/10.14454/mzv1-5b55 + 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 Contributors from the DataCite Metadata Working Group: @@ -27,10 +27,6 @@ Contributors from the DataCite Metadata Working Group: Kirsten ElgerORCID logo -.. |Vanessa Gabriel| raw:: html - - Vanessa GabrielORCID logo - .. |Ted Habermann| raw:: html Ted HabermannORCID logo @@ -55,10 +51,6 @@ Contributors from the DataCite Metadata Working Group: Mike ShallcrossORCID logo -.. |Jessica Parland-von Essen| raw:: html - - Jessica Parland-von EssenORCID logo - .. |Kelly Stathis| raw:: html Kelly StathisORCID logo @@ -71,9 +63,29 @@ Contributors from the DataCite Metadata Working Group: Hana VyčítalováORCID logo -.. |Alexander Whelan| raw:: html +.. |Melissa Harrison| raw:: html + + Melissa HarrisonORCID logo + +.. |Peyton Tvrdy| raw:: html + + Peyton TvrdyORCID logo + +.. |Dorothea Strecker| raw:: html + + Dorothea StreckerORCID logo + +.. |Ian Mathews| raw:: html + + Ian MathewsORCID logo + +.. |Robin Kraus| raw:: html + + Robin KrausORCID logo + +.. |Adam Vials Moore| raw:: html - Alexander WhelanORCID logo + Adam Vials MooreORCID logo .. |Sara El-Gebali| raw:: html @@ -99,10 +111,6 @@ Contributors from the DataCite Metadata Working Group: GFZ German Research Centre for GeosciencesROR logo -.. |University Library of the LMU Munich| raw:: html - - University Library of the LMU MunichROR logo - .. |Metadata Game Changers| raw:: html Metadata Game ChangersROR logo @@ -111,9 +119,9 @@ Contributors from the DataCite Metadata Working Group: The National GalleryROR logo -.. |National Institute of Standards and Technology (US)| raw:: html +.. |Sage Data| raw:: html - National Institute of Standards and Technology (US)ROR logo + Sage DataROR logo .. |University of Maryland| raw:: html @@ -127,10 +135,6 @@ Contributors from the DataCite Metadata Working Group: Inter-university Consortium for Political and Social ResearchROR logo -.. |CSC - IT Center for Science| raw:: html - - CSC - IT Center for ScienceROR logo - .. |CERN| raw:: html CERNROR logo @@ -139,13 +143,33 @@ Contributors from the DataCite Metadata Working Group: National Library of Technology (Czech Republic)ROR logo -.. |New York University| raw:: html +.. |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 + +.. |Redivis| raw:: html + + RedivisROR logo + +.. |TIB Hanover| raw:: html + + TIB HannoverROR logo + +.. |Jisc| raw:: html - New York UniversityROR logo + JiscROR logo .. |DataCite| raw:: html - DataCiteROR logo + DataCiteROR logo .. only:: not latex @@ -155,16 +179,19 @@ 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| - * |Vanessa Gabriel|, |University Library of the LMU Munich| * |Ted Habermann|, |Metadata Game Changers| - * |Andrea Medina-Smith|, |National Institute of Standards and Technology (US)| + * |Melissa Harrison|, |EMBL-EBI| + * |Robin Kraus|, |TIB Hanover| + * |Ian Mathews|, |Redivis| + * |Andrea Medina-Smith|, |Sage Data| + * |Adam Vials Moore|, |Jisc| * |Joseph Padfield|, |The National Gallery| - * |Jessica Parland-von Essen|, |CSC - IT Center for Science| * |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)| - * |Alexander Whelan|, |New York University| * |Kelly Stathis|, |DataCite| * |Sara El-Gebali|, |DataCite| @@ -176,16 +203,19 @@ 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 - * Vanessa Gabriel, University Library of the LMU Munich * Ted Habermann, Metadata Game Changers - * Andrea Medina-Smith, National Institute of Standards and Technology (US) + * Melissa Harrison, EMBL-EBI + * Robin Kraus, TIB Hanover + * Ian Mathews, Redivis + * Andrea Medina-Smith, Sage Data + * Adam Vials Moore, Jisc * Joseph Padfield, The National Gallery - * Jessica Parland-von Essen, CSC - IT Center for Science * 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) - * Alexander Whelan, New York University * Kelly Stathis, DataCite * Sara El-Gebali, DataCite diff --git a/docs/introduction/about-schema.rst b/docs/introduction/about-schema.rst index d877d19..71a4949 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. (2024). DataCite Metadata Schema Documentation for the Publication and Citation of Research Data and Other Research Outputs. Version 4.6. DataCite e.V. https://doi.org/10.14454/mzv1-5b55 + **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 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 80a12b3..945bab0 100644 --- a/docs/introduction/version-update.rst +++ b/docs/introduction/version-update.rst @@ -1,12 +1,12 @@ -Version 4.6 Update +Version 4.7 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.6/pdf/ - - Epub: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.6/epub/ + - PDF: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.7/pdf/ + - Epub: https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.7/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. @@ -16,24 +16,33 @@ These changes are in response to requests from DataCite community members—peop Schema changes ----------------------------- -* Addition of :ref:`Award` and :ref:`Project` to the :doc:`/appendices/appendix-1/resourceTypeGeneral` controlled list values. +* Addition of :ref:`Poster` and :ref:`Presentation` 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`). + * 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. -* Addition of :ref:`CSTR` and :ref:`RRID` 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: - * 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/contributorType`: :ref:`Translator` - - * 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:`HasTranslation` and :ref:`IsTranslationOf` - -* Addition of new :doc:`/appendices/appendix-1/dateType`: :ref:`Coverage` + * :ref:`12.g` for :ref:`12` + * :ref:`20.c` for :ref:`20` Documentation changes ----------------------------- -* Clarification of the allowed values for :ref:`9`. -* Updated the guidance for using :ref:`xmllang`. \ No newline at end of file +* 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`. diff --git a/docs/mappings/dublincore-qualified.rst b/docs/mappings/dublincore-qualified.rst index 9dc800c..e6239a3 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.6 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.7 of the DataCite Metadata Schema into records that comply with the Dublin Core Metadata Initiative Schema. .. _Table 4: diff --git a/docs/mappings/dublincore.rst b/docs/mappings/dublincore.rst index 2346b7e..380ab9e 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.6 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.7 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.6 of dublincore-qualified dublincore-local -The first mapping in :ref:`Table 4` can be used to convert records described following version 4.6 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.7 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/contributor.rst b/docs/properties/contributor.rst index 50feb03..217d6b6 100644 --- a/docs/properties/contributor.rst +++ b/docs/properties/contributor.rst @@ -124,7 +124,6 @@ If Contributor is used, then contributorType is mandatory. See :doc:`Appendix 1: Controlled List Definitions - contributorType ` for definitions. - .. _7.1: 7.1 contributorName @@ -158,6 +157,21 @@ The personal name format should be: family, given. Non- roman names should be tr * Organizational * Personal +.. _7.1.lang: + +7.1.lang xml:lang +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** The language of the contributor name. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. + +For contributor names, `xml:lang` is recommended only when nameType is "Organizational". + .. _7.2: 7.2 givenName diff --git a/docs/properties/creator.rst b/docs/properties/creator.rst index 20aeda9..deac8c5 100644 --- a/docs/properties/creator.rst +++ b/docs/properties/creator.rst @@ -107,6 +107,21 @@ Note that the personal name format should be: family, given. Names in non-roman * Organizational * Personal +.. _2.1.lang: + +2.1.lang xml:lang +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** The language of the creator name. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. + +For creator names, `xml:lang` is recommended only when nameType is "Organizational". + .. _2.2: 2.2 givenName diff --git a/docs/properties/description.rst b/docs/properties/description.rst index daa74a2..f52cb15 100644 --- a/docs/properties/description.rst +++ b/docs/properties/description.rst @@ -66,3 +66,17 @@ If Description is used, descriptionType is mandatory. Note: :ref:`SeriesInformation` as a container for series title, volume, issue, page number, and related fields, is now superseded by the new :ref:`20` property with relationType "IsPublishedIn" selected. See :doc:`Appendix 1: Controlled List Definitions - descriptionType ` for definitions. + + +.. _17.lang: + +17.lang xml:lang +~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** The language of the description. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. \ No newline at end of file diff --git a/docs/properties/overview.rst b/docs/properties/overview.rst index cd20aaf..9b6c921 100644 --- a/docs/properties/overview.rst +++ b/docs/properties/overview.rst @@ -113,8 +113,8 @@ The schema provides the :ref:`9` property to be used to describe the language of Mandatory Properties ------------------------------------------------- -The mandatory properties must be supplied with any initial metadata submission to DataCite, together with their relevant sub-properties. **If one of the required -properties is unavailable**, please use one of the standard (machine-recognizable) codes listed in +The mandatory properties must be supplied with any initial metadata submission to DataCite, together with their relevant sub-properties. If one of the required +properties is unavailable, please use one of the standard (machine-recognizable) codes listed in :doc:`/appendices/appendix-3`. .. _Table_1: @@ -139,15 +139,12 @@ Table 1: DataCite Mandatory Properties | 10 | :ref:`ResourceType <10>` | M | +----+-----------------------------------------------------------------------------------------+------------+ +.. _Guidance_missing_values: + Guidance for handling missing mandatory property values ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If providing values for any of the mandatory properties presents a difficulty, use of standard machine - recognizable codes is strongly advised. A set of the codes is provided in :doc:`/appendices/appendix-3`. However, we recommend that you consider the resulting effect on the citation created from the metadata provided. - -Here is an example of a citation that uses machine-readable substitutions for all but one of the required metadata properties. Obviously the more metadata that is supplied, the more information is conveyed. Note that this is a demonstration DOI and not an actual identifier, so the link will not work. :: - - :unkn 9999: :none. :null. Dataset. https://doi.org/10.5072/FK2JW8C992 - +If providing values for any of the mandatory properties presents a difficulty, use of standard machine-recognizable codes is strongly advised. A set of the codes is provided in :doc:`/appendices/appendix-3`. However, we recommend that you consider the resulting effect on the citation created from the metadata provided. [#f4]_ Recommended and Optional Properties ------------------------------------------------- @@ -196,4 +193,5 @@ Table 2: DataCite Recommended and Optional Properties .. rubric:: Footnotes .. [#f1] This convention is known as “camelCase.” https://en.wikipedia.org/wiki/CamelCase .. [#f2] `xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. -.. [#f3] For creator and contributor names, `xml:lang` is recommended only when nameType is "Organizational". \ No newline at end of file +.. [#f3] For creator and contributor names, `xml:lang` is recommended only when nameType is "Organizational". +.. [#f4] The standard values will be represented as provided in the citation string. For example, here is an example of a citation that uses machine-readable substitutions for all but one of the required metadata properties. The less metadata that is supplied, the less information is conveyed: ``:unkn (2020). :none. :null. https://doi.org/10.5072/FK2JW8C992`` \ No newline at end of file diff --git a/docs/properties/publisher.rst b/docs/properties/publisher.rst index 1820895..f77d377 100644 --- a/docs/properties/publisher.rst +++ b/docs/properties/publisher.rst @@ -104,3 +104,17 @@ Examples: * https://re3data.org/ * https://viaf.org/ * https://www.wikidata.org/wiki/ + + +.. _4.lang: + +4.lang xml:lang +~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** The language of the publisher name. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. \ No newline at end of file diff --git a/docs/properties/relatedidentifier.rst b/docs/properties/relatedidentifier.rst index 91c6752..d420139 100644 --- a/docs/properties/relatedidentifier.rst +++ b/docs/properties/relatedidentifier.rst @@ -82,7 +82,9 @@ If relatedIdentifier is used, relatedIdentifierType is mandatory. * :ref:`LSID` * :ref:`PMID` * :ref:`PURL` +* :ref:`RAiD` * :ref:`RRID` +* :ref:`SWHID` * :ref:`UPC` * :ref:`URL` * :ref:`URN` @@ -145,6 +147,7 @@ Note: Some relationTypes are processed as citations and references. Read more ab * :ref:`Collects` * :ref:`IsTranslationOf` * :ref:`HasTranslation` +* :ref:`relationType_Other` See :doc:`Appendix 1: Controlled List Definitions - relationType ` for definitions, examples and usage notes. @@ -227,7 +230,9 @@ Use the controlled list values as stated in :ref:`10.a`: * :ref:`OutputManagementPlan` * :ref:`PeerReview` * :ref:`PhysicalObject` +* :ref:`Poster` * :ref:`Preprint` +* :ref:`Presentation` * :ref:`Project` * :ref:`Report` * :ref:`Service` @@ -240,3 +245,17 @@ Use the controlled list values as stated in :ref:`10.a`: * :ref:`resourceTypeGeneral_Other` See :doc:`Appendix 1: Controlled List Definitions - resourceTypeGeneral ` for definitions, examples and usage notes. + +.. _12.g: + +12.g relationTypeInformation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** Additional information about the selected :ref:`12.b`, if appropriate. + +**Allowed values, examples, other constraints:** + +Free text. +May be used to provide more information about the nature of the relationship. Recommended for use with the relationType :ref:`relationType_Other`. diff --git a/docs/properties/relateditem.rst b/docs/properties/relateditem.rst index 104705d..1c2299d 100644 --- a/docs/properties/relateditem.rst +++ b/docs/properties/relateditem.rst @@ -56,7 +56,9 @@ Use the controlled list values as stated in :ref:`10.a`: * :ref:`OutputManagementPlan` * :ref:`PeerReview` * :ref:`PhysicalObject` +* :ref:`Poster` * :ref:`Preprint` +* :ref:`Presentation` * :ref:`Project` * :ref:`Report` * :ref:`Service` @@ -121,11 +123,26 @@ Use the controlled list values as stated in :ref:`12.b`: * :ref:`Collects` * :ref:`IsTranslationOf` * :ref:`HasTranslation` +* :ref:`relationType_Other` relationType :ref:`IsPublishedIn` can be used to include series information, like title, volume, issue, page, etc. See :doc:`Appendix 1: Controlled List Definitions - relationType ` for definitions, examples, and usage notes. +.. _20.c: + +20.c relationTypeInformation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** Additional information about the selected :ref:`20.b`, if appropriate. + +**Allowed values, examples, other constraints:** + +Free text. +May be used to provide more information about the nature of the relationship. Recommended for use with the relationType :ref:`relationType_Other`. + .. _20.1: 20.1 relatedItemIdentifier @@ -170,7 +187,9 @@ Use the controlled list values as stated in :ref:`12.a`: * :ref:`LSID` * :ref:`PMID` * :ref:`PURL` +* :ref:`RAiD` * :ref:`RRID` +* :ref:`SWHID` * :ref:`UPC` * :ref:`URL` * :ref:`URN` @@ -264,6 +283,23 @@ Note: The personal name, format should be: family, given. Non-roman names may be * Personal +.. _20.2.1.lang: + +20.2.1.lang xml:lang +####################### + +**Occurrences:** 0-1 + +**Definition:** The language of the creator name. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. + +For creator names, `xml:lang` is recommended only when nameType is "Organizational". + +.. _20.2.2: + 20.2.2 givenName ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -275,6 +311,7 @@ Note: The personal name, format should be: family, given. Non-roman names may be Examples based on the `20.2.1`_ names: Antoine; Mae +.. _20.2.3: 20.2.3 familyName ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -313,7 +350,21 @@ Example: Journal of the American Chemical Society The titleType sub-property is used when more than a single title is provided. Unless otherwise indicated by titleType, a title is considered to be the main title. -.. _20.4: + +.. _20.3.lang: + +20.3.lang xml:lang +^^^^^^^^^^^^^^^^^^^ + +**Occurrences:** 0-1 + +**Definition:** The language of the title. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. + +.. _20.4: 20.4 publicationYear ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -511,6 +562,24 @@ Note: The personal name, format should be: family, given. Non-roman names may be * Personal +.. _20.12.1.lang: + +20.12.1.lang xml:lang +####################### + +**Occurrences:** 0-1 + +**Definition:** The language of the contributor name. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. + +For contributor names, `xml:lang` is recommended only when nameType is "Organizational". + + +.. _20.12.2: + 20.12.2 givenName ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -523,6 +592,8 @@ Note: The personal name, format should be: family, given. Non-roman names may be Examples based on the `20.12.1`_ names: Antoine; Mae +.. _20.12.3: + 20.12.3 familyName ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/properties/resourcetype.rst b/docs/properties/resourcetype.rst index 559985c..a7dc2c0 100644 --- a/docs/properties/resourcetype.rst +++ b/docs/properties/resourcetype.rst @@ -68,7 +68,9 @@ Free text. The recommended content is a single term of some detail so that a pai * :ref:`OutputManagementPlan` * :ref:`PeerReview` * :ref:`PhysicalObject` +* :ref:`Poster` * :ref:`Preprint` +* :ref:`Presentation` * :ref:`Project` * :ref:`Report` * :ref:`Service` diff --git a/docs/properties/rights.rst b/docs/properties/rights.rst index f31384a..00138e1 100644 --- a/docs/properties/rights.rst +++ b/docs/properties/rights.rst @@ -107,3 +107,17 @@ Example: SPDX **Allowed values, examples, other constraints:** Example: https://spdx.org/licenses/ + + +.. _16.lang: + +16.lang xml:lang +~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** The language of the rights information. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. \ No newline at end of file diff --git a/docs/properties/subject.rst b/docs/properties/subject.rst index 494ba2e..d15fcb0 100644 --- a/docs/properties/subject.rst +++ b/docs/properties/subject.rst @@ -111,3 +111,17 @@ Example: (where 310607 is the classification code associated with the subject term “Nanobiotechnology” in the ANZSRC Fields of Research subject scheme) The classificationCode sub-property may be used for subject schemes, like ANZSRC, which do not have valueURIs for each subject term. + + +.. _6.lang: + +6.lang xml:lang +~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** The language of the subject. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. \ No newline at end of file diff --git a/docs/properties/title.rst b/docs/properties/title.rst index fb77aac..53dd31e 100644 --- a/docs/properties/title.rst +++ b/docs/properties/title.rst @@ -62,3 +62,17 @@ Free text. * Other The titleType subproperty is used when more than a single title is provided. Unless otherwise indicated by titleType, a title is considered to be the main title. + + +.. _3.lang: + +3.lang xml:lang +~~~~~~~~~~~~~~~~~~~~~~ + +**Occurrences:** 0-1 + +**Definition:** The language of the title. + +**Allowed values, examples, other constraints:** + +`xml:lang` values must follow the pattern defined by the `XML schema language type `_, e.g.: fr, cmn, nys, swh. See the W3C’s `Choosing a Language Tag `_ for guidance on recommended values. \ No newline at end of file diff --git a/docs/xml.rst b/docs/xml.rst index d7da82c..2ec4da4 100644 --- a/docs/xml.rst +++ b/docs/xml.rst @@ -5,7 +5,7 @@ XML Schema -------------------------------- The XML Schema is available here: -https://schema.datacite.org/meta/kernel-4.6/metadata.xsd +https://schema.datacite.org/meta/kernel-4.7/metadata.xsd JSON Representation @@ -25,31 +25,39 @@ Demonstration Examples .. tab:: XML - * `Full DataCite metadata example (all properties) `_ - * `Dataset resourceTypeGeneral `_ - * `Award resourceTypeGeneral `_ - * `Project resourceTypeGeneral `_ - * `Coverage dateType `_ + * `Full DataCite metadata example (all properties) `_ + * `Dataset resourceTypeGeneral `_ + * `Poster resourceTypeGeneral `_ + * `Presentation resourceTypeGeneral `_ + * `Audiovisual resourceTypeGeneral `_ + * `Award resourceTypeGeneral `_ + * `Project resourceTypeGeneral `_ + * `relationTypeInformation attribute with relationType "Other" `_ + * `Coverage dateType `_ * Connecting a translation to the original work: - * `Translation `_ - * `Original (translated) work `_ - * `Document containing two languages in parallel `_ - * `Multilingual metadata `_ + * `Translation `_ + * `Original (translated) work `_ + * `Document containing two languages in parallel `_ + * `Multilingual metadata `_ * RelatedItem: - * `Journal article in a journal (with an ISSN) `_ - * `Digitized book chapter in a book (with no identifier) `_ - * `Digitized book chapter in a book (with an ISBN) `_ + * `Journal article in a journal (with an ISSN) `_ + * `Digitized book chapter in a book (with no identifier) `_ + * `Digitized book chapter in a book (with an ISBN) `_ .. tab:: JSON * `Full DataCite metadata example (all properties) `_ * `Dataset resourceTypeGeneral `_ + * `Poster resourceTypeGeneral `_ + * `Presentation resourceTypeGeneral `_ + * `Audiovisual resourceTypeGeneral `_ * `Award resourceTypeGeneral `_ * `Project resourceTypeGeneral `_ + * `relationTypeInformation attribute with relationType "Other" `_ * `Coverage dateType `_ * Connecting a translation to the original work: