-
Notifications
You must be signed in to change notification settings - Fork 33
0027 alternative page order #638
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
base: master
Are you sure you want to change the base?
Conversation
Use case:Change: Implementation NotesAdd a paragraph explaining the following from the spec: "user interfaces that interact with this order should use the order within the selected Range, rather than the default order of items." from the sequence text in https://iiif.io/api/presentation/3.0/#behavior Add a paragraph explaining that behaviour of a range can be a list and could include individuals or paged alongside sequence if you would like the range canvases to be shown as paginated. Also note ranges can have Restrictions:Sequence ranges need to be top order ranges (can’t be embedded in a table of contents). Text from specification: “Ranges that have the behavior value sequence must be directly within the structures property of the Manifest, and must not be embedded or referenced within other Ranges." from https://iiif.io/api/presentation/3.0/#54-range Example
Related recipesAdd a note to the table of contents recipe to say its an example of different way of using ranges. (for this type of note see: https://preview.iiif.io/cookbook/0045-css/recipe/0045-css/) OK to go to TRC if its possible to get the items above done. |
Also discussing renaming as alternative page sequences. |
Change title order to sequences
I have addressed to the issues highlighted by the editors, but the example section.
0027 - Post editors edit
As recommended, I have updated the Example with a case study kindly provided by the Biblioteca Civica Bertoliana. Changed the title to Alternative Page Order (previously Sequence). Fixed typos.
Images by permission of Biblioteca Civica Bertoliana.
Fixed behavior arrays Updated title Added provider
Updated manifest ranges to highlight
## Restrictions | ||
|
||
Ranges with `behavior` set to `sequence` indicate that they define an alternative reading order. Therefore, they: | ||
- "must be directly within the `structures` property of the Manifest, and must not be embedded or referenced within other Ranges" (see [Range section](https://iiif.io/api/presentation/3.0/#54-range)). This ensures that clients can easily locate all available sequences without traversing or resolving nested structures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put this up in the implementation section - this is just how it works, not a restriction.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good morning, and thank you for the feedback!
We included this in the Restrictions section because using Ranges for ordering purposes limits their use for other functionalities, such as a Table of Contents, which is also a common use case for book objects. We should probably make this more explicit.
|
||
Ranges with `behavior` set to `sequence` indicate that they define an alternative reading order. Therefore, they: | ||
- "must be directly within the `structures` property of the Manifest, and must not be embedded or referenced within other Ranges" (see [Range section](https://iiif.io/api/presentation/3.0/#54-range)). This ensures that clients can easily locate all available sequences without traversing or resolving nested structures. | ||
- cannot have `thumbnail-nav` or `no-nav` behaviors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about this - it's not a restriction per se, just that if someone were to use no-nav
the items wouldn't display. I'm not sure it needs to be mentioned as a restriction?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For clarity, we can move this to Implementation. We considered this a 'formal' restriction of the specification since sequence
is disjoint with no-nav
or thumbnail-nav
and must not be used together.
For an IIIF viewer to display the selectable Ranges, each Range should have a `label`. Additionally, for the viewer to be able to use the provided Ranges for ordering purposes, they must have the `behavior` value `sequence`. | ||
|
||
When `behavior` is set to `sequence`, "user interfaces that interact with this order should use the order within the selected Range, rather than the default order of items" ([Presentation API 3.0](https://iiif.io/api/presentation/3.0/#54-range)). | ||
Furthermore, the behavior property can be assigned to a list containing, besides `sequence`, other valid behaviors listed on the [behaviors section of the Presentation API](https://iiif.io/api/presentation/3.0/#behavior). These behaviors will work in combination with any behaviors inherited from the parent Manifest. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The suggestion for other behavior
properties was specifically about using paged
or individuals
to show that one can override the manifests behavior if resequencing affects the layout for some reason. As a general note about behavior being an array, I would probably remove it. Or, combine it with the paragraph below about viewingDirection
and simply say that one can add the viewingDirection
property and/or other behavior
values to overwrite manifest values. As it is now, this bit it somewhat confusing.
|
||
## Use Case | ||
|
||
A book may contain pages in the incorrect order; for example, a codex which was rebound at some point in history may have certain folios or quires accidentally misplaced. You want to digitally represent the book object in its current order while offering users the option to browse its contents in the intended order. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here you mention representing the book in its current order, then having intended order as the secondary option, but the example shows the reverse - should the example match the use case as described?
Reordering of sections for clarity Rework of range properties in Implementation Rework of Restrictions
Swapped orderings to better reflect the case study
Thanks again for the feedback. With @giacomomarchioro's previous edits as base:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would change the title to Alternative page sequences as Glen suggested, this will make the recipe easier to find for user that used Sequences in the past implementation.
No description provided.