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 sample publication #220

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add sample publication #220

wants to merge 7 commits into from

Conversation

mattgarrish
Copy link
Contributor

This converts the world cultures and geography textbook in the old IDPF samples project to an ebraille publication - at least as best I can do without a validator to double-check everything.

I haven't tried to update the content to match the braille best practices for markup and css, so this is only about the core requirements of the format.

I'm adding the fileset and a packaged ebraille publication in separate folders.

Comment on lines 18 to 19
<meta property="a11y:cellType">8</meta>
<meta property="a11y:code">UEB</meta>
Copy link
Member

Choose a reason for hiding this comment

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

Should this be cellType 6? I don't think there's a 8-dot UEB code. I think we also need to specify contracted or uncontracted.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ugh, yes, I copied the tag and wasn't thinking about the value!

The code value is also technically invalid since the text isn't formatted to any code at this point. I was just making sure all the required metadata was present.

Copy link
Member

Choose a reason for hiding this comment

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

Actually I did see some 8-dot cells, e.g. in ⠄⡳⠭⠆⠴⠆⠆⠄: this is a Liblouis thing, it's not UEB. It is a kind of escape sequence that was inserted for a character that was unknown to Liblouis.

Copy link
Member

Choose a reason for hiding this comment

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

(in this case it was the character "•" (U+2022))

Copy link
Member

Choose a reason for hiding this comment

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

@mattgarrish What do you mean by "text isn't formatted to any code"?

<header><h1 id="d20258e55-0" class="part"><span class="label" epub:type="label">⠠⠠⠥⠝⠊⠞</span>
<span class="ordinal" epub:type="ordinal">⠼⠁</span>⠤⠤⠠⠠⠔⠞⠗⠕⠙⠥⠉⠰⠝ ⠠⠠⠖⠠⠠⠸⠺ ⠠⠠⠉⠥⠇⠞⠥⠗⠑⠎ ⠠⠠⠯ ⠠⠠⠛⠑⠕⠛⠗⠁⠏⠓⠽</h1></header>
<figure>
<img src="images/wcag-p2-1.jpg" alt="Satellite view of the Earth at night. This image spans pages 2 and 3" id="wcag-p2-1" aria-describedby="pnote-p2-1"/>
Copy link
Member

Choose a reason for hiding this comment

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

Did we say we want to translated the alt attributes?

By the way, how did you produce the braille? If you used DAISY Pipeline, I could do a quick fix to also handle the necessary attributes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't remember how the braille was produced anymore. Too long ago and I didn't create the sample. I just grabbed the braille rendition of the epub here: https://github.com/IDPF/epub3-samples/tree/main/30/WCAG

I didn't make any changes to the content of the publication, so I'm sure there are all kinds of other issues. I figure we can clean that up later, as it'll need someone familiar with UEB to do it right.

Copy link
Member

Choose a reason for hiding this comment

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

Yes that seems like something that came from Pipeline.

Is it OK that if I discover issues like alt attribute one, I make a note here so we don't forget to fix it later?

@skntkacm
Copy link
Collaborator

skntkacm commented Jul 6, 2024

This is not any helpful comment, just an expression of gratitude - this seems already very concrete thing. Again, very exciting step in my view. I believe the appearance on a braille display will be up to the program used for viewing ebrl files in the future.

@skntkacm skntkacm closed this Jul 6, 2024
@skntkacm skntkacm reopened this Jul 6, 2024
@mattgarrish
Copy link
Contributor Author

I just pushed some cleanup of the markup to make the files a little more readable. I took out all the epub:type and class attributes, reformatted line lengths, added the page numbers, and other small stuff like that.

I linked the css file but stripped it of all its styles as I don't think most of that file even applies to this sample (it's for the whole textbook and we only have 15 pages or so). It'll be better to build it up with the styles we need than try to work from everything that was in it.

@bertfrees
Copy link
Member

Great!

Copy link
Collaborator

@wfree-aph wfree-aph left a comment

Choose a reason for hiding this comment

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

Thanks for working on this example file Matt. Sorry it took me so long to review. Looks good!

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

Successfully merging this pull request may close these issues.

4 participants