Giters

sul-dlss / vt-arclight

An Arclight-based discovery application for materials from the Virtual Tribunals project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Explain what EAD means in the "Download EAD" section

marlo-longley opened this issue · comments

commented

This was raised in the stakeholder demo yesterday. Not sure what the design or conclusions should be, or if we should implement this at all. @laurensorensen @ggeisler

commented

I do not think it's necessary to do this before the release. I'm open to discussing how we do this and getting feedback from the AL community if @ggeisler seems like that's a good idea.. I kind of think this might be something that would be an Arclight core feature rather than custom? And we might want to ask at another round of user interviews?

commented

I don't think this has enough potential to confuse users that it deserves the awkward workaround it will likely require.

If a user doesn't know what "EAD" means, are they likely to be bothered by a button that is fairly out of the way and doesn't impact their normal use of the site? The button is intended for users who do know what "EAD" means and might want to download a copy. If there was as straightforward way to educate users who don't know what it means, sure, that would be nice, just to inform EAD-unaware users this is likely not something they care about. But an obvious solution that doesn't negatively affect the UI isn't clear to me.

Potentially we could add an info icon (the "i" icon we use for the More info button) and use that to display some explanation. But we also have to keep in mind that this is not a dedicated EAD download button. It currently is in VT, but the button is set up (unless something has changed) to handle multiple types of downloads (EAD, PDF of the finding aid, etc.) when they exist. In that case the button label is just "Download" with a dropdown affordance to show the download options. So the info icon doesn't work so well as a general solution. We'd have to make the button customized for VT.

I could work on this more if necessary, it just doesn't seem important enough to me, at least until we get some sort of feedback leading us to think it's something that will address a real issue.

commented

@laurensorensen @ggeisler seems like from the demo today, this is actually something we need to do. Thoughts?

commented

I'll post a suggested design soon.

I think we should just do it in VT, though, rather than core ArcLight. At least in VT we can assume EAD is the only download option so a solution doesn't need to account for a more generic button label, as when EAD is just one download option.

commented

Here's a suggested design. Add a new icon to the "Download EAD" button:

Screen Shot 2023-01-27 at 1 44 18 PM

On user selection/mouseover, display a tooltip with an explanation of EAD:

Screen Shot 2023-01-27 at 4 16 59 PM

This involves:

  • Add a question mark icon after the "Download EAD" button label. It should be sized and styled identically to the information icon used in the adjacent More info button.
  • Ensure there is 0.25rem horizontal margin between the button label and the new icon.
  • Attach a Bootstrap tooltip to the new icon. Use the "Tooltip on bottom" placement option. Use the default styling (white text on black background).
  • Use the text EAD is an abbreviation for “Encoded Archival Description,” an XML standard for encoding archival finding aids. The downloadable EAD file contains the entire IMT content inventory in XML format. for the tooltip text. (If anyone has ideas for a better definition, while not requiring much more space than this suggestion, feel free to edit.)

You could make the tooltip body somewhat wider than in my mockup, to reduce the vertical space it requires. But I think the max width shouldn't exceed the outer edges of the Download EAD and More info buttons above it.