Problem/Motivation
It would be good if the various dialogues were more consistent with one another.
Steps to reproduce
1. Go to simplytest.me
2. Create a site with Drupal core 11.x-dev, editoria11y 3.x-dev, and, if not yet merged, editoria11y patch https://git.drupalcode.org/project/editoria11y/-/merge_requests/49.patch
3. Go to /admin/config/content/editoria11y/demo
4. Hover over the first issue icon to activate the dialog for that issue
5. Continue through each issue and note the consistencies and inconsistencies between each one
Proposed resolution
I respectfully suggest the following edits to the dialogs for consistency, based on the demo. If you want me to break any of these, or even this entire comment, into a separate issue, please let me know and I will be happy to do so.
changed: Consider using the same formatting for "To fix" and "Tip." I like the bubble which you are using for "To fix" as it makes it easy for the eyes to jump to that point, although I am concerned that the font size might be smaller than the running text. If you keep "Tip:" as is, I suggest bolding it.
changed: #3 QA_BLOCKQUOTE: Between "Should this quote be a heading?" and "Blockquote formatting" show the quote.
#4 QA_FAKE_HEADING: Between "Should this bold text be a heading?" and "To fix" show the bold text.
#5 HEADING_LONG: Between "Can this heading be shorter?" and "To fix" show the heading text. I'll file a separate issue for changing the title to "Can this heading be shorter? Is it actually a heading?"
(not implemented; it's a really cool idea but the current tip design is already crowded) #6 through #20 IMAGE_*: Consider adding a thumbnail of the image after the title.
changed: #9 ALT_UNPRONOUNCEABLE: Show the alt text on a line by itself, preceded by the "Alt text" bubble to be consistent with #11 SUS_ALT.
changed: #10 ALT_FILE_EXT: Between "This alt text is a filename, not a description" and "Screen readers will dictate..." show the alt text, preceded by an "Alt text" bubble to be consistent with #11 SUS_ALT and #18 LINK_IMAGE_ALT_AND_TEXT.
changed: #11 SUS_ALT, #12 LINK_SUS_ALT: Show "To fix" in a bubble to be consistent with other dialogs. Move the alt text line immediately below the dialog title.
changed: #13 ALT_PLACEHOLDER, #14 LINK_PLACEHOLDER_ALT, #15 ALT_MAYBE_BAD, #16 LINK_ALT_MAYBE_BAD, #17 IMAGE_ALT_TOO_LONG: Show the alt text on a line by itself immediately below the dialog title, preceded by the "Alt text" bubble to be consistent with #11 and #18.
changed: #18 LINK_IMAGE_ALT_AND_TEXT: Show "To fix" in a bubble to be consistent with other dialogs. Move the alt text line immediately below the dialog title.
(not implemented due to upstream limitations) #19 IMAGE_FIGURE_DECORATIVE (?): Show the alt text on a line by itself, preceded by the "Alt text" bubble to be consistent with #11. [Note this tip does not yet print the alt]
changed: #21 EMBED_AUDIO, #27 through #33 (EMBED_*, some LINK): Is the tip label missing?
#35+ LINK_URL, LINK_UNPRONOUNCEABLE, LINK_DOI, LINK_NEW_TAB, QA_PDF, LINK_FILE_EXT, DUPLICATE_TITLE: Show the link text below the dialog title, preceded by a "Link text" bubble.
changed: #34 QA_PDF: "then dismiss this alert" Is this needed here? It's not shown on any of the other dialogs.
(not implemented) #36 LINK_IMAGE_NO_ALT_TEXT through #41 LINK_IMAGE_NO_ALT_TEXT (: Consider adding a thumbnail of the image after the title.
changed: #55 QA_IN_PAGE_LINK: Add the anchor name immediately below the title. Is the tip label missing?
Partially changed: #60 QA_UPPERCASE: Show the actual uppercase text below the title. Use sentence case for "LARGE BLOCKS OF UPPERCASE TEXT ARE MORE DIFFICULT TO READ, AND ARE OFTEN INTERPRETED AS SHOUTING."
changed: #61 QA_UNDERLINE: Show the actual underlined text below the title.
#62 QA_STRONG_ITALICS: Show the actual emphasized text below the title. Is the tip label missing?
Comments
Comment #2
itmaybejj commentedEdited issue description with tip keys for ease of discussion
Comment #3
itmaybejj commentedComment #4
itmaybejj commentedI likely won't get to this until after Beta 1, but I agree with a lot of these.
Comment #7
itmaybejj commentedComment #8
itmaybejj commentedUpdated issue description to reflect the accepted formatting changes.
I like some of your other suggestions too, but they require changes to the testing rules shared with Sa11y, so I'm going to set them aside for the moment and revisit after 3.x lands in Drupal and WP.
Comment #9
itmaybejj commentedAdam thought this was a great idea, so the excerpt strings are now available upstream. See also.
My next tag is just a bugfix; this will wait for the RC.
Comment #10
charles belov@itmaybejj Thank you!
By the way, "excerpt strings are now available upstream" is missing an href parameter, so I thought the page was broken. Please consider editing your comment.
Comment #11
itmaybejj commentedThe last batch of suggestions has been accepted and implemented, and will be included in RC1.
Thank you; this was very helpful and a good improvement.