Skip to content

Fixes for A11y metadata #208

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
May 8, 2025
Merged

Fixes for A11y metadata #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fb1e1f0
fixes
chocolatkey Mar 18, 2025
917784a
fix incorrect link
chocolatkey Mar 18, 2025
d3a7463
fix bug in casing of DC element data
chocolatkey Mar 18, 2025
3399cf8
Merge branch 'develop' into a11y-refines-fix
chocolatkey Apr 22, 2025
55ee48e
Merge branch 'develop' into a11y-refines-fix
chocolatkey Apr 22, 2025
aa9dd97
Merge branch 'develop' into a11y-refines-fix
chocolatkey May 8, 2025
79abb26
added test nested a11y data
chocolatkey May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/manifest/contributor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (

// Contributor
// https://github.com/readium/webpub-manifest/tree/master/contexts/default#contributors
// https://github.com/readium/webpub-manifest/schema/contributor-object.schema.json
// https://github.com/readium/webpub-manifest/blob/master/schema/contributor-object.schema.json
type Contributor struct {
LocalizedName LocalizedString `json:"name" validate:"required"` // The name of the contributor.
LocalizedSortAs *LocalizedString `json:"sortAs,omitempty"` // The string used to sort the name of the contributor.
Expand Down
106 changes: 73 additions & 33 deletions pkg/parser/epub/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ func (m MetadataParser) parseMetaElement(element *xmlquery.Node) *MetadataItem {
id: element.SelectAttr("id"),
}
} else {
propName := strings.TrimSpace(element.SelectAttr("property"))
propName := strings.TrimSpace(property)
if propName == "" {
return nil
}
Expand Down Expand Up @@ -238,7 +238,7 @@ func (m MetadataParser) parseDcElement(element *xmlquery.Node) *MetadataItem {
}

data := strings.ToLower(element.Data)
propName := VocabularyDCTerms + data
propName := VocabularyDCTerms + element.Data
switch data {
case "creator", "contributor", "publisher":
c := m.contributorWithLegacyAttr(element, propName, propValue)
Expand Down Expand Up @@ -399,13 +399,18 @@ func (m metadataAdapter) FirstValue(property string) string {
return item.value
}

func itemsValues(items []MetadataItem) []string {
values := make([]string, len(items))
for i, item := range items {
values[i] = item.value
}
return values
}

func (m metadataAdapter) Values(property string) []string {
var values []string
if items, ok := m.items[property]; ok {
values = make([]string, len(items))
for i, item := range items {
values[i] = item.value
}
values = itemsValues(items)
}
return values
}
Expand Down Expand Up @@ -636,18 +641,38 @@ func (m PubMetadataAdapter) LocalizedSortAs() *manifest.LocalizedString {

func (m PubMetadataAdapter) Accessibility() *manifest.A11y {
a11y := manifest.NewA11y()
a11y.ConformsTo = m.a11yConformsTo()
a11y.Certification = m.a11yCertification()
a11y.Summary = m.a11ySummary()
a11y.AccessModes = m.a11yAccessModes()
a11y.AccessModesSufficient = m.a11yAccessModesSufficient()
a11y.Features = m.a11yFeatures()
a11y.Hazards = m.a11yHazards()
a11y.Exemptions = m.a11yExemptions()
ct, refinedA11y := m.a11yConformsTo()
a11y.ConformsTo = ct

certifierItem, _ := m.First(VocabularyA11Y + "certifiedBy")
a11y.Certification = m.a11yCertification(certifierItem)

a11y.Summary = m.FirstValue(VocabularySchema + "accessibilitySummary")

modeValues := m.Values(VocabularySchema + "accessMode")
a11y.AccessModes = valuesToAccessModes(modeValues)

sufficientValues := m.Values(VocabularySchema + "accessModeSufficient")
a11y.AccessModesSufficient = valuesToAccessModesSufficient(sufficientValues)

featureValues := m.Values(VocabularySchema + "accessibilityFeature")
a11y.Features = valuesToA11yFeatures(featureValues)

hazardValues := m.Values(VocabularySchema + "accessibilityHazard")
a11y.Hazards = valuesToA11yHazards(hazardValues)

exemptionValues := m.Values(VocabularyA11Y + "exemption")
a11y.Exemptions = valuesToA11yExemptions(exemptionValues)

if a11y.IsEmpty() {
return nil
}

// ConformsTo refinements merge with the main a11y data
if !refinedA11y.IsEmpty() {
a11y.Merge(&refinedA11y)
}

return &a11y
}

Expand All @@ -670,13 +695,32 @@ func (m PubMetadataAdapter) TDM() *manifest.TDM {
return tdm
}

func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile {
func (m PubMetadataAdapter) a11yConformsTo() ([]manifest.A11yProfile, manifest.A11y) {
profiles := manifest.A11yProfileList{}
a11y := manifest.NewA11y()

if items, ok := m.items[VocabularyDCTerms+"conformsto"]; ok {
if items, ok := m.items[VocabularyDCTerms+"conformsTo"]; ok {
for _, item := range items {
if profile := a11yProfile(item.value); profile != "" {
profiles = append(profiles, profile)
for k, v := range item.children {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I read correctly that the refined metadata of the last conformsTo declared will override all the other accessibility metadata? In which case we're loosing the other metadata (global or refined). Is this what we want @HadrienGardeur?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I'm following that one since conformsTo should be an array of URIs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand the code correctly this will parse the a11y metadata that are refining each dc:conformsTo tags. Although I didn't know that <dc:conformsTo> could be refined, I thought only <meta> with an ID could.

@chocolatkey Do you have an OPF example that this is supposed to parse?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the example that we were using: https://github.com/standardebooks/nathaniel-hawthorne_the-house-of-the-seven-gables/blob/master/src/epub/content.opf#L19

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha I see, in that case my initial question stands. We can have several conformances with different IDs and their own refinements.

<meta id="conformance-statement" property="dcterms:conformsTo">EPUB Accessibility 1.1 - WCAG 2.2 Level AA</meta>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then it's probably a limitation of our model because the certification object isn't tied to a particular conformsTo.

I'm hesitant to shake things up though, because it seems quite unlikely that you'd get certified multiple times (in most countries, there won't be a certification process at all).

switch k {
case VocabularyA11Y + "certifiedBy":
a11y.Certification = m.a11yCertification(v[0])
case VocabularySchema + "accessibilitySummary":
a11y.Summary = v[0].value
case VocabularySchema + "accessMode":
a11y.AccessModes = valuesToAccessModes(itemsValues(v))
case VocabularySchema + "accessModeSufficient":
a11y.AccessModesSufficient = valuesToAccessModesSufficient(itemsValues(v))
case VocabularySchema + "accessibilityFeature":
a11y.Features = valuesToA11yFeatures(itemsValues(v))
case VocabularySchema + "accessibilityHazard":
a11y.Hazards = valuesToA11yHazards(itemsValues(v))
case VocabularyA11Y + "exemption":
a11y.Exemptions = valuesToA11yExemptions(itemsValues(v))
}
}
}
}
}
Expand All @@ -688,7 +732,7 @@ func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile {
}

profiles.Sort()
return profiles
return profiles, a11y
}

func a11yProfile(value string) manifest.A11yProfile {
Expand Down Expand Up @@ -722,13 +766,18 @@ func a11yProfile(value string) manifest.A11yProfile {
return manifest.EPUBA11y11WCAG21AA
case "EPUB Accessibility 1.1 - WCAG 2.1 Level AAA":
return manifest.EPUBA11y11WCAG21AAA
case "EPUB Accessibility 1.1 - WCAG 2.2 Level A":
return manifest.EPUBA11y11WCAG22A
case "EPUB Accessibility 1.1 - WCAG 2.2 Level AA":
return manifest.EPUBA11y11WCAG22AA
case "EPUB Accessibility 1.1 - WCAG 2.2 Level AAA":
return manifest.EPUBA11y11WCAG22AAA
default:
return ""
}
}

func (m PubMetadataAdapter) a11yCertification() *manifest.A11yCertification {
certifierItem, _ := m.First(VocabularyA11Y + "certifiedBy")
func (m PubMetadataAdapter) a11yCertification(certifierItem MetadataItem) *manifest.A11yCertification {
c := manifest.A11yCertification{
CertifiedBy: certifierItem.value,
}
Expand Down Expand Up @@ -756,21 +805,15 @@ func (m PubMetadataAdapter) a11yCertification() *manifest.A11yCertification {
return &c
}

func (m PubMetadataAdapter) a11ySummary() string {
return m.FirstValue(VocabularySchema + "accessibilitySummary")
}

func (m PubMetadataAdapter) a11yAccessModes() []manifest.A11yAccessMode {
values := m.Values(VocabularySchema + "accessMode")
func valuesToAccessModes(values []string) []manifest.A11yAccessMode {
am := make([]manifest.A11yAccessMode, len(values))
for i, v := range values {
am[i] = manifest.A11yAccessMode(v)
}
return am
}

func (m PubMetadataAdapter) a11yAccessModesSufficient() [][]manifest.A11yPrimaryAccessMode {
values := m.Values(VocabularySchema + "accessModeSufficient")
func valuesToAccessModesSufficient(values []string) [][]manifest.A11yPrimaryAccessMode {
ams := make([][]manifest.A11yPrimaryAccessMode, 0, len(values))
for _, v := range values {
c := a11yAccessModesSufficient(v)
Expand All @@ -793,26 +836,23 @@ func a11yAccessModesSufficient(value string) []manifest.A11yPrimaryAccessMode {
return ams
}

func (m PubMetadataAdapter) a11yFeatures() []manifest.A11yFeature {
values := m.Values(VocabularySchema + "accessibilityFeature")
func valuesToA11yFeatures(values []string) []manifest.A11yFeature {
features := make([]manifest.A11yFeature, len(values))
for i, v := range values {
features[i] = manifest.A11yFeature(v)
}
return features
}

func (m PubMetadataAdapter) a11yHazards() []manifest.A11yHazard {
values := m.Values(VocabularySchema + "accessibilityHazard")
func valuesToA11yHazards(values []string) []manifest.A11yHazard {
hazards := make([]manifest.A11yHazard, len(values))
for i, v := range values {
hazards[i] = manifest.A11yHazard(v)
}
return hazards
}

func (m PubMetadataAdapter) a11yExemptions() []manifest.A11yExemption {
values := m.Values(VocabularyA11Y + "exemption")
func valuesToA11yExemptions(values []string) []manifest.A11yExemption {
exemptions := make([]manifest.A11yExemption, len(values))
for i, v := range values {
exemptions[i] = manifest.A11yExemption(v)
Expand Down
20 changes: 20 additions & 0 deletions pkg/parser/epub/metadata_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"github.com/readium/go-toolkit/pkg/mediatype"
"github.com/readium/go-toolkit/pkg/util/url"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func loadMetadata(ctx context.Context, name string) (*manifest.Metadata, error) {
Expand Down Expand Up @@ -361,6 +362,25 @@ func TestMetadataEPUB3Accessibility(t *testing.T) {
assert.Nil(t, m.OtherMetadata["accessibility"])
}

func TestMetadataEPUB3AccessibilityRefines(t *testing.T) {
m, err := loadMetadata(t.Context(), "accessibility-refines")
require.NoError(t, err)
e := manifest.NewA11y()
e.Summary = "This publication conforms to WCAG 2.2 Level AA."
e.ConformsTo = []manifest.A11yProfile{manifest.EPUBA11y11WCAG22AA}
e.Certification = &manifest.A11yCertification{
CertifiedBy: "Standard Ebooks",
}
e.AccessModes = manifest.A11yAccessModesFromStrings([]string{"textual"})
e.AccessModesSufficient = [][]manifest.A11yPrimaryAccessMode{
a11yAccessModesSufficient("textual"),
}
e.Features = valuesToA11yFeatures([]string{"readingOrder", "structuralNavigation", "tableOfContents", "unlocked"})
e.Hazards = valuesToA11yHazards([]string{"none"})
assert.Equal(t, &e, m.Accessibility)
assert.Nil(t, m.OtherMetadata["accessibility"])
}

func TestMetadataEPUB3TDM(t *testing.T) {
m, err := loadMetadata(t.Context(), "tdm-epub3")
assert.NoError(t, err)
Expand Down
27 changes: 27 additions & 0 deletions pkg/parser/epub/testdata/package/accessibility-refines.opf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://www.idpf.org/2007/opf" dir="ltr" prefix="se: https://standardebooks.org/vocab/1.0" unique-identifier="uid" version="3.0" xml:lang="en-US">
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
<dc:identifier id="uid">url:https://standardebooks.org/ebooks/nathaniel-hawthorne/the-house-of-the-seven-gables</dc:identifier>
<meta property="dcterms:modified">2024-10-02T02:28:18Z</meta>
<dc:publisher id="publisher">Standard Ebooks</dc:publisher>
<meta id="conformance-statement" property="dcterms:conformsTo">EPUB Accessibility 1.1 - WCAG 2.2 Level AA</meta>
<meta property="a11y:certifiedBy" refines="#conformance-statement">Standard Ebooks</meta>
<meta property="schema:accessMode">textual</meta>
<meta property="schema:accessModeSufficient">textual</meta>
<meta property="schema:accessibilityFeature">readingOrder</meta>
<meta property="schema:accessibilityFeature">structuralNavigation</meta>
<meta property="schema:accessibilityFeature">tableOfContents</meta>
<meta property="schema:accessibilityFeature">unlocked</meta>
<meta property="schema:accessibilityHazard">none</meta>
<meta property="schema:accessibilitySummary">This publication conforms to WCAG 2.2 Level AA.</meta>
<dc:title id="title">The House of the Seven Gables</dc:title>
<!--Deleted-->
<dc:language>en-US</dc:language>
</metadata>
<manifest>
<item href="text/titlepage.xhtml" id="titlepage.xhtml" media-type="application/xhtml+xml" />
</manifest>
<spine>
<itemref idref="titlepage.xhtml"/>
</spine>
</package>