Unusual Words

[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.3 A mechanism is available for identifying specific definitions of words or phrases used in an unusual or restricted way, including idioms and jargon.

• [ ] Providing the definition of a word or phrase used in an unusual or restricted way for the first occurrence of the word or phrase, If the word or phrase has a unique meaning within the Web page. Using one of the following techniques
  • 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.
    • Using description list dt
    • Using the link element to link a glossary
  • Using inline definitions with dfn elements
  • Providing a glossary
  • Providing a function to search an online dictionary This technique uses existing resources on the Web to provide the definition rather than requiring the author to create a glossary or other mechanism within the site. By providing access from within the Web page, a user can easily locate the desired definition. This technique can only be used if the online dictionary returns the correct definition.
• [ ] Providing the definition of a word or phrase used in an unusual or restricted way for each occurrence of the word or phrase, If the word or phrase means different things within the same Web page. Using one of the following techniques
  • Linking to definitions
    • Using description list dt
    • Using the link element to link a glossary
  • Providing a glossary
  • Providing a function to search an online dictionary

Example: A list of descriptions of nautical terms used on a Website about sailing.

<dl title="Nautical terms">
  <dt>Knot</dt>
  <dd>
    <p>A <em>knot</em> is a unit of speed equaling 1 
      nautical mile per hour (1.15 miles per hour or 1.852 
      kilometers per hour).</p>
  </dd>
  <dt>Port</dt>
  <dd>
    <p><em>Port</em> is the nautical term (used on 
      boats and ships) that refers to the left side
      of a ship, as perceived by a person facing towards 
      the bow (the front of the vessel).</p>
  </dd>
  <dt>Starboard</dt>
  <dd>
    <p><em>Starboard</em> is the nautical term (used 
      on boats and ships) that refers to the right 
      side of a vessel, as perceived by a person 
      facing towards the bow (the front of the vessel).</p>
  </dd>
</dl>  

Example: Using the link element to link to a glossary

<link rel="glossary" href="https://www.w3.org/TR/WCAG20/#glossary">

Example 1: Use of the dfn element.

<p>The Web Content Accessibility Guidelines require that non-text content
has a text alternative. <dfn>Non-text content</dfn> is content that is not a sequence
of characters that can be programmatically determined or where the sequence is
not expressing something in human language; this includes ASCII Art (which is a
pattern of characters), emoticons, leetspeak (which is character substitution), and
images representing text .</p> 

Tests Procedure

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 description lists

For any set of terms and their associated descriptions:

1. Check that the list is contained within a dl element.
2. Check that each term in the list being described is contained within a dt element.
3. Check that when there is more than one term that shares the same description that the dt elements immediately follow each other.
4. Check that the description for each term is contained in one or more dd elements.
5. Check that the one or more dd elements immediately follow the one or more dt elements containing the term being described.

Expected Results: all 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.

Using the dfn element to identify the defining instance of a word

1. Identify all words that are defined inline in the text, that is, where the definition occurs in a sentence near an occurrence of the word.
2. Check that each word that is defined inline is contained in a dfn element.

Expected Results: 2 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.

---

:busts_in_silhouette: Benefited Users

This Success Criterion may help people with cognitive, language and learning disabilities who:

• have difficulty decoding words
• have difficulty understanding words and phrases
• have difficulty using context to aid understanding

It would also help people with visual disabilities who:

• lose context when zoomed-in with a screen magnifier

[github-actions[bot]]

This Feature is ready to be implemented.