From f7ca88b1a0064c9d2e47a47cb8a6218bea8ff9ef Mon Sep 17 00:00:00 2001 From: tedhabermann Date: Thu, 3 Oct 2024 08:54:47 -0600 Subject: [PATCH 01/13] Update cookbook for new DataCite schema (4.5) and add a couple of details. --- .DS_Store | Bin 0 -> 6148 bytes datacite-cookbook/metadata.rst | 68 +++++++++++++++++++++++---------- 2 files changed, 48 insertions(+), 20 deletions(-) create mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..be904e13a449d9384879daa1617568d2a3c0ed40 GIT binary patch literal 6148 zcmeHKyGjH>5Ukb<4ouF>aDKqRKNybl3;Y4^ZWTmf12x~s@AA{Eek98x2#3j04c#@< z(>2Rhu)Phywx7ctumP~9JL1d3()`?gVHcG#BAs^}@q!OL;g+kvnRBl(U{BtD#vd`_ z6$eJ*^YDH=jN_Y^%cOu5kOERb3P^zy6sTspzB=I!QKf(sI8O!q`_Sl)y>Lp5PX|Mc z0K^s3VO+;7L2RBN_QENV8JZ=Pm{h9~!;;Q?tGZq|B_`, in the `nameIdentifier` + subproperty of `Contributor `_. `Manufacturer` The organization or individual that built the instrument. Add as DataCite property `Creator`. Consider also to add an identifier for - the manufacturer in the `nameIdentifier` subproperty of `Creator`. + the manufacturer in the `nameIdentifier` subproperty of `Creator `_. `Model` The name of the model or type of the instrument. As of this @@ -58,7 +61,9 @@ instrument can be best represented in the DataCite Schema: `Description` A textual description of the device and its capabilities. Add as - DataCite property `Description` with `descriptionType=Abstract`. + DataCite property `Description` with `descriptionType=Abstract`. A description with + `descriptionType=TechnicalInfo` can also be used to provide additional technical details + (see Model, InstrumentType, and MeasuredVariable). `InstrumentType` A classification of the type of the instrument. As of this writing, @@ -87,10 +92,30 @@ instrument can be best represented in the DataCite Schema: instrument has already been decommissioned. `RelatedIdentifier` - This can be used to establish links to related resources. The + This can be used to establish links to related resources with identifiers. The DataCite Schema has a property with the same name, having very similar subproperties and semantics as the PIDINST Schema. + The type of the relation is described using the relationType property. The DataCite schema has + a list of valid `relation types `_. + + Several relation types can be used to connect to more detailed instrument metadata: + * `IsDescribedBy _` + can be used to link to a more detailed description of the instrument. + * `HasMetadata ` can be used to + link to metadata records that describe the instrument in more detail. + * `HasVersion `_, + `IsVersionOf `_, + `IsNewVersionOf `_, + and `IsPreviousVersionOf `_ can be used to link to + other versions of the instrument. + * `HasPart `_ and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. + + Version 4.5 of the DataCite schema added the relation type `Collects`_ + for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B. The complimentary relationship + (dataset B is collected by instrument A) can be described using the relation type `IsCollectedBy`_. + + `AlternateIdentifier` To be used if this instrument is also registered elsewhere. Add as DataCite property `AlternateIdentifier`. Use @@ -139,25 +164,28 @@ considered as well, if it makes sense for a particular use case. be set. We recommend to set it to the entity that created the DOI and is responsible for maintaining the DOI metadata. + In Version 4.5 of the schema several sub-properties were added to `publisher`_: + * publisherIdentifier: An identifier for the publisher. Use a ROR ID if available. + * publisherIdentifierScheme: The scheme for the publisher identifier (e.g. ROR). + * schemeURI: The URI of the identifier scheme (e.g. https://ror.org). + `PublicationYear` Mandatory in the DataCite Schema. We suggest to set it to the year of issuing the DOI. -`ResourceType` +`ResourceTypeGeneral`and `ResourceType` DataCite DOIs are for many different types of objects, so there is a - need to indicate the type. This is mandatory in the DataCite - Schema. `ResourceType` is free text, but even more relevant is the - subproperty `resourceTypeGeneral` having a controlled list of values - with defined types of resources. Set - `resourceTypeGeneral=Instrument` here. + need to indicate the type. ResourceTypeGeneral is a mandatory element in the DataCite + Schema selected from a `shared vocabulary `_. + Set `resourceTypeGeneral=Instrument` for DataCite instrument metadata records. -`FundingReference` - This is optional in the DataCite Schema, but it may be useful to - acknowledge external funding that supported the purchase or the - creation of the instrument. + ResourceType is a free text field that can be used to provide a more specific resource type. +`FundingReference` + This optional element can be used to acknowledge external funding that supported the purchase or the + creation of the instrument. See `funder metadata `_ for details. -.. _DataCite Metadata Schema: https://schema.datacite.org/ +.. _DataCite Metadata Schema: https://datacite-metadata-schema.readthedocs.io/en/4.5/introduction/ .. _DataCite PIDINST Mapping: https://datacite-metadata-schema.readthedocs.io/en/latest/mappings/pidinst/ From e07a9b5ba515abe7c6c82f2a51c529caddddf2e2 Mon Sep 17 00:00:00 2001 From: tedhabermann Date: Thu, 3 Oct 2024 09:14:43 -0600 Subject: [PATCH 02/13] A few small updates Checking for a syntax problem - but could not find any. The build from the first file I sent looks good, i.e. no errors. This branch includes those changes. --- datacite-cookbook/metadata.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index bdbe489..d00c386 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -31,22 +31,22 @@ instrument can be best represented in the DataCite Schema: `Name` The name by which this instrument is known. Add as DataCite property - `Title`. The DataCite schema allows for multiple kinds of titles that are + `Title `_. The DataCite schema allows for multiple kinds of titles that are distinguished by the `titleType` subproperty. A title without a specified - type is assumed to be the main title. Many instruments are commonly refered - to with acronyms. Use "title (acronym)" to include the acronym in the main title. + type is assumed to be the main title. + + Many instruments are commonly refered + to with acronyms. Use "title" with TitleType="AlternateTitle" to include the acronym for the instrument. `Owner` The organization or individual that manages the instrument. Add as DataCite property `Contributor` with `contributorType=HostingInstitution`. - An identifier can be used to unambiguously identify the owner, - typically a `ROR `, in the `nameIdentifier` + An identifier, typically a `ROR `, can be used to unambiguously identify the owner in the `nameIdentifier` subproperty of `Contributor `_. `Manufacturer` The organization or individual that built the instrument. Add as - DataCite property `Creator`. Consider also to add an identifier for - the manufacturer in the `nameIdentifier` subproperty of `Creator `_. + DataCite property `Creator`. Consider also to add an identifier, typically a `ROR `, for the manufacturer in the `nameIdentifier` subproperty of `Creator `_. `Model` The name of the model or type of the instrument. As of this @@ -111,9 +111,9 @@ instrument can be best represented in the DataCite Schema: other versions of the instrument. * `HasPart `_ and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. - Version 4.5 of the DataCite schema added the relation type `Collects`_ - for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B. The complimentary relationship - (dataset B is collected by instrument A) can be described using the relation type `IsCollectedBy`_. + `Collects`_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B + * `IsCollectedBy`_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship + (dataset B is collected by instrument A). `AlternateIdentifier` @@ -183,7 +183,7 @@ considered as well, if it makes sense for a particular use case. `FundingReference` This optional element can be used to acknowledge external funding that supported the purchase or the - creation of the instrument. See `funder metadata `_ for details. + creation of the instrument. See `FundingReference `_ for details. .. _DataCite Metadata Schema: https://datacite-metadata-schema.readthedocs.io/en/4.5/introduction/ From 3f607504a68a3a0bd26e41b8964964e8f19b219d Mon Sep 17 00:00:00 2001 From: tedhabermann Date: Thu, 3 Oct 2024 09:30:17 -0600 Subject: [PATCH 03/13] Update metadata.rst Trying to fix rst errors. Many lines with blanks on the end, lines too long, bad targets. It seems there must be a space before the url in links. --- datacite-cookbook/metadata.rst | 46 ++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index d00c386..efd8119 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -31,16 +31,17 @@ instrument can be best represented in the DataCite Schema: `Name` The name by which this instrument is known. Add as DataCite property - `Title `_. The DataCite schema allows for multiple kinds of titles that are + `Title `_. The DataCite schema allows for multiple kinds of titles that are distinguished by the `titleType` subproperty. A title without a specified - type is assumed to be the main title. - - Many instruments are commonly refered - to with acronyms. Use "title" with TitleType="AlternateTitle" to include the acronym for the instrument. - + type is assumed to be the main title. + + Many instruments are commonly refered + to with acronyms. Use "title" with TitleType="AlternateTitle" to include + the acronym for the instrument. + `Owner` The organization or individual that manages the instrument. Add as - DataCite property `Contributor` with `contributorType=HostingInstitution`. + DataCite property `Contributor` with `contributorType=HostingInstitution`. An identifier, typically a `ROR `, can be used to unambiguously identify the owner in the `nameIdentifier` subproperty of `Contributor `_. @@ -62,7 +63,7 @@ instrument can be best represented in the DataCite Schema: `Description` A textual description of the device and its capabilities. Add as DataCite property `Description` with `descriptionType=Abstract`. A description with - `descriptionType=TechnicalInfo` can also be used to provide additional technical details + `descriptionType=TechnicalInfo` can also be used to provide additional technical details (see Model, InstrumentType, and MeasuredVariable). `InstrumentType` @@ -96,23 +97,24 @@ instrument can be best represented in the DataCite Schema: DataCite Schema has a property with the same name, having very similar subproperties and semantics as the PIDINST Schema. - The type of the relation is described using the relationType property. The DataCite schema has + The type of the relation is described using the relationType property. The DataCite schema has a list of valid `relation types `_. - + Several relation types can be used to connect to more detailed instrument metadata: * `IsDescribedBy _` - can be used to link to a more detailed description of the instrument. + can be used to link to a more detailed description of the instrument. * `HasMetadata ` can be used to - link to metadata records that describe the instrument in more detail. + link to metadata records that describe the instrument in more detail. * `HasVersion `_, - `IsVersionOf `_, - `IsNewVersionOf `_, + `IsVersionOf `_, + `IsNewVersionOf `_, and `IsPreviousVersionOf `_ can be used to link to other versions of the instrument. - * `HasPart `_ and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. + * `HasPart `_ + and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. - `Collects`_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B - * `IsCollectedBy`_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship + `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B + * `IsCollectedBy `_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship (dataset B is collected by instrument A). @@ -164,7 +166,8 @@ considered as well, if it makes sense for a particular use case. be set. We recommend to set it to the entity that created the DOI and is responsible for maintaining the DOI metadata. - In Version 4.5 of the schema several sub-properties were added to `publisher`_: + In Version 4.5 of the schema several sub-properties were added + to `publisher `_: * publisherIdentifier: An identifier for the publisher. Use a ROR ID if available. * publisherIdentifierScheme: The scheme for the publisher identifier (e.g. ROR). * schemeURI: The URI of the identifier scheme (e.g. https://ror.org). @@ -173,10 +176,11 @@ considered as well, if it makes sense for a particular use case. Mandatory in the DataCite Schema. We suggest to set it to the year of issuing the DOI. -`ResourceTypeGeneral`and `ResourceType` +`ResourceTypeGeneral`and `ResourceType` DataCite DOIs are for many different types of objects, so there is a - need to indicate the type. ResourceTypeGeneral is a mandatory element in the DataCite - Schema selected from a `shared vocabulary `_. + need to indicate the type. ResourceTypeGeneral is a mandatory element in the DataCite + Schema selected from a + `shared vocabulary `_. Set `resourceTypeGeneral=Instrument` for DataCite instrument metadata records. ResourceType is a free text field that can be used to provide a more specific resource type. From 241d9fdec6e19900a8819e4bb0e1948c9dd8e9f9 Mon Sep 17 00:00:00 2001 From: tedhabermann Date: Thu, 3 Oct 2024 09:39:49 -0600 Subject: [PATCH 04/13] Update metadata.rst Trying to fix too long lines and trailing blanks... --- datacite-cookbook/metadata.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index efd8119..be47468 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -62,8 +62,9 @@ instrument can be best represented in the DataCite Schema: `Description` A textual description of the device and its capabilities. Add as - DataCite property `Description` with `descriptionType=Abstract`. A description with - `descriptionType=TechnicalInfo` can also be used to provide additional technical details + DataCite property `Description` with `descriptionType=Abstract`. + A description with `descriptionType=TechnicalInfo` can also + be used to provide additional technical details (see Model, InstrumentType, and MeasuredVariable). `InstrumentType` @@ -93,8 +94,8 @@ instrument can be best represented in the DataCite Schema: instrument has already been decommissioned. `RelatedIdentifier` - This can be used to establish links to related resources with identifiers. The - DataCite Schema has a property with the same name, having very + This can be used to establish links to related resources with identifiers. + The DataCite Schema has a property with the same name, having very similar subproperties and semantics as the PIDINST Schema. The type of the relation is described using the relationType property. The DataCite schema has @@ -110,7 +111,7 @@ instrument can be best represented in the DataCite Schema: `IsNewVersionOf `_, and `IsPreviousVersionOf `_ can be used to link to other versions of the instrument. - * `HasPart `_ + * `HasPart `_ and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B @@ -168,8 +169,8 @@ considered as well, if it makes sense for a particular use case. In Version 4.5 of the schema several sub-properties were added to `publisher `_: - * publisherIdentifier: An identifier for the publisher. Use a ROR ID if available. - * publisherIdentifierScheme: The scheme for the publisher identifier (e.g. ROR). + * publisherIdentifier: Identifier for publisher. Use a ROR ID if available. + * publisherIdentifierScheme: Scheme for publisher identifier (e.g. ROR). * schemeURI: The URI of the identifier scheme (e.g. https://ror.org). `PublicationYear` @@ -178,12 +179,15 @@ considered as well, if it makes sense for a particular use case. `ResourceTypeGeneral`and `ResourceType` DataCite DOIs are for many different types of objects, so there is a - need to indicate the type. ResourceTypeGeneral is a mandatory element in the DataCite + need to indicate the type. ResourceTypeGeneral is a + mandatory element in the DataCite Schema selected from a `shared vocabulary `_. - Set `resourceTypeGeneral=Instrument` for DataCite instrument metadata records. + Set `resourceTypeGeneral=Instrument` for DataCite instrument + metadata records. - ResourceType is a free text field that can be used to provide a more specific resource type. + ResourceType is a free text field that can be used to provide a more + specific resource type. `FundingReference` This optional element can be used to acknowledge external funding that supported the purchase or the From d272a20bce2b491ece86a2d71aae85cd8a9d36c0 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 15:04:22 +0100 Subject: [PATCH 05/13] Remove spurious .DS_Store file --- .DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index be904e13a449d9384879daa1617568d2a3c0ed40..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKyGjH>5Ukb<4ouF>aDKqRKNybl3;Y4^ZWTmf12x~s@AA{Eek98x2#3j04c#@< z(>2Rhu)Phywx7ctumP~9JL1d3()`?gVHcG#BAs^}@q!OL;g+kvnRBl(U{BtD#vd`_ z6$eJ*^YDH=jN_Y^%cOu5kOERb3P^zy6sTspzB=I!QKf(sI8O!q`_Sl)y>Lp5PX|Mc z0K^s3VO+;7L2RBN_QENV8JZ=Pm{h9~!;;Q?tGZq|B_ Date: Wed, 30 Oct 2024 15:31:33 +0100 Subject: [PATCH 06/13] Fix reStructuredText syntax errors, mostly with respect to lists --- datacite-cookbook/metadata.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index be47468..47b4bf3 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -102,21 +102,21 @@ instrument can be best represented in the DataCite Schema: a list of valid `relation types `_. Several relation types can be used to connect to more detailed instrument metadata: + * `IsDescribedBy _` - can be used to link to a more detailed description of the instrument. + can be used to link to a more detailed description of the instrument. * `HasMetadata ` can be used to - link to metadata records that describe the instrument in more detail. + link to metadata records that describe the instrument in more detail. * `HasVersion `_, - `IsVersionOf `_, - `IsNewVersionOf `_, - and `IsPreviousVersionOf `_ can be used to link to - other versions of the instrument. + `IsVersionOf `_, + `IsNewVersionOf `_, + and `IsPreviousVersionOf `_ can be used to link to + other versions of the instrument. * `HasPart `_ - and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. - - `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B + and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. + * `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B * `IsCollectedBy `_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship - (dataset B is collected by instrument A). + (dataset B is collected by instrument A). `AlternateIdentifier` @@ -169,6 +169,7 @@ considered as well, if it makes sense for a particular use case. In Version 4.5 of the schema several sub-properties were added to `publisher `_: + * publisherIdentifier: Identifier for publisher. Use a ROR ID if available. * publisherIdentifierScheme: Scheme for publisher identifier (e.g. ROR). * schemeURI: The URI of the identifier scheme (e.g. https://ror.org). @@ -177,7 +178,7 @@ considered as well, if it makes sense for a particular use case. Mandatory in the DataCite Schema. We suggest to set it to the year of issuing the DOI. -`ResourceTypeGeneral`and `ResourceType` +`ResourceTypeGeneral` and `ResourceType` DataCite DOIs are for many different types of objects, so there is a need to indicate the type. ResourceTypeGeneral is a mandatory element in the DataCite From e005f7069c0e1d7230ed5bcefddeeabceb6fa659 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 16:04:44 +0100 Subject: [PATCH 07/13] Move external links to the bottom of the page --- datacite-cookbook/metadata.rst | 89 +++++++++++++++++++++++++++------- 1 file changed, 71 insertions(+), 18 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index 47b4bf3..db3f5d7 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -31,7 +31,7 @@ instrument can be best represented in the DataCite Schema: `Name` The name by which this instrument is known. Add as DataCite property - `Title `_. The DataCite schema allows for multiple kinds of titles that are + `Title `_. The DataCite schema allows for multiple kinds of titles that are distinguished by the `titleType` subproperty. A title without a specified type is assumed to be the main title. @@ -42,12 +42,12 @@ instrument can be best represented in the DataCite Schema: `Owner` The organization or individual that manages the instrument. Add as DataCite property `Contributor` with `contributorType=HostingInstitution`. - An identifier, typically a `ROR `, can be used to unambiguously identify the owner in the `nameIdentifier` - subproperty of `Contributor `_. + An identifier, typically a `ROR`_, can be used to unambiguously identify the owner in the `nameIdentifier` + subproperty of `Contributor `_. `Manufacturer` The organization or individual that built the instrument. Add as - DataCite property `Creator`. Consider also to add an identifier, typically a `ROR `, for the manufacturer in the `nameIdentifier` subproperty of `Creator `_. + DataCite property `Creator`. Consider also to add an identifier, typically a `ROR`_, for the manufacturer in the `nameIdentifier` subproperty of `Creator `_. `Model` The name of the model or type of the instrument. As of this @@ -99,23 +99,23 @@ instrument can be best represented in the DataCite Schema: similar subproperties and semantics as the PIDINST Schema. The type of the relation is described using the relationType property. The DataCite schema has - a list of valid `relation types `_. + a list of valid `relation types `_. Several relation types can be used to connect to more detailed instrument metadata: - * `IsDescribedBy _` + * `IsDescribedBy `_ can be used to link to a more detailed description of the instrument. - * `HasMetadata ` can be used to + * `HasMetadata `_ can be used to link to metadata records that describe the instrument in more detail. - * `HasVersion `_, - `IsVersionOf `_, - `IsNewVersionOf `_, - and `IsPreviousVersionOf `_ can be used to link to + * `HasVersion `_, + `IsVersionOf `_, + `IsNewVersionOf `_, + and `IsPreviousVersionOf `_ can be used to link to other versions of the instrument. - * `HasPart `_ - and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. - * `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B - * `IsCollectedBy `_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship + * `HasPart `_ + and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. + * `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B + * `IsCollectedBy `_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship (dataset B is collected by instrument A). @@ -168,7 +168,7 @@ considered as well, if it makes sense for a particular use case. and is responsible for maintaining the DOI metadata. In Version 4.5 of the schema several sub-properties were added - to `publisher `_: + to `publisher `_: * publisherIdentifier: Identifier for publisher. Use a ROR ID if available. * publisherIdentifierScheme: Scheme for publisher identifier (e.g. ROR). @@ -183,7 +183,7 @@ considered as well, if it makes sense for a particular use case. need to indicate the type. ResourceTypeGeneral is a mandatory element in the DataCite Schema selected from a - `shared vocabulary `_. + `shared vocabulary `_. Set `resourceTypeGeneral=Instrument` for DataCite instrument metadata records. @@ -192,9 +192,62 @@ considered as well, if it makes sense for a particular use case. `FundingReference` This optional element can be used to acknowledge external funding that supported the purchase or the - creation of the instrument. See `FundingReference `_ for details. + creation of the instrument. See `FundingReference `_ for details. + +.. _ROR: https://ror.org/ .. _DataCite Metadata Schema: https://datacite-metadata-schema.readthedocs.io/en/4.5/introduction/ +.. _DataCite property Creator: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/creator/ + +.. _DataCite property Title: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/title/ + +.. _DataCite property Publisher: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/publisher/ + +.. _DataCite property Contributor: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/contributor/ + +.. _DataCite property FundingReference: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/fundingreference/ + +.. _DataCite definition resourceTypeGeneral: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/resourceTypeGeneral/ + +.. _DataCite definition relationType: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/ + +.. _DataCite definition IsDescribedBy: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#isdescribedby + +.. _DataCite definition HasMetadata: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#hasmetadata + +.. _DataCite definition HasVersion: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#hasversion + +.. _DataCite definition IsVersionOf: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#isversionof + +.. _DataCite definition IsNewVersionOf: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#isnewversionof + +.. _DataCite definition IsPreviousVersionOf: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#ispreviousversionof + +.. _DataCite definition IsPartOf: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#ispartof + +.. _DataCite definition HasPart: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#haspart + +.. _DataCite definition IsCollectedBy: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#iscollectedby + +.. _DataCite definition Collects: + https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#collects + .. _DataCite PIDINST Mapping: https://datacite-metadata-schema.readthedocs.io/en/latest/mappings/pidinst/ From 5b32b54813c90a7b1f29ea5877b359cd718fedbf Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 16:19:36 +0100 Subject: [PATCH 08/13] Adhere to the typing convention of the document to use backquotes to indicate literals --- datacite-cookbook/metadata.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index db3f5d7..058ee3c 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -36,7 +36,7 @@ instrument can be best represented in the DataCite Schema: type is assumed to be the main title. Many instruments are commonly refered - to with acronyms. Use "title" with TitleType="AlternateTitle" to include + to with acronyms. Use `Title` with `titleType=AlternateTitle` to include the acronym for the instrument. `Owner` @@ -170,9 +170,9 @@ considered as well, if it makes sense for a particular use case. In Version 4.5 of the schema several sub-properties were added to `publisher `_: - * publisherIdentifier: Identifier for publisher. Use a ROR ID if available. - * publisherIdentifierScheme: Scheme for publisher identifier (e.g. ROR). - * schemeURI: The URI of the identifier scheme (e.g. https://ror.org). + * `publisherIdentifier`: Identifier for publisher. Use a ROR ID if available. + * `publisherIdentifierScheme`: Scheme for publisher identifier (e.g. `ROR`). + * `schemeURI`: The URI of the identifier scheme (e.g. `https://ror.org`). `PublicationYear` Mandatory in the DataCite Schema. We suggest to set it to the year @@ -180,14 +180,14 @@ considered as well, if it makes sense for a particular use case. `ResourceTypeGeneral` and `ResourceType` DataCite DOIs are for many different types of objects, so there is a - need to indicate the type. ResourceTypeGeneral is a + need to indicate the type. `resourceTypeGeneral` is a mandatory element in the DataCite Schema selected from a `shared vocabulary `_. Set `resourceTypeGeneral=Instrument` for DataCite instrument metadata records. - ResourceType is a free text field that can be used to provide a more + `ResourceType` is a free text field that can be used to provide a more specific resource type. `FundingReference` From a146d867fa803c0f7886be8b8277ee22cc46daac Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 16:35:59 +0100 Subject: [PATCH 09/13] Style with respect to linking: - always link the first occurence of the term, - prefer linking `DataCite property X`_ rather than DataCite property `X`_ to make it clearer where that link goes to. --- datacite-cookbook/metadata.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index 058ee3c..5dc3461 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -30,8 +30,8 @@ instrument can be best represented in the DataCite Schema: URL along with the metadata when creating the DOI. `Name` - The name by which this instrument is known. Add as DataCite property - `Title `_. The DataCite schema allows for multiple kinds of titles that are + The name by which this instrument is known. Add as `DataCite property + Title`_. The DataCite schema allows for multiple kinds of titles that are distinguished by the `titleType` subproperty. A title without a specified type is assumed to be the main title. @@ -41,13 +41,13 @@ instrument can be best represented in the DataCite Schema: `Owner` The organization or individual that manages the instrument. Add as - DataCite property `Contributor` with `contributorType=HostingInstitution`. + `DataCite property Contributor`_ with `contributorType=HostingInstitution`. An identifier, typically a `ROR`_, can be used to unambiguously identify the owner in the `nameIdentifier` - subproperty of `Contributor `_. + subproperty of `Contributor`. `Manufacturer` The organization or individual that built the instrument. Add as - DataCite property `Creator`. Consider also to add an identifier, typically a `ROR`_, for the manufacturer in the `nameIdentifier` subproperty of `Creator `_. + `DataCite property Creator`_. Consider also to add an identifier, typically a `ROR`_, for the manufacturer in the `nameIdentifier` subproperty of `Creator`. `Model` The name of the model or type of the instrument. As of this @@ -168,7 +168,7 @@ considered as well, if it makes sense for a particular use case. and is responsible for maintaining the DOI metadata. In Version 4.5 of the schema several sub-properties were added - to `publisher `_: + to `DataCite property Publisher`_: * `publisherIdentifier`: Identifier for publisher. Use a ROR ID if available. * `publisherIdentifierScheme`: Scheme for publisher identifier (e.g. `ROR`). @@ -192,7 +192,7 @@ considered as well, if it makes sense for a particular use case. `FundingReference` This optional element can be used to acknowledge external funding that supported the purchase or the - creation of the instrument. See `FundingReference `_ for details. + creation of the instrument. See `DataCite property FundingReference`_ for details. .. _ROR: https://ror.org/ From 80f4b9b825b4289573888cd3f1f61398477bd9d2 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 16:45:46 +0100 Subject: [PATCH 10/13] Add links to DataCite properties Identifier, Date and AlternateIdentifier --- datacite-cookbook/metadata.rst | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index 5dc3461..1507f1f 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -21,8 +21,8 @@ following additional hints and discuss how the metadata describing the instrument can be best represented in the DataCite Schema: `Identifier` - The DOI that you are going to create. Add as DataCite property - `Identifier` with `identifierType=DOI`. + The DOI that you are going to create. Add as `DataCite property + Identifier`_ with `identifierType=DOI`. `LandingPage` The URL of the landing page that the PID resolves to. The DataCite @@ -87,7 +87,7 @@ instrument can be best represented in the DataCite Schema: `Date` Relevant events pertaining to this instrument instance. Add as - DataCite property `Date`. Use `dateType=Available` to indicate the + `DataCite property Date`_. Use `dateType=Available` to indicate the date that the instrument is or was in operation. Use a single date if the instrument is still in operation, to indicate a start date. Use a date interval to indicate a start and an end date, if the @@ -121,7 +121,7 @@ instrument can be best represented in the DataCite Schema: `AlternateIdentifier` To be used if this instrument is also registered elsewhere. Add as - DataCite property `AlternateIdentifier`. Use + `DataCite property AlternateIdentifier`_. Use `alternateIdentifierType=SerialNumber` for a serial number attributed by the manufacturer. Use `alternateIdentifierType=InventoryNumber` for an inventory number @@ -198,6 +198,9 @@ considered as well, if it makes sense for a particular use case. .. _DataCite Metadata Schema: https://datacite-metadata-schema.readthedocs.io/en/4.5/introduction/ +.. _DataCite property Identifier: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/identifier/ + .. _DataCite property Creator: https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/creator/ @@ -210,6 +213,12 @@ considered as well, if it makes sense for a particular use case. .. _DataCite property Contributor: https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/contributor/ +.. _DataCite property Date: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/date/ + +.. _DataCite property AlternateIdentifier: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/alternateidentifier/ + .. _DataCite property FundingReference: https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/fundingreference/ From 1836045d50c1bf8bef6596e686d69acd7422748b Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 16:56:52 +0100 Subject: [PATCH 11/13] Remove a spurious paragraph break --- datacite-cookbook/metadata.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index 1507f1f..1be247c 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -100,7 +100,6 @@ instrument can be best represented in the DataCite Schema: The type of the relation is described using the relationType property. The DataCite schema has a list of valid `relation types `_. - Several relation types can be used to connect to more detailed instrument metadata: * `IsDescribedBy `_ From 2f13d0dc66e5dd8c39175e4ffb8d4316b2e44bd1 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 17:02:52 +0100 Subject: [PATCH 12/13] Line wrapping and white space --- datacite-cookbook/metadata.rst | 89 +++++++++++++++++++--------------- 1 file changed, 51 insertions(+), 38 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index 1be247c..69c2c9a 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -41,13 +41,16 @@ instrument can be best represented in the DataCite Schema: `Owner` The organization or individual that manages the instrument. Add as - `DataCite property Contributor`_ with `contributorType=HostingInstitution`. - An identifier, typically a `ROR`_, can be used to unambiguously identify the owner in the `nameIdentifier` - subproperty of `Contributor`. + `DataCite property Contributor`_ with + `contributorType=HostingInstitution`. An identifier, typically a + `ROR`_, can be used to unambiguously identify the owner in the + `nameIdentifier` subproperty of `Contributor`. `Manufacturer` The organization or individual that built the instrument. Add as - `DataCite property Creator`_. Consider also to add an identifier, typically a `ROR`_, for the manufacturer in the `nameIdentifier` subproperty of `Creator`. + `DataCite property Creator`_. Consider also to add an identifier, + typically a `ROR`_, for the manufacturer in the `nameIdentifier` + subproperty of `Creator`. `Model` The name of the model or type of the instrument. As of this @@ -94,28 +97,35 @@ instrument can be best represented in the DataCite Schema: instrument has already been decommissioned. `RelatedIdentifier` - This can be used to establish links to related resources with identifiers. - The DataCite Schema has a property with the same name, having very - similar subproperties and semantics as the PIDINST Schema. - - The type of the relation is described using the relationType property. The DataCite schema has - a list of valid `relation types `_. - Several relation types can be used to connect to more detailed instrument metadata: - - * `IsDescribedBy `_ - can be used to link to a more detailed description of the instrument. + This can be used to establish links to related resources with + identifiers. The DataCite Schema has a property with the same name, + having very similar subproperties and semantics as the PIDINST + Schema. + + The type of the relation is described using the relationType + property. The DataCite schema has a list of valid `relation types + `_. Several relation types can + be used to connect to more detailed instrument metadata: + + * `IsDescribedBy `_ can be used + to link to a more detailed description of the instrument. * `HasMetadata `_ can be used to - link to metadata records that describe the instrument in more detail. - * `HasVersion `_, - `IsVersionOf `_, - `IsNewVersionOf `_, - and `IsPreviousVersionOf `_ can be used to link to - other versions of the instrument. - * `HasPart `_ - and `IsPartOf `_ can be used to define parts of instruments or instruments with parts. - * `Collects `_ (added in Version 4.5 of the schema) can be used for describing the relation between an instrument and a dataset, i.e. instrument A collects dataset B - * `IsCollectedBy `_ (also added in Version 4.5 of the schema) can be used for the complimentary relationship - (dataset B is collected by instrument A). + link to metadata records that describe the instrument in more + detail. + * `HasVersion `_, `IsVersionOf + `_, `IsNewVersionOf `_, and `IsPreviousVersionOf `_ can be used to link to other + versions of the instrument. + * `HasPart `_ and `IsPartOf `_ can be used to define parts of instruments + or instruments with parts. + * `Collects `_ (added in Version 4.5 + of the schema) can be used for describing the relation between an + instrument and a dataset, i.e. instrument A collects dataset B. + * `IsCollectedBy `_ (also added + in Version 4.5 of the schema) can be used for the complimentary + relationship (dataset B is collected by instrument A). `AlternateIdentifier` @@ -169,9 +179,12 @@ considered as well, if it makes sense for a particular use case. In Version 4.5 of the schema several sub-properties were added to `DataCite property Publisher`_: - * `publisherIdentifier`: Identifier for publisher. Use a ROR ID if available. - * `publisherIdentifierScheme`: Scheme for publisher identifier (e.g. `ROR`). - * `schemeURI`: The URI of the identifier scheme (e.g. `https://ror.org`). + * `publisherIdentifier`: Identifier for publisher. Use a ROR ID if + available. + * `publisherIdentifierScheme`: Scheme for publisher identifier + (e.g. `ROR`). + * `schemeURI`: The URI of the identifier scheme + (e.g. `https://ror.org`). `PublicationYear` Mandatory in the DataCite Schema. We suggest to set it to the year @@ -179,19 +192,19 @@ considered as well, if it makes sense for a particular use case. `ResourceTypeGeneral` and `ResourceType` DataCite DOIs are for many different types of objects, so there is a - need to indicate the type. `resourceTypeGeneral` is a - mandatory element in the DataCite - Schema selected from a - `shared vocabulary `_. - Set `resourceTypeGeneral=Instrument` for DataCite instrument - metadata records. + need to indicate the type. `resourceTypeGeneral` is a mandatory + element in the DataCite Schema selected from a `shared vocabulary + `_. Set + `resourceTypeGeneral=Instrument` for DataCite instrument metadata + records. - `ResourceType` is a free text field that can be used to provide a more - specific resource type. + `ResourceType` is a free text field that can be used to provide a + more specific resource type. `FundingReference` - This optional element can be used to acknowledge external funding that supported the purchase or the - creation of the instrument. See `DataCite property FundingReference`_ for details. + This optional element can be used to acknowledge external funding + that supported the purchase or the creation of the instrument. See + `DataCite property FundingReference`_ for details. .. _ROR: https://ror.org/ From a7aad7ad8f703ce863ddfa46ea9f7f9eb78026f0 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 30 Oct 2024 18:38:29 +0100 Subject: [PATCH 13/13] Reformulate the explanation for DataCite property ResourceType --- datacite-cookbook/metadata.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/datacite-cookbook/metadata.rst b/datacite-cookbook/metadata.rst index 69c2c9a..22f4cbf 100644 --- a/datacite-cookbook/metadata.rst +++ b/datacite-cookbook/metadata.rst @@ -190,16 +190,17 @@ considered as well, if it makes sense for a particular use case. Mandatory in the DataCite Schema. We suggest to set it to the year of issuing the DOI. -`ResourceTypeGeneral` and `ResourceType` +`ResourceType` DataCite DOIs are for many different types of objects, so there is a - need to indicate the type. `resourceTypeGeneral` is a mandatory - element in the DataCite Schema selected from a `shared vocabulary - `_. Set + need to indicate the type. Therefore, the `DataCite property + ResourceType`_ is mandatory. The subproperty `resourceTypeGeneral` + is needs to be selected from a `controlled vocabulary `_. Set `resourceTypeGeneral=Instrument` for DataCite instrument metadata records. - `ResourceType` is a free text field that can be used to provide a - more specific resource type. + `ResourceType` itself is a free text field that can be used to + provide a more specific resource type. `FundingReference` This optional element can be used to acknowledge external funding @@ -228,6 +229,9 @@ considered as well, if it makes sense for a particular use case. .. _DataCite property Date: https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/date/ +.. _DataCite property ResourceType: + https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/resourcetype/ + .. _DataCite property AlternateIdentifier: https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/alternateidentifier/