Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show technique titles, not just technique numbers, for related techniques #3583

Closed
CharlesBelov opened this issue Dec 5, 2023 · 5 comments
Closed

Comments

@CharlesBelov
Copy link

CharlesBelov commented Dec 5, 2023

Technique PDF3:Ensuring correct tab and reading order in PDF documents has a section Related Techniques which provides links to related techniques. However, that section only gives the technique numbers without any context. It would be better to include the titles.

This appears to be an issue on related pages as well.

Current content:

Related Techniques
G57
G59
G202

Expected content:

G57: Ordering the content in a meaningful sequence
G59: Placing the interactive elements in an order that follows sequences and relationships within the content
G202: Ensuring keyboard control for all functionality

I seem to recall that techniques pages used to show the titles for related techniques, so this may be a regression.

@CharlesBelov CharlesBelov changed the title Show technique titles, not just technique numbers Show technique titles, not just technique numbers, for related techniques Dec 5, 2023
@KerstinProbiesch
Copy link
Contributor

Also in H69 (https://www.w3.org/WAI/WCAG22/Techniques/html/H69) are two related techniques where only the number is given.

@mbgower
Copy link
Contributor

mbgower commented Dec 6, 2023

I suspect this is done for readability. Some techniques have very long names, and the list could become somewhat impenetrable, instead of easy to scan, as it is right now. However, I'll leave someone more familiar with conventions to comment on the current use.

@CharlesBelov
Copy link
Author

CharlesBelov commented Dec 7, 2023

It may be readable, but it is unusable for me as just the number is meaningless. I wind up having to click each item to find out whether it is relevant to me. For cross-reference lists with more than three items, it becomes tedious.

If long titles are problematic, then improved spacing between items or introducing a short title field would help.

Actually, I believe just showing the technique number violates Success Criterion 2.4.4 Link Purpose (In Context), which is a level A criterion.

@alastc
Copy link
Contributor

alastc commented Dec 18, 2023

I had thought that the names were automatically added as part of the build process, but it appears not.
Maybe it's just done for the understanding page? Or perhaps it's all manual, it's hard to tell without a lot of digging.

In any case, it would be a general task for someone to run through the technique and understanding documents and fill in the full titles.

Actually, I believe just showing the technique number violates Success Criterion 2.4.4 Link Purpose (In Context), which is a level A criterion.

No, there's an exception for when a link is ambigious to all users, which is the case here. That doesn't make it good, but not a fail of that SC.

@kfranqueiro
Copy link
Contributor

This has been resolved by the new Eleventy build system, which is currently used for 2.2 docs, and will be used to rebuild 2.1 docs once #4007 is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants