IDPF / epub-guides

Informative guides covering production issues for EPUB Publications
9 stars 2 forks source link

Give concrete example of series metadata #1

Open jcsalomon opened 6 years ago

jcsalomon commented 6 years ago

Following up from the discussion at w3c/publ-epub-revision#326, the EPUB Package Metadata Guide should include a complete example of series metadata. For instance, this seems to me the correct way to indicate that the book Princess in Training is #6 in the Princess Diaries series:

<meta property="schema:isPartOf">Princess Diaries</meta>
<meta property="schema:position">4</meta>

or (following Calibre’s convention) that the book The Princess Present is between Books 6 & 7 in that series:

<meta property="schema:isPartOf">Princess Diaries</meta>
<meta property="schema:position">6.5</meta>

… but of course the actual provided example should be checked for correctness by people more familiar with the arcana of schema.org records than myself.

ghost commented 6 years ago

Idea: you might also want to give a concrete example of genre ("genre" in http://schema.org/Book ) and age range ("typicalAgeRange" in http://schema.org/Book ) metadata - those seem to me like commonly needed values as well.

ghost commented 6 years ago

Oh. I also just noticed, the guide you linked completely lacks a mention of <meta property="rdf:type">http://schema.org/Book</meta>.

This should really be reiterated on that page in a prominent place, or people are bound to forget that this line needs to be included to be able to use those metadata tags.

Edit: also I'm just noticing it doesn't even show where in the OPF those tags really go either - I think it would be a really good idea to add a full OPF example at the bottom showing some of those tags in practice so there is really no ambiguity at all. After all, this combination of standards can be a bit daunting and it doesn't help anyone if people mess up some detail and broken files start to circulate around.

BigBlueHat commented 6 years ago

@JonasT the RDFa typeof parameter maps to rdf:type: https://www.w3.org/TR/rdfa-core/#typing-resources-with-typeof

Maybe?

<body typeof="schema:Book">
ghost commented 6 years ago

@BigBlueHat I don't understand what you are suggesting (coming from the OPF here which usually doesn't have a <body> element). That is exactly why the manual here: https://idpf.github.io/epub-guides/package-metadata/ .. really needs a full OPF example at the bottom to show how it's integrated in practice.

ghost commented 6 years ago

I just tested this, rdf:... isn't currently accepted by epubchecker because rdf isn't a known namespace I think. (It makes sense I suppose, after all xmlns:dc is also linked to an external URL definition in the <metadata> root element.) However, this example doesn't have xmlns:rdf in the metadata root attributes: https://idpf.github.io/epub-guides/schema-org-integration/#h.2urrswf91171

schema:... works fine though.

Is this something that still needs to be added?

ell1e commented 2 years ago

Was this ever solved? What's the official way to specify a series in the latest spec?