Merge pull request #218 from IIIF/0053-seeAlso

Recipe #53—Related Machine-Readable Resources with seeAlso
IIIF · Mar 10, 2021 · 5121a87 · 5121a87
2 parents 739d987 + 8ec02a0
commit 5121a87
Show file tree

Hide file tree

Showing 5 changed files with 356 additions and 22 deletions.
diff --git a/_includes/links.md b/_includes/links.md
@@ -19,8 +19,8 @@
 [0024]: {{site.baseurl}}/recipe/0024-book-4-toc/ "Table of Contents for Book Chapters"
 [0026]: {{site.baseurl}}/recipe/0026-toc-opera/ "Table of Contents for A/V Content"
 [0029]: {{site.baseurl}}/recipe/0029-metadata-anywhere/ "Metadata on any Resource"
+[0053]: {{site.baseurl}}/recipe/0053-seeAlso/ "Linking to Structured Metadata"
 [0046]: {{site.baseurl}}/recipe/0046-rendering/ "Providing Alternative Representations"
-
 [0064]: {{site.baseurl}}/recipe/0064-opera-one-canvas/ "Table of Contents for Multiple A/V Files on a Single Canvas"
 [0065]: {{site.baseurl}}/recipe/0065-opera-multiple-canvases/ "Table of Contents for Multiple A/V Files on Multiple Canvases"
 

diff --git a/index.md b/index.md
@@ -100,7 +100,7 @@ _(leading on to segmentation examples later)_
 * Linking from external metadata to Image API
 * Linking from external metadata to Presentation API
 * Linking between Presentation API representations
-* seeAlso scenarios (incl other manifests) (8)
+* [Linking to Structured Metadata][0053] (8)
 
 ## Technical
 

diff --git a/recipe/0053-seeAlso/ezukushi.xml b/recipe/0053-seeAlso/ezukushi.xml
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document repository="default" id="1c26b425-97c3-42ba-8479-6cf2a6c45861">
+  <schema xmlns:dc="http://www.nuxeo.org/ecm/schemas/dublincore/" name="dublincore">
+    <dc:creator><![CDATA[ucla_upload]]></dc:creator>
+    <dc:modified><![CDATA[2019-07-30T20:28:37.000Z]]></dc:modified>
+    <dc:lastContributor><![CDATA[ucla_upload]]></dc:lastContributor>
+    <dc:created><![CDATA[2017-02-18T17:48:36.570Z]]></dc:created>
+    <dc:title><![CDATA[秋葉権現廻船話 [Akiba gongen kaisen-banashi] ; 後狂言双蝶々曲輪日記 [atokyōgen Futatsu chōchō kuruwa nikki] ; 切狂言五大力恋緘 [kirikyōgen Godairiki koi no fūjime]]]></dc:title>
+    <dc:contributors>
+      <item><![CDATA[ucla_upload]]></item>
+      <item><![CDATA[[email protected]]]></item>
+      <item><![CDATA[[email protected]]]></item>
+      <item><![CDATA[[email protected]]]></item>
+      <item><![CDATA[[email protected]]]></item>
+    </dc:contributors>
+  </schema>
+  <schema xmlns:ucldc_schema="http://www.nuxeo.org/ecm/project/schemas/tingle-california-digita/ucldc_schema" name="ucldc_schema">
+    <ucldc_schema:alternativetitle>
+      <item><![CDATA[]]></item>
+    </ucldc_schema:alternativetitle>
+    <ucldc_schema:type><![CDATA[text]]></ucldc_schema:type>
+    <ucldc_schema:date>
+      <item>
+        <date><![CDATA[嘉永2年閏4月 [May, 1849]]]></date>
+        <single><![CDATA[1849-05]]></single>
+        <datetype><![CDATA[created]]></datetype>
+        <inclusivestart><![CDATA[]]></inclusivestart>
+        <inclusiveend><![CDATA[]]></inclusiveend>
+      </item>
+    </ucldc_schema:date>
+    <ucldc_schema:extent><![CDATA[4 leaves (4-chō) on double leaves (pouch binding/fukurotoji) : illustrations ; 196 x 135 mm]]></ucldc_schema:extent>
+    <ucldc_schema:rightsstatement><![CDATA[Material in the public domain. No restrictions on use.]]></ucldc_schema:rightsstatement>
+    <ucldc_schema:subjectname/>
+    <ucldc_schema:place>
+      <item>
+        <name><![CDATA[筑後芝居 [Chikugo no Shibai] (Theater)]]></name>
+        <source><![CDATA[]]></source>
+      </item>
+    </ucldc_schema:place>
+    <ucldc_schema:rightsstatus><![CDATA[publicdomain]]></ucldc_schema:rightsstatus>
+    <ucldc_schema:accessrestrict><![CDATA[public]]></ucldc_schema:accessrestrict>
+    <ucldc_schema:rightsholder/>
+    <ucldc_schema:publisher>
+      <item><![CDATA[大坂 : 本清（本屋玉置清七） [Osaka : Honsei (Hon'ya Tamaki Seishichi)]]]></item>
+    </ucldc_schema:publisher>
+    <ucldc_schema:contributor>
+      <item>
+        <role><![CDATA[Producer/Zamoto]]></role>
+        <nametype><![CDATA[persname]]></nametype>
+        <name><![CDATA[市川巳之助 [Ichikawa, Minosuke], Producer]]></name>
+      </item>
+    </ucldc_schema:contributor>
+    <ucldc_schema:description>
+      <item>
+        <item><![CDATA[嘉永２年閏４月の筑後芝居における「秋葉権現廻船話」、「双蝶々曲輪日記」、 「五大力恋緘」の絵尽及び役割番付；主な役者：２代目片岡我童、６代目市川海老蔵、２代目沢村其答、４代目三枡大五郎、初代中村歌六；表表紙に座本市川巳之助の家紋あり。]]></item>
+        <type><![CDATA[scopecontent]]></type>
+      </item>
+      <item>
+        <item><![CDATA[Playbill for "Akiba gongen kaisen-banashi," "Futatsu chōchō kuruwa nikki" and "Godairiki koi no fūjime" performed at the Chikugo Theater in Osaka from the fifth month of Kaei 2 (May, 1849); main actors: Gadō Kataoka II, Ebizō Ichikawa VI, Kitō Sawamura II, Daigorō Mimasu IV and Karoku Nakamura I; on front cover: producer Mominosuke Ichikawa's crest.]]></item>
+        <type><![CDATA[scopecontent]]></type>
+      </item>
+    </ucldc_schema:description>
+    <ucldc_schema:language>
+      <item>
+        <language><![CDATA[Japanese]]></language>
+      </item>
+    </ucldc_schema:language>
+    <ucldc_schema:relatedresource>
+      <item><![CDATA[秋葉権現廻船話 [Akiba gongen kaisen-banashi]]]></item>
+      <item><![CDATA[双蝶々曲輪日記 [Futatsu chōchō kuruwa nikki]]]></item>
+      <item><![CDATA[五大力恋緘 [Godairiki koi no fūjime]]]></item>
+      <item><![CDATA[]]></item>
+    </ucldc_schema:relatedresource>
+    <ucldc_schema:formgenre>
+      <item>
+        <heading><![CDATA[絵尽 [ezukushi]]]></heading>
+        <source><![CDATA[local]]></source>
+      </item>
+      <item>
+        <heading><![CDATA[役割番付 [yakuwari banzuke]]]></heading>
+        <source><![CDATA[local]]></source>
+      </item>
+      <item>
+        <heading><![CDATA[合羽摺 [kappazuri]]]></heading>
+        <source><![CDATA[local]]></source>
+      </item>
+      <item>
+        <heading><![CDATA[woodcuts]]></heading>
+        <source><![CDATA[aat]]></source>
+      </item>
+      <item>
+        <heading><![CDATA[playbills]]></heading>
+        <source><![CDATA[aat]]></source>
+      </item>
+      <item>
+        <heading><![CDATA[stencil printing]]></heading>
+        <source><![CDATA[aat]]></source>
+      </item>
+    </ucldc_schema:formgenre>
+    <ucldc_schema:subjecttopic/>
+    <ucldc_schema:creator/>
+    <ucldc_schema:localidentifier>
+      <item><![CDATA[PN2924.5 K3 K33 no.1]]></item>
+    </ucldc_schema:localidentifier>
+  </schema>
+</document>
diff --git a/recipe/0053-seeAlso/index.md b/recipe/0053-seeAlso/index.md
@@ -1,42 +1,52 @@
 ---
-title: More seeAlso scenarios
+title: Linking to Structured Metadata
 id: 53
 layout: recipe
-tags: [tbc]
+tags: [metadata,presentation]
 summary: "tbc"
 ---
 
-
 ## Use Case
 
-Why is this pattern is important?
+You have a IIIF manifest resource along with additional machine-readable metadata usable by aggregators and others that can process or index it via the [`seeAlso`](https://iiif.io/api/presentation/3.0/#seealso) property. You know from previous experience that aggregators crawling your collection harvest best when handed structured metadata and are also then able to offer their readers faceting capabilities, making your resources amenable to focused discovery. Through use of the `seeAlso` property, you are able to alert an aggregator to the presence of a dataset so the aggregator can provide appropriate and sophisticated information about your resource to the aggregator's users.
+
+## Implementation Notes
+
+This property is used for pointing a viewer to the URI of a non-IIIF resource with information about the IIIF resource to which it is attached. Most frequently, the non-IIIF resource will be structured metadata, and to be most effective, the target resource should be a machine-readable format such as XML, JSON, or RDF. The `type` value for `seeAlso` is usually `dataset`.
+
+Three other properties may seem similar, so it's worth highlighting the differences. 
+
+* `homepage` [(IIIF Presentation API reference)](https://iiif.io/api/presentation/3.0/#homepage)  
+Where `rendering` presents an additional representation of the same resource, `homepage` points to a webpage _about_ the object represented by the resource.
 
-## Implementation notes
+* `accompanyingCanvas` [(IIIF Presentation API reference)](https://iiif.io/api/presentation/3.0/#accompanyingcanvas)  
+An `accompanyingCanvas` resource is a IIIF resource presented simultaneously with the main resource, where a target of `rendering` is not IIIF-compatible and must be viewed outside the main resource's viewer. In addition, `accompanyingCanvas` is used for content complementary to the main resource while `rendering` points to additional representations of the same resource.
 
-How does one implement the pattern?
+* `rendering` [(IIIF Presentation API reference)](https://iiif.io/api/presentation/3.0/#rendering)  
+Unlike `seeAlso`, the `rendering` property provides the URI of an alternate representation of the current resource, such as a PDF or ePub version. The `type` values for `rendering` vary more widely than do those for `seeAlso`, in keeping with the variety of target formats possible.
+
+Any resource may have the `seeAlso` property. Each instance of it may have multiple items contained inside it, provided each has the `id` and `type` properties; `label`, `format`, and `profile` are strongly recommended properties. Conforming clients may process this property in some way, but the outcomes of a client's processing has no defined form.
 
 ## Restrictions
 
-When is this pattern is usable / not usable? Is it deprecated? If it uses multiple specifications, which versions are needed, etc.? (Not present if not needed.)
+None
 
 ## Example
 
-Describe in prose and provide examples, e.g.: 
+In this example, a MODS XML file is provided for the program as a whole, and as such the `seeAlso` property attaches to the Manifest. If such data files were available for each view or page separately, each Canvas would be a logical place for the corresponding `seeAlso` instance.
+
+To see the property in action in Mirador, toggle the sidebar by activating the three-line ("hamburger") menu in the upper left-hand corner of the content window. You should then, in the "Related" area, see the link in the "Related" section under the "See also" subheading.
+
+{% include manifest_links.html viewers="Mirador" manifest="manifest.json" %}
+
+{% include jsonviewer.html src="manifest.json" config='data-line="16-28"' %}
 
-``` json-doc
-{
-  "@context": [
-    "http://www.w3.org/ns/anno.jsonld",
-    "http://iiif.io/api/presentation/{{ page.major }}/context.json"
-  ],
-  "id": "https://example.org/iiif/book1/manifest",
-  "type": "Manifest" 
-}
-```
+The direct link to the fixture is a useful convenience.
 
-# Related recipes
+## Related Recipes
 
-Provide a bulleted list of related recipes and why they are relevant.
+* [homepage][0047] for pointing to a web page about the object represented by the current resource
+* [Providing Alternative Representations][0046] for alternate representations of the same object
 
 
 {% include acronyms.md %}