XWIKI-22484: The alternative for the home link on the logo does not mean anything #3510
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ean anything * Updated the companylogo template to add a proper text alternative * Added translations for those text alternatives
Sereza7
added
backport stable-15.10.x
michitux
reviewed
Oct 11, 2024
| @@ -46,7 +46,8 @@ | |||
| #end | |||
| #end | |||
| <div id="companylogo"> | |||
| <a href="$!xwiki.getURL($services.wiki.currentWikiDescriptor.mainPageReference)" title="Home" rel="home" #if(!$displayPageHeader)class="navbar-brand"#end> | |||
| <img src="$!logourl" alt="Wiki Logo"/> | |||
| <a href="$!xwiki.getURL($services.wiki.currentWikiDescriptor.mainPageReference)" rel="home" #if(!$displayPageHeader)class="navbar-brand"#end> | |||
There was a problem hiding this comment.
I don't think that removing the title from the link is good as it means that users won't get any hint anymore that the link points to the home page of the wiki when they're hovering the logo. I understand that the title attribute might not be enough for screen readers, but I think it would still be good to keep the title attribute, but maybe with the new translated text.
There was a problem hiding this comment.
My bad, I didn't realize this title was important for usability.
I added it back in a7411b8 👍
For AT, the title on a link might only get used if there's no other text alternative, so having it is not an issue.
| @@ -752,6 +752,9 @@ core.footer.modification=Last modified by {0} on {1} | |||
| ## This label is only visible by AT users to help with understanding the meaning of the top section containing | |||
| ## the page title and the info about the last modification of the page. | |||
| core.document.header.info.label=Page header | |||
| ## These two text alternatives are only visible by AT users. | |||
| core.document.header.companylogo.anchor.text=Wiki home | |||
| core.document.header.companylogo.logo.text=Logo of the wiki | |||
There was a problem hiding this comment.
I'm wondering some things:
- Should we really use the name
companylogo? I see that it is the ID of the container, but in my opinion it isn't really fitting as the wiki doesn't necessarily belong to a company. What about a shorter "logo" and then "image" instead of the "logo" for the second key? - Should we really name the text "Wiki home", why don't we keep the shorter "Home" that was the title previously? Asides from being shorter, there is also the aspect that from the perspective of the user, this website might not really be a wiki but some public, non-editable website.
- While the logo alternative text seems good enough, I wonder if we shouldn't offer an easy way to configure the alternative text next to the logo upload.
There was a problem hiding this comment.
- Yeah, company is definitely off,
orglogocould work too. Implemented your suggestion in 34c40f8 👍 - My reason was that in the context of a browser, the
Homeis something else more generic and it'd be better to have something a bit more precise than this. I forgot thatwikiis not always what the end user sees. Reverting this change to go with your suggestion in defdf3d 👍 - Created https://jira.xwiki.org/browse/XWIKI-22602 to track the progress on this idea 👍 For now, admins can still edit it with a translation, which is quite easy once they figure out the translation they need to edit :)
…ean anything * Added back the title
…ean anything * Updated the translation keys to avoid using `companyLogo`
…ean anything * Updated the translation value of the anchor alternative text
Sereza7
removed
the
backport stable-15.10.x
michitux
reviewed
Nov 4, 2024
Comment on lines
50
to
54
| title="$escapetool.xml($services.localization.render('core.document.header.companylogo.logo.text'))" ## | ||
| #if(!$displayPageHeader)class="navbar-brand"#end>## | ||
| <span class="sr-only">$services.localization.render('core.document.header.companylogo.anchor.text')</span> | ||
| <img src="$!logourl" ## | ||
| alt="$escapetool.xml($services.localization.render('core.document.header.companylogo.logo.text'))"/>## |
There was a problem hiding this comment.
These translation keys don't match those that are defined in the translation file below.
There was a problem hiding this comment.
Addressed in a5ca06b 👍
Thank you :)
…ean anything * Updated the use of translations
michitux
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Jira URL
https://jira.xwiki.org/browse/XWIKI-22484
Changes
Description
Screenshots & Video
After the changes proposed in this PR:
Executed Tests
None except manual tests (see screeshot above). Checked functional tests and it seems the selector for the element we modified is intact:
xwiki-platform/xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/BasePage.java
Lines 112 to 113 in 0ddc451
Expected merging strategy