Skip to content

Commit

Permalink
Merge pull request #218 from w3c/langreview
Browse files Browse the repository at this point in the history 
Full review for language consistency
  • Loading branch information
@GeorgeKerscher
GeorgeKerscher authored Nov 29, 2023
2 parents bf022bb + 5b1eab1 commit 4ff096e
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions UX-Guide-Metadata/draft/principles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
independent organizations.</p>

<p>This document proposes a shared framework for presenting publication accessibility metadata in a
user-friendly manner, so as to offer the information to end users in a way that is easy for them to understand (even to the less technical) and consistent across different publications and different digital catalogs.</p>
user-friendly manner, so as to offer the information to end users in a way that is easy for them to understand (even for the less technical) and consistent across different publications and different digital catalogs.</p>
</section>
<section id="sotd"></section>
<section id="general-overview">
Expand Down Expand Up @@ -150,7 +150,7 @@ <h3>Metadata techniques</h3>
<section id="general-info">
<h2>General information (supplement the bibliographic information)</h2>
<p>
The product details are giving precious information about usability of the book in relation with specifics needs. The following informations should always be displayed:
The product details provide precious information about the usability of the book in relation to specific user needs. The following informations should always be displayed:
<ul>
<li>
File format (EPUB, PDF, MP3, Audiobook, etc.)
Expand All @@ -174,22 +174,22 @@ <h2>General information (supplement the bibliographic information)</h2>
<summary>
Why this information is important for accessibility?
</summary>
</detail>
George asks why is details used here?</detail>
<ul>
<li>
The file format gives a strong indication of accessibility: an MP3 format audio book will be less structured than an Audiobook; a PDF does not allows for fine typography tunning, etc.
The file format gives a strong indication of accessibility: an MP3 format audio book will be less structured than an Audiobook; a PDF does not allow for typography modification, etc.
</li>
<li>
The protection measure may block assistive technologies such as screen readers. In addition, many specific reading devices such as DAISY readers or Braille notepads are not equipped to read encrypted files.
</li>
<li>
The publication date gives an indication of when the files were produced. A book published before 2011 will probably be an EPUB2 file including poor semantics, and a book published in 2022 will be more likely to be correctly structured and benefit of strong semantics.
The publication date gives an indication of when the files were produced. A book published before 2011 will probably be an EPUB2 file including poor semantics, and a book published in 2022 will be more likely to be correctly structured and benefit from strong semantics.
</li>
<li>
The name of the publishing house can highlight the efforts it has made in terms of accessibility.
</li>
<li>
The main language of the content enables readers to be sure that they will be able to read in good conditions by checking that they have a synthesised voice or the corresponding Braille table.
The main language of the content enables readers to be confident that they will be able to read with their Assistive Technology that uses synthesised voice or the corresponding Braille table for the language.
</li>
</ul>

Expand All @@ -199,7 +199,7 @@ <h2>General information (supplement the bibliographic information)</h2>
<h2>Key accessibility information</h2>

<div class="note">
<p>When the content creator does not provide any accessibility metadata for a publication, should still be shown the three pieces of information that should always be present (with an indication of whether the information is missing): <a href="#supports-nonvisual-reading">Supports nonvisual reading</a>, <a href="#visual-adjustments">Visual adjustments</a> and <a href="#conformance-group">Conformance</a>.</p>
<p>When the content creator does not provide any accessibility metadata for a publication, the three pieces of key information that should always be present can still be shown (with an indication that the information is missing): <a href="#supports-nonvisual-reading">Supports nonvisual reading</a>, <a href="#visual-adjustments">Visual adjustments</a> and <a href="#conformance-group">Conformance</a>.</p>
</div>

<div class="note">
Expand All @@ -211,7 +211,7 @@ <h2>Key accessibility information</h2>
<h3>Supports nonvisual reading</h3>

<div class="note">
<p>This key information should always be shown displayed, even if there is no metadata (with the relevant wording).</p>
<p>This key information should always be displayed, even if there is no metadata (with the relevant wording).</p>
</div>

<p>Indicates whether all content required for comprehension can be consumed in text and therefore is
Expand All @@ -233,9 +233,9 @@ <h4>Examples</h4>

<aside class="example" title="Descriptive explanations">
<ul>
<li>All content is available in generated read aloud and electronic braille.</li>
<li>Portions of the content may not be available in generated read aloud and electronic braille.</li>
<li>Not all the content will be available in generated read aloud and electronic braille.</li>
<li>All content is available in generated read aloud speech and electronic braille.</li>
<li>Portions of the content may not be available in generated read aloud speech and electronic braille.</li>
<li>Not all of the content will be available in generated read aloud speech and electronic braille.</li>
</ul>
</aside>

Expand Down Expand Up @@ -276,7 +276,7 @@ <h3>Pre-recorded audio</h3>
accessibility options in the future.</p>

<p>Some publications provide audio (including in video) in addition to text. In this case, it is
important that the user gets informed as they may not be able to access all content in the book. </p>
important that the user is informed that they may not be able to access all content in the book. </p>

<p>Some publications provide pre-recorded audio with text synchronization.
Users with hearing impairments still can access the full content of these books.</p>
Expand Down Expand Up @@ -319,7 +319,7 @@ <h4>Metadata techniques</h4>
<h3>Visual adjustments</h3>

<div class="note">
<p>This key information should always be shown displayed, even if there is no metadata (with the relevant wording).</p>
<p>This key information should always be displayed, even if there is no metadata (with the relevant wording).</p>
</div>

<p>Indicates if users can modify the appearance of the text and the page layout according to the
Expand All @@ -331,7 +331,7 @@ <h3>Visual adjustments</h3>
text and its background (contrast), the font family and font size used, as well as spacing between
letters, words, sentences, or paragraphs.</p>

<p><!--this one might be moved to the technics-->Knowing that a publication can reflow to fit the
<p><!--this one might be moved to the techniques-->Knowing that a publication can reflow to fit the
reading system's display area is not sufficient to know that modifications to the font, spacing, and
colors are possible or that the changes will not cause other readability issues (e.g., text being
clipped by its container).</p>
Expand All @@ -346,7 +346,7 @@ <h4>Examples</h4>
<ul>
<li>Appearance of the text and page layout can be modified according to the capabilities of
the reading system (font family and font size, spaces between paragraphs, sentences,
word, and letter, as well as color of background and texts).</li>
words, and letters, as well as color of background and text).</li>
<li>Text and page layout can not be modified. The reading experience is close to a print
version. Reading systems can still provide zooming options.</li>
<li>Ability to modify the appearance is not known.</li>
Expand Down Expand Up @@ -407,7 +407,7 @@ <h4>Examples</h4>
<li>Contains a table of contents that provides direct access to all chapters of the text via
links.</li>
<li>Index provides links to item references.</li>
<li>Landmarks provides quick access to main parts of the book.</li>
<li>Landmarks provide quick access to main parts of the book.</li>
<li>A page list enables users to coordinate their reading with a statically paginated
version.</li>
</ul>
Expand Down Expand Up @@ -531,7 +531,7 @@ <h4>Metadata techniques</h4>
<h3>Conformance</h3>

<div class="note">
<p>This key information should always be shown displayed, even if there is no metadata (with the relevant wording).</p>
<p>This key information should always be displayed, even if there is no metadata (with the relevant wording).</p>
</div>

<p>Identifies whether the digital publication meets internationally recognized conformance standards
Expand Down Expand Up @@ -697,7 +697,7 @@ <h3>Accessibility summary</h3>
<p>This key information can be hidden if metadata is missing.</p>
</div>

<p>The accessibility summary was intended (in EPUB Accessibility 1.0) to describes in human-readable
<p>The accessibility summary was intended (in EPUB Accessibility 1.0) to describe in human-readable
prose the accessibility features present in the publication as well as any shortcomings.
From EPUB Accessibility version 1.1 the accessibility summary became a human-readable summary of the accessibility
that complements, but does not duplicate, the other discoverability metadata.</p>
Expand Down Expand Up @@ -879,6 +879,8 @@ <h3>Contributors</h3>
<li>Matt Garrish</li>
<li>Rachel Comerford</li>
<li>Rick Johnson</li>
<li>Gautier Chomel</li>
<li>More to add</li>
</ul>
</section>

Expand Down

0 comments on commit 4ff096e

Please sign in to comment.