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

feat: improvements on glossary a11y #34095

Merged
merged 11 commits into from
Jun 27, 2024
14 changes: 10 additions & 4 deletions files/en-us/glossary/accessibility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,20 @@ page-type: glossary-definition

{{GlossarySidebar}}

**Accessibility** (**A11Y**) refers to best practices for keeping a website usable despite physical and technical restrictions. Web accessibility is formally defined and discussed at the {{Glossary("W3C")}} through the {{Glossary("WAI","Web Accessibility Initiative")}} (WAI).
**Accessibility** (often abbreviated to **A11y** — as in, "a", then 11 characters, and then "y") in web development means enabling as many people as possible to use websites, even when those people's abilities are limited in some way. Web accessibility is formally defined and discussed at the {{Glossary("W3C")}} through the {{Glossary("WAI", "Web Accessibility Initiative (WAI)")}}.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fly-by comment (meaning I choose not to arbitrate on this), but the format (**A11Y**) is a very well understood way of indicating contraction/short form of a word. I find "(often abbreviated to A11y — as in, "a", then 11 characters, and then "y")" as verbose with no added value.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

many entries contains these abbreviations descriptions. this above was just copied from Web/Accessibility lol.

i totally agree with your point. l18n, l10n, ... this is a pretty common abbr way in computer science. maybe we can also remove Web/Accessibility's one.

Screenshot 2024-06-14 at 11 06 02 AM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would argue that it might be a good thing to keep the verbose derivation of A11y in the Glossary for absolute beginners to web development. We can consider removing it from the Web/Accessibility page.


## See also

- [Accessibility resources](/en-US/docs/Web/Accessibility)
- [Accessibility](/en-US/docs/Web/Accessibility)
- [Learn accessibility](/en-US/docs/Learn/Accessibility)
- [ARIA documentation](/en-US/docs/Web/Accessibility/ARIA)
- [ARIA](/en-US/docs/Web/Accessibility/ARIA)
- [Web accessibility](https://en.wikipedia.org/wiki/Web_accessibility) on Wikipedia
- [The W3C Web Accessibility Initiative (WAI)](https://www.w3.org/WAI/)
PassionPenguin marked this conversation as resolved.
Show resolved Hide resolved
- [Accessible Rich Internet Applications (WAI-ARIA)](https://w3c.github.io/aria/)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

put WAI and WAI-ARIA together, given they are in the order of

  • WAI, the organization
  • WAI-ARIA, the spec put forward by the org

PassionPenguin marked this conversation as resolved.
Show resolved Hide resolved
- [The W3C Web Accessibility Initiative](https://www.w3.org/WAI/)
- [Web Accessibility In Mind](https://webaim.org/)
- [Glossary](/en-US/docs/Glossary)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed a different style has been adopted here: #33423 (comment), and I understand you might have already implemented it on many pages, so I won't ask you to revert it.

However, to keep the list (and the page length) contained, I would have formatted this as (no link on Glossary):

For one term in in the list:

  • Related glossary terms: <term 1 link>

For multiple terms:

  • Related glossary terms: <term 1 link>, <term 2 link>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW I would have personally gone with

  • <term 1 link>
  • <term 2 link>

Without any extra text, per see also guidelines, but I have no feelings towards any of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, i have been translated pages under glossary folder for some time (processed about 300-350 files and PRs), and find that in most cases they are arranged in that style, and with suggestion from @bsmth, using the style of the most common case but without a link, i.e.

- Glossary
  - a.
  - b.


- {{Glossary("Accessibility tree")}}
- {{Glossary("Accessible description")}}
- {{Glossary("Accessible name")}}
- {{Glossary("ARIA")}}
10 changes: 9 additions & 1 deletion files/en-us/glossary/accessibility_tree/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are four properties in an accessibility tree object:
- : How do we describe this thing, if we want to provide more description beyond the name? The description of a table could explain what kind of information the table contains.
- [**role**](/en-US/docs/Web/Accessibility/ARIA/Roles)
- : What kind of thing is it? For example, is it a button, a nav bar, or a list of items?
- **state**
- [**state**](/en-US/docs/Web/Accessibility/ARIA/Attributes)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added link to attributes given aria-state is under attributes page right now

- : Does it have a state? Examples include checked or unchecked checkbox states and collapsed or expanded states for the [`<summary>`](/en-US/docs/Web/HTML/Element/summary) element.

Additionally, the accessibility tree often contains information on what can be done with an element: a link can be _followed_, a text input can be _typed into_, etc.
Expand All @@ -27,7 +27,15 @@ While still in draft form within the Web Incubator Community Group as of April 2

## See also

- [Accessibility](/en-US/docs/Web/Accessibility)
- [Learn accessibility](/en-US/docs/Learn/Accessibility)
- [ARIA](/en-US/docs/Web/Accessibility/ARIA)
- [Web accessibility](https://en.wikipedia.org/wiki/Web_accessibility) on Wikipedia
- [The W3C Web Accessibility Initiative (WAI)](https://www.w3.org/WAI/)
- [Accessible Rich Internet Applications (WAI-ARIA)](https://w3c.github.io/aria/)
- [Glossary](/en-US/docs/Glossary)

- {{Glossary("Accessibility")}}
- {{Glossary("Accessible description")}}
- {{Glossary("Accessible name")}}
- {{Glossary("ARIA")}}
12 changes: 10 additions & 2 deletions files/en-us/glossary/accessible_name/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ Assistive technologies will provide the user with the accessibility name propert

## See also

- [ARIA roles](/en-US/docs/Web/Accessibility/ARIA/Roles)
- [ARIA attribute](/en-US/docs/Web/Accessibility/ARIA/Attributes)
- [Accessibility](/en-US/docs/Web/Accessibility)
- [Learn accessibility](/en-US/docs/Learn/Accessibility)
- [ARIA](/en-US/docs/Web/Accessibility/ARIA)
- [Web accessibility](https://en.wikipedia.org/wiki/Web_accessibility) on Wikipedia
- [The W3C Web Accessibility Initiative (WAI)](https://www.w3.org/WAI/)
- [Accessible Rich Internet Applications (WAI-ARIA)](https://w3c.github.io/aria/)
- [Glossary](/en-US/docs/Glossary)

- {{Glossary("Accessibility")}}
- {{Glossary("Accessibility tree")}}
- {{Glossary("Accessible description")}}
- {{Glossary("ARIA")}}