Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
posixeleni opened this issue Apr 13, 2016 · 7 comments
Closed

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

posixeleni opened this issue Apr 13, 2016 · 7 comments
Assignees
Milestone

Comments

@posixeleni
Copy link
Contributor

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
Copy link
Contributor

bencomp commented Apr 14, 2016

@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
Copy link
Contributor Author

@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.

@posixeleni posixeleni changed the title Metadata Blocks: Change from "showabovefold" to "displayOnCreate" Metadata Blocks: Change from "showabovefold" to "displayDuringCreate" Apr 14, 2016
@tdilauro
Copy link
Contributor

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
Copy link
Member

pdurbin commented Apr 14, 2016

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
Copy link
Contributor

@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 posixeleni changed the title Metadata Blocks: Change from "showabovefold" to "displayDuringCreate" Metadata Blocks: Change from "showabovefold" to "displayoncreate" Apr 14, 2016
posixeleni added a commit that referenced this issue Apr 15, 2016
Change from “showabovefold” to more accurate “displayoncreate” #3073
@posixeleni
Copy link
Contributor Author

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

@kcondon kcondon self-assigned this Apr 21, 2016
@kcondon
Copy link
Contributor

kcondon commented Apr 21, 2016

Works, closing

@kcondon kcondon closed this as completed Apr 21, 2016
scolapasta added a commit that referenced this issue Apr 27, 2016
@scolapasta scolapasta added this to the 4.3.1 milestone May 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants