-
Notifications
You must be signed in to change notification settings - Fork 6
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
Canonical JSON #614
base: main
Are you sure you want to change the base?
Canonical JSON #614
Conversation
}, | ||
"conformance-certifier-report": { | ||
"compact": "For more information refer to the certifier's report", | ||
"descriptive": null |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably, instead of Null, we should reproduce the Compact.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can iterate over the json and automatically populate the null values with the compact ones at run time.
Or code the output so that you never attempt to use the descriptive statement in those cases that are null.
Or write some bloated checking to test if you need the descriptive statement and take the compact when it's null.
I can live with null values, in other words, although my preference would be to not have them. If it means we have to duplicate every string in the guidelines so they can be harvested, that might sway me the other way. But could the script that builds the json automatically insert the compact statement instead of null?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mattgarrish there is no need to have all the strings in the guidelines, I can fix the script that generates the JSON to use the same value for compact and descriptive, in case there is no descriptive
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would double up the strings, then, rather than use null.
We're already repeating the strings in the json for the no information available outputs.
"descriptive": null | ||
}, | ||
"conformance-epub-accessibility-1-0": { | ||
"compact": "EPUB Accessibility 1.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The whitespace needed to join these strings together is missing in the new output.
Hi,
in this PR you will find the first public version of the script for generating canonical JSON from the guidelines and techniques documents.
Also find the updated canonical JSON.
See you later!