-
Notifications
You must be signed in to change notification settings - Fork 5
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
Remaining WCAG2ICT document format issues #147
Comments
One more thing...which I may discuss with the TF to see if we should do it: Incorporation of the SC Understanding document's Intent section into the WCAG2ICT content. This used to exist in the old 2013 version in collapse/expand sections that defaulted to collapsed. ** The TF decided including the Intent was important, so added as a task in the top list. ** |
@ChrisLoiselle I had noticed that the text size for all includes of WCAG original text within the blockquotes is a smaller size than all other text in the document. There would have to be a general CSS tweak for that. Additionally, the inserted notes from the original WCAG text are intentionally in gray so they are distinctly different from the WCAG2ICT notes. The one thing missing is the word "NOTE" on them which wasn't processed into the document yet. See the bullets I have to cover these issues:
|
@ChrisLoiselle In the changes Michael made in the scripting, some of the link anchors needed to change, so we need to fix references to them in a pull request:
So those references need to be updated in the file comments-by-guideline-and-success-criterion.md |
@maryjom I'll make these changes on Friday of this week to assist. |
Hi @maryjom and @ChrisLoiselle. Apologies for my tardiness - I've finally reviewed chapter 7 of the netlify version and have found a few issues. I suspect some may be due to the changes to definition labels in your comment above, but have included them all for ref. List of links from included content that don't work or go to wrong document:
List of links that are fixable in WCAG2ICT content directly (our internal document links):
I've moved down here the list of things that don't require any changes to be made.
|
We discussed this topic in the 27 April meeting and decided we want the Intent content included in the document. So I think this is a task for @michael-n-cooper |
@maryjom @bruce-usab @pday1 if you need help on this, let me know. Thanks! |
Thanks @ChrisLoiselle I will need some help or maybe another orientation. I am not finding the errors @pday1 flagged in above. Mostly I am looking in |
@bruce-usab I think several of the links that @pday1 found are broken come from included original WCAG definition text - things you'll only see by looking at the built document. The issue is that WCAG2ICT doesn't have any alternate interpretations for several definitions, so any dfn links or links to conformance and such in the original WCAG definition content would have an unresolved anchor in the WCAG2ICT document's definition section. |
@bruce-usab You will need to review the netlify document to see the errors as per Mary Jo's comment above. https://deploy-preview-144--wcag2ict.netlify.app |
@bruce-usab sorry , didn't see this before the call as I was on another call. Looks like @pday1 has you on the right track. |
@daniel-montalvo Unfortunately, the CSS modification for the text insertions and replacements didn't get rid of the underline. So that must be defaulting to what is defined for W3C documents somehow. Not sure how that's being done. |
@bruce-usab I've shown what the fixes/replacements should be for the broken links that are not in the included content. The includes' links would have to either be removed or fixed using scripting, or modified in the WCAG source content. We can't fix those. |
As per bullet in issue #147 "1. For 7.3.1.1, remove all redundant term links from the definition of accessibility supported in WCAG2ICT document to look more similar to accessibility supported in WCAG 2.2. Only the first occurrence of the desired linked term should appear for each definition."
As per following bullets in issue #147 2. In 7.3.1.1 Guidance When Applying “accessibility supported” to Non-Web Documents and Software. Link "assistive technologies" again looks OK (uses document anchor) but doesn't work in netlify version - it just opens the document at the start. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies MJM: change link reference to #dfn-assistive-technology 3. In 7.3.1.1 accessibility supported list. Link "user agents" doesn't work https://deploy-preview-144--wcag2ict.netlify.app/#dfn-user-agents. MJM: change link reference to #user-agent 4. In 7.3.1.1 Link "software" doesn't work https://deploy-preview-144--wcag2ict.netlify.app/#dfn-software MJM: change anchor to #software 5. In 7.3.1.1 Link "non-web document" doesn't work https://deploy-preview-144--wcag2ict.netlify.app/#dfn-non-web-document in "1. The way that the [non-web document " MJM: change link reference to #document 6. Link "software" doesn't work https://deploy-preview-144--wcag2ict.netlify.app/#dfn-software in "1. The way that the [non-web document "… MJM: I think this isn't the first link to the definition of software or non-web document, remove them. Only one link per definition is needed. 7. Link "technology" doesn't work https://deploy-preview-144--wcag2ict.netlify.app/#dfn-technologies in same section MJM: change link reference to #dfn-technology 8. Link "human language(s)" doesn't work https://deploy-preview-144--wcag2ict.netlify.app/#dfn-human-language in same section MJM: should link to full URL https://www.w3.org/TR/WCAG22/#dfn-human-language-s 9. Link "content" in the same section works as expected https://deploy-preview-144--wcag2ict.netlify.app/#dfn-content MJM: If this is the first link to the definition of content for the term "accessibility-supported" change the link to #content 10. Again, in bullet 2. The [non-web document or software] … Links are broken for non-web document, software, technology, software MJM: Remove these links. Links to these same terms already appear in the "accessibility-supported" definition - only need one. 11. Bullet 2.2. The technology is supported in a widely-distributed plug-in [or other software extension]. No link for other software extension - not sure if this is correct or not. MJM: Remove the link. A link to "technology" already appears in the "accessibility-supported" definition - only need one.
As per the following bullets in issue #147 12. Again, in section 7.3.2.1, broken links for non-web document, software MJM: change anchors to #document and #software 13. 14.3.4.1 Guidance When Applying “changes of context” to Non-Web Documents and Software. Broken links in changes of context sub for non-web document, software, MJM: change anchors to #document and #software 14. 7.3.5 conformance. Link "Comments on Conformance" works, but doesn't use relative URL; instead linking directly to the github version https://w3c.github.io/wcag2ict/#comments-on-conformance MJM: This should use a relative link only #comments-on-conformance 15. 7.3.6.1 Guidance When Applying “conforming alternate version” to Non-Web Documents and Software. Link "Comments on Conformance"works, but doesn't use relative URL: https://w3c.github.io/wcag2ict/#comments-on-conformance MJM: This should use a relative link only #comments-on-conformance
As per the following bullets in issue #147 16. 7.3.11.1 Guidance When Applying “input error” to Non-Web Documents and Software. Broken links for non-web document, software. MJM: change anchors to #document and #software 17. 7.3.12.1 Guidance When Applying “keyboard interface” to Non-Web Documents and Software. Broken link "guidance for Success Criterion 2.1.1", doesn't use relative URL, and takes to comments on conformance. https://w3c.github.io/wcag2ict/#comments-on-conformance MJM: Use the anchor only #guidance-when-applying-success-criterion-2-1-1-to-non-web-documents-and-software 18. 7.3.14.1 Guidance When Applying “label” to Non-Web Documents and Software. Broken links for "text" and "text alternative". https://deploy-preview-144--wcag2ict.netlify.app/#dfn-text https://deploy-preview-144--wcag2ict.netlify.app/#dfn-text-alternative **MJM: "text" should link to WCAG definition for text, "text alternative" should link to WCAG definition for text alternative since WCAG2ICT has no additional guidance for these terms. 19. 7.3.16.1 Guidance When Applying “programmatically determined” to Non-Web Documents and Software. Broken link for "software" https://deploy-preview-144--wcag2ict.netlify.app/#dfn-software MJM: Change link to #software 20. Broken link for assistive technologies https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies MJM: Change link to #dfn-assistive-technology 21. In 7.3.16.1 Note, broken link for "accessibility services of platform software". Currently doesn't use relative URL: https://w3c.github.io/wcag2ict/#wcag2ict-def_accessibility-services MJM: remove github.io part and only use the relative URL #accessibility-services-of-platform-software 22. Also in Note, broken link to "content" https://w3c.github.io/wcag2ict/wcag2ict-def_content MJM: Any links to "content" should go to #content-on-and-off-the-web
As per following bullet in issue #147 23. 7.3.17 programmatically set. Broken link for "assistive technologies" https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies MJM: Change link to #dfn-assistive-technology
#147 - fixing broken links - Content - editing any URLs using githubio to instead use relative document links
Fix links for Items 33-38 in Issue #147, definitions from "technology" to "user interface component"
Fixing all the rest of the broken links listed in #147 in the definitions.
@pday1 @ChrisLoiselle I have completed the rest of the broken links work in the definitions files. ReSpec now shows zero broken local links!!! Thanks for your help on this. |
@maryjom Amazing ! |
Hi @maryjom Here's the state of things as-of today. Michael is making great progress. We would propose to focus on the Intents for now and address a couple of things at a later stage.
Michael is currently working on this. The requested additions imply changes in the underlying JSON file that he's using to pull up the content and it is taking a bit longer than expected. He may have updates before our meeting on 25th.
Michael and I are investigating it but we still don't have a clear answer. We'd propose to address this after we have finish the Intents includes. In the event that we cannot fix it by the time we publish FPWD, we should then probably be using the Netlify link.
Fixed. Will be part of MIchael's PR with the Intents includes.
We'd propose to work on this after we finish the Intents includes.
We'd propose to work on this after we finish the Intents includes.
Done.
This needs to be done via scripting. I'd like to be clear on which sections specifically we want to suppress numbering for before asking Michael. Are we OK with only suppressing numbering for all sections under "6. Comments by Guideline and Success Criteria"? Do we also want to suppress numbering for section "7. Comments on Definitions in WCAG 2.2 Glossary"?
This is W3C style and we cannot override it.
We'd propose to work on this after we finish the Intents includes. |
@daniel-montalvo Thanks for the update. I would suggest the W3C style for inserted content is inaccessible, as one cannot visually identify links in the inserted content. This happens often, as the inserted content is usually the replacement words which are definition links. |
Hi @maryjom |
@daniel-montalvo @michael-n-cooper Issues I still see:
|
It would be really helpful if we could align the numbering with WCAG. EN 301 549 does this by adding a number or 2 in front of the number - so it could be something like 1.1.2.1 for Audio or 1.1.2.1.1 and 1.1.2.1.2 for closed function and open functionality, etc. |
@mraccess77 I agree it would be good and it is on the bucket list of things to address. The problem is figuring out how to get this to work within the constraints of using GitHub markdown and respec tool. We are not coding in pure HTML or using a Word document that's converted to PDF like the EN 301 549 does. Some things are done automatically, such as numbering, that I wish I could understand how to selectively override. When we add headings for guidance sections, those get added in the numbering and throw everything off. I am not a scripting expert and do not know how to change the way these work. Plus we would have to add empty section headings for all Level AAA criteria that we will not have any guidance for in the first round of the published note as not all Level A and AA are contiguous in the numbering scheme. There are some additional document styling methods that are set up by the W3C document authoring styles, such as notes and examples. I'd really like to have additional special CSS markup available to use different styles for WCAG2ICT guidance and notes, but have been unable to establish anything unique to this document. |
@mraccess77 Section numbering has been fixed to match WCAG. Sorry it took so long, but I had no idea how to do the post-processing scripts on the document to get that done. |
I think all of these are now fixed with PR #326 |
The document is looking so much better now! There are some things that I noticed:
Formatting things:
<INS>
? It makes it hard to find links that are on the inserted text, as you cannot visibly see any difference in the underline. See the screen shot below where the the exception text has links on "user agent" and "software" but not on "or".Nice-to-have:
The text was updated successfully, but these errors were encountered: