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

Document Physical Dimensions extension #1358

Open
azaroth42 opened this issue Dec 20, 2017 · 9 comments
Open

Document Physical Dimensions extension #1358

azaroth42 opened this issue Dec 20, 2017 · 9 comments

Comments

@azaroth42
Copy link
Member

Following #1269, the Physical Dimensions service is no longer a service but an extension. We need to document it, as it is used in the wild. E.g.: https://data.ucd.ie/api/img/manifests/ucdlib:33064

@azaroth42 azaroth42 added this to the Presentation 3.0 milestone Dec 20, 2017
@azaroth42
Copy link
Member Author

Can we find someone other than an editor to do this, as an easy test run of submitting an extension to be registered?

@workergnome
Copy link

Here's a first pass at this: https://gist.github.com/workergnome/01a3c617b0f5a6ee8a2fb51fc44666bf

To go along with it, here's a first pass at the documentation for writing extensions as tested on both this and a revised version of my palette extension.

https://gist.github.com/workergnome/a161d3376a950ac7e283e6ec6630e1ec

@zimeon
Copy link
Member

zimeon commented Feb 26, 2018

I wrote a comment on the gist but perhaps better to add here: The physdim extension looks good to me, I would be happy to import this into the prezi3 branch as /api/annex/exensions/physdim/index.md (to eventually become http://iiif.io/api/annex/exensions/physdim/) and roll any review/revision into the v3 process. We could then also use this extension as an example in the Image API v3 spec (in the full example, 5.8)

@workergnome
Copy link

Fine by me.

@azaroth42
Copy link
Member Author

Some minor comments on the referenced gist ...

  • Instead of type PhysicalDimension, it seems more like a Ratio or Scale. I would intuitively expect an array of PhysicalDimension objects referenced from a physicalDimensions property. PhysicalRatio ?
  • Do we need to talk about Duration for v3? I don't think so as there's no real scaling here.

And meta-wise:

  • Do we want the contexts to be in the extension HTML pages, or just referenced?

@zimeon
Copy link
Member

zimeon commented Feb 27, 2018

I was assuming context should be just referenced but was included in the gist for convenience

@zimeon
Copy link
Member

zimeon commented Feb 27, 2018

To the points above:

  • I think Ratio would be wrong -- this is a dimensioned concept: pixels to something with a length unit. I could imagine Scale but I don't really see any advantage in clarity overPhysicalDimesion
  • I agree that duration is not required, we already have real seconds

@workergnome
Copy link

I think a near-the-top link to the context would be useful, but I don't think there's a lot of value in explicitly writing it out--the documentation is more useful.

Don't have strong opinions abut the name--my only argument would be changing the name away from what it was called in prezi2 would add even more cognitive barriers for upgraders.

@azaroth42
Copy link
Member Author

For 4.0, proposal to bring this into the main spec, as any AR use will require it for 3d

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

3 participants