IQSS / dataverse

Open source research data repository software
http://dataverse.org
Other
882 stars 493 forks source link

Metadata Blocks: Change from "showabovefold" to "displayoncreate" #3073

Closed posixeleni closed 8 years ago

posixeleni commented 8 years ago

This change would not require any code change or solr reindexing so I recommend that once I check this in it can be pulled into the dev branch for 4.4 release.

This needs to be changed because it is causing confusion with dataverse installation users since it actually is a boolean to tag any metadata fields you want to show when you create a dataset and not show above the fold.

bencomp commented 8 years ago

@tdilauro suggested displayDuringCreate instead of displayOnCreate. Are you sure that it doesn't need any code changes? How does Dataverse decide which fields to show during creation of a dataset?

posixeleni commented 8 years ago

@bencomp I will be modifying this ticket to use @tdilauro suggestion.

Apologies for the confusion:

I am sure that the script that reads the tsv's does not actually look at the names in that row. Those are solely there for humans to see. @scolapasta can provide further technical details if this is not sufficient.

tdilauro commented 8 years ago

Thanks for the reminder, @bencomp. And thanks for the update, @posixeleni.

Rationale from my comment in the metadata block document: I would suggest renaming this variable to "displayDuringCreate", rather than "displayOnCreate". The "On" in the latter is too much like "Upon", which might be interpreted as "OnceCreateIsCompleted".

pdurbin commented 8 years ago

The field on the table is currently called "displayoncreate" which you can see at http://phoenix.dataverse.org/schemaspy/latest/tables/datasetfieldtype.html

Here's the Java side, which has a decent comment on what the field is for: https://github.com/IQSS/dataverse/blob/v4.3/src/main/java/edu/harvard/iq/dataverse/DatasetFieldType.java#L243

(Mental note that we should work on Publish Javadoc as HTML #2513 at some point.)

Anyway, I think it would be preferable to keep it as "displayoncreate" rather than "displayduringcreate" in the database table since they're almost the same. A change here would require a database upgrade script. It would probably be nice if the TSV file had the same label as what appears in the database.

tdilauro commented 8 years ago

@pdurbin Okay. I don't feel that strongly about it. But let's finish up this document and make it available so that there can be some prose explanation to clarify its function.

posixeleni commented 8 years ago

Sent the pull request so @scolapasta should be able to merge this.

kcondon commented 8 years ago

Works, closing