ABBR: remove title #18409

estelle · 2022-07-16T06:20:39Z

Summary

The title attribute is not recommended on ABBR. See https://www.tpgi.com/short-note-the-abbreviation-appreciation-society/, but can be used when an expansion of the abbreviation for all users to see is not possible. It is NOT needed when the acronym is obvious, such as on the MDN acronym on MDN.

The title attribute page was missing some features (LINK element), incorrect in some areas (should not be used on INPUT), and referenced deprecated elements (MENUITEM), so I edited that page a little more in-depth.

* for required is not an abbreviation or acronym. Edited that.

Motivation

Supporting details

https://www.tpgi.com/short-note-the-abbreviation-appreciation-society/

Related issues

PArt of openwebdocs/project#115

Metadata

Adds a new document
Rewrites (or significantly expands) a document
Fixes a typo, bug, or other error

github-actions · 2022-07-16T06:23:34Z

Preview URLs

Flaws

Note! 5 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/Accessibility/ARIA/Roles
Title: WAI-ARIA Roles
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
- /en-US/docs/Web/HTML/Element/h6 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements

URL: /en-US/docs/Web/HTML/Element/abbr
Title: <abbr>: The Abbreviation element
on GitHub
Flaw count: 1

macros:
- wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Learn/Accessibility/CSS_and_JavaScript
Title: CSS and JavaScript accessibility best practices
on GitHub
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/Web/API/GlobalEventHandlers/onclick
- Link points to the page it's already on

URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Advanced_text_formatting
Title: Advanced text formatting
on GitHub
Flaw count: 1

broken_links:
- Link points to the page it's already on

URL: /en-US/docs/Learn/Forms/Form_validation
Title: Client-side form validation
on GitHub
Flaw count: 4

macros:
- /en-US/docs/Web/API/ValidityState/valueMissing does not exist
- /en-US/docs/Web/API/ValidityState/customError does not exist
broken_links:
- Can't resolve /en-US/docs/Web/HTML/Attributes/novalidate
- Link points to the page it's already on

URL: /en-US/docs/Learn/Forms/How_to_structure_a_web_form
Title: How to structure a web form
on GitHub
Flaw count: 3

macros:
- /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
- /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
broken_links:
- Link points to the page it's already on

External URLs

URL: /en-US/docs/Web/Accessibility/ARIA/Attributes
Title: ARIA states and properties
on GitHub

No new external URLs

URL: /en-US/docs/Web/Accessibility/ARIA/Roles
Title: WAI-ARIA Roles
on GitHub

No new external URLs

URL: /en-US/docs/Web/Accessibility/ARIA/Roles/window_role
Title: ARIA: window role
on GitHub

No new external URLs

URL: /en-US/docs/Web/Accessibility/ARIA/Roles/toolbar_role
Title: ARIA: toolbar role
on GitHub

https://www.w3.org/TR/wai-aria-practices-1.2/examples/toolbar/toolbar.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTML/Global_attributes/title
Title: title
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/abbr
Title: <abbr>: The Abbreviation element
on GitHub

No new external URLs

URL: /en-US/docs/Learn/Accessibility/CSS_and_JavaScript
Title: CSS and JavaScript accessibility best practices
on GitHub

No new external URLs

URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Advanced_text_formatting
Title: Advanced text formatting
on GitHub

No new external URLs

URL: /en-US/docs/Learn/Forms/Form_validation
Title: Client-side form validation
on GitHub

No new external URLs

URL: /en-US/docs/Learn/Forms/How_to_structure_a_web_form
Title: How to structure a web form
on GitHub

No new external URLs

URL: /en-US/docs/Learn/Forms/How_to_structure_a_web_form/Example
Title: Example
on GitHub

No new external URLs

(this comment was updated 2022-07-19 20:30:33.192262)

files/en-us/web/html/element/abbr/index.md

files/en-us/web/html/global_attributes/title/index.md

teoli2003

Thank you! A few nits and some questions!

files/en-us/learn/html/introduction_to_html/advanced_text_formatting/index.md

teoli2003 · 2022-07-17T06:23:18Z

files/en-us/learn/html/introduction_to_html/advanced_text_formatting/index.md

@@ -525,7 +527,7 @@ solution.addEventListener('click', function() {
  updateCode();
 });

-const htmlSolution = '<p><abbr title="National Aeronautics and Space Administration">NASA</abbr> sure does some exciting work.</p>';
+const htmlSolution = '<p><abbr>NASA</abbr>, the National Aeronautics and Space Administration, sure does some exciting work.</p>';


I'm curious, will screen readers read this as N – A – S – A or as Nasa?

If they do the first, how should we mark up our content to prevent this?

teoli2003 · 2022-07-17T06:24:41Z

files/en-us/web/accessibility/aria/attributes/index.md

@@ -10,9 +10,9 @@ tags:
  - States
  - Properties
 ---
-This page lists reference pages covering all the WAI-ARIA attributes discussed on MDN.
+This page lists reference pages covering all the <abbr>WAI-ARIA</abbr> attributes discussed on <abbr>MDN</abbr>.


Strictly speaking, MDN is no more an abbreviation for Mozilla Developer Network, like IBM is no more an abbreviation for International Business Machines.

files/en-us/web/accessibility/aria/roles/toolbar_role/index.md

files/en-us/web/html/element/abbr/index.md

teoli2003 · 2022-07-17T06:28:37Z

files/en-us/web/html/global_attributes/title/index.md

-Additional semantics are attached to the `title` attributes of the {{HTMLElement("link")}}, {{HTMLElement("abbr")}}, {{HTMLElement("input")}}, and {{HTMLElement("menuitem")}} elements.
+The `title` attribute, when added to [`<link rel="stylesheet">`](/en-US/docs/Web/HTML/Element/link), creates an alternate stylesheet. When defining an alternative style sheet with `<link rel="alternate">` the attribute is required and must be set to a non-empty string. 
+
+While `title` can be used to provide a programmatically associated label for an {{HTMLElement("input")}} element, this is not good practice. Use a {{HTMLElement("label")}} instead.



I think we should list the <abbr>case here, too.

files/en-us/web/accessibility/aria/attributes/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>

teoli2003

👍

ABBR: remove title

fb87818

estelle requested review from a team as code owners July 16, 2022 06:20

estelle requested review from schalkneethling and Rumyra and removed request for a team July 16, 2022 06:20

estelle marked this pull request as draft July 16, 2022 06:20

ABBR: remove title

58bbda2

github-actions bot added Content:Accessibility Accessibility docs Content:Learn Learning area docs Content:HTML Hypertext Markup Language docs labels Jul 16, 2022

ABBR: update title attribute page

9392f96

estelle commented Jul 16, 2022

View reviewed changes

files/en-us/web/html/element/abbr/index.md Outdated Show resolved Hide resolved

typo

4f0d772

estelle commented Jul 16, 2022

View reviewed changes

files/en-us/web/html/element/abbr/index.md Outdated Show resolved Hide resolved

Update files/en-us/web/html/element/abbr/index.md

3ee6b88

estelle commented Jul 16, 2022

View reviewed changes

files/en-us/web/html/global_attributes/title/index.md Outdated Show resolved Hide resolved

Update files/en-us/web/html/global_attributes/title/index.md

b9ee7da

estelle marked this pull request as ready for review July 16, 2022 21:08

teoli2003 suggested changes Jul 17, 2022

View reviewed changes

estelle commented Jul 19, 2022

View reviewed changes

files/en-us/web/accessibility/aria/attributes/index.md Outdated Show resolved Hide resolved

estelle and others added 2 commits July 19, 2022 12:49

Apply suggestions from code review

0fc6d4f

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>

added abbr back in.

4c41bb1

teoli2003 approved these changes Jul 19, 2022

View reviewed changes

teoli2003 merged commit 615d347 into mdn:main Jul 19, 2022

estelle deleted the semantics-3 branch July 19, 2022 22:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ABBR: remove title #18409

ABBR: remove title #18409

estelle commented Jul 16, 2022 •

edited

Loading

github-actions bot commented Jul 16, 2022 •

edited

Loading

teoli2003 left a comment

teoli2003 Jul 17, 2022

teoli2003 Jul 17, 2022

teoli2003 Jul 17, 2022

teoli2003 left a comment

ABBR: remove title #18409

ABBR: remove title #18409

Conversation

estelle commented Jul 16, 2022 • edited Loading

Summary

Motivation

Supporting details

Related issues

Metadata

github-actions bot commented Jul 16, 2022 • edited Loading

Preview URLs

Flaws

External URLs

teoli2003 left a comment

Choose a reason for hiding this comment

teoli2003 Jul 17, 2022

Choose a reason for hiding this comment

teoli2003 Jul 17, 2022

Choose a reason for hiding this comment

teoli2003 Jul 17, 2022

Choose a reason for hiding this comment

teoli2003 left a comment

Choose a reason for hiding this comment

estelle commented Jul 16, 2022 •

edited

Loading

github-actions bot commented Jul 16, 2022 •

edited

Loading