IQSS
Feature Request/Idea: In Dataverse Guides, indicate which metadatablock properties are required and optional
Overview of the Feature Request
What kind of user is the feature intended for? (Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin) Curator, Sysadmin
What inspired the request? A TSV file for a new metadatablock being worked on was missing a property that was required. The property in this case was displayOrder, a property of every TSV file's datasetField section. The metadatablock can't be added to Dataverse installations without the displayOrder property being filled out.
As of v5.11, the guides don't indicate that the displayOrder for each field is required and doesn't indicate which other properties need to be filled and which are optional.
What existing behavior do you want changed? The Dataverse Guides indicate which parts of the TSV file need to be filled out and which are optional. Specifically, which parts of the three sections - metadataBlock, datasetField, and controlledVocabulary - are required or optional.
Any related open or closed issues to this feature request? https://github.com/IQSS/dataverse/issues/7844 https://github.com/IQSS/dataverse/issues/8127
The datasetField's description property isn't technically required but I think should be required or recommended since it's what appears when people click or hover over the tooltip icon that's next to the metadata fields. Not including a description means that the tooltip will be empty.
So maybe the guides should indicate which properties are technically required, which are recommended and which are optional.
https://github.com/IQSS/dataverse/issues/8127 is related because it includes the metadata text guidelines being introduced in the next Dataverse software version. And I'm realizing that it includes recommendations for what to include in the description property, but it might be helpful to include that some description should always be included (otherwise clicking on the tooltip icon shows no text).
The Metadata Customization page seems like a good place. Maybe adding a line in the "Allowed values and restrictions" column of each property. (Adding a fourth column might make the table less readable, considering how little horizontal space there is now.)
Thanks for opening this issue, @jggautier
I recently struggled to get a tsv loaded when it wasn't quite right.
Perhaps this goes without saying but if we're in there making tweaks to the metadata customization page, let's also include any tips that might help someone with the somewhat arduous process of creating and loading a metadata block. tsv.
