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

Editorial fixes #100

Merged
merged 14 commits into from
Apr 2, 2025
Merged

Editorial fixes #100

merged 14 commits into from
Apr 2, 2025

Conversation

iadawn
Copy link
Contributor

@iadawn iadawn commented Mar 18, 2025

No description provided.

iadawn and others added 2 commits March 18, 2025 12:30
- removed the title of the document from the first sentence in the Abstract (and also getting this corrected this in the WCAG2ICT Abstract)
- removed capitals from nouns that are not proper nouns
- corrected typos and punctuation in lists
- proposed making 'New terms' a nested list of 4 categories
- Shawn Henry proposes removing the phrase 'but not limited to' as "including" implies that it could be more and it's not an inclusive list.
- corrected title case for h3 headings
- Kevin White proposes removing references about who the guidance was created by
@tamsinewing555
Copy link
Contributor

@iadawn - I've added the proposed edits, taking in your feedback.

Just 2 small issues remaining from my side:

  1. @shawna-slh noted in the review document that this is not correct?:

This document is part of a series of technical and educational documents published by the W3C Web Accessibility Initiative (WAI) and available from the Mobile Accessibility at W3C Overview.

I already made a note to correct the link text to 'Mobile Accessibility at W3C' but aside from correcting the text, I'm unclear whether to delete altogether or amend the wording further?

  1. Using an em dash (which sets off explanatory/supplemental information about the previous clause) in order to avoid having a list item consisting of 2 sentences. If more than one sentence is needed for a list item, it's best to redesign the content not as a list).
    Examples:
  • This document is not sufficient by itself to ensure accessibility in mobile applications — as a web standard, WCAG does not fully cover all accessibility requirements for non-user interface aspects of platforms, user-interface components as individual items, or closed product software (where there is no assistive technology to communicate programmatic information).
  • References to glossary items from WCAG 2 are presented in elements that are visually styled as ordinary text with a dotted underline, and contain title attributes noting these are WCAG definitions — when mouse or keyboard focus is placed over them, they turn blue with a yellow background.

@iadawn iadawn requested a review from JJdeGroot March 20, 2025 11:08
@iadawn
Copy link
Contributor Author

iadawn commented Mar 20, 2025

Hi JJ, more editorial tweaks for you to double check.

At some point we will need to add a 'Glossary' section to replace the 'Key Terms' - future topic!

@iadawn
Copy link
Contributor Author

iadawn commented Mar 20, 2025

This document is part of a series of technical and educational documents published by the W3C Web Accessibility Initiative (WAI) and available from the Mobile Accessibility at W3C Overview.

Have removed for now

Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for wcag2mobile ready!

Name Link
🔨 Latest commit 0344712
🔍 Latest deploy log https://app.netlify.com/sites/wcag2mobile/deploys/67e43ce31c155b0008321dda
😎 Deploy Preview https://deploy-preview-100--wcag2mobile.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@shawna-slh
Copy link
Contributor

Have removed for now

Added link to Mobile Accessibility at W3C at end of Background section.

@shawna-slh
Copy link
Contributor

/me notices the preview URI is https://deploy-preview-100--wcag2mobie.netlify.app

and wonders if 'wcag2mobie' would be better as 'wcag2mobile'

? @iadawn

@iadawn
Copy link
Contributor Author

iadawn commented Mar 23, 2025

Nah... mobie seems soooo much better! 😉

@JJdeGroot
Copy link
Member

JJdeGroot commented Mar 24, 2025

Good morning @iadawn , @shawna-slh @tamsinewing555
Thanks for making these changes.

Unfortunately I did not notice it earlier - but you have modified the generated index.html instead of the source markdown files located in the sections folder

Can you migrate these changes to the source files? You can then run node matf.js to generate an updated index.html. See setup section in the README of this repo.

I'll add some remarks to exact lines in the index.html files. I'd say most changes are good to go, but... some are causing deviating from WCAG2ICT. We based our sections on their wording and title capitalizations in our sections.

@iadawn
Copy link
Contributor Author

iadawn commented Mar 24, 2025

Can you migrate these changes to the source files? You can then run node matf.js to generate an updated index.html. See setup section in the README of this repo.

Will sort that out

@JJdeGroot
Copy link
Member

JJdeGroot commented Apr 1, 2025

@iadawn thanks for moving the changes to the Markdown files. When I re-generate the index.html file from this branch, I get the exact same output as the current index.html file in this branch.

It's OK for me to merge now - but still 2 open comments about capitalization, up to you to make the decision to uppercase it or keep as is.

Update: both resolved, sentence case is the new preferred way.

@iadawn iadawn merged commit fd14078 into main Apr 2, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants