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

Document formatting issues and anomalies #118

Closed
3 of 5 tasks
maryjom opened this issue Mar 3, 2023 · 2 comments
Closed
3 of 5 tasks

Document formatting issues and anomalies #118

maryjom opened this issue Mar 3, 2023 · 2 comments

Comments

@maryjom
Copy link
Contributor

maryjom commented Mar 3, 2023

In moving to the new W3C document formatting and markdown, there are a few things that could be improved:

  • <INS>some text</INS> is used to indicate where there is replacement or inserted text. In the old WCAG2ICT, the replacement or inserted text was enclosed in square brackets, in red bold text. Now it appears with no square brackets, in green, underlined style text. I had to add in bold and square brackets in the markdown, but can't figure out how to change the style of the text so it is red and not underlined. The underlining looks bad and is confusing when used on a large chunk of text that contains links. Makes it hard to tell the links apart from the rest of the text - all are green text and underlined.
    Here's the visual example from the 2013 WCAG2ICT:

Screen shot of 2013 WCAG2ICT content key term

Compared to the editor's draft:

Screen Shot of editor's draft content key term

  • Would be really nice to have a special callout box that contained the WCAG2ICT interpretation that is different from the Example and Note styling. See the original WCAG2ICT screen shot above where there is a non-color filled callout box to highlight the section of WCAG2ICT guidance.
  • Would be great to be able to number notes. Sometimes there can be 8 or so notes in a row.
  • Would be great to have a unique style to tell the difference between the WCAG note and new WCAG2ICT notes. Maybe the use of <INS> styling will be sufficient, but it's currently not used consistently throughout and is not good if all text is underlined.
  • Would be great to have control over what sections are numbered and what are not to make the section numbers more closely match the WCAG SC numbering. Otherwise, it's weird to go through the document and see a section numbered 6.1.5.3.1 that is talking about Success Criterion 1.4.2, as shown in the screen shot below.

Screen shot of SC 1.4.2 in editor's draft

@maryjom maryjom added this to the Update supporting sections milestone Mar 3, 2023
@maryjom maryjom changed the title Document formatting Document formatting issues and anomalies Mar 3, 2023
@daniel-montalvo daniel-montalvo self-assigned this Mar 6, 2023
@michael-n-cooper michael-n-cooper self-assigned this Apr 13, 2023
@daniel-montalvo
Copy link
Contributor

@maryjom

I edited your comment above, including checkboxes and ticking those that I think are resolved. Please let me know if that's a correct understanding.

@maryjom
Copy link
Contributor Author

maryjom commented Mar 22, 2024

I think this can now be closed. I don't think we'll get any special callout box style for WCAG2ICT guidance and the other things have been handled in the latest updates to the editor's draft.

@maryjom maryjom closed this as completed Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

3 participants