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

A guided-navigation structure is not an alternate rendition of a webpub manifest #14

Open
llemeurfr opened this issue Jul 30, 2024 · 3 comments
Labels

Comments

@llemeurfr
Copy link

In https://github.com/readium/guided-navigation?tab=readme-ov-file#22-publication-level the relation between the webpub manifest and the guided navigation structure is "alternate".
Semantically this is not the case. I propose a new rel value = "guided-navigation" (or guidedNavitation? I don't remember what is the standardized syntax)

"links": [
  {
    "rel": "guided-navigation",
    "href": "guided.json",
    "type": "application/guided-navigation+json"
  }
]
@HadrienGardeur
Copy link
Contributor

HadrienGardeur commented Jul 30, 2024

Since we already have a dedicated media type, I'm not entirely convinced that a new rel is needed as well.

We can use related as the rel value.

@llemeurfr
Copy link
Author

@danielweck may chime in here, as we discussed the topic yesterday. The proposal of merging media overlays and guided navigation may be a problem because when a reading system sees such a link in a manifest, it has no clue about the kind of processing it has to initialise.

@HadrienGardeur
Copy link
Contributor

HadrienGardeur commented Aug 1, 2024

@llemeurfr I don't see that as much of a threat.

Right now, the only thing you can encounter in an EPUB would be Media Overlays as Guided Navigation (technically you could also encounter region-based navigation, but we both know that there is absolutely zero support for that in the wild). Even if at some point we start encountering authored Guided Navigation Documents in EPUB files, we could further differentiate the two of them using:

  • additional rel values (we could easily roll out a dedicated value for MO)
  • or adapt the behaviour of our Guided Navigation experience by inspecting the content of the Guided Navigation Document

If you're really worried about that, we can preemptively decide what the rel value should be and implement this right away (starting with the Go toolkit).

We could use the URL of their specifications for that:

Let's adapt an example from EPUB 3.3 to see how this would look like with RWPM:

"readingOrder": [
  {
    "href": "chapter1.xhtml",
    "type": "application/xhtml+xml",
    "alternate": [
      {
        "href": "guided-chapter1.json",
        "type": "application/guided-navigation+json",
        "rel": "https://www.w3.org/TR/SMIL3/"
      }
    ]
  }
]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants