[#17508] - a11y improvement: plugins Pagenavigation
- Fixed in Code Base
- 13 Aug 2017
- Medium
- Build: staging
- # 17508
- Diff
- zwiastunsw:j38_pagenavgation
- Pending hound Hound is busy reviewing changes... Details
User tests: Successful: Unsuccessful:
Summary of Changes
The Pagenavigation plugin displays links to the previous and next article. The text of the links are the words "Prev" and "Next". They do not contain any information about the content/topic of the articles. For display users, tooltips with article titles have been added. For Assistive Technology users - aria-label with information that the link gives access to previous/next article and article title.
Developed by Web Accessibility Team.
Testing Instructions
- Start the article list page in one category.
- Open the article from the list.
- Set the mouse pointer over the links (buttons) Prev and Next. Tooltips should be displayed.
- Run a screen reader, such as NVDA (or ChromoVox for Chrome). Move tabs between links. Check that the screen reader correctly announces the purpose of the links to previous and next article
Expected result
- Tooltips with linked article title are displayed above the Prev and Next buttons.
- The screen reader will announce links to the titles of the articles to which they lead.
Actual result
Currently, the user is not informed exactly about the purpose of the link. The content of the links "previous" and "next" is quite vague.
Documentation Changes Required
- No changes to the documentation required - no new functionality introduced.
- You need to add two new language constants do administrator/language/en-GB/en-GB.en-GB.plg_content_pagenavigation.ini file
PLG_PAGENAVIGATION_PREV_A11Y="Access to the previous article: %s"
PLG_PAGENAVIGATION_NEXT_A11Y="Access to the next article: %s"
joomla-cms-bot
- | Category | ⇒ | Front End Plugins |
| Status | New | ⇒ | Pending |
| Category | Front End Plugins | ⇒ | Administration Language & Strings Front End Plugins |
| Labels |
Added:
?
|
||
| Title |
|
||||||
- Do we really need to add "tooltip"?
- Please read the correct way to use sprintf https://docs.joomla.org/Formatted_fields_in_language_translation_strings
| Labels |
Added:
?
|
||
Thanks, Brian :)
- Tooltip is not necessary, but improves accessibility for regular users.
- Right, my mistake!
@brianteeman, can you add this PR to accessibility category?
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17508.
| Category | Front End Plugins Administration Language & Strings | ⇒ | Accessibility Administration Front End Language & Strings Plugins |
@zwiastunsw done
I have tested this item
I've tested this item successfully (on 3.7.4), it works as described and is a real improvement.
But I am not sure about the Tooltip.
It seems to me kind of b/c break - template designers do not expect the tooltips here and have to adapt their design?
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17508.
I have tested this item
Enable full php error reporting and view the source code you will see the following error
<br />
<b>Notice</b>: Undefined offset: -1 in <b>C:\Apache24\htdocs\cms\plugins\content\pagenavigation\tmpl\default.php</b> on line <b>26</b><br />
<br />
<b>Notice</b>: Trying to get property of non-object in <b>C:\Apache24\htdocs\cms\plugins\content\pagenavigation\tmpl\default.php</b> on line <b>26</b><br />
PLG_PAGENAVIGATION_NEXT_A11Y```<hr /><sub>This comment was created with the <a href="https://github.com/joomla/jissues">J!Tracker Application</a> at <a href="https://issues.joomla.org/tracker/joomla-cms/17508">issues.joomla.org/tracker/joomla-cms/17508</a>.</sub>
Note to replicate that error it must be on a page with ONLY a next link
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17508.
the language strings are in the wrong file. If you apply this PR and check it you will see that ;)
The language file you added the strings to is only loaded in the admin. You probably should put them into en-GB.ini in both the /site and /administrator language folders
Also it would be better if they were simply called something like JNEXT_TITLE and JPREVIOUS_TITLE
Finally for accessibility we should not include words such as link to, image to, access to as they are redundant words as many AT will add that text automatically. eg in this example they would announce "link to access to next article: article name"
It is enough to simply say "next article: article name"
So I would suggest the strings should be
JNEXT_TITLE="Next article: %s"
JPREVIOUS_TITLE="Previous article: %s"
Language files for plugins are always and only in the admin language folder?
@brianteeman Thank you for your correct suggestions!
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17508.
I have tested this item
retest after cs fixes
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17508.
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17508.
@franz-wohlkoenig Please set RTC after 2 succesfull tests.
| Status | Pending | ⇒ | Ready to Commit |
RTC after two successful tests.
| Category | Front End Plugins Administration Language & Strings Accessibility | ⇒ | Administration Language & Strings Front End com_content Plugins Accessibility |
| Labels |
Added:
?
|
||
| Category | Front End Plugins Administration Language & Strings Accessibility com_content | ⇒ | Administration Language & Strings Front End Plugins Accessibility |
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2017-08-13 15:39:47 |
| Closed_By | ⇒ | mbabker |