Browse Source

datacite.yml: New template

Achilleas Koutsou 4 years ago
parent
commit
cf17b3f07d
1 changed files with 35 additions and 18 deletions
  1. 35 18
      datacite.yml

+ 35 - 18
datacite.yml

@@ -1,58 +1,75 @@
-# Required fields
-# The main researchers involved working on the resource,
-# or the authors of the publication in priority order.
-# May be a corporate/institutional or personal name.
-# Include digital identifier (e.g., ORCID) if possible
+# Metadata for DOI registration according to DataCite Metadata Schema 4.1.
+# For detailed schema description see https://doi.org/10.5438/0014
+
+## Required fields
+
+# The main researchers involved. Include digital identifier (e.g., ORCID)
+# if possible, including the prefix to indicate its type.
 authors:
   -
     firstname: "GivenName1"
     lastname: "FamilyName1"
     affiliation: "Affiliation1"
-    id: "AuthorID1 (e.g. ORCID)"
+    id: "ORCID:0000-0001-2345-6789"
   -
     firstname: "GivenName2"
     lastname: "FamilyName2"
     affiliation: "Affiliation2"
+    id: "ResearcherID:X-1234-5678"
   -
     firstname: "GivenName3"
     lastname: "FamilyName3"
 
-# A name or title to describe the published resource.
+# A title to describe the published resource.
 title: "Example Title"
 
-# Any additional information. It is best practice to supply a description for the resource.
+# Additional information about the resource, e.g., a brief abstract.
 description: |
   Example description
   that can contain linebreaks
   but has to maintain indentation.
 
-# List of keywords the resource should be associated with.
+# Lit of keywords the resource should be associated with.
+# Give as many keywords as possible, to make the resource findable.
 keywords:
   - Neuroscience
   - Electrophysiology
 
-# Any rights information for this resource. Please provide both a license name and a link to the license.
-# Please add also a LICENSE file to the repository
+# License information for this resource. Please provide the license name and/or a link to the license.
+# Please add also a corresponding LICENSE file to the repository.
 license:
   name: "Creative Commons CC0 1.0 Public Domain Dedication"
   url: "https://creativecommons.org/publicdomain/zero/1.0/"
 
+
+
 ## Optional Fields
 
-# Any funding reference for this resource. Separate funder name and grant number by comma
+# Funding information for this resource.
+# Separate funder name and grant number by comma.
 funding:
   - "DFG, DFG.12345"
   - "EU, EU.12345"
 
-# Related publications. reftype might be: IsCitedBy, IsSupplementTo, IsReferencedBy, IsPartOf
-# for further valid types see https://schema.datacite.org/meta/kernel-4
+
+# Related publications. reftype might be: IsSupplementTo, IsDescribedBy, IsReferencedBy.
 # Please provide digital identifier (e.g., DOI) if possible.
+# Add a prefix to the ID, separated by a colon, to indicate the source.
+# Supported sources are: DOI, arXiv, PMID
 references:
   -
-    doi: "10.xxx/zzzz"
+    id: "doi:10.xxx/zzzz"
+    reftype: "IsSupplementTo"
+    name: "PublicationName1"
+  -
+    id: "arxiv:mmmm.nnnn"
     reftype: "IsSupplementTo"
-    name: "PublicationName"
+    name: "PublicationName2"
   -
-    reftype: "IsPartOf"
-    name: "PublicationName"
+    id: "pmid:nnnnnnnn"
+    reftype: "IsReferencedBy"
+    name: "PublicationName3"
+
 
+# Resource type. Default is Dataset, other possible values are Software, DataPaper, Image, Text.
+resourcetype: Dataset