Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reformat methods #558

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
9679fd5
Editorial fixes from PR#526
jspellman Jun 6, 2021
deb7509
Update Explainer from June 8 meeting
jspellman Jun 15, 2021
5818f8a
Update Explainer with Inclusion goal
jspellman Jun 16, 2021
22b144c
rename and update Resources page
fstrr Jul 16, 2021
5983fe2
initial commit of glossary page
fstrr Jul 16, 2021
65560ea
update description page
fstrr Jul 16, 2021
d157c87
delete into page
fstrr Jul 16, 2021
3e60b2d
fix copy and paste errors
fstrr Jul 16, 2021
89fb1f7
fixexed resources heading
fstrr Jul 20, 2021
555e673
add link to glossary
fstrr Jul 20, 2021
ae54b02
remove pdf from list of technologies
fstrr Jul 20, 2021
243196a
remove introduction link
fstrr Jul 20, 2021
4332491
update tests to include all relevant ACT tests
fstrr Jul 20, 2021
2036189
update glossary to add missing definitions.
fstrr Jul 20, 2021
9cd5e20
remove empty dependencies section
fstrr Jul 20, 2021
22ac9ca
whitespace tweak
fstrr Jul 20, 2021
c79c8fb
update tabs
fstrr Jul 21, 2021
192ad2d
Remove explainer edits from this methods PR
Jul 22, 2021
0948e2d
add link to WAI easy checks to test page.
fstrr Jul 26, 2021
b743f47
update proposal
fstrr Aug 2, 2021
896ae2a
fix mislabel of Examples
jspellman Sep 8, 2021
fe2314e
Update templates
jspellman Sep 8, 2021
8abd264
Images of Text update Index
jspellman Sep 21, 2021
4256946
update descriptions of images of text
jspellman Sep 22, 2021
09faa4c
Background
jspellman Sep 22, 2021
3c71e8a
added failure examples
jspellman Sep 22, 2021
d69f934
tests update
jspellman Sep 22, 2021
1880964
Added Glossary files
jspellman Sep 22, 2021
11aa3ed
description of caption reflow
jspellman Sep 23, 2021
09d8391
updated index
jspellman Sep 23, 2021
99078c8
filename to match content
Sep 24, 2021
fd69f13
picked up from act method proposal
Sep 24, 2021
860f053
Update TOCs
Sep 24, 2021
b1df891
introduction (back) to description
Sep 28, 2021
4af1703
renamed resources to background, added new sections
jspellman Sep 29, 2021
319d4cd
Updated examples
jspellman Sep 29, 2021
170223a
Update tests for reflow captions
jspellman Sep 29, 2021
7ba7e9f
Update Clear Words
jspellman Sep 29, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions explainer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h3>Structure of these guidelines</h3>
<p>Some of these sections are in this document. You can find others in links within the sections.</p>
</details>
<figure id="guidelines-structure-diagram" aria-labelledby="guidelines-structure-description" class="figure-float">
<img src="../guidelines/img/structure-core.svg" />
<img alt="" src="../guidelines/img/structure-core.svg" />
<figcaption>Core Structure</figcaption>
</figure>
<p><a href="#guidelines-structure-diagram">Figure 1</a> shows <span id="guidelines-structure-description">the core structure of WCAG 3.0. WCAG 3.0 has three levels of content with associated documentation. Guidelines form the top level. Each guideline contains multiple outcomes, with associated critical errors and outcomes scoring. Each outcome contains multiple methods, with an associated description and examples, tests, and test scoring.</span></p>
Expand Down Expand Up @@ -199,7 +199,7 @@ <h4>Outcome rating</h4>
<section>
<h3>Methods structure</h3>
<figure id="method_screenshot" aria-labelledby="method_screenshot_description" class="figure-float screenshot">
<img src="../guidelines/img/method.png" />
<img alt="" src="../guidelines/img/method.png" />
<figcaption>Screenshot of a Method for Structured Content</figcaption>
</figure>
<p>Each outcome has one or more <a href="#methods-structure">methods</a>. There are three types of methods:</p>
Expand Down Expand Up @@ -252,14 +252,14 @@ <h4>Additional Documentation and Scoring Information</h4>

<p>The core structure has inter-relationships with supporting documents and the scoring process. <span id="guidelines--full-structure-description"> Functional needs inform both outcomes and functional categories. The tests within methods are used to inform the scores for each outcome. Then outcome scores are aggregated to create scores by functional category and an overall score. These then result in a bronze rating. Silver and gold ratings build on the bronze rating to demonstrate improved accessibility. General information about guidelines is available in How To documents. </span></p>
<figure id="guidelines-full-structure-diagram" aria-labelledby="guidelines--full-structure-description" class="figure-full">
<img src="../guidelines/img/structure-scoring.svg" />
<img alt="" src="../guidelines/img/structure-scoring.svg" />
<figcaption>Documentation and Scoring Structure</figcaption>
</figure>
<section>
<h3>How tos</h3>
<p>The <a>How-To</a> content provides explanatory material for each guideline that applies across technologies. This guidance explains how to apply the concepts presented in the guidelines for non-technical readers. This plain language resource includes information on getting started, who the guideline helps and how, as well information for project managers, designers and developers.  </p>
<figure id="howTo_screenshot" aria-labelledby="howTo_screenshot_description" class="figure-float screenshot">
<img src="../guidelines/img/how-to.png" />
<img alt="" src="../guidelines/img/how-to.png" />
<figcaption>Example screenshot of a How-To for Structured Content</figcaption>
</figure>
<p id="howTo_screenshot_description">The example of a How-To for Structured Content provides basic information organized by tabs to help people get started with accessibility for structured content, plan for implementing accessible structured content across a project, design accessible structured content, and basics for developers new to accessibility of structured content. It also includes information on examples, the outcomes for meeting the guideline, and resources.</p>
Expand Down
4 changes: 2 additions & 2 deletions methods/audio-metadata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ <h1>Provides visual equivalent of speech and non-speech audio metadata</h1>
<main>
<!-- This list is for editorial convenience and will be converted to tabs by the generator -->
<ul>
<li><a href="intro.html">Introduction</a></li>
<li><a href="description.html">Description</a></li>
<li><a href="background.html">Background</a></li>
<li><a href="examples.html">Examples</a></li>
<li><a href="tests.html">Tests</a></li>
<li><a href="resources.html">Resources</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</main>
<footer>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,18 @@ <h2>Non-W3C Resources</h2>
<li><a href="https://www.bbc.co.uk/rd/blog/2014-10-tvx2014-short-paper-enhancing-subtitles">Enhancing Subtitles - BBC</a></li>
</ul>
</section>
<section id="accsupport">
<h2>Accessibility Support</h2>
<p> to be written
</p>
</section>
<section id="assumptions">
<h2>Assumptions</h2>
<ul>
<li>To be written [assumptions]</li>
</ul>
</section>

</main>
</body>
</html>
46 changes: 34 additions & 12 deletions methods/caption-reflow/description.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,50 @@ <h1>Description</h1>
</header>
<main>
<section id="outcome">
<h2>Outcome and Functional Categories</h2>
<h2>Outcome</h2>
<p>This method supports the outcome <a href="https://www.w3.org/WAI/GL/WCAG3/2020/outcomes/conveys-information-about-the-sound">Conveys information about the sound</a>.</p>
<p>Applies to immersive environments that support text equivalents (such as captions or transcripts) of audio track. </p>
</section>
<section id="details">
<h2>Detailed description</h2>
<section>
<h3>Maintaining reflow context in XR for Captions</h3>
<section id="platform">
<h2>Platform</h2>
<ul>
<li>Media players</li>
<li>Immersive technology engines</li>
</ul>
</section>
<section id="technology">
<h2>Technology</h2>
<ul>
<li>Media</li>
<li>XR</li>
</ul>
</section>
<section id="input_aspects">
<h2>Input aspects for testing</h2>
<ul>
<li>To be completed. [technical sources for input, such as DOM tree, Accessibility tree and CSS styling]</li>
</ul>
</section>
<section id="summary">
<h2>Summary</h2>
<p>Users with vision impairments may need to resize or reflow captions,
subtitling or other text. It is important that caption, subtitling or text can reflow (in context)
within an XR environment without loss of information, context or functionality.
</p>
<p>Content should not lose its context. This means that when captioning is related to speech they maintain their relationship with the source. If captioned text within the environment needs to be moved there is a persistent parent / child relationship between the related source and the related caption that enables either to be moved or other transformations to take place.</p>
<p>See <a href="https://github.com/w3c/silver/issues/139">https://github.com/w3c/silver/issues/139</a> for example of traditional content in XR environment</p>
</section>
<section>
<h3>Anti-Aliasing or use of vector graphics of Captions</h3>
<p>Depending on the environment - Captions should be resized without loss of quality. This may mean anti-aliasing options need to be available in XR or requiring the use of vector style graphics for captions and other text, which means they will resize more easily without loss of quality.</p>
</section>
</section>
<section id="dependencies">
<h2>Dependencies</h2>
<section id="user-need">
<h2>How it solves user need</h2>
<p>People can choose a font format or size of their choice or use a mechanism with accessible affordances. This will allow them to resize and reflow text without either hiding or obscuring the content or substantial loss of context. The means of choice can be via (choose at least one): </p>
<ul>
<li><p>None.</p> </li>
<li>user preference</li>
<li>personalization</li>
<li>other customisation setting</li>
</ul>
</section>
</main>
</body>
</html>
</html>
22 changes: 18 additions & 4 deletions methods/caption-reflow/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,29 @@
<h1>Examples</h1>
</header>
<main>
<section class="example">
<h3>Example 1</h3>
<section id="passed">
<h2>Passed</h2>
<section class="example">
<h3>Example 1</h3>
<p>A conversation is taking place between a group of people at a virtual meeting and a deaf user is tracking this discussion - there may be colour coding to distinguish the speakers and the caption colours may be related.</p>

<p>The deaf user may later wish to explore the environment or look at some thing - and therefore move focus from the speakers but dock the captions, or keep them in some bespoke view. Therefore the speaker source and ‘their’ captions relationship can be maintained.</p>

<p class="ednote">This relationship maybe as simple as a text saying ‘Speaker name: Lorraine’, ‘Speaker name: Ruairi’ or similar. Or could be provided in markup. Providing the association of ‘source/caption’ in markup would allow greater movement, and further potential transformations.</p>

</section>
</section>
</section>
<section id="failed">
<h2>Failed</h2>
<section class="example">
<p>To be written</p>
</section>
</section>
<section id="inapplicable">
<h2>Inapplicable</h2>
<section class="example">
<p>To be written</p>
</section>
</section>
</main>
</body>
</html>
17 changes: 17 additions & 0 deletions methods/caption-reflow/glossary.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Method - Glossary</title>
</head>
<body>
<header>
<h1>Glossary</h1>
</header>
<main>
<section id="[term]-def">
<h2>[term]</h2>
<p>[definition] To be completed. </p>
</section>
</main>
</body>
</html>
6 changes: 4 additions & 2 deletions methods/caption-reflow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ <h1>Caption reflow</h1>
<main>
<!-- This list is for editorial convenience and will be converted to tabs by the generator -->
<ul>
<li><a href="intro.html">Introduction</a></li>
<li><a href="description.html">Description</a></li>
<li><a href="background.html">Background</a></li>
<li><a href="examples.html">Examples</a></li>
<li><a href="tests.html">Tests</a></li>
<li><a href="resources.html">Resources</a></li>
<li><a href="glossary.html">Glossary</a></li>

</ul>
</main>
<footer>
Expand All @@ -26,6 +27,7 @@ <h2>Status</h2>
<h2>Change Log</h2>
<ul>
<li>2020-09-10: Draft</li>
<li>2021-09-22: Reformatted to ACT Method design</li>
</ul>
</section>
</footer>
Expand Down
15 changes: 15 additions & 0 deletions methods/caption-reflow/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@
<h1>Introduction</h1>
</header>
<main>
<section id="outcome">
<h2>Outcome and Functional Categories</h2>
<p>This method supports the outcome <a href="https://www.w3.org/WAI/GL/WCAG3/2020/outcomes/conveys-information-about-the-sound">Conveys information about the sound</a>.</p>
<p>Applies to immersive environments that support text equivalents (such as captions or transcripts) of audio track. </p>
</section>
<section id="platform">
<h2>Platform</h2>
<ul>
Expand All @@ -22,12 +27,22 @@ <h2>Technology</h2>
<li>XR</li>
</ul>
</section>
<section id="input_aspects">
<h2>Input aspects for testing</h2>
<ul>
<li>To be completed. [technical sources for input, such as DOM tree, Accessibility tree and CSS styling]</li>
</ul>
</section>
<section id="summary">
<h2>Summary</h2>
<p>Users with vision impairments may need to resize or reflow captions,
subtitling or other text. It is important that caption, subtitling or text can reflow (in context)
within an XR environment without loss of information, context or functionality.
</p>
<p>Content should not lose its context. This means that when captioning is related to speech they maintain their relationship with the source. If captioned text within the environment needs to be moved there is a persistent parent / child relationship between the related source and the related caption that enables either to be moved or other transformations to take place.</p>
<p>See <a href="https://github.com/w3c/silver/issues/139">https://github.com/w3c/silver/issues/139</a> for example of traditional content in XR environment</p>
<p>Depending on the environment - Captions should be resized without loss of quality. This may mean anti-aliasing options need to be available in XR or requiring the use of vector style graphics for captions and other text, which means they will resize more easily without loss of quality.</p>
</section>
</section>
<section id="user-need">
<h2>How it solves user need</h2>
Expand Down
28 changes: 19 additions & 9 deletions methods/caption-reflow/tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,32 @@
<h1>Tests</h1>
</header>
<main>
<section id="atomic">
<h2>Atomic Tests</h2>
<section id="get_started">
<h2>Get Started</h2>
<p>To be written</p>
</section>
<section id="summary">
<h2>Summary</h2>
<p>To be written [overview of the test]</p>
</section>
<section id="applicability">
<h2>Applicability</h2>
<p>To be written: This outcome applies to any [element names] element that is [condition] and for which one of the following is true:
<dl>
<dt>{excluded, ignored, exception}</dt>
<dd>[element]
</dl>
</section>
<section id="expectations">
<h2>Expectations</h2>
<p>To be written. [detail of the expectation] Tests from First Public Working Draft: </p>
<ul>
<li>Check that there is support for captioning and subtitling of multimedia content.</li>
<li>Check that there is support for reflow of captions and other text.</li>
<li>Check that a mechanism exists to reveal further text within the XR environment without the need to scroll.</li>
<li>Check that there are semantics present that define context and relationships between related captions, subtitles and their source.</li>
<li>Check that where captions and other text may be placed on a second screen, context and source information is maintained.</li>
</ul>
</section>
<section id="holistic">
<h2>Holistic Tests</h2>
<ul>
<li>Still to be developed. We will include this in a future working draft. </li>
</ul>
</section>
</main>
</body>
</html>
4 changes: 2 additions & 2 deletions methods/clear-words/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ <h1>Clear words</h1>
<main>
<!-- This list is for editorial convenience and will be converted to tabs by the generator -->
<ul>
<li><a href="intro.html">Introduction</a></li>
<li><a href="description.html">Description</a></li>
<li><a href="background.html">Background</a></li>
<li><a href="examples.html">Examples</a></li>
<li><a href="tests.html">Tests</a></li>
<li><a href="resources.html">Resources</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</main>
<footer>
Expand Down
23 changes: 21 additions & 2 deletions methods/clear-words/intro.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Method - Introduction</title>
<title>Method - Description</title>
</head>
<body>
<header>
<h1>Introduction</h1>
<h1>Description</h1>
</header>
<main>
<section id="outcome">
<h2>Outcome</h2>
<p>This method supports the outcome: <a href="../../outcomes/common-clear-words.html" class="outcome-link">Common clear words</a></p>
</section>
<section id="platform">
<h2>Platform</h2>
<ul>
Expand All @@ -23,11 +27,26 @@ <h2>Technology</h2>
<section id="summary">
<h2>Summary</h2>
<p>Clear words help create more accessible content for people with cognitive and learning disabilities. Use words or phrases that are most-frequently used for the current context, unless it will result in a loss of meaning or clarity. </p>

<p><strong>Clear and common words:</strong> Use words or phrases that are most-frequently used for the current context, unless it will result in a loss of meaning or clarity. This includes not using abbreviations, words, or phrases, unless they are the common form to refer to concepts for beginners. Where word frequencies are known for the context, they can be used. An example would be the <a href="https://learnersdictionary.com/3000-words">Merriam Webster 3000 Core English Vocabulary Words</a>. </p>
<p>Even languages with a small number of users have published lists of most-frequent words (such as Hebrew). If there is a natural language that does not have such a list, algorithms exist that calculate these lists for languages, or for specific contexts. Testing content against these word lists can be done manually. </p>
<p><strong>Define unusual words:</strong> It is best to define technical or jargon words in context so that the user does not have to navigate away from the text to a glossary in a different location. There are a variety of possible solutions for defining words in context, including the use of a pop-up definition. </p>
<p><strong>Provide a glossary:</strong> A glossary is typically an alphabetical list of terms related to a given set of content. </p>
</section>
<section id="user-need">
<h2>How it solves user need</h2>
<p>Using clear and common words makes content easier to read and to understand. </p>
</section>
<section id="input_aspects">
<h2>Input aspects for testing</h2>
<ul>
<li>Not written [technical sources for input, such as DOM tree, Accessibility tree and CSS styling]</li>
</ul>
</section>
<section id="when-to-use">
<h2>When to use</h2>
<p>Not written yet {when the method should or should not be used}</p>
</section>
</main>
</body>
</html>
Loading