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

Clarify credentials need to be associated with certifier #1410

Closed
mattgarrish opened this issue Nov 7, 2020 · 12 comments · Fixed by #1435
Closed

Clarify credentials need to be associated with certifier #1410

mattgarrish opened this issue Nov 7, 2020 · 12 comments · Fixed by #1435
Labels
Accessibility11 Issues addressed in the Accessibility 1.1 revision Cat-Accessibility Grouping label for all accessibility related issues Spec-Accessibility The issue affects the EPUB Accessibility 1.1 Recommendation Topic-Accessibility-Vocab The issue affects the EPUB Accessibility vocabulary

Comments

@mattgarrish
Copy link
Member

The current definition of certifierCredential states:

Identifies a credential or badge that establishes the authority of the party identified in the certifiedBy property to certify content accessible

This is too general a statement, as more than one certification can be listed, so more than one certifier can be listed, too.

We didn't use the refines attribute to tie the two together because it was expected to be deprecated in 3.1, but we should correct that now.

The definition should say "in the associated certifiedBy property" and the refines attribute should be added to the example.

/cc @GeorgeKerscher @avneeshsingh @clapierre

@mattgarrish mattgarrish added Cat-Accessibility Grouping label for all accessibility related issues Spec-Accessibility The issue affects the EPUB Accessibility 1.1 Recommendation Topic-Accessibility-Vocab The issue affects the EPUB Accessibility vocabulary labels Nov 7, 2020
@clapierre
Copy link
Contributor

Question, couldn't the certifierCredential or "badge" be an actual stamp/logo (ie. image) within the EPUB, along with a text description of the credential? Right now its a text string which could be a URL or plain text of the credentials name.

This has become somewhat problematic with Vitalsource & Redshelf who wished to show this badge for those EPUBs which has this metadata. Now out-of-band mechanism between a library / bookstore and the certifiedBy party is needed to provide this image with its description for those EPUBs with a specific certifierCredential.

@GeorgeKerscher
Copy link

GeorgeKerscher commented Nov 9, 2020 via email

@mattgarrish
Copy link
Member Author

It's potentially overloading one piece of metadata to try and make it both a credential and a logo. A logo sounds like a separate piece of information.

There's also a question of whether a logo is something that belongs in the container, as wouldn't you want everyone to reference a version that is always up to date?

And once it's at least probable to be hosted outside the container, a manifest mechanism for alt text isn't going to help, since you can't reference remote images.

I'd imagine the credential name is probably your alt text in most cases, though. As to identifying a logo, that probably belongs in a link element. The question becomes how convoluted is it to express that there is a logo for a credential for a certifier. We're really pushing the boundaries of EPUB's lack of structured metadata.

It might help to cook up some examples of how this might work.

@mattgarrish
Copy link
Member Author

mattgarrish commented Nov 9, 2020

Here's at least what I'm picturing:

<meta property="a11y:certifiedBy" id="cert">Ronald Ruck</meta>
<meta property="a11y:certifierCredential" id="cred" refines="#cert">A11y Credential</meta>
<link rel="icon" href="https://example.org/credential/a11y.svg" refines="#cred"/>

(Not sure if icon is the best rel, but was the first thing that came to mind.)

@clapierre
Copy link
Contributor

clapierre commented Nov 9, 2020

This is what I was thinking as well Matt.
If the author wanted to include the icon inside the EPUB would it be

<link rel="icon" href="../images/cover.jpg/a11y.svg" refines="#cred"/>

@mattgarrish
Copy link
Member Author

I'm going to open a new issue about images so this one can stay focused on adding refines back.

@mattgarrish
Copy link
Member Author

Proposed Solution

Update the definitions for both certifierCredential and certifierReport to make clear that they are associated with the certifiedBy property and update the examples to include the refines attribute.

@mattgarrish mattgarrish added the Status-Proposed Solution A proposed solution has been included in the issue for working group review label Nov 17, 2020
@mattgarrish mattgarrish added the Accessibility11 Issues addressed in the Accessibility 1.1 revision label Nov 17, 2020
@clapierre
Copy link
Contributor

(Not sure if icon is the best rel, but was the first thing that came to mind.)

According to our marketing department usually these are called "Marks" or "Stamps". Icon can work too I suppose.

@iherman
Copy link
Member

iherman commented Dec 11, 2020

The issue was discussed in a meeting on 2020-12-10)

List of resolutions:

  • Resolution No. 2: associate CertifiedBy with CertifierCredentials with refine.
View the transcript

3. Clarify credentials need to be associated with certifier

See github issue #1410.

Avneesh Singh: credentials refine certifier, but this relationship is not clear in the spec.
… Matt G suggested that we formalize this relationship.

Matthew Chan: Matt G's example #1410 (comment).

Proposed resolution: associate CertifiedBy with CertifierCredentials with refine. (Avneesh Singh)

Matthew Chan: +1.

Charles LaPierre: +1.

Ben Schroeter: +1.

Juliette McShane: +1.

Bill Kasdorf: +1.

Jun’Ichi Yoshii: +1.

George Kerscher: +1.

Laura Brady: +1.

Resolution #2: associate CertifiedBy with CertifierCredentials with refine.

@mattgarrish mattgarrish removed the Status-Proposed Solution A proposed solution has been included in the issue for working group review label Dec 16, 2020
@murata2makoto
Copy link
Contributor

I have nothing against this resolution. But I'm wondering if we should submit a defect report to ISO about this. I certainly do not want to publish a JIS without mentioning the use of the refines attribute for associating CertifiedBy with CertifierCredentials.

@mattgarrish
Copy link
Member Author

But I'm wondering if we should submit a defect report to ISO about this.

Do we need to wait until this document becomes a recommendation to ensure the changes will become "official"?

@murata2makoto
Copy link
Contributor

@mattgarrish No, we do not have to wait since the ISO/IEC version is not intended to be technically identical to any specification (including the W3C submission). However, if EPUB A11Y 1.0 is going to be used (together with its own URI), we should ideally drop these two from the ISO/IEC version as well as the W3C submission. But can we change the submission?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accessibility11 Issues addressed in the Accessibility 1.1 revision Cat-Accessibility Grouping label for all accessibility related issues Spec-Accessibility The issue affects the EPUB Accessibility 1.1 Recommendation Topic-Accessibility-Vocab The issue affects the EPUB Accessibility vocabulary
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants