From 7a62ea625d610d2776f45217844706d3d29a7093 Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Sat, 28 Dec 2024 11:31:30 -0700 Subject: [PATCH 1/8] Validated and correct spelling problems in prep for editing --- .../draft/techniques/epub-metadata/index.html | 259 +++++++++--------- 1 file changed, 131 insertions(+), 128 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index df46e665..2430071e 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -68,51 +68,51 @@

EPUB Accessibility Metadata

- +

This metadata as outlined in EPUB Accessibility 1.1 [[epub-a11y-11]], can be found in the EPUB package document [[EPUB-33]].

- + - + - + - - + +

EPUB Accessibility Metadata Examples

EPUB accessibility metadata describing an EPUB

-

Here is an example of accessibility metadata embedded within the package document, +

Here is an example of accessibility metadata embedded within the package document, which will be used as a reference point for the following examples on EPUB accessibility metadata: the results of the XPath shown are based on this example. @@ -131,7 +131,7 @@

EPUB accessibility met

- +

Conventions for implementations

The code conventions used in the provided code snippet follow a structure commonly found in programming languages like Python, Java, or C++. Here's an explanation of the conventions:

@@ -152,7 +152,7 @@

Conventions for implementations

The code is written in a way that is intended to be easily readable and understandable even by non-coders.
- +

Common Functions

In this section we define the functions common to all techniques, which are called by them during execution.

@@ -160,11 +160,11 @@

Common Functions

Preprocessing

Before working directly with the metadata we must read the metadata in the Package document (package document) inside the EPUB. This is a common starting point for all techniques that allows us to query the metadata directly.

- + - +

This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.

To generate the internal representation, run the following steps:

    @@ -172,7 +172,7 @@

    Preprocessing

  1. Return package_document.
- +

Check for Node

Many of the techniques rely on checking for the presence or absence of metadata in the metadata section of the Package document.

@@ -213,7 +213,7 @@

Join array to comma list

- +

Techniques

@@ -241,11 +241,11 @@

Understanding the variables

Variables setup

  1. LET package_document be the result of calling preprocessing given package_document_as_text.
    2. - +
  2. LET all_textual_content_can_be_modified be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="displayTransformability"].
  3. LET is_fixed_layout be the result of calling check for node on package_document, /package/metadata/meta[@property="rendition:layout" and text()="pre-paginated"].
    4. - +

Instructions

    @@ -260,7 +260,7 @@

    Instructions

  1. ELSE display "No information is available".
- +

Supports nonvisual reading

This technique relates to Supports nonvisual reading key information.

@@ -304,14 +304,14 @@

Variables setup

  • LET all_necessary_content_textual be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessModeSufficient" and text()="textual"].
  • - LET non_textual_content_images be the result of calling check for node on + LET non_textual_content_images be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and
    (text()="chartOnVisual" or text()="chemOnVisual" or
    text()="diagramOnVisual" or text()="mathOnVisual" or
    text()="musicOnVisual" or text()="textOnVisual")]    .
    • - +
  • LET textual_alternative_images be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and
    (text()="longDescription" or text()="alternativeText" or text()="describedMath")]    . - +

    • Instructions

    @@ -329,14 +329,14 @@

    Instructions

    - - + +

    Conformance

    This technique relates to Conformance key information.

    This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.

    - +

    Understanding the variables

    conformance_string
    @@ -354,7 +354,7 @@

    Understanding the variables

    certifier_credentials
    -

    Returns the description of a11y:certifierCredential (Compliance certification by (URL) or text) if present in the package document, otherwise if false it means that the metadata is not present.

    +

    Returns the description of a11y:certifierCredential (Compliance certification by (URL) or text) if present in the package document, otherwise if false it means that the metadata is not present.

    This means that the the URL of a web page belonging to an organization responsible for compliance testing and certification of the product is present – typically a ‘home page’ or a page describing the certification scheme itself.

    certification_date
    @@ -374,16 +374,17 @@

    Understanding the variables

    - +

    Variables setup

    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. - +
    2. - IF the result of calling check for node on package_document, /package/metadata/link[@rel="dcterms:conformsTo" and @href="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"] | /package/metadata/meta[@property="dcterms:conformsTo" and text() = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"] : + IF the result of calling check for node on package_document, /package/metadata/link[@rel="dcterms:conformsTo" and @href="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"] | /package/metadata/meta[@property=" +dcterms:conformsTo" and text() = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"] : - THEN LET conformance_string = 'EPUB Accessibility 1.0 WCAG 2.0 Level A', + THEN LET conformance_string = 'EPUB Accessibility 1.0 WCAG 2.0 Level A', and LET wcag_level = 'A'.
      3. @@ -391,7 +392,7 @@

      Variables setup

    3. IF the result of calling check for node on package_document, /package/metadata/link[@rel="dcterms:conformsTo" and @href="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"] | /package/metadata/meta[@property="dcterms:conformsTo" and text() = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"]: - THEN LET conformance_string = 'EPUB Accessibility 1.0 WCAG 2.0 Level AA', + THEN LET conformance_string = 'EPUB Accessibility 1.0 WCAG 2.0 Level AA', and LET wcag_level = 'AA'.
      4. @@ -399,14 +400,14 @@

      Variables setup

    4. IF the result of calling check for node on package_document, /package/metadata/link[@rel="dcterms:conformsTo" and @href="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa"] | /package/metadata/meta[@property="dcterms:conformsTo" and text() = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa"]: - THEN LET conformance_string = 'EPUB Accessibility 1.0 WCAG 2.0 Level AAA', + THEN LET conformance_string = 'EPUB Accessibility 1.0 WCAG 2.0 Level AAA', and LET wcag_level = 'AAA'.
    5. LET conformance be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="dcterms:conformsTo" and matches(normalize-space(.), 'EPUB Accessibility 1\.1 - WCAG 2\.[0-2] Level [A]+').
      6. - +
    6. IF conformance is NOT empty: @@ -414,16 +415,16 @@

      Variables setup

      and LET wcag_level = replace(conformance, 'EPUB Accessibility 1\.1 - WCAG 2\.[0-2] Level ', '').
      7. - +
    7. LET certifier be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifiedBy"]/text().
      8. - +
    8. LET certifier_credentials be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifierCredential"]/text().
      9. - +
    9. LET certification_date be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="dcterms:date" and @refines=//meta[@property="a11y:certifiedBy"]/@id]/text()].
      10. - +
    10. LET certifier_report be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifierReport"]/text().
    - +

    Instructions

    1. IF conformance_string is empty: @@ -464,7 +465,7 @@

      Instructions

    2. ELSE display certifier_credentials as text.
      3. - +
    3. @@ -473,7 +474,7 @@

      Instructions

    4. display "This publication claims to meet ".

    5. display conformance_string.

      - +

      The value of conformance_string will be one of the following strings:

      @@ -516,14 +517,14 @@

      Instructions

    - +
    - - + +

    Prerecorded audio

    This technique relates to Prerecorded audio key information.

    - +

    This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.

    Understanding the variables

    @@ -534,29 +535,30 @@

    Understanding the variables

    synchronised_pre_recorded_audio
    -

    If true it indicates that the accessibilityFeature="sychronizedAudioText" is present in the package document, otherwise, if false, it means that the metadata is not present.

    -

    This indicates that text-synchronised prerecorded audio narration (natural or synthesised voice) is included for substantially all textual matter, including all alternative descriptions, e.g. via a SMIL media overlay.

    +

    If true it indicates that the accessibilityFeature=" +sychronizedAudioText" is present in the package document, otherwise, if false, it means that the metadata is not present.

    +

    This indicates that text-synchronised prerecorded audio narration (natural or synthesized voice) is included for substantially all textual matter, including all alternative descriptions, e.g. via a SMIL media overlay.

    - +
    audio_content

    If true it indicates that the accessMode="auditory" is present in the package document, otherwise, if false, it means that the metadata is not present.

    This indicates that prerecorded audio content is included as part of the work.

    - - + +

    Variables setup

    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. - +
    2. LET all_content_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessModeSufficient" and text()="auditory"].
      3. - +
    3. LET synchronised_pre_recorded_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="sychronizedAudioText"].
      4. - +
    4. LET audio_content be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessMode" and text()="auditory"].
      5. - +

    Instructions

      @@ -567,14 +569,14 @@

      Instructions

    1. ELSE IF synchronised_pre_recorded_audio: THEN display "Prerecorded audio synchronized with text". -
      2. +
    2. ELSE IF audio_content: THEN display "Complementary audio and text". -
      3. +
    3. - ELSE either omit this key informtion if metadata is missing or display "No information is available". + ELSE either omit this key information if metadata is missing or display "No information is available".
    @@ -589,7 +591,7 @@

    Understanding the variables

    table_of_contents_navigation

    If true it indicates that the accessibilityFeature="tableOfContents" (Table of contents navigation) is present in the package document, otherwise if false it means that the metadata is not present.

    - +

    This means that the resource includes a table of contents that provides links to the major sections of the content.

    index_navigation
    @@ -611,15 +613,15 @@

    Understanding the variables

    Variables setup

      - +
    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. - +
    2. LET table_of_contents_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tableOfContents"].
    3. LET index_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="index"].
    4. LET page_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="pageNavigation"].
      5. - +
    5. LET next_previous_structural_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="structuralNavigation"].
    @@ -655,21 +657,21 @@

    Instructions

  • - ELSE either omit this key informtion if metadata is missing or display "No information is available". + ELSE either omit this key information if metadata is missing or display "No information is available".
    • - +

    Charts, diagrams, math, and formulas

    This technique relates to Charts, diagrams, math, and formulas key information.

    - +

    This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.

    Understanding the variables

    contains_charts_diagrams
    -

    If true it indicates that the accessibilityFeature="chartOnVisual" (charts encoded in visual form) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    If true it indicates that the accessibilityFeature="chartOnVisual" (charts encoded in visual form) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that there is a positive indication that the product has some information conveyed via some form of illustration, such as a graph, a chart, a diagram, a figure, etc).

    long_text_descriptions
    @@ -678,11 +680,12 @@

    Understanding the variables

    This means that there is a positive indication that a full alternative textual description has been supplied for all of the graphs, charts, diagrams, or figures necessary to understand the content.

    contains_chemical_formula
    -
    +

    If true it indicates that the accessibilityFeature="chemOnVisual" (Chemical content) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that there is a positive indication that the publication contains chemical notations, formulae.

    -
    chemical_formula_as_chemml
    +
    chemical_formula_as_ +chemml

    If true it indicates that the accessibilityFeature="ChemML" (Accessible chemistry content as ChemML) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that there is a positive indication that the chemical formulae are presented using ChemML and works with compatible assistive technology.

    @@ -706,18 +709,18 @@

    Understanding the variables

    Variables setup

    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. - +
    2. LET contains_charts_diagrams be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chartOnVisual"].
      3. - +
    3. LET long_text_descriptions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="longDescriptions"].
      4. - +
    4. LET contains_chemical_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chemOnVisual"].
      5. - +
    5. LET chemical_formula_as_chemml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ChemML"].
      6. - - + +
    6. LET contains_math_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="describedMath"].
      7. - +
    7. LET math_formula_as_latex be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="latex"].
    8. LET math_formula_as_mathml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="MathML"].
      9. @@ -743,60 +746,60 @@

      Instructions

    - +

    Hazards

    This technique relates to Hazards key information.

    This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.

    - +

    Understanding the variables

    no_hazards_or_warnings_confirmed
    -

    If true it indicates that the accessibilityHazard="none" (no accessibility hazards) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no associated hazard warnings with this product.

    +

    If true it indicates that the accessibilityHazard="none" (no accessibility hazards) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    This means there is a positive indication in the accessibility metadata within the EPUB confirming there are no associated hazard warnings with this product.

    flashing_hazard
    -

    If true it indicates that the accessibilityHazard="flashing" (WARNING - Flashing hazards) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a flashing hazard which must be displayed.

    +

    If true it indicates that the accessibilityHazard="flashing" (WARNING - Flashing hazards) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    This means that there is a positive indication in the accessibility metadata within the EPUB confirming that the product has a flashing hazard which must be displayed.

    no_flashing_hazards
    -

    If true it indicates that the accessibilityHazard="noFlashingHazard" (No flashing hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no flashing hazards associated with this product.

    +

    If true it indicates that the accessibilityHazard="noFlashingHazard" (No flashing hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    This means there is a positive indication in the accessibility metadata within the EPUB confirming there are no flashing hazards associated with this product.

    motion_simulation_hazard
    -

    If true it indicates that the accessibilityHazard="motionSimulation" (WARNING - Motion simulation hazard) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a motion simulation hazard which must be displayed.

    +

    If true it indicates that the accessibilityHazard="motionSimulation" (WARNING - Motion simulation hazard) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    This means that there is a positive indication in the accessibility metadata within the EPUB confirming that the product has a motion simulation hazard which must be displayed.

    no_motion_hazards
    -

    If true it indicates that the accessibilityHazard="noMotionSimulationHazard" (No motion simulation hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.

    This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no motion simulation hazards associated with this product.

    +

    If true it indicates that the accessibilityHazard="noMotionSimulationHazard" (No motion simulation hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.

    This means there is a positive indication in the accessibility metadata within the EPUB confirming there are no motion simulation hazards associated with this product.

    sound_hazard
    -

    If true it indicates that the accessibilityHazard="Sound" (WARNING - Sound hazard) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a sound hazard which must be displayed.

    +

    If true it indicates that the accessibilityHazard="Sound" (WARNING - Sound hazard) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    This means that there is a positive indication in the accessibility metadata within the EPUB confirming that the product has a sound hazard which must be displayed.

    no_sound_hazards
    -

    If true it indicates that the accessibilityHazard="noSoundHazard" (No sound hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no sound hazards associated with this product.

    +

    If true it indicates that the accessibilityHazard="noSoundHazard" (No sound hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    This means there is a positive indication in the accessibility metadata within the EPUB confirming there are no sound hazards associated with this product.

    unknown_if_contains_hazards
    -

    If true it indicates that the accessibilityHazard="unknown" (unknown hazards) is present in the package document, otherwise if false it means that the metadata is not present.

    +

    If true it indicates that the accessibilityHazard="unknown" (unknown hazards) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that the product has not been assessed for hazards and there is no information about potential hazards.

    - +
    - +

    Variables setup

    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. - +
    2. LET no_hazards_or_warnings_confirmed be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="none"].
    3. LET flashing_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="flashing"].
      4. @@ -819,7 +822,7 @@

      Variables setup

    4. LET unknown_if_contains_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="unknown"].
      5. - +

    Instructions

      @@ -847,7 +850,7 @@

      Instructions

      • calling join array to comma list given hazards
      • uppercasing the first character
        • -
      • concatenating " hazards" to the end of the string IF (length of hazards) > 1 ELSE concatenating " hazard" to the end of the string.
        • +
      • concatenating " hazards" to the end of the string IF (length of hazards) 1 ELSE concatenating " hazard" to the end of the string.
    1. display hazards_string.
      2. @@ -858,13 +861,13 @@

      Instructions

      THEN display "The presence of hazards is unknown".
    2. - ELSE either omit this key informtion if metadata is missing or display "No information is available". + ELSE either omit this key information if metadata is missing or display "No information is available".
    - +

    Accessibility summary

    This technique relates to Accessibility summary key information.

    @@ -886,7 +889,7 @@

    Understanding the variables

    lang_attribute_accessibility_summary
    -

    Returns the lang attribute of the node containing the accessibility_summary, or the lang attribute of the nearest anchestor.

    +

    Returns the lang attribute of the node containing the accessibility_summary, or the lang attribute of the nearest ancestor.

    This is the language code in which the text of the Accessibility summary was written.

    language_of_text
    @@ -919,7 +922,7 @@

    Instructions

    IF accessibility_summary is NOT empty: THEN display the content of accessibility_summary with language_accessibility_summary as language.
  • - ELSE either omit this key informtion if metadata is missing or display "No accessibility summary is available.". + ELSE either omit this key information if metadata is missing or display "No accessibility summary is available.".
    • @@ -927,11 +930,11 @@

    Instructions

    - - + +

    Additional accessibility information

    This technique relates to Additional accessibility information key information.

    @@ -978,7 +981,7 @@

    Additional accessibility information

    Adaptation

    - +
    Understanding the variables
    audio_descriptions
    @@ -1022,7 +1025,7 @@
    Understanding the variables

    This means that a full signing of audio content of the product is supplied with the video file.

    - +
    Variables setup
    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. @@ -1032,7 +1035,7 @@
      Variables setup
    2. LET tactile_object be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tactileObject"].
    3. LET sign_language be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="signLanguage"].
    - +
    Instructions
    1. LET adaptation be an empty array.
      2. @@ -1069,39 +1072,39 @@
      Instructions
    - +

    Clarity

    - +
    Understanding the variables
    - +
    aria

    If true it indicates that the accessibilityFeature="aria" (ARIA roles - semantic markup) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means that the use of AIRA, including DPUB ARIA is used to improve the semantic markup of the publication.

    +

    This means that the use of ARIA, including DPUB ARIA is used to improve the semantic markup of the publication.

    full_ruby_annotations

    If true it indicates that the accessibilityFeature="fullRubyAnnotations" (Full Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.

    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.

    -
    - + +
    text_to_speech_hinting

    If true it indicates that the accessibilityFeature="ttsMarkup" (Text-to-speech markup provided) is present in the package document, otherwise if false it means that the metadata is not present.

    -

    This means that text-to-speech has been optimised through provision of PLS lexicons, SSML or CSS Speech synthesis hints or other speech synthesis markup languages or hinting.

    +

    This means that text-to-speech has been optimized through provision of PLS lexicons, SSML or CSS Speech synthesis hints or other speech synthesis markup languages or hinting.

    high_contrast_between_foreground_and_background_audio

    If true it indicates that the accessibilityFeature="highContrastAudio" (Use of high contrast between foreground and background audio) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that foreground audio content (eg voice) is presented with no or low background noise (eg ambient sounds, music), at least 20dB below the level of the foreground, or background noise can be switched off (eg via an alternative audio track). Brief and occasional sound effects may be as loud as foreground voice so long as they are isolated from the foreground.

    -
    +
    high_contrast_between_text_and_background

    If true it indicates that the accessibilityFeature="highContrastDisplay" (Use of high contrast between text and background color) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that body text is presented with a contrast ratio of at least 4.5:1 (or 3:1 for large/heading text).

    -
    +
    large_print

    If true it indicates that the accessibilityFeature="largePrint" (Large Print) is present in the package document, otherwise if false it means that the metadata is not present.

    @@ -1116,10 +1119,10 @@
    Understanding the variables

    If true it indicates that the accessibilityFeature="rubyAnnotations" (Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.

    This means that ruby annotations are attached to some but not all CJK ideographic characters in the content.

    -
    - + +
    - +
    Variables setup
    1. LET package_document be the result of calling preprocessing given package_document_as_text.
      2. @@ -1132,7 +1135,7 @@
      Variables setup
    2. LET page_break_markers be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="pageBreakMarkers"].
    3. LET ruby_annotations be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="rubyAnnotations"].
    - +
    Instructions
    1. LET clarity be an empty array.
      2. @@ -1169,7 +1172,7 @@
      Instructions
      THEN APPEND "ruby annotations" to clarity. - +
    2. IF clarity is NOT empty:
      1. LET clarity_string be the result of: @@ -1183,10 +1186,10 @@
        Instructions
    - - + +
    - +
    From aa2dacb8a3e9ee09979d2c2a432f633519db11ec Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Sat, 28 Dec 2024 12:46:48 -0700 Subject: [PATCH 2/8] Updated the EPUB techniques navigation section --- .../draft/techniques/epub-metadata/index.html | 29 ++++++++----------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index 2430071e..78b2c7c5 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -629,33 +629,28 @@

    Instructions

    1. IF table_of_contents_navigation OR index_navigation OR page_navigation OR next_previous_structural_navigation: - THEN LET navigation be an empty array. +
      1. IF table_of_contents_navigation: - THEN APPEND "Table of contents" to navigation. + THEN display "Table of contents".
      2. IF index_navigation: - THEN APPEND "Index" to navigation. + THEN display "Index".
      3. - IF page_navigation: - THEN APPEND "Go to page" to navigation. -
        4. -
      4. - IF next_previous_structural_navigation: - THEN APPEND "Headings" to navigation. + IF print_equivalent_page_numbering: + THEN display "Go to page".
        5. -
      5. LET navigation_string be the result of: -
          -
        • calling join array to comma list given navigation
          • -
        • concatenating "Navigation by " to the beginning of the string.
          • -
        +
      6. + IF next_previous_structural_navigation: + THEN display "Headings". +
      2. -
    2. display navigation_string.
      3. -
    - + + +
  • ELSE either omit this key information if metadata is missing or display "No information is available".
    • From 4b19419a0acd647351e2692bc3faacf3ee0068d7 Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Sat, 28 Dec 2024 13:09:43 -0700 Subject: [PATCH 3/8] Updated the Hazard section instructions only --- .../draft/techniques/epub-metadata/index.html | 21 ++++++------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index 78b2c7c5..6a99d862 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -826,31 +826,22 @@

    Instructions

    THEN display "No hazards".
  • - ELSE IF flashing_hazard OR motion_simulation_hazard OR sound_hazard: - THEN LET hazards be an empty array. -
      + ELSE IF flashing_hazard OR motion_simulation_hazard OR sound_hazard: + THEN
      1. IF flashing_hazard: - THEN APPEND "Flashing content" to hazards. + THEN display "Flashing content".
      2. IF motion_simulation_hazard: - THEN APPEND "Motion simulation" to hazards. + THEN display "Motion simulation".
      3. IF sound_hazard: - THEN APPEND "Loud sounds" to hazards. -
        4. -
      4. LET hazards_string be the result of: -
          -
        • calling join array to comma list given hazards
          • -
        • uppercasing the first character
          • -
        • concatenating " hazards" to the end of the string IF (length of hazards) 1 ELSE concatenating " hazard" to the end of the string.
          • -
        + THEN display "Loud sounds".
        5. -
      5. display hazards_string.
      - +
    1. ELSE IF unknown_if_contains_hazards: THEN display "The presence of hazards is unknown". From f83900593353a385a4d2a37f67b7087f81a75bff Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Sat, 28 Dec 2024 14:18:44 -0700 Subject: [PATCH 4/8] Updated the Rich content and added chem as LaTex --- .../draft/techniques/epub-metadata/index.html | 52 +++++++++++++++---- 1 file changed, 42 insertions(+), 10 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index 6a99d862..a4a5dab8 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -658,7 +658,7 @@

      Instructions

      -

      Charts, diagrams, math, and formulas

      +

      Rich content

      This technique relates to Charts, diagrams, math, and formulas key information.

      This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.

      @@ -685,6 +685,12 @@

      Understanding the variables

      If true it indicates that the accessibilityFeature="ChemML" (Accessible chemistry content as ChemML) is present in the package document, otherwise if false it means that the metadata is not present.

      This means that there is a positive indication that the chemical formulae are presented using ChemML and works with compatible assistive technology.

      +
      chemical_formula_as_latex
      +
      +

      If true it indicates that the accessibilityFeature="latex-chemistry" (Accessible chemistry content as Latex) is present in the package document, otherwise if false it means that the metadata is not present.

      +

      This means that there is a positive indication that the chemical formulae are presented using Latex and works with compatible assistive technology.

      +
      +
      contains_math_formula

      If true it indicates that the accessibilityFeature="describedMath" (Mathematical content) is present in the package document, otherwise if false it means that the metadata is not present.

      @@ -711,7 +717,8 @@

      Variables setup

    2. LET contains_chemical_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chemOnVisual"].
      3. -
    3. LET chemical_formula_as_chemml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ChemML"].
      4. +
    4. LET chemical_formula_as_latex be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="latex-chemistry"].
      5. +
    5. LET chemical_formula_as_chemml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ChemML"].
    6. LET contains_math_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="describedMath"].
      7. @@ -722,24 +729,49 @@

      Variables setup

    Instructions

      +
    1. + IF math_formula_as_mathml: + THEN display "Math as MathML". +
      2. +
    2. + ELSE IF math_formula_as_latex: + THEN display "Math as LaTex". +
      3. +
    3. + ELSE IF contains_math_formula AND short_textual_alternative_images: + THEN display "Math as images with text description". +
      4. +
    4. + IF chemical_formula_as_mathml: + THEN display "Chemical formulas in MathML". +
      5. +
    5. + IF chemical_formula_as_latex: + THEN display "Chemical formulas in LaTex". +
      6. +rich-content-accessible- +rich-content-accessible-chemistry-as-latex
    6. - IF (contains_charts_diagrams AND long_text_descriptions): + IF charts_diagrams_as_non_graphical_data OR full_alternative_textual_descriptions: THEN display "Information-rich images are described by extended descriptions".
    7. - IF chemical_formula_as_chemml: - THEN display "Accessible chemistry content". + IF closed_captions: + THEN display "Videos have closed captions".
    8. - IF math_formula_as_latex OR math_formula_as_mathml: - THEN display "Accessible math content". + IF open_captions: + THEN display "Videos have open captions".
    9. - IF (contains_charts_diagrams OR contains_chemical_formula OR contains_math_formula) AND NOT (long_text_descriptions OR chemical_formula_as_chemml OR math_formula_as_latex OR math_formula_as_mathml): - THEN display "No information is available". + IF transcript: + THEN display "Has transcript". +
      10. +
    10. + IF NOT (math_formula_as_mathml OR math_formula_as_latex OR (contains_math_formula AND short_textual_alternative_images) OR chemical_formula_as_mathml OR charts_diagrams_as_non_graphical_data OR full_alternative_textual_descriptions OR closed_captions OR open_captions OR transcript): + THEN either omit this key information if metadata is missing or display "No information is available".
    -
    From 393acada1a6d1240e9cf2c4f69d886369eace047 Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Sat, 28 Dec 2024 14:44:46 -0700 Subject: [PATCH 5/8] Updated alt text in nonvisual reading section --- .../2.0/draft/techniques/epub-metadata/index.html | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index a4a5dab8..71173f3c 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -316,6 +316,11 @@

    Variables setup

    Instructions

      +
    1. + IF textual_alternative_images: + THEN display "Has alt text". +
      2. +
    2. IF all_necessary_content_textual: THEN display "Readable in read aloud or dynamic braille". From 8c44baa5eb9a0b65e0b562546a9e8ee86813bc0e Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Sat, 28 Dec 2024 15:04:59 -0700 Subject: [PATCH 6/8] A few adjustments in strings --- .../2.0/draft/techniques/epub-metadata/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index 71173f3c..af141932 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -454,7 +454,7 @@

      Instructions

      IF certifier is NOT empty: THEN
        -
      • display "This publication was certified by "
        • +
      • display "The publication was certified by "
      • display certifier.
      3. @@ -474,7 +474,7 @@

      Instructions

    3. - Display "Detailed Conformance Information" as heading. + Display "Detailed conformance information" as heading.
      • display "This publication claims to meet ".
      • From d671abbd53b3c889218422c2b864d7cd5f07796e Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Mon, 30 Dec 2024 15:20:10 -0700 Subject: [PATCH 7/8] Made changes Gregorio pointed out --- .../2.0/draft/techniques/epub-metadata/index.html | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index af141932..5d15bec6 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -743,7 +743,7 @@

        Instructions

        THEN display "Math as LaTex".
      • - ELSE IF contains_math_formula AND short_textual_alternative_images: + ELSE IF contains_math_formula THEN display "Math as images with text description".
      • @@ -754,10 +754,8 @@

        Instructions

        IF chemical_formula_as_latex: THEN display "Chemical formulas in LaTex".
        • -rich-content-accessible- -rich-content-accessible-chemistry-as-latex -
      • - IF charts_diagrams_as_non_graphical_data OR full_alternative_textual_descriptions: +
      • + IF long_text_descriptions THEN display "Information-rich images are described by extended descriptions".
      • @@ -773,7 +771,7 @@

        Instructions

        THEN display "Has transcript".
      • - IF NOT (math_formula_as_mathml OR math_formula_as_latex OR (contains_math_formula AND short_textual_alternative_images) OR chemical_formula_as_mathml OR charts_diagrams_as_non_graphical_data OR full_alternative_textual_descriptions OR closed_captions OR open_captions OR transcript): + IF NOT (math_formula_as_mathml OR math_formula_as_latex OR (contains_math_formula AND long_text_descriptions) OR chemical_formula_as_mathml OR long_text_descriptions OR closed_captions OR open_captions OR transcript): THEN either omit this key information if metadata is missing or display "No information is available".
    From 427479731c1d3fbfe4315708f8491c8831b7d988 Mon Sep 17 00:00:00 2001 From: George Kerscher Date: Mon, 30 Dec 2024 23:59:04 -0700 Subject: [PATCH 8/8] Needed to add colon in some if then statements before display --- .../2.0/draft/techniques/epub-metadata/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html index 5d15bec6..b94a66c9 100755 --- a/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html +++ b/a11y-meta-display-guide/2.0/draft/techniques/epub-metadata/index.html @@ -743,7 +743,7 @@

    Instructions

    THEN display "Math as LaTex".
  • - ELSE IF contains_math_formula + ELSE IF contains_math_formula: THEN display "Math as images with text description".
  • @@ -755,7 +755,7 @@

    Instructions

    THEN display "Chemical formulas in LaTex".
  • - IF long_text_descriptions + IF long_text_descriptions: THEN display "Information-rich images are described by extended descriptions".