-
Notifications
You must be signed in to change notification settings - Fork 33
First pass of a v4 cookbook #598
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
Open
glenrobson
wants to merge
35
commits into
master
Choose a base branch
from
v4
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
42dbef4
First pass of a v4 recipe
glenrobson 1eeeed0
Pausing validation
glenrobson 7a6b77e
Reversing if statement to default to 3
glenrobson 485a655
Don't need to specify supported versions
glenrobson 68240e1
Adding a v3/v4 link to homepage
glenrobson adc723b
Making version more prominent and defaulting to 3
glenrobson 16875c4
Fixing link
glenrobson 18a6bc1
Updated for IIIF Presentation v4 🆙
triplingual 3f476a9
Added new files for v4 structure and content ➕
triplingual 1943076
Increased clarity and specificity of label value 🛠️
triplingual 1ec93b0
Added highlighting for new-to-v4 Type value 🎨
triplingual 320a34c
Added convenience links to the two parts of the v4 spec ➕
triplingual 571b9fb
Mentioned v4 difference and linked to appropriate spec section 📝
triplingual b0fb77e
Updated Implementation Notes body text for v4 📝
triplingual a2303d4
Removed incorrect and unnecessary info 🚮
triplingual 91920dc
Re-centered recipe title 🎨
triplingual 45b0edf
Edited per cookbook authors call to leave behind comparisons to MVM I…
triplingual eaceab4
Reworded related recipe text, added 3D related 📝⛓️
triplingual 2398efc
Moved highlighting to the correct template place 🚚🤦🏻♂️
triplingual e0d487e
Added entry for prezi4 version of the recipe ➕
triplingual aa76f6a
Sorted links numerically for readability 🔢
triplingual c24d847
first version of updated simplest video recipe for v4
robcast 0dc6074
Removed duplicative TOC entry 🚮
triplingual c0c17ba
Updated IDs semantically and functionally (in the case of target) 📝🆙
triplingual 1840d82
add v4 magic and links.
robcast 5fcdbc1
fix more v4 path issues.
robcast 509f93b
Merge pull request #611 from IIIF/v4-0003-simplest-manifest-video
glenrobson 9090a80
Merge branch 'v4' into v4-0002-simplest-manifest-audio
triplingual 6172cad
Merge pull request #607 from IIIF/v4-0002-simplest-manifest-audio
triplingual 4352337
Fixing links to keep in v4 area of cookbook
glenrobson 31e621d
Adding 3d model
glenrobson 003aeef
Removing viewers
glenrobson 5517e82
Merge pull request #612 from IIIF/v4-fixes-3d
glenrobson 1e0065e
Update links.md
glenrobson 5db0e1f
Merge pull request #619 from IIIF/glenrobson-patch-1
glenrobson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| ## Use Case | ||
|
|
||
| The simplest viable manifest for image content. If all you have for an object is one image on the web and a label to go along with it, this pattern turns it into a IIIF Presentation resource. If you would like to enable deep zooming, you will need to use a IIIF Image server. For this, see the [Support Deep Viewing with Basic Use of a IIIF Image Service][0005] recipe. | ||
|
|
||
| ## Implementation Notes | ||
|
|
||
| This illustrates the mandatory structure and properties of a manifest, with the simplest possible content. | ||
|
|
||
| The JSON-LD opens with the `@context` declaration, which identifies the terms used in the document as belonging to the IIIF specification. The `id` property identifies this manifest with the URL at which it is available online. The `type` property must be `Manifest`. The `label` property is mandatory, and the language of its value must be given (or the special value `none`), using a [language map][prezi3-languages]. Here the language of the label is English and its value is "Single Image Example". The manifest's `items` property is a list of canvases. In this example there is only one canvas, with a `height` of 1800 and a `width` of 1200. These units have no dimension: they establish a coordinate space that in this case the single image will fill. The canvas's `id` property is used later as the `target` of the annotation that links to the single image. | ||
|
|
||
| The `items` property of the Canvas is a list of annotation pages, in this case there is only one page. The `items` property of the annotation page is a list of annotations, in this case there is only one annotation. This annotation is what links the image resource with the canvas. The `body` of the annotation is an image, the url of which is the `id` property of the body. The dimensions of the image, in pixels, are given and here match the canvas dimensions exactly. The `target` property tells us that the image is associated with the entirety of the canvas, and the `motivation` property of `painting` tells us that a client should render the image to fill the canvas. | ||
|
|
||
| ## Restrictions | ||
|
|
||
| This recipe is not for large images or deep zoom functionality. For this, see the [Support Deep Viewing with Basic Use of a IIIF Image Service][0005] recipe. | ||
|
|
||
| ## Example | ||
|
|
||
| {% include manifest_links.html manifest="manifest.json" version="3" %} | ||
|
|
||
| {% include jsonviewer.html src="manifest.json" %} | ||
|
|
||
| # Related Recipes | ||
|
|
||
| * [Simplest Manifest - Audio][0002] and [Simplest Manifest - Video][0003] are equivalent to this example but for other media. | ||
| * [Support Deep Viewing with Basic Use of a IIIF Image Service][0005] shows a basic manifest for use with a IIIF Image server. | ||
| * [Image different size to canvas][0004] shows a canvas with dimensions different from the pixel dimensions of its content. | ||
| * [Multiple values and languages][0006] demonstrates language map variations, for multiple values and multiple languages. | ||
|
|
||
|
|
||
| {% include acronyms.md %} | ||
| {% include links.md %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "@context": "http://iiif.io/api/presentation/4/context.json", | ||
| "id": "{{ id.url }}", | ||
| "type": "Manifest", | ||
| "label": { "en": [ "Single Image Example" ] }, | ||
| "items": [ | ||
| { | ||
| "id": "{{ id.path }}/canvas/p1", | ||
| "type": "Canvas", | ||
| "height": 1800, | ||
| "width": 1200, | ||
| "items": [ | ||
| { | ||
| "id": "{{ id.path }}/page/p1/1", | ||
| "type": "AnnotationPage", | ||
| "items": [ | ||
| { | ||
| "id": "{{ id.path }}/annotation/p0001-image", | ||
| "type": "Annotation", | ||
| "motivation": "painting", | ||
| "body": { | ||
| "id": "http://iiif.io/api/presentation/2.1/example/fixtures/resources/page1-full.png", | ||
| "type": "Image", | ||
| "format": "image/png", | ||
| "height": 1800, | ||
| "width": 1200 | ||
| }, | ||
| "target": "{{ id.path }}/canvas/p1" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
|
|
||
| ## Use Case | ||
|
|
||
| The simplest viable manifest for image content. If all you have for an object is one image on the web and a label to go along with it, this pattern turns it into a IIIF Presentation resource. If you would like to enable deep zooming, you will need to use a IIIF Image server. For this, see the [Support Deep Viewing with Basic Use of a IIIF Image Service (v3)][0005] recipe. | ||
|
|
||
| ## Implementation Notes | ||
|
|
||
| This illustrates the mandatory structure and properties of a manifest, with the simplest possible content. | ||
|
|
||
| The JSON-LD opens with the `@context` declaration, which identifies the terms used in the document as belonging to the IIIF specification. The `id` property identifies this manifest with the URL at which it is available online. The `type` property must be `Manifest`. The `label` property is mandatory, and the language of its value must be given (or the special value `none`), using a [language map][prezi3-languages]. Here the language of the label is English and its value is "Single Image Example". The manifest's `items` property is a list of canvases. In this example there is only one canvas, with a `height` of 1800 and a `width` of 1200. These units have no dimension: they establish a coordinate space that in this case the single image will fill. The canvas's `id` property is used later as the `target` of the annotation that links to the single image. | ||
|
|
||
| The `items` property of the Canvas is a list of annotation pages, in this case there is only one page. The `items` property of the annotation page is a list of annotations, in this case there is only one annotation. This annotation is what links the image resource with the canvas. The `body` of the annotation is an image, the url of which is the `id` property of the body. The dimensions of the image, in pixels, are given and here match the canvas dimensions exactly. The `target` property tells us that the image is associated with the entirety of the canvas, and the `motivation` property of `painting` tells us that a client should render the image to fill the canvas. | ||
|
|
||
| ## Restrictions | ||
|
|
||
| This recipe is not for large images or deep zoom functionality. For this, see the [Support Deep Viewing with Basic Use of a IIIF Image Service (v3)][0005] recipe. | ||
|
|
||
| ## Example | ||
|
|
||
| {% include manifest_links.html manifest="v4/manifest.json" version="4" %} | ||
|
|
||
| {% include jsonviewer.html src="v4/manifest.json" %} | ||
|
|
||
| # Related Recipes | ||
|
|
||
| * [Simplest Manifest - Audio][0002] (v3) and [Simplest Manifest - Video][0003] (v3) are equivalent to this example but for other media. | ||
| * [Support Deep Viewing with Basic Use of a IIIF Image Service][0005] (v3) shows a basic manifest for use with a IIIF Image server. | ||
| * [Image different size to canvas][0004] (v3) shows a canvas with dimensions different from the pixel dimensions of its content. | ||
| * [Multiple values and languages][0006] (v3) demonstrates language map variations, for multiple values and multiple languages. | ||
|
|
||
|
|
||
| {% include acronyms.md %} | ||
| {% include links.md %} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Point to version 4 of the spec: [language map][prezi3-languages]