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

Add which accessibilityFeature, accessibilityHazard, etc. is invalid in the HTML report #343

Closed
clapierre opened this issue Mar 12, 2021 · 3 comments

Comments

@clapierre
Copy link

Ace Command Line v1.1.1
When you report
metadata-accessibilityfeature-invalid or others like metadata-accessibilityhazard-invalid etc.

Under the details section it would be helpful to also report which item you are referring to.
ie: "resizeText" or could be a typo like "alterativeText"

Right now you have to go through every feature to see which one is incorrect, you obviously have this information so please add it in the description to make it easier.

Thanks

@danielweck
Copy link
Member

We are aware of several places in the report where the information could be more useful (another example: missing role attribute values alongside existing epub:type attributes, currently no hint is provided to help the user figure out the mapping)
This will be addressed in a future revision, the current development spring is a large refactoring of Ace + Axe, which will be released shortly.
#314

@danielweck
Copy link
Member

danielweck commented Jul 7, 2022

The JSON report contains the information:

"metadatainvalid": {
"kbtitle": "Schema.org Accessibility Metadata",
"resdesc": "Use one of the metadata values defined by schema.org",
"ruledesc": "'{{name}}' metadata must be set to one of the expected values",
"testdesc": "Value '{{value}}' is invalid for '{{name}}' metadata"
},

title: `metadata-${name.toLowerCase().replace('schema:', '')}-invalid`,
testDesc: localize("checkepub.metadatainvalid.testdesc", { value: splitValue, name, interpolation: { escapeValue: false } }),
resDesc: localize("checkepub.metadatainvalid.resdesc", { name, interpolation: { escapeValue: false } }),
kbPath: 'docs/metadata/schema.org/index.html',
kbTitle: localize("checkepub.metadatainvalid.kbtitle"),
ruleDesc: localize("checkepub.metadatainvalid.ruledesc", { name, interpolation: { escapeValue: false } })

.withTest(
new builders.TestBuilder()
.withImpact(impact)
.withTitle(title)
.withDescription(testDesc)
.withHelp(
KB_BASE + kbPath,
kbTitle,
resDesc)
.withRulesetTags(['EPUB'])
.build())
.withResult(
new builders.ResultBuilder('fail')
.withDescription(ruleDesc)
.build())
.build();

@danielweck
Copy link
Member

I checked that the HTML report contains the information too. This issue can be closed.

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

2 participants