0231 transcript meta recipe v3/v4

_includes/links.md

@@ -45,6 +45,8 @@
 
 [0068]: {{ site.cookbook_url | absolute_url }}/recipe/0068-newspaper/ "Basic Newspaper"
 [0074]: {{ site.cookbook_url | absolute_url}}/recipe/0074-multiple-language-captions/ "Using Caption and Subtitle Files in Multiple Languages with Video Content"
+# [0074-4]: {{ site.cookbook_url | absolute_url}}/recipe/0074-multiple-language-captions/#version-4 "Using Caption and Subtitle Files in Multiple Languages with Video Content"
+# [0079-4]: {{ site.cookbook_url | absolute_url }}/recipe/0079-annotations-for-captions/#version-4 "Using Annotations for Timed Text"
 [0117]: {{ site.cookbook_url | absolute_url }}/recipe/0117-add-image-thumbnail/ "Image Thumbnail for Manifest"
 [0118]: {{ site.cookbook_url | absolute_url }}/recipe/0118-multivalue/ "Displaying Multiple Values with Language Maps"
 
@@ -54,12 +56,16 @@
 
 [0232]: {{ site.cookbook_url | absolute_url }}/recipe/0232-image-thumbnail-canvas/ "Implementation discussion: Thumbnails on Canvases"
 [0219]: {{ site.cookbook_url | absolute_url }}/recipe/0219-using-caption-file/ "Using Caption and Subtitle Files with Video Content"
+# [0219-4]: {{ site.cookbook_url | absolute_url }}/recipe/0219-using-caption-file/#version-4 "Using Caption Files with Video Content"
 [0229]: {{ site.cookbook_url | absolute_url }}/recipe/0229-behavior-ranges/ "Adding Thumbnail Navigation and `no-nav` to a Video Resource"
 [0230]: {{ site.cookbook_url | absolute_url }}/recipe/0230-navdate/ "Navigation by Chronology"
 [0231]: {{ site.cookbook_url | absolute_url }}/recipe/0231-transcript-meta-recipe/ "Transcripts, Captions, and Subtitles - General Considerations"
-
+[0231-4]: {{ site.cookbook_url | absolute_url }}/recipe/0231-transcript-meta-recipe/#version-4 "Transcripts, Captions, and Subtitles - General Considerations"
+[0232]: {{ site.cookbook_url | absolute_url }}/recipe/0232-image-thumbnail-canvas/ "Implementation discussion: Thumbnails on Canvases"
 [0234]: {{ site.cookbook_url | absolute_url }}/recipe/0234-provider/ "Acknowledge Content Contributors"
 [0240]: {{ site.cookbook_url | absolute_url }}/recipe/0240-navPlace-on-canvases/ "Locate Multiple Canvases on a Web Map"
+# [0253-4]: {{ site.cookbook_url | absolute_url }}/recipe/0253-using-transcript-file/ "Using Transcript Files with Audio or Video Content" 
+[0258]: {{ site.cookbook_url | absolute_url }}/recipe/0258-tagging-external-resource/ "Tagging with an External Resource"
 [0261]: {{ site.cookbook_url | absolute_url }}/recipe/0261-non-rectangular-commenting/ "Annotation with a Non-Rectangular Polygon"
 [0258]: {{ site.cookbook_url | absolute_url }}/recipe/0258-tagging-external-resource/ "Tagging with an External Resource"
 

recipe/0231-transcript-meta-recipe/index.md

@@ -5,72 +5,23 @@ layout: recipe
 tags: [Transcripts, Captions, Subtitles]
 summary: "General Considerations for using Transcripts, Captions, and Subtitles"
 topic: note
----
-
-## Use Case
-
-This meta recipe describes options when using Transcripts, Captions, and Subtitles with your resources taking into consideration the desired user experience.
-
-## Transcripts
-
-Transcripts are text-based representations of material originally presented in another medium such as newspapers and audio or video recordings.
-There are 3 options for handling transcript files using the IIIF Presentation API; which option to use depends on the desired user experience:
-
-1. Providing independent access to the transcript via download
-
-    When the transcript is considered an alternative representation of the resource, a link to the transcript can be offered so that the user can download it or view it outside the client. This is accomplished via the `rendering` link option.
-
-    a. For an example of this option in the book space, see [Providing Alternative Representations][0046].
-
-    b. For an example in the newspaper space see the ALTO example in [A basic newspaper][0068] recipe.
-
-    c. For an example in the A/V space, see [Providing Access to Transcript Files of A/V Content][0017].
-
-2. Providing access to the transcript alongside the resource
-
-    When the intention is to have the client display the transcript alongside the resource, one should follow the pattern used with other supplementing materials, i.e., via an annotation with the `supplementing` motivation associated with the corresponding Canvas or at the Manifest level. Note that this option offers the transcript file as a single annotation.
-
-    a. For an example of this option in the A/V space, see [A Side-by-side Transcript of a Video Recording][0253].
 
-3. Providing synchronized access to transcript and resource
-
-    When the transcript includes spatial and/or temporal information, one can use that information to enable synchronization of the display or streaming of the media and the display of the individual transcript fragments. To accomplish that, create one annotation for each transcript fragment, including its spatial and/or temporal information in the media fragment portion of the annotation target url. The motivation of the corresponding Annotation is `supplementing`.
-
-    a. For an example in the image space see [Transcription of image-based content][016].
-
-    b. For an example in the newspaper space see the example annotations in a [A basic newspaper][0068] recipe.
-
-    c. For an example in the A/V space see [Using Annotations for Timed Text][0079].
-
-## Captions and Subtitles
-
-Captions and subtitles are used to optionally mark up the external text track resources in connection with the HTML element of a *video* file. They are available in various file formats such as [WebVTT](https://w3c.github.io/webvtt/) (Web Video Text Tracks) and [TTML](https://w3c.github.io/ttml3/index.html) (Timed Text Markup Language). These markup file formats include time tags that allow for time alignment of the captions or subtitles with the video content during playback. 
-
-1. Serving the Caption File directly
-
-    The manifest for this case is identical to option 2 above but, given the support for these standard file formats by modern viewers, the text is presented on top of the video as it is expected for captions and subtitles, thus providing for a completely different viewing experience. 
-
-    a. See [Using Caption and Subtitle Files with Video Content][0219] for implementation details.
-
-    b. See [Serving HLS Files][0257] for details on using segmented WebVTT with HLS content.
-
-2. Transforming captions into annotations
-
-    Like transcription files, caption files can be transformed into annotations. This option aligns better with image-based annotations, so providers are encouraged to offer their captions and subtitles in this way. See [Using Annotations for Timed Text][0079].
-
-
-## Related Recipes
+top_tabs:
+  - label: Version 3
+    content: "{% capture my_include %}{%- include_relative recipe.md version='3' -%}{% endcapture %}{{ my_include | markdownify }}"
+  - label: Version 4
+    content: "{% capture my_include %}{%- include_relative v4/recipe.md version='4' -%}{% endcapture %}{{ my_include | markdownify }}"
+---
 
-* [Providing Alternative Representations][0046]
-* [Providing Access to Transcript Files of A/V Content][0017]
-* [A basic newspaper][0068]
-* [A Side-by-side Transcript of a Video Recording][0253]
-* [Transcription of image-based content][016]
-* [Using annotations for Timed Text][0079]
-* [Using Caption and Subtitle Files with Video Content][0219]
-* [Serving HLS Files][0257]
+{{ theme.block-center-start }}
 
+{% include blocks/tabs.html  tabs=page.top_tabs %}
 
-{% include acronyms.md %}
-{% include links.md %}
+{{ theme.block-end }}
+<script>
+  if (!window.location.hash) {
+    let el = document.getElementById("version-3-heading");
+    el.className += " is-active";
+  }  
+</script>
 

recipe/0231-transcript-meta-recipe/recipe.md

@@ -0,0 +1,66 @@
+## Use Case
+
+This meta recipe describes options when using Transcripts, Captions, and Subtitles with your resources taking into consideration the desired user experience.
+
+## Transcripts
+
+Transcripts are text-based representations of material originally presented in another medium such as newspapers and audio or video recordings.
+There are 3 options for handling transcript files using the IIIF Presentation API; which option to use depends on the desired user experience:
+
+1. Providing independent access to the transcript via download
+
+    When the transcript is considered an alternative representation of the resource, a link to the transcript can be offered so that the user can download it or view it outside the client. This is accomplished via the `rendering` link option.
+
+    a. For an example of this option in the book space, see [Providing Alternative Representations][0046].
+
+    b. For an example in the newspaper space see the ALTO example in [A basic newspaper][0068] recipe.
+
+    c. For an example in the A/V space, see [Providing Access to Transcript Files of A/V Content][0017].
+
+2. Providing access to the transcript alongside the resource
+
+    When the intention is to have the client display the transcript alongside the resource, one should follow the pattern used with other supplementing materials, i.e., via an annotation with the `supplementing` motivation associated with the corresponding Canvas or at the Manifest level. Note that this option offers the transcript file as a single annotation.
+
+    a. For an example of this option in the A/V space, see [A Side-by-side Transcript of a Video Recording][0253].
+
+3. Providing synchronized access to transcript and resource
+
+    When the transcript includes spatial and/or temporal information, one can use that information to enable synchronization of the display or streaming of the media and the display of the individual transcript fragments. To accomplish that, create one annotation for each transcript fragment, including its spatial and/or temporal information in the media fragment portion of the annotation target url. The motivation of the corresponding Annotation is `supplementing`.
+
+    a. For an example in the image space see [Transcription of image-based content][016].
+
+    b. For an example in the newspaper space see the example annotations in a [A basic newspaper][0068] recipe.
+
+    c. For an example in the A/V space see [Using Annotations for Timed Text][0079].
+
+## Captions and Subtitles
+
+Captions and subtitles are used to optionally mark up the external text track resources in connection with the HTML element of a *video* file. They are available in various file formats such as [WebVTT](https://w3c.github.io/webvtt/) (Web Video Text Tracks) and [TTML](https://w3c.github.io/ttml3/index.html) (Timed Text Markup Language). These markup file formats include time tags that allow for time alignment of the captions or subtitles with the video content during playback. 
+
+1. Serving the Caption File directly
+
+    The manifest for this case is identical to option 2 above but, given the support for these standard file formats by modern viewers, the text is presented on top of the video as it is expected for captions and subtitles, thus providing for a completely different viewing experience. 
+
+    a. See [Using Caption and Subtitle Files with Video Content][0219] for implementation details.
+
+    b. See [Serving HLS Files][0257] for details on using segmented WebVTT with HLS content.
+
+2. Transforming captions into annotations
+
+    Like transcription files, caption files can be transformed into annotations. This option aligns better with image-based annotations, so providers are encouraged to offer their captions and subtitles in this way. See [Using Annotations for Timed Text][0079].
+
+
+## Related Recipes
+
+* [Providing Alternative Representations][0046]
+* [Providing Access to Transcript Files of A/V Content][0017]
+* [A basic newspaper][0068]
+* [A Side-by-side Transcript of a Video Recording][0253]
+* [Transcription of image-based content][016]
+* [Using annotations for Timed Text][0079]
+* [Using Caption and Subtitle Files with Video Content][0219]
+* [Serving HLS Files][0257]
+
+
+{% include acronyms.md %}
+{% include links.md %}

recipe/0231-transcript-meta-recipe/v4/recipe.md

@@ -0,0 +1,75 @@
+## Use Case
+
+This meta recipe describes options when using Transcripts, Captions, and Subtitles with your resources taking into consideration the desired user experience.
+
+## Transcripts
+
+Transcripts are textual representations of content originally presented in a non-textual medium such as audio or video recordings or manuscripts.
+They are generally displayed alongside the original media or made available via download.
+There are several options for handling transcripts using the IIIF Presentation API (v4). 
+
+1. Providing access to the transcript via download
+
+    When the transcript is considered an alternative representation of the resource, a link to the transcript can be offered so that the user can download it or view it outside the client. This is accomplished via the `rendering` link option.
+
+    a. For an example of this option in the book space, see [Providing Alternative Representations][0046].
+
+    b. For an example in the newspaper space see the ALTO example in [A basic newspaper][0068] recipe.
+
+    c. For an example in the A/V space, see [Providing Access to Transcript Files of A/V Content][0017].
+
+
+2. Providing access to a transcript alongside the resource via an external file 
+
+    When the intention is to have the client display the transcript alongside the resource, one should use an annotation with the `supplementing` motivation and with the `provides` property specified to indicate a `transcript`. Note that this option offers the transcript file as a single annotation. The transcript file can take many different formats and may or may not include spatial/temporal information that allows synchronization between transcript fragments and display or streaming of media.
+
+    a. For an example of this option in the A/V space, see [Using Transcript Files with Audio or Video Content][0253-4].
+
+
+3. Providing access to transcript alongside the resource via textual annotations 
+
+    When the transcript includes spatial and/or temporal information, the transcript can be expressed as a series of textual annotations. To accomplish that, create one annotation for each transcript fragment, including its spatial and/or temporal information in the media fragment portion of the annotation target url. The motivation of the corresponding annotations are `supplementing` with the `provides` property specified to indicate a `transcript`. This also allows synchronization between transcript annotations and display or streaming of media. 
+
+    a. For an example in the image space see [Transcription of image-based content][016].
+
+    b. For an example in the newspaper space see the example annotations in a [A basic newspaper][0068] recipe.
+
+    c. For an example in the A/V space see [Using Annotations for Timed Text][0079-4].
+
+## Captions
+
+Captions are textual representations of spoken word and non-speech audio that are primarily used with video recordings. They are intended for users who cannot hear audio. Caption display must be synchronized with playback (generally over top of video), and caption file formats inherently include time tags that enable this synchronization. The most common formats are [WebVTT](https://w3c.github.io/webvtt/) (Web Video Text Tracks) or [SRT](https://en.wikipedia.org/wiki/SubRip) (SubRip Text). 
+
+1. Serving a caption file directly
+
+    The manifest for this case is nearly identical to option 2 above but, given the support for these standard file formats by modern viewers, the text is presented on top of the video, thus providing for a completely different viewing experience. The `provides` property is used to indicate that the annotation includes captions, rather than transcripts.
+
+    a. See [Using Caption Files with Video Content][0219-4] for implementation details.
+
+2. Transforming captions into textual annotations
+
+    Like transcript files, caption files can be transformed into a series of textual annotations that include temporal information in the media fragment portion of the annotation target url. Each annotation includes the `provides` property to differentiate between captions and transcripts and enable display on top of video. 
+
+    a. See [Using Annotations for Timed Text][0079-4].
+
+## Subtitles
+
+Subtitles are translations of captions into a different language than the original spoken audio. They are intended for users who can hear, but do not understand the spoken language in the recording. Just like captions, subtitles must be synchronized with playback. To provide subtitles, follow the pattern for the captions recipes above, but use a `provides` property value of `subtitles` in the appropriate annotation(s).
+
+1. For an example of how to provide both captions and subtitles for a video recording, see [Using Caption and Subtitle Files in Multiple Languages with Video Content][0074-4].
+
+
+## Related Recipes
+
+* [Providing Alternative Representations][0046]
+* [Providing Access to Transcript Files of A/V Content][0017]
+* [A basic newspaper][0068]
+* [Using Transcript Files with Audio or Video Content][0253-4]
+* [Transcription of image-based content][016]
+* [Using annotations for Timed Text][0079-4]
+* [Using Caption Files with Video Content][0219-4]
+* [Using Caption and Subtitle Files in Multiple Languages with Video Content][0074-4]
+
+
+{% include acronyms.md %}
+{% include links.md %}