From 25e0e5c66e1c9d1ff585871bbe5c4e48cf0a0ea7 Mon Sep 17 00:00:00 2001 From: Alastair Campbell Date: Sat, 23 Nov 2024 20:02:52 +0000 Subject: [PATCH 1/2] Initial draft --- .../clear-meaning/implied-meaning.11tydata.js | 3 + how-to/outcomes/clear-meaning/index.md | 83 +++++++++++++++++++ how-to/outcomes/clear-meaning/methods.md | 27 ++++++ .../complex-images/complex-images.json | 8 ++ .../methods/complex-images/index.md | 18 ++++ .../clear-meaning/methods/methods.json | 3 + how-to/outcomes/clear-meaning/outcome.json | 5 ++ 7 files changed, 147 insertions(+) create mode 100644 how-to/outcomes/clear-meaning/implied-meaning.11tydata.js create mode 100644 how-to/outcomes/clear-meaning/index.md create mode 100644 how-to/outcomes/clear-meaning/methods.md create mode 100644 how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json create mode 100644 how-to/outcomes/clear-meaning/methods/complex-images/index.md create mode 100644 how-to/outcomes/clear-meaning/methods/methods.json create mode 100644 how-to/outcomes/clear-meaning/outcome.json diff --git a/how-to/outcomes/clear-meaning/implied-meaning.11tydata.js b/how-to/outcomes/clear-meaning/implied-meaning.11tydata.js new file mode 100644 index 0000000..baddaa9 --- /dev/null +++ b/how-to/outcomes/clear-meaning/implied-meaning.11tydata.js @@ -0,0 +1,3 @@ +module.exports = { + ...require('../../build/get-outcome')(__dirname) +} diff --git a/how-to/outcomes/clear-meaning/index.md b/how-to/outcomes/clear-meaning/index.md new file mode 100644 index 0000000..a17fbc6 --- /dev/null +++ b/how-to/outcomes/clear-meaning/index.md @@ -0,0 +1,83 @@ +--- +layout: outcome.html +--- + +## Goal + +To help people understand text: +* Use literal language, or +* Explain the implied meaning of non-literal language. + +Making non-literal or figurative language easier to understand helps people with cognitive disabilities as well as neurodivergent people, such as those who are autistic and may be so focused on the literal meaning that they may not notice the implied meaning. + +Explaining or avoiding non-literal language can also help: +* Non-native language speakers +* People of different ages or generations +* People from different cultural backgrounds + +## Normative text + +
+ +### Guideline + +

{{ outcome.description }}

+ +
+ +### Foundational Requirements + +For each item of ambiguous text, such as non-literal text, abbreviations and acronyms, ambiguous numbers, or text missing letters or diacritics: + +1. Is the non-literal text presented in a way that is available to user agents, including assistive technology (AT)? + 1. Yes, view meets *Text is programmatically determinable*, continue. + 2. No, continue to step 3. +2. Does the *accessibility support set* meet *Explain ambiguous text or provide an unambiguous alternative*? + 1. Yes, pass. + 2. No, continue. +3. Does the publisher sufficiently explain the non-literal text or provide a literal alternative? + 1. Yes, view meets *Explain non-literal text or provide a literal alternative*, pass. + 2. No, fail. + +#### Exceptions +* If the purpose is to showcase works of art or fiction, such as a poetry journal or fictional stories, this guideline does not apply; however, if the purpose is to educate students about pieces of art, then this guideline applies. + +
+ +### Supplimental Requirements + +

None defined at this time.

+ +### Assertions + +

There will probably be a generic assertion based on style guides that applies to this guideline.

+ + +
+ +## What to do + +
+ +Determine if the text has words or phrases that: +* Hint at a meaning that is not directly stated, or +* Can have more than one meaning, such as working on a literal and figurative level at the same time. Example in English: “The chef cuts corners when slicing the fish.” Non-literal: The chef is preparing the fish in an easy or cheap way. Literal: The chef is cutting the fish into shapes that don’t have sharp corners. + +When checking for non-literal text, also consider how sentences are combined together, such as if a word in one sentence is critical to accurately understanding the meaning of a later sentence. + +If the text has implied meaning, explain it or provide a literal alternative using one of the techniques in the [Methods](.methods/) section. + +
+ +## Definitions + +- **Back translation** is a two-step process of translating text into another language and then back to its original language. Also called reverse translation, this process can help identify phrases that may lose their intended meaning when translated. +- **Content publisher** The creative individual or organization responsible for curating, producing, and distributing various forms of content to engage and inform audiences. Includes tools used by the publisher such as HTML and JSON and content management systems like Wix and WordPress. +- **Emoji character** An emoji character is a small digital image with Unicode for its literal meaning, such as 🌴(“Palm tree”). But emojis often have implied meaning that users may need help understanding. Common examples of emojis used in non-literal ways: + - 💯(“Hundred points”) can be used in various ways, such as to indicate a perfect score or complete agreement. + - 🙃 (“Upside-down face”) is often used to indicate sarcasm or silliness. +- **Literal text** uses the direct meaning of words to convey exactly what is written. Unlike non-literal or figurative language, literal text does not have implied meaning. +- **Non-literal text** uses words or phrases in a way that goes beyond their standard or dictionary meaning to express deeper, more complex ideas. This is also called figurative language. To understand it, users have to interpret the implied meaning behind the words, rather than just their literal or direct meaning. + - Examples: Allusions, hyperbole, idioms, irony, jokes, litotes, metaphors, metonymies, onomatopoeias, oxymorons, personification, puns, sarcasm, and similes. More detailed examples are available in the [Methods](.methods/) section. +- **User agent** W3C defines user agent as any software that retrieves, renders, and facilitates end-user interaction with Web content, or whose user interface is implemented using Web technologies. +Examples: Web browsers, media players, operating system shells, plug-ins, consumer electronics with Web-widgets, and stand-alone applications or embedded applications that help in retrieving, rendering, and interacting with Web content. \ No newline at end of file diff --git a/how-to/outcomes/clear-meaning/methods.md b/how-to/outcomes/clear-meaning/methods.md new file mode 100644 index 0000000..cc966db --- /dev/null +++ b/how-to/outcomes/clear-meaning/methods.md @@ -0,0 +1,27 @@ +--- +layout: layout/methods.md +--- + +## Decision tree + +The approach to a text alternative depends on the type of image and how it is used. + +The following decision tree is used to determine the appropriate method. + +For each image: + +
+ +1. Would removing the image impact how people understand the page? (Prerequisite) + 1. No, image must meet [Decorative images](decorative-images) [stop] + 2. Yes, continue + +2. Is the image presented in a way that is available to user agents and assistive technology? (Prerequisite) + 1. Yes, image must meet [@@@ programatic availability] image AND the [accessibility support set] incorporates [Equivalent alternative text](equivalent-alternative-text). [stop] + 2. No, continue + +3. Is an equivalent text alternative available for the image? (Baseline) + 1. Yes, image must meet [Equivalent alternative text](equivalent-alternative-text) [stop] + 2. No, fail + +
\ No newline at end of file diff --git a/how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json b/how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json new file mode 100644 index 0000000..bcfc97d --- /dev/null +++ b/how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json @@ -0,0 +1,8 @@ +{ + "method": { + "index": 1, + "title": "Complex images", + "slug": "complex-images", + "description": "@@@" + } +} diff --git a/how-to/outcomes/clear-meaning/methods/complex-images/index.md b/how-to/outcomes/clear-meaning/methods/complex-images/index.md new file mode 100644 index 0000000..5a51975 --- /dev/null +++ b/how-to/outcomes/clear-meaning/methods/complex-images/index.md @@ -0,0 +1,18 @@ +--- +layout: method.html +subtitle: Introduction +--- + +
+
+
Level:
+
@@@
+
+
+ +## Techniques + +* **Author technique (General):** Include text that provides equivalent information in a show/hide element near the image. +* **Author technique (General):** Include structured text information that provides equivalent information for the image. +* **Platform:** User-agents provide descriptions of the image [future method? And requires “accessibility supported”]. +* **Author technique (General):** For artistic content (where the image conveys a aesthetic or emotional content that has no equivalent), include text that provides descriptive information near the image. \ No newline at end of file diff --git a/how-to/outcomes/clear-meaning/methods/methods.json b/how-to/outcomes/clear-meaning/methods/methods.json new file mode 100644 index 0000000..f25a945 --- /dev/null +++ b/how-to/outcomes/clear-meaning/methods/methods.json @@ -0,0 +1,3 @@ +{ + "type": "method" +} \ No newline at end of file diff --git a/how-to/outcomes/clear-meaning/outcome.json b/how-to/outcomes/clear-meaning/outcome.json new file mode 100644 index 0000000..7e07730 --- /dev/null +++ b/how-to/outcomes/clear-meaning/outcome.json @@ -0,0 +1,5 @@ +{ + "index": 0, + "title": "Clear Meaning", + "description": "Users can access explanations of or alternatives to ambiguous text content." +} From 5f1cdc98616f2711bdad93f92e4d5ff109be2aa2 Mon Sep 17 00:00:00 2001 From: Alastair Campbell Date: Sat, 23 Nov 2024 20:34:44 +0000 Subject: [PATCH 2/2] Updating methods --- ....11tydata.js => clear-meaning.11tydata.js} | 0 how-to/outcomes/clear-meaning/methods.md | 21 +++++---------- .../complex-images/complex-images.json | 8 ------ .../methods/complex-images/index.md | 18 ------------- .../explain-ambiguous-text.json | 8 ++++++ .../methods/explain-ambiguous-text/index.md | 27 +++++++++++++++++++ 6 files changed, 42 insertions(+), 40 deletions(-) rename how-to/outcomes/clear-meaning/{implied-meaning.11tydata.js => clear-meaning.11tydata.js} (100%) delete mode 100644 how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json delete mode 100644 how-to/outcomes/clear-meaning/methods/complex-images/index.md create mode 100644 how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/explain-ambiguous-text.json create mode 100644 how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/index.md diff --git a/how-to/outcomes/clear-meaning/implied-meaning.11tydata.js b/how-to/outcomes/clear-meaning/clear-meaning.11tydata.js similarity index 100% rename from how-to/outcomes/clear-meaning/implied-meaning.11tydata.js rename to how-to/outcomes/clear-meaning/clear-meaning.11tydata.js diff --git a/how-to/outcomes/clear-meaning/methods.md b/how-to/outcomes/clear-meaning/methods.md index cc966db..24f8cbc 100644 --- a/how-to/outcomes/clear-meaning/methods.md +++ b/how-to/outcomes/clear-meaning/methods.md @@ -2,26 +2,19 @@ layout: layout/methods.md --- -## Decision tree -The approach to a text alternative depends on the type of image and how it is used. +## Foundational Requirements -The following decision tree is used to determine the appropriate method. +
-For each image: +- [Explain ambiguous text or provide an unambiguous alternative](explain-ambiguous-text) -
+
-1. Would removing the image impact how people understand the page? (Prerequisite) - 1. No, image must meet [Decorative images](decorative-images) [stop] - 2. Yes, continue +## Supplimental -2. Is the image presented in a way that is available to user agents and assistive technology? (Prerequisite) - 1. Yes, image must meet [@@@ programatic availability] image AND the [accessibility support set] incorporates [Equivalent alternative text](equivalent-alternative-text). [stop] - 2. No, continue +
-3. Is an equivalent text alternative available for the image? (Baseline) - 1. Yes, image must meet [Equivalent alternative text](equivalent-alternative-text) [stop] - 2. No, fail +- None available
\ No newline at end of file diff --git a/how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json b/how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json deleted file mode 100644 index bcfc97d..0000000 --- a/how-to/outcomes/clear-meaning/methods/complex-images/complex-images.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "method": { - "index": 1, - "title": "Complex images", - "slug": "complex-images", - "description": "@@@" - } -} diff --git a/how-to/outcomes/clear-meaning/methods/complex-images/index.md b/how-to/outcomes/clear-meaning/methods/complex-images/index.md deleted file mode 100644 index 5a51975..0000000 --- a/how-to/outcomes/clear-meaning/methods/complex-images/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method.html -subtitle: Introduction ---- - -
-
-
Level:
-
@@@
-
-
- -## Techniques - -* **Author technique (General):** Include text that provides equivalent information in a show/hide element near the image. -* **Author technique (General):** Include structured text information that provides equivalent information for the image. -* **Platform:** User-agents provide descriptions of the image [future method? And requires “accessibility supported”]. -* **Author technique (General):** For artistic content (where the image conveys a aesthetic or emotional content that has no equivalent), include text that provides descriptive information near the image. \ No newline at end of file diff --git a/how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/explain-ambiguous-text.json b/how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/explain-ambiguous-text.json new file mode 100644 index 0000000..0706d6a --- /dev/null +++ b/how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/explain-ambiguous-text.json @@ -0,0 +1,8 @@ +{ + "method": { + "index": 1, + "title": "Explain ambiguous text or provide an unambiguous alternative", + "slug": "explain-ambiguous-text", + "description": "@@@" + } +} diff --git a/how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/index.md b/how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/index.md new file mode 100644 index 0000000..9a3fcbe --- /dev/null +++ b/how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/index.md @@ -0,0 +1,27 @@ +--- +layout: method.html +subtitle: Introduction +--- + +
+
+
Level: Foundational
+
@@@
+
+
+ +Determine if the text has: +- non-literal text, +- abbreviations and acronyms, +- ambiguous numbers, or +- text missing letters or diacritics + +If the text is ambiguous, explain it or provide an alternative using one of the techniques in the techniques section. + + + +## Techniques + +* **Author technique (General):** Spell out the meaning in brackens after the first use. +* **Author technique (General):** Linking to a glossary. +* **Author technique (HTML):** Include text that explains the meaning using an abbriviation. \ No newline at end of file