RTC a11y Frontend Template PR-5.2-dev Pending

User tests: Successful: Unsuccessful:

avatar chmst
chmst
1 Jul 2024

Pull Request for Issue # .

Summary of Changes

The article info in articles is built as a definition list.
The definion term is the text for Details,
The definition description is a list of different items like author, publishing-date ad so on

If the user decides to hide the definition term then the dt-tag remains empty.
With this small PR the the details info is not empty but hides the text only for sighted users, screen readers still have the complete definition term.

This PR is of type "better than nothing"
because a more correct solution for the would be a definition list which writes for every element
<dt>Author</dt><dd>Mr. John Doe</dd>

Testing Instructions

Easiest test is any blog in joomla.
Just set some detail info in the corresponding menu item to "show"
Then show and hide the details
No change in frontend for sighted users, but check the source code.

Actual result BEFORE applying this Pull Request

If the Article Info Title is set on "hide". The dt is empty
grafik

Expected result AFTER applying this Pull Request

grafik

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

avatar chmst chmst - open - 1 Jul 2024
avatar chmst chmst - change - 1 Jul 2024
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 1 Jul 2024
Category Layout
avatar chmst chmst - change - 1 Jul 2024
Labels Added: a11y Frontend Template PR-5.1-dev
avatar chmst chmst - change - 1 Jul 2024
The description was changed
avatar chmst chmst - edited - 1 Jul 2024
avatar brianteeman
brianteeman - comment - 1 Jul 2024

because a more correct solution for the would be a definition list which writes for every element

Why not fix it this way

avatar chmst
chmst - comment - 1 Jul 2024

Can do. Do you think it is worth? It is not a big issue ... just somthing for accuracy fanatics like us

avatar brianteeman
brianteeman - comment - 1 Jul 2024

If a job is worth doing it is worth doing well.

Assuming of course that it is the correct thing to do and wcag seems to suggest that it is the correct way and even without hiding the "Details" it is wrong.

https://www.w3.org/WAI/tutorials/page-structure/content/#description-lists

avatar chmst
chmst - comment - 1 Jul 2024

I like this quote. So I make this a draft for now.

avatar brianteeman
brianteeman - comment - 1 Jul 2024

I like this quote. So I make this a draft for now.

its a very famous "english" quote. I am sure there will be a german equivalent

avatar chmst
chmst - comment - 5 Jul 2024

Reviewing the code for this details block I think it is better to leave as is and just add this PR.
What we have is not wrong, it is one definiton term with multiple descriptions and in in this context it is ok. I will not change other layouts.

avatar dautrich dautrich - test_item - 26 Jul 2024 - Tested successfully
avatar dautrich
dautrich - comment - 26 Jul 2024

I have tested this item ✅ successfully on e11afa7


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43729.

avatar fgsw fgsw - test_item - 29 Jul 2024 - Tested successfully
avatar fgsw
fgsw - comment - 29 Jul 2024

I have tested this item ✅ successfully on e11afa7


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43729.

avatar Quy Quy - change - 29 Jul 2024
Status Pending Ready to Commit
avatar Quy
Quy - comment - 29 Jul 2024

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43729.

avatar bembelimen bembelimen - change - 4 Aug 2024
Title
[5.1] Small fix for the dt- tag in content details list
[5.2] Small fix for the dt- tag in content details list
avatar bembelimen bembelimen - edited - 4 Aug 2024
avatar bembelimen bembelimen - change - 4 Aug 2024
Labels Added: RTC PR-5.2-dev
avatar bembelimen
bembelimen - comment - 4 Aug 2024

I've moved this to 5.2, I agree it's a bug fix, but what could happen is, that suddenly now with templates not supporting the CSS class, the label could appear, although it's disabled.

avatar pe7er pe7er - change - 8 Aug 2024
Labels Removed: PR-5.1-dev
avatar pe7er pe7er - change - 8 Aug 2024
Status Ready to Commit Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2024-08-08 21:47:25
Closed_By pe7er
avatar pe7er pe7er - close - 8 Aug 2024
avatar pe7er pe7er - merge - 8 Aug 2024
avatar pe7er
pe7er - comment - 9 Aug 2024

Thanks @chmst !

Add a Comment

Login with GitHub to post a comment