Skip to content

Commit

Permalink
Merge pull request #365 from w3c/principles-b4-publishing
Browse files Browse the repository at this point in the history 
Updated principles before publishing
  • Loading branch information
@GeorgeKerscher
GeorgeKerscher authored Aug 12, 2024
2 parents d0c6d2d + 768cc4f commit 56416af
Showing 1 changed file with 34 additions and 37 deletions.
71 changes: 34 additions & 37 deletions UX-Guide-Metadata/draft/principles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,8 @@
<section id="sotd"></section>
<section id="intro">
<h2>Introduction</h2>

<section id="background" class="informative">
<h3>Background</h3>
<p>Reading a publication is a very personal experience. For most people this is routine, and little

<p>Reading a publication is a very personal experience. For most people this is routine, and little
consideration is given to how the title was obtained before it is read. Users may go to a bookstore, search for the
title to purchase online, or have the title selected for them by an instructor for a class.</p>

Expand All @@ -132,7 +130,7 @@ <h3>Background</h3>
accessible from the outset, not fixed later) and getting the accessibility validation or audit done by
independent organizations.</p>

</section>

</section>
<section id="general-overview">
<h2>General overview</h2>
Expand Down Expand Up @@ -214,15 +212,15 @@ <h3>Metadata techniques</h3>

</section>
<section id="general-info">
<h2>General information (supplement the bibliographic information)</h2>
<h2>General information</h2>
<p>To solve the problem of displaying the accessibility metadata in a human readable form, vendors will determine their correct statement to display (from the User Experience Guide) by parsing the metadata and using the appropriate Display Techniques document. </p>

<p>The product details provide precious information about the usability of the book in relation to specific user needs. The following information should always be displayed:</p>

<ul>
<li> File format (EPUB, PDF, MP3, Audiobook, etc.) </li>
<li> File format (EPUB 2 or 3, PDF, MP3, Audiobook, etc.) </li>
<li> Protection measure or lack thereof </li>
<li> Date of publication </li>

<li> Name of the publishing house </li>
<li> Main language of the content </li>
</ul>
Expand All @@ -231,13 +229,11 @@ <h3>Why this information is important for accessibility</h3>

<ul>
<li> The file format gives a strong indication of accessibility: an MP3 format audiobook will be less
structured than an Audiobook; a PDF does not allow for typography modification, etc. </li>
structured than an Audiobook; a PDF does not allow for typography modification, EPUB 2 is deprecated, an EPUB 3 supports page navigation and better structural semantics, 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 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 confident that they will be able to read
with their Assistive Technology that uses synthesized voice or the corresponding Braille table for
Expand Down Expand Up @@ -315,8 +311,8 @@ <h4>Examples</h4>
</section>

<section id="va-techniques">
<h4>Metadata techniques</h4>

<h4>Visual adjustments metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html">EPUB Accessibility: Visual
Adjustments</a></li>
Expand Down Expand Up @@ -378,8 +374,8 @@ <h4>Examples</h4>
</section>

<section id="nv-techniques">
<h4>Metadata techniques</h4>

<h4>Supports nonvisual reading metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html#screen-reader-friendly">EPUB Accessibility:
Supports nonvisual reading</a></li>
Expand Down Expand Up @@ -542,7 +538,8 @@ <h4>Examples</h4>
</section>

<section id="conf-techniques">
<h4>Metadata techniques</h4>
<h4>Conformance metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>

<ul>
<li><a href="../techniques/epub-metadata/index.html">EPUB Accessibility: Conformance</a></li>
Expand Down Expand Up @@ -599,8 +596,8 @@ <h4>Examples</h4>
</section>

<section id="pra-techniques">
<h4>Metadata techniques</h4>

<h4>Pre-recorded audio metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html#full-audio">EPUB Accessibility: Full
audio</a></li>
Expand Down Expand Up @@ -652,8 +649,8 @@ <h4>Examples</h4>
</section>

<section id="nav-techniques">
<h4>Metadata techniques</h4>

<h4>Navigation metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html">EPUB Accessibility: Navigation</a></li>
<li><a href="../techniques/onix-metadata/index.html">ONIX: Navigation</a></li>
Expand Down Expand Up @@ -700,8 +697,8 @@ <h4>Examples</h4>
</section>

<section id="cdf-techniques">
<h4>Metadata techniques</h4>

<h4>Charts, diagrams, and formulas metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html">EPUB Accessibility: Graphics and
Formulas</a></li>
Expand Down Expand Up @@ -753,8 +750,8 @@ <h4>Examples</h4>
</section>

<section id="hazards-techniques">
<h4>Metadata techniques</h4>

<h4>Hazards metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html#hazards">EPUB Accessibility:
Hazards</a></li>
Expand Down Expand Up @@ -793,8 +790,8 @@ <h4>Examples</h4>
</section>

<section id="sum-techniques">
<h4>Metadata techniques</h4>

<h4>Accessibility summary metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html">EPUB Accessibility: Accessibility
Summary</a></li>
Expand All @@ -804,11 +801,12 @@ <h4>Metadata techniques</h4>
</section>
<section id="legal-considerations">
<h3>Legal considerations</h3>
<div class="note">
<p>This key information should be hidden if metadata is not present .</p>
</div>

<div class="issue" data-number="350">We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.</div>

<div class="note">
<p>This key information should be hidden if metadata is not present .</p>
</div>

<div class="note">Disclaimer: nothing here may be construed as legal advice supplied by W3C or any the groups or individuals who have contributed to this document.
Always get legal advice from in-house or your retained counsel to assess legal compliance and risk.</div>
Expand All @@ -835,8 +833,8 @@ <h2>Examples</h2>


<section id="legal-techniques">
<h4>Metadata techniques</h4>

<h4> Legal considerations metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html#legal-considerations">EPUB Accessibility: legal considerations</a></li>
<li><a href="../techniques/onix-metadata/index.html#legal-considerations">ONIX: legal considerations</a></li>
Expand Down Expand Up @@ -926,8 +924,8 @@ <h2>Examples</h2>
</section>

<section id="add-info-techniques">
<h4>Metadata techniques</h4>

<h4>Additional accessibility information metadata techniques</h4>
<p>Specific techniques for meeting this principle are defined in the following documents:</p>
<ul>
<li><a href="../techniques/epub-metadata/index.html">EPUB Accessibility: Book Features</a></li>
<li><a href="../techniques/onix-metadata/index.html">ONIX: Book Features</a></li>
Expand Down Expand Up @@ -1022,11 +1020,10 @@ <h2>Localization</h2>

<section id="implementations">
<h2>Implementations</h2>
<p>These guidelines provide a general framework and make suggestions on the display of accessibility
<div class="issue" data-number="268">We are collecting information on companies and organizations that wish to possibly commit examples of their implementation. Please visit this GitHub issue to review companies and organizations that have put their name forward. To possibly volunteer an implementation, please put your company name, your name and your contact information.</div>
<p>These guidelines provide a general framework and make suggestions on the display of accessibility
metadata. It is not a normative description of what must be done. It is instructive to provide
examples of implementations from the community. </p>
<p>We are collecting information on companies and organizations that wish to possibly commit examples of their implementation. Please visit the GitHub issue to review companies and organizations that have volunteered. Please put your company name, your name and your contact information to possibly volunteer an implementation.</p>
<div class="issue" data-number="268"></div>

<p>Linked below are static pages that show real-life implementations. We have captured these examples
from organization's websites that have agreed to allow us to showcase the work they have done to
Expand Down

0 comments on commit 56416af

Please sign in to comment.