search

allen-cell-animated / timelapse-colorizer

A web-based, time-series visualizer for tracked segmented data.
Other
8 stars 1 forks source link

Glossary for feature descriptions #198

Open toloudis opened 7 months ago

toloudis commented 7 months ago

Use Case

A possible need/want for publication might be a tab or some space in the UI to display a .md file (or iframed web page?) that has a nice descriptive text about the dataset. This would help external users who are coming in cold.

This has come up in CFE as well.

Such a document could provide a glossary of what the feature names mean, among other things.

Acceptance Criteria

Determine if this is needed, prioritize, and design an initial layout.

Details

I suggest .md to keep it simple, just text and pictures and links. Who authors the document? How do they add it to a dataset? Where does it belong in the layout?

ShrimpCryptid commented 1 month ago
toloudis commented 1 month ago

minimum info: something like a tooltip with ~2 sentences for each feature (#371). -- this might satisfy the more immediate need as of writing this

ShrimpCryptid commented 1 month ago

Image

toloudis commented 1 month ago

Also, can there be images? see https://www.allencell.org/glossary-of-cell-features-v2.html

ShrimpCryptid commented 1 month ago

Adding a comment, this was also requested by educators during Teachstravaganza.

ShrimpCryptid commented 1 month ago

short description + long description field? (one for tooltip, one for glossary?)

toloudis commented 2 weeks ago
  1. links in tooltips are not accessible via keyboard
  2. tooltips should be brief but the scientists are concerned that you can not get full accuracy and it might be misleading. scientists asked that shortened descriptions are not as important as the full description.
  3. do we need both tooltips AND a full glossary panel?
  4. is a long tooltip really a tooltip? Is there a middle ground where it's a popup modal or something? At the point of access in the feature dropdown
toloudis commented 2 weeks ago

We will initially implement an expandable panel that is at a higher z index above the rest of the ui. There will be a button next to the feature dropdown that triggers the panel to open. Doesnt need to scroll to current feature.

what is the icon? "glossary"

Also noting here that there will not be tooltips for this implementation. Only the expandable panel.