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

Rename startCanvas to start, allow ref to part of a Canvas #1320

Closed
azaroth42 opened this issue Nov 17, 2017 · 11 comments
Closed

Rename startCanvas to start, allow ref to part of a Canvas #1320

azaroth42 opened this issue Nov 17, 2017 · 11 comments

Comments

@azaroth42
Copy link
Member

Now that Canvases can have a duration, the start of the startCanvas is not necessarily the beginning of the duration. It could be that the interesting part of the content begins on the first canvas, but not at the beginning of its duration. This would let the player initialize to a temporal offset within the Canvas, rather than playing the 10 seconds of silence or 3 minutes of audience noise at the beginning.
For x,y canvases, this would allow scrolling to a region of the Canvas, such as the most interesting part of the 150k px Princeton scroll.

Proposal: startCanvas can also refer to a Canvas with a fragment, in the same way that Ranges can.

@azaroth42 azaroth42 added this to the Presentation 3.0 milestone Nov 17, 2017
@tomcrane
Copy link
Contributor

Agree with the user experience, but is startCanvas is still the best name for this term? It's a simplified highlighting annotation used to initialise a viewer.

"startAt": "http://example.org/iiif/bladerunner/canvas/3#xywh=1000,1000,300,400&t=743.32"

A viewer that can be given a highlighting anno to initialise with can use exactly the same mechanism when the info is provided in the manifest.

I don't mind startCanvas though, for continuity. I'm not proposing startAt, just thinking about how obvious the intent is.

@jpstroop
Copy link
Member

start?

@azaroth42
Copy link
Member Author

While we're renaming things ... start is good. Gives us more scope in the future (c.f. contentLayer -> includes)

@tomcrane
Copy link
Contributor

👍 to start

@jpstroop
Copy link
Member

I realize it was my suggestion, but I can't think of a reason why start would bother me either. (backhanded 👍 )

@zimeon
Copy link
Member

zimeon commented Nov 21, 2017

👍 to start

@mikeapp
Copy link
Member

mikeapp commented Nov 21, 2017

👍 to start

@azaroth42
Copy link
Member Author

So new proposal, that I think we're all +1 on...

Proposal: Rename startCanvas to start and clarify that it can also refer to a Canvas with a fragment, in the same way that Ranges can.

@azaroth42 azaroth42 changed the title Allow startCanvas to refer to part of a Canvas Rename startCanvas to start, allow ref to part of a Canvas Dec 4, 2017
@mikeapp
Copy link
Member

mikeapp commented Dec 20, 2017

Community agreement on 12/20

@tomcrane
Copy link
Contributor

Can start point to a range as well? Skip past the audience noise and general hubbub, and start playing at the overture?

Allowing start to point to range makes this simpler to model, and still results in the same thing, player jumps to canvas/fragment. A client would effectively simulate the selection of that range in the UI.

@azaroth42
Copy link
Member Author

I think it should point to either a range or a canvas/part-of-canvas, but not either as then there'd be two ways to accomplish the same thing, forcing a decision on the production side and two implementations on the consumption side. I'd prefer just the Canvas, as there may not be an appropriate range that you'd want to expose. So I'm 👎 on start referencing a Range, unless there's some functionality that a Range would offer us over the Canvas (and then we could have it as /just/ the Range?)

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

No branches or pull requests

5 participants