Skip to content

Commit

Permalink
Merge pull request #432 from giacomomarchioro/0022-linking-with-a-hot…
Browse files Browse the repository at this point in the history
…spot

Add more detailed explanation and links
  • Loading branch information
giacomomarchioro authored Sep 29, 2023
2 parents 932e42f + 9cce2f1 commit 0daeafe
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
1 change: 1 addition & 0 deletions _includes/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

[0019]: {{ site.cookbook_url | absolute_url }}/recipe/0019-html-in-annotations/ "HTML in Annotations"
[0021]: {{ site.cookbook_url | absolute_url }}/recipe/0021-tagging/ "Simple Annotation — Tagging"
[0022]: {{ site.cookbook_url | absolute_url }}/recipe/0022-linking-with-a-hotspot/ "Redirecting from one Canvas to another resource (Hotspot linking)"

[0033]: {{site.baseurl}}/recipe/0033-choice/ "Multiple choice of images in a single view"
[0035]: {{site.baseurl}}/recipe/0035-foldouts/ "Foldouts, Flaps, and Maps"
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ _(leading on to segmentation examples later)_
* [Simple Annotation - Tagging][0021]
* [Annotation with a Non-Rectangular Polygon][0261]
* [Tagging with an External Resource][0258]
* hotspot linking
* [Redirecting from one Canvas to another resource (Hotspot linking)][0022]
* [Annotate a specific images or layers][0326]
* [Geographic coordinates][0139]
* [Embedded or Referenced Annotations][0269]
Expand Down
15 changes: 13 additions & 2 deletions recipe/0022-linking-with-a-hotspot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,23 @@ In an image showing multiple objects or parts, you want to see a detailed versio

The create the annotation, we create an Annotation inside an AnnotationPage
To select the area we want to link to a specific resource we set the target using the link of the Canvas and a fragment as in [Simple Annotation — Tagging][0021], however, in this case, the `motivation` of the annotation is `linking`.
The `body` contains a SpecificResource with `source` attribute set to the Canvas we want to link.

In the case the link is between a region of a Canvas and another Canvas in a Manifest, the `body` contains a SpecificResource with `source` attribute set to the Canvas we want to link.
The `partOf` attribute of the Canvas must point to the Manifest containing the Canvas and have the same `id`.
The element must be present even when the Canvas is part of the same Manifest, in this way when the manifest is consumed it is always possible to identify where the Canvas is contained.
The `partOf` attribute must be present even when the Canvas is part of the same Manifest, in this way when the manifest is consumed it is always possible to identify where the Canvas is contained.

In the case the link is between a region of a Canvas and and an external resource it is recommended to add the correct type as indicated in the [Web Annotation Data Model](https://www.w3.org/TR/annotation-model/#h-accessibility-of-content), for instance:

```json
{
"id": "http://example.org/website1",
"type": "Text"
}
```

The implementer could consider adding also a Textual Body to the annotation to give more context to the end-user.


## Restrictions

None known.
Expand Down
2 changes: 1 addition & 1 deletion recipe/0022-linking-with-a-hotspot/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"type": "TextualBody",
"language": "de",
"format": "text/plain",
"value": "Der Gänseliesel-Brunnen"
"value": "A link to a close up of Gänseliesel-Brunnen fountain."
},
{
"type": "SpecificResource",
Expand Down

0 comments on commit 0daeafe

Please sign in to comment.