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

Remaining WCAG2ICT document format issues #147

Closed
13 of 14 tasks
maryjom opened this issue Apr 17, 2023 · 26 comments
Closed
13 of 14 tasks

Remaining WCAG2ICT document format issues #147

maryjom opened this issue Apr 17, 2023 · 26 comments
Assignees

Comments

@maryjom
Copy link
Contributor

maryjom commented Apr 17, 2023

The document is looking so much better now! There are some things that I noticed:

  • Document still missing the Understanding Intent content which should be incorporated from the WCAG Understanding docs. NOTE: The TF discussed on 27 April and decided this content is important to include.
  • The github.io version doesn't have the includes, but the netlify version does (link from the pull request). Does this mean when we publish, we should give the netlify link to that version of the document rather than the github.io one?
  • The headings for the definitions sections still have the hyphenated file names rather than simply the term. I think this probably requires some more post-processing.
  • There are links in the original included WCAG and Intent text that are meant to go to the WCAG standard but are in-document anchor links. These need conversion to include the full URL. This happens anywhere included files are used - SC text, Intent text, and definitions. An example is from Phil Day's list below:
    • 7.3.1 accessibility supported. Links to "Conformance Requirement 4" and "Conformance Requirement 5" don't work. They are using anchor references: #cc4 and #cc5, but these sections only exist in WCAG, not the WCAG2ICT document.

Formatting things:

  • The included text from the Understanding Intent for the SCs doesn't have the bar to the left indicating it's quoted content.
  • The included WCAG original note text doesn't have the verbiage "NOTE" or "EXAMPLE" in them (probably just some additional processing with the new formatting).
  • Figure out how we can make the subsection numbers for the SCs align with the numbering in WCAG. Can we use some special formatting instead of headings for the principles and guidelines so a number isn't used up?
  • Can the "Guidance on Applying" subsections of the glossary terms sections be removed from the TOC?
  • I wonder what happens with screen reader announcement of any of the quoted content - is it inside of an html block quote or some other programmatic element that is announced? I want to make sure however that is revealed, that is listed in the introductory info.
  • Inserted WCAG original text is a smaller font than other content. Should the font size be consistent throughout?
  • Is there a way to selectively turn off section numbering? e.g. not have it for the introduction sections and the "Guidance when applying..." sections. This would help us get the section numbers to align with the WCAG SC numbering (similar to EN 301 549)
  • How do I adjust the CSS to avoid underlining insertions of text using <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:

  • Would be great to have a way to number the WCAG2ICT notes.
  • Would be nice to have a different formatting for WCAG2ICT notes added. Using INS may need to be used.
@maryjom
Copy link
Contributor Author

maryjom commented Apr 18, 2023

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
Copy link
Contributor

ChrisLoiselle commented Apr 19, 2023

  1. General statement, but wanted to call out. In a given section, say https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-principle-1-to-non-web-documents-and-software , the size of the text for the "In WCAG" section underneath the heading is larger than it is for the call outs in https://deploy-preview-144--wcag2ict.netlify.app/#text-alternatives , I don't know if this is standard procedure on text size or not.

For Notes, the text size seems to resemble the blurbs underneath https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-1-1-1-to-non-web-documents-and-software , however https://deploy-preview-144--wcag2ict.netlify.app/#time-based-media's call out , the text size visually appears smaller in font size.

  1. For https://deploy-preview-144--wcag2ict.netlify.app/#sensory-characteristics, grey box is set for requirements related to color, however NOTES are generally in Green call out box.
  2. https://deploy-preview-144--wcag2ict.netlify.app/#document text format is not clear on green underline and underline of not linked text., same can be said wherever this is present
  3. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies is broken.
  4. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-user-interface-components is broken.
  5. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-keyboard-shortcuts is broken
  6. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-programmatically-determinable is broken
  7. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies is broken under 3.1.1 https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-3-1-1-to-non-web-documents-and-software
  8. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-programmatically-determinable is broken underneath https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-3-1-2-to-non-web-documents-and-software
  9. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-change-of-context is broken underneath https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-3-2-1-to-non-web-documents-and-software
  10. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies is broken underneath https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-principle-4-to-non-web-documents-and-software
  11. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies is broken under https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-guideline-4-1-to-non-web-documents-and-software
  12. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies is broken underneath https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-4-1-1-to-non-web-documents-and-software as is https://deploy-preview-144--wcag2ict.netlify.app/#dfn-assistive-technologies
  13. https://deploy-preview-144--wcag2ict.netlify.app/#dfn-user-interface-components is broken underneath https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-4-1-2-to-non-web-documents-and-software
  14. Same for https://deploy-preview-144--wcag2ict.netlify.app/#dfn-programmatically-determinable under https://deploy-preview-144--wcag2ict.netlify.app/#guidance-when-applying-success-criterion-4-1-3-to-non-web-documents-and-software

@maryjom
Copy link
Contributor Author

maryjom commented Apr 19, 2023

@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:

  • The WCAG original note text doesn't have the verbiage "NOTE" in them (probably just some additional processing with the new formatting).
  • Inserted WCAG original text is a smaller font than other content. Should the font size be consistent throughout?

@maryjom
Copy link
Contributor Author

maryjom commented Apr 19, 2023

@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:

  • #dfn-assistive-technologies is now #dfn-assistive-technology
  • #dfn-user-interface-components is now #dfn-user-interface-component
  • #dfn-keyboard-shortcuts is now #dfn-keyboard-shortcut
  • #dfn-programmatically-determinable is now #dfn-programmatically-determined
  • #dfn-change-of-context is now #dfn-changes-of-context

So those references need to be updated in the file comments-by-guideline-and-success-criterion.md

@ChrisLoiselle
Copy link
Contributor

@maryjom I'll make these changes on Friday of this week to assist.

@ChrisLoiselle
Copy link
Contributor

@maryjom I've made the request for proposed changes 0fcbcc0

@pday1
Copy link
Contributor

pday1 commented Apr 26, 2023

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.

  1. However, links for user agent and viewport both work as expected. "user agent" https://deploy-preview-144--wcag2ict.netlify.app/#dfn-user-agent And "viewport" https://deploy-preview-144--wcag2ict.netlify.app/#dfn-viewport Both work as expected MJM: I don't think this is stating an issue to fix, says the links work - are they going to the right place?
  2. 7.3.15.1 Guidance When Applying “name” to Non-Web Documents and Software. Label link works as expected. MJM: Seems this is not stating any issue. I checked and links from "name" all work.
  3. 7.3.29.1 Guidance When Applying “Web Page” to Non-Web Documents and Software. NOTE. Editorial - appears to be missing content?. NOTE. For those success criteria that use the term “web page”, WCAG2ICT provides specific replacement term(s) for “Web page”. MJM: I don't think this is missing anything. The replacement terms may be differently handled so this definition note won't /shouldn't say what the replacements are.

@bruce-usab
Copy link
Contributor

bruce-usab commented Apr 27, 2023

Thanks @pday1 -- I added a - [ ] in front of items so now they are something of "task list" with interactive checkboxes.

@maryjom -- I can put some time tomorrow (Friday 4/27) to help with some of these editorial nits.

@maryjom
Copy link
Contributor Author

maryjom commented Apr 27, 2023

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.

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

@ChrisLoiselle
Copy link
Contributor

@maryjom @bruce-usab @pday1 if you need help on this, let me know. Thanks!

@bruce-usab
Copy link
Contributor

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 comments-by-guideline-and-success-criterion.md but whole sentences (the ones that need the links corrected) seem to be missing.

@maryjom
Copy link
Contributor Author

maryjom commented May 4, 2023

@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.

@pday1
Copy link
Contributor

pday1 commented May 4, 2023

@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
Apologies for not making that clear

@ChrisLoiselle
Copy link
Contributor

@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.

@maryjom
Copy link
Contributor Author

maryjom commented May 9, 2023

@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.

@maryjom
Copy link
Contributor Author

maryjom commented May 10, 2023

@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.

pday1 added a commit that referenced this issue May 19, 2023
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."
pday1 added a commit that referenced this issue May 19, 2023
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.
pday1 added a commit that referenced this issue May 19, 2023
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
pday1 added a commit that referenced this issue May 19, 2023
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
pday1 added a commit that referenced this issue May 19, 2023
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
maryjom added a commit that referenced this issue May 19, 2023
#147 - fixing broken links
- Content
- editing any URLs using githubio to instead use relative document links
maryjom added a commit that referenced this issue May 19, 2023
Fix links for Items 33-38 in Issue #147, definitions from "technology" to "user interface component"
maryjom added a commit that referenced this issue May 19, 2023
Fixing all the rest of the broken links listed in #147 in the definitions.
@maryjom
Copy link
Contributor Author

maryjom commented May 19, 2023

@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.

@ChrisLoiselle
Copy link
Contributor

@maryjom Amazing !

@daniel-montalvo
Copy link
Contributor

daniel-montalvo commented May 22, 2023

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.

  • Document still missing the Understanding Intent content which should be incorporated from the WCAG Understanding docs. NOTE: The TF discussed on 27 April and decided this content is important to include.

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.

  • The github.io version doesn't have the includes, but the netlify version does (link from the pull request). Does this mean when we publish, we should give the netlify link to that version of the document rather than the github.io one?

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.

  • The headings for the definitions sections still have the hyphenated file names rather than simply the term. I think this probably requires some more post-processing.

Fixed. Will be part of MIchael's PR with the Intents includes.

  • The WCAG original note text doesn't have the verbiage "NOTE" in them (probably just some additional processing with the new formatting).

We'd propose to work on this after we finish the Intents includes.

  • There are links in the original included WCAG text that are meant to go to the WCAG standard but are in-document anchor links. These need conversion to include the full URL. This happens anywhere included files are used - SC text, Intent text, and definitions. An example is from Phil Day's list below:

    • 7.3.1 accessibility supported. Links to "Conformance Requirement 4" and "Conformance Requirement 5" don't work. They are using anchor references: #cc4 and #cc5, but these sections only exist in WCAG, not the WCAG2ICT document.

We'd propose to work on this after we finish the Intents includes.

Formatting things:

  • Inserted WCAG original text is a smaller font than other content. Should the font size be consistent throughout?

Done.

  • Is there a way to selectively turn off section numbering? e.g. not have it for the introduction sections and the "Guidance when applying..." sections. This would help us get the section numbers to align with the WCAG SC numbering (similar to EN 301 549)

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"?

  • How do I adjust the CSS to avoid underlining insertions of text using <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".

This is W3C style and we cannot override it.

  • Would be great to have a way to number the WCAG2ICT notes.

We'd propose to work on this after we finish the Intents includes.

@maryjom
Copy link
Contributor Author

maryjom commented May 25, 2023

@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.

@daniel-montalvo
Copy link
Contributor

Hi @maryjom
See w3c/tr-design#325

@maryjom
Copy link
Contributor Author

maryjom commented Jun 1, 2023

@daniel-montalvo @michael-n-cooper

Issues I still see:

  • Intent sections from the Understanding the SC are not included
  • Need to remove "Guidance when applying" from the TOC for the principles and the guidelines from the numbered sections. However, I think that post-processing those previously left gaps in the numbering. We may need a different approach by using callout boxes with a specific styling instead (maybe the INS) and not make those headings?
  • Still issues with some links in included content that are in-document anchors for WCAG that don't appear in WCAG2ICT. (e.g. accessibility supported definition notes in gray boxes has links to Conformance Requirement 4 and Conformance Requirement 5. The conformance requirements aren't repeated in WCAG2ICT, so it's a non-working link.
  • The word "NOTE" and "EXAMPLE" is missing from the included content now that we're using gray box styling.

@mraccess77
Copy link

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.

@maryjom
Copy link
Contributor Author

maryjom commented Aug 1, 2023

@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.

@maryjom
Copy link
Contributor Author

maryjom commented Oct 12, 2023

@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.

@maryjom
Copy link
Contributor Author

maryjom commented Mar 20, 2024

I think all of these are now fixed with PR #326

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

Successfully merging a pull request may close this issue.

7 participants