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

Use bitstream description instead of file name in item view if present #2103

Closed
alanorth opened this issue Feb 16, 2023 · 5 comments
Closed
Labels
bug Difficulty: Low Estimated at less than 8 hours help wanted Needs a volunteer to claim to move forward low priority ux User Experience related works

Comments

@alanorth
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As of DSpace 7.5-SNAPSHOT the item view still uses the file name for bitstreams in the item view.

Describe the solution you'd like
In DSpace 4/5/6 the XMLUI would opportunistically use the bitstream description instead if it was present. This is very useful if you have messy file names and want to display something more pleasant. For example:

@alanorth alanorth added Difficulty: Low Estimated at less than 8 hours new feature low priority needs triage New issue needs triage and/or scheduling ux User Experience related works labels Feb 16, 2023
@bram-atmire
Copy link
Member

I would argue it's a bug instead of a new feature. If we are no longer leveraging/using bitstream descriptions in a case where we were in the past, it's a bug/regression and not a new feature.

Can confirm that I recently saw the exact same behaviour, where we tried to modify the displayed bitstream name by adding a description but where that didn't seem to have any effect.

@alanorth alanorth added bug and removed new feature labels Feb 16, 2023
alanorth added a commit to alanorth/dspace-angular that referenced this issue Feb 17, 2023
We should show the bitsream description instead of the file name if
it is present. This is how DSpace XMLUI has been showing bitstreams
already for many years.

Fixes: DSpace#2103
alanorth added a commit to alanorth/dspace-angular that referenced this issue Feb 17, 2023
We should show the bitstream description instead of the file name in
the simple item view if it is present. This is how DSpace XMLUI has
behaved at least for many years.

Fixes: DSpace#2103
alanorth added a commit to alanorth/dspace-angular that referenced this issue Feb 17, 2023
We should show the bitstream description instead of the file name in
the simple item view if it is present. This is how DSpace XMLUI has
behaved at least for many years.

Fixes: DSpace#2103
@alanorth
Copy link
Contributor Author

I just realized that the description is used on the full item page:

So this should be very easy to fix in the simple item view. I've submitted #2108 to fix this. Please take a look, as I'm new to Angluar. Thanks!

@tdonohue
Copy link
Member

tdonohue commented Mar 8, 2023

Moving this to the 7.6 board in case we can find a volunteer. As discussed in #2108 comments, I think the solution here needs to include both the description and the filename, as both were discoverable in 6.x. So, simply replacing the filename with the description doesn't seem like a full solution. See this comment for more details: #2108 (comment)

In any case, needs a volunteer

@tdonohue tdonohue added help wanted Needs a volunteer to claim to move forward and removed needs triage New issue needs triage and/or scheduling labels Mar 8, 2023
@alanorth
Copy link
Contributor Author

alanorth commented Jul 4, 2023

FYI I've implemented this as a themed file-section component. Here's how it looks:

The component opportunistically uses the bitstream description and appends the file extension (via a helper function in the component). If the bitstream doesn't have a description then the old behavior is used:

@alanorth
Copy link
Contributor Author

Closing as this seems to be a preference of some sites based on past XMLUI behavior, but has the drawback that the file name/type is not visible when hovering over the link. It is very easy to create a themed file-section component to add these changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Difficulty: Low Estimated at less than 8 hours help wanted Needs a volunteer to claim to move forward low priority ux User Experience related works
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants