Abbreviations

[ecureuill]

This is a "not-end" requirement. What I want to mean is that this should be considered for any new page you create that Student can access. Also should correct the old pages.

I will use the label Feature Design Notes to this cases

---

wcag: 3.1.4

A mechanism for identifying the expanded form or meaning of abbreviations is available.

• [ ] Providing the expansion or explanation of an abbreviation for the first occurrence of the abbreviation, If the abbreviation has only one meaning within the Web page. Using one of the following techniques:
  • Providing the first use of an abbreviation immediately before or after the expanded form to make the expanded form of an abbreviation available by associating the expanded form with its abbreviation the first time it occurs within a Web page
  • Linking to definitions To make the definition of a word, phrase, or abbreviation available by providing the definition, either within the same Web page or in a different Web page, and establishing a link between the item and its definition.
  • Providing definitions for abbreviations by using the abbr element to provide expansions or definitions for abbreviations by using the abbr element
• [ ] Providing the expansion or explanation of an abbreviation for all occurrence of the abbreviation, If the abbreviation has only one meaning within the Web page. Using one of the following techniques:
  • Linking to definitions
  • Providing a glossary
  • Using the link element to link to a glossary
  • Providing a function to search an online dictionary
  • Providing definitions for abbreviations by using the abbr element
• [ ] Providing the expansion or explanation of an abbreviation for all occurrence of the abbreviation, If the abbreviation means different things within the Web page. Using one of the following techniques:
  • Linking to definitions
  • Providing definitions for abbreviations by using the abbr element

Examples

Example: Providing the first use of an abbreviation immediately before or after the expanded form

"The United Nations High Commissioner for Human Rights (UNHCR) was established in 1950 to provide protection and assistance to refugees."

"The WAI (Web Accessibility Initiative) demonstrates the W3C commitment to accessibility."

Example: Using abbr element to expand abbreviations.

<p>Sugar is commonly sold in 5 <abbr title="pound">lb.</abbr> bags.</p>
<p>Welcome to the <abbr title="World Wide Web">WWW</abbr>!</p>       

Example: Using abbr element to define abbreviations.

<p>
   Tasini <abbr title="and others">et al.</abbr> <abbr title="versus">v.</abbr>
The New York Times <abbr title="and others">et al.</abbr> is the landmark lawsuit 
brought by members of the National Writers Union against ......
</p>  

Example 4: Using the abbr element to expand an initialism

 <p>
   <abbr title="World Wide Web">WWW</abbr>
</p>

Test Procedure

Providing the first use of an abbreviation immediately before or after the expanded form

For each abbreviation in the content,

1. Search for the first use of that abbreviation in the authored component.
2. Check that the first use is immediately preceded or followed by the expanded form of the abbreviation.
3. Check that the expanded form is the correct expanded form for the use of the abbreviation.

Expected Results: Checks 2 and 3 are true.

Linking to definitions

For each word, phrase, or abbreviation to be defined:

1. Check that at least the first instance of the item is a link.
2. Check that each link navigates to the definition of the item.

Expected Results: all are true.

using the abbr element

1. Check that an expansion or definition is provided for each abbreviation via abbr.

Expected Results: Check 1 is true.

Glossary

1. Check that either
   1. The glossary is included in the Web page, or
   2. A mechanism is available to locate the glossary.
2. Check that each word, phrase, or abbreviation to be defined is defined in the glossary
3. Check that the glossary contains only one definition for each item.

Expected Results: All three checks above are true.

Online dictionary

For each word, phrase, or abbreviation to be defined:

1. Check that a mechanism exists within the Web page to search for the word, phrase, or abbreviation via an on-line dictionary.
2. Check that the result of the search of the dictionary for the word, phrase, or abbreviation is the correct definition.

Expected Results: Checks 1 and 2 are true.

Using the link element to link to a glossary

For any set of words and their definitions that are meant to serve as a glossary:

1. Check that the head section of the Web page that contains words, phrases or abbreviations defined in a glossary contains a link element
2. Check that the link element has attribute rel="glossary"
3. Check that the href attribute of the link element refers to the glossary page.

Expected Results: all are true.

:busts_in_silhouette: Benefits

This Success Criterion may help people who:

• have difficulty decoding words;
• rely on screen magnifiers (magnification may reduce contextual cues);
• have limited memory;
• have difficulty using context to aid understanding.

[github-actions[bot]]

This Feature is ready to be implemented.