Merge pull request #379 from w3c/Adding-Additional-Accessibility-Info…

…rmation added to Additional Accessibility Information
w3c · Aug 20, 2024 · d3badbb · d3badbb
2 parents 51f7029 + 93e14bc
commit d3badbb
Showing 1 changed file with 64 additions and 2 deletions.
diff --git a/UX-Guide-Metadata/draft/techniques/epub-metadata/index.html b/UX-Guide-Metadata/draft/techniques/epub-metadata/index.html
@@ -979,6 +979,11 @@ <h5>Understanding the variables</h5>
 							<p>If true it indicates that the <i>accessibilityFeature="audioDescriptions"</i> (Audio Descriptions) is present in the package document, otherwise if false it means that the metadata is not present.</p>
 							<p>This means that there is an audio descriptions track available for video content.</p>
 						</dd>
+						<dt><var>braille</var></dt>
+						<dd>
+							<p>If true it indicates that the <i>accessibilityFeature="braille"</i> (Braille) is present in the package document, otherwise if false it means that the metadata is not present.</p>
+							<p>This means that there is braille available within the publication.</p>
+						</dd>
 						<dt><var>closed_captions</var></dt>
 						<dd>
 							<p>If true it indicates that the <i>accessibilityFeature="closedCaptions"</i> (Closed captions) is present in the package document, otherwise if false it means that the metadata is not present.</p>
@@ -989,6 +994,16 @@ <h5>Understanding the variables</h5>
 							<p>If true it indicates that the <i>accessibilityFeature="openCaptions"</i> (Open captions) is present in the package document, otherwise if false it means that the metadata is not present.</p>
 							<p>This means that the audio content of a video can be seen via open captions, which means they cannot be turned off and are always visible when the video plays.</p>
 						</dd>
+						<dt><var>tactile_graphic</var></dt>
+						<dd>
+							<p>If true it indicates that the <i>accessibilityFeature="tactileGraphic"</i> (tactile 2D graphic) is present in the package document, otherwise if false it means that the metadata is not present.</p>
+							<p>This means that there is tactile graphic(s) contained within this publication.</p>
+						</dd>
+						<dt><var>tactile_object</var></dt>
+						<dd>
+							<p>If true it indicates that the <i>accessibilityFeature="tactileObject"</i> (tactile 3D object) is present in the package document, otherwise if false it means that the metadata is not present.</p>
+							<p>This means that there is tactile 3D object(s) contained within this publication.</p>
+						</dd>
 						<dt><var>transcript</var></dt>
 						<dd>
 							<p>If true it indicates that the <i>accessibilityFeature="transcript"</i> (transcript) is present in the package document, otherwise if false it means that the metadata is not present.</p>
@@ -1005,8 +1020,11 @@ <h5>Variables setup</h5>
 					<ol class="condition">
                         <li><b>LET</b> <var>package_document</var> be the result of calling <a href="#pre-processing">preprocessing</a> given <var>package_document_as_text</var>.</li>
 						<li><b>LET</b> <var>audio_descriptions</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>audioDescription</i>"]</code>.</li>
+						<li><b>LET</b> <var>braille</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>braille</i>"]</code>.</li>
 						<li><b>LET</b> <var>closed_captions</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>closedCaptions</i>"]</code>.</li>
                         <li><b>LET</b> <var>open_captions</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>openCaptions</i>"]</code>.</li>
+                        <li><b>LET</b> <var>tactile_graphic</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>tactileGraphic</i>"]</code>.</li>
+                        <li><b>LET</b> <var>tactile_object</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>tactileObject</i>"]</code>.</li>
                         <li><b>LET</b> <var>transcript</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>transcript</i>"]</code>.</li>
                         <li><b>LET</b> <var>sign_language</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>signLanguage</i>"]</code>.</li>
     				</ol>
@@ -1018,6 +1036,10 @@ <h5>Instructions</h5>
 							<span><b>IF</b> <var>audio_descriptions</var>:</span>
 							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-audio-descriptions">"audio descriptions"</code> to <var>adaptation</var>.</span>
 						</li>
+						<li>
+							<span><b>IF</b> <var>braille</var>:</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-braille">"braille"</code> to <var>adaptation</var>.</span>
+						</li>
 						<li>
 							<span><b>IF</b> <var>closed_captions</var>:</span>
 							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-closed-captions">"closed captions"</code> to <var>adaptation</var>.</span>
@@ -1026,6 +1048,14 @@ <h5>Instructions</h5>
 							<span><b>IF</b> <var>open_captions</var>:</span>
 							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-open-captions">"open captions"</code> to <var>adaptation</var>.</span>
 						</li>
+						<li>
+							<span><b>IF</b> <var>tactile_graphic</var>:</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-tactile_graphic">"tactile graphic"</code> to <var>adaptation</var>.</span>
+						</li>
+						<li>
+							<span><b>IF</b> <var>tactile_object</var>:</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-tactile_object">"tactile 3D object"</code> to <var>adaptation</var>.</span>
+						</li>
 						<li>
 							<span><b>IF</b> <var>transcript</var>:</span>
 							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-adaptation-transcript">"transcript"</code> to <var>adaptation</var>.</span>
@@ -1054,6 +1084,18 @@ <h3>Clarity</h3>
 
 					<h5>Understanding the variables</h5>
 					<dl>
+
+						<dt><var>aria</var></dt>
+						<dd>
+							<p>If true it indicates that the <i>accessibilityFeature="aria"</i>  (ARIA roles - semantic markup) is present in the package document, otherwise if false it means that the metadata is not present.</p>
+							<p>This means that the use of AIRA, including <a href="https://w3c.github.io/dpub-aria/">DPUB ARIA</a> is used to improve the semantic markup of the publication.</p>
+						</dd>
+  						<dt><var>full_ruby_annotations</var></dt>
+						<dd>
+							<p>If true it indicates that the <i>accessibilityFeature="fullRubyAnnotations"</i> (Full Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.</p>
+							<p>This means that ruby annotations are attached to every CJK ideographic character in the content. Ruby annotations are used as pronunciation guides for the logographic characters for languages like Chinese or Japanese. They make difficult CJK ideographic characters more accessible.</p>
+						</dd>  
+
 						<dt><var>text_to_speech_hinting</var></dt>
 						<dd>
 							<p>If true it indicates that the <i>accessibilityFeature="ttsMarkup"</i>  (Text-to-speech markup provided) is present in the package document, otherwise if false it means that the metadata is not present.</p>
@@ -1079,22 +1121,38 @@ <h5>Understanding the variables</h5>
                             <p>If true it indicates that the <i>accessibilityFeature="pageBreakMarkers"</i> (Print-equivalent page numbering) is present in the package document, otherwise if false it means that the metadata is not present.</p>
                             <p>This means that the publication contains references to the page numbering.</p>
                         </dd>
+ 						<dt><var>ruby_annotations</var></dt>
+						<dd>
+							<p>If true it indicates that the <i>accessibilityFeature="rubyAnnotations"</i> (Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.</p>
+							<p>This means that ruby annotations are attached to some but not all CJK ideographic characters in the content.</p>
+						</dd>  
 
 					</dl>
 
 					<h5>Variables setup</h5>
 					<ol class="condition">
 						<li><b>LET</b> <var>package_document</var> be the result of calling <a href="#pre-processing">preprocessing</a> given <var>package_document_as_text</var>.</li>
+						<li><b>LET</b> <var>aria</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>aria</i>"]</code>.</li>
+						<li><b>LET</b> <var>full_ruby_annotations</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>fullRubyAnnotations</i>"]</code>.</li>
 						<li><b>LET</b> <var>text_to_speech_hinting</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>ttsMarkup</i>"]</code>.</li>
     				    <li><b>LET</b> <var>high_contrast_between_foreground_and_background_audio</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>highContrastAudio</i>"]</code>.</li>
     				    <li><b>LET</b> <var>high_contrast_between_text_and_background</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>highContrastDisplay</i>"]</code>.</li>
                         <li><b>LET</b> <var>large_print</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>largePrint</i>"]</code>.</li>
                         <li><b>LET</b> <var>page_break_markers</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>pageBreakMarkers</i>"]</code>.</li>
+						<li><b>LET</b> <var>ruby_annotations</var> be the result of calling <a href="#check-for-node">check for node</a> on <var>package_document</var>, <code class="xpath">/package/metadata/meta[@property="schema:<i>accessibilityFeature</i>" and text()="<i>rubyAnnotations</i>"]</code>.</li>
                     </ol>
 
 					<h5>Instructions</h5>
 					<ol class="condition">
 						<li><b>LET</b> <var>clarity</var> be  an empty array.</li>
+						<li>
+							<span><b>IF</b> <var>aria</var>:</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-aria">"aria"</code> to <var>clarity</var>.</span>
+						</li>
+						<li>
+							<span><b>IF</b> <var>full_ruby_annotations</var>:</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-full-ruby-annotations">"full ruby annotations"</code> to <var>clarity</var>.</span>
+						</li>
 						<li>
 							<span><b>IF</b> <var>text_to_speech_hinting</var>:</span>
 							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-text-to-speech-hinting">"text-to-speech hinting provided"</code> to <var>clarity</var>.</span>
@@ -1109,12 +1167,16 @@ <h5>Instructions</h5>
 						</li>
 						<li>
 							<span><b>IF</b> <var>large_print</var>:</span>
-							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-large-print">"large print "</code> to <var>clarity</var>.</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-large-print">"large print"</code> to <var>clarity</var>.</span>
 						</li>
                         <li>
                             <span><b>IF</b> <var>page_break_markers</var>:</span>
                             <span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-page-breaks">"page breaks"</code> to <var>clarity</var>.</span>
-							</li>
+                        </li>
+						<li>
+							<span><b>IF</b> <var>ruby_annotations</var>:</span>
+							<span><b>THEN</b> <b>APPEND</b> <code id="additional-accessibility-information-clarity-ruby-annotations">"ruby annotations"</code> to <var>clarity</var>.</span>
+						</li>
 
 
                         <li><b>IF</b> <var>clarity</var> is <b>NOT</b> empty: