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

Recipe #103 -- Annotating a Poetry Reading #130

Open
wants to merge 34 commits into
base: master
Choose a base branch
from
Open

Conversation

glenrobson
Copy link
Member

Merging Sara's remote copy to the IIIF repo so that it can be built automatically. Original pull request with comments is #107. Original description from Sara:

An initial attempt at a IIIF v3 manifest with annotations on an audio file.

This needs to be updated with github pages references instead of raw github references to our repo, but I think that's a chicken & egg problem that will be fixed after merging (by whom?)

Discussion here or in the IIIF AV Slack channel.

@glenrobson
Copy link
Member Author

(Automated comment): Branch aviliable for testing at https://preview.iiif.io/cookbook/0103-poetry

@glenrobson
Copy link
Member Author

@glenrobson glenrobson added content: av Recipe involves temporal material meta: ready-for-trc Issue is ready for TRC review labels Dec 4, 2019
@azaroth42 azaroth42 removed the meta: ready-for-trc Issue is ready for TRC review label Dec 10, 2019
@azaroth42
Copy link
Member

Comments on the text:

  • The numbered list is broken -- it restarts at 1. for "While the IIIF Specification" ...
  • The examples do not use arrays of motivations, so I suggest deleting the entry completely.
  • The text and example do not line up -- The text says the final example has both supplementing and commenting, whereas it only has commenting. As below, I think it should be only supplementing.

Comments on the examples:

  • Shouldn't the MP3 be stored in IIIF S3 space to ensure that it stays working (see Newspaper recipe)
  • Is "her kind" a transcription of the spoken content? If so then it should be motivation supplementing, not commenting. See: https://iiif.io/api/presentation/3.0/#35-values

@glenrobson
Copy link
Member Author

Thanks for your comments Rob. Regarding:

Shouldn't the MP3 be stored in IIIF S3 space to ensure that it stays working (see Newspaper recipe)

We did discuss this but haven't heard from Harvard if they are happy for us to take a copy of the content so haven't done so. It would be interesting to raise in the TRC what peoples thoughts are on this but is it better to have examples with external content soon or examples with hosted content which may take longer to arrange?

For info there was a similar discussion with the Newspapers and thankfully Europeana were OK for us to copy the images but we only copied the first two images and left the last two as remote.

{
"id":"{{ id.path }}/canvas/annotation1",
"type":"Annotation",
"motivation":"commenting",
Copy link
Member Author

@glenrobson glenrobson Dec 19, 2019

Choose a reason for hiding this comment

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

Oh this is a difficult one... Is noting a breath taken a comment or a transcription?

Copy link
Member Author

Choose a reason for hiding this comment

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

but should be an array of values.

Choose a reason for hiding this comment

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

Comment. Pretty sure our academic partner calls this "paratext", which I wouldn't call transcription.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry I'm wrong here it should be a string not an array...

{
"id":"{{ id.path }}/canvas/segment1/annotation/4",
"type":"Annotation",
"motivation":"commenting",
Copy link
Member Author

Choose a reason for hiding this comment

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

Per Rob's comment "Is "her kind" a transcription of the spoken content? If so then it should be motivation supplementing, not commenting. See: https://iiif.io/api/presentation/3.0/#35-values"

Listening to the recording it is a transcription so this should be:

"motivation":["supplementing"]

Choose a reason for hiding this comment

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

We'll change this to an array so it matches the IIIF spec rather than the w3c annotation spec.

Commenting is the correct motivation, as below.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry I'm wrong here it should be a string...

{
"id":"{{ id.path }}/canvas/1/annotation/1",
"type":"Annotation",
"motivation":"commenting",
Copy link
Member Author

Choose a reason for hiding this comment

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

Should this be supplementing as above?

Copy link
Member Author

Choose a reason for hiding this comment

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

but needs to be an array

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry I'm wrong here it should be a string...

{
"id":"{{ id.path }}/canvas/1/annotation/2",
"type":"Annotation",
"motivation":"commenting",
Copy link
Member Author

Choose a reason for hiding this comment

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

Per Rob's comment "Is "her kind" a transcription of the spoken content? If so then it should be motivation supplementing, not commenting. See: https://iiif.io/api/presentation/3.0/#35-values"

Listening to the recording it is a transcription so this should be:

"motivation":["supplementing"]

Choose a reason for hiding this comment

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

We're going to change "her kind" into "repetition of 'her kind'" -- it's meant as commentary on the structure of the poem, rather than a direct transcription. That will clarify it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry I'm wrong here it should be a string...

```json
```

<a name="annotations"></a>Annotation examples, both a point annotation (at a particular time) and a range annotation (covering a time range). We use the "supplementing" motivation because these annotations are derived from the audio file on the canvas and the "commenting" motivation because the annotations are a comment about the canvas. Annotations must have "supplementing" as a motivation for any annotations derived from the items on the canvas.
Copy link
Member Author

Choose a reason for hiding this comment

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

Related to the other changes but Rob's comments:

"The text and example do not line up -- The text says the final example has both supplementing and commenting, whereas it only has commenting. As below, I think it should be only supplementing."

@benwbrum
Copy link

I'm trying to figure out whether the motivations in this example should be ["supplementing", "commenting"] or just ["commenting"]. @saracarl has cleared up the fact that the annotations are not supposed to be transcriptions, which would necessitate a supplementing motivation as I understand it, but the annotations are certainly derived from the canvas, so I'm not sure whether supplementing should be added.

The IIIF spec says,

Thus content of any type may be associated with the Canvas via an Annotation that has the motivation value painting, meaning the content is part of the Canvas; an Annotation that has the motivation value supplementing, meaning the content is from the Canvas but not necessarily part of it; or an Annotation with another motivation meaning that it is somehow about the Canvas.

A scholar who notes when a performer draws a breath or emphasizes a phrase is not really transcribing the poem--especially if the remaining text of the poem is not also represented in the associated annotations--so we're not required to use supplementing here. On the other hand, I don't really understand the difference between the annotation being "from the canvas" versus "about the canvas".

The spec also gives some hints when it suggests behavior for presenting annotations with a supplementing motivation:

Resources associated with a Canvas by an Annotation that has the motivation value supplementing MAY be presented to the user as part of the representation of the Canvas, or MAY be presented in a different part of the user interface. The content can be thought of as being from the Canvas. [...] For example, an Annotation that has the motivation value supplementing, a body of an Image and the target of part of the Canvas is an instruction to present that Image to the user either in the Canvas's rendering area or somewhere associated with it, and could be used to present an easier to read representation of a diagram. Similarly, a textual body is to be presented either in the targeted region of the Canvas or otherwise associated with it, and might be a transcription or translation of handwritten text or captions for what is being said in a Canvas with audio content.

When presenting these annotations, we hope to see them alongside the media. However, they should not replace the media or be presented over the media: if, for example, these annotations were applied to a video recording of the performance instead of a pure audio recording, we would not want these annotations presented as captions. They function as footnotes to the performance--intended to be linked to particular sections of the media--but don't replace it. Clearly we should not use painting as a motivation, but does supplementing apply?

@azaroth42
Copy link
Member

As they're not intended to be transcription, then they're not supplementing. That said, I think the example is a poor one for a recipe due to this confusion. If the authors are confused, then people reading the recipe will be even more confused.

@benwbrum
Copy link

benwbrum commented Dec 19, 2019

We'll remove the paragraph about supplementing from the markdown, and include a sentence clarifying that non-transcription/translation content such as scholarly commentary should use ["commenting"] motivations without supplementing. That might be useful for people who--like me--found the spec's distinction between "from the canvas" and "about the canvas" unclear when implementing.

@glenrobson
Copy link
Member Author

Note the build is breaking as it expects the motivation to be a string... so I will need to fix that.

@saracarl
Copy link

Changes from the TRC:

  1. remove the array brackets from the annotation motivation.
  2. remove the array/string discussion in the implementation notes
  3. explanation should explain "commenting" as a motivation.

Should we break this into 2 recipes; this one would only demonstrate scholarly commentary on audio files; another one would show how annotations can be internal to a manifest OR linked to an external annotation file?

@benwbrum
Copy link

Changes from today's cookbook meeting:

  • Fix renumbered list item in comment explanation
  • Remove version with embedded annotations -- a separate recipe will discuss embedding annotations vs. externalizing them.
  • Remove extra slash in URI for Harvard MP3 file.

@github-actions github-actions bot temporarily deployed to staging July 24, 2020 17:01 Inactive
@glenrobson
Copy link
Member Author

Tasks:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content: av Recipe involves temporal material
Projects
Status: On Hold
Development

Successfully merging this pull request may close these issues.

4 participants