Page MenuHomePhabricator
Create Task
Maniphest T317090

Minor improvements to Pywikibot documentation's landing page
Closed, ResolvedPublic
Actions

Description

During my review of the landing page (T304756) I identified a few small improvements we could make:

Accessibility:

  • Alt text fields for images displayed on the page do not contain useful information. If we consider these images as purely decorative, then they should not contain alt text at all. If we consider them informative, they should contain the description of what the image is showing, not attribution info or file name. The four images spelling out "Bots" in the middle of the screen are particularly unhelpful here. See https://knowbility.org/blog/2019/an-alt-text-primer/ for more information.
  • The search form does not have an associated label. We should add a title, label, or the aria-labelledby attribute.

Introductory text:

  • The introductory text does not appear in search results - what we get instead is a part of the translation box followed by contents of the first box (Running a bot). Is it possible for us to feature specific text in search results?

Related Objects
Search...

Event Timeline

KBach created this task.Sep 6 2022, 9:56 AM
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald TranscriptSep 6 2022, 9:56 AM
KBach mentioned this in T304756: Review Pywikibot landing page.Sep 6 2022, 9:59 AM
KBach updated the task description. (Show Details)Sep 6 2022, 11:00 AM
KBach claimed this task.Nov 15 2022, 10:45 AM
KBach added a parent task: T322215: Improvements to Manual:Pywikibot, content structure, and navigation on mw.org.
KBach changed the task status from Open to In Progress.Nov 15 2022, 10:52 AM
KBach added a subscriber: Xqt.EditedNov 15 2022, 1:02 PM

I applied some of the accessibility changes on the landing page - https://www.mediawiki.org/w/index.php?title=Manual:Pywikibot&diff=prev&oldid=5591787&diffmode=source. The search now has an arialabel attribute, and all decorative images have alt text set to null (as per https://www.w3.org/WAI/tutorials/images/decision-tree/). However, this removed some image credits (alt text is not a good place for that anyway).

If we want to credit image authors, perhaps we could create a dedicated section, like in my sandbox https://www.mediawiki.org/wiki/User:KBach-WMF/Sandbox/PywikibotLandingPage:

<translate>
== Image credits ==
* Sanko Seisakusyo (三幸製作所) – Tin Wind Up – Tiny Sparkling Robo – Front.jpg
* Swedish script images by Robosk, Roberto94, Honsvu
* Wikimedia Hackathon 2013, Amsterdam - Flickr - Sebastiaan ter Burg (22).jpg
</translate>

FYI @Xqt

KBach updated the task description. (Show Details)Nov 15 2022, 1:02 PM
KBach updated the task description. (Show Details)
KBach closed this task as Resolved.Nov 16 2022, 1:03 PM

I replaced the opening layout table (which contained the opening text, search box, and the logo) with flexbox. This makes the opening text available in search results and makes the page more accessible. Closing task as resolved.

KBach triaged this task as Medium priority.Nov 16 2022, 1:04 PM
KBach added a project: Developer-Advocacy (Oct-Dec 2022).
KBach updated the task description. (Show Details)
KBach moved this task from To-Do to Done on the Developer-Advocacy (Oct-Dec 2022) board.
Xqt added a comment.Nov 17 2022, 8:55 AM

If we want to credit image authors, perhaps we could create a dedicated section, like in my sandbox https://www.mediawiki.org/wiki/User:KBach-WMF/Sandbox/PywikibotLandingPage:

I don't see that this is necessary and it is unusual on wmf pages I think.

bd808 subscribed.Nov 17 2022, 4:54 PM
In T317090#8401484, @Xqt wrote:

If we want to credit image authors, perhaps we could create a dedicated section, like in my sandbox https://www.mediawiki.org/wiki/User:KBach-WMF/Sandbox/PywikibotLandingPage:

I don't see that this is necessary and it is unusual on wmf pages I think.

This sort of attribution is definitely encouraged for off-wiki usage and usage where linking to the File page on commons is not possible. I would agree that on-wiki we broadly assume that images will link back to their File page which gives all of the attribution and license information. I see that |link= is used quite a bit on mw:Manual:Pywikibot which does feel like a potential attribution issue for images like https://www.mediawiki.org/wiki/File:Wikimedia_Hackathon_2013,_Amsterdam_-_Flickr_-_Sebastiaan_ter_Burg_(22).jpg which are CC-BY licensed rather than PD licensed.

KBach added a subscriber: JJMC89.Nov 22 2022, 12:45 PM
In T317090#8403137, @bd808 wrote:
In T317090#8401484, @Xqt wrote:

If we want to credit image authors, perhaps we could create a dedicated section, like in my sandbox https://www.mediawiki.org/wiki/User:KBach-WMF/Sandbox/PywikibotLandingPage:

I don't see that this is necessary and it is unusual on wmf pages I think.

This sort of attribution is definitely encouraged for off-wiki usage and usage where linking to the File page on commons is not possible. I would agree that on-wiki we broadly assume that images will link back to their File page which gives all of the attribution and license information. I see that |link= is used quite a bit on mw:Manual:Pywikibot which does feel like a potential attribution issue for images like https://www.mediawiki.org/wiki/File:Wikimedia_Hackathon_2013,_Amsterdam_-_Flickr_-_Sebastiaan_ter_Burg_(22).jpg which are CC-BY licensed rather than PD licensed.

Good point, I see @JJMC89 has already added the links required for attribution. I added short alt text to these for accessibility (image links shouldn't have empty alt text).

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits