@@ -5,6 +5,7 @@ Templates:
55- ` dataset_description.json `
66- ` README[.md|.rst|.txt] `
77- ` CITATION.cff `
8+ - ` datacite.yml `
89- ` CHANGES `
910- ` LICENSE[.md|.rst|.txt] `
1011
@@ -31,8 +32,8 @@ and a guide for using macros can be found at
3132 "HEDVersion": "RECOMMENDED",
3233 "DatasetLinks": "REQUIRED if [ BIDS URIs] [ ] are used",
3334 "DatasetType": "RECOMMENDED",
34- "License": "RECOMMENDED",
35- "Authors": "RECOMMENDED if CITATION.cff is not present",
35+ "License": "RECOMMENDED if CITATION.cff and datacite.yml are not present ",
36+ "Authors": "RECOMMENDED if CITATION.cff and datacite.yml are not present",
3637 "Keywords": "OPTIONAL",
3738 "Acknowledgements": "OPTIONAL",
3839 "HowToAcknowledge": "OPTIONAL",
@@ -172,26 +173,47 @@ A guide for using macros can be found at
172173-->
173174{{ MACROS__ _ render_text("objects.files.README.description") }}
174175
175- ## ` CITATION.cff `
176+ ## Structured citation files
177+
178+ BIDS permits structured citation files that may improve interoperability with
179+ dataset indexing utilities or afford higher precision than fields in
180+ ` dataset_description.json ` .
181+
182+ If these files are used, fields that provide information that is redundant with
183+ ` dataset_description.json ` fields SHOULD be preferred to those in ` dataset_description.json ` .
184+
185+ To avoid inconsistency, metadata present in one of the following files SHOULD NOT be
186+ be included in ` dataset_description.json ` , with the exception of ` Name ` and
187+ ` DatasetDOI ` , to ensure that tools that are only aware of ` dataset_description.json `
188+ can generate references to the dataset.
189+
190+ In particular, if a structured citation file is present,
191+ the ` "Authors" ` field of ` dataset_description.json ` MUST be omitted.
192+
193+ ### ` CITATION.cff `
176194
177195<!-- This block generates a file tree.
178196A guide for using macros can be found at
179197 https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
180198-->
181199{{ MACROS__ _ render_text("objects.files.CITATION.description") }}
182200
183- For most redundant fields between ` CITATION.cff ` and ` dataset_description.json ` ,
184- the ` CITATION.cff ` SHOULD take precedence.
185- To avoid inconsistency, metadata present in ` CITATION.cff ` SHOULD NOT be
186- be included in ` dataset_description.json ` , with the exception of ` Name ` and
187- ` DatasetDOI ` , to ensure that ` CITATION.cff ` -unaware tools can generate
188- references to the dataset.
189- In particular, if ` CITATION.cff ` is present,
190- the ` "Authors" ` field of ` dataset_description.json ` MUST be omitted,
191- and the ` "HowToAcknowledge" ` , ` "License" ` and ` "ReferencesAndLinks" ` SHOULD be omitted
201+ If ` CITATION.cff ` is present,
202+ the ` "HowToAcknowledge" ` , ` "License" ` and ` "ReferencesAndLinks" ` SHOULD be omitted
192203in favor of the ` CITATION.cff ` fields ` message ` /` preferred-citation ` , ` license ` and
193204` references ` .
194205
206+ ### ` datacite.yml `
207+
208+ <!-- This block generates a file tree.
209+ A guide for using macros can be found at
210+ https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
211+ -->
212+ {{ MACROS__ _ render_text("objects.files.datacite.description") }}
213+
214+ If ` datacite.yml ` is present, the ` "License" ` SHOULD be omitted
215+ in favor of the ` datacite.yml ` field ` rightsList ` .
216+
195217## ` CHANGES `
196218
197219<!-- This block generates a description.
0 commit comments