Skip to content

Commit

Permalink
Merge pull request #143 from w3c/ux-guide-new-versoin
Browse files Browse the repository at this point in the history 
Edits discussed in editors' call
  • Loading branch information
@gregoriopellegrino
gregoriopellegrino authored Jan 25, 2023
2 parents ab1d808 + 296ba55 commit 02fb580
Showing 1 changed file with 23 additions and 52 deletions.
75 changes: 23 additions & 52 deletions UX-Guide-Metadata/draft/principles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,29 +153,9 @@ <h2>Discovering Accessible Content</h2>
<section id="ui-technical-details">
<h2>UI Technical Details</h2>
<p>When you have accessibility metadata about a digital publication, it is important to share this information in as user-friendly a way as possible. At a very high level, when displaying information about a digital publication, you may only want to acknowledge that <q>Accessibility Features</q> or <q>Accessibility Information</q> is available. If the user would like to get at this information, they can click a text or image link which will then provide the information that is discussed below.</p>

<div class="note">
<p>When a publisher does not provide any accessibility metadata for a publication, a statement should be displayed to the user informing them that no information was supplied.</p>
</div>

<p>In this example, a link to the accessibility information is provided with a traditional textual link.</p>
<aside class="example">
<p>Title: Huckleberry Finn</p>
<p>Author: Mark Twain</p>
<p>Copyright: 1999</p>
<p>ISBN: 9780486110035</p>
<p>Publisher: Dover Publications</p>
<p>Book Features: <u>Accessibility Information</u>
<i>(textual link to accessibility information below)</i></p>
</aside>
<p>Alternatively, this link to the accessibility information could be provided with a clickable image.</p>
<aside id="ex-bookFeatures" class="example">
<p>Book Features:</p>
<p><img src="./media/accessibility.svg" alt="Accessibility Information" width="75" /></p>
<p><i>(clickable image to accessibility information below)</i></p>
<p><i>Suggested Alt-text for image <q>Accessibility Information</q></i></p>
</aside>

<section id="techniques">
<h3>Techniques</h3>
<p>To assist developers in implementing these guidelines, in-depth notes are available to explain how to extract information from publishing industry metadata standards.</p>
Expand All @@ -185,41 +165,11 @@ <h3>Techniques</h3>
<li><p><a href="../techniques/onix-metadata/index.html">ONIX Accessibility Metadata</a></p></li>
</ul>
</section>


</section>

<section id="order-of-key-information">
<h2>Order of Key Information</h2>
<p>
Ordering the supplied metadata in a meaningful and consistent way for users helps them easily understand the
strengths and weaknesses of each publication. Consequently, the most important information appears first to help the user quickly determine if the publication will meet their specific needs.</p>

<p>The recommended ordering of information is as follows:</p>

<ol type="1">
<li><p><a href="#screen-reader-friendly">Screen Reader Friendly</a></p></li>
<li><p><a href="#full-audio">Full Audio</a> (if present)</p></li>
<li><p><a href="#accessibility-summary">Accessibility Summary</a></p></li>
<li><p><a href="#accessibility-conformance">Accessibility Conformance</a></p></li>
<li><p><a href="#certified-by">Certified By</a></p></li>
<li><p><a href="#certifier-credential">Certifier’s Credential</a></p></li>
<li><p><a href="#certifier-report">Certifier’s Report</a> (if present)</p></li>
<li><p><a href="#hazards">Hazards</a></p></li>
<li><p><a href="#all-accessibility-metadata">All Accessibility Metadata</a></p></li>
</ol>

<p>
The two most important accessibility accommodations to list are if the publication is <q>Screen Reader Friendly</q> and has <q>Full Audio</q>. A screen reader friendly publication implies all text is accessible and any images are described, if necessary. A publication that indicates it includes full audio lets the user will know the entire publication can be read through audio playback.
</p>
<p>
The next important piece is the Accessibility Summary which is metadata describing all the accessibility accommodations provided by this publication.
Following this are the accessibility conformance information (what level of conformance was reached, who certified it, and any certification credentials).
</p>
<p>
Finally displaying any hazards if present and linking to all the accessibility metadata including all the specific accessibility features such as: image descriptions, MathML, a table of contents, etc.
</p>
<p>More detailed information about these fields is provided in the following sections.</p>
<h2>Key Information</h2>


<section id="screen-reader-friendly">
<h3>Screen Reader Friendly</h3>
Expand Down Expand Up @@ -365,6 +315,27 @@ <h4>Implementation</h4>
</section>

</section>

<section id="examples">
<h2>Examples</h2>
<p>In this example, a link to the accessibility information is provided with a traditional textual link.</p>
<aside class="example">
<p>Title: Huckleberry Finn</p>
<p>Author: Mark Twain</p>
<p>Copyright: 1999</p>
<p>ISBN: 9780486110035</p>
<p>Publisher: Dover Publications</p>
<p>Book Features: <u>Accessibility Information</u>
<i>(textual link to accessibility information below)</i></p>
</aside>
<p>Alternatively, this link to the accessibility information could be provided with a clickable image.</p>
<aside id="ex-bookFeatures" class="example">
<p>Book Features:</p>
<p><img src="./media/accessibility.svg" alt="Accessibility Information" width="75" /></p>
<p><i>(clickable image to accessibility information below)</i></p>
<p><i>Suggested Alt-text for image <q>Accessibility Information</q></i></p>
</aside>
</section>

<section id="app-acknowledgements" class="appendix informative">
<h2 id="acknowledgements">Acknowledgements</h2>
Expand Down

0 comments on commit 02fb580

Please sign in to comment.