Problem/Motivation
This is spun off from #2862458: [META] Once media is enabled, having the File, Image and Media reference fields all listed is confusing.
When creating a new field, the site builder is presented with a select list of field types. This select list has been described as "the most problematic select list in all of core" because it's quite opaque. It's not very clear what each field type is for, or what the differences are.
This is a big problem space, but the overall discussion and debate is taking place in the meta issue. One concrete step that has been agreed upon, though, is to expose the field type descriptions to users when they are creating a new field.
Proposed resolution
Field UI should show the field type description below the field type selection box whilst creating a new field.
Remaining tasks
Port the patch from #2862458-91: [META] Once media is enabled, having the File, Image and Media reference fields all listed is confusing, but without any of the verbiage changes. Review and commit that patch.
User interface changes
Field type descriptions will be displayed below the select list when creating a new field.
API changes
None.
Data model changes
None.
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | interdiff-2862458-2934860.txt | 2.85 KB | benjifisher |
| #7 | 2934860-6.patch | 7.24 KB | benjifisher |
Comments
Comment #2
phenaproximaComment #3
phenaproximaMinor fix in the IS.
Comment #4
marcoscanoIf this is a standalone patch decoupled from the Media improvements, then maybe we should mark #2930446: [PP-1] Improve field description texts for fields provided by core as duplicate, and improve all descriptions at once here?
Comment #5
benjifisherI will adapt @marcoscano's patch. I am working with @phenaproxima and others at the Boston Media sprint.
Comment #6
benjifisherI removed the parts of the patch that change the description text, leaving in the parts that display the text in the UI.
I removed the part of the test that checks for the description on a Media field. I left in the parts that test for the description of File and Image fields. These were already independent of the actual text.
Comment #7
benjifisherIt turns out that thinking really hard about uploading the patch is not actually good enough. Who knew?
Comment #8
phenaproximaThanks, @benjifisher! Preemptively RTBC once Drupal CI approves.
Comment #9
berdirSimilar to #4, I'm still not convinced to show the current, sometimes *very* technical and likely confusing descriptions to end users. It's a bit harder to test them in advance (can be done by applying both patches together for example) , but would IMHO make sense to get the improved descriptions in first or at the same time.
Comment #10
xjmYeah I had a similar thought to #9; we don't want to inadvertently create a UX regression for other fields in trying to improve the UX for these. In general, the less text on the screen, the better, so we should make sure this issue doesn't add new text for other fields where it's not needed.
What someone could do is look around core for existing field descriptions that will now be exposed. We can:
Then we can decide what to do for this based on that information.
Comment #11
xjm@phenaproxima said this info is in #2930446: [PP-1] Improve field description texts for fields provided by core.
Comment #12
amateescu commentedI agree with #9, getting this patch in without improving the descriptions is most likely a UX loss instead of a win.
Also, for committers, all the people who worked on this patch in #2862458: [META] Once media is enabled, having the File, Image and Media reference fields all listed is confusing should be given credit here.
Comment #13
xjmDiscussed more with @phenaproxima. We're going to start with adding some brief documentation to
media_help()about Media reference fields, how File and Image reference fields are used on them, and what you should use when. Then, we can link to that wherever we need in whatever descriptions we need, potentially display help text as a block rather than as a description, or whatever.So we'll start with the documentation first, and then decide whether this or another implementation is the correct way to fix it.
Thanks!
Comment #14
benjifisherThe documentation issue is #2934885: Document the difference between File, Image, and Media fields.
Comment #15
xjmAnother option is that we could initially display the descriptions only for media, file, and image fields, and only display the other descriptions once they're improved.
Comment #27
dieterholvoet commentedThis has been fixed in #3356894: Make field selection less overwhelming by introducing groups, right?
Comment #28
martijn de witYes, this ticket seems outdated and already fixed in a certain way by #3346539: [Plan] Improve field creation experience / #3356894: Make field selection less overwhelming by introducing groups
Comment #29
xjmDuplicate is probably a better classification.
Saving credits for those who worked on this one.