Warning:
This wiki has been archived and is now read-only.

Cookbook

From Open Annotation Community Group
Jump to: navigation, search

Conventions

The diagrams in the cookbook use the following style:

- Instances are depicted as colored ellipses
 - Instances with a resolvable URI have a single line border
 - Instances with a non-resolvable URN or are a blank node have a double line border
- Classes are depicted as white rectangles
- Literals are depicted as white lozenges
- Relationships are depicted as straight, black lines. 
  Relationships are RDF predicates where the range is a Resource, and equivalent to OWL object properties.
- Properties are depicted as curved, black lines. 
  Properties are RDF predicates where the range is a Literal, and equivalent to OWL datatype properties.
- Class instantiation (rdf:type) is depicted as a straight black line with white arrow head, following UML.
- Example instance identifiers are lowercase and end in a number. 
  For example, anno1 is a specific instance of an Annotation, whereas oa:Annotation is a class
- Example literals follow the requirements for the model and, thus, must not be interpreted as the only possible value
- Conceptual resource boundaries not explicit in the model, but considered important for understanding, 
  are depicted as grey dashed boxes around the components. 
  They are used to convey spatial parts of the diagrams and may be safely ignored.

Scenarios

The following are examples depicting how to use the Open Annotation model in common scenarios.

  1. Simple annotations of single target resources
    1. Bookmarking a Webpage
    2. Tagging an Image with free text
    3. Semantically Tagging an Image
    4. Multiple Semantic Tags on Image
    5. Bookmarking and Tagging a Webpage
    6. Commenting on a Video Fragment

** The rest of the Cookbook is currently outdated... working on it **

Open Annotation Model in Action

The following examples and scenarios are - unless otherwise specified - compliant to the following specs:


<< Back to the Wiki Home

Example of features of the OA model

Scenarios

The following are examples depicting how to use the Open Annotation model in common scenarios.

  1. Simple annotations of Single-Target-Resources
    1. Annotation of a Webpage with another Webpage
    2. Annotation of a Webpage with a Textual Note
    3. Annotation of an Image with a Hypertextual Note
    4. Inline Comment on an Image
    5. Comment on a Video
    6. Annotation of a Document with a Video
    7. Annotation of a Video with a Video
  2. Simple annotations of Multiple Target Resources
    1. Comment on Multiple Images
    2. Description of Multiple Webpages
  3. Simple annotations of Resource Fragments
    1. Highlight of Text Fragment
    2. Highlight of Image Fragment
    3. Comment on Text Fragment
    4. Comment on Image Fragment
    5. Comment on a Video Fragment
    6. Tagging a Text Fragment
    7. Georeferencing a Historic Map
    8. Commenting a Region on a Historic Map


Notes

Note: In some browsers/applications free text tags can be associated to improve bookmarks search and sorting.