Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

<refines> clarification #374

Open
rickj opened this issue Aug 16, 2024 · 6 comments
Open

<refines> clarification #374

rickj opened this issue Aug 16, 2024 · 6 comments
Labels
a11y-display-guide Issue with the UX Guide principles or techniques

Comments

@rickj
Copy link
Collaborator

rickj commented Aug 16, 2024

There is one instance of refines in the techniques guide, as:
/package/metadata/meta[@Property="dcterms:date" and @refines=//meta[@Property="a11y:certifiedBy"]/@id]/text()

https://www.w3.org/TR/epub-a11y-11/ presents multiple examples of the use of refines for metadata other than as a date for certifiedBy.

Should:

  1. only the instance in the techniques guide be presented thru the user interface?
  2. only the examples in the EPUB 1.1 specification be presented?
  3. Every metadata item potentially accommodate a refines to augment the display to the user?
@rickj
Copy link
Collaborator Author

rickj commented Aug 16, 2024

The wording of https://www.w3.org/TR/epub-33/#attrdef-refines makes it sound like anything could have a refines attached to it.

@mattgarrish mattgarrish added the a11y-display-guide Issue with the UX Guide principles or techniques label Sep 5, 2024
@mattgarrish
Copy link
Member

As I mentioned on the call yesterday, the only case for refines for accessibility metadata is on the certifier information you've noted in the Accessibility 1.1 specification.

Looking at the epub techniques, it doesn't account for all the possibilities. I don't know if it matters a lot, as it's probably unlikely that there will be more than one certifier for a publication, so any reports and credentials will belong to that entity. But that's kind of a lazy approach that could fail in weird ways.

You can find refined metadata elsewhere, as Hadrien mentioned, like for creators, contributors, titles, and subjects, but since those aren't in scope of this document I assume you'd be handling them elsewhere in your metadata display to users.

@clapierre
Copy link
Collaborator

For example, Macmillan Learning has two conformsTo statements one for an internal conformance accessibility standard and then the WCAG 2.1 AA statement and there should be in this situation two certifiedBy with one being Macmillan themselves and the 2nd being a 3rd party certification which in our case is by Benetech with our GCA credential.

@mattgarrish
Copy link
Member

Macmillan Learning has two conformsTo statements

Then it should be incorporated into the xpaths. It probably complicates the display a bit, though.

@HadrienGardeur
Copy link

Macmillan Learning has two conformsTo statements one for an internal conformance accessibility standard […]

How do they declare conformance to these internal accessibility standards? With a string? With a URI?

I still believe that using strings for conformance (internal or not) is the wrong move and a list of well-known URIs that could be documented somewhere would work better.

URIs have the benefit of being dereferenceable, which could point to a page where Macmillan Learning would provide additional details about their own internal a11y standards. They're also much easier to validate and compare, which are important properties when used in the kind of if statements that we're documenting.

@clapierre
Copy link
Collaborator

clapierre commented Oct 11, 2024

How do they declare conformance to these internal accessibility standards? With a string? With a URI?

With a string @HadrienGardeur
<meta property="dcterms:conformsTo">Macmillan Learning Flat Accessible ePub Specification V5.1</meta>
We will encourage Macmillan to add the following

    <meta id="macmilan-accessibility" property="dcterms:conformsTo">Macmillan Learning Flat Accessible ePub Specification V5.1</meta>
    <meta property="a11y:certifiedBy" refines="#macmilan-accessibility">Macmillan Learning</meta>

Similarly for the conformance to WCAG and 3rd party certification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y-display-guide Issue with the UX Guide principles or techniques
Projects
None yet
Development

No branches or pull requests

4 participants