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

WIP: Guided Navigation #181

Merged
merged 17 commits into from
Jul 9, 2024
Merged

WIP: Guided Navigation #181

merged 17 commits into from
Jul 9, 2024

Conversation

HadrienGardeur
Copy link
Contributor

@HadrienGardeur HadrienGardeur commented Feb 13, 2023

This is a WIP for a new take on Media Overlay with an updated scope to cover more media.

Some of our design goals include:

  • support for image references, video references and text in addition to audio and text references
  • synchronized media is essentially an alternate reading order, not necessarily following the "normal" reading order of a publication
  • instead of an EPUB-specific approach, this is meant to be generic enough to work on audiobooks and comics (Divina) as well

Preview link: https://github.com/readium/architecture/tree/sync-media/models/guided

@HadrienGardeur HadrienGardeur changed the title Synchronized Media WIP: Synchronized Media Feb 13, 2023
models/sync-media/syntax.md Outdated Show resolved Hide resolved
models/sync-media/README.md Outdated Show resolved Hide resolved
]
```

### Linked and chained
Copy link
Member

Choose a reason for hiding this comment

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

This has the advantage of being more compact in the manifest, and allow to specify multiple sync media in a single publication (maybe with rel or additional metadata).

Copy link
Contributor

Choose a reason for hiding this comment

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

I may not get the point, but I would expect a simple and natural way to define multiple synchronized reading orders.


```json
{
"textref": "chapter1.html",
Copy link
Member

Choose a reason for hiding this comment

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

What's the purpose of the xrefs in grouping elements? Does it limit the children to a given scope?


```json
{
"textref": "chapter1.html#par1",
Copy link
Member

Choose a reason for hiding this comment

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

I'm concerned that we can't synchronize two media of the same type, which would be useful for parallel texts.

models/sync-media/README.md Outdated Show resolved Hide resolved
models/sync-media/README.md Outdated Show resolved Hide resolved
@danielweck
Copy link
Member

Also see: readium/webpub-manifest#83

@HadrienGardeur
Copy link
Contributor Author

I'm thinking of moving this work to its own repo/project, probably guided-navigation.

I expect that there will be enough material to warrant this, just like we did with webpub-manifest. There's not much overall in this PR, so rewriting this into more of a spec sounds like a good idea anyway.

@HadrienGardeur HadrienGardeur marked this pull request as ready for review July 9, 2024 16:11
@HadrienGardeur HadrienGardeur merged commit 880300e into master Jul 9, 2024
@HadrienGardeur HadrienGardeur deleted the sync-media branch July 9, 2024 16:12
@HadrienGardeur
Copy link
Contributor Author

I've merged this PR but all of the work dedicated to the Guided Navigation document is now handled in its own separate repo: https://github.com/readium/guided-navigation/

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.

None yet

5 participants