Merge pull request #142 from w3c/Clear-Meaning-V2

Clear meaning

how-to/outcomes/clear-meaning/clear-meaning.11tydata.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../build/get-outcome')(__dirname)
+}

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
+
+<div class="normative">
+
+### Guideline
+
+  <p>{{ outcome.description }}</p>
+
+<div class="nested">
+
+### 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.
+
+</div>
+
+### Supplimental Requirements
+
+<p class="ednote">None defined at this time.</p>
+
+### Assertions
+
+<p class="ednote">There will probably be a generic assertion based on style guides that applies to this guideline.</p>
+
+
+</div>
+
+## What to do
+
+<div class="nested">
+
+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.
+
+</div>
+
+## 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. 

how-to/outcomes/clear-meaning/methods.md

@@ -0,0 +1,20 @@
+---
+layout: layout/methods.md
+---
+
+
+## Foundational Requirements
+
+<div class="nested">
+
+- [Explain ambiguous text or provide an unambiguous alternative](explain-ambiguous-text)
+
+</div>
+
+## Supplimental
+
+<div class="nested">
+
+- None available
+
+</div>

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": "@@@"
+  }
+}

how-to/outcomes/clear-meaning/methods/explain-ambiguous-text/index.md

@@ -0,0 +1,27 @@
+---
+layout: method.html
+subtitle: Introduction
+---
+
+<dl class="method-card">
+  <div>
+    <dt>Level: Foundational</dt>
+    <dd>@@@</dd>
+  </div>
+</dl>
+
+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.

how-to/outcomes/clear-meaning/methods/methods.json

@@ -0,0 +1,3 @@
+{
+  "type": "method"
+}

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."
+}