search

daisy / ebraille

Repository for developing use cases and standard for digital braille
16 stars 4 forks source link

Explain manifest and spine in more detail #178

Closed mattgarrish closed 1 month ago

mattgarrish commented 1 month ago

Similar to the media overlays PR, I've expanded the sections on the package document manifest and spine to explain a bit more what they are for, what is required of them, and to give some examples. Additional links are provided to the fuller epub definitions.

mattgarrish commented 1 month ago

shouldn't you also include the image itself in the images folder?

I try to keep the examples as minimal as possible to avoid confusion. There wouldn't be a connection between the entries absent html markup to show the svg referenced from an img or object tag. And that'd be making a massive example just to show a single attribute value.

But maybe what I can do is add a description to the example to explain what it means that it has embedded svg.

GeorgeKerscher commented 1 month ago

Looks good.

mattgarrish commented 1 month ago

why did you change from xhtml to html?

To be consistent with using .html for the navigation document/primary entry page.

The extension doesn't define how the contents are rendered, so .html can be used for both syntaxes. Browsers use the media type the file is served as to determine which parser to use, but in the case of epub and ebraille it's irrelevant since the reading system should always be serving the files as xhtml.

Since we talk about serving ebraille file sets on the web, it may be worth noting the need for the correct media type in another section, maybe in the reading system section. Let's deal with this in another pull request, though.

mattgarrish commented 1 month ago

For the record, epub doesn't require .xhtml extensions, either. It used to be a recommendation, but that got tossed in 3.3 along with a lot of other file extension requirements..