-
Notifications
You must be signed in to change notification settings - Fork 7
First draft for placeholder #732
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
Conversation
As discussed in issue #688
Just on a skim this looks fine, but it's a headache to implement to test. If I switch over to placeholders, either I have to duplicate the code to continue to account for the 2.0 files or I'm back to only being able to display English. We should try and hurry this revision along after adding, perhaps not taking up any additional issues, so we can deprecate 2.0 and get the translations updated. |
One issue I noticed that's not directly covered here is the certifier's report. The algorithm says to replace the entire string with a hyperlink, but the examples in the guidelines show only the words "certifier's report" hyperlinked. The guidelines approach makes more sense, but is there a way to accommodate that with a placeholder since it's not possible to know what words to hyperlink in any other language. (edit: changed last sentence from suggesting percent sign to bracket since we are using braces.) |
a11y-meta-display-guide/2.1/draft/techniques/onix-metadata/index.html
Outdated
Show resolved
Hide resolved
I've finished implementing this now. The only other slightly tangential comment I have is that maybe we should say something about localizing the date, not just to replace the placeholder with whatever value you get from the metadata. No matter the language it may need some processing, if not to turn the date into the local language then to process out an attached time. It could just go in the variable setup description, but it's a unique case of localizing the publisher data. |
in the guidelines for more information on how to present these strings.</p> | ||
</div> | ||
|
||
<span><b>IF</b> <var>epub_accessibility_10</var> <b>OR</b> <var>epub_accessibility_11</var> <b>OR</b> <var>wcag_20</var> <b>OR</b> <var>wcag_21</var> <b>OR</b> <var>wcag_22</var> <b>OR</b> <var>level_aaa</var> <b>OR</b> <var>level_aa</var> <b>OR</b> <var>level_a</var>:</span> |
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.
@clapierre made me aware that if you don't have complete metadata this section will generate some weird statements like "This publication claims to conform to EPUB Accessibility 1.1 Level AA" or even just "This publication claims to conform to Level AA" after processing the placeholders.
To avoid this, the test here might need to be modified to be more thorough in what is expected. To check that we get complete statements it could be:
IF (epub_accessibility_10 OR epub_accessibility_11) AND (wcag_20 OR wcag_21 OR wcag_22) AND (level_aaa OR levela_aa OR level_a):
If we really need to support wcag conformance statements without accompany epub accessibility conformance, then it gets harder as you'd have to test that the epub statements aren't also accompanied by partial wcag statements.
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 should have fixed this.
I have included a dedicated instruction for formatting the date and a note explaining why, with examples. |
…ex.html Co-authored-by: Matt Garrish <[email protected]>
Waiting for @mickael-menu & @HadrienGardeur feedback as they originated the issue. |
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.
It looks good and addresses the issues I raised in #688. Thank you all.
As discussed in issue #688