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

Report if required a11y metadata 'conformsTo' is absent. #171

Closed
marisademeglio opened this issue Feb 20, 2018 · 8 comments
Closed

Report if required a11y metadata 'conformsTo' is absent. #171

marisademeglio opened this issue Feb 20, 2018 · 8 comments
Assignees
Milestone

Comments

@marisademeglio
Copy link
Member

marisademeglio commented Feb 20, 2018

See http://www.idpf.org/epub/a11y/accessibility.html#sec-conf-reporting

We don't process <link> elements (as far as I know) so maybe that's why this isn't already included. The other a11y properties are <meta>s.

@marisademeglio marisademeglio self-assigned this Feb 20, 2018
@marisademeglio marisademeglio changed the title Report violation if required a11y metadata 'conformsTo' is absent. Report if required a11y metadata 'conformsTo' is absent. Feb 20, 2018
@laudrain
Copy link

We had discussions about that in France in "Normes&Standards" working group.
We are thoughtful about self-certification by the publisher, and considering a 2 steps process:

  • publishers (and epub producers) setup a conformance level
  • independant organisations can verify the conformance and declare certification
    Then the certifiedBy property would not be setup at production level.
    Are we diverging from this specification?

@rdeltour
Copy link
Member

Are we diverging from this specification?

No, the 2-step approach you’re describing sounds OK!

For clarification: the absence of conformsTo would not be reported as a violation, but the (its value or its absence) property should be reported along with other properties in the "Accessibility metadata" section.

@laudrain
Copy link

@rdeltour: thanks for the clarification.

@mattgarrish
Copy link

should be reported along with other properties in the "Accessibility metadata" section

It's currently only reported in the links section when present.

@marisademeglio
Copy link
Member Author

marisademeglio commented Apr 18, 2018

@rdeltour Is there any other property that would be in links that we want in the metadata table? I'm just running into an issue where this link property gets special treatment, separate from the others. It's fine but ugly.

Also, if we do want to include other link properties, should they just have their own table? Or should we rename our current one "metadata and links" ?

@rdeltour
Copy link
Member

@rdeltour Is there any other property that would be in links that we want in the metadata table?

Looking at the link vocabulary, I don’t think so.

Well, we could of course try to fetch and parse external metadata records, but I don’t think we want to go there just yet 🙂

Also, if we do want to include other link properties, should they just have their own table? Or should we rename our current one "metadata and links" ?

The conformsTo info should really be at the same place as the other a11y metadata info, so I wouldn’t put it in its own table. Renaming the table is fine, but then it’s a long name, does it integrate well in the UI?

@marisademeglio
Copy link
Member Author

The conformsTo info should really be at the same place as the other a11y metadata info, so I wouldn’t put it in its own table. Renaming the table is fine, but then it’s a long name, does it integrate well in the UI?

It's not as nice. We will just lump this one link property in with the metadata and call it all "metadata".

marisademeglio added a commit that referenced this issue Apr 19, 2018
The report includes dcterms:conformsTo in the metadata table and reports it as missing if it is not present.

The report also shows HTML entities correctly.

Some report helper functions have more consistent naming too.

Fixes #161
Fixes #171
@jenstroeger
Copy link

Helpful discussion, thank you!

Is it possible to derive the value of conformsTo from the results of an Ace run? Or need I provide that conformance level value myself? And if so, will that value be validated against the state of the document?

@rdeltour rdeltour added this to the v1.0.1 milestone May 25, 2018
rdeltour pushed a commit that referenced this issue May 25, 2018
The report includes dcterms:conformsTo in the metadata table and reports it as missing if it is not present.

The report also shows HTML entities correctly.

Some report helper functions have more consistent naming too.

Fixes #161
Fixes #171
rdeltour pushed a commit that referenced this issue May 25, 2018
The report includes dcterms:conformsTo in the metadata table and reports it as missing if it is not present.

The report also shows HTML entities correctly.

Some report helper functions have more consistent naming too.

Fixes #161
Fixes #171
rdeltour pushed a commit that referenced this issue May 25, 2018
The report includes dcterms:conformsTo in the metadata table and reports it as missing if it is not present.

The report also shows HTML entities correctly.

Some report helper functions have more consistent naming too.

Fixes #161
Fixes #171
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants